ugcleague 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2186fb5e3d34ef40101b0855c86da380c7ee4ce
+  data.tar.gz: 6e831cf17c5e237b88bdd133028a7cd3f7ccb29d
+SHA512:
+  metadata.gz: e2e6407178c24277aae13d11f9b2f6bb0b9098e80a8a8138d594a62c91aa3e0f91545defa771266a1519099a7365e01b4adc12864b64ee5e51788ff3b1779bf7
+  data.tar.gz: e11d3a0db720174c2cd65b921ffdae69561c239fe2c511571801179c6dadb1aaf74dc03478968047765da8df746b390c3a76d440ce26fe8e9129e40e22472cfd

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# UGC League
+
+UGCLeague is a Ruby client for the UGC League API.
+
+## Installation
+
+Install it from RubyGems:
+
+```
+gem install ugcleague
+```
+
+Or add it to a Gemfile:
+
+```
+gem 'ugcleague'
+```
+
+## Usage
+
+Configuration:
+
+```
+require 'ugcleague'
+
+UGC.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.
+end
+```
+
+Examples:
+
+```
+# Set the API key.
+UGC.api_key = "API Key"
+
+# Set the user agent.
+UGC.user_agent = "User agent"
+
+# Get a player's team history.
+UGC.player_history(76561198063808035)
+
+# Get a player's current team.
+UGC.player_current(76561198063808035)
+```
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ugcleague/api.rb

@@ -0,0 +1,14 @@
+module UGC
+    class API < Request
+
+        attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+        def initialize(options={})
+            options = UGC.options.merge(options)
+            (Configuration::VALID_OPTIONS_KEYS).each do |key|
+                send("#{key}=", options[key]) if options[key]
+            end
+        end
+
+    end
+end

data/lib/ugcleague/client/players.rb

@@ -0,0 +1,13 @@
+class UGC::Client
+    module Players
+
+        def player_history(steamid)
+            get({:player => steamid})
+        end
+
+        def player_current(steamid)
+            get({:active => steamid})
+        end
+
+    end
+end

data/lib/ugcleague/client.rb

@@ -0,0 +1,9 @@
+module UGC
+    class Client < API
+
+        Dir[File.expand_path('../client/*.rb', __FILE__)].each {|f| require f}
+
+        include Players
+
+    end
+end

data/lib/ugcleague/configuration.rb

@@ -0,0 +1,30 @@
+module UGC
+    module Configuration
+
+        VALID_OPTIONS_KEYS = [:api_key, :user_agent].freeze
+
+        DEFAULT_USER_AGENT = "UGC League Ruby Gem #{UGC::VERSION}".freeze
+
+        attr_accessor(*VALID_OPTIONS_KEYS)
+
+        def self.extended(base)
+            base.reset
+        end
+
+        def configure
+            yield self
+        end
+
+        def options
+            VALID_OPTIONS_KEYS.inject({}) do |option, key|
+                option.merge!(key => send(key))
+            end
+        end
+
+        def reset
+            self.api_key = ENV['UGC_LEAGUE_API_KEY']
+            self.user_agent = DEFAULT_USER_AGENT
+        end
+
+    end
+end

data/lib/ugcleague/error.rb

@@ -0,0 +1,11 @@
+module UGC
+    module Error
+
+        class Error < StandardError; end
+
+        class Parsing < Error; end
+
+        class Unauthorized < Error; end
+
+    end
+end

data/lib/ugcleague/request.rb

@@ -0,0 +1,51 @@
+require 'httparty'
+require 'json'
+require 'rack'
+
+module UGC
+    class Request
+        
+        include HTTParty
+        format :json
+        headers 'Accept' => 'application/json'
+        parser Proc.new { |body, _| parse(body) }
+
+        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
+                raise Error::Parsing.new "The response is not valid JSON"
+            end
+        end
+
+        def get(options={})
+            options[:key] = @api_key unless !@api_key
+            query_string = Rack::Utils.build_query(options)
+            validate self.class.get("http://www.ugcleague.com/api/api.php?#{query_string}")
+        end
+
+        private
+
+        def validate(response)
+            case response.body
+                when "Access denied."; raise Error::Unauthorized.new error_message(response)
+            end
+
+            response.parsed_response
+        end
+
+        def error_message(response)
+            parsed_response = response.parsed_response
+
+            "Server responded with code #{response.code}. " \
+            "Request URI: #{response.request.base_uri}#{response.request.path}"
+        end
+
+    end
+end

data/lib/ugcleague/version.rb

@@ -0,0 +1,3 @@
+module UGC
+    VERSION = "1.0.0"
+end

data/lib/ugcleague.rb

@@ -0,0 +1,24 @@
+require 'ugcleague/version'
+require 'ugcleague/configuration'
+require 'ugcleague/error'
+require 'ugcleague/request'
+require 'ugcleague/api'
+require 'ugcleague/client'
+
+module UGC
+    extend Configuration
+
+    def self.client(options={})
+        UGC::Client.new(options)
+    end
+
+    def self.method_missing(method, *args, &block)
+        return super unless client.respond_to?(method)
+        client.send(method, *args, &block)
+    end
+
+    def self.respond_to?(method)
+        return client.respond_to?(method) || super
+    end
+
+end

data/ugcleague_api.gemspec

@@ -0,0 +1,18 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ugcleague/version'
+
+Gem::Specification.new do |gem|
+    gem.name            = "ugcleague"
+    gem.version         = UGC::VERSION
+    gem.authors         = ["Ranndom"]
+    gem.email           = ["Ranndom@rnndm.xyz"]
+    gem.description     = %q{Ruby client for UGC League API}
+    gem.summary         = %q{Ruby client for UGC League API}
+    gem.homepage        = "https://github.com/Ranndom/UGCLeague"
+
+    gem.files           = `git ls-files`.split($/)
+    gem.require_paths   = ["lib"]
+
+    gem.add_runtime_dependency 'httparty'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: ugcleague
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ranndom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+description: Ruby client for UGC League API
+email:
+- Ranndom@rnndm.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/ugcleague.rb
+- lib/ugcleague/api.rb
+- lib/ugcleague/client.rb
+- lib/ugcleague/client/players.rb
+- lib/ugcleague/configuration.rb
+- lib/ugcleague/error.rb
+- lib/ugcleague/request.rb
+- lib/ugcleague/version.rb
+- ugcleague_api.gemspec
+homepage: https://github.com/Ranndom/UGCLeague
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for UGC League API
+test_files: []