arke 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2b484cebed2989532174c0001b0016ac4fe3e31
+  data.tar.gz: 94cc8cd064543d16f67a99ea951bd57179418bcf
+SHA512:
+  metadata.gz: f43786d9a78de90132bf3b8c710da9281df73d726713fbd4e5cd570633c7ef051660464aba64722c521e45a67a61189ab90550a55f339f84cad1fc5a7f283706
+  data.tar.gz: 4f5e32f17f5e0bc727a0506d155a26f4a871e477a40c79d126ba5614d4d0014140f89d11ec14c6f5aeef37554a5dd6dcaa0377c61adfdd32d4dbac7feda880e7

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jarod
+
+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 @@
+# Arke
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'arke'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arke
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/arke/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/arke.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arke/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'arke'
+  spec.version       = Arke::VERSION
+  spec.authors       = ['Jarod Reid']
+  spec.email         = ['jreid@voyst.com']
+  spec.summary       = %q{Arke is a service oriented api client, providing similar functionality to that of Active Resource}
+  spec.description   = %q{Arke is a service oriented api client, providing similar functionality to that of Active Resource}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'httparty'
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'addressable'
+  spec.add_dependency 'activesupport'
+
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry-debugger'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'rspec'
+  
+end

data/lib/arke.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'httparty'
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/string/conversions'
+
+
+
+require 'arke/version'
+require 'arke/errors'
+require 'arke/resource'
+require 'arke/mime_types'

data/lib/arke/errors.rb

@@ -0,0 +1,29 @@
+module Arke
+  module Errors
+
+    class InvalidHandler < StandardError; end
+
+    class DeserializationError < StandardError
+
+      def initialize(error)
+        message = "There was an error deserializing the response, failed with error: #{error.class} - #{error.message}"
+        super message
+      end
+
+    end
+
+    class MissingType < StandardError; end
+
+    class ConnectionRefused < StandardError
+
+      def initialize(host)
+        message = "There was an error connecting to the resource at #{host}"
+        super message
+      end
+
+    end
+
+    class MissingHandlerBlock < StandardError; end
+
+  end
+end

data/lib/arke/mime_types.rb

@@ -0,0 +1,6 @@
+module Arke
+  MIME_TYPES = {
+    'json' => 'application/json',
+    'xml'  => 'application/xml'
+  }
+end

data/lib/arke/resource.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+require 'active_model'
+require 'addressable/uri'
+require 'addressable/template'
+
+require 'arke/resource/errors'
+require 'arke/resource/fields'
+require 'arke/resource/collection'
+require 'arke/resource/model'
+require 'arke/resource/associations'

data/lib/arke/resource/associations.rb

@@ -0,0 +1,2 @@
+require_relative './associations/base'
+require_relative './associations/has_many_association'

data/lib/arke/resource/associations/base.rb

@@ -0,0 +1,27 @@
+module Arke
+  module Resource
+    module Associations
+      class Base
+
+        attr_reader :name, :options
+
+        def initialize(parent, name, options={})
+          @parent  = parent
+          @name    = name
+          @options = options
+        end
+
+        def target
+          klass.constantize
+        end
+
+        private
+
+        def klass
+          "#{@parent.class.name.split('::')[0..-2].join('::')}::#{name.to_s.classify}"
+        end
+
+      end
+    end
+  end
+end

data/lib/arke/resource/associations/has_many_association.rb

@@ -0,0 +1,27 @@
+module Arke
+  module Resource
+    module Associations
+
+      class HasManyAssociation < Base
+        include Enumerable
+        delegate :find, to: :target
+
+        def all(params={})
+          target.all(params.merge({
+            template: "/#{@parent.class.table_name}/#{@parent.id}/{endpoint}"
+                                           }))
+        end
+
+        def each(&block)
+          self.all.each &block
+        end
+
+        def count(params={})
+          all(params).count
+        end
+
+      end
+
+    end
+  end
+end

data/lib/arke/resource/collection.rb

@@ -0,0 +1,38 @@
+module Arke
+  module Resource
+    class Collection
+      include Enumerable
+
+      def initialize(parent, array)
+        raise Errors::UnexpectedResponse.
+                new("#all expected to receive an Array from the resource, instead a #{array.class} was received.") unless array.is_a? Array
+        @array = array.collect { |item| parent.new(item) }
+      end
+
+      def each(&block)
+        @array.each &block
+      end
+
+      def [](key)
+        @array[key]
+      end
+
+      def first
+        self[0]
+      end
+
+      def last
+        self[-1]
+      end
+
+      def length
+        @array.length
+      end
+
+      def inspect
+        "#<#{self.class.name}:0x%08x record_count: #{self.length}>" % (object_id * 2)
+      end
+
+    end
+  end
+end

data/lib/arke/resource/errors.rb

@@ -0,0 +1,27 @@
+module Arke
+
+  module Resource
+    module Errors
+
+      class UnexpectedResponse < StandardError; end
+
+      class NotFound < StandardError
+
+        def initialize
+          message = "The specificed resource was not found"
+          super message
+        end
+
+      end
+
+      class Exception < StandardError
+
+        def initialize(resource)
+          message "An error on the specificed resource: Status Code #{resource.code}"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/arke/resource/fields.rb

@@ -0,0 +1,40 @@
+module Arke
+  module Resource
+    module Fields
+      extend ActiveSupport::Concern
+
+
+      module ClassMethods
+
+        def field(name, options={})
+          raise Errors::MissingType.new('The field type is required when defining a field.') unless options[:type]
+          define_getter(name.to_s, options[:type])
+          define_setter(name.to_s, options[:type])
+        end
+
+        private
+
+        def define_getter(name, klass)
+          instance_eval do
+            define_method(name) do
+              value = @_attributes[name]
+              value ? klass.new(@_attributes[name]) : klass.new
+            end
+          end 
+        end
+
+        def define_setter(name, klass)
+          instance_eval do
+            define_method("#{name}=") do |value|
+              @_attributes[name] = value
+            end
+          end
+        end
+
+
+      end
+
+
+    end
+  end
+end

data/lib/arke/resource/model.rb

@@ -0,0 +1,199 @@
+module Arke
+  module Resource
+    module Model
+
+      extend ActiveSupport::Concern
+
+      included do |base|
+        base.class_eval do
+          include ActiveModel
+          include ActiveModel::Conversion
+          include ActiveModel::Validations
+          include HTTParty
+
+          extend ActiveModel::Naming
+
+          include Resource::Fields
+
+          class_attribute :_collection, :_url_template, :_deserializer
+
+          cattr_accessor  :associations, :after_initializers
+
+
+          collection    Arke::Resource::Collection
+          url_template  DEFAULT_URL_TEMPLATE
+          deserializer  { |body| JSON.parse(body) }
+
+          handle([200, 201]) { |response| JSON.parse(response.body) }
+
+          handle(404) { raise Errors::NotFound }
+
+          field :id, type: String
+
+
+        end
+      end
+
+      # The default template used for generating resource urls.
+      DEFAULT_URL_TEMPLATE     = '/{endpoint}{/id}{?query*}'
+
+      RESPONSE_HANDLERS        = {}
+
+      module ClassMethods
+
+        def find(id)
+          body = make_request(:get, {}, id: id)
+          new(body)
+        end
+
+        def all(params={})
+          body = make_request(:get, {}, params)
+          self._collection.new(self, body)
+        end
+
+        def has_many(name, options={})
+          self.associations ||= {}
+          self.associations[name] =  Associations::HasManyAssociation
+        end
+
+        def after_initialize(&block)
+          @after_initializers ||= []
+          @after_initializers << block
+        end
+
+        def handle(code, &block)
+          raise Arke::Errors::MissingHandlerBlock unless block_given?
+          case code
+            when String, Integer, Fixnum
+              response_handlers[code.to_i] = block
+              return true
+            when Range, Array
+              code.to_a.each do |c|
+                response_handlers[c.to_i] = block
+              end
+              return true
+            else
+              raise Errors::InvalidHandler.
+                      new("#{code.class.name} is an invalid class, please user an Integer, Fixnum, String, Range or Array")
+          end
+        end
+
+        def response_handlers
+          RESPONSE_HANDLERS
+        end
+
+        def collection(collection)
+          self._collection = collection if collection
+        end
+
+        # Gets or sets the url template for the resource. The url template is a
+        # {https://github.com/sporkmonger/addressable Addressable} template and defaults to {DEFAULT_URL_TEMPLATE}.
+        # If a parameter is passed to this method it will set the url template to the passed parameter, otherwise
+        # it will just return the URL template.
+        #
+        # @param [String] template the url template to set, if left nil, the method will simply return the current
+        # url template
+        #
+        # @return [Addressable::Template] the url template. If none has been set, it references {DEFAULT_URL_TEMPLATE}
+        def url_template(template)
+          self._url_template  = Addressable::Template.new(template)
+        end
+
+        # Gets or sets the resource host.
+        #
+        # @param [String] host the resource host. if left nil, the method will simply return the current resource host
+        #
+        # @return [String] the current resource host
+        def host(host=nil)
+          @host = host if host
+          @host
+        end
+
+        # Gets the resource url. This compiles the url template using the passed options and returns the resulting
+        # string.
+        #
+        # @param [Hash] options the url options to pass to the template. By default the template looks for a an id and a
+        # query.
+        #
+        # @return [String] the full resource url
+        def url(options={})
+          template = options[:template] ? Addressable::Template.new(options.delete(:template)) : nil || _url_template
+          host + template.expand(options.merge(endpoint: endpoint)).to_s
+        end
+
+        # Gets or sets the device endpoint. By default the endpoint uses {#resource_name} if an endpoint has not been
+        # provided.
+        #
+        # @param [String] the service endpoint. if left nil it will simply return the existing endpoint
+        #
+        # @return [String] the service endpoint
+        def endpoint(endpoint=nil)
+          @endpoint = endpoint if endpoint
+          @endpoint ||= resource_name
+        end
+
+        def deserializer(&block)
+          self._deserializer = block if block_given?
+        end
+
+        def deserialize(body)
+          begin
+            self._deserializer.call(body)
+          rescue => e
+            raise Errors::DeserializationError.new(e)
+          end
+        end
+
+        def table_name
+          self.name.split('::')[-1].tableize
+        end
+
+        private
+
+        def resource_name
+          @resource_name ||= self.name.tableize
+        end
+
+        def make_request(method, body={}, params={})
+          begin
+            response = send(method, url(params), body)
+          rescue Errno::ECONNREFUSED
+            raise Errors::ConnectionRefused.new(host)
+          end
+          handle_response(response)
+        end
+
+        def handle_response(response)
+          response_handlers[response.code.to_i].call(response)
+        end
+
+      end
+
+      def initialize(attributes={})
+        @_attributes = attributes
+        self.class.after_initializers.each { |ai| ai.call } if self.class.after_initializers
+      end
+
+      def to_param
+        self.id
+      end
+
+      def persisted?
+        !self.id.nil?
+      end
+
+
+      def inspect
+        id = "id: ''#{self.id}'" if try(:id)
+        "#<#{self.class.name}:0x%08x>" % (object_id * 2)
+      end
+
+      private
+
+      def method_missing(meth, *args)
+        return self.class.associations[meth.to_sym].new(self, meth.to_sym) if self.class.associations && self.class.associations[meth.to_sym]
+        super
+      end
+    end
+  end
+end

data/lib/arke/version.rb

@@ -0,0 +1,3 @@
+module Arke
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: arke
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jarod Reid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 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'
+- !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: addressable
+  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: 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: 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: pry-debugger
+  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: yard
+  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: Arke is a service oriented api client, providing similar functionality
+  to that of Active Resource
+email:
+- jreid@voyst.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arke.gemspec
+- lib/arke.rb
+- lib/arke/errors.rb
+- lib/arke/mime_types.rb
+- lib/arke/resource.rb
+- lib/arke/resource/associations.rb
+- lib/arke/resource/associations/base.rb
+- lib/arke/resource/associations/has_many_association.rb
+- lib/arke/resource/collection.rb
+- lib/arke/resource/errors.rb
+- lib/arke/resource/fields.rb
+- lib/arke/resource/model.rb
+- lib/arke/version.rb
+- spec/resource_spec.rb
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Arke is a service oriented api client, providing similar functionality to
+  that of Active Resource
+test_files:
+- spec/resource_spec.rb
+has_rdoc: