ugcleague 1.1.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a2499d5c929d4992f5ac4e7b87bf138588be980
-  data.tar.gz: 9ec6f975068ab165603c572ff58a36e0405ca786
+  metadata.gz: 74a0eabdbcc574f7f6a25747678807207ae0e93a
+  data.tar.gz: 38df875c17afc93365c2924edc2393feaa9e83dc
 SHA512:
-  metadata.gz: d4924107b3af785468e7564ddbfd49fabab69c3a3f0424267a1d89103eca6896fe2aac08842eedbed419781c4d9fe079d4f2c0b4de25d57f3657e03c5b7c9507
-  data.tar.gz: 84d14239a48a236578036061918501cca8e6f5a530fb354de2a4e9e71029ff203b7913058de93c57e840fbd54bdd7e119683c00e0ccdfc9a68b7ceed50a2d330
+  metadata.gz: f64dd37c9f112dc676e6996f636811a98252a59222d341eccf98537ebceb4252d369a9aecb32f8e1ea5a3d393b20c6de58ccbd8772be8e12f00dd79ae3547507
+  data.tar.gz: 2e0a5f21ccc570b31ab0363bb990b87fb17c23000f4401d8dc841e13c9c6a0ecbfdee7866fc8497b84382435b93290f0aaecb3781e04b509d309479e41e17c11

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -26,6 +26,7 @@ require 'ugcleague'
 UGCLeague.configure do |config|
     config.api_key      = "API Key"     # Obtain from a UGC admin.
     config.user_agent   = "User agent"  # User agent to be sent with the request.
+    config.debug        = false         # Whether to print debug messages.
 end
 ```
 
@@ -38,6 +39,12 @@ UGCLeague.api_key = "API Key"
 # Set the user agent.
 UGCLeague.user_agent = "User agent"
 
+# Set debug.
+UGCLeague.debug = true
+
+# Checks if the player has a profile on UGC.
+UGCLeague.player_has_profile(76561198063808035)
+
 # Get a player's team history.
 UGCLeague.player_history(76561198063808035)
 

data/lib/ugcleague/client/players.rb

@@ -1,4 +1,4 @@
-class UGC::Client
+class UGCLeague::Client
     module Players
 
         def player_has_profile(steamid)

data/lib/ugcleague/configuration.rb

@@ -1,7 +1,7 @@
 module UGCLeague
     module Configuration
 
-        VALID_OPTIONS_KEYS = [:api_key, :user_agent].freeze
+        VALID_OPTIONS_KEYS = [:api_key, :user_agent, :debug].freeze
 
         DEFAULT_USER_AGENT = "UGC League Ruby Gem #{UGCLeague::VERSION}".freeze
 

data/lib/ugcleague/error.rb

@@ -2,9 +2,7 @@ module UGCLeague
     module Error
 
         class Error < StandardError; end
-
         class Parsing < Error; end
-
         class Unauthorized < Error; end
 
     end

data/lib/ugcleague/request.rb

@@ -13,10 +13,6 @@ module UGCLeague
         attr_accessor :api_key
 
         def self.parse(body)
-            case body
-                when "Access denied."; raise Error::Unauthorized.new "Invalid API key"
-            end
-
             begin
                 JSON.load body
             rescue JSON::ParserError
@@ -27,9 +23,23 @@ module UGCLeague
         def get(options={})
             options[:key] = @api_key unless !@api_key
             query_string = Rack::Utils.build_query(options)
+
+            debug_message("GET request for \"http://www.ugcleague.com/api/api.php?#{query_string}\" sent (using useragent \"#{@user_agent}\")")
             validate self.class.get("http://www.ugcleague.com/api/api.php?#{query_string}")
         end
 
+        def validate(response)
+            case response.body
+                when "Access denied."; raise Error::Unauthorized.new "Invalid API key"
+            end
+
+            response.parsed_response
+        end
+
+        def debug_message(message)
+            puts "DEBUG: #{message}" if @debug
+        end
+
         private
 
         def error_message(response)
@@ -41,3 +51,4 @@ module UGCLeague
 
     end
 end
+

data/lib/ugcleague/version.rb

@@ -1,3 +1,3 @@
 module UGCLeague
-    VERSION = "1.1.1"
+    VERSION = "1.2.2"
 end

data/spec/fixtures/player.json

@@ -0,0 +1,25 @@
+{
+    "ugc_page": "http://www.ugcleague.com/players_page.cfm?player_id=76561198063808035",
+    "team": [
+        {
+            "name": "Diruo Division",
+            "tag": "_esportsTM",
+            "format": "9v9",
+            "division": "AUS/NZ Platinum",
+            "status": "DR",
+            "last_updated": "2014-07-21 00:00:57",
+            "joined": "2013-08-20 04:51:12",
+            "active": "true"
+        },
+        {
+            "name": "Take Five!",
+            "tag": "Take Five, !",
+            "format": "4v4",
+            "division": "Silver N.Amer",
+            "status": "I",
+            "last_updated": "2014-08-20 02:57:59",
+            "joined": "2013-12-23 15:12:38",
+            "active": "false"
+        }
+    ]
+}

data/spec/fixtures/player_active.json

@@ -0,0 +1,15 @@
+{
+    "ugc_page": "http://www.ugcleague.com/players_page.cfm?player_id=76561198063808035",
+    "team": [
+        {
+            "name": "Diruo Division",
+            "tag": "_esportsTM",
+            "format": "9v9",
+            "division": "AUS/NZ Platinum",
+            "status": "A",
+            "last_updated": "2014-07-21 00:00:57",
+            "joined": "2013-08-20 04:51:12",
+            "active": "true"
+        }
+    ]
+}

data/spec/fixtures/player_current.json

@@ -0,0 +1,15 @@
+{
+    "ugc_page": "http://www.ugcleague.com/players_page.cfm?player_id=76561198063808035",
+    "team": [
+        {
+            "name": "Diruo Division",
+            "tag": "_esportsTM",
+            "format": "9v9",
+            "division": "AUS/NZ Platinum",
+            "status": "HP",
+            "last_updated": "2014-07-21 00:00:57",
+            "joined": "2013-08-20 04:51:12",
+            "active": "true"
+        }
+    ]
+}

data/spec/fixtures/player_exists.json

@@ -0,0 +1,3 @@
+{
+    "exists": true
+}

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'webmock/rspec'
+
+def load_fixture(fixture)
+    File.new(File.dirname(__FILE__) + "/fixtures/#{fixture}.json")
+end
+
+require File.expand_path("../../lib/ugcleague", __FILE__)
+
+RSpec.configure do |config|
+end
+
+def stub_get(url, fixture)
+    stub_request(:get, "http://www.ugcleague.com#{url}")
+        .with(:headers => {:Accept => 'application/json'})
+        .to_return(:body => load_fixture(fixture))
+end
+
+def a_get(url)
+    a_request(:get, "http://www.ugcleague.com#{url}")
+end

data/spec/ugcleague/client/players_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe UGCLeague::Client do
+
+    describe "#player_has_profile" do
+        before do
+            stub_get("/api/api.php?exists=123", "player_exists")
+            @player = UGCLeague.player_has_profile(123)
+        end
+
+        it "should return the correct resource" do
+            expect(a_get("/api/api.php?exists=123")).to have_been_made
+        end
+
+        it "should return a hash" do
+            expect(@player).to be_a Hash
+        end
+    end
+
+    describe "#player_history" do
+        before do
+            stub_get("/api/api.php?player=123", "player")
+            @player = UGCLeague.player_history(123)
+        end
+
+        it "should return the correct resource" do
+            expect(a_get("/api/api.php?player=123")).to have_been_made
+        end
+
+        it "should return a hash" do
+            expect(@player).to be_a Hash
+        end
+    end
+
+    describe "#player_current" do
+        before do
+            stub_get("/api/api.php?active=123", "player_active")
+            @player = UGCLeague.player_current(123)
+        end
+
+        it "should return the correct resource" do
+            expect(a_get("/api/api.php?active=123")).to have_been_made
+        end
+    end
+
+end

data/spec/ugcleague/request_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe UGCLeague::Request do
+
+    it { should respond_to :get }
+
+    before do
+        @request = UGCLeague::Request.new
+    end
+
+    describe "#parse" do
+        it "should return JSON" do
+            body = "{\"exists\": true}"
+            expect(UGCLeague::Request.parse(body)).to be_a Hash
+            expect { UGCLeague::Request.parse("Not JSON") }.to raise_error(UGCLeague::Error::Parsing)
+        end
+    end
+
+end

data/spec/ugcleague_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe UGCLeague do
+    after { UGCLeague.reset }
+
+    describe "#client" do
+        
+        it "should be a UGCLeague::Client" do
+            expect(UGCLeague.client).to be_a UGCLeague::Client
+        end
+
+        it "should not override other clients" do
+            client_1 = UGCLeague.client(api_key: '001', user_agent: 'Client 1')
+            client_2 = UGCLeague.client(api_key: '002', user_agent: 'Client 2')
+
+            expect(client_1.api_key).to eq('001')
+            expect(client_2.api_key).to eq('002')
+            
+            expect(client_1.user_agent).to eq('Client 1')
+            expect(client_2.user_agent).to eq('Client 2')
+        end
+
+    end
+
+    describe "#api_key=" do
+        it "should set the api key" do
+            UGCLeague.api_key = '123'
+            expect(UGCLeague.api_key).to eq('123')
+        end
+    end
+
+    describe "#user_agent=" do
+        it "should set the user agent" do
+            UGCLeague.user_agent = 'Test'
+            expect(UGCLeague.user_agent).to eq('Test')
+        end
+    end
+
+    describe "#user_agent" do
+        it "should return the default user agent" do
+            expect(UGCLeague.user_agent).to eq(UGCLeague::Configuration::DEFAULT_USER_AGENT)
+        end
+    end
+
+    describe "#debug=" do
+        it "should set the debug option" do
+            UGCLeague.debug = true
+            expect(UGCLeague.debug).to eq(true)
+        end
+    end
+
+    describe "#configure" do
+        UGCLeague::Configuration::VALID_OPTIONS_KEYS.each do |key|
+            it "should set #{key}" do
+                UGCLeague.configure do |config|
+                    config.send("#{key}=", key)
+                    expect(UGCLeague.send(key)).to eq(key)
+                end
+            end
+        end
+    end
+
+end

data/ugcleague_api.gemspec

@@ -12,7 +12,13 @@ Gem::Specification.new do |gem|
     gem.homepage        = "https://github.com/Ranndom/UGCLeague"
 
     gem.files           = `git ls-files`.split($/)
+    gem.test_files      = gem.files.grep(%r{^(test|spec)/})
     gem.require_paths   = ["lib"]
 
     gem.add_runtime_dependency 'httparty'
+    gem.add_runtime_dependency "rack"
+
+    gem.add_development_dependency 'rake'
+    gem.add_development_dependency 'rspec'
+    gem.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ugcleague
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Ranndom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby client for UGC League API
 email:
 - Ranndom@rnndm.xyz
@@ -31,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - Gemfile
 - README.md
 - Rakefile
@@ -42,6 +99,17 @@ files:
 - lib/ugcleague/error.rb
 - lib/ugcleague/request.rb
 - lib/ugcleague/version.rb
+- spec/fixtures/player.json
+- spec/fixtures/player_active.json
+- spec/fixtures/player_current.json
+- spec/fixtures/player_exists.json
+- spec/spec_helper.rb
+- spec/ugcleague/client/players_spec.rb
+- spec/ugcleague/client/teams_spec.rb
+- spec/ugcleague/configuration_spec.rb
+- spec/ugcleague/error_spec.rb
+- spec/ugcleague/request_spec.rb
+- spec/ugcleague_spec.rb
 - ugcleague_api.gemspec
 homepage: https://github.com/Ranndom/UGCLeague
 licenses: []
@@ -66,4 +134,15 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for UGC League API
-test_files: []
+test_files:
+- spec/fixtures/player.json
+- spec/fixtures/player_active.json
+- spec/fixtures/player_current.json
+- spec/fixtures/player_exists.json
+- spec/spec_helper.rb
+- spec/ugcleague/client/players_spec.rb
+- spec/ugcleague/client/teams_spec.rb
+- spec/ugcleague/configuration_spec.rb
+- spec/ugcleague/error_spec.rb
+- spec/ugcleague/request_spec.rb
+- spec/ugcleague_spec.rb