sightstone 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 587af5785d237527f2a8e316356ce84b8c39e544
-  data.tar.gz: 3a2cb00c736b6deb110b2f395a0d737e69e689fe
+  metadata.gz: 1566ea45d97a16bfb02822e9296b299eac3652ec
+  data.tar.gz: db3c4c40c0118e3f40ad8248a74cfc60deb7436b
 SHA512:
-  metadata.gz: e1e208bec4e4c1621cab7a4715ce688e49070366186e7a8d08b7d92039e153643f2ddcbb25b79a8777eed6c8961790531f6516a4ecb44fed4f8938e6047f5008
-  data.tar.gz: b4f3c49ea4792c541c5531e576ecc3128b47fd6c7ba19dd7b84f20ad294a002fd011d0f35e565f402f5801043531850795f10b1da80577d0e692abf00dcd98ec
+  metadata.gz: c4e405bead9f20bd1d485975f671adedb8aea7ee5c10e7b60a6f4428293a3689f4c5d85fe86d1e3dc124cb0839a8bea3efa8cac60dd0f8401d2069b4163728d3
+  data.tar.gz: 0c18e8f96c8a328ccc2aea80cf463be5ec6c18c82a5c8a91639bf9ae5a76da11ebe71d3c0a1aa757ba2f5b0fe7a5b3c41ab29850f8024f22d15049b56d997cfb

data/lib/sightstone/modules/champion_module.rb

@@ -1,13 +1,16 @@
 require 'sightstone/champion'
+require 'sightstone/modules/sightstone_base_module'
 
-class ChampionModule
+class ChampionModule < SightstoneBaseModule
 
   def initialize(sightstone)
     @sightstone = sightstone
   end
 
-  def champions(free_to_play=false)
-    uri = "https://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/champion"
+  def champions(, optional={})
+    region = optional[:region] || @sightstone.region
+    free_to_play = optional[:free_to_play]
+    uri = "https://prod.api.pvp.net/api/lol/#{region}/v1.1/champion"
     response = _get_api_response(uri, {'freeToPlay' => free_to_play})
   puts response
 
@@ -20,28 +23,4 @@ class ChampionModule
       return champions
     }
   end
-  
-  private
-    def _get_api_response(uri, headers={})
-    params = {'api_key' => @sightstone.api_key}.merge headers
-    RestClient.get(uri, headers={:params => params}) {|response, request, result| response }
-  rescue SocketError => e
-    nil
-
-    end
-
-  def _parse_response(response, &block)
-    response_code = if response.nil?
-    500
-    else
-    response.code
-    end
-
-    if response_code == 200
-    block.call(response.body)
-    elsif response_code == 500
-      raise Sightstone::SightstoneConnectionException
-    end
-  end
-
 end

data/lib/sightstone/modules/game_module.rb

@@ -1,19 +1,21 @@
+require 'sightstone/modules/sightstone_base_module'
 require 'sightstone/summoner'
 require 'sightstone/match_history'
 
-class GameModule
+class GameModule < SightstoneBaseModule
   
   def initialize(sightstone)
     @sightstone = sightstone
   end
   
-  def recent(summoner)
+  def recent(summoner, optional={})
+    region = optional[:region] || @sightstone.region
    id = if summoner.is_a? Summoner
      summoner.id
    else
      summoner
    end
-   uri = "http://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/game/by-summoner/#{id}/recent"
+   uri = "https://prod.api.pvp.net/api/lol/#{region}/v1.1/game/by-summoner/#{id}/recent"
    
     response = _get_api_response(uri)
     _parse_response(response) { |resp|
@@ -22,29 +24,5 @@ class GameModule
     }
   end
   
-   private
-
-  def _get_api_response(uri)
-    params = {'api_key' => @sightstone.api_key}
-    RestClient.get(uri, headers={:params => params}) {|response, request, result| response }
-  rescue SocketError => e
-    nil
-
-    end
-
-  def _parse_response(response, &block)
-    response_code = if response.nil?
-    500
-    else
-    response.code
-    end
-
-    if response_code == 200
-    block.call(response.body)
-    elsif response_code == 404
-      raise Sightstone::SummonerNotFoundException
-    elsif response_code == 500
-      raise Sightstone::SightstoneConnectionException
-    end
-  end
+  
 end

data/lib/sightstone/modules/league_module.rb

@@ -1,19 +1,21 @@
+require 'sightstone/modules/sightstone_base_module'
 require 'sightstone/summoner'
 require 'sightstone/league'
 
-class LeagueModule
+class LeagueModule < SightstoneBaseModule
   def initialize(sightstone)
     @sightstone = sightstone
   end
   
-  def league(summoner)
+  def league(summoner, optional={})
+    region = optional[:region] || @sightstone.region
     id = if summoner.is_a? Summoner
       summoner.id
     else
       summoner
     end
     
-    uri = "http://prod.api.pvp.net/api/#{@sightstone.region}/v2.1/league/by-summoner/#{id}"
+    uri = "https://prod.api.pvp.net/api/#{region}/v2.1/league/by-summoner/#{id}"
     response = _get_api_response(uri)
     _parse_response(response) { |resp|
       data = JSON.parse(resp)
@@ -26,28 +28,4 @@ class LeagueModule
     }
   end
   
-   private
-
-  def _get_api_response(uri)
-    params = {'api_key' => @sightstone.api_key}
-    RestClient.get(uri, headers={:params => params}) {|response, request, result| response }
-  rescue SocketError => e
-    nil
-
-    end
-
-  def _parse_response(response, &block)
-    response_code = if response.nil?
-    500
-    else
-    response.code
-    end
-    if response_code == 200
-    block.call(response.body)
-    elsif response_code == 404
-      raise Sightstone::SummonerNotFoundException
-    elsif response_code == 500
-      raise Sightstone::SightstoneConnectionException
-    end
-  end
 end

data/lib/sightstone/modules/sightstone_base_module.rb

@@ -0,0 +1,36 @@
+require 'open-uri'
+
+# Base class of the api modules
+# @abstract
+class SightstoneBaseModule
+  
+  protected
+  def _get_api_response(uri, header={})
+    params = {'api_key' => @sightstone.api_key}.merge header
+    RestClient.get(uri, headers={:params => params}) {|response, request, result| response }
+  rescue SocketError => e
+    nil
+
+    end
+
+  def _parse_response(response, &block)
+    response_code = if response.nil?
+    500
+    else
+    response.code
+    end
+
+    if response_code == 200
+    block.call(response.body)
+    elsif response_code == 404
+      raise Sightstone::SummonerNotFoundException
+    elsif response_code == 500
+      raise Sightstone::SightstoneConnectionException
+    elsif response_code == 429
+      raise Sightstone::RateLimitExceededException
+    else
+      raise Sightstone::SightstoneApiException 'Unknown error occured'
+    end
+  end
+  
+end

data/lib/sightstone/modules/stats_module.rb

@@ -1,19 +1,23 @@
+require 'sightstone/modules/sightstone_base_module'
 require 'sightstone/summoner'
 require 'sightstone/player_stats_summary'
 require 'sightstone/ranked_stats'
 
-class StatsModule
+class StatsModule < SightstoneBaseModule
   def initialize(sightstone)
     @sightstone = sightstone
   end
 
-  def summary(summoner, season=nil)
+  def summary(summoner, , optional={})
+    region = optional[:region] || @sightstone.region)
+    season = optional[:season]
+    
     id = if summoner.is_a? Summoner
     summoner.id
     else
     summoner
     end
-    uri = "https://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/stats/by-summoner/#{id}/summary"
+    uri = "https://prod.api.pvp.net/api/lol/#{region}/v1.1/stats/by-summoner/#{id}/summary"
     response = if season.nil?
       _get_api_response(uri)
     else
@@ -27,13 +31,15 @@ class StatsModule
 
   end
   
-  def ranked(summoner, season=nil)
+  def ranked(summoner, optional={})
+    region = optional[:region] || @sightstone.region
+    season = optional[:season]
     id = if summoner.is_a? Summoner
     summoner.id
     else
     summoner
     end
-    uri = "https://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/stats/by-summoner/#{id}/ranked"
+    uri = "https://prod.api.pvp.net/api/lol/#{region}/v1.1/stats/by-summoner/#{id}/ranked"
     response = if season.nil?
       _get_api_response(uri)
     else
@@ -46,29 +52,4 @@ class StatsModule
     }
 
   end
-
-  def _get_api_response(uri, header={})
-    params = {'api_key' => @sightstone.api_key}.merge header
-    RestClient.get(uri, headers={:params => params}) {|response, request, result| response }
-  rescue SocketError => e
-    nil
-
-    end
-
-  def _parse_response(response, &block)
-    response_code = if response.nil?
-    500
-    else
-    response.code
-    end
-
-    if response_code == 200
-    block.call(response.body)
-    elsif response_code == 404
-      raise Sightstone::SummonerNotFoundException
-    elsif response_code == 500
-      raise Sightstone::SightstoneConnectionException
-    end
-  end
-
 end

data/lib/sightstone/modules/summoner_module.rb

@@ -1,17 +1,20 @@
+require 'sightstone/modules/sightstone_base_module'
 require 'sightstone/summoner'
 require 'sightstone/masterybook'
 require 'sightstone/runebook'
+require 'open-uri'
 
-class SummonerModule
+class SummonerModule < SightstoneBaseModule
   def initialize(sightstone)
     @sightstone = sightstone
   end
 
-  def summoner(name_or_id)
+  def summoner(name_or_id, optional={})
+    region = optional[:region] || @sightstone.region
     uri = if name_or_id.is_a? Integer
-      "http://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/summoner/#{name_or_id}"
+      "https://prod.api.pvp.net/api/lol/#{region}/v1.1/summoner/#{name_or_id}"
     else
-      "http://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/summoner/by-name/#{name_or_id}"
+      "https://prod.api.pvp.net/api/lol/#{region}/v1.1/summoner/by-name/#{URI::encode(name_or_id)}"
     end
     
     response = _get_api_response(uri)
@@ -22,9 +25,10 @@ class SummonerModule
   end
 
 
-  def names(ids)
+  def names(ids, optional={})
+    region = optional[:region] || @sightstone.region
     ids = ids.join(',')
-    uri = "http://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/summoner/#{ids}/name"
+    uri = "http://prod.api.pvp.net/api/lol/#{region}/v1.1/summoner/#{ids}/name"
     response = _get_api_response(uri)
     _parse_response(response) { |resp|
       data = JSON.parse(resp)
@@ -32,13 +36,14 @@ class SummonerModule
     }
   end
 
-  def runes(summoner)
+  def runes(summoner, optional={})
+    region = optional[:region] || @sightstone.region
     id = if summoner.is_a? Summoner
       summoner.id
     else
       summoner
     end
-    uri = "http://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/summoner/#{id}/runes"
+    uri = "http://prod.api.pvp.net/api/lol/#{region}/v1.1/summoner/#{id}/runes"
     response = _get_api_response(uri)
     _parse_response(response) { |resp|
       data = JSON.parse(resp)
@@ -46,43 +51,18 @@ class SummonerModule
     }
   end
 
-  def masteries(summoner)
+  def masteries(summoner, optional={})
+    region = optional[:region] || @sightstone.region
      id = if summoner.is_a? Summoner
       summoner.id
     else
       summoner
     end
-    uri = "http://prod.api.pvp.net/api/lol/#{@sightstone.region}/v1.1/summoner/#{id}/masteries"
+    uri = "http://prod.api.pvp.net/api/lol/#{region}/v1.1/summoner/#{id}/masteries"
     response = _get_api_response(uri)
     _parse_response(response) { |resp|
       data = JSON.parse(resp)
       return MasteryBook.new(data)
     }
   end
-
-  private
-
-  def _get_api_response(uri)
-    params = {'api_key' => @sightstone.api_key}
-    RestClient.get(uri, headers={:params => params}) {|response, request, result| response }
-  rescue SocketError => e
-    nil
-
-    end
-
-  def _parse_response(response, &block)
-    response_code = if response.nil?
-    500
-    else
-    response.code
-    end
-
-    if response_code == 200
-    block.call(response.body)
-    elsif response_code == 404
-      raise Sightstone::SummonerNotFoundException
-    elsif response_code == 500
-      raise Sightstone::SightstoneConnectionException
-    end
-  end
 end

data/lib/sightstone/modules/team_module.rb

@@ -1,19 +1,21 @@
+require 'sightstone/modules/sightstone_base_module'
 require 'sightstone/summoner'
 require 'sightstone/team'
 
-class TeamModule
+class TeamModule < SightstoneBaseModule
   def initialize(sightstone)
     @sightstone = sightstone
   end
 
-  def teams(summoner)
+  def teams(summoner, optional={})
+    region = optional[:region] || @sightstone.region
     id = if summoner.is_a? Summoner
       summoner.id
     else
       summoner
     end
     
-    uri = "http://prod.api.pvp.net/api/#{@sightstone.region}/v2.1/team/by-summoner/#{id}"
+    uri = "https://prod.api.pvp.net/api/#{region}/v2.1/team/by-summoner/#{id}"
 
     response = _get_api_response(uri)
     _parse_response(response) { |resp|
@@ -26,31 +28,4 @@ class TeamModule
     }
   end
 
-
-
-  private
-
-  def _get_api_response(uri)
-    params = {'api_key' => @sightstone.api_key}
-    RestClient.get(uri, headers={:params => params}) {|response, request, result| response }
-  rescue SocketError => e
-    nil
-
-    end
-
-  def _parse_response(response, &block)
-    response_code = if response.nil?
-    500
-    else
-    response.code
-    end
-
-    if response_code == 200
-    block.call(response.body)
-    elsif response_code == 404
-      raise Sightstone::SummonerNotFoundException
-    elsif response_code == 500
-      raise Sightstone::SightstoneConnectionException
-    end
-  end
 end

data/lib/sightstone/summoner.rb

@@ -1,9 +1,14 @@
-
-
+# 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']

data/lib/sightstone.rb

@@ -7,11 +7,24 @@ require 'sightstone/modules/league_module'
 require 'sightstone/modules/stats_module'
 require 'sightstone/modules/team_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
 class Sightstone
-  attr_accessor :region, :api_key
+  
+  attr_accessor :region
+  attr_accessor :api_key
   attr_accessor :summoner, :champion, :game, :league, :stats, :team
   
-  def initialize(api_key, region)
+  # @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
     
@@ -24,9 +37,14 @@ class Sightstone
   end
 end
 
-# Error classes
+# Base class for exceptions raised by the gem
 class SightstoneApiException < Exception; 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sightstone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2012-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -51,6 +51,7 @@ files:
 - lib/sightstone/modules/champion_module.rb
 - lib/sightstone/modules/game_module.rb
 - lib/sightstone/modules/league_module.rb
+- lib/sightstone/modules/sightstone_base_module.rb
 - lib/sightstone/modules/stats_module.rb
 - lib/sightstone/modules/summoner_module.rb
 - lib/sightstone/modules/team_module.rb
@@ -86,3 +87,4 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper for riots league of legends api
 test_files: []
+has_rdoc: