league_of_legends 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69d531bb9522870e6d2b2f4c641fd2b8cca0f28b
-  data.tar.gz: 63d6949c7a40c92127769f36ea0bc078fb126882
+  metadata.gz: 88d301f5ac4bd1cbfce2d325c27fc7b812e9c6fc
+  data.tar.gz: 95bc9470c025d4d4c878b07d3094504fd1354f03
 SHA512:
-  metadata.gz: c26c44e5243efe607d6a462d4e477cae4f18e1c1f80794001e5275193e1ee6199e932943aceb60671cd67330b8f276d2fabb4b2f1e13787d01d9ad6480699159
-  data.tar.gz: a783c48faa899654dd5f5ab616a8603cfba113815617ae027dafc00b0adba94ec0762f0cb913daf4c1770f51750ffc76565d210569235f153696adc483f79b47
+  metadata.gz: 20670ef360d1c4bc57658e49234f2d2c99f3ed832ac42cc47e2a3cc5445aef0f5c6645f3088f7e0c3b4d2c6ad2dadab560d08ccccfe0846161c7e92c04f5b4db
+  data.tar.gz: 26b7b4a92f6eb33ce2f7fe4383d536287ade407ced096cedfa78ba58e2130f022c35aafeee9cf3223133f0b3eafafd9e8916b3539c10af10f4ff18bca76be130

data/README.md

@@ -20,14 +20,19 @@ Or install it yourself as:
 
 ## Usage
 
-The gem is still not (properly) usable at this point. It is a work in progress! :)
+The gem is still a work in progress and has limited functionality.
 
-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.
+    # create a new instance of the API
+    lol_api = ::LeagueOfLegends::Api.new <api key>
 
-Then you can do:
+    # get all available request types
+    lol_api.available_request
 
-    sss_request = ::LeagueOfLegends::Request::Stats::BySummoner::Summary.new <summoner_id>
-    sss_request.response # => ::LeagueOfLegends::DTO::PlayerStatsSummaryList
+    # execute a request
+    result_dto = lol_api.get(:summoner_stats_summary, <summoner id>)
+
+
+In this example, the DTO returned is a `::LeagueOfLegends::DTO::PlayerStatsSummaryList`.
 
 You can read about each Request and DTO at http://developer.riotgames.com/api/methods
 

data/league_of_legends.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["francisco.orvalho@gmail.com"]
   spec.summary       = %q{Implementation of the LoL API}
   spec.description   = %q{This gem implements the League Of Legends API (currently in open beta). It will continue to be updated as the API evolves.
+    Please see the README at https://github.com/forvalho/league_of_legends/blob/master/README.md
 
 This product is not endorsed, certified or otherwise approved in any way by Riot Games, Inc. or any of its affiliates.}
   spec.homepage      = "http://github.com/forvalho/league_of_legends"

data/lib/league_of_legends/api.rb

@@ -1,12 +1,66 @@
+require 'league_of_legends/request/all'
+
 module ::LeagueOfLegends
   class Api
 
-    def self.key
-      'a1a1a1-b2b2b2-c3c3c3-d4d4d4-e5e5e5e5'
+    attr_reader :key, :base_url
+
+    def initialize options = {}
+      case options
+      when Hash
+        opt = self.class.default_options.merge(options)
+        set_key(opt[:key])
+        set_base_url(opt[:base_url])
+      when String
+        set_key(options)
+        set_base_url(self.class.default_options[:base_url])
+      else
+        raise ArgumentError.new 'expected a Hash or a String'
+      end
+    end
+
+    def self.default_options
+      {
+        key: nil,
+        base_url: 'https://prod.api.pvp.net/api/lol'
+      }
+    end
+
+    def get request, *arguments
+      req_class = ::LeagueOfLegends::Request::Mapper.get(request.to_sym)
+      request = req_class.new self, *arguments
+      request.response
     end
 
-    def self.base_url
-      'https://prod.api.pvp.net/api/lol'
+    def available_requests
+      ::LeagueOfLegends::Request::Mapper.available
+    end
+
+    private
+
+    def set_key key = nil
+      case key
+      when nil
+        raise ArgumentError.new 'wrong number of arguments (0 for 1)'
+      when String
+        if key =~ /^\h{8}(-\h{4}){3}-\h{12}$/
+          @key = key
+        else
+          raise ArgumentError.new 'key with incorrect format'
+        end
+      else
+        raise ArgumentError.new 'expected a String'
+      end
+    end
+
+    def set_base_url base_url
+      require 'uri'
+
+      if base_url =~ /^#{URI::regexp}$/o
+        @base_url = base_url
+      else
+        raise ArgumentError.new 'expected a valid URL'
+      end
     end
 
   end

data/lib/league_of_legends/request/all.rb

@@ -0,0 +1,3 @@
+require 'league_of_legends/request/mapper'
+require 'league_of_legends/request/base'
+require 'league_of_legends/request/stats/by_summoner/summary'

data/lib/league_of_legends/request/base.rb

@@ -6,9 +6,8 @@ module ::LeagueOfLegends
     class Base
       require 'net/http'
 
-      def self.options
-        @options ||= default_options
-      end
+
+      attr_reader :options
 
       def self.default_options
         {
@@ -25,15 +24,16 @@ module ::LeagueOfLegends
         dto_class.version
       end
 
-      def self.region
+      def region
          options[:region]
       end
 
-      def self.api_key
-        ::LeagueOfLegends::Api.key
+      def api_key
+        api.key
       end
 
-      def initialize options = {}
+      def initialize api, options = {}
+        @api = api
         @options = self.class.default_options.merge(options)
       end
 
@@ -50,25 +50,26 @@ module ::LeagueOfLegends
 
       protected
 
+      attr_reader :api
+
       def base_url
         [
-          ::LeagueOfLegends::Api.base_url, 
-          self.class.region, 
+          api.base_url, 
+          region, 
           self.class.version
-        ].join('/')
+        ]
       end
 
       def url_parameters
         [
-          "?api_key=#{self.class.api_key}"
-        ].join('&')
+          "api_key=#{api_key}"
+        ]
       end
 
-
       private
 
       def url
-        base_url + url_parameters
+        "#{base_url.join('/')}?#{url_parameters.join('&')}"
       end
 
       def send_request

data/lib/league_of_legends/request/mapper.rb

@@ -0,0 +1,37 @@
+module ::LeagueOfLegends
+  module Request
+    class Mapper
+
+      class << self
+
+        def get request_name
+          get_info(request_name)[:class]
+        end
+
+        def get_info request_name
+          map[request_name.to_sym]
+        end
+
+        def available? request_name
+          map.has_key? request_name
+        end
+
+        def available
+          map.keys
+        end
+
+        private
+
+        def map
+          @map ||= {
+            summoner_stats_summary: {
+              class: ::LeagueOfLegends::Request::Stats::BySummoner::Summary,
+              },
+          }
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -7,10 +7,10 @@ module ::LeagueOfLegends
       module BySummoner
         class Summary < ::LeagueOfLegends::Request::Base
 
-          attr_reader :summoner_id, :options
+          attr_reader :summoner_id
 
-          def initialize summoner_id, options = {}
-            super(options)
+          def initialize api, summoner_id, options = {}
+            super(api, options)
             @summoner_id = summoner_id
           end
 
@@ -21,7 +21,7 @@ module ::LeagueOfLegends
           protected
 
           def base_url
-            super + "/stats/by-summoner/#{summoner_id}/summary"
+            super << "stats/by-summoner/#{summoner_id}/summary"
           end
 
         end

data/lib/league_of_legends/version.rb

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

data/spec/league_of_legends/api_spec.rb

@@ -2,13 +2,25 @@ 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
+  let(:api) { ::LeagueOfLegends::Api.new '0c78469b-b773-4b35-9f6a-00d7fe964290
+' }
+
+  it "has access to an API key" do
+    pending "testing with real key"
+    expect(api.key).to eq 'a1a1a1a1-a1a1-a1a1-a1a1-a1a1a1a1a1a1'
   end
 
   it "has a base url" do
-    expect(described_class.base_url).to eq 'https://prod.api.pvp.net/api/lol'
+    expect(api.base_url).to eq 'https://prod.api.pvp.net/api/lol'
+  end
+
+  it "can get a list of available requests" do
+    expect(api.available_requests).to be_kind_of Enumerable
+  end
+
+  it "can send requests and receive a response" do
+    pending "requires internet connection"
+    expect(api.get(:summoner_stats_summary, 12345)).to be_an_instance_of ::LeagueOfLegends::DTO::PlayerStatsSummaryList
   end
 
 end

data/spec/league_of_legends/request/base_spec.rb

@@ -2,19 +2,21 @@ require 'league_of_legends/request/base'
 
 describe ::LeagueOfLegends::Request::Base do
 
+  let(:api) { ::LeagueOfLegends::Api.new 'a1a1a1a1-a1a1-a1a1-a1a1-a1a1a1a1a1a1' }
+
   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
+    req_test = ReqTest.new api
 
-    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? :options).to be_true
+    expect(req_test.respond_to? :region).to be_true
+    expect(req_test.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

data/spec/league_of_legends/request/mapper_spec.rb

@@ -0,0 +1,10 @@
+require 'league_of_legends/request/mapper'
+
+describe ::LeagueOfLegends::Request::Mapper do
+
+  it "knows the class for certain requests" do
+    req = described_class.get :summoner_stats_summary
+    expect(req).to eq ::LeagueOfLegends::Request::Stats::BySummoner::Summary
+  end
+
+end

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

@@ -2,19 +2,22 @@ require 'league_of_legends/request/stats/by_summoner/summary'
 
 describe ::LeagueOfLegends::Request::Stats::BySummoner::Summary do
 
-  let(:request) { described_class.new 50519866 }
+  let(:api) { ::LeagueOfLegends::Api.new 'a1a1a1a1-a1a1-a1a1-a1a1-a1a1a1a1a1a1' }
+
+  let(:request) { described_class.new api, 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.region).to eq 'euw'
+    expect(request.api_key).to be_an_instance_of String
+    expect(request.api_key.length).to eq 36
     
     expect(request.summoner_id).to eq 50519866
   end
 
   it "can be sent and get a response" do
+    pending "requires internet connection"
     expect(request.response).to be_an_instance_of ::LeagueOfLegends::DTO::PlayerStatsSummaryList
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: league_of_legends
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Francisco Orvalho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2014-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,6 +40,7 @@ dependencies:
         version: '0'
 description: |-
   This gem implements the League Of Legends API (currently in open beta). It will continue to be updated as the API evolves.
+      Please see the README at https://github.com/forvalho/league_of_legends/blob/master/README.md
 
   This product is not endorsed, certified or otherwise approved in any way by Riot Games, Inc. or any of its affiliates.
 email:
@@ -62,7 +63,9 @@ files:
 - 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/all.rb
 - lib/league_of_legends/request/base.rb
+- lib/league_of_legends/request/mapper.rb
 - lib/league_of_legends/request/stats/by_summoner/summary.rb
 - lib/league_of_legends/version.rb
 - spec/league_of_legends/api_spec.rb
@@ -73,6 +76,7 @@ files:
 - 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/mapper_spec.rb
 - spec/league_of_legends/request/stats/by_summoner/summary_spec.rb
 homepage: http://github.com/forvalho/league_of_legends
 licenses:
@@ -107,4 +111,6 @@ test_files:
 - 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/mapper_spec.rb
 - spec/league_of_legends/request/stats/by_summoner/summary_spec.rb
+has_rdoc: