bn 0.0.1

data/lib/bn/error/base.rb

@@ -0,0 +1,10 @@
+require "bn/helpers/has_attributes"
+
+module BN
+  module Error
+    # The base class for errors.
+    class Base < StandardError
+      include Helpers::HasAttributes
+    end
+  end
+end

data/lib/bn/error/middleware/base.rb

@@ -0,0 +1,11 @@
+require "bn/error/base"
+
+module BN
+  module Error
+    module Middleware
+      # The base class for Middleware errors.
+      class Base < Error::Base
+      end
+    end
+  end
+end

data/lib/bn/error/middleware/invalid_api_request.rb

@@ -0,0 +1,38 @@
+require "bn/error/middleware/base"
+
+module BN
+  module Error
+    module Middleware
+      # Raised when the JSON API response was an error.
+      class InvalidAPIRequest < Base
+        # @method code
+        # Get the code for this API error.
+        #
+        # @return [String]
+
+        # @method code=
+        # Set the code for this API error.
+        #
+        # @param [#to_s] value
+        # @return [String]
+        attribute(:code) { |value| value.to_s }
+
+        # @method reason
+        # Get the reason for this API error.
+        #
+        # @return [String]
+
+        # @method reason=
+        # Set the reason for this API error.
+        #
+        # @param [#to_s] value
+        # @return [String]
+        attribute(:reason) { |value| value.to_s }
+
+        def to_s
+          "Invalid API request: #{@reason}."
+        end
+      end
+    end
+  end
+end

data/lib/bn/error/middleware/invalid_http_response.rb

@@ -0,0 +1,26 @@
+require "bn/error/middleware/base"
+
+module BN
+  module Error
+    module Middleware
+      # Raised when the HTTP response object given is invalid.
+      class InvalidHTTPResponse < Base
+        # @method response
+        # Get the HTTP response.
+        #
+        # @return [#body]
+
+        # @method response=
+        # Set the HTTP response.
+        #
+        # @param [#body] value
+        # @return [#body]
+        attribute(:response)
+
+        def to_s
+          "Invalid HTTP response."
+        end
+      end
+    end
+  end
+end

data/lib/bn/helpers/has_attributes.rb

@@ -0,0 +1,45 @@
+module BN
+  module Helpers
+    # Adds the `update_attributes` method and `attribute` class method.
+    module HasAttributes
+      # The class methods to be mixed in when included.
+      module ClassMethods
+        def attribute(name, options={}, &block)
+          options = options.to_h
+
+          attr_reader(name)
+
+          define_method("#{name}=") do |value|
+            value = instance_exec(value, options, &block) unless block.nil?
+
+            instance_variable_set("@#{name}", value)
+          end
+        end
+      end
+
+      class << self
+        def included(base)
+          base.extend(ClassMethods)
+        end
+      end
+
+      # Initialize this object by optionally updating attributes with a Hash.
+      #
+      # @param [#to_h] attributes Attributes to set after initializing.
+      def initialize(attributes={})
+        update_attributes(attributes)
+      end
+
+      # Update any attributes on this object.
+      #
+      # @param [#to_h] attributes
+      # @return [Hash] The attributes.
+      def update_attributes(attributes={})
+        attributes = attributes.to_h
+        attributes.each { |name, value| send("#{name}=", value) }
+
+        attributes
+      end
+    end
+  end
+end

data/lib/bn/middleware.rb

@@ -0,0 +1,13 @@
+module BN
+  # The API response middleware.
+  module Middleware
+    class << self
+      def execute(data, *middleware)
+        middleware.each_with_object(data) { |middleware, data| middleware.execute(data, options) }
+      end
+    end
+  end
+end
+
+require "bn/middleware/http_response"
+require "bn/middleware/d3"

data/lib/bn/middleware/api_error.rb

@@ -0,0 +1,27 @@
+require "bn/error/middleware/invalid_api_request"
+require "bn/middleware/base"
+
+module BN
+  module Middleware
+    # Checks the JSON API response to see if it is an error.
+    class APIResponse < Base
+      # Execute the middleware.
+      #
+      # @param [#to_h] data
+      # @return [Hash]
+      def execute(data)
+        data = data.to_h
+
+        raise BN::Error::Middleware::InvalidAPIRequest, data if error?(data)
+
+        data
+      end
+
+      protected
+
+      def error?(data)
+        data.keys.sort == [:code, :reason].sort
+      end
+    end
+  end
+end

data/lib/bn/middleware/base.rb

@@ -0,0 +1,21 @@
+module BN
+  module Middleware
+    # The base class for middleware.
+    class Base
+      class << self
+        def execute(data, options={})
+          new(options).execute(data)
+        end
+      end
+
+      def initialize(options={})
+        @options = options.to_h
+      end
+
+      # Execute the middleware.
+      def execute(_value)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/bn/middleware/d3.rb

@@ -0,0 +1,9 @@
+module BN
+  module Middleware
+    # The namespace for Diablo 3 middleware.
+    module D3
+    end
+  end
+end
+
+require "bn/middleware/d3/profile"

data/lib/bn/middleware/d3/profile.rb

@@ -0,0 +1,39 @@
+require "bn/middleware/base"
+require "bn/entity/d3/profile"
+
+module BN
+  module Middleware
+    module D3
+      # Transforms a Hash into an Entity::Profile instance.
+      class Profile < Base
+        # Execute the middleware.
+        #
+        # @return [Entity::Profile]
+        def execute(data)
+          convert_heroes(data)
+          convert_time_played(data)
+
+          Entity::D3::Profile.new(data)
+        end
+
+        protected
+
+        def convert_heroes(data)
+          data[:heroes].each do |hero|
+            hero[:hero_class] = hero.delete(:class).tr("-", "_").downcase.to_sym
+            hero[:gender] = hero[:gender] == 0 ? :male : :female
+          end
+        end
+
+        def convert_time_played(data)
+          data[:time_played].keys.each do |hero_class|
+            value = data[:time_played].delete(hero_class).to_f
+            hero_class = hero_class.tr("-", "_").downcase.to_sym
+
+            hero[hero_class] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bn/middleware/http_response.rb

@@ -0,0 +1,24 @@
+require "json"
+require "httpi"
+require "bn/error/middleware/invalid_http_response"
+require "bn/middleware/base"
+
+module BN
+  module Middleware
+    # Transforms the body of an HTTP request from JSON to Ruby.
+    class HTTPResponse < Base
+      # Execute the middleware.
+      #
+      # @param [#body] response
+      # @return [Hash]
+      def execute(response)
+        raise Error::Middleware::InvalidHTTPResponse, response: response unless response.respond_to?(:body)
+        raise Error::Middleware::InvalidHTTPResponse, response: response unless response.respond_to?(:code) && (200...300).include?(response.code)
+
+        body = response.body.to_s
+
+        ::JSON.parse(body)
+      end
+    end
+  end
+end

data/lib/bn/middleware/key_converter.rb

@@ -0,0 +1,28 @@
+require "bn/middleware/base"
+
+module BN
+  module Middleware
+    # Recursively convert all keys in a Hash from camelCase or dashed-delimited Strings into underscore_delimited Symbols.
+    class KeyConverter < Base
+      # Execute the middleware.
+      #
+      # @param [#to_h] value
+      # @return [Hash]
+      def execute(value)
+        convert_keys(value.to_h)
+      end
+
+      protected
+
+      def convert_keys(data)
+        data.keys.each do |key|
+          value = data.delete(key)
+          value = convert_keys(value) if value.is_a?(Hash)
+          key = key.gsub(/([a-z\d])([A-Z])/, "\1_\2").tr("-", "_").downcase.to_sym
+
+          data[key] = value
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: bn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+description: A Battle.net API adapter and entity mapper.
+email: ryan@rynet.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- bn.gemspec
+- lib/bn.rb
+- lib/bn/api.rb
+- lib/bn/api/base.rb
+- lib/bn/api/d3.rb
+- lib/bn/api/sc2.rb
+- lib/bn/api/wow.rb
+- lib/bn/entity.rb
+- lib/bn/entity/base.rb
+- lib/bn/entity/d3/hero.rb
+- lib/bn/entity/d3/profile.rb
+- lib/bn/error/api/base.rb
+- lib/bn/error/api/invalid_key.rb
+- lib/bn/error/api/invalid_locale.rb
+- lib/bn/error/api/invalid_region.rb
+- lib/bn/error/base.rb
+- lib/bn/error/middleware/base.rb
+- lib/bn/error/middleware/invalid_api_request.rb
+- lib/bn/error/middleware/invalid_http_response.rb
+- lib/bn/helpers/has_attributes.rb
+- lib/bn/middleware.rb
+- lib/bn/middleware/api_error.rb
+- lib/bn/middleware/base.rb
+- lib/bn/middleware/d3.rb
+- lib/bn/middleware/d3/profile.rb
+- lib/bn/middleware/http_response.rb
+- lib/bn/middleware/key_converter.rb
+homepage: http://github.com/RyanScottLewis/
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 4
+summary: A Battle.net API adapter and entity mapper.
+test_files: []