open_dota_api 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 26b5314aeee9b4bb08ed2c8b16729d9d9257cd11
-  data.tar.gz: 37724f8357207da15240781468a9fa54fc303b92
+SHA256:
+  metadata.gz: 808512136e0502bf89c7a10c8922302f70917042d7a866cf10ff3e8a441ee299
+  data.tar.gz: 0d8487e5a03d1d4c7020c1a739938ecacd52edc60a55801918d3a693310215b6
 SHA512:
-  metadata.gz: 9c8f25ea65b0cf61b8312e935ce3a5f93fc8263ffbd6662eb9e55da987c1a75aac078bb058a43d8b701bf0ee6e971fcbc380dbac47cd862670cef13de1c90aad
-  data.tar.gz: 18d14e7aceb9ef766a731e4b364b46e8eb14e84e406493226eb5143e45495452fce99bc09353f35c93f49cad476663310b5eaba03bd50367be9067801824d63d
+  metadata.gz: 795eac8e9764bca6fe5cba16bcf29965cc3e4efef6ec6d41dc89303f1d0be0f46d62332c40d2b3928648de259a05f5ccda7158b057aed9e8cc8d6d1a1f341392
+  data.tar.gz: d2844e9bd2e35298cfce1f4b0664ae188ede5b2d5a912b0978e497aab99cd77056655d4069bb01c25c4b87100d090c625ab5cc2907d01a362acf6e7e4b36bd15

data/lib/open_dota_api.rb

@@ -8,4 +8,8 @@ module OpenDotaApi
   def self.client
     @client ||= Client.new
   end
+
+  class << self
+    attr_accessor :api_key
+  end
 end

data/lib/open_dota_api/client.rb

@@ -10,39 +10,45 @@ module OpenDotaApi
   class Client
     INTERFACE = 'api'.freeze
 
-    def leagues
-      leagues_data = request(League::ENDPOINT)
+    def leagues(attributes = {})
+      leagues_data = request(League::ENDPOINT, query_params: { api_key: attributes.delete(:api_key) }.compact)
       return {} unless leagues_data.success?
+
       League.instantiate(leagues_data)
     end
 
-    def teams
-      teams_data = request(Team::ENDPOINT)
+    def teams(attributes = {})
+      teams_data = request(Team::ENDPOINT, query_params: { api_key: attributes.delete(:api_key) }.compact)
       return {} unless teams_data.success?
+
       Team.instantiate(teams_data)
     end
 
-    def matches(match_id = nil)
-      match_data = request(Match::ENDPOINT, match_id)
+    def matches(match_id = nil, attributes = {})
+      match_data = request(Match::ENDPOINT, match_id, query_params: { api_key: attributes.delete(:api_key) }.compact)
       return {} unless match_data.success?
+
       Match.new(match_data)
     end
 
-    def heroes
-      heroes_data = request(Hero::ENDPOINT)
+    def heroes(attributes = {})
+      heroes_data = request(Hero::ENDPOINT, query_params: { api_key: attributes.delete(:api_key) }.compact)
       return {} unless heroes_data.success?
+
       Hero.instantiate(heroes_data)
     end
 
-    def pro_players
-      pro_players_data = request(ProPlayer::ENDPOINT)
+    def pro_players(attributes = {})
+      pro_players_data = request(ProPlayer::ENDPOINT, query_params: { api_key: attributes.delete(:api_key) }.compact)
       return {} unless pro_players_data
+
       ProPlayer.instantiate(pro_players_data)
     end
 
-    def explorer(league_id = nil)
-      explorer_data = request(Explorer::ENDPOINT, query_params: Explorer.query_params(league_id))
+    def explorer(league_id = nil, attributes = {})
+      explorer_data = request(Explorer::ENDPOINT, query_params: { api_key: attributes.delete(:api_key) }.merge(Explorer.query_params(league_id)).compact)
       return {} unless explorer_data.success?
+
       Explorer.new(explorer_data)
     end
 
@@ -52,10 +58,12 @@ module OpenDotaApi
       @connection ||= Connection.new
     end
 
-    def request(method, argument = nil, query_params: nil)
-      argument = argument ? argument.to_s.concat('/') : nil
-      pathname = "/#{INTERFACE}/#{method}/#{argument}"
-      connection.get(pathname, query: query_params)
+    def request(method, argument = nil, query_params: {})
+      params = query_params.merge({ api_key: OpenDotaApi.api_key }.compact)
+      argument = argument ? "/#{argument}" : nil
+      pathname = "/#{INTERFACE}/#{method}#{argument}"
+
+      connection.get(pathname, query: params)
     end
   end
 end

data/lib/open_dota_api/pro_player.rb

@@ -79,11 +79,11 @@ module OpenDotaApi
       data['team_tag']
     end
 
-    def is_locked
+    def locked?
       data['is_locked']
     end
 
-    def is_pro
+    def pro?
       data['is_pro']
     end
 

data/lib/open_dota_api/version.rb

@@ -1,3 +1,3 @@
 module OpenDotaApi
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/spec/lib/open_dota_api/client_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 
 describe OpenDotaApi::Client do
-
   let(:client) { described_class.new }
   let(:endpoint) {}
-  let(:match_id) { 3149215336 }
+  let(:match_id) { 3_149_215_336 }
   let(:league_id) { 5401 }
   let(:leagues_file) { File.read('spec/data/leagues.json') }
   let(:teams_file) { File.read('spec/data/teams.json') }
@@ -15,7 +14,7 @@ describe OpenDotaApi::Client do
   let(:data_file) {}
   let(:headers) do
     {
-        "content-type" => ["application/json; charset=utf-8"]
+      'content-type' => ['application/json; charset=utf-8']
     }
   end
 
@@ -26,12 +25,14 @@ describe OpenDotaApi::Client do
   let(:expected_heroes) { OpenDotaApi::Hero.instantiate(response_json) }
   let(:expected_pro_players) { OpenDotaApi::ProPlayers.instantiate(response_json) }
 
-  let(:api_url) {"http://api.opendota.com/api/#{endpoint}/"}
+  let(:api_key) { 'random-value' }
+  let(:params) { "" }
+  let(:api_url) { "http://api.opendota.com/api/#{endpoint}#{params}" }
 
   before do
-    stub_request(:get, api_url).
-        with(headers: { 'Accept': '*/*', 'Accept-Encoding': 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent': 'Ruby' }).
-        to_return(status: 200, body: data_file, headers: headers)
+    stub_request(:get, api_url)
+      .with(headers: { 'Accept': '*/*', 'Accept-Encoding': 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent': 'Ruby' })
+      .to_return(status: 200, body: data_file, headers: headers)
   end
 
   it 'returns interface' do
@@ -44,7 +45,7 @@ describe OpenDotaApi::Client do
       let(:data_file) { leagues_file }
 
       it 'returns array of objects' do
-        expect(client.leagues.all? { |league| league.kind_of? OpenDotaApi::League }).to be_truthy
+        expect(client.leagues.all? { |league| league.is_a? OpenDotaApi::League }).to be_truthy
       end
 
       it 'returns list' do
@@ -57,7 +58,7 @@ describe OpenDotaApi::Client do
       let(:data_file) { teams_file }
 
       it 'returns array of objects' do
-        expect(client.teams.all? { |team| team.kind_of? OpenDotaApi::Team }).to be_truthy
+        expect(client.teams.all? { |team| team.is_a? OpenDotaApi::Team }).to be_truthy
       end
 
       it 'returns list' do
@@ -70,7 +71,7 @@ describe OpenDotaApi::Client do
       let(:data_file) { match_file }
 
       it 'returns object' do
-        expect(client.matches(match_id).kind_of? OpenDotaApi::Match).to be_truthy
+        expect(client.matches(match_id).is_a?(OpenDotaApi::Match)).to be_truthy
       end
 
       it 'returns match' do
@@ -78,13 +79,12 @@ describe OpenDotaApi::Client do
       end
     end
 
-
     describe '#heroes' do
-      let(:endpoint) { "#{OpenDotaApi::Hero::ENDPOINT}" }
+      let(:endpoint) { OpenDotaApi::Hero::ENDPOINT }
       let(:data_file) { heroes_file }
 
       it 'returns array of objects' do
-        expect(client.heroes.all? { |hero| hero.kind_of? OpenDotaApi::Hero }).to be_truthy
+        expect(client.heroes.all? { |hero| hero.is_a? OpenDotaApi::Hero }).to be_truthy
       end
 
       it 'returns list' do
@@ -93,11 +93,11 @@ describe OpenDotaApi::Client do
     end
 
     describe '#pro_players' do
-      let(:endpoint) { "#{OpenDotaApi::ProPlayer::ENDPOINT}" }
+      let(:endpoint) { OpenDotaApi::ProPlayer::ENDPOINT }
       let(:data_file) { pro_players_file }
 
       it 'returns array of objects' do
-        expect(client.pro_players.all? { |hero| hero.kind_of? OpenDotaApi::ProPlayer }).to be_truthy
+        expect(client.pro_players.all? { |hero| hero.is_a? OpenDotaApi::ProPlayer }).to be_truthy
       end
 
       it 'returns list' do
@@ -107,12 +107,23 @@ describe OpenDotaApi::Client do
 
     describe '#explorer' do
       let(:query) { OpenDotaApi::Explorer.query_params(league_id) }
-      let(:endpoint) { "#{OpenDotaApi::Explorer::ENDPOINT}/?#{query.keys[0]}=#{query.values[0]}" }
+      let(:endpoint) { "#{OpenDotaApi::Explorer::ENDPOINT}" }
+      let(:params) { "?#{query.keys[0]}=#{query.values[0]}" }
       let(:data_file) { explorer_file }
-      let(:api_url) {"http://api.opendota.com/api/#{endpoint}"}
 
       it 'returns array of match ids' do
-        expect(client.explorer(league_id).league_matches_ids.kind_of? Array).to be_truthy
+        expect(client.explorer(league_id).league_matches_ids.is_a?(Array)).to be_truthy
+      end
+
+      context 'API_KEY' do
+        let(:params) { "?api_key=#{api_key}&#{query.keys[0]}=#{query.values[0]}" }
+        before do
+          OpenDotaApi.api_key = api_key
+        end
+
+        it 'returns array of match ids' do
+          expect(client.explorer(league_id).league_matches_ids.is_a?(Array)).to be_truthy
+        end
       end
     end
   end

data/spec/lib/open_dota_api/explorer_spec.rb

@@ -19,6 +19,10 @@ describe OpenDotaApi::Explorer do
     expect(explorer).to be_a OpenDotaApi::Entity
   end
 
+  it 'is not instantiable' do
+    expect { described_class.instantiate }.to raise_error NotImplementedError
+  end
+
   describe 'default attributes' do
     it "returns league's matches ids" do
       expect(explorer.league_matches_ids).to match_array(match_ids)

data/spec/lib/open_dota_api/pro_player_spec.rb

@@ -119,11 +119,11 @@ describe OpenDotaApi::ProPlayer do
     end
 
     it 'returns if it is locked' do
-      expect(pro_player.is_locked).to eq is_locked
+      expect(pro_player.locked?).to eq is_locked
     end
 
     it 'returns if it is pro' do
-      expect(pro_player.is_pro).to eq is_pro
+      expect(pro_player.pro?).to eq is_pro
     end
 
     it 'returns locked until' do

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: open_dota_api
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
-- Yaroslav Oslavskiy
+- YaroslavO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2019-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: hashable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
-  name: hashable
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.17.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -59,83 +59,83 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.5
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 13.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 13.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.8.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 3.7.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 3.7.5
 description: Unofficial Ruby Library for OpenDotaAPI. This API provides Dota 2 related
   data.
 email:
-- osyaroslav@gmail.com.com
+- osyaroslav@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -192,27 +192,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Open Dota API
 test_files:
-- spec/data/explorer.json
-- spec/data/heroes.json
-- spec/data/leagues.json
-- spec/data/match.json
-- spec/data/pro_players.json
-- spec/data/teams.json
-- spec/data/unofficial_match.json
-- spec/lib/open_dota_api/client_spec.rb
-- spec/lib/open_dota_api/connection_spec.rb
-- spec/lib/open_dota_api/explorer_spec.rb
-- spec/lib/open_dota_api/hero_spec.rb
+- spec/spec_helper.rb
+- spec/lib/open_dota_api/team_spec.rb
 - spec/lib/open_dota_api/league_spec.rb
+- spec/lib/open_dota_api/client_spec.rb
 - spec/lib/open_dota_api/match_spec.rb
+- spec/lib/open_dota_api/explorer_spec.rb
 - spec/lib/open_dota_api/matches/player_spec.rb
+- spec/lib/open_dota_api/hero_spec.rb
+- spec/lib/open_dota_api/connection_spec.rb
 - spec/lib/open_dota_api/pro_player_spec.rb
-- spec/lib/open_dota_api/team_spec.rb
 - spec/lib/open_dota_api_spec.rb
-- spec/spec_helper.rb
+- spec/data/heroes.json
+- spec/data/match.json
+- spec/data/teams.json
+- spec/data/pro_players.json
+- spec/data/unofficial_match.json
+- spec/data/explorer.json
+- spec/data/leagues.json