her 0.6.4 → 0.6.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzFmYjMyNGNlODUyZjk4N2I2MzA5ZGZmYjdkNTQyYTQ5YzZiMzlhMw==
+    ZGIzMGM1MTY2YmRmZjZjNmJhNzhhOGQ0YjcxZmMxZDM3MTJlNWVlZg==
   data.tar.gz: !binary |-
-    ODJkYzM0YTU3YTI3YTI2ZmNlNmIxM2UxOTAzZTc2YTA3NTJjMTM0Zg==
+    NTM0Y2JjYWZiNjAxOTJhMTUyZjc0OTYwZjU1YTRkNGViOWM4MTcwZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ODEzZjJhOTYwNDM0OGI0NGQzYzBmMGVkODdiYjk3NDFkY2E5ZTNkZTRkYWZl
-    MDlhODA5ZDY4NTJhZjE2MDM1MDIzMjViZDIzMjUxMTdhZDA1OTE4NDliODRj
-    MDdkMzdiMTI2MzAzNDE4NjkxNDY5ZDRhNmFmNGJjMjlmODcyNjA=
+    MTExZDExMjk5ODU5MmQ1Nzg4YmIwNWEyYmJmZDRiMTFiMjdlNTkwNjViNzQw
+    YjcxN2MyM2Q2ODlmZmNkODk0OTQyOGUwY2ViMWUwMTViMWI2OTMxYWVmZjNk
+    NzQ0MzhiY2JlZGE2YWY4NzIyMTg1YWVhYjgwNTNhYjkzYzVjNjY=
   data.tar.gz: !binary |-
-    MTBiODVmMmEzMDI5NTI2NmE0NGMzNDIyNWJkNjRiZTM2YTAxYzc1YjFhMTA4
-    YTM5NWRmNzVhNjE2Yjc0MDVkYTNiMjYyY2NkMTg2ODYxYjJhZDdlZjYzNmVk
-    NmYyNDc2M2IwYmVlNWU1YjU3Y2ZmYTE0YmQ1YWMyYjE4ZGM1YzQ=
+    YjJiN2Y5NGY5NWRjMTcyOTRiNDgwOGVjMjZmYTYxY2NmNjQ3NDhiNDUwMDg2
+    MWFhNWVkNjA3OTBiNzQzOGRkNzU1ZTRlZWJjZmMyYWVmM2VjOTkwOTZlYjU3
+    YzYyYjNkYjdhYzNhNTJmYjcyYzY1MGQyYzE1YjE2OWViMmI4ZjM=

data/README.md

@@ -670,6 +670,23 @@ end
 # GET /users?role=admin&active=1
 ```
 
+A neat trick you can do with scopes is interact with complex paths.
+
+```ruby
+class User
+  include Her::Model
+
+  collection_path "organizations/:organization_id/users"
+  scope :for_organization, -> { |id| where(organization_id: id) }
+end
+
+@user = User.for_organization(3).find(2)
+# GET /organizations/3/users/2
+
+@user = User.for_organization(3).create(fullname: "Tobias Fünke")
+# POST /organizations/3 with `fullname=Tobias+Fünke`
+```
+
 ### Multiple APIs
 
 It is possible to use different APIs for different models. Instead of calling `Her::API.setup`, you can create instances of `Her::API`:
@@ -834,7 +851,7 @@ See [CONTRIBUTING.md](https://github.com/remiprev/her/blob/master/CONTRIBUTING.m
 
 ### Contributors
 
-These fine folks helped with Her:
+These [fine folks](https://github.com/remiprev/her/contributors) helped with Her:
 
 * [@jfcixmedia](https://github.com/jfcixmedia)
 * [@EtienneLem](https://github.com/EtienneLem)

data/lib/her/model/attributes.rb

@@ -163,6 +163,13 @@ module Her
           Her::Model::Attributes.initialize_collection(self, parsed_data)
         end
 
+        # Initialize a new object with the "raw" parsed_data from the parsing middleware
+        #
+        # @private
+        def new_from_parsed_data(parsed_data)
+          new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])
+        end
+
         # Define the attributes that will be used to track dirty attributes and validations
         #
         # @param [Array] attributes
@@ -233,7 +240,7 @@ module Her
         def store_her_data(name, value)
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
             if @_her_store_#{name} && value.present?
-              remove_method @_her_store_#{name}
+              remove_method @_her_store_#{name}.to_sym
               remove_method @_her_store_#{name}.to_s + '='
             end
 

data/lib/her/model/orm.rb

@@ -42,11 +42,11 @@ module Her
             params = to_params
             self.class.request(to_params.merge(:_method => method, :_path => request_path)) do |parsed_data, response|
               assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-              self.metadata = parsed_data[:metadata]
-              self.response_errors = parsed_data[:errors]
-              self.changed_attributes.clear if self.changed_attributes.present?
+              @metadata = parsed_data[:metadata]
+              @response_errors = parsed_data[:errors]
 
-              return false if !response.success? || self.response_errors.any?
+              return false if !response.success? || @response_errors.any?
+              self.changed_attributes.clear if self.changed_attributes.present?
             end
           end
         end
@@ -65,8 +65,8 @@ module Her
         run_callbacks :destroy do
           self.class.request(:_method => method, :_path => request_path) do |parsed_data, response|
             assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-            self.metadata = parsed_data[:metadata]
-            self.response_errors = parsed_data[:errors]
+            @metadata = parsed_data[:metadata]
+            @response_errors = parsed_data[:errors]
             @destroyed = true
           end
         end
@@ -74,37 +74,6 @@ module Her
       end
 
       module ClassMethods
-        # Fetch specific resource(s) by their ID
-        #
-        # @example
-        #   @user = User.find(1)
-        #   # Fetched via GET "/users/1"
-        #
-        # @example
-        #   @users = User.find([1, 2])
-        #   # Fetched via GET "/users/1" and GET "/users/2"
-        def find(*ids)
-          params = ids.last.is_a?(Hash) ? ids.pop : {}
-          results = ids.flatten.compact.uniq.map do |id|
-            resource = nil
-            request(params.merge(:_method => method_for(:find), :_path => build_request_path(params.merge(primary_key => id)))) do |parsed_data, response|
-              if response.success?
-                resource = new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:metadata], :_errors => parsed_data[:errors])
-                resource.run_callbacks :find
-              else
-                return nil
-              end
-            end
-            resource
-          end
-
-          if ids.length > 1 || ids.first.kind_of?(Array)
-            results
-          else
-            results.first
-          end
-        end
-
         # Create a new chainable scope
         #
         # @example
@@ -152,7 +121,7 @@ module Her
         end
 
         # Delegate the following methods to `scoped`
-        [:all, :where, :create, :build, :first_or_create, :first_or_initialize].each do |method|
+        [:all, :where, :create, :build, :find, :first_or_create, :first_or_initialize].each do |method|
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{method}(*params)
               scoped.send(#{method.to_sym.inspect}, *params)

data/lib/her/model/relation.rb

@@ -73,6 +73,40 @@ module Her
         end
       end
 
+      # Fetch specific resource(s) by their ID
+      #
+      # @example
+      #   @user = User.find(1)
+      #   # Fetched via GET "/users/1"
+      #
+      # @example
+      #   @users = User.find([1, 2])
+      #   # Fetched via GET "/users/1" and GET "/users/2"
+      def find(*ids)
+        params = @params.merge(ids.last.is_a?(Hash) ? ids.pop : {})
+
+        results = ids.flatten.compact.uniq.map do |id|
+          resource = nil
+          request_params = params.merge(
+            :_method => @parent.method_for(:find),
+            :_path => @parent.build_request_path(params.merge(@parent.primary_key => id))
+          )
+
+          @parent.request(request_params) do |parsed_data, response|
+            if response.success?
+              resource = @parent.new_from_parsed_data(parsed_data)
+              resource.run_callbacks :find
+            else
+              return nil
+            end
+          end
+
+          resource
+        end
+
+        ids.length > 1 || ids.first.kind_of?(Array) ? results : results.first
+      end
+
       # Create a resource and return it
       #
       # @example

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
 end

data/spec/model/attributes_spec.rb

@@ -139,6 +139,13 @@ describe Her::Model::Attributes do
 
   context "handling metadata and errors" do
     before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.adapter :test do |stub|
+          stub.post("/users") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
+        end
+      end
+
       spawn_model 'Foo::User' do
         store_response_errors :errors
         store_metadata :my_data
@@ -162,6 +169,14 @@ describe Her::Model::Attributes do
     it "should remove the default method for metadata" do
       expect { @user.metadata }.to raise_error(NoMethodError)
     end
+
+    it "should work with #save" do
+      @user.assign_attributes(:fullname => "Tobias Fünke")
+      @user.save
+      expect { @user.metadata }.to raise_error(NoMethodError)
+      @user.my_data.should be_empty
+      @user.errors.should be_empty
+    end
   end
 
   context "overwriting default attribute methods" do

data/spec/model/dirty_spec.rb

@@ -9,7 +9,9 @@ describe "Her::Model and ActiveModel::Dirty" do
         builder.use Faraday::Request::UrlEncoded
         builder.adapter :test do |stub|
           stub.get("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke" }.to_json] }
+          stub.get("/users/2") { |env| [200, {}, { :id => 2, :fullname => "Maeby Fünke" }.to_json] }
           stub.put("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
+          stub.put("/users/2") { |env| [400, {}, { :errors => ["Email cannot be blank"] }.to_json] }
           stub.post("/users") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
         end
       end
@@ -20,14 +22,28 @@ describe "Her::Model and ActiveModel::Dirty" do
     end
 
     context "for existing resource" do
-      it "tracks dirty attributes" do
-        user = Foo::User.find(1)
-        user.fullname = "Tobias Fünke"
-        user.fullname_changed?.should be_true
-        user.email_changed?.should be_false
-        user.should be_changed
-        user.save
-        user.should_not be_changed
+      context "with successful save" do
+        it "tracks dirty attributes" do
+          user = Foo::User.find(1)
+          user.fullname = "Tobias Fünke"
+          user.fullname_changed?.should be_true
+          user.email_changed?.should be_false
+          user.should be_changed
+          user.save
+          user.should_not be_changed
+        end
+      end
+
+      context "with erroneous save" do
+        it "tracks dirty attributes" do
+          user = Foo::User.find(2)
+          user.fullname = "Tobias Fünke"
+          user.fullname_changed?.should be_true
+          user.email_changed?.should be_false
+          user.should be_changed
+          user.save
+          user.should be_changed
+        end
       end
     end
 

data/spec/model/paths_spec.rb

@@ -190,6 +190,13 @@ describe Her::Model::Paths do
         @user.id.should == 1
         @user.fullname.should == "Tobias Fünke"
       end
+
+      it "maps a single resource using a scope to a Ruby object" do
+        Foo::User.scope :for_organization, lambda { |o| where(:organization_id => o) }
+        @user = Foo::User.for_organization(2).find(1)
+        @user.id.should == 1
+        @user.fullname.should == "Tobias Fünke"
+      end
     end
 
     describe "fetching a collection" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-26 00:00:00.000000000 Z
+date: 2013-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake