Contents

require_relative 'base'
require 'addressable/template'
module Taric
  module Operation
    module Champion
      include Taric::Operation::Base

      CHAMPION_VERSION = 'v1.2'.freeze
      CHAMPION_BASE_URL = "#{BASE_URL_FN.(CHAMPION_VERSION)}/champion"

      CHAMPIONS =  Addressable::Template.new("#{CHAMPION_BASE_URL}{?api_key,freeToPlay}")
      CHAMPION_BY_ID = Addressable::Template.new("#{CHAMPION_BASE_URL}/{id}{?api_key}")

      # Returns [Hash] embedding an [Array] of champion data.
      #
      # @see {https://developer.riotgames.com/api/methods#!/958/3290}
      # @param free_to_play [Boolean] optional, nil returns all, true or false to filter if they're free to play or not
      # @return [Hash] embedding [Array] of champions keyed off of "champions"
      #
      # @example
      #   all_champions = client.champions["champions"]
      #   free_champions = client.champions(free_to_play: true)["champions"]
      #   nonfree_champions = client.champions(free_to_play: false)["champions"]
      def champions(free_to_play: nil)
        response_for CHAMPIONS, freeToPlay: free_to_play
      end

      def champion(id:)
        response_for CHAMPION_BY_ID, id: id
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
taric-0.1.2	lib/taric/operation/champion.rb