consumerable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9d5f8170c3d34ec7da8bf6f91ab1cc6bcf4d640
+  data.tar.gz: f233298e249dec73caab12f519e432c37fe39ad8
+SHA512:
+  metadata.gz: 39782f49579e362ec5b921723367c63f00099dfbddda482421b7ca86d2c8bb3b9a7b47d5ec34e004936f23cb719e9856a6b7a4d5961c5cf0227f7de50d2c308b
+  data.tar.gz: 81d6a03e63e7337722d3ac282299a30a1f8246b18a30f92e9c66f0d70ae935d4c36e50f597ffb315747a61e0da8287009e8039d7a67879051ca6487ddb41cb31

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Beedle
+
+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,70 @@
+# Consumerable
+
+Quickly write API object mapper libraries without having to re-invent the wheel
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'consumerable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install consumerable
+
+## Usage
+
+First configure consumerable for the REST API that you would like to consume
+```ruby
+Consumerable.configure do |config|
+  config.endpoint               = 'https://api.heroku.com'
+  config.content_type           = :json
+  config.accept_header          = 'application/vnd.heroku+json; version=3'
+  config.basic_auth_username    = ENV['HEROKU_USERNAME']
+  config.basic_auth_password    = ENV['HEROKU_PASSWORD']
+  config.logger                 = my_logger
+end
+```
+
+Then in your gem/application create the classes to match the API
+```ruby
+class HerokuPlatform::App
+  include Consumerable
+
+  attribute :name,  String
+
+  consumerable path: '/apps'
+
+  has_many :collaborators, class_name: 'HerokuPlatform::Collaborators',
+    source: :app
+end
+
+class HerokuPlatform::Collaborator
+  include Consumerable
+
+  attribute :email, String
+
+  consumerable path: "/apps/:app_id/collaborators"
+
+  belongs_to :app, class_name: 'HerokuPlatform::App'
+end
+```
+
+Profit
+
+```ruby
+app = HerokuPlatform::App.create!(name: 'some app')
+app.collaborators.create(email: 'mattbeedle@gmail.com')
+```
+
+## Contributing
+
+1. Fork it
+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/consumerable.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'consumerable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'consumerable'
+  spec.version       = Consumerable::VERSION
+  spec.authors       = ['Matt Beedle']
+  spec.email         = ['mattbeedle@googlemail.com']
+  spec.description   = %q{Quickly write API object mappers without having to re-invent the wheel}
+  spec.summary       = %q{Quickly write API object mappers without having to re-invent the wheel}
+  spec.homepage      = 'http://www.github.com/mattbeedle/consumerable'
+  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.add_runtime_dependency 'activemodel'
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'typhoeus'
+  spec.add_runtime_dependency 'virtus'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/consumerable.rb

@@ -0,0 +1,30 @@
+require 'consumerable/version'
+
+module Consumerable
+  extend ActiveSupport::Autoload
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration = Consumerable::Configuration.new
+    yield self.configuration
+    self.configuration
+  end
+
+  eager_autoload do
+    autoload :Associations
+    autoload :Configuration
+    autoload :Connection
+    autoload :Creatable
+    autoload :Deletable
+    autoload :Listable
+    autoload :Model
+  end
+
+  def self.eager_autoload!
+    super
+    Consumerable::Associations.eager_load!
+  end
+end

data/lib/consumerable/associations.rb

@@ -0,0 +1,15 @@
+module Consumerable
+  module Associations
+    extend ActiveSupport::Autoload
+    extend ActiveSupport::Concern
+
+    autoload :BelongsTo
+    autoload :HasMany
+    autoload :HasManyProxy
+
+    included do
+      include Consumerable::Associations::BelongsTo
+      include Consumerable::Associations::HasMany
+    end
+  end
+end

data/lib/consumerable/associations/belongs_to.rb

@@ -0,0 +1,42 @@
+module Consumerable
+  module Associations
+    module BelongsTo
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def belongs_to(association_name, options = {})
+          foreign_key = options[:foreign_key] || :"#{association_name}_id"
+
+          class_eval do
+            attribute foreign_key, String
+          end
+
+          (class << self; self; end).instance_eval do
+            define_method "_for_#{association_name}" do |id|
+              init_collection Consumerable::Connection.
+                get(list_path.gsub(/:#{association_name}/, id))
+            end
+          end
+
+          define_method association_name do
+            instance_variable_get(:"@#{association_name}") ||
+              if self.send(foreign_key)
+                options[:class_name].constantize.
+                  find(self.send(foreign_key)).tap do |parent|
+                    self.send("#{association_name}=", object)
+                  end
+              else
+                nil
+              end
+          end
+
+          define_method "#{association_name}=" do |associated_object|
+            instance_variable_set(:"@#{association_name}", associated_object)
+            id = associated_object ? associated_object.id : nil
+            self.send "#{foreign_key}=", id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/consumerable/associations/has_many.rb

@@ -0,0 +1,40 @@
+module Consumerable
+  module Associations
+    module HasMany
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def has_many(association_name, options = {})
+          define_method association_name do
+            instance_variable_get(:"@#{association_name}") ||
+              Consumerable::Associations::HasManyProxy.new(
+                self,
+                options[:class_name].constantize,
+                options[:class_name].constantize.
+                  send("_for_#{self.class.to_s.demodulize.downcase}", self.id),
+                options[:source]
+              ).tap do |proxy|
+                instance_variable_set :"@#{association_name}", proxy
+              end
+            instance_variable_get :"@#{association_name}"
+          end
+
+          define_method "#{association_name}=" do |associated_objects|
+            if associated_objects.is_a?(Hash)
+              associated_objects = Array(
+                options[:class_name].constanize.new(
+                  associated_objects[options[:class_name].demodulize.downcase]
+                )
+              )
+            end
+            instance_variable_set :"@#{association_name}",
+              Consumerable::Associations::HasManyProxy.new(
+                self, options[:class_name].constantize,
+                associated_objects, options[:source]
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/consumerable/associations/has_many_proxy.rb

@@ -0,0 +1,35 @@
+module Consumerable
+  module Associations
+    class HasManyProxy < BasicObject
+
+      attr_reader :parent, :target_klass, :target, :source
+
+      def initialize(parent, target_klass, target, source)
+        @parent         = parent
+        @target_klass   = target_klass
+        @target         = target
+        @source         = source
+      end
+
+      def method_missing(name, *args, &block)
+        target.send(name, *args, &block)
+      end
+
+      def create(attributes = {})
+        build(attributes).save
+      end
+
+      def build(attributes)
+        target_klass.new(attributes).tap do |item|
+          item.send("#{source}=", parent)
+          target << item
+        end
+      end
+
+      def tap
+        yield self
+        self
+      end
+    end
+  end
+end

data/lib/consumerable/configuration.rb

@@ -0,0 +1,10 @@
+module Consumerable
+  class Configuration
+    attr_accessor :logger, :endpoint, :api_version, :content_type,
+      :accept_header, :basic_auth_username, :basic_auth_password
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end

data/lib/consumerable/connection.rb

@@ -0,0 +1,48 @@
+require 'typhoeus/adapters/faraday'
+
+module Consumerable
+  class Connection
+
+    def self.get(path, options = {})
+      connection.get(path, options).body
+    end
+
+    def self.post(path, options = {})
+      Consumerable.configuration.logger.info(
+        "POSTing #{options} to #{path}"
+      )
+      connection.post(path, options).body
+    end
+
+    def self.patch(path, options = {})
+      connection.patch(path, options).success?
+    end
+
+    def self.delete(path, options = {})
+      connection.delete(path, options).success?
+    end
+
+    def self.connection
+      Faraday::Connection.new(
+        url: Consumerable.configuration.endpoint,
+        headers: {
+          accept: Consumerable.configuration.accept_header,
+          content_type: Consumerable.configuration.content_type
+        }
+      ) do |builder|
+        builder.request   Consumerable.configuration.content_type
+        builder.response  Consumerable.configuration.content_type
+        builder.response  :raise_error
+        builder.use       Faraday::Response::Mashify
+        builder.adapter   :typhoeus
+      end.tap do |connection|
+        if Consumerable.configuration.basic_auth_username
+          connection.basic_auth(
+            Consumerable.configuration.basic_auth_username,
+            Consumerable.configuration.basic_auth_password
+          )
+        end
+      end
+    end
+  end
+end

data/lib/consumerable/creatable.rb

@@ -0,0 +1,40 @@
+module Consumerable
+  module Creatable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def create(attributes = {})
+        new(attributes).tap(&:save)
+      end
+
+      def create!(attributes = {})
+        new(attributes).tap(&:save!)
+      end
+    end
+
+    def save
+      if valid?
+        create_record
+      else
+        false
+      end
+    end
+
+    def save!
+      if valid?
+        create_record
+      else
+        raise Consumerable::Errors::RecordInvalid.new(self)
+      end
+    end
+
+    private
+
+    def create_record
+      self.attributes =
+        Consumerable::Connection.post(
+          _inject_path_params(create_path), attributes_for_api.except(:id)
+        )
+    end
+  end
+end

data/lib/consumerable/deletable.rb

@@ -0,0 +1,11 @@
+module Consumerable
+  module Deletable
+    extend ActiveSupport::Concern
+
+    def destroy
+      self.id = nil if Consumerable::Connection.
+        delete(_inject_path_params(delete_path))
+      self
+    end
+  end
+end

data/lib/consumerable/errors.rb

@@ -0,0 +1,12 @@
+module Consumerable
+  module Errors
+    extend ActiveSupport::Autoload
+    extend ActiveSupport::Concern
+
+    autoload :RecordInvalid
+
+    included do
+      include Consumerable::Errors::RecordInvalid
+    end
+  end
+end

data/lib/consumerable/errors/record_invalid.rb

@@ -0,0 +1,12 @@
+module Consumerable
+  module Errors
+    class RecordInvalid < StandardError
+      attr_reader :object
+
+      def initialize(object)
+        @object = object
+        super(object)
+      end
+    end
+  end
+end

data/lib/consumerable/listable.rb

@@ -0,0 +1,11 @@
+module Consumerable
+  module Listable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def all
+        init_collection Consumerable::Connection.get(list_path)
+      end
+    end
+  end
+end

data/lib/consumerable/model.rb

@@ -0,0 +1,42 @@
+module Consumerable
+  module Model
+    extend ActiveSupport::Concern
+    include ActiveModel::Validations
+    include Consumerable::Associations
+    include Consumerable::Creatable
+    include Consumerable::Deletable
+    include Consumerable::Listable
+    include Virtus
+
+    module ClassMethods
+      def consumerable(options = {})
+        define_method :create_path do
+          options[:path] || "/#{self.class.to_s.demodulize.downcase.pluralize}"
+        end
+
+        define_method :delete_path do
+          "/#{self.class.to_s.demodulize.downcase.pluralize}/:id"
+        end
+
+        define_method :attributes_for_api do
+          self.attributes
+        end
+
+        define_method :_inject_path_params do |path|
+          path.scan(/:[^\/]*id/).each do |attribute|
+            path.gsub!(/#{attribute}/, self.send(attribute.gsub(/^:/, '')))
+          end
+          path
+        end
+
+        define_singleton_method :list_path do
+          options[:path] || "/#{to_s.demodulize.downcase.pluralize}"
+        end
+
+        define_singleton_method :init_collection do |collection|
+          collection.map { |item| new(item) }
+        end
+      end
+    end
+  end
+end

data/lib/consumerable/version.rb

@@ -0,0 +1,3 @@
+module Consumerable
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: consumerable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Beedle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: activesupport
+  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: faraday
+  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: typhoeus
+  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: virtus
+  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: bundler
+  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: 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'
+description: Quickly write API object mappers without having to re-invent the wheel
+email:
+- mattbeedle@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- consumerable.gemspec
+- lib/consumerable.rb
+- lib/consumerable/associations.rb
+- lib/consumerable/associations/belongs_to.rb
+- lib/consumerable/associations/has_many.rb
+- lib/consumerable/associations/has_many_proxy.rb
+- lib/consumerable/configuration.rb
+- lib/consumerable/connection.rb
+- lib/consumerable/creatable.rb
+- lib/consumerable/deletable.rb
+- lib/consumerable/errors.rb
+- lib/consumerable/errors/record_invalid.rb
+- lib/consumerable/listable.rb
+- lib/consumerable/model.rb
+- lib/consumerable/version.rb
+homepage: http://www.github.com/mattbeedle/consumerable
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Quickly write API object mappers without having to re-invent the wheel
+test_files: []
+has_rdoc: