ruby-lol 0.0.7 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64b2c711ab04175c2affa3e50c2e2edcd19174cc
-  data.tar.gz: 332cbea429a999952017e23e26e156dcf777e64c
+  metadata.gz: 3ed1b5474d3abe4a83a978853e1e40f51b205d51
+  data.tar.gz: 951a6a05d57d7574b7a01e1a7d1168941a993b9e
 SHA512:
-  metadata.gz: 745627a7bcdcb12d570f246dd5da1dd8636e7061036de7f9b24b4ea9a7b323f9db119c923d53c49efd0b20acd9d80cd7fbba8944cac0d6e1a509f6746c4817bf
-  data.tar.gz: 7b7c2824be9137a8f3c7b63bf6851ca912f4750076f159cb7aac1b91f00877a10f43f3b3a7086119af4b5881390fb06c7c8534a273193731f4939148ce5b0d37
+  metadata.gz: a639d3260ba7b4dec631e22c30295114736be5ac3065ef15198e411fe56493983f2784e5e676a724203eb94bcd920e2a0d4ec0a7d18f3590e7bf8992c6200866
+  data.tar.gz: 9cca04e89cf82bf3736a0b1667dd8b69166b29d6d77c6ac754da6166b875f51ae815efa26a491c3548b052e10568b69b546f4712c5ff03a4f2d39c38d6890c81

data/README.md

@@ -3,10 +3,6 @@
 
 ruby-lol is a wrapper to the [Riot Games API](https://developer.riotgames.com).
 
-## IMPORTANT NOTICE
-
-An important piece of refactoring is happening in the *refactoring* branch. Check it out for updated docs. I plan to merge it in this week.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -66,15 +62,15 @@ Or install it yourself as:
     # => Lol::RankedStats
 
     client.summoner.masteries(summoner_id)
-    # => Lol::Masteries
+    # => [Lol::Masterypage]
     client.summoner.runes(summoner_id)
-    # => Lol::Runes
+    # => [Lol::Runepage]
     client.summoner.by_name(name)
     # => Lol::Summoner
     client.summoner.get(summoner_id)
     # => Lol::Summoner
     client.summoner.name(summoner_ids)
-    # => Array
+    # => [Hash]
 
     client.team.get(summoner_id)
     # => Array

data/Rakefile

@@ -2,7 +2,9 @@ require "bundler/setup"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec, :tag) do |t, task_args|
+  t.rspec_opts = "--tag #{task_args[:tag]}" if task_args[:tag]
+end
 
 task :default => :spec
 

data/demo/demo.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(__dir__ + "/../lib")
+
+require "rubygems"
+require "ap"
+require "lol"
+
+include Lol
+
+client = Client.new "18b7c486-0d5a-459f-9d60-cf8776b154c6"
+intinig = client.summoner.by_name "intinig"
+leagues = client.league.get intinig.id
+my_league = leagues.first
+
+my_league.entries.select {|entry| entry.player_or_team_name == "intinig"}.each do |entry|
+  ap entry
+end

data/lib/lol.rb

@@ -6,12 +6,19 @@ require "lol/game_request"
 require "lol/stats_request"
 require "lol/team_request"
 require "lol/league_request"
+require "lol/summoner_request"
 
 require "lol/model"
 require "lol/champion"
 require "lol/game"
 require "lol/league"
 require "lol/player"
+require "lol/summoner"
+require "lol/rune_page"
+require "lol/rune_slot"
+require "lol/rune"
+require "lol/mastery_page"
+require "lol/talent"
 require "lol/raw_statistic"
 require "lol/player_statistic"
 require "lol/aggregated_statistic"

data/lib/lol/client.rb

@@ -2,8 +2,6 @@ require 'httparty'
 require 'uri'
 
 module Lol
-  class InvalidAPIResponse < StandardError; end
-
   class Client
 
     # @!attribute [rw] region
@@ -39,6 +37,11 @@ module Lol
       @team_request ||= TeamRequest.new(api_key, region)
     end
 
+    # @return [SummonerRequest]
+    def summoner
+      @summoner_request ||= SummonerRequest.new(api_key, region)
+    end
+
     # Initializes a Lol::Client
     # @param api_key [String]
     # @param options [Hash]

data/lib/lol/game_request.rb

@@ -5,7 +5,7 @@ module Lol
     # @return [Array] an array of games
     def recent summoner_id
       summoner_api_path = "game/by-summoner/#{summoner_id}/recent"
-      perform_request(api_url("v1.1", summoner_api_path))["games"].map do |game_data|
+      perform_request(api_url("v1.2", summoner_api_path))["games"].map do |game_data|
         Game.new game_data
       end
     end

data/lib/lol/league_request.rb

@@ -3,7 +3,7 @@ module Lol
     # Retrieves leagues data for summoner, including leagues for all of summoner's teams, v2.1
     # @return [Array] an array of champions
     def get summoner_id
-      response = perform_request(api_url("v2.1", "league/by-summoner/#{summoner_id}"))[summoner_id]
+      response = perform_request(api_url("v2.1", "league/by-summoner/#{summoner_id}"))[summoner_id.to_s]
       response.is_a?(Hash) ? [League.new(response)] : response.map {|l| League.new l}
     end
 

data/lib/lol/mastery_page.rb

@@ -0,0 +1,28 @@
+module Lol
+  class MasteryPage < Model
+
+    # @!attribute [r] id
+    #   @return [Fixnum] id of summoner
+    attr_reader :summoner_id
+
+    # @!attribute [r] talents
+    #   @return [Array] array of Lol::Talent
+    attr_reader :talents
+
+    # @!attribute [r] name
+    #   @return [String] name of mastery page
+    attr_reader :name
+
+    # @!attribute [r] current
+    #   @return [Boolean] is it the current mastery page?
+    attr_reader :current
+
+    private
+
+    attr_writer :summoner_id, :name, :current
+
+    def talents= new_talents
+      @talents = new_talents.map {|t| Talent.new t}
+    end
+  end
+end

data/{spec → lib}/lol/request.rb

@@ -1,4 +1,7 @@
 module Lol
+  class InvalidAPIResponse < StandardError; end
+  class NotFound < StandardError; end
+
   # Encapsulates common methods for all requests
   # Request classes inherit from this
   class Request
@@ -18,7 +21,7 @@ module Lol
     # @param path [String] API path to call
     # @return [String] full fledged url
     def api_url version, path, params = {}
-      lol = version == "v1.1" ? "lol" : ""
+      lol = version == "v2.1" ? "" : "lol"
       query_string = URI.encode_www_form params.merge api_key: api_key
       File.join "http://prod.api.pvp.net/api/", lol, "/#{region}/#{version}/", "#{path}?#{query_string}"
     end
@@ -28,24 +31,16 @@ module Lol
     # @return [String] raw response of the call
     def perform_request url
       response = self.class.get(url)
-      if response.is_a?(Hash) && response["status"]
-        raise InvalidAPIResponse.new(response["status"]["message"])
-      else
-        response
-      end
+      raise NotFound.new("404 Not Found") if response.respond_to?(:code) && response.not_found?
+      raise InvalidAPIResponse.new(response["status"]["message"]) if response.is_a?(Hash) && response["status"]
+
+      response
     end
 
     def initialize api_key, region
       @api_key = api_key
       @region = region
     end
-    private
 
-    # Sets api_key to new_key
-    # @param new_key [String] a Riot Games API key
-    # @return [String] new_key
-    def api_key= new_key
-      @api_key = new_key
-    end
   end
 end

data/lib/lol/rune.rb

@@ -0,0 +1,23 @@
+module Lol
+  class Rune < Model
+    # @!attribute [r] id
+    #   @return [Fixnum] Rune id
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] Rune name
+    attr_reader :name
+
+    # @!attribute [r] description
+    #   @return [String] Rune description
+    attr_reader :description
+
+    # @!attribute [r] tier
+    #   @return [Fixnum] Rune tier
+    attr_reader :tier
+
+    private
+
+    attr_writer :id, :name, :description, :tier
+  end
+end

data/lib/lol/rune_page.rb

@@ -0,0 +1,28 @@
+module Lol
+  class RunePage < Model
+    # @!attribute [r] id
+    #   @return [Fixnum] id of Runepage
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] name of Runepage
+    attr_reader :name
+
+    # @!attribute [r] current
+    #   @return [Boolean] is the Runepage currently active?
+    attr_reader :current
+
+
+    # @!attribute [r] current
+    #   @return [Array] array of Lol::RuneSlot
+    attr_reader :slots
+  end
+
+  private
+
+  attr_writer :id, :name, :current
+
+  def slots= *runeslots
+    @slots = runeslots.flatten.map {|slot| RuneSlot.new slot}
+  end
+end

data/lib/lol/rune_slot.rb

@@ -0,0 +1,27 @@
+module Lol
+  class RuneSlot < Model
+    # @!attribute [r] id
+    #   @return [Fixnum] id of RuneSlot
+    def id
+      @rune_slot_id
+    end
+
+    # @!attribute [r] rune
+    # @return [Rune] rune placed in the slot
+    attr_reader :rune
+
+    private
+
+    def rune= rune_data
+      @rune = Rune.new rune_data
+    end
+
+    def id= new_id
+      @rune_slot_id = new_id
+    end
+
+    def rune_slot_id= new_id
+      @rune_slot_id = new_id
+    end
+  end
+end

data/lib/lol/summoner.rb

@@ -0,0 +1,36 @@
+module Lol
+  class Summoner < Model
+    # @!attribute [r] id
+    #   @return [String]
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] Summoner Name
+    attr_reader :name
+
+    # @!attribute [r] profile_icon_id
+    #   @return [String] Id of the profile icon. No way to get the icon out for now
+    attr_reader :profile_icon_id
+
+    # @!attribute [r] revision_date
+    #   @return [Time] Last date of summoner profile revision
+    attr_reader :revision_date
+
+    # @!attribute [r] revision_date_str
+    #   @return [String] Human readable string representing date of summoner profile revision
+    attr_reader :revision_date_str
+
+    # @!attribute [r] summoner_level
+    #   @return [Numeric] 1-30
+    attr_reader :summoner_level
+
+    private
+
+    attr_writer :id, :name, :profile_icon_id, :summoner_level, :revision_date_str
+
+    def revision_date= value
+      @revision_date = value.is_a?(Numeric) && Time.at(value / 1000) || value
+    end
+
+  end
+end

data/lib/lol/summoner_request.rb

@@ -0,0 +1,45 @@
+module Lol
+  class SummonerRequest < Request
+    # Looks for a summoner name and returns the associated summoner
+    # @param [String] name Summoner name
+    # @return [Summoner] matching summoner
+    def by_name name
+      Summoner.new perform_request(api_url("v1.1", "summoner/by-name/#{name}"))
+    end
+
+    # Get list of summoner names by summoner IDs
+    # @param [Array] array of summoner ids
+    # @return [Array] array of Hash { "id" => "foo", "name" => "bar" }
+    def name *summoner_ids
+      perform_request(api_url("v1.1", "summoner/#{summoner_ids.join(",")}/name"))["summoners"].map do |summoner|
+        summoner
+      end
+    end
+
+    # Get summoner by summoner ID
+    # @param [String] summoner_id
+    # @return [Lol::Summoner]
+    def get summoner_id
+      Summoner.new perform_request(api_url("v1.1", "summoner/#{summoner_id}"))
+    end
+
+    # Get rune pages by summoner ID
+    # @param [String] summoner_id
+    # @return [Array] array of Lol::RunePage
+    def runes summoner_id
+      perform_request(api_url("v1.1", "summoner/#{summoner_id}/runes"))["pages"].map do |runepage|
+        RunePage.new runepage
+      end
+    end
+
+    # Get mastery pages by summoner ID
+    # @param [String] summoner_id
+    # @return [Array] array of Lol::MasteryPage
+    def masteries summoner_id
+      perform_request(api_url("v1.1", "summoner/#{summoner_id}/masteries"))["pages"].map do |masterypage|
+        MasteryPage.new masterypage
+      end
+    end
+
+  end
+end

data/lib/lol/talent.rb

@@ -0,0 +1,20 @@
+module Lol
+  class Talent < Model
+
+    # @!attribute [r] id
+    #   @return [Fixnum] id of talent
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] name of talent
+    attr_reader :name
+
+    # @!attribute [r] rank
+    #   @return [Fixnum] rank of talent
+    attr_reader :rank
+
+    private
+
+    attr_writer :id, :name, :rank
+  end
+end

data/lib/lol/version.rb

@@ -1,3 +1,3 @@
 module Lol
-  VERSION = "0.0.7"
+  VERSION = "0.9.1"
 end

data/spec/acceptance_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+require "lol"
+require "awesome_print"
+
+# Requires connection
+describe "Live API testing", :remote => true do
+  before(:all) do
+    VCR.configure do |c|
+      c.allow_http_connections_when_no_cassette = true
+    end
+  end
+
+  subject    { Lol::Client.new ENV['RIOT_GAMES_API_KEY'] }
+  let(:na)   { Lol::Client.new ENV['RIOT_GAMES_API_KEY'], :region => "na" }
+  let(:eune) { Lol::Client.new ENV['RIOT_GAMES_API_KEY'], :region => "eune" }
+  let(:br)   { Lol::Client.new ENV['RIOT_GAMES_API_KEY'], :region => "br"}
+  let(:tr)   { Lol::Client.new ENV['RIOT_GAMES_API_KEY'], :region => "tr"}
+
+  describe "champion-v1.1" do
+    context "working realms" do
+      %w(euw na eune).each do |realm|
+        it "works on #{realm}" do
+          subject.region = realm
+          expect { subject.champion.get }.not_to raise_error
+        end
+      end
+    end
+  end
+
+  describe "game-v1.2" do
+    context "working realms" do
+      %w(euw na eune).each do |realm|
+        it "works on #{realm}" do
+          subject.region = realm
+          expect { subject.game.recent(summoners[realm]) }.not_to raise_error
+        end
+      end
+    end
+  end
+
+  after(:all) do
+    VCR.configure do |c|
+      c.allow_http_connections_when_no_cassette = true
+    end
+  end
+end