tbg_api_consumer 0.0.6.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b468006c1114a60637f89b0fb60a5d4b878be0b1
+  data.tar.gz: a06016b46f7d0a2379baa2b8e774c04406027a40
+SHA512:
+  metadata.gz: 6e69021539cff89be68c3339fe46fdb88a28a43bc247a01bd2183ccd05cba9569a298ab12e91389976705e83f0cb12fb46f5c25f9605d58e1611201f6c260e2b
+  data.tar.gz: 3c422c0c2add9895a9f988edc7fbc7bf50c5effb7fbccf52cc6d77692a179874e21e6cfd1bec793fd6e622c0ce1a5aea4be70fc31850255a94dbbc8a5b871d74

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.pryrc

@@ -0,0 +1,62 @@
+Pry.config.editor = "vim"
+
+# https://github.com/kyrylo/pry-theme
+# $ gem install pry-theme
+Pry.config.theme = "solarized"
+
+# Custom prompt
+prompt = "ruby-#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+Pry.config.prompt = [
+  proc { |obj, nest_level, _| "#{prompt} (#{obj}):#{nest_level} > " },
+  proc { |obj, nest_level, _| "#{prompt} (#{obj}):#{nest_level} * " }
+]
+
+# Default Command Set, add custom methods here:
+default_command_set = Pry::CommandSet.new do
+  command "pccopy", "Copy argument to the clip-board" do |str|
+     IO.popen('pbcopy', 'w') { |f| f << str.to_s }
+  end
+end
+
+# https://github.com/michaeldv/awesome_print/
+# $ gem install awesome_print
+begin
+  require 'awesome_print'
+  Pry.config.print = proc { |output, value| output.puts value.ai(:indent => 2) }
+rescue LoadError => e
+  warn "[WARN] #{e}"
+  puts "$ gem install awesome_print"
+end
+
+# Use Array.toy to get an array to play with
+class Array
+  def self.toy(n = 10, &block)
+    block_given? ? Array.new(n, &block) : Array.new(n) { |i| i+1 }
+  end
+end
+
+# Use Hash.toy to get an hash to play with
+class Hash
+  def self.toy(n = 10)
+    Hash[Array.toy(n).zip(Array.toy(n){ |c| (96+(c+1)).chr })]
+  end
+end
+
+# Launch Pry with access to the entire Rails stack.
+rails = File.join(Dir.getwd, 'config', 'environment.rb')
+if File.exist?(rails) && ENV['SKIP_RAILS'].nil?
+  require rails
+  case Rails.version.to_i
+  when 2
+    require 'console_app'
+    require 'console_with_helpers'
+  when 3
+    require 'rails/console/app'
+    require 'rails/console/helpers'
+    extend Rails::ConsoleMethods if Rails.version.to_f >= 3.2
+  else
+    warn "[WARN] cannot load Rails console commands"
+  end
+end
+
+Pry.config.commands.import(default_command_set)

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api_consumer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 luxerama
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ApiConsumer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'api_consumer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_consumer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/api_consumer/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`)
+5. Create new Pull Request

data/Rakefile

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

data/api_consumer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_consumer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tbg_api_consumer"
+  spec.version       = ApiConsumer::VERSION
+  spec.authors       = ["luxerama"]
+  spec.email         = ["vincent@siebert.im"]
+  spec.summary       = %q{API module}
+  spec.description   = %q{API module to make the consumtion of standardised API responses easier}
+  spec.homepage      = "https://github.com/thebeansgroup/api_consumer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency "activeresource", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency 'pry-byebug', '~> 1.3'
+  spec.add_development_dependency 'pry-rails', '~> 0.3'
+  spec.add_development_dependency 'pry-stack_explorer', '~> 0.4'
+  spec.add_development_dependency 'awesome_print', '~> 1.2'
+  spec.add_development_dependency "rake", '~> 10.3'
+end

data/lib/api_consumer/attributes/base.rb

@@ -0,0 +1,16 @@
+module ApiConsumer
+  module Attributes
+    class Base
+      STANDARDIZATIONS_KEY = "meta"
+      attr_accessor :attributes
+
+      def initialize(attributes)
+        self.attributes = attributes
+      end
+
+      def standardized?
+        self.attributes.has_key? STANDARDIZATIONS_KEY
+      end
+    end
+  end
+end

data/lib/api_consumer/elements/meta.rb

@@ -0,0 +1,12 @@
+module ApiConsumer
+  module Elements
+    Meta = Struct.new(:code, :error_type, :error_message) do
+
+      def initialize(attributes)
+        raise "Meta required a status code" unless attributes.has_key? 'code'
+        attributes.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+
+    end
+  end
+end

data/lib/api_consumer/elements/order.rb

@@ -0,0 +1,13 @@
+module ApiConsumer
+  module Elements
+    Order = Struct.new :order_by do
+      def initialize(attributes)
+        attributes.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+
+      def to_s
+        self.order_by
+      end
+    end
+  end
+end

data/lib/api_consumer/elements/pagination.rb

@@ -0,0 +1,11 @@
+module ApiConsumer
+  module Elements
+    Pagination = Struct.new(:page, :limit) do
+
+      def initialize(attributes)
+        attributes.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+
+    end
+  end
+end

data/lib/api_consumer/elements/response.rb

@@ -0,0 +1,10 @@
+module ApiConsumer
+  module Elements
+    class Response
+      def add_attribute(attr)
+        self.class.send(:define_method, "#{attr}=".to_sym) { |v| instance_variable_set "@#{attr}", v  }
+        self.class.send(:define_method, attr.to_sym) { instance_variable_get "@#{attr}" }
+      end
+    end
+  end
+end

data/lib/api_consumer/parser.rb

@@ -0,0 +1,13 @@
+module ApiConsumer
+  module Parser
+
+    class << self
+      def parse(data)
+        data.map do |key, item|
+          parser = ParserRegistry.find_parser_for key
+          parser.load item
+        end
+      end
+    end
+  end
+end

data/lib/api_consumer/parser_registry.rb

@@ -0,0 +1,45 @@
+module ApiConsumer
+  class ParserRegistry
+
+    DEFAULT_NAMESPACE = :root
+
+    class_attribute :registered_parsers
+
+    self.registered_parsers = {}
+
+    class << self
+
+      def registered
+        self.registered_parsers
+      end
+
+      # Return whether or not the namespace has a parser in the registry
+      # with the given name
+      def registered?(name, namespace = DEFAULT_NAMESPACE)
+        registered = has_namespace? namespace
+        if registered
+          registered = self.registered_parsers[namespace].has_key? name
+        end
+        registered
+      end
+
+      def has_namespace?(namespace)
+        self.registered_parsers.has_key? namespace
+      end
+
+      def registered_namespaces
+        registered.keys
+      end
+
+      def register(name, parser, namespace = DEFAULT_NAMESPACE)
+        self.registered_parsers[namespace] ||= {}
+        registered[namespace][name] = parser
+      end
+
+      def parser_for(key, namespace = DEFAULT_NAMESPACE)
+        return self.registered_parsers.fetch(namespace).fetch(key) if registered? key, namespace
+        return self.registered_parsers.fetch(DEFAULT_NAMESPACE).fetch(key) if registered? key
+      end
+    end
+  end
+end

data/lib/api_consumer/parsers/base.rb

@@ -0,0 +1,9 @@
+module ApiConsumer
+  module Parsers
+    class Base
+      def self.parse(attributes)
+        raise "Not defined"
+      end
+    end
+  end
+end

data/lib/api_consumer/parsers/collection.rb

@@ -0,0 +1,20 @@
+require 'active_resource'
+
+module ApiConsumer
+  module Parsers
+    class Collection < ::ActiveResource::Collection
+      attr_accessor :response
+
+      def initialize(parsed = {})
+        @elements = parsed.fetch('data')
+        parsed.delete 'data'
+        @response = parsed
+      end
+
+      def collect!
+        @response = ApiConsumer::Processor.process @response, resource_class.to_s
+        super
+      end
+    end
+  end
+end

data/lib/api_consumer/parsers/meta.rb

@@ -0,0 +1,9 @@
+module ApiConsumer
+  module Parsers
+    class Meta < Base
+      def self.parse(parsed = {})
+        ApiConsumer::Elements::Meta.new parsed
+      end
+    end
+  end
+end

data/lib/api_consumer/parsers/order.rb

@@ -0,0 +1,9 @@
+module ApiConsumer
+  module Parsers
+    class Order
+      def self.parse(parsed = {})
+        ApiConsumer::Elements::Order.new parsed
+      end
+    end
+  end
+end

data/lib/api_consumer/parsers/pagination.rb

@@ -0,0 +1,9 @@
+module ApiConsumer
+  module Parsers
+    class Pagination
+      def self.parse(parsed = {})
+        ApiConsumer::Elements::Pagination.new parsed
+      end
+    end
+  end
+end

data/lib/api_consumer/processor.rb

@@ -0,0 +1,17 @@
+module ApiConsumer
+  class Processor
+    class << self
+      def process(data, namespace)
+        response = Elements::Response.new
+        data.each do |key, item|
+          parser = ParserRegistry.parser_for key, namespace
+          unless parser.nil?
+            response.add_attribute key
+            response.send "#{key}=", parser.parse(item)
+          end
+        end
+        response
+      end
+    end
+  end
+end

data/lib/api_consumer/railtie.rb

@@ -0,0 +1,17 @@
+module ApiConsumer
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      #ApiConsumer.setup!
+    end
+
+    initializer "api_consumer.configure_default_parsers" do |app|
+      ApiConsumer.configure do |config|
+        config.build_parser_registry do |reg|
+          reg.register 'meta', Parsers::Meta
+          reg.register 'pagination', Parsers::Pagination
+          reg.register 'order', Parsers::Order
+        end
+      end
+    end
+  end
+end

data/lib/api_consumer/version.rb

@@ -0,0 +1,3 @@
+module ApiConsumer
+  VERSION = "0.0.6.pre"
+end

data/lib/api_consumer.rb

@@ -0,0 +1,60 @@
+require 'api_consumer/version'
+require 'api_consumer/parser_registry'
+require 'api_consumer/processor'
+require 'api_consumer/parsers/base'
+require 'api_consumer/parsers/collection'
+require 'api_consumer/parsers/meta'
+require 'api_consumer/parsers/pagination'
+require 'api_consumer/parsers/order'
+require 'api_consumer/elements/response'
+require 'api_consumer/elements/pagination'
+require 'api_consumer/elements/order'
+require 'api_consumer/elements/meta'
+require 'api_consumer/attributes/base'
+require 'api_consumer/railtie' if defined?(Rails)
+
+module ApiConsumer
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  module Base
+    module Initializer
+      def initialize(attributes, persisted = false)
+        if Attributes::Base.new(attributes).standardized?
+          attributes = attributes.fetch('data')
+        end
+
+        super attributes, persisted
+      end
+    end
+
+    mattr_accessor :parser_registry
+    def self.included(base)
+      base.class_eval do
+        base.collection_parser = Parsers::Collection
+        base.send :prepend, Initializer
+      end
+    end
+
+  end
+
+  class Configuration
+    attr_accessor :parser_registry
+
+    def initialize
+      self.parser_registry = ParserRegistry
+    end
+
+    def build_parser_registry(&block)
+      yield self.parser_registry
+    end
+  end
+
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: tbg_api_consumer
+version: !ruby/object:Gem::Version
+  version: 0.0.6.pre
+platform: ruby
+authors:
+- luxerama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: API module to make the consumtion of standardised API responses easier
+email:
+- vincent@siebert.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".pryrc"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_consumer.gemspec
+- lib/api_consumer.rb
+- lib/api_consumer/attributes/base.rb
+- lib/api_consumer/elements/meta.rb
+- lib/api_consumer/elements/order.rb
+- lib/api_consumer/elements/pagination.rb
+- lib/api_consumer/elements/response.rb
+- lib/api_consumer/parser.rb
+- lib/api_consumer/parser_registry.rb
+- lib/api_consumer/parsers/base.rb
+- lib/api_consumer/parsers/collection.rb
+- lib/api_consumer/parsers/meta.rb
+- lib/api_consumer/parsers/order.rb
+- lib/api_consumer/parsers/pagination.rb
+- lib/api_consumer/processor.rb
+- lib/api_consumer/railtie.rb
+- lib/api_consumer/version.rb
+homepage: https://github.com/thebeansgroup/api_consumer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: API module
+test_files: []
+has_rdoc: