arrest 0.0.18 → 0.0.19

data/.gitignore

@@ -1,5 +1,6 @@
 .bundle
 .project
+.rvmrc
 *.gem
 *.swp
 coverage

data/lib/arrest.rb

@@ -10,6 +10,7 @@ require "arrest/attributes/nested_attribute"
 require "arrest/attributes/polymorphic_attribute"
 require "arrest/attributes/belongs_to_attribute"
 require "arrest/attributes/has_many_attribute"
+require "arrest/attributes/has_many_sub_resource_attribute"
 require "arrest/attributes/converter"
 require "arrest/class_utils.rb"
 require "arrest/string_utils.rb"

data/lib/arrest/abstract_resource.rb

@@ -54,21 +54,24 @@ module Arrest
         method_name = method_name.to_sym
         clazz_name = StringUtils.singular(method_name.to_s)
         foreign_key = clazz_name + "_id"
+        sub_resource = false
         if options
           clazz_name = options[:class_name].to_s unless options[:class_name] == nil
           foreign_key = "#{StringUtils.underscore(clazz_name)}_id"
           foreign_key = options[:foreign_key].to_s unless options[:foreign_key] == nil
+          sub_resource = !!options[:sub_resource]
         end
 
         url_part = method_name.to_s
-        
-        hm_attr = HasManyAttribute.new(ids_field_name, 
-                                       method_name, 
-                                       clazz_name,
-                                       url_part,
-                                       foreign_key)
+
+        hm_attr = create_has_many_attribute(sub_resource,
+                                            ids_field_name,
+                                            method_name,
+                                            clazz_name,
+                                            url_part,
+                                            foreign_key)
         add_attribute(hm_attr)
-        
+
         send :define_method, method_name do
           if @has_many_collections == nil
             @has_many_collections = {}
@@ -81,6 +84,23 @@ module Arrest
         end
       end
 
+      def create_has_many_attribute(sub_resource, ids_field_name, method_name,
+                                    clazz_name, url_part, foreign_key)
+        if sub_resource
+          HasManySubResourceAttribute.new(ids_field_name,
+                                          method_name,
+                                          clazz_name,
+                                          url_part,
+                                          foreign_key)
+        else
+          HasManyAttribute.new(ids_field_name,
+                               method_name,
+                               clazz_name,
+                               url_part,
+                               foreign_key)
+        end
+      end
+
       def children(*args)
         method_name, options = args
         method_name = method_name.to_sym
@@ -110,7 +130,7 @@ module Arrest
       end
 
 
-      def scope name, &block 
+      def scope name, &block
         if @scopes == nil
           @scopes = []
         end
@@ -136,11 +156,21 @@ module Arrest
 
     def save
       if Source.skip_validations || self.valid?
-        verb = new_record? ? :post : :put
-        !!AbstractResource::source.send(verb, self)
-      else
-        false
+        req_type = new_record? ? :post : :put
+
+        success = !!AbstractResource::source.send(req_type, self)
+
+        if success # check for special sub resources
+          self.class.all_fields.find_all{|f| f.is_a?(HasManySubResourceAttribute)}.each do |attr|
+            ids = self.send(attr.name)
+            srifn = attr.sub_resource_field_name
+            result = !!AbstractResource::source.put_sub_resource(self, srifn, ids)
+            return false if !result
+          end
+          return true
+        end
       end
+      false
     end
 
     def new_record?
@@ -155,11 +185,17 @@ module Arrest
     # convenience method printing curl command
     def curl
       hs = ""
-      Arrest::Source.header_decorator.headers.each_pair do |k,v| 
+      Arrest::Source.header_decorator.headers.each_pair do |k,v|
         hs << "-H '#{k}:#{v}'"
       end
 
       "curl #{hs} -v '#{Arrest::Source.source.url}/#{self.resource_location}'"
     end
+
+    def == (comparison_object)
+      other_class_name = comparison_object.class.name if comparison_object
+      other_id = comparison_object.id if comparison_object
+      self.class.name == other_class_name && self.id == other_id
+    end
   end
 end

data/lib/arrest/attributes/has_attributes.rb

@@ -79,8 +79,9 @@ module Arrest
         @fields = []
       end
 
-      def attribute name, clazz
-        add_attribute Attribute.new(name, false, clazz)
+      def attribute name, clazz, attribs = {} 
+        read_only = !!attribs[:read_only]
+        add_attribute Attribute.new(name, read_only, clazz)
       end
 
       def attributes(args)

data/lib/arrest/attributes/has_many_attribute.rb

@@ -1,12 +1,13 @@
 module Arrest
   class HasManyAttribute < Attribute
     attr_reader :method_name, :clazz_name, :url_part, :foreign_key
-    def initialize(ids_field_name, 
+    def initialize(ids_field_name,
                    method_name,
                    clazz_name,
                    url_part,
-                   foreign_key)
-      super(ids_field_name, false, Array)
+                   foreign_key,
+                   read_only = false)
+      super(ids_field_name, read_only, Array)
       @method_name = method_name.to_sym
       @clazz_name = clazz_name.to_sym
       @url_part = url_part.to_sym

data/lib/arrest/attributes/has_many_sub_resource_attribute.rb

@@ -0,0 +1,17 @@
+module Arrest
+  class HasManySubResourceAttribute < HasManyAttribute
+    def initialize(ids_field_name,
+                   method_name,
+                   clazz_name,
+                   url_part,
+                   foreign_key)
+      # the read_only is set to sub_resource to avoid sending post request as ids array
+      # directly instead of sending the ids to the sub_resource
+      super(ids_field_name, method_name, clazz_name, url_part, foreign_key, true)
+    end
+
+    def sub_resource_field_name
+      @name
+    end
+  end
+end

data/lib/arrest/http_source.rb

@@ -13,30 +13,30 @@ module Arrest
       @base
     end
 
-    def add_headers headers
+    def add_headers(headers)
       Arrest::Source.header_decorator.headers.each_pair do |k,v|
         headers[k.to_s] = v.to_s
       end
     end
 
-    def get_one sub, filter={}
+    def get_one(sub, filter={})
       response = self.connection().get do |req|
-        req.url sub, filter
-        add_headers req.headers
+        req.url(sub, filter)
+        add_headers(req.headers)
       end
       rql = RequestLog.new(:get, "#{sub}#{hash_to_query filter}", nil)
       rsl = ResponseLog.new(response.env[:status], response.body)
       Arrest::Source.call_logger.log(rql, rsl)
       if response.env[:status] != 200
-        raise Errors::DocumentNotFoundError 
+        raise Errors::DocumentNotFoundError
       end
       response.body
     end
 
-    def get_many sub, filter={}
+    def get_many(sub, filter={})
       response = self.connection().get do |req|
-        req.url sub, filter
-        add_headers req.headers
+        req.url(sub, filter)
+        add_headers(req.headers)
       end
       rql = RequestLog.new(:get, "#{sub}#{hash_to_query filter}", nil)
       rsl = ResponseLog.new(response.env[:status], response.body)
@@ -44,8 +44,8 @@ module Arrest
       response.body
     end
 
-    
-    def delete_all resource_path
+
+    def delete_all(resource_path)
         response = self.connection().delete do |req|
         req.url(resource_path)
         add_headers(req.headers)
@@ -53,15 +53,15 @@ module Arrest
       rql = RequestLog.new(:delete, "#{resource_path}", nil)
       rsl = ResponseLog.new(response.env[:status], response.body)
       Arrest::Source.call_logger.log(rql, rsl)
-      
+
       response.env[:status] == 200
     end
 
-    def delete rest_resource
+    def delete(rest_resource)
       raise "To delete an object it must have an id" unless rest_resource.respond_to?(:id) && rest_resource.id != nil
       response = self.connection().delete do |req|
-        req.url rest_resource.resource_location
-        add_headers req.headers
+        req.url(rest_resource.resource_location)
+        add_headers(req.headers)
       end
       rql = RequestLog.new(:delete, rest_resource.resource_location, nil)
       rsl = ResponseLog.new(response.env[:status], response.body)
@@ -69,29 +69,40 @@ module Arrest
       response.env[:status] == 200
     end
 
-    def put rest_resource
+    def put_sub_resource(rest_resource, sub_url, ids)
+      location = rest_resource.resource_location + "/#{sub_url}"
+      #body = {sub_url => ids}.to_json
+      body = ids.to_json
+
+      internal_put(rest_resource, location, body)
+    end
+
+    def put(rest_resource)
       raise "To change an object it must have an id" unless rest_resource.respond_to?(:id) && rest_resource.id != nil
       hash = rest_resource.to_jhash
       hash.delete(:id)
       hash.delete("id")
       body = hash.to_json
 
+      internal_put(rest_resource, rest_resource.resource_location, body)
+    end
+
+    def internal_put(rest_resource, location, body)
       response = self.connection().put do |req|
-        req.url rest_resource.resource_location
-        add_headers req.headers
+        req.url(location)
+        add_headers(req.headers)
         req.body = body
       end
-      rql = RequestLog.new(:put, rest_resource.resource_location, body)
+      rql = RequestLog.new(:put, location, body)
       rsl = ResponseLog.new(response.env[:status], response.body)
       Arrest::Source.call_logger.log(rql, rsl)
       if response.env[:status] != 200
-        err = Arrest::Source.error_handler.convert(response.body, response.env[:status])
-        rest_resource.errors.add(:base, err)
+        handle_errors(rest_resource, response.body, response.env[:status])
       end
       response.env[:status] == 200
     end
 
-    def post rest_resource
+    def post(rest_resource)
       raise "new object must have setter for id" unless rest_resource.respond_to?(:id=)
       raise "new object must not have id" if rest_resource.respond_to?(:id) && rest_resource.id != nil
       hash = rest_resource.to_jhash
@@ -99,7 +110,7 @@ module Arrest
       hash.delete('id')
 
       hash.delete_if{|k,v| v == nil}
-      
+
       body = hash.to_json
       response = self.connection().post do |req|
         req.url rest_resource.resource_path
@@ -115,11 +126,10 @@ module Arrest
         rest_resource.id= id
         true
       else
-        err = Arrest::Source.error_handler.convert(response.body, response.env[:status])
-        rest_resource.errors.add(:base, err)
+        handle_errors(rest_resource, response.body, response.env[:status])
         false
       end
-      
+
     end
 
     def connection
@@ -145,5 +155,16 @@ module Arrest
       r
     end
 
+    private
+
+      def handle_errors rest_resource, body, status
+        err = Arrest::Source.error_handler.convert(body,status)
+        if err.is_a?(String)
+          rest_resource.errors.add(:base, err)
+        else # is_a?(Array)
+          err.map{|k,v| rest_resource.errors.add(k,v)}
+        end
+      end
+
   end
 end

data/lib/arrest/root_resource.rb

@@ -33,6 +33,16 @@ module Arrest
         end
       end
 
+      def load
+        r = source().get_one "#{self.resource_path}"
+        body = body_root(r)
+        if body == nil || body.empty?
+          Arrest::logger.info "DocumentNotFoundError for #{self.resource_path}"
+          raise Errors::DocumentNotFoundError.new
+        end
+        self.build body
+      end
+
       def find id
         if id == nil || "" == id
           Arrest::logger.info "DocumentNotFoundError: no id given"

data/lib/arrest/version.rb

@@ -1,3 +1,3 @@
 module Arrest
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

data/test/unit.rb

@@ -549,5 +549,47 @@ class FirstTest < Test::Unit::TestCase
     f1_rel = Foo.find(f1.id)
     assert f1_rel.other_bars.empty?
   end
+
+  def test_equality_non_persistent
+    zoo1 = Zoo.new(:name => 'zoo1')
+    zoo2 = Zoo.new(:name => 'zoo2')
+    zoo1.id = '1'
+    zoo2.id = '1'
+
+    assert zoo1 == zoo2
+    assert_equal zoo1, zoo2
+    zoo2.id = '2'
+    assert zoo1 != zoo2
+    assert_not_equal zoo1, zoo2
+  end
+
+  def test_equality
+    zoo1 = Zoo.new(:name => 'zoo1')
+    zoo2 = Zoo.new(:name => 'zoo2')
+
+    assert zoo1.save, 'simple zoo should be saveable'
+    assert zoo2.save, 'simple zoo should be saveable'
+
+    assert_not_equal zoo1.id, zoo2.id, 'new zoos should have different ids'
+
+    assert_not_equal zoo1,zoo2, 'objects with different ids should not be equal'
+
+    assert_equal zoo1, zoo1, 'An object should be euqual to itself'
+    
+    assert_not_equal zoo1, nil, 'Anactual object should not equal nil'
+
+    zoo1_reloaded = Zoo.find(zoo1.id)
+    assert_not_nil zoo1_reloaded
+
+    assert zoo1 == zoo1_reloaded, "Objects of the same class with the same id should be equal"
+
+    foo = Foo.new()
+    foo.id = zoo1.id
+
+    assert_not_equal zoo1, foo, "Objects of different classes should not be euqal, even if they have the same id"
+    
+    zoo1_reloaded.name = 'zoooooo'
+    assert_equal zoo1, zoo1_reloaded, "Objects of the same class with the same id should be equal even if they differ in attributes (same as in rails)"
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arrest
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-25 00:00:00.000000000Z
+date: 2012-01-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &21375560 !ruby/object:Gem::Requirement
+  requirement: &2164553540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21375560
+  version_requirements: *2164553540
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &21374520 !ruby/object:Gem::Requirement
+  requirement: &2164549080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.7.5
   type: :runtime
   prerelease: false
-  version_requirements: *21374520
+  version_requirements: *2164549080
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &21374000 !ruby/object:Gem::Requirement
+  requirement: &2164547760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *21374000
+  version_requirements: *2164547760
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &21363500 !ruby/object:Gem::Requirement
+  requirement: &2164546900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *21363500
+  version_requirements: *2164546900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21363020 !ruby/object:Gem::Requirement
+  requirement: &2164545840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21363020
+  version_requirements: *2164545840
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &21362460 !ruby/object:Gem::Requirement
+  requirement: &2164544020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21362460
+  version_requirements: *2164544020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21361740 !ruby/object:Gem::Requirement
+  requirement: &2164543140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *21361740
+  version_requirements: *2164543140
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &21360960 !ruby/object:Gem::Requirement
+  requirement: &2164542260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21360960
+  version_requirements: *2164542260
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &21360500 !ruby/object:Gem::Requirement
+  requirement: &2164541340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21360500
+  version_requirements: *2164541340
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &21360000 !ruby/object:Gem::Requirement
+  requirement: &2164522540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21360000
+  version_requirements: *2164522540
 description: Consume a rest API in a AR like fashion
 email:
 - axel.tetzlaff@fortytools.com
@@ -142,6 +142,7 @@ files:
 - lib/arrest/attributes/converter.rb
 - lib/arrest/attributes/has_attributes.rb
 - lib/arrest/attributes/has_many_attribute.rb
+- lib/arrest/attributes/has_many_sub_resource_attribute.rb
 - lib/arrest/attributes/nested_attribute.rb
 - lib/arrest/attributes/polymorphic_attribute.rb
 - lib/arrest/class_utils.rb
@@ -191,4 +192,12 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Another ruby rest client
-test_files: []
+test_files:
+- spec/arrest_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/user.rb
+- test/has_attributed.rb
+- test/models.rb
+- test/nested_resource.rb
+- test/unit.rb
+- test/validations.rb