sightstone 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03ecf96e34045604da8d2b7f9acfb3fcaf877f06
-  data.tar.gz: ef7984584413ad9cb2a37d473f455fb87573c910
+  metadata.gz: 1a05d3f035d3a0ac01cc753b4f5bb8cffa2c1608
+  data.tar.gz: f71878adee457931d79e38ab063dafc12330e4cf
 SHA512:
-  metadata.gz: 5a799483b0723d247ccec6835bd889adabf87668d24cf295612cc5162601e0c2048e36fe5c46ee230bf483a29c7c716361aab472b0f77f8174d702b183fca958
-  data.tar.gz: 3ce13ece552482e2d92e91afda5bcedd7999b412adb965dcc8467b1542f26e44c5bf58b20d6a9f6a66e1ce7e0b23f5132b3e1c44bae49e09c08f4e0939b8947f
+  metadata.gz: 392c096c578bb08d475b394caf6b6b97dc8d4a53aac459446db1aa23a819fb921ce51e5705b02dbaa1c19a30631007316c1aebf27bcf7eb8e7ad3222826d9992
+  data.tar.gz: 63fdab5267b0a95dd072ef49fed9e9e666d0b5c8136525b581903d8e0849dc46d188248726ef810a008e2153139d2df67779991553a0a9279b76ece93ec4425f

data/lib/sightstone/match_history.rb

@@ -1,5 +1,8 @@
 require 'sightstone/stat'
 
+# match history of a summoner
+# @attr [Fixnum] summonerId ID of the summoner
+# @attr [Array<HistoryGame>] games unsorted list of recently played games
 class MatchHistory
   attr_accessor :games, :summonerId
   
@@ -7,13 +10,28 @@ class MatchHistory
     @summonerId = data['summonerId']
     @games = []
     data['games'].each do |game|
-      games << Game.new(game)
+      games << HistoryGame.new(game)
     end
   end
 end
 
-class Game
-  attr_accessor :championId, :createDate, :createDateString, :fellowPlayers, :gameId, :gameMode, :gameType, :invalid, :level, :mapId, :spell1, :spell2, :statistics, :subType, :teamId
+# A played game
+# @attr [Fixnum] championId ID of the played champ of requested summoner
+# @attr [Fixnum] createDate UNIX timestamp of creation date of the games
+# @attr [Array<Player>] fellowPlayers a list of all players of the game
+# @attr [Fixnum] gameId ID of the game
+# @attr [String] gameMode mode of the game
+# @attr [String] gameType type of the game
+# @attr [Boolean] invalid Invalid flag #TODO what is this?
+# @attr [Fixnum] level level of the requested summoner
+# @attr [Fixnum] mapId ID of the played map
+# @attr [Fixnum] spell1 selected summoner spell no 1
+# @attr [Fixnum] spell2 selected summoner spell no 2
+# @attr [String] subtype subtype
+# @attr [Fixnum] teamId ID of the team if there is a team associated to the game
+# @attr [Array<Stat>] statistics statistics of the game
+class HistoryGame
+  attr_accessor :championId, :createDate, :fellowPlayers, :gameId, :gameMode, :gameType, :invalid, :level, :mapId, :spell1, :spell2, :statistics, :subType, :teamId
   
   def initialize(data)
     @championId=data['championId']
@@ -29,7 +47,7 @@ class Game
     @invalid=data['invalid']
     @level=data['level']
     @mapId=data['mapId']
-    @spell1=data['spell1]']
+    @spell1=data['spell1']
     @spell2=data['spell2']
     @statistics = []
     data['statistics'].each do |stat|
@@ -40,6 +58,10 @@ class Game
   end
 end
 
+# player of a game
+# @attr [Fixnum] championId ID of played Champion
+# @attr [Fixnum] summonerId ID of the summoner
+# @attr [Fixnum] teammId ID of the team
 class Player
   attr_accessor :championId, :summonerId, :teamId
   
@@ -48,4 +70,22 @@ class Player
     @summonerId = data['summonerId']
     @teamId = data['teamId']
   end
+end
+
+# statistical value of a game
+# @attr [Fixnum] id ID of the statistical value
+# @attr [String] mame name of the statistical value (example: MINIONS_KILLED)
+# @attr [Fixnum] value value
+class Stat
+  attr_accessor :id, :name, :value
+  
+  def initialize(data)
+    @name = data['name']
+    @id = data['id']
+    @value = if data.has_key? 'value'
+      data['value']
+    else
+      data['count']
+    end
+  end
 end

data/lib/sightstone/modules/game_module.rb

@@ -2,12 +2,17 @@ require 'sightstone/modules/sightstone_base_module'
 require 'sightstone/summoner'
 require 'sightstone/match_history'
 
+# module to access the game api
 class GameModule < SightstoneBaseModule
   
   def initialize(sightstone)
     @sightstone = sightstone
   end
   
+  # returns the match history of a summoner
+  # @param [Summoner, Fixnum] summoner summoner object or id of a summoner
+  # @param optional [Hash] optional arguments: :region => replaces default region
+  # @return [MatchHistory] match history of the summoner
   def recent(summoner, optional={})
     region = optional[:region] || @sightstone.region
    id = if summoner.is_a? Summoner
@@ -15,7 +20,7 @@ class GameModule < SightstoneBaseModule
    else
      summoner
    end
-   uri = "https://prod.api.pvp.net/api/lol/#{region}/v1.1/game/by-summoner/#{id}/recent"
+   uri = "https://prod.api.pvp.net/api/lol/#{region}/v1.2/game/by-summoner/#{id}/recent"
    
     response = _get_api_response(uri)
     _parse_response(response) { |resp|

data/lib/sightstone/modules/team_module.rb

@@ -2,11 +2,16 @@ require 'sightstone/modules/sightstone_base_module'
 require 'sightstone/summoner'
 require 'sightstone/team'
 
+# module to make calls to the team api
 class TeamModule < SightstoneBaseModule
   def initialize(sightstone)
     @sightstone = sightstone
   end
 
+  # call to receive all teams for a summoner
+  # @param [Summoner, Fixnum] summoner summoner object or id of a summoner
+  # @param optional [Hash] optional arguments: :region => replaces default region
+  # @ return [Array<Team>] An array containing all teams of the given summoner
   def teams(summoner, optional={})
     region = optional[:region] || @sightstone.region
     id = if summoner.is_a? Summoner
@@ -15,7 +20,7 @@ class TeamModule < SightstoneBaseModule
       summoner
     end
     
-    uri = "https://prod.api.pvp.net/api/#{region}/v2.1/team/by-summoner/#{id}"
+    uri = "https://prod.api.pvp.net/api/lol/#{region}/v2.2/team/by-summoner/#{id}"
 
     response = _get_api_response(uri)
     _parse_response(response) { |resp|

data/lib/sightstone/team.rb

@@ -1,18 +1,32 @@
+# A Team
+# @attr [Fixnum] createDate UNIX timestamp of team creation
+# @attr [String] fullId id of the team
+# @attr [Fixnum] lastGameDate UNIX timespamp of last game
+# @attr [Fixnum] lastJoinDate UNIX timestamp of the date where the newest player joined the team
+# @attr [Fixnum] lastJoinedRankedTeamQueueDate UNIX timestamp of latest team game
+# @attr [Array<TeamHistoryGame>] matchHistory List of latest games
+# @attr [Fixnum] modifyDate UNIX timestamp of latest team modification
+# @attr [String] name team name
+# @attr [Roster] roster team roster
+# @attr [Fixnum] secondLastJoinDate UNIX timestamp of second latest join date of a member
+# @attr [String] status team status
+# @attr [String] tag tag of the team
+# @attr [Array<TeamStat>] teamStatSummary array containing the stats of the team
+# @attr [Fixnum] thridLastJoinDate UNIX timestamp of third latest join date of a member       
 class Team
-  attr_accessor :teamStatSummary, :status, :tag, :roster, :lastGameDate, :modifyDate, :teamId, :timestamp, :lastJoinDate, :secondLastJoinDate, :matchHistory, :lastJoinedRankedTeamQueueDate, :name, :thirdLastJoinDate, :createDate
+  attr_accessor :teamStatSummary, :status, :tag, :roster, :lastGameDate, :modifyDate, :teamId, :lastJoinDate, :secondLastJoinDate, :matchHistory, :lastJoinedRankedTeamQueueDate, :name, :thirdLastJoinDate, :createDate
   def initialize(data)
     @status = data['status']
     @tag = data['tag']
     @roster = Roster.new(data['roster'])
     @lastGameDate = data['lastGameDate']
     @modifyDate = data['modifyDate']
-    @teamId = data['teamId']['fullId']
-    @timestamp = data['timestamp']
+    @teamId = data['fullId']
     @lastJoinDate = data['lastJoinDate']
     @secondLastJoinDate = data['secondLastJoinDate']
     @matchHistory = []
     data['matchHistory'].each do |game|
-      matchHistory << Game.new(game)
+      matchHistory << TeamHistoryGame.new(game)
     end
     @lastJoinedRankedTeamQueueDate=data['lastJoinedRankedTeamQueueDate']
     @name = data['name']
@@ -26,6 +40,9 @@ class Team
   end
 end
 
+# class to represent the roster of a team
+# @attr [Fixnum] ownerId summoner ID of the team owner
+# @attr [Array<Member>] memberList list of all team members
 class Roster
   attr_accessor :ownerId, :memberList
   def initialize(data)
@@ -37,6 +54,11 @@ class Roster
   end
 end
 
+# member of a team
+# @attr [Fixnum] joinDate UNIX timestamp of join date
+# @attr [Fixnum] inviteDate UNIX timestamp of invitation date
+# @attr [String] status status of the team member
+# @attr [Fixnum] playerId summoner ID of the member
 class Member
   attr_accessor :joinDate, :inviteDate, :status, :playerId
   def initialize(data)
@@ -47,20 +69,37 @@ class Member
   end
 end
 
-class TeamStat
-  attr_accessor :wins, :losses, :averageGamesPlayed, :teamId, :teamStatType
+# statistical overview of a team
+# @attr [Fixnum] wins number of won games
+# @attr [Fixnum] losses number of lost games
+# @attr [Fixnum] averageFamesPlayed average played games of member
+# @attr [String] fullId id of the team
+# @attr [String] teamStatType queue of the stat
+class TeamStat 
+  attr_accessor :wins, :losses, :averageGamesPlayed, :fullId, :teamStatType
   def initialize(data)
     @wins = data['wins']
     @losses = data['losses']
     @averageGamesPlayed = data['averageGamesPlayed']
-    @teamId = data['teamId']
+    @fullId = data['fullId']
     @teamStatType = data['teamStatType']
 
   end
 end
 
-class Game
-  attr_accessor :gameMode, :mapId, :assists, :opposingTeamName, :invalid, :deaths, :gameId, :kills, :win, :date, :opposingTeamKills
+# Recent game of a team
+# @attr [Fixnum] gameMode mode of the game
+# @attr [Fixnum] mapId ID of the map
+# @attr [Fixnum] assists assists of the team
+# @attr [String] opposingTeamName name of the enemy team
+# @attr [Boolean] invalid Invalid flag # TODO what is this?
+# @attr [Fixnum] deaths number of deaths summed over all players of the team
+# @attr [Boolean] win true if game has been won by the team 
+# @attr [Fixnum] opposingTeamKills number of kills of the enemy team
+# @attr [Fixnum] gameId ID of the game
+# @attr [Fixnum] kills kills of the team
+class TeamHistoryGame
+  attr_accessor :gameMode, :mapId, :assists, :opposingTeamName, :invalid, :deaths, :gameId, :kills, :win, :opposingTeamKills
   def initialize(data)
     @gameMode = data['gameMode']
     @mapId = data['mapId']
@@ -71,7 +110,6 @@ class Game
     @gameId = data['gameId']
     @kills = data['kills']
     @win = data['win']
-    @date = data['date']
     @opposingTeamKills = data['opposingTeamKills']
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sightstone
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Daniel Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-31 00:00:00.000000000 Z
+date: 2014-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -44,6 +44,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/sightstone.rb
 - lib/sightstone/champion.rb
 - lib/sightstone/league.rb
 - lib/sightstone/masterybook.rb
@@ -59,10 +60,8 @@ files:
 - lib/sightstone/player_stats_summary.rb
 - lib/sightstone/ranked_stats.rb
 - lib/sightstone/runebook.rb
-- lib/sightstone/stat.rb
 - lib/sightstone/summoner.rb
 - lib/sightstone/team.rb
-- lib/sightstone.rb
 homepage: https://github.com/danijoo/Sightstone
 licenses:
 - MIT
@@ -83,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for riots league of legends api

data/lib/sightstone/stat.rb

@@ -1,12 +0,0 @@
-class Stat
-  attr_accessor :name, :value
-  
-  def initialize(data)
-    @name = data['name']
-    @value = if data.has_key? 'value'
-      data['value']
-    else
-      data['count']
-    end
-  end
-end