sightstone 1.4.4 → 1.4.5

data/lib/sightstone/modules/team_module.rb

@@ -1,42 +1,42 @@
-require 'sightstone/modules/sightstone_base_module'
-require 'sightstone/summoner'
-require 'sightstone/team'
-
-module Sightstone
-# 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
-      summoner.id
-    else
-      summoner
-    end
-    
-    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 = JSON.parse(resp)
-      teams = []
-      data.each do |team|
-        teams << Team.new(team)
-      end
-      if block_given?
-        yield teams
-      else
-        return teams
-      end
-    }
-  end
-
-end
-end
+require 'sightstone/modules/sightstone_base_module'
+require 'sightstone/summoner'
+require 'sightstone/team'
+
+module Sightstone
+# 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
+      summoner.id
+    else
+      summoner
+    end
+    
+    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 = JSON.parse(resp)
+      teams = []
+      data.each do |team|
+        teams << Team.new(team)
+      end
+      if block_given?
+        yield teams
+      else
+        return teams
+      end
+    }
+  end
+
+end
+end

data/lib/sightstone/player_stats_summary.rb

@@ -1,39 +1,39 @@
-module Sightstone
-# summary of player statistic
-# @attr [Fixnum] summonerId ID of the summoner
-# @attr [Array<PlayerStatSummary] array of stat summaries for player with given id
-class PlayerStatsSummaryList
-  
-  attr_accessor :summonerId, :playerStatSummaries
-  
-  def initialize(data)
-    @summonerId = data['summonerId']
-    @playerStatSummaries = []
-    data['playerStatSummaries'].each do |summary|
-      @playerStatSummaries << PlayerStatSummary.new(summary)
-    end
-  end
-end
-
-# stat sumary for a queue
-# @attr [Fixnum] wins number of won game
-# @attr [Fixnum] losses number of lost games
-# @attr [Fixnum] modifyDate date of modification as unix date
-# @attr [String] playerStatSummaryType type of the stat (can be: AramUnranked5x5, CoopVsAI, OdinUnranked, RankedPremade3x3, RankedPremade5x5, RankedSolo5x5, RankedTeam3x3, RankedTeam5x5, Unranked, Unranked3x3, OneForAll5x5, FirstBlood1x1, FirstBlood2x2)
-# @attr [Hash<String, Fixnum>] aggregatedStats a hash of all stats (key) and their values.
-class PlayerStatSummary
-  attr_accessor :wins, :losses, :modifyDate, :playerStatSummaryType, :aggregatedStats
-  
-  def initialize(data)
-    @wins = data['wins']
-    @losses = data['losses']
-    @modifyDate = data['modifyDate']
-    @playerStatSummaryType = data['playerStatSummaryType']  
-    @aggregatedStats = {}
-    stat_keys = data['aggregatedStats'].keys
-    stat_keys.each do |stat|
-      @aggregatedStats[stat] = data['aggregatedStats'][stat]
-    end
-  end
-end
+module Sightstone
+# summary of player statistic
+# @attr [Fixnum] summonerId ID of the summoner
+# @attr [Array<PlayerStatSummary] array of stat summaries for player with given id
+class PlayerStatsSummaryList
+  
+  attr_accessor :summonerId, :playerStatSummaries
+  
+  def initialize(data)
+    @summonerId = data['summonerId']
+    @playerStatSummaries = []
+    data['playerStatSummaries'].each do |summary|
+      @playerStatSummaries << PlayerStatSummary.new(summary)
+    end
+  end
+end
+
+# stat sumary for a queue
+# @attr [Fixnum] wins number of won game
+# @attr [Fixnum] losses number of lost games
+# @attr [Fixnum] modifyDate date of modification as unix date
+# @attr [String] playerStatSummaryType type of the stat (can be: AramUnranked5x5, CoopVsAI, OdinUnranked, RankedPremade3x3, RankedPremade5x5, RankedSolo5x5, RankedTeam3x3, RankedTeam5x5, Unranked, Unranked3x3, OneForAll5x5, FirstBlood1x1, FirstBlood2x2)
+# @attr [Hash<String, Fixnum>] aggregatedStats a hash of all stats (key) and their values.
+class PlayerStatSummary
+  attr_accessor :wins, :losses, :modifyDate, :playerStatSummaryType, :aggregatedStats
+  
+  def initialize(data)
+    @wins = data['wins']
+    @losses = data['losses']
+    @modifyDate = data['modifyDate']
+    @playerStatSummaryType = data['playerStatSummaryType']  
+    @aggregatedStats = {}
+    stat_keys = data['aggregatedStats'].keys
+    stat_keys.each do |stat|
+      @aggregatedStats[stat] = data['aggregatedStats'][stat]
+    end
+  end
+end
 end

data/lib/sightstone/ranked_stats.rb

@@ -1,24 +1,24 @@
-module Sightstone
-# Ranked stats of a summoner
-# @attr [Fixnum] modifyDate date of last modification
-# @attr [Fixnum] summonerId id of the summoner
-# @attr [Hash<Fixnum, Hash<String, Fixnum>>] champions Statisitc for each champion in a Hash. Each key stands for a champions id (0 is sum of all champs) and returns a Hash<stat, stat_value>.
-class RankedStats
-  attr_accessor :champions, :modifyDate, :summonerId
-  
-  def initialize(data)
-    @summonerId = data['summonerId']
-    @modifyDate = data['modifyDate']
-    @champions = {}
-    
-    data['champions'].each do |champ|
-      id = champ['id']
-      @champions[id] = Hash.new unless @champions.has_key? id
-      stat_keys = champ['stats'].keys
-      stat_keys.each do |key|
-        @champions[id][key] = champ['stats'][key]
-      end
-    end
-  end
-end
-end
+module Sightstone
+# Ranked stats of a summoner
+# @attr [Fixnum] modifyDate date of last modification
+# @attr [Fixnum] summonerId id of the summoner
+# @attr [Hash<Fixnum, Hash<String, Fixnum>>] champions Statisitc for each champion in a Hash. Each key stands for a champions id (0 is sum of all champs) and returns a Hash<stat, stat_value>.
+class RankedStats
+  attr_accessor :champions, :modifyDate, :summonerId
+  
+  def initialize(data)
+    @summonerId = data['summonerId']
+    @modifyDate = data['modifyDate']
+    @champions = {}
+    
+    data['champions'].each do |champ|
+      id = champ['id']
+      @champions[id] = Hash.new unless @champions.has_key? id
+      stat_keys = champ['stats'].keys
+      stat_keys.each do |key|
+        @champions[id][key] = champ['stats'][key]
+      end
+    end
+  end
+end
+end

data/lib/sightstone/runebook.rb

@@ -1,52 +1,56 @@
-module Sightstone
-# Class to represent the runebook of a summoner
-# @attr [Numeric] summonerId id of the summoner
-# @attr [Array<RunePage>] pages of the runebook
-class RuneBook
-  attr_accessor :pages, :summonerId
-  
-  def initialize(data)
-    @summonerId = data['summonerId']
-    @pages = []
-    data['pages'].each do |page|
-      @pages << RunePage.new(page)
-    end
-  end
-end
-
-# Class to represent a page of a runebook
-# @attr [Numeric] id ID of the page
-# @attr [String] name page name
-# @attr [Boolean] current indicates if the page is selected
-# @attr [Hash<Numeric, Rune>] slots matches slot ids to the rune  
-class RunePage
-  attr_accessor :id, :slots, :name, :current
-  
-  def initialize(data)
-    @id = data['id']
-    @name = data['name']
-    @current = data['current']
-    @slots = {}
-    data['slots'].each do |slot|
-      @slots[slot['runeSlotId']] = Rune.new(slot['rune'])
-    end
-  end
-
-end
-
-# Class to represent a rune
-# @attr [Numeric] id ID of the rune
-# @attr [String] description description
-# @attr [String] name name of the rune
-# @attr [Numeric] tier rune tier (1,2,3)
-class Rune
-  attr_accessor :id, :description, :name, :tier
-  
-  def initialize(data)
-    @id = data['id']
-    @description = data['description']
-    @name = data['name']
-    @tier = data['tier']
-  end
-end
+module Sightstone
+# Class to represent the runebook of a summoner
+# @attr [Numeric] summonerId id of the summoner
+# @attr [Array<RunePage>] pages of the runebook
+class RuneBook
+  attr_accessor :pages, :summonerId
+  
+  def initialize(data)
+    @summonerId = data['summonerId']
+    @pages = []
+    if(data.has_key? 'pages')
+      data['pages'].each do |page|
+        @pages << RunePage.new(page)
+      end
+    end
+  end
+end
+
+# Class to represent a page of a runebook
+# @attr [Numeric] id ID of the page
+# @attr [String] name page name
+# @attr [Boolean] current indicates if the page is selected
+# @attr [Hash<Numeric, Rune>] slots matches slot ids to the rune  
+class RunePage
+  attr_accessor :id, :slots, :name, :current
+  
+  def initialize(data)
+    @id = data['id']
+    @name = data['name']
+    @current = data['current']
+    @slots = {}
+    if(data.has_key? 'slots')
+      data['slots'].each do |slot|
+        @slots[slot['runeSlotId']] = Rune.new(slot['rune'])
+      end
+    end
+  end
+
+end
+
+# Class to represent a rune
+# @attr [Numeric] id ID of the rune
+# @attr [String] description description
+# @attr [String] name name of the rune
+# @attr [Numeric] tier rune tier (1,2,3)
+class Rune
+  attr_accessor :id, :description, :name, :tier
+  
+  def initialize(data)
+    @id = data['id']
+    @description = data['description']
+    @name = data['name']
+    @tier = data['tier']
+  end
+end
 end

data/lib/sightstone/summoner.rb

@@ -1,23 +1,23 @@
-module Sightstone
-# Class to represent a summoner
-# @attr [String] name name
-# @attr [Long] id summoner id (used for other calls)
-# @attr [Integer] profileIconId profile icon id of the summoner
-# @attr [long] revisionDate timestamp of latest data change
-# @attr [Integer] level summoner level
-class Summoner
-  
-  attr_accessor :name, :id, :profileIconId, :revisionDate, :level
-  
-  # @param data [Hash] json hash representation of the summoner
-  def initialize(data)
-     @name = data['name']
-     @id =  data['id']
-     @profileIconId =  data['profileIconId']
-     @revisionDate =  data['revisionDate']
-     @level =  data['summonerLevel']
-  end
-  
-  
-end
+module Sightstone
+# Class to represent a summoner
+# @attr [String] name name
+# @attr [Long] id summoner id (used for other calls)
+# @attr [Integer] profileIconId profile icon id of the summoner
+# @attr [long] revisionDate timestamp of latest data change
+# @attr [Integer] level summoner level
+class Summoner
+  
+  attr_accessor :name, :id, :profileIconId, :revisionDate, :level
+  
+  # @param data [Hash] json hash representation of the summoner
+  def initialize(data)
+     @name = data['name']
+     @id =  data['id']
+     @profileIconId =  data['profileIconId']
+     @revisionDate =  data['revisionDate']
+     @level =  data['summonerLevel']
+  end
+  
+  
+end
 end

data/lib/sightstone/team.rb

@@ -1,117 +1,117 @@
-module Sightstone
-# 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, :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['fullId']
-    @lastJoinDate = data['lastJoinDate']
-    @secondLastJoinDate = data['secondLastJoinDate']
-    @matchHistory = []
-    data['matchHistory'].each do |game|
-      matchHistory << TeamHistoryGame.new(game)
-    end
-    @lastJoinedRankedTeamQueueDate=data['lastJoinedRankedTeamQueueDate']
-    @name = data['name']
-    @thirdLastJoinDate = data['thirdLastJoinDate']
-    @createDate = data['createDate']
-    @teamStatSummary = []
-    data['teamStatSummary']['teamStatDetails'].each do |detail|
-      teamStatSummary << TeamStat.new(detail)
-    end
-
-  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)
-    @ownerId = data['ownerId']
-    @memberList = []
-    data['memberList'].each do |m|
-      memberList << Member.new(m)
-    end
-  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)
-    @joinDate = data['joinDate']
-    @inviteDate = data['inviteDate']
-    @status = data['status']
-    @playerId = data['playerId']
-  end
-end
-
-# 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']
-    @fullId = data['fullId']
-    @teamStatType = data['teamStatType']
-
-  end
-end
-
-# 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']
-    @assists = data['assists']
-    @opposingTeamName = data['opposingTeamName']
-    @invalid = data['invalid']
-    @deaths = data['deaths']
-    @gameId = data['gameId']
-    @kills = data['kills']
-    @win = data['win']
-    @opposingTeamKills = data['opposingTeamKills']
-  end
-end
+module Sightstone
+# 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, :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['fullId']
+    @lastJoinDate = data['lastJoinDate']
+    @secondLastJoinDate = data['secondLastJoinDate']
+    @matchHistory = []
+    data['matchHistory'].each do |game|
+      matchHistory << TeamHistoryGame.new(game)
+    end
+    @lastJoinedRankedTeamQueueDate=data['lastJoinedRankedTeamQueueDate']
+    @name = data['name']
+    @thirdLastJoinDate = data['thirdLastJoinDate']
+    @createDate = data['createDate']
+    @teamStatSummary = []
+    data['teamStatSummary']['teamStatDetails'].each do |detail|
+      teamStatSummary << TeamStat.new(detail)
+    end
+
+  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)
+    @ownerId = data['ownerId']
+    @memberList = []
+    data['memberList'].each do |m|
+      memberList << Member.new(m)
+    end
+  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)
+    @joinDate = data['joinDate']
+    @inviteDate = data['inviteDate']
+    @status = data['status']
+    @playerId = data['playerId']
+  end
+end
+
+# 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']
+    @fullId = data['fullId']
+    @teamStatType = data['teamStatType']
+
+  end
+end
+
+# 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']
+    @assists = data['assists']
+    @opposingTeamName = data['opposingTeamName']
+    @invalid = data['invalid']
+    @deaths = data['deaths']
+    @gameId = data['gameId']
+    @kills = data['kills']
+    @win = data['win']
+    @opposingTeamKills = data['opposingTeamKills']
+  end
+end
 end