arke 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2b484cebed2989532174c0001b0016ac4fe3e31
-  data.tar.gz: 94cc8cd064543d16f67a99ea951bd57179418bcf
+  metadata.gz: 747bbdfb0c8f1c05d707315be454b3e4d40a4560
+  data.tar.gz: 5c0907b7b22ac017ff67a99d5797b82df7f416ad
 SHA512:
-  metadata.gz: f43786d9a78de90132bf3b8c710da9281df73d726713fbd4e5cd570633c7ef051660464aba64722c521e45a67a61189ab90550a55f339f84cad1fc5a7f283706
-  data.tar.gz: 4f5e32f17f5e0bc727a0506d155a26f4a871e477a40c79d126ba5614d4d0014140f89d11ec14c6f5aeef37554a5dd6dcaa0377c61adfdd32d4dbac7feda880e7
+  metadata.gz: e82f7dc3099d68ec00e9be21c37192f066590a936f8f25886837d7ee8a6b52b191d791b0130a34bf267b160fe9a578a430ffed10ffbcfcb7fcf33d965f33ed2a
+  data.tar.gz: f885c70be045a80cc613ff48ce6ace55a4d395f500feba98997f83dc6c06e0be5ee5d494330a6c7ae24f1d963c51012319b73ee41622cccdc4e096349f6c2bbf

data/.ruby-version

@@ -1 +1 @@
-2.0.0
+2.1.0

data/README.md

@@ -1,29 +1,77 @@
 # Arke
 
-TODO: Write a gem description
+Arke is a RESTful API client library designed specifically for utilizing distributed services in a service oriented
+environment.
 
-## Installation
+## Compatibility
 
-Add this line to your application's Gemfile:
+Arke is developed against MRI 2.1.0 and tested against MRI 1.9.3, 2.0.0, and 2.1.0.
 
-    gem 'arke'
+## Basic Usage
 
-And then execute:
+Arke's model format is similar to that of Mongoid's:
 
-    $ bundle
+```ruby
+class User
+    include Arke::Resource::model
 
-Or install it yourself as:
+    host 'http://localhost:3000'
 
-    $ gem install arke
+    field :email, type: String
 
-## Usage
+end
+```
 
-TODO: Write usage instructions here
+## Advanced Usage
 
-## Contributing
+### Fields
+
+Fields are required to access data returned from the service resource. If a field is not defined it will not be
+accessible from the model. This allows the fields to be serialized as the developer requires, and allows them to
+be fully integrated into Rails ```form_for```. The field type defaults to ```String```.
+
+### Hosts
+
+Arke makes it easy to access multiple different hosts. The ```host``` directive defines the host the request will be
+sent to.
+
+### Endpoints
+
+The endpoint is the location on the host for the specified resource. By default the endpoint is the tablelized name
+of the model. So in the case of a class named ```User``` the endpoint would be ```/users```
+
+Endpoints can be redefined as necessary by passing the ```endpoint``` directive:
+
+```
+class User
+    include Arke::Resource::model
+
+    host     'http://localhost:3000'
+    endpoint 'members'
+
+    field :email, type: String
+
+end
+```
+
+### Deserializers
+
+By default Arke assumes data will be coming back as JSON. You can define a custom deserialization method using the
+```deserializer``` directive:
+
+```ruby
+class User
+    include Arke::Resource::model
+
+    host 'http://localhost:3000'
+
+    deserializer { |response| MessagePack.unpack(response.body) }
+
+    field :email, type: String
+
+end
+```
+
+### URL Templates
+Arke uses Addressable for url templating.
 
-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/lib/arke/resource/associations/base.rb

@@ -18,10 +18,10 @@ module Arke
         private
 
         def klass
-          "#{@parent.class.name.split('::')[0..-2].join('::')}::#{name.to_s.classify}"
+          "#{@parent.class.name.split('::')[0..-2].join('::')}::#{@options[:class_name] || name.to_s.classify}"
         end
 
       end
     end
   end
-end
+end

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

@@ -8,7 +8,7 @@ module Arke
 
         def all(params={})
           target.all(params.merge({
-            template: "/#{@parent.class.table_name}/#{@parent.id}/{endpoint}"
+            template: "/#{@parent.class.table_name}/#{@parent.send(options[:foreign_key] || :id)}/{endpoint}"
                                            }))
         end
 

data/lib/arke/resource/collection.rb

@@ -35,4 +35,4 @@ module Arke
 
     end
   end
-end
+end

data/lib/arke/resource/errors.rb

@@ -3,8 +3,12 @@ module Arke
   module Resource
     module Errors
 
+      class ConnectionRefused < StandardError; end
+
       class UnexpectedResponse < StandardError; end
 
+      class MethodNotAllowed < StandardError; end
+
       class NotFound < StandardError
 
         def initialize
@@ -17,11 +21,13 @@ module Arke
       class Exception < StandardError
 
         def initialize(resource)
-          message "An error on the specificed resource: Status Code #{resource.code}"
+          self.message = "An error on the specificed resource: Status Code #{resource.code}"
         end
 
       end
 
+      class UnprocessableEntity < StandardError; end
+
     end
   end
 end

data/lib/arke/resource/fields.rb

@@ -18,9 +18,10 @@ module Arke
           instance_eval do
             define_method(name) do
               value = @_attributes[name]
+              return value if klass == Boolean
               value ? klass.new(@_attributes[name]) : klass.new
             end
-          end 
+          end
         end
 
         def define_setter(name, klass)
@@ -37,4 +38,4 @@ module Arke
 
     end
   end
-end
+end

data/lib/arke/resource/model.rb

@@ -25,8 +25,10 @@ module Arke
           deserializer  { |body| JSON.parse(body) }
 
           handle([200, 201]) { |response| JSON.parse(response.body) }
-
+          
           handle(404) { raise Errors::NotFound }
+          handle(405) { raise Errors::MethodNotAllowed }
+          handle(422) { raise Errors::UnprocessableEntity }
 
           field :id, type: String
 
@@ -53,7 +55,10 @@ module Arke
 
         def has_many(name, options={})
           self.associations ||= {}
-          self.associations[name] =  Associations::HasManyAssociation
+          self.associations[name] = {
+            association: Associations::HasManyAssociation,
+            options:     options
+          }
         end
 
         def after_initialize(&block)
@@ -179,7 +184,14 @@ module Arke
       end
 
       def persisted?
-        !self.id.nil?
+        !self.id.empty?
+      end
+
+      def save
+        unless self.persisted?
+          return make_request(:post, @_attributes)  && true
+        end
+        false
       end
 
 
@@ -190,10 +202,25 @@ module Arke
 
       private
 
+      def make_request(method, body={}, params={})
+        begin
+          response = self.class.send(method, self.class.url(params.empty? ? body : params), {body: body})
+        rescue Errno::ECONNREFUSED
+          raise Errors::ConnectionRefused.new(host)
+        end
+        handle_response(response)
+      end
+
+      def handle_response(response)
+        self.class.response_handlers[response.code.to_i].call(response, self)
+      end
+
+
       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]
+        return self.class.associations[meth.to_sym][:association].
+          new(self, meth.to_sym, associations[meth.to_sym][:options]) if self.class.associations && self.class.associations[meth.to_sym]
         super
       end
     end
   end
-end
+end

data/lib/arke/version.rb

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

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: arke
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jarod Reid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-05-08 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
@@ -144,8 +144,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
+- ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -174,12 +174,12 @@ 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: []