ruby-lol 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40594303990be0131e05065ee27214203ddc6c34
-  data.tar.gz: c145a0e4c8e88a5d078bd2899108646b48d63a31
+  metadata.gz: 4e4514fa6155984e91035d39c11f299138b3b104
+  data.tar.gz: 38fd725d0b900483523b5ffb7fb93c5131ce9eda
 SHA512:
-  metadata.gz: 93d7b18857c428884b43d7eb71262c7211ca2c400f107f3ec3d3fbf66251374b433fed299bfceee92c04ce41e45d8f59ae5f87e659106aa1f2bea94ee1c3aa6f
-  data.tar.gz: a47eeabc90db1141c5222ffdd4b16d1fd2491127ee1503e22427c44853f2dc9ac7412032b643ba38fc1e0c46d35967319d179b63874f90b6114e6d81c2f83307
+  metadata.gz: 2a9c947b9c8f803bf1cf13850bfd40f0d7aad75b1bd81878a508cef07f51353306154b859e26a7fab50f496913e3153275119f5d062786477a6d9105f7b08374
+  data.tar.gz: 26103c71d7782de216d3eeb7a81f0062e4bd33f101fa0bb4cc29d6e39de0a798221ce0516042060cbfaa275ff0cf4c51abce4752ff1222e0281a07f8c204383b

data/README.md

@@ -39,6 +39,25 @@ Or install it yourself as:
     # let's play a bit, who is free to play?
     client.champion.select {|c| c.free_to_play }.map {|c| c.name}
     # => %w(Aatrox Cassiopeia Lux Malphite MissFortune MonkeyKing Nautilus Sivir Talon Taric)
+
+    # it's time to fetch some of my games, isn't it?
+    games = client.game my_summoner_id
+    # => Array of Lol::Game
+
+    # let's get one game and look into it
+    game = games.first
+
+    # who was I playing with?
+    game.fellow_players
+    # => Array of Lol::Player
+
+    # gimme some stats!
+    game.statistics
+    # => Array of Lol::RawStatistic
+
+    # let's get some info about my Leagues now
+    leagues = client.league my_summoner_id
+    # => Array of Lol::League
 ```
 
 ## Contributing

data/lib/lol.rb

@@ -3,4 +3,16 @@ require __dir__ + "/lol/champion"
 require __dir__ + "/lol/game"
 require __dir__ + "/lol/league"
 require __dir__ + "/lol/player"
-require __dir__ + "/lol/statistic"
+require __dir__ + "/lol/raw_statistic"
+require __dir__ + "/lol/player_statistic"
+require __dir__ + "/lol/aggregated_statistic"
+require __dir__ + "/lol/ranked_statistics_summary"
+require __dir__ + "/lol/champion_statistics_summary"
+require __dir__ + "/lol/champion_statistic"
+require __dir__ + "/lol/team"
+require __dir__ + "/lol/roster"
+require __dir__ + "/lol/team_member"
+require __dir__ + "/lol/team_statistic"
+require __dir__ + "/lol/match_summary"
+require __dir__ + "/lol/league_entry"
+require __dir__ + "/lol/mini_series"

data/lib/lol/aggregated_statistic.rb

@@ -0,0 +1,21 @@
+require 'lol/model'
+
+module Lol
+  class AggregatedStatistic < Lol::Model
+    # @!attribute [r] id
+    #   @return [Fixnum] Statistic Type Id
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] Statistic Type name
+    attr_reader :name
+
+    # @!attribute [r] count
+    #   @return [Fixnum] Statistic value
+    attr_reader :count
+
+    private
+
+    attr_writer :id, :name, :count
+  end
+end

data/lib/lol/champion.rb

@@ -2,10 +2,6 @@ require 'lol/model'
 
 module Lol
   class Champion < Lol::Model
-    # @!attribute [r] raw
-    #   @return [String] raw version of options Hash used to initialize Champion
-    attr_reader :raw
-
     # @!attribute [r] id
     #   @return [Fixnum] id of Champion
     attr_reader :id

data/lib/lol/champion_statistic.rb

@@ -0,0 +1,25 @@
+require 'lol/model'
+
+module Lol
+  class ChampionStatistic < Lol::Model
+    # @!attribute [r] c
+    #   @return [Fixnum] Count of samples (games) that make up the aggregated value, where relevant.
+    attr_reader :c
+
+    # @!attribute [r] id
+    #   @return [Fixnum] Aggregated stat type Id
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] Aggregated stat type Name
+    attr_reader :name
+
+    # @!attribute [r] value
+    #   @return [Fixnum] Aggregated stat type Value
+    attr_reader :value
+
+    private
+
+    attr_writer :id, :name, :c, :value
+  end
+end

data/lib/lol/champion_statistics_summary.rb

@@ -0,0 +1,27 @@
+require 'lol/model'
+
+module Lol
+  class ChampionStatisticsSummary < Lol::Model
+    # @!attribute [r] id
+    #   @return [Fixnum] Champion Id
+    attr_reader :id
+
+    # @!attribute [r] name
+    #   @return [String] Champion Name
+    attr_reader :name
+
+    # @!attribute [r] stats
+    #   @return [Array] List of stats associated with this champion
+    attr_reader :stats
+
+    private
+
+    attr_writer :id, :name
+
+    def stats= collection
+      @stats = collection.map do |c|
+        c.respond_to?(:[]) && ChampionStatistic.new(c) || c
+      end
+    end
+  end
+end

data/lib/lol/client.rb

@@ -1,4 +1,5 @@
 require 'httparty'
+require 'uri'
 
 module Lol
   class InvalidAPIResponse < StandardError; end
@@ -18,16 +19,17 @@ module Lol
     # @param version [String] API version to call
     # @param path [String] API path to call
     # @return [String] full fledged url
-    def api_url version, path
+    def api_url version, path, params = {}
       lol = version == "v1.1" ? "lol" : ""
-      File.join "http://prod.api.pvp.net/api/", lol, "/#{region}/#{version}/", "#{path}?api_key=#{api_key}"
+      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
 
     # Calls the API via HTTParty and handles errors
     #
     def get url
       response = self.class.get(url)
-      if response["status"]
+      if response.is_a?(Hash) && response["status"]
         raise InvalidAPIResponse.new(response["status"]["message"])
       else
         response
@@ -69,9 +71,55 @@ module Lol
     # Retrieves leagues data for summoner, including leagues for all of summoner's teams, v2.1
     # @return [Array] an array of champions
     def league21 summoner_id
-      get(api_url("v2.1", "league/by-summoner/#{summoner_id}"))[summoner_id].map {|l| League.new}
+      response = get(api_url("v2.1", "league/by-summoner/#{summoner_id}"))[summoner_id]
+      response.is_a?(Hash) ? [League.new(response)] : response.map {|l| League.new l}
     end
 
+    # Calls the latest API version of stats
+    def stats *args
+      stats11 *args
+    end
+
+    # Retrieves player statistics summaries for the given summoner
+    # @return [Array] an array of player statistics, one per queue type
+    def stats11 summoner_id, extra = {}
+      if extra.keys.select { |k| k.to_sym != :season }.any?
+        raise ArgumentError, 'Only :season is allowed as extra parameter'
+      end
+      stats_api_path = "stats/by-summoner/#{summoner_id}/summary"
+      get(api_url('v1.1', stats_api_path, extra))['playerStatSummaries'].map do |player_stat_data|
+        PlayerStatistic.new player_stat_data
+      end
+    end
+
+    # Calls the latest API version of ranked_stats
+    def ranked_stats *args
+      ranked_stats11 *args
+    end
+
+    # Retrieves ranked statistics summary for the given summoner
+    # @return [RankedStatisticsSummary] Ranked Stats.
+    #   Includes stats for Twisted Treeline and Summoner's Rift
+    def ranked_stats11 summoner_id, extra = {}
+      if extra.keys.select { |k| k.to_sym != :season }.any?
+        raise ArgumentError, 'Only :season is allowed as extra parameter'
+      end
+      stats_api_path = "stats/by-summoner/#{summoner_id}/ranked"
+      RankedStatisticsSummary.new get api_url 'v1.1', stats_api_path, extra
+    end
+
+    # Calls the latest API version of team returning the list of teams for the given summoner
+    def team *args
+      team21 *args
+    end
+
+    # Retrieves the list of Teams for the given summoner
+    # @return [Array] List of Team
+    def team21 summoner_id
+      get(api_url 'v2.1', "team/by-summoner/#{summoner_id}").map do |team_data|
+        Team.new team_data
+      end
+    end
 
     # Initializes a Lol::Client
     # @param api_key [String]

data/lib/lol/game.rb

@@ -2,10 +2,6 @@ require 'lol/model'
 
 module Lol
   class Game < Lol::Model
-    # @!attribute [r] raw
-    #   @return [Hash] raw version of options Hash used to initialize Game
-    attr_reader :raw
-
     # @!attribute [r] id
     #   @return [Fixnum] Game Id
     attr_reader :game_id
@@ -15,7 +11,7 @@ module Lol
     attr_reader :champion_id
 
     # @!attribute [r] create_date
-    #   @return [DateTime] Date game was played
+    #   @return [Time] Date game was played
     attr_reader :create_date
 
     # @!attribute [r] create_date_str
@@ -74,7 +70,7 @@ module Lol
                 :create_date_str
 
     def create_date= value
-      @create_date = value.is_a?(DateTime) && value || DateTime.strptime(value.to_s, '%s')
+      @create_date = value.is_a?(Numeric) && Time.at(value / 1000) || value
     end
 
     def fellow_players= collection
@@ -85,8 +81,8 @@ module Lol
 
     def statistics= collection
       @statistics = collection.map do |c|
-        c.respond_to?(:[]) && Statistic.new(c) || c
+        c.respond_to?(:[]) && RawStatistic.new(c) || c
       end
     end
   end
-end
+end

data/lib/lol/league.rb

@@ -1,10 +1,6 @@
 module Lol
   # Holds the representation of a League
   class League < Model
-    # @!attribute [r] raw
-    #   @return [String] raw version of options Hash used to initialize League
-    attr_reader :raw
-
     # @!attribute [r] timestamp
     #   @return [String] timestamp of league snapshot
     attr_reader :timestamp
@@ -30,7 +26,8 @@ module Lol
     attr_writer :timestamp, :name, :tier, :queue
 
     def entries= list
-      "foo"
+      @entries = []
+      list.each {|entry| @entries << LeagueEntry.new(entry)}
     end
   end
 end

data/lib/lol/league_entry.rb

@@ -0,0 +1,86 @@
+module Lol
+  # Holds the representation of a League
+  class LeagueEntry < Model
+    # @!attribute [r] player_or_team_id
+    #   @return [String] id for the player or the team returned
+    attr_reader :player_or_team_id
+
+    # @!attribute [r] player_or_team_name
+    #   @return [String] name for the player or the team returned
+    attr_reader :player_or_team_name
+
+    # @!attribute [r] league_name
+    #   @return [String] name of league
+    attr_reader :league_name
+
+    # @!attribute [r] queue_type
+    #   @return [String] type of queue
+    attr_reader :queue_type
+
+    # @!attribute [r] entry tier
+    #   @return [String] tier of league
+    attr_reader :tier
+
+    # @!attribute [r] rank
+    #   @return [String] entry rank
+    attr_reader :rank
+
+    # @!attribute [r] league_points
+    #   @return [String] league points of entry
+    attr_reader :league_points
+
+    # @!attribute [r] wins
+    #   @return [String] wins
+    attr_reader :wins
+
+    # @!attribute [r] losses
+    #   @return [String] losses
+    attr_reader :losses
+
+    # @!attribute [r] is_hot_streak
+    #   @return [Boolean] is currently on hot streak
+    attr_reader :is_hot_streak
+
+    # @!attribute [r] is_veteran
+    #   @return [Boolean] is a veteran in this league
+    attr_reader :is_veteran
+
+    # @!attribute [r] is_fresh_blood
+    #   @return [Boolean] is fresh blood in this league
+    attr_reader :is_fresh_blood
+
+    # @!attribute [r] is_inactive
+    #   @return [Boolean] is marked as inactive
+    attr_reader :is_inactive
+
+    # @!attribute [r] last_played
+    #   @return [DateTime] date of last played game
+    #           at the time of writing this attributes is broken in the API
+    #           it always returns 0.
+    attr_reader :last_played
+
+    # @!attribute [r] time_until_decay
+    #   @return [Boolean] time until league decay
+    attr_reader :time_until_decay
+
+    # @!attribute [r] mini_series
+    #   @return [MiniSeries] if player is in a mini_series, returns the MiniSeries object
+    #           representing it
+    attr_reader :mini_series
+
+    private
+
+    attr_writer :player_or_team_id, :player_or_team_name, :league_name, :queue_type, :tier,
+                :league_points, :wins, :losses, :is_hot_streak, :is_veteran, :is_fresh_blood,
+                :is_inactive, :time_until_decay, :rank
+
+    def last_played= date
+      @last_played = date
+    end
+
+    def mini_series= raw
+      @mini_series = MiniSeries.new raw
+    end
+
+  end
+end

data/lib/lol/match_summary.rb

@@ -0,0 +1,59 @@
+require 'lol/model'
+
+module Lol
+  class MatchSummary < Lol::Model
+    # @!attribute [r] assists
+    #   @return [Fixnum] Number of assists
+    attr_reader :assists
+
+    # @!attribute [r] date
+    #   @return [Time] Match date
+    attr_reader :date
+
+    # @!attribute [r] deaths
+    #   @return [Fixnum] Number of deaths
+    attr_reader :deaths
+
+    # @!attribute [r] game_id
+    #   @return [Fixnum] Game Id
+    attr_reader :game_id
+
+    # @!attribute [r] game_mode
+    #   @return [String] Game Mode
+    attr_reader :game_mode
+
+    # @!attribute [r] invalid
+    #   @return [true] If the match is invalid
+    #   @return [false] If the match is valid
+    attr_reader :invalid
+
+    # @!attribute [r] kills
+    #   @return [Fixnum] Number of kills
+    attr_reader :kills
+
+    # @!attribute [r] map_id
+    #   @return [Fixnum] Map Id
+    attr_reader :map_id
+
+    # @!attribute [r] opposing_team_kills
+    #   @return [Fixnum] Opposing Team Kills
+    attr_reader :opposing_team_kills
+
+    # @!attribute [r] opposing_team_name
+    #   @return [String] Opposing Team Name
+    attr_reader :opposing_team_name
+
+    # @!attribute [r] win
+    #   @return [true] If the team won this match
+    #   @return [false] If the team lost this match
+    attr_reader :win
+
+    private
+
+    attr_writer :assists, :deaths, :game_id, :game_mode, :invalid, :kills, :map_id, :opposing_team_kills, :opposing_team_name, :win
+
+    def date= value
+      @date = value.is_a?(Numeric) && Time.at(value / 1000) || value
+    end
+  end
+end

data/lib/lol/mini_series.rb

@@ -0,0 +1,29 @@
+module Lol
+  # Holds the representation of a MiniSeries
+  class MiniSeries < Model
+    # @!attribute [r] target
+    #   @return [String] number of games required to advance
+    attr_reader :target
+
+    # @!attribute [r] wins
+    #   @return [Fixnum] wins in the miniseries
+    attr_reader :wins
+
+    # @!attribute [r] losses
+    #   @return [Fixnum] losses in the miniseries
+    attr_reader :losses
+
+    # @!attribute [r] time_left_to_play_millis
+    #   @return [Fixnum] time left to play the miniseries, expressed in milliseconds
+    attr_reader :time_left_to_play_millis
+
+    # @!attribute [r] progress
+    #   @return [String] string representation of the miniseries progress.
+    #           i.e. "WLN" (Win / Loss / Not played)
+    attr_reader :progress
+
+    private
+
+    attr_writer :target, :wins, :losses, :time_left_to_play_millis, :progress
+  end
+end