league_of_legends 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecc7dd2c6bbe476cb20c0a555a47fca80fbabbce
-  data.tar.gz: 4f81bd5b7e31e558ea930bd7ea9e1f2e4d89f184
+  metadata.gz: 69d531bb9522870e6d2b2f4c641fd2b8cca0f28b
+  data.tar.gz: 63d6949c7a40c92127769f36ea0bc078fb126882
 SHA512:
-  metadata.gz: 0954d361c173bb8f729d3d931362116e5c48840c20d45e4a7a64c358c2466728207a926a84aa0b9a7b8153a7e5518dc54543f7fd2166789343b8b9fa33ebb8a4
-  data.tar.gz: 40951e499982bd5f7f9547265fb2b4337502c7e0fd254558927d42bb7c78a4545193ab017a9f8c9a140f7b599aef2d35702b0cd367b388bc7a1c7f560e8da9c5
+  metadata.gz: c26c44e5243efe607d6a462d4e477cae4f18e1c1f80794001e5275193e1ee6199e932943aceb60671cd67330b8f276d2fabb4b2f1e13787d01d9ad6480699159
+  data.tar.gz: a783c48faa899654dd5f5ab616a8603cfba113815617ae027dafc00b0adba94ec0762f0cb913daf4c1770f51750ffc76565d210569235f153696adc483f79b47

data/README.md

@@ -1,4 +1,4 @@
-# LeagueOfLegends
+# league_of_legends
 
 This gem implements the League Of Legends API (currently in open beta). It will continue to be updated as the API evolves.
 
@@ -20,11 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem is still not (properly) usable at this point. It is a work in progress! :)
+
+To work with it (until the next version comes out!), change the code in lib/league_of_legends/api.rb to return your actual API key.
+
+Then you can do:
+
+    sss_request = ::LeagueOfLegends::Request::Stats::BySummoner::Summary.new <summoner_id>
+    sss_request.response # => ::LeagueOfLegends::DTO::PlayerStatsSummaryList
+
+You can read about each Request and DTO at http://developer.riotgames.com/api/methods
+
+
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/league_of_legends/fork )
+1. Fork it ( http://github.com/forvalho/league_of_legends/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/league_of_legends/api.rb

@@ -0,0 +1,13 @@
+module ::LeagueOfLegends
+  class Api
+
+    def self.key
+      'a1a1a1-b2b2b2-c3c3c3-d4d4d4-e5e5e5e5'
+    end
+
+    def self.base_url
+      'https://prod.api.pvp.net/api/lol'
+    end
+
+  end
+end

data/lib/league_of_legends/dto/aggregated_stats.rb

@@ -2,6 +2,10 @@ module ::LeagueOfLegends
   module DTO
     class AggregatedStats
 
+      def self.version
+        ::LeagueOfLegends::DTO::PlayerStatsSummaryList.version
+      end
+
       attr_reader :average_assists, :average_champions_killed, 
         :average_combat_player_score, :average_node_capture, 
         :average_node_capture_assist, :average_node_neutralize, 
@@ -25,7 +29,7 @@ module ::LeagueOfLegends
         :total_quadra_kills, :total_sessions_lost, :total_sessions_played, 
         :total_sessions_won, :total_triple_kills, :total_turrets_killed, 
         :total_unreal_kills
-        
+
       def initialize attributes
         @average_assists = attributes[:averageAssists].to_i
         @average_champions_killed = attributes[:averageChampionsKilled].to_i

data/lib/league_of_legends/dto/champion.rb

@@ -0,0 +1,30 @@
+module ::LeagueOfLegends
+  module DTO
+    class Champion
+
+      def self.version
+        ::LeagueOfLegends::DTO::ChampionList.version
+      end
+
+      attr_reader :active, :attack_rank, :bot_enabled,
+        :bot_mm_enabled, :defense_rank, :difficulty_rank,
+        :free_to_play, :id, :magic_rank, :name,
+        :ranked_play_enabled
+
+      def initialize attributes
+        @active = attributes[:active]
+        @attack_rank = attributes[:attackRank]
+        @bot_enabled = attributes[:botEnabled]
+        @bot_mm_enabled = attributes[:botMmEnabled]
+        @defense_rank = attributes[:defenseRank]
+        @difficulty_rank = attributes[:difficultyRank]
+        @free_to_play = attributes[:freeToPlay]
+        @id = attributes[:id]
+        @magic_rank = attributes[:magicRank]
+        @name = attributes[:name]
+        @ranked_play_enabled = attributes[:rankedPlayEnabled]
+      end
+
+    end
+  end
+end

data/lib/league_of_legends/dto/champion_list.rb

@@ -0,0 +1,23 @@
+require 'league_of_legends/dto/base'
+require 'league_of_legends/dto/champion'
+
+module ::LeagueOfLegends
+  module DTO
+    class ChampionList < ::LeagueOfLegends::DTO::Base
+
+      def self.version
+        'v1.1'
+      end
+
+      attr_reader :champions
+
+      def initialize json
+        attributes = build_attributes json
+        @champions = attributes[:champions].map do |champion|
+          ::LeagueOfLegends::DTO::Champion.new(champion)
+        end
+      end
+
+    end
+  end
+end

data/lib/league_of_legends/dto/player_stats_summary.rb

@@ -1,7 +1,13 @@
+require 'league_of_legends/dto/aggregated_stats'
+
 module ::LeagueOfLegends
   module DTO
     class PlayerStatsSummary
 
+      def self.version
+        ::LeagueOfLegends::DTO::PlayerStatsSummaryList.version
+      end
+
       attr_reader :player_stat_summary_type, :wins,
         :losses, :modify_date, :aggregated_stats
 

data/lib/league_of_legends/dto/player_stats_summary_list.rb

@@ -1,21 +1,24 @@
+require 'league_of_legends/dto/base'
+require 'league_of_legends/dto/player_stats_summary'
+
 module ::LeagueOfLegends
   module DTO
     class PlayerStatsSummaryList < ::LeagueOfLegends::DTO::Base
 
+      def self.version
+        'v1.2'
+      end
+
       attr_reader :summoner_id, :player_stat_summaries
 
       def initialize json
-        @attributes = build_attributes json
+        attributes = build_attributes json
         @summoner_id = attributes[:summonerId].to_i
         @player_stat_summaries = attributes[:playerStatSummaries].map do |pss|
           ::LeagueOfLegends::DTO::PlayerStatsSummary.new(pss)
         end
       end
 
-      private
-
-      attr_reader :attributes
-
     end
   end
 end

data/lib/league_of_legends/request/base.rb

@@ -0,0 +1,81 @@
+require "net/http"
+require "uri"
+
+module ::LeagueOfLegends
+  module Request
+    class Base
+      require 'net/http'
+
+      def self.options
+        @options ||= default_options
+      end
+
+      def self.default_options
+        {
+          region: 'euw',
+          version: dto_class.version
+        }
+      end
+
+      def self.dto_class
+        raise NotImplementedError, "Children of LeagueOfLegends::Request::Base must implement ::dto_class"
+      end
+
+      def self.version
+        dto_class.version
+      end
+
+      def self.region
+         options[:region]
+      end
+
+      def self.api_key
+        ::LeagueOfLegends::Api.key
+      end
+
+      def initialize options = {}
+        @options = self.class.default_options.merge(options)
+      end
+
+      def response
+        @response ||= send_request
+
+        case @response.code.to_i
+        when 200 then
+          self.class.dto_class.new(@response.body)
+        else
+          @response.message
+        end
+      end
+
+      protected
+
+      def base_url
+        [
+          ::LeagueOfLegends::Api.base_url, 
+          self.class.region, 
+          self.class.version
+        ].join('/')
+      end
+
+      def url_parameters
+        [
+          "?api_key=#{self.class.api_key}"
+        ].join('&')
+      end
+
+
+      private
+
+      def url
+        base_url + url_parameters
+      end
+
+      def send_request
+        uri = URI.parse url
+        Net::HTTP.get_response uri
+      end
+
+    end
+  end
+end

data/lib/league_of_legends/request/stats/by_summoner/summary.rb

@@ -0,0 +1,31 @@
+require 'league_of_legends/request/base'
+require 'league_of_legends/dto/player_stats_summary_list'
+
+module ::LeagueOfLegends
+  module Request
+    module Stats
+      module BySummoner
+        class Summary < ::LeagueOfLegends::Request::Base
+
+          attr_reader :summoner_id, :options
+
+          def initialize summoner_id, options = {}
+            super(options)
+            @summoner_id = summoner_id
+          end
+
+          def self.dto_class
+            ::LeagueOfLegends::DTO::PlayerStatsSummaryList
+          end
+
+          protected
+
+          def base_url
+            super + "/stats/by-summoner/#{summoner_id}/summary"
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/league_of_legends/version.rb

@@ -1,3 +1,3 @@
 module LeagueOfLegends
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/league_of_legends/api_spec.rb

@@ -0,0 +1,14 @@
+require 'league_of_legends/api'
+
+describe ::LeagueOfLegends::Api do
+
+  it "has an API key" do
+    expect(described_class.key).to be_an_instance_of String
+    expect(described_class.key.length).to eq 36
+  end
+
+  it "has a base url" do
+    expect(described_class.base_url).to eq 'https://prod.api.pvp.net/api/lol'
+  end
+
+end

data/spec/{dto → league_of_legends/dto}/aggregated_stats_spec.rb

@@ -18,5 +18,9 @@ describe ::LeagueOfLegends::DTO::AggregatedStats do
     expect(dto.total_neutral_minions_killed).to eq 339
     expect(dto.total_assists).to eq 75
   end
+
+  it "has a version" do
+    expect(described_class.version).to eq 'v1.2'
+  end
   
 end

data/spec/{dto → league_of_legends/dto}/base_spec.rb

@@ -2,4 +2,6 @@ require 'league_of_legends/dto/base'
 
 describe ::LeagueOfLegends::DTO::Base do
 
+  let(:dto) { described_class.new }
+
 end

data/spec/league_of_legends/dto/champion_list_spec.rb

@@ -0,0 +1,62 @@
+require 'league_of_legends/dto/champion_list'
+
+describe ::LeagueOfLegends::DTO::ChampionList do
+
+  json = '{"champions": 
+  [
+    {
+      "botMmEnabled": false,
+      "defenseRank": 4,
+      "attackRank": 8,
+      "id": 266,
+      "rankedPlayEnabled": true,
+      "name": "Aatrox",
+      "botEnabled": false,
+      "difficultyRank": 6,
+      "active": true,
+      "freeToPlay": false,
+      "magicRank": 3
+    },
+    {
+      "botMmEnabled": false,
+      "defenseRank": 4,
+      "attackRank": 3,
+      "id": 103,
+      "rankedPlayEnabled": true,
+      "name": "Ahri",
+      "botEnabled": false,
+      "difficultyRank": 8,
+      "active": true,
+      "freeToPlay": false,
+      "magicRank": 8
+    },
+    {
+      "botMmEnabled": false,
+      "defenseRank": 3,
+      "attackRank": 5,
+      "id": 84,
+      "rankedPlayEnabled": true,
+      "name": "Akali",
+      "botEnabled": false,
+      "difficultyRank": 6,
+      "active": true,
+      "freeToPlay": false,
+      "magicRank": 8
+    }
+  ]}'
+  let(:dto){ described_class.new(json) }
+
+  it "has attributes" do
+    expect(dto.champions).to be_an_instance_of Array
+    expect(dto.champions.size).to eq 3
+
+    dto.champions.each do |champion|
+      expect(champion).to be_an_instance_of ::LeagueOfLegends::DTO::Champion
+    end
+  end
+
+  it "has a version" do
+    expect(described_class.version).to eq 'v1.1'
+  end
+
+end

data/spec/league_of_legends/dto/champion_spec.rb

@@ -0,0 +1,38 @@
+require 'league_of_legends/dto/champion'
+
+describe ::LeagueOfLegends::DTO::Champion do
+
+  let(:attributes) { {
+      botMmEnabled: false,
+      defenseRank: 4,
+      attackRank: 3,
+      id: 103,
+      rankedPlayEnabled: true,
+      name: "Ahri",
+      botEnabled: false,
+      difficultyRank: 8,
+      active: true,
+      freeToPlay: false,
+      magicRank: 8
+  } }
+  let(:dto) { described_class.new(attributes) }
+
+  it "has attributes" do
+    expect(dto.bot_mm_enabled).to be_false
+    expect(dto.defense_rank).to eq 4
+    expect(dto.attack_rank).to eq 3
+    expect(dto.id).to eq 103
+    expect(dto.ranked_play_enabled).to be_true
+    expect(dto.name).to eq "Ahri"
+    expect(dto.bot_enabled).to be_false
+    expect(dto.difficulty_rank).to eq 8
+    expect(dto.active).to be_true
+    expect(dto.free_to_play).to be_false
+    expect(dto.magic_rank).to eq 8
+  end
+
+  it "has a version" do
+    expect(described_class.version).to eq 'v1.1'
+  end
+
+end

data/spec/{dto → league_of_legends/dto}/player_stats_summary_list_spec.rb

@@ -1,5 +1,4 @@
 require 'league_of_legends/dto/player_stats_summary_list'
-require 'league_of_legends/dto/player_stats_summary_list'
 
 describe ::LeagueOfLegends::DTO::PlayerStatsSummaryList do
 
@@ -55,11 +54,15 @@ describe ::LeagueOfLegends::DTO::PlayerStatsSummaryList do
 
   it "has attributes" do
     expect(dto.summoner_id).to eq 50519866
-    expect(dto.player_stat_summaries.is_a? Array).to eq true
+    expect(dto.player_stat_summaries).to be_an_instance_of Array
   
     dto.player_stat_summaries.each do |pss|
-      expect(pss.is_a? ::LeagueOfLegends::DTO::PlayerStatsSummary).to eq true
+      expect(pss).to be_an_instance_of ::LeagueOfLegends::DTO::PlayerStatsSummary
     end
   end
+
+  it "has a version" do
+    expect(described_class.version).to eq 'v1.2'
+  end
   
 end

data/spec/{dto → league_of_legends/dto}/player_stats_summary_spec.rb

@@ -22,7 +22,11 @@ describe LeagueOfLegends::DTO::PlayerStatsSummary do
     expect(dto.wins).to eq 13
     expect(dto.losses).to eq 0
     expect(dto.modify_date).to eq Time.new(2013,11,25,14,26,36)
-    expect(dto.aggregated_stats.is_a?(LeagueOfLegends::DTO::AggregatedStats)).to eq true
+    expect(dto.aggregated_stats).to be_an_instance_of ::LeagueOfLegends::DTO::AggregatedStats
+  end
+
+  it "has a version" do
+    expect(described_class.version).to eq 'v1.2'
   end
 
 end

data/spec/league_of_legends/request/base_spec.rb

@@ -0,0 +1,24 @@
+require 'league_of_legends/request/base'
+
+describe ::LeagueOfLegends::Request::Base do
+
+  it "exposes methods to it's children" do
+    class ReqTest < described_class
+      def self.version; 'xx'; end
+      def self.dto_class; ReqTest; end
+    end
+    req_test = ReqTest.new
+
+    expect(ReqTest.respond_to? :options).to be_true
+    expect(ReqTest.respond_to? :default_options).to be_true
+    expect(ReqTest.respond_to? :dto_class).to be_true
+    expect(ReqTest.respond_to? :version).to be_true
+    expect(ReqTest.respond_to? :region).to be_true
+    expect(ReqTest.respond_to? :api_key).to be_true
+    expect(req_test.respond_to? :response).to be_true
+
+    expect(req_test.respond_to? :url).to be_false
+    expect(req_test.respond_to? :send_request).to be_false
+  end
+
+end

data/spec/league_of_legends/request/stats/by_summoner/summary_spec.rb

@@ -0,0 +1,21 @@
+require 'league_of_legends/request/stats/by_summoner/summary'
+
+describe ::LeagueOfLegends::Request::Stats::BySummoner::Summary do
+
+  let(:request) { described_class.new 50519866 }
+
+  it "has the required parameters" do
+    expect(described_class.dto_class).to eq ::LeagueOfLegends::DTO::PlayerStatsSummaryList
+    expect(described_class.region).to eq 'euw'
+    expect(described_class.version).to eq 'v1.2'
+    expect(described_class.api_key).to be_an_instance_of String
+    expect(described_class.api_key.length).to eq 36
+    
+    expect(request.summoner_id).to eq 50519866
+  end
+
+  it "can be sent and get a response" do
+    expect(request.response).to be_an_instance_of ::LeagueOfLegends::DTO::PlayerStatsSummaryList
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: league_of_legends
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Francisco Orvalho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-24 00:00:00.000000000 Z
+date: 2014-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,15 +55,25 @@ files:
 - Rakefile
 - league_of_legends.gemspec
 - lib/league_of_legends.rb
+- lib/league_of_legends/api.rb
 - lib/league_of_legends/dto/aggregated_stats.rb
 - lib/league_of_legends/dto/base.rb
+- lib/league_of_legends/dto/champion.rb
+- lib/league_of_legends/dto/champion_list.rb
 - lib/league_of_legends/dto/player_stats_summary.rb
 - lib/league_of_legends/dto/player_stats_summary_list.rb
+- lib/league_of_legends/request/base.rb
+- lib/league_of_legends/request/stats/by_summoner/summary.rb
 - lib/league_of_legends/version.rb
-- spec/dto/aggregated_stats_spec.rb
-- spec/dto/base_spec.rb
-- spec/dto/player_stats_summary_list_spec.rb
-- spec/dto/player_stats_summary_spec.rb
+- spec/league_of_legends/api_spec.rb
+- spec/league_of_legends/dto/aggregated_stats_spec.rb
+- spec/league_of_legends/dto/base_spec.rb
+- spec/league_of_legends/dto/champion_list_spec.rb
+- spec/league_of_legends/dto/champion_spec.rb
+- spec/league_of_legends/dto/player_stats_summary_list_spec.rb
+- spec/league_of_legends/dto/player_stats_summary_spec.rb
+- spec/league_of_legends/request/base_spec.rb
+- spec/league_of_legends/request/stats/by_summoner/summary_spec.rb
 homepage: http://github.com/forvalho/league_of_legends
 licenses:
 - MIT
@@ -89,7 +99,12 @@ signing_key:
 specification_version: 4
 summary: Implementation of the LoL API
 test_files:
-- spec/dto/aggregated_stats_spec.rb
-- spec/dto/base_spec.rb
-- spec/dto/player_stats_summary_list_spec.rb
-- spec/dto/player_stats_summary_spec.rb
+- spec/league_of_legends/api_spec.rb
+- spec/league_of_legends/dto/aggregated_stats_spec.rb
+- spec/league_of_legends/dto/base_spec.rb
+- spec/league_of_legends/dto/champion_list_spec.rb
+- spec/league_of_legends/dto/champion_spec.rb
+- spec/league_of_legends/dto/player_stats_summary_list_spec.rb
+- spec/league_of_legends/dto/player_stats_summary_spec.rb
+- spec/league_of_legends/request/base_spec.rb
+- spec/league_of_legends/request/stats/by_summoner/summary_spec.rb