sightstone 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38279a7f1b4ec4691e88ed7fb2ac5cefebeca985
-  data.tar.gz: b2498dc2fc739ae1729e17b1bfabb712c91b4b75
+  metadata.gz: 674b8ccfe9635887055e21b15151ee42e3bc6f98
+  data.tar.gz: 3ee4495da48ce5b376a699dd2ead22d4943536c1
 SHA512:
-  metadata.gz: 76132725fa1f45fdaafddbebf2cc527084d7afc1463a9e20dfdc674fd8ee6b762551b2d3cb02cadba79b0888a4d5f480bd2a70f4dd01c26e73f46f73407d3303
-  data.tar.gz: 22137135214f309482ec30867cca98d3df6fbf8da76c2da6ec1f9c417b70bec980be0fc4c828f94328dbd1df0907225b973a2e3a36c7c65b9dd425b81662adbf
+  metadata.gz: 0cb27f775a73026f9e901199d5afd13443b2276adfa96710f48244e670875dd845a805c5ab2f8f857e379e7bae7278a2df09f969859750c9a333b93e518238ba
+  data.tar.gz: 23a6a7e7f763555c2dd3556c44aa3e214adc6a19c75b0b92e1c0d79c5628fc7ddf29bfa25ef6ba0d8488515321a00b9a8f6594e3922a50f3642ba4e8e65684b7

data/lib/sightstone.rb

@@ -1,60 +1,60 @@
-require 'rest_client'
-require 'json'
-require 'sightstone/modules/champion_module'
-require 'sightstone/modules/summoner_module'
-require 'sightstone/modules/game_module'
-require 'sightstone/modules/league_module'
-require 'sightstone/modules/stats_module'
-require 'sightstone/modules/team_module'
-require 'sightstone/modules/datadragon_module'
-
-# This is the main class of the Sightstone gem. All calls should be perfomrmed through this class.
-# @attr [String] region The default region
-# @attr [String] api_key Your api key
-# @attr [SummonerModule] summoner Module to call the summoners api
-# @attr [ChampionModule] Champion module to call the champion api
-# @attr [GameModule] Game module to call the game api
-# @attr [LeagueModule] League module to call the leagues api
-# @attr [StatsModule] Stats module to call the stats api
-# @attr [TeamModule] Team module to call the team api
-module Sightstone
-
-class Sightstone
-  
-  attr_accessor :region
-  attr_accessor :api_key
-  attr_accessor :summoner, :champion, :game, :league, :stats, :team, :ddragon
-  
-  # @param api_key [String] Riot developer api key
-  # @param region [String] The default region to be used. See riots dev. page for supported regions.
-  def initialize(api_key, region='euw')
-    @api_key = api_key
-    @region = region
-    
-    @summoner = SummonerModule.new(self)
-    @champion = ChampionModule.new(self)
-    @game = GameModule.new(self)
-    @league = LeagueModule.new(self)
-    @stats = StatsModule.new(self)
-    @team = TeamModule.new(self)
-    @ddragon = DatadragonModule.new(self)
-  end
-end
-
-# Base class for exceptions raised by the gem
-class SightstoneApiException < Exception; end
-
-# Raised if no or an invalid api key was passed to the api
-class InvalidApiKeyException < SightstoneApiException; end
-
-# Raised if the given developer cannot be found (api returns http error code 404)
-class SummonerNotFoundException < SightstoneApiException; end
-
-# Raised if the connection to the api failed
-class SightstoneConnectionException < SightstoneApiException; end
-
-# Raised when the RateLimit has been exceeded (api returns http error code 429)
-class RateLimitExceededException < SightstoneApiException; end
-
-
-end
+require 'rest_client'
+require 'json'
+require 'sightstone/modules/champion_module'
+require 'sightstone/modules/summoner_module'
+require 'sightstone/modules/game_module'
+require 'sightstone/modules/league_module'
+require 'sightstone/modules/stats_module'
+require 'sightstone/modules/team_module'
+require 'sightstone/modules/datadragon_module'
+
+# This is the main class of the Sightstone gem. All calls should be perfomrmed through this class.
+# @attr [String] region The default region
+# @attr [String] api_key Your api key
+# @attr [SummonerModule] summoner Module to call the summoners api
+# @attr [ChampionModule] Champion module to call the champion api
+# @attr [GameModule] Game module to call the game api
+# @attr [LeagueModule] League module to call the leagues api
+# @attr [StatsModule] Stats module to call the stats api
+# @attr [TeamModule] Team module to call the team api
+module Sightstone
+
+class Sightstone
+  
+  attr_accessor :region
+  attr_accessor :api_key
+  attr_accessor :summoner, :champion, :game, :league, :stats, :team, :ddragon
+  
+  # @param api_key [String] Riot developer api key
+  # @param region [String] The default region to be used. See riots dev. page for supported regions.
+  def initialize(api_key, region='euw')
+    @api_key = api_key
+    @region = region
+    
+    @summoner = SummonerModule.new(self)
+    @champion = ChampionModule.new(self)
+    @game = GameModule.new(self)
+    @league = LeagueModule.new(self)
+    @stats = StatsModule.new(self)
+    @team = TeamModule.new(self)
+    @ddragon = DatadragonModule.new(self)
+  end
+end
+
+# Base class for exceptions raised by the gem
+class SightstoneApiException < Exception; end
+
+# Raised if no or an invalid api key was passed to the api
+class InvalidApiKeyException < SightstoneApiException; end
+
+# Raised if the given developer cannot be found (api returns http error code 404)
+class SummonerNotFoundException < SightstoneApiException; end
+
+# Raised if the connection to the api failed
+class SightstoneConnectionException < SightstoneApiException; end
+
+# Raised when the RateLimit has been exceeded (api returns http error code 429)
+class RateLimitExceededException < SightstoneApiException; end
+
+
+end

data/lib/sightstone/champion.rb

@@ -1,32 +1,32 @@
-module Sightstone
-# Class to represent a champion
-# @attr [Boolean] active determines if champion is active
-# @attr [Integer] attackRank attack rank
-# @attr [Boolean] botEnabled Bot enabled flag (for custom games)
-# @attr [Boolean] botMmEnabled Bot Match Made enabeld flag (for Coop/AI games)
-# @attr [Integer] defenseRank	Champion defense rank.
-# @attr [Integer] difficultyRank Champion difficulty rank.
-# @attr [Boolean] freeToPlay Indicates if the champion is free to play. Free to play champions are rotated periodically.
-# @attr [Fixnum] id	Champion ID.
-# @attr [Integer] magicRank	Champion magic rank.
-# @attr [String] name Champion name.
-# @attr [boolean] rankedPlayEnabled	Ranked play enabled flag.
-class Champion
-  attr_accessor :active, :attackRank, :botEnabled, :botMmEnabled
-  attr_accessor :defenseRank, :difficultyRank, :freeToPlay, :id, :magicRank, :name, :rankedPlayEnabled
-  
-  def initialize(data)
-    @active = data['active']
-    @attackRank = data['attackRank']
-    @botEnabled = data['botEnabled']
-    @defenseRank = data['defenseRank']
-    @difficultyRank = data['difficultyRank']
-    @freeToPlay = data['freeToPlay']
-    @id = data['id']
-    @magicRank = data['magicRank']
-    @name = data['name']
-    @rankedPlayEnabled = data['rankedPlayEnabled']
-  end
-  
-end
+module Sightstone
+# Class to represent a champion
+# @attr [Boolean] active determines if champion is active
+# @attr [Integer] attackRank attack rank
+# @attr [Boolean] botEnabled Bot enabled flag (for custom games)
+# @attr [Boolean] botMmEnabled Bot Match Made enabeld flag (for Coop/AI games)
+# @attr [Integer] defenseRank	Champion defense rank.
+# @attr [Integer] difficultyRank Champion difficulty rank.
+# @attr [Boolean] freeToPlay Indicates if the champion is free to play. Free to play champions are rotated periodically.
+# @attr [Fixnum] id	Champion ID.
+# @attr [Integer] magicRank	Champion magic rank.
+# @attr [String] name Champion name.
+# @attr [boolean] rankedPlayEnabled	Ranked play enabled flag.
+class Champion
+  attr_accessor :active, :attackRank, :botEnabled, :botMmEnabled
+  attr_accessor :defenseRank, :difficultyRank, :freeToPlay, :id, :magicRank, :name, :rankedPlayEnabled
+  
+  def initialize(data)
+    @active = data['active']
+    @attackRank = data['attackRank']
+    @botEnabled = data['botEnabled']
+    @defenseRank = data['defenseRank']
+    @difficultyRank = data['difficultyRank']
+    @freeToPlay = data['freeToPlay']
+    @id = data['id']
+    @magicRank = data['magicRank']
+    @name = data['name']
+    @rankedPlayEnabled = data['rankedPlayEnabled']
+  end
+  
+end
 end

data/lib/sightstone/league.rb

@@ -1,73 +1,74 @@
-module Sightstone
-# Class to represent a league
-# @attr [String] name name of the league
-# @attr [String] queue queue Type (can be: RANKED_SOLO_5x5, RANKED_TEAM_3x3, RANKED_TEAM_5x5)
-# @attr [String] tier tier of the requestet summoner (can be: CHALLENGER, DIAMOND, PLATINUM, GOLD, SILVER, BRONZE)
-# @attr [Array<LeagueItem>] entries  
-class League
-  attr_accessor :entries, :name, :queue, :tier
-  
-  def initialize(data)
-    @name = data['name']
-    @queue = data['queue']
-    @tier = data['tier']
-    @entries = []
-    data['entries'].each do |entry|
-      @entries << LeagueItem.new(entry)
-    end  
-  end
-end
-
-# One entry of a league
-# @attr [Boolean] isFreshBlood determines if summoner is new in the league
-# @attr [Boolean] isHotStreak hotStreak = 3 games won in a row
-# @attr [Boolean] isInactive true if summoner is inactive
-# @attr [Boolean] isVetern true if veteran
-# @attr [Fixnum] lastPlayed timestamp of last played game
-# @attr [String] leagueName name of the league
-# @attr [Fixnum] leaguePoints leaguePoints
-# @attr [MiniSeries, nil] nil if player has no miniseries, a miniseries object if he is in one
-# @attr [String] playerOrTeamId id of the player or team as a string
-# @attr [String] playerOrTeamName name of the player/team
-# @attr [String] queueType type of the queue
-# @attr [String] rank rank (can be: I, II, III, IV, V)
-# @attr [String] tier tier (can be: CHALLENGER, DIAMOND, PLATINUM, GOLD, SILVER, BRONZE)
-# @attr [Fixnum] wins number of won matches in given queue
-class LeagueItem
-  attr_accessor :isFreshBlood, :isHotStreak, :isInactive, :isVeteran, :lastPlayed, :leagueName, :leaguePoints, :miniSeries, :playerOrTeamId, :playerOrTeamName, :queueType, :rank, :tier, :wins
- 
-  def initialize(data)
-    @isFreshBlood=data['isFreshBlood']
-    @isHotStreak=data['isHotStreak']
-    @isInactive=data['isInactive']
-    @isVeteran=data['isVeteran']
-    @lastPlayed=data['lastPlayed']
-    @leagueName=data['leagueName']
-    @leaguePoints=data['leaguePoints']
-    @miniSeries= MiniSeries.new(data['miniSeries']) if data.has_key? 'miniSeries'
-    @playerOrTeamId=data['playerOrTeamId']
-    @playerOrTeamName=data['playerOrTeamName']
-    @queueType=data['queueType']
-    @rank=data['rank']
-    @tier=data['tier']
-    @wins=data['wins']
-  end
-end
-
-# Class to represent a MiniSeries (Promotion games)
-# @attr [Fixnum] losses number of lost games of the series
-# @attr [Fixnum] wins number of won games of the series
-# @attr [Fixnum] target number of required wins to win the series
-# @attr [Fixnum] timeLeftToPlayMillis time left to complete the series
-# @attr [String] win/loose history as a string. Each character shows a (W)in, (L)oss or (N)ot played
-class MiniSeries
-  attr_accessor :losses, :wins, :target, :progress, :timeLeftToPlayMillis
-  def initialize(data)
-    @losses = data['losses']
-    @wins = data['wins']
-    @target = data['target']
-    @progress = data['progress']
-    @timeLeftToPlayMillis = data['timeLeftToPlayMillis']
-  end
-end
-end
+module Sightstone
+# Class to represent a league
+# @attr [String] name name of the league
+# @attr [String] queue queue Type (can be: RANKED_SOLO_5x5, RANKED_TEAM_3x3, RANKED_TEAM_5x5)
+# @attr [String] tier tier of the requestet summoner (can be: CHALLENGER, DIAMOND, PLATINUM, GOLD, SILVER, BRONZE)
+# @attr [Array<LeagueItem>] entries  
+class League
+  attr_accessor :entries, :name, :queue, :tier, :participantId
+  
+  def initialize(data)
+    @name = data['name']
+    @queue = data['queue']
+    @tier = data['tier']
+    @participantId = data['participantId']
+    @entries = []
+    data['entries'].each do |entry|
+      @entries << LeagueItem.new(entry)
+    end  
+  end
+end
+
+# One entry of a league
+# @attr [Boolean] isFreshBlood determines if summoner is new in the league
+# @attr [Boolean] isHotStreak hotStreak = 3 games won in a row
+# @attr [Boolean] isInactive true if summoner is inactive
+# @attr [Boolean] isVetern true if veteran
+# @attr [Fixnum] lastPlayed timestamp of last played game
+# @attr [String] leagueName name of the league
+# @attr [Fixnum] leaguePoints leaguePoints
+# @attr [MiniSeries, nil] nil if player has no miniseries, a miniseries object if he is in one
+# @attr [String] playerOrTeamId id of the player or team as a string
+# @attr [String] playerOrTeamName name of the player/team
+# @attr [String] queueType type of the queue
+# @attr [String] rank rank (can be: I, II, III, IV, V)
+# @attr [String] tier tier (can be: CHALLENGER, DIAMOND, PLATINUM, GOLD, SILVER, BRONZE)
+# @attr [Fixnum] wins number of won matches in given queue
+class LeagueItem
+  attr_accessor :isFreshBlood, :isHotStreak, :isInactive, :isVeteran, :lastPlayed, :leagueName, :leaguePoints, :miniSeries, :playerOrTeamId, :playerOrTeamName, :queueType, :rank, :tier, :wins
+ 
+  def initialize(data)
+    @isFreshBlood=data['isFreshBlood']
+    @isHotStreak=data['isHotStreak']
+    @isInactive=data['isInactive']
+    @isVeteran=data['isVeteran']
+    @lastPlayed=data['lastPlayed']
+    @leagueName=data['leagueName']
+    @leaguePoints=data['leaguePoints']
+    @miniSeries= MiniSeries.new(data['miniSeries']) if data.has_key? 'miniSeries'
+    @playerOrTeamId=data['playerOrTeamId']
+    @playerOrTeamName=data['playerOrTeamName']
+    @queueType=data['queueType']
+    @rank=data['rank']
+    @tier=data['tier']
+    @wins=data['wins']
+  end
+end
+
+# Class to represent a MiniSeries (Promotion games)
+# @attr [Fixnum] losses number of lost games of the series
+# @attr [Fixnum] wins number of won games of the series
+# @attr [Fixnum] target number of required wins to win the series
+# @attr [Fixnum] timeLeftToPlayMillis time left to complete the series
+# @attr [String] win/loose history as a string. Each character shows a (W)in, (L)oss or (N)ot played
+class MiniSeries
+  attr_accessor :losses, :wins, :target, :progress, :timeLeftToPlayMillis
+  def initialize(data)
+    @losses = data['losses']
+    @wins = data['wins']
+    @target = data['target']
+    @progress = data['progress']
+    @timeLeftToPlayMillis = data['timeLeftToPlayMillis']
+  end
+end
+end

data/lib/sightstone/masterybook.rb

@@ -1,50 +1,50 @@
-module Sightstone
-# Class to represent the masterybook of a summoner
-# @attr [Numeric] summonerId id of the summoner
-# @attr [Array<MasteryPage>] pages of the masterybook
-class MasteryBook
-  attr_accessor :pages, :summonerId
-  
-  def initialize(data)
-    @summonerId = data['summonerId']
-    @pages = []
-    data['pages'].each do |page|
-      @pages << MasteryPage.new(page)
-    end
-  end
-end
-
-# Class to represent a page of a masterybook
-# @attr [Numeric] id ID of the page
-# @attr [String] name page name
-# @attr [Boolean] current indicates if the page is selected
-# @attr [Array<Talent>] array of selected talents
-class MasteryPage
-  attr_accessor :id, :talents, :name, :current
-  
-  def initialize(data)
-    @id = data['id']
-    @name = data['name']
-    @current = data['current']
-    @talents = []
-    data['talents'].each do |talent|
-      @talents << Talent.new(talent)
-    end
-  end
-
-end
-
-# Class to represent a talent of a mastery page
-# @attr [Numeric] id id of the mastery
-# @attr [String] name of the mastery
-# @attr [Numeric] rank rank of the mastery
-class Talent
-  attr_accessor :id,:rank, :name
-  
-  def initialize(data)
-    @id = data['id']
-    @name = data['name']
-    @rank = data['rank']
-  end
-end
+module Sightstone
+# Class to represent the masterybook of a summoner
+# @attr [Numeric] summonerId id of the summoner
+# @attr [Array<MasteryPage>] pages of the masterybook
+class MasteryBook
+  attr_accessor :pages, :summonerId
+  
+  def initialize(data)
+    @summonerId = data['summonerId']
+    @pages = []
+    data['pages'].each do |page|
+      @pages << MasteryPage.new(page)
+    end
+  end
+end
+
+# Class to represent a page of a masterybook
+# @attr [Numeric] id ID of the page
+# @attr [String] name page name
+# @attr [Boolean] current indicates if the page is selected
+# @attr [Array<Talent>] array of selected talents
+class MasteryPage
+  attr_accessor :id, :talents, :name, :current
+  
+  def initialize(data)
+    @id = data['id']
+    @name = data['name']
+    @current = data['current']
+    @talents = []
+    data['talents'].each do |talent|
+      @talents << Talent.new(talent)
+    end
+  end
+
+end
+
+# Class to represent a talent of a mastery page
+# @attr [Numeric] id id of the mastery
+# @attr [String] name of the mastery
+# @attr [Numeric] rank rank of the mastery
+class Talent
+  attr_accessor :id,:rank, :name
+  
+  def initialize(data)
+    @id = data['id']
+    @name = data['name']
+    @rank = data['rank']
+  end
+end
 end

data/lib/sightstone/match_history.rb

@@ -1,76 +1,76 @@
-module Sightstone
-# 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
-  
-  def initialize(data)
-    @summonerId = data['summonerId']
-    @games = []
-    data['games'].each do |game|
-      games << HistoryGame.new(game)
-    end
-  end
-end
-
-# 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 [Hash<String, Fixnum, Boolean>] statistics statistics of the game as a Hash: name -> value
-class HistoryGame
-  attr_accessor :championId, :createDate, :fellowPlayers, :gameId, :gameMode, :gameType, :invalid, :level, :mapId, :spell1, :spell2, :statistics, :subType, :teamId
-  
-  def initialize(data)
-    @championId=data['championId']
-    @createDate=data['createDate']
-    @createDateString=data['createDateString']
-    @fellowPlayers=[]
-    if(data.has_key? "fellowPlayers")
-    data['fellowPlayers'].each do |player|
-      @fellowPlayers << Player.new(player)
-    end
-  end
-    @gameId=data['gameId']
-    @gameMode=data['gameMode']
-    @gameType=data['gameType']
-    @invalid=data['invalid']
-    @level=data['level']
-    @mapId=data['mapId']
-    @spell1=data['spell1']
-    @spell2=data['spell2']
-    @statistics = {}
-    data['stats'].each do |key, stat|
-      @statistics[key] = stat
-    end
-    @subType=data['subType']
-    @teamId=data['teamId']
-  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
-  
-  def initialize(data)
-    @championId = data['championId']
-    @summonerId = data['summonerId']
-    @teamId = data['teamId']
-  end
-end
-
-end
+module Sightstone
+# 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
+  
+  def initialize(data)
+    @summonerId = data['summonerId']
+    @games = []
+    data['games'].each do |game|
+      games << HistoryGame.new(game)
+    end
+  end
+end
+
+# 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 [Hash<String, Fixnum, Boolean>] statistics statistics of the game as a Hash: name -> value
+class HistoryGame
+  attr_accessor :championId, :createDate, :fellowPlayers, :gameId, :gameMode, :gameType, :invalid, :level, :mapId, :spell1, :spell2, :statistics, :subType, :teamId
+  
+  def initialize(data)
+    @championId=data['championId']
+    @createDate=data['createDate']
+    @createDateString=data['createDateString']
+    @fellowPlayers=[]
+    if(data.has_key? "fellowPlayers")
+    data['fellowPlayers'].each do |player|
+      @fellowPlayers << Player.new(player)
+    end
+  end
+    @gameId=data['gameId']
+    @gameMode=data['gameMode']
+    @gameType=data['gameType']
+    @invalid=data['invalid']
+    @level=data['level']
+    @mapId=data['mapId']
+    @spell1=data['spell1']
+    @spell2=data['spell2']
+    @statistics = {}
+    data['stats'].each do |key, stat|
+      @statistics[key] = stat
+    end
+    @subType=data['subType']
+    @teamId=data['teamId']
+  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
+  
+  def initialize(data)
+    @championId = data['championId']
+    @summonerId = data['summonerId']
+    @teamId = data['teamId']
+  end
+end
+
+end