riot_api 0.0.2 → 0.0.4

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.0.4
+* Yanked 0.0.3 release as Team method not implemented
+* Fixed team method
+* Otherwise same as 0.0.3
+
+## 0.0.3 (Yanked)
+* All Endpoints Implemented
+* Initial Model Approach for Summoner using Virtus
+* Refactoring of base paths and regions to DRY up resources
+* Errors for invalid regions parameter
+
 ## 0.0.2
 * Refactored URL building
 * Add Stats method

data/README.md

@@ -45,6 +45,38 @@ summoner_details = ra.summoner.name('Best Lux EUW')
 summoner.name # => "Best Lux EUW"
 ```
 
+## Methods
+
+```
+RiotApi::API
+  #summoner
+    #name(summoner_name)
+      should return information from a given summoner name
+    #id(summoner_name)
+      should return information from a given summoner id
+    #names(summoner_name_1, summoner_name_2)
+      should return an array of summoners with name set
+  #stats
+    #ranked(summoner_name)
+      should return ranked information from a given summoner name
+    #summary(summoner_name)
+      should return summary information from a given summoner id
+  #champions
+    #list
+      should return a list of all champions
+    #free
+      should return a list of all free champions
+  #game
+    #recent(summoner_name)
+      should return a list of recent games played from a given summoner id
+  #league
+    #by_summoner(summoner_name)
+      should return leagues data from a given summoner id
+  #team
+    #by_summoner(summoner_id)
+      should return team data from a given summoner id
+```
+
 ## ChangeLog / History / Releases
 
 see the [CHANGELOG.md](./CHANGELOG.md) file.
@@ -77,7 +109,7 @@ rspec
 
 ### Contributors
 
-* None Yet :)
+* [pcg79](https://github.com/pcg79)
 
 For more information and a complete list see [the contributor page on GitHub](https://github.com/petems/riot_api/contributors).
 

data/lib/riot_api/api.rb

@@ -1,11 +1,26 @@
 module RiotApi
   class API
+
+    # Creates a new Riot API client instance.
+    #
+    # @param [Hash] params
+    # @option params [String] :api_key The api_key (required)
+    # @option params [String] :api_key The region ('eune','br','tr','na','euw') (required)
+    # @option params [String] :base_url ("http://prod.api.pvp.net/api/lol/#{@region}/") API base url with region
+    # @option params [Symbol] :faraday_adapter ('Faraday.default_adapter')  Faraday adapter/http client library to use.
+    # @raise [ArgumentError] when no api_key is provided
+    # @raise [ArgumentError] when no region is provided
+    # @raise [ArgumentError] when region is not one of 'eune','br','tr','na', or 'euw'
+    # @example
+    #   ra = RiotApi::API.new :api_key => '######', :region => 'euw'
+    #
+    # @see [Faraday]
     def initialize(params)
       @api_key             = params[:api_key]
       @region              = params[:region]
       @debug               = params[:debug]
       @ssl                 = params[:ssl] || { :verify => true }
-      @base_url            = params[:base_url]            || "http://prod.api.pvp.net/api/lol/#{@region}/"
+      @base_url            = params[:base_url]            || "http://prod.api.pvp.net/api/"
       @faraday_adapter     = params[:faraday_adapter]     || Faraday.default_adapter
       @raise_status_errors = params[:raise_status_errors] || false
       @faraday             = params[:faraday]             || default_faraday
@@ -14,12 +29,28 @@ module RiotApi
       raise ArgumentError, "Invalid Region (Valid regions: 'eune','br','tr','na','euw')" unless ['eune','br','tr','na','euw'].include?(@region)
     end
 
-    def summoner
-      RiotApi::Resource::Summoner.new(@faraday)
+    def champions
+      RiotApi::Resource::Champions.new(@faraday, @region)
+    end
+
+    def game
+      RiotApi::Resource::Game.new(@faraday, @region)
+    end
+
+    def league
+      RiotApi::Resource::League.new(@faraday, @region)
     end
 
     def stats
-      RiotApi::Resource::Stats.new(@faraday)
+      RiotApi::Resource::Stats.new(@faraday, @region)
+    end
+
+    def summoner
+      RiotApi::Resource::Summoner.new(@faraday, @region)
+    end
+
+    def team
+      RiotApi::Resource::Team.new(@faraday, @region)
     end
 
     def default_faraday
@@ -34,5 +65,6 @@ module RiotApi
         faraday.headers['User-Agent'] = "riot_api rubygem v#{RiotApi::VERSION}"
       end
     end
+
   end
 end

data/lib/riot_api/model/base.rb

@@ -0,0 +1,9 @@
+require 'virtus'
+
+module RiotApi
+  module Model
+    class Base
+      include Virtus.model
+    end
+  end
+end

data/lib/riot_api/model/summoner.rb

@@ -0,0 +1,13 @@
+module RiotApi
+  module Model
+    class Summoner < Base
+      attribute :id,        Integer
+      attribute :name,      String
+      attribute :profile_icon_id, Integer
+      attribute :summoner_level,  Integer
+      attribute :revision_date_str, String
+      attribute :revision_date, Integer
+
+    end
+  end
+end

data/lib/riot_api/model.rb

@@ -0,0 +1,8 @@
+require 'riot_api/model/base'
+require 'riot_api/model/summoner'
+
+module RiotApi
+  module Model
+
+  end
+end

data/lib/riot_api/resource/base.rb

@@ -1,12 +1,13 @@
 module RiotApi
   module Resource
     class Base
-      def initialize(connection, options = {})
+      def initialize(connection, region, options = {})
         @connection = connection
+        @region = region
       end
 
-      def endpoint_version
-        "v1.1"
+      def endpoint_precursor
+        "lol/#{@region}/v1.1"
       end
     end
   end

data/lib/riot_api/resource/base_v21.rb

@@ -0,0 +1,9 @@
+ module RiotApi
+   module Resource
+     class BaseV21 < Base
+       def endpoint_precursor
+         "#{@region}/v2.1"
+       end
+     end
+   end
+ end

data/lib/riot_api/resource/champions.rb

@@ -0,0 +1,20 @@
+module RiotApi
+  module Resource
+    class Champions < Base
+
+      def list(free=false)
+        @connection.get(base_path, { :freeToPlay => free }).body.champions
+      end
+
+      def free
+        list(true)
+      end
+
+      private
+
+      def base_path
+        "#{endpoint_precursor}/champion"
+      end
+    end
+  end
+end

data/lib/riot_api/resource/game.rb

@@ -0,0 +1,21 @@
+module RiotApi
+  module Resource
+    class Game < Base
+
+      def recent(summoner_id)
+        @connection.get(recent_path(summoner_id)).body.games
+      end
+
+      private
+
+      def recent_path(summoner_id)
+        "#{base_path(summoner_id)}/recent"
+      end
+
+      def base_path(summoner_id)
+        "#{endpoint_precursor}/game/by-summoner/#{summoner_id}"
+      end
+
+    end
+  end
+end

data/lib/riot_api/resource/league.rb

@@ -0,0 +1,21 @@
+module RiotApi
+  module Resource
+    class League < BaseV21
+
+      def by_summoner(summoner_id)
+        @connection.get(by_summoner_path(summoner_id)).body[summoner_id.to_s]
+      end
+
+      private
+
+      def by_summoner_path(summoner_id)
+        "#{base_path}/by-summoner/#{summoner_id}"
+      end
+
+      def base_path
+        "#{endpoint_precursor}/league"
+      end
+
+    end
+  end
+end

data/lib/riot_api/resource/stats.rb

@@ -3,17 +3,17 @@ module RiotApi
     class Stats < Base
 
       def ranked(id, opts = {})
-        @connection.get("#{base_path(id)}/ranked").body
+        @connection.get("#{base_path(id)}/ranked", opts).body
       end
 
       def summary(id, opts = {})
-        @connection.get("#{base_path(id)}/summary").body
+        @connection.get("#{base_path(id)}/summary", opts).body
       end
 
       private
 
       def base_path(id)
-        "#{endpoint_version}/stats/by-summoner/#{id}"
+        "#{endpoint_precursor}/stats/by-summoner/#{id}"
       end
     end
   end

data/lib/riot_api/resource/summoner.rb

@@ -3,17 +3,32 @@ module RiotApi
     class Summoner < Base
 
       def name(name, opts = {})
-        @connection.get("#{base_path}/by-name/#{name}/").body
+        RiotApi::Model::Summoner.new @connection.get("#{base_path}/by-name/#{name}/").body
       end
 
       def id(id, opts = {})
-        @connection.get("#{base_path}/#{id}/").body
+        RiotApi::Model::Summoner.new @connection.get("#{base_path}/#{id}/").body
+      end
+
+      def masteries(id)
+        @connection.get("#{base_path}/#{id}/masteries").body
+      end
+
+      def names(*ids)
+        ids = ids.compact.join(',')
+        @connection.get("#{base_path}/#{ids}/name").body.summoners.map do |summoner|
+          RiotApi::Model::Summoner.new summoner
+        end
+      end
+
+      def runes(id)
+        @connection.get("#{base_path}/#{id}/runes").body
       end
 
       private
 
       def base_path
-        "#{endpoint_version}/summoner/"
+        "#{endpoint_precursor}/summoner/"
       end
 
     end

data/lib/riot_api/resource/team.rb

@@ -0,0 +1,21 @@
+module RiotApi
+  module Resource
+    class Team < BaseV21
+
+      def by_summoner(summoner_id)
+        @connection.get(by_summoner_path(summoner_id)).body
+      end
+
+      private
+
+      def by_summoner_path(summoner_id)
+        "#{base_path}/by-summoner/#{summoner_id}"
+      end
+
+      def base_path
+        "#{endpoint_precursor}/team"
+      end
+
+    end
+  end
+end

data/lib/riot_api/resource.rb

@@ -1,6 +1,11 @@
 require 'riot_api/resource/base'
-require 'riot_api/resource/summoner'
+require 'riot_api/resource/base_v21'
+require 'riot_api/resource/champions'
+require 'riot_api/resource/game'
+require 'riot_api/resource/league'
 require 'riot_api/resource/stats'
+require 'riot_api/resource/summoner'
+require 'riot_api/resource/team'
 
 module RiotApi
   module Resource

data/lib/riot_api/version.rb

@@ -1,3 +1,3 @@
 module RiotApi
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end

data/lib/riot_api.rb

@@ -4,6 +4,7 @@ require 'faraday_middleware'
 require 'riot_api/version'
 require 'riot_api/api'
 require 'riot_api/resource'
+require 'riot_api/model'
 
 module RiotApi
 end

data/riot_api.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday_middleware', '~> 0.9.0'
   gem.add_dependency 'json', '~> 1.8.1'
   gem.add_dependency 'rash', '~> 0.4.0'
+  gem.add_dependency 'virtus', '~> 1.0.1'
 
   gem.add_development_dependency 'rspec', '~> 2.0'
   gem.add_development_dependency 'guard', '~> 2.1.0'

data/spec/api_spec.rb

@@ -59,6 +59,46 @@ describe RiotApi::API, :vcr do
       end
     end
 
+    describe '#masteries' do
+      let(:summoner_id) { '19531813' }
+
+      let(:response) {
+        subject.summoner.masteries summoner_id
+      }
+
+      it 'should return a list of mastery pages containing lists of talents' do
+        response.pages.count.should be > 0
+        response.pages.first.talents.count.should be > 0
+      end
+    end
+
+    describe '#names' do
+      let(:froggen) { '19531813' }
+      let(:response) {
+        subject.summoner.names summoner_id, froggen
+      }
+
+      it "should return an array of summoners with name set" do
+        response.class.should == Array
+        response.count.should == 2
+        response.first.class.should == RiotApi::Model::Summoner
+        response.first.name.should == "Best Lux EUW"
+      end
+    end
+
+    describe '#runes' do
+      let(:summoner_id) { '19531813' }
+
+      let(:response) {
+        subject.summoner.runes summoner_id
+      }
+
+      it 'should return a list of rune pages containing lists of talents' do
+        response.pages.count.should be > 0
+        response.pages.first.slots.count.should be > 0
+      end
+    end
+
   end
 
   describe '#stats' do
@@ -66,26 +106,131 @@ describe RiotApi::API, :vcr do
 
     # Ranked command requires user has played ranked
     describe '#ranked' do
+
+      describe 'omitting season' do
+        let(:response) {
+          subject.stats.ranked summoner_id
+        }
+
+        it 'should return ranked information from the summoner id' do
+          response.summonerId.should eql(19531813)
+          response.champions.first.first.should eql ["id", 111]
+        end
+      end
+
+      describe 'specifying season' do
+        let(:response) {
+          subject.stats.ranked summoner_id, :season => "SEASON3"
+        }
+
+        it 'should return ranked information from the summoner id for the specified season' do
+          response.summonerId.should eql(19531813)
+          response.champions.first.first.should eql ["id", 111]
+        end
+      end
+    end
+
+    describe '#summary' do
+
+      describe 'omitting season' do
+        let(:response) {
+          subject.stats.summary summoner_id
+        }
+
+        it 'should return summary information from the summoner id' do
+          response.summonerId.should eql(19531813)
+          response.playerStatSummaries.first.should include 'aggregated_stats'
+        end
+      end
+
+      describe 'specifying season' do
+        let(:response) {
+          subject.stats.summary summoner_id, :season => "SEASON3"
+        }
+
+        it 'should return summary information from the summoner id for the specified season' do
+          response.summonerId.should eql(19531813)
+          response.playerStatSummaries.first.should include 'aggregated_stats'
+        end
+      end
+    end
+
+  end
+
+  describe '#champions' do
+    let(:current_champion_count) { 116 }
+
+    describe '#list' do
       let(:response) {
-        subject.stats.ranked summoner_id
+        subject.champions.list
       }
 
-      it 'should return ranked information from the summoner name' do
-        response.summonerId.should eql(19531813)
-        response.champions.first.first.should eql ["id", 111]
+      it 'should return a list of all champions' do
+        response.count.should be >= current_champion_count
+        response.first.respond_to?(:name).should be_true
       end
     end
 
-    describe '#summary' do
+    describe '#free' do
       let(:response) {
-        subject.stats.summary summoner_id
+        subject.champions.free
       }
 
-      it 'should return summary information from the summoner id' do
-        response.summonerId.should eql(19531813)
-        response.playerStatSummaries.first.should include 'aggregated_stats'
+      it 'should return a list of all free champions' do
+        response.count.should be < current_champion_count
+        response.count.should be > 0
+        response.first.respond_to?(:name).should be_true
+        response.first.free_to_play.should be_true
       end
     end
 
   end
+
+  describe '#game' do
+    let(:summoner_id) { '19531813' }
+
+    # Ranked command requires user has played ranked
+    describe '#recent' do
+      let(:response) {
+        subject.game.recent summoner_id
+      }
+
+      it 'should return a list of recent games played' do
+        response.count.should > 0
+        response.first.respond_to?(:champion_id).should be_true
+      end
+    end
+  end
+
+  describe '#league', :vcr do
+    let(:summoner_id) { '19531813' }
+
+    describe '#by_summoner' do
+      let(:response) {
+        subject.league.by_summoner summoner_id
+      }
+
+      it 'should return leagues data for summoner' do
+        response["entries"].count.should > 0
+        response.tier.should == 'CHALLENGER'
+      end
+    end
+  end
+
+
+  describe '#team', :vcr do
+    let(:summoner_id) { '19531813' }
+
+    describe '#by_summoner' do
+      let(:response) {
+        subject.team.by_summoner summoner_id
+      }
+
+      it 'should return team data for summoner' do
+        response.count.should > 0
+        response.first.first.should == ["timestamp", 1387051307170]
+      end
+    end
+  end
+
 end

data/spec/model/summoner_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe RiotApi::Model::Summoner do
+
+  describe '#initialize' do
+    let(:data) { { id: 44600324, name: "Best Lux EUW", profile_icon_id: 7, summoner_level: 6, revision_date: 1375116256000, revision_date_str: "07/29/2013 04:44 PM UTC" } }
+    let(:summoner) { RiotApi::Model::Summoner.new data }
+
+    it "should create a valid object" do
+      summoner.id.should == data[:id]
+      summoner.revision_date.should == data[:revision_date]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
 require 'coveralls'
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'support/vcr'
+end
+
 Coveralls.wear!
 
 require 'rspec/autorun'

data/spec/support/vcr.rb

@@ -12,7 +12,7 @@ VCR.configure do |c|
 
   c.filter_sensitive_data('XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') do |http_interaction|
     #Not sure if this needs removing, but better safe than sorry...
-    if http_interaction.response.headers['x-newrelic-app-data'].first != nil
+    if http_interaction.response.headers['x-newrelic-app-data'] != nil
       http_interaction.response.headers['x-newrelic-app-data'].first
     end
   end

data/spec/vcr/cassettes/RiotApi_API/_champions/_free/should_return_a_list_of_all_free_champions.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://prod.api.pvp.net/api/lol/euw/v1.1/champion?api_key=api_key_YYYYYYYYYYYYYYYYYYYYY&freeToPlay=true
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - riot_api rubygem v0.0.1
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      access-control-allow-headers:
+      - Content-Type
+      access-control-allow-methods:
+      - GET, POST, DELETE, PUT
+      access-control-allow-origin:
+      - ! '*'
+      content-type:
+      - application/json;charset=UTF-8
+      date:
+      - Wed, 11 Dec 2013 15:44:19 GMT
+      server:
+      - Jetty(9.1.0.v20131115)
+      x-newrelic-app-data:
+      - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+      content-length:
+      - '1890'
+      connection:
+      - Close
+    body:
+      encoding: US-ASCII
+      string: ! '{"champions":[{"id":31,"name":"Chogath","active":true,"attackRank":3,"defenseRank":7,"magicRank":7,"difficultyRank":7,"botEnabled":true,"freeToPlay":true,"botMmEnabled":true,"rankedPlayEnabled":true},{"id":104,"name":"Graves","active":true,"attackRank":8,"defenseRank":5,"magicRank":3,"difficultyRank":4,"botEnabled":true,"freeToPlay":true,"botMmEnabled":true,"rankedPlayEnabled":true},{"id":74,"name":"Heimerdinger","active":true,"attackRank":2,"defenseRank":6,"magicRank":8,"difficultyRank":4,"botEnabled":false,"freeToPlay":true,"botMmEnabled":false,"rankedPlayEnabled":true},{"id":39,"name":"Irelia","active":true,"attackRank":7,"defenseRank":4,"magicRank":5,"difficultyRank":5,"botEnabled":false,"freeToPlay":true,"botMmEnabled":true,"rankedPlayEnabled":true},{"id":43,"name":"Karma","active":true,"attackRank":1,"defenseRank":7,"magicRank":8,"difficultyRank":8,"botEnabled":false,"freeToPlay":true,"botMmEnabled":false,"rankedPlayEnabled":true},{"id":117,"name":"Lulu","active":true,"attackRank":4,"defenseRank":5,"magicRank":7,"difficultyRank":7,"botEnabled":false,"freeToPlay":true,"botMmEnabled":false,"rankedPlayEnabled":true},{"id":11,"name":"MasterYi","active":true,"attackRank":10,"defenseRank":4,"magicRank":2,"difficultyRank":2,"botEnabled":true,"freeToPlay":true,"botMmEnabled":true,"rankedPlayEnabled":true},{"id":133,"name":"Quinn","active":true,"attackRank":9,"defenseRank":4,"magicRank":2,"difficultyRank":7,"botEnabled":false,"freeToPlay":true,"botMmEnabled":false,"rankedPlayEnabled":true},{"id":35,"name":"Shaco","active":true,"attackRank":8,"defenseRank":4,"magicRank":6,"difficultyRank":9,"botEnabled":false,"freeToPlay":true,"botMmEnabled":false,"rankedPlayEnabled":true},{"id":4,"name":"TwistedFate","active":true,"attackRank":6,"defenseRank":2,"magicRank":6,"difficultyRank":9,"botEnabled":false,"freeToPlay":true,"botMmEnabled":false,"rankedPlayEnabled":true}]}'
+    http_version: 
+  recorded_at: Wed, 11 Dec 2013 15:44:19 GMT
+recorded_with: VCR 2.8.0