wot_api 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0909caedc0a048860390e94624ac37f4c9af8c2
-  data.tar.gz: 8a75cb0165ee35d8c9db6de2c8a04cadd5a76ad5
+  metadata.gz: 4586e3de28e0bacf291c1cbe01b18ff30fc2ace9
+  data.tar.gz: 0cd304b95e69d48dc12509c91fd5b1496787423e
 SHA512:
-  metadata.gz: 4fe70ddf3fa23be6410327910a1fabdc23577ed4273d0d961d5ebbf6cedf65b232e3bd6336ec05e1e79c617b084c81083e9acd169726bf307a07c1fc80595257
-  data.tar.gz: 2c3755fbc5ed330fa206babc9f7a2115878b7b8d75558d99f5e2edecce56935c542af7ae0b2c840a26665cfab41dd3b8a4c30ed72905f9212cffbc89349bcfc5
+  metadata.gz: 43d4e887e6524d6671567387d364e317869f2d8fdfb6f4971154a07aced1e0bc9691aa7f00252657243b2737907b32326d1a465a2ab7a4e513e5b1c368fef79f
+  data.tar.gz: 513b084b8a91ca13d245da5953f85692145b1de7f3ec9ee90ae66bc27f3abef0e2a8ba0cb80f25d5915f1aff684389ef5833bd79e4a09328038bedce6e79989b

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.1
+  - 2.0.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - ruby-head

data/README.md

@@ -1,6 +1,8 @@
 # WotApi
 
-API wrapper for World of Tanks
+API wrapper for World of Tanks in Ruby
+
+[![Build Status](https://travis-ci.org/jcantara/wot_api.svg?branch=master)](https://travis-ci.org/jcantara/wot_api)
 
 ## Installation
 
@@ -20,25 +22,38 @@ Or install it yourself as:
 
 Get an Application ID from Wargaming and read the available endpoints here: https://na.wargaming.net/developers/
 
-Initialize the gem with your Application ID:
+NOTE: Other WoT geographical regions require different Application IDs
+
+Initialize the gem with your Application ID(s):
+
+    WotApi::Base.config({na: '123456'})
+
+The available regions are: na, ru, eu, asia, kr
+
+The first region specified becomes the default if no region is specified in endpoint method arguments.
 
-WotApi::Base.application_id = '123456'
+If using Rails, it is recommended to create an initializer that looks something like:
+
+    WotApi::Base.config(YAML.load_file("#{::Rails.root}/config/wot_api.yml"))
+
+Along with a yaml file, config/wot_api.yml:
+
+    na: 123456
+    ru: 6asdf6
 
 Call endpoints like such:
 
-WotApi::Base.account_list(search: 'tank')
+    WotApi::Base.account_list(search: 'tank', region: 'ru')
 
-Will return an array or hash with the results, or nil on a failure.
+Will return an array or hash with the results, or throw an error with a message on a failure.
 
 ## Future plans
 
-Throw exceptions on failures
-
 Add class wrappers for endpoints with convenience methods for class relationships and such. 
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/wot_api/fork )
+1. Fork it ( https://github.com/jcantara/wot_api/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/wot_api/base.rb

@@ -4,7 +4,6 @@ module WotApi
 
   class Base
     include HTTParty
-    base_uri 'https://api.worldoftanks.com'
 
     ENDPOINTS = [
       '/wot/account/list/',
@@ -41,12 +40,31 @@ module WotApi
       '/wot/tanks/achievements/'
     ]
 
+    REGIONS = {
+      na: 'https://api.worldoftanks.com',
+      ru: 'https://api.worldoftanks.ru',
+      eu: 'https://api.worldoftanks.eu',
+      asia: 'https://api.worldoftanks.asia',
+      kr: 'https://api.worldoftanks.kr'
+    }
+
     class << self
-      attr_reader :application_id
+      attr_reader :configuration
+      attr_reader :default_region
 
-      def application_id=(id)
-        @application_id = id
-        #self.default_params application_id: @application_id
+      def config(params={})
+        @configuration = {}
+        @default_region = nil
+        params.each do |conf|
+          region = conf[0].to_sym
+          application_id = conf[1]
+          if REGIONS[region] && application_id
+            @default_region ||= region
+            @configuration[region] = {base_uri: REGIONS[region], application_id: application_id.to_s}
+          else
+            raise WotApi::InvalidConfigError
+          end
+        end
       end
 
       def pathname(path)
@@ -54,16 +72,32 @@ module WotApi
       end
 
       def merged_params(params)
-        params.merge({application_id: @application_id})
+        raise WotApi::InvalidConfigError unless @configuration.class == Hash
+        if region = params.delete(:region).to_sym rescue nil
+          config = @configuration[region]
+        else
+          config = @configuration[@default_region]
+        end
+        base_uri = config[:base_uri]
+        application_id = config[:application_id]
+        raise WotApi::InvalidRegionError unless base_uri && application_id
+        self.base_uri base_uri
+        params.merge({application_id: application_id})
       end
 
       ENDPOINTS.each do |endpoint|
         define_method WotApi::Base.pathname(endpoint) do |params = {}|
-          response = WotApi::Base.post(endpoint, body: merged_params(params))
+          begin
+            response = WotApi::Base.post(endpoint, body: merged_params(params))
+          rescue
+            raise
+          end
           if response && response['data']
-            response['data']
+            return response['data']
           else
-            nil
+            message = 'Unknown Error'
+            message = response['error']['message'] if response && response['error'] && response['error']['message']
+            raise WotApi::ResponseError, message
           end
         end
       end

data/lib/wot_api/exceptions.rb

@@ -0,0 +1,15 @@
+module WotApi
+
+  class Error < StandardError
+  end
+
+  class ResponseError < Error
+  end
+
+  class InvalidRegionError < Error
+  end
+
+  class InvalidConfigError < Error
+  end
+
+end

data/lib/wot_api/version.rb

@@ -1,3 +1,3 @@
 module WotApi
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/wot_api.rb

@@ -1,5 +1,5 @@
 require "wot_api/version"
 require "wot_api/base"
-#require "wot_api/player"
+require "wot_api/exceptions"
 
 module WotApi; end

data/spec/base_spec.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 
 describe WotApi::Base do
 
-  it "has the correct base_uri" do
-    expect(WotApi::Base.base_uri).to eq 'https://api.worldoftanks.com'
+  it "has an empty base_uri" do
+    # NOTE: may remove this entirely if base_uri is just going to be set dynamically
+    expect(WotApi::Base.base_uri).to eq nil
   end
 
   it "includes HTTParty" do
@@ -21,23 +22,44 @@ describe WotApi::Base do
     end
   end
 
-  describe ".application_id=" do
-    it "stores value to application_id class variable" do
-      WotApi::Base.application_id = '12345'
-      expect(WotApi::Base.application_id).to eq '12345'
+  describe "REGIONS" do
+    WotApi::Base::REGIONS.each do |region|
+      describe "#{region}" do
+        it "has a sym region key" do
+          expect(region[0]).to be_a Symbol
+        end
+
+        it "has a string value" do
+          expect(region[1]).to be_a String
+        end
+
+        it "has a https URL value" do
+          expect(URI.parse(region[1]).scheme).to eq 'https'
+        end
+      end
     end
+  end
 
-    it "updates value in application_id when set multiple times" do
-      WotApi::Base.application_id = 'aaaaa'
-      expect(WotApi::Base.application_id).to eq 'aaaaa'
-      WotApi::Base.application_id = '54321'
-      expect(WotApi::Base.application_id).to eq '54321'
+  describe ".config" do
+    context "with a valid config" do
+      it "creates hash of regions with base_uri and application_id" do
+        WotApi::Base.config({'na' => '123456'})
+        expect(WotApi::Base.configuration).to eq({na: {base_uri: 'https://api.worldoftanks.com', application_id: '123456'}})
+      end
+
+      it "sets first item as default region" do
+        WotApi::Base.config({'na' => '123456'})
+        expect(WotApi::Base.default_region).to eq :na
+        WotApi::Base.config({'ru' => '444444','na' => '123456'})
+        expect(WotApi::Base.default_region).to eq :ru
+      end
     end
 
-    #it "sets the httparty default_params hash application_id key" do
-    #  WotApi::Base.application_id = '22222'
-    #  expect(WotApi::Base.default_params[:application_id]).to eq '22222'
-    #end
+    context "with an invalid config" do
+      it "raises an error" do
+        expect{WotApi::Base.config({lalala: 'fake'})}.to raise_error
+      end
+    end
   end
 
   describe ".pathname" do
@@ -49,10 +71,30 @@ describe WotApi::Base do
   end
 
   describe ".merged_params" do
-    it "merges the params hash argument with the application_id" do
-      arguments = {a: 'hi', b: 'test', c: 3}
-      WotApi::Base.application_id = 'abc123'
-      expect(WotApi::Base.merged_params(arguments)).to eq arguments.merge(application_id: 'abc123')
+    context "with a region parameter" do
+      it "merges the params hash argument with the application_id from the specified region" do
+        arguments = {a: 'hi', b: 'test', c: 3, region: 'na'}
+        WotApi::Base.config(na: 'abc123')
+        expect(WotApi::Base.merged_params(arguments)).to eq({a: 'hi', b: 'test', c: 3}.merge(application_id: 'abc123'))
+      end
+    end
+
+    context "with no region parameter" do
+      it "merges the params hash argument with the application_id from the default first region" do
+        arguments = {a: 'hi', b: 'test', c: 3}
+        WotApi::Base.config(na: 'abc123')
+        expect(WotApi::Base.merged_params(arguments)).to eq arguments.merge(application_id: 'abc123')
+      end
+    end
+
+    it "sets base_uri" do
+      WotApi::Base.config(na: 'abc123')
+      WotApi::Base.merged_params({})
+      expect(WotApi::Base.base_uri).to eq WotApi::Base::REGIONS[:na]
+
+      WotApi::Base.config(ru: 'abc123')
+      WotApi::Base.merged_params({})
+      expect(WotApi::Base.base_uri).to eq WotApi::Base::REGIONS[:ru]
     end
   end
 
@@ -60,25 +102,49 @@ describe WotApi::Base do
     WotApi::Base::ENDPOINTS.each do |endpoint|
       method_name = WotApi::Base.pathname(endpoint)
       describe ".#{method_name}" do
+        before(:example) do
+          WotApi::Base.config({na: '123456'})
+        end
+
         it "creates a method named #{method_name}" do
           expect(WotApi::Base.respond_to?(method_name.to_sym)).to eq true
         end
 
         it "posts to the endpoint #{endpoint}" do
-          expect(WotApi::Base).to receive(:post).exactly(1).times
+          expect(WotApi::Base).to receive(:post).and_return({'data' => true})
           WotApi::Base.send(method_name.to_sym)
         end
 
         it "accepts a hash of arguments to post to the endpoint and merges them with the application_id" do
           arguments = {a: 'hi', b: 'test', c: 3}
-          WotApi::Base.application_id = '123456'
-          expect(WotApi::Base).to receive(:post).with(endpoint, body: arguments.merge(application_id: WotApi::Base.application_id)).exactly(1).times
+          expect(WotApi::Base).to receive(:post).with(endpoint, body: arguments.merge(application_id: '123456')).and_return({'data' => true})
           WotApi::Base.send(method_name.to_sym, arguments)
         end
 
-        it "receives a response from api with data in an Array or Hash" do
-          FakeWeb.register_uri(:post, "#{WotApi::Base.base_uri}#{endpoint}", :response => File.join(File.dirname(__FILE__), 'fixtures', "#{method_name}.json"))
-          expect(WotApi::Base.send(method_name.to_sym)).to be_a_kind_of(Array).or be_a_kind_of(Hash)
+        context "with a valid response" do
+          it "receives a response from api with data in an Array or Hash" do
+            FakeWeb.register_uri(:post, "#{WotApi::Base.base_uri}#{endpoint}", :response => File.join(File.dirname(__FILE__), 'fixtures', "#{method_name}.json"))
+            expect(WotApi::Base.send(method_name.to_sym)).to be_a_kind_of(Array).or be_a_kind_of(Hash)
+          end
+        end
+
+        context "with an invalid response" do
+          it "raises an exception" do
+            FakeWeb.register_uri(:post, "#{WotApi::Base.base_uri}#{endpoint}", :response => File.join(File.dirname(__FILE__), 'fixtures', "error.json"))
+            expect{WotApi::Base.send(method_name.to_sym)}.to raise_error
+          end
+
+          it "includes the error message from WoT in the exception" do
+            FakeWeb.register_uri(:post, "#{WotApi::Base.base_uri}#{endpoint}", :response => File.join(File.dirname(__FILE__), 'fixtures', "error.json"))
+            expect{WotApi::Base.send(method_name.to_sym)}.to raise_error('APPLICATION_ID_NOT_SPECIFIED')
+          end
+        end
+
+        context "with httparty exception" do
+          it "reraises the httparty exception" do
+            allow(WotApi::Base).to receive(:post).and_raise(HTTParty::Error)
+            expect{WotApi::Base.send(method_name.to_sym)}.to raise_error(HTTParty::Error)
+          end
         end
       end
     end

data/spec/fixtures/error.json

@@ -0,0 +1,10 @@
+HTTP/1.1 200 OK
+Server: nginx
+Date: Tue, 05 Aug 2014 21:48:28 GMT
+Content-Type: application/json
+Transfer-Encoding: chunked
+Connection: keep-alive
+Vary: Accept-Encoding
+Access-Control-Allow-Origin: *
+
+{"status":"error","error":{"field":"application_id","message":"APPLICATION_ID_NOT_SPECIFIED","code":402,"value":null}}

data/wot_api.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "httparty", "~> 0.13"
 
-  spec.requirements << "Application ID from Wargaming developers portal."
+  spec.requirements << "Application ID(s) from Wargaming developers portal."
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wot_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jesse Cantara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,13 +103,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/wot_api.rb
 - lib/wot_api/base.rb
-- lib/wot_api/player.rb
+- lib/wot_api/exceptions.rb
 - lib/wot_api/version.rb
 - spec/base_spec.rb
 - spec/fixtures/account_achievements.json
@@ -132,6 +133,7 @@ files:
 - spec/fixtures/encyclopedia_tanks.json
 - spec/fixtures/encyclopedia_tankturrets.json
 - spec/fixtures/endpoints.yml
+- spec/fixtures/error.json
 - spec/fixtures/globalwar_clans.json
 - spec/fixtures/globalwar_famepoints.json
 - spec/fixtures/globalwar_maps.json
@@ -145,7 +147,6 @@ files:
 - spec/fixtures/ratings_types.json
 - spec/fixtures/tanks_achievements.json
 - spec/fixtures/tanks_stats.json
-- spec/player_spec.rb
 - spec/spec_helper.rb
 - wot_api.gemspec
 homepage: https://github.com/jcantara/wot_api
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- Application ID from Wargaming developers portal.
+- Application ID(s) from Wargaming developers portal.
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
@@ -195,6 +196,7 @@ test_files:
 - spec/fixtures/encyclopedia_tanks.json
 - spec/fixtures/encyclopedia_tankturrets.json
 - spec/fixtures/endpoints.yml
+- spec/fixtures/error.json
 - spec/fixtures/globalwar_clans.json
 - spec/fixtures/globalwar_famepoints.json
 - spec/fixtures/globalwar_maps.json
@@ -208,5 +210,4 @@ test_files:
 - spec/fixtures/ratings_types.json
 - spec/fixtures/tanks_achievements.json
 - spec/fixtures/tanks_stats.json
-- spec/player_spec.rb
 - spec/spec_helper.rb

data/lib/wot_api/player.rb

@@ -1,28 +0,0 @@
-module WotApi
-
-  class Player < Base
-    attr_reader :nickname, :account_id
-
-    def initialize(params={})
-      ArgumentError.new("application_id is required") unless self.class.default_params[:application_id]
-      @nickname = params['nickname']
-      @account_id = params['account_id']
-    end
-
-    class << self
-
-      def find_all_by_name_like(query)
-        result = self.post('/wot/account/list/', body: {search: query})
-        data = result['data']
-        if data
-          data.map{|d| self.new(d)}
-        else
-          []
-        end
-      end
-
-    end
-
-  end
-
-end

data/spec/player_spec.rb

@@ -1,32 +0,0 @@
-require 'spec_helper'
-
-describe WotApi::Player do
-  context "with a presumably valid application_id" do
-    before(:all) { WotApi::Base.application_id = '12345'; puts WotApi::Base.application_id }
-
-    it "inherits application_id from base" do
-      puts WotApi::Base.application_id
-      expect(WotApi::Player.default_params[:application_id]).to eq '12345'
-    end
-  end
-
-  context "with no application_id" do
-    before(:all) { WotApi::Base.application_id = nil; puts WotApi::Base.application_id }
-
-    it "throws an exception when attempting to initialize an instance" do
-      puts WotApi::Base.application_id
-      expect{ WotApi::Player.new }.to raise_error
-    end
-
-    it "has a nil application_id" do
-      expect(WotApi::Player.default_params[:application_id]).to be_nil
-    end
-  end
-
-  it "gets latest application_id from Base when it becomes updated" do
-    WotApi::Base.application_id = 'aaaaa'
-    expect(WotApi::Player.default_params[:application_id]).to eq 'aaaaa'
-    WotApi::Base.application_id = '54321'
-    expect(WotApi::Player.default_params[:application_id]).to eq '54321'
-  end
-end