her 0.4.1 → 0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmU4ZjBhMTAxNGJhNTE5ZThjNDY5OTcxZmFkOGM5NzQwZjBhYTIyOA==
+    ODkyMGNiNzY1MDY3MGY1YjBhMTQ1YTQ5Mjk3NWZmNmIwMDVmZWI3Mg==
   data.tar.gz: !binary |-
-    MTIxOGI1NjljNzBiNjFlNmM2ODczZDZiNDlhNGIxZmQ0Njk3NjEyNw==
+    YjAzYjJkNWQ2YjIyZTIwOThmYjY5ZTRhNzJkOWZkZGZmNzlmMmY3Mg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NGNjNDg0MjIzMmRhOTA5MDU3MWIyMWZkYzIyMzFkNWViNDdiYmFkZDE3ZjQ1
-    ZTA1NTExMzA1YTc2MTE3MGM0NTYxNjg2ZjI1OTllYWFlZGQ3ZDY2ZWIwYjQ5
-    NTUwYjI4NTBhMTk3MTVjZTExYjNkZDNmM2Q1MjM5YjkwN2U2ZGY=
+    YzgxZTFkNWI1NGUzZWYzNDk2NTQ1NjhlYWYzNmZiMzAwNmEyYjE2MWUxYTU3
+    YTc5MDRlYjZhZDBmZmQ0YTUzOGNmNTM4NDViMzliMDQ4MmZhZGE3NjUxZDIy
+    NjJjYWNhZWM0ODYwODg5ZTEzNGVjYWZjNTVlYjIzY2JiNTNjY2Q=
   data.tar.gz: !binary |-
-    NjAzM2JlOWZlZDBjMzZjYjI2OWJkYzc5NTY4MzAyNzhhZGVkODlhMmZmZGJm
-    NjUzY2JlMjExZDAzYjljOTI1YzE1NWJkOWM0OTY0NzE2MDQwYjY1NmZmN2M4
-    YzU0YmYyNDY0YWE3ZWVjZWY0N2NkY2Y0NGQ1ODFhMzg2MTIxN2E=
+    NTdjYmNjZTQ1ZDVjYmM5NGZmNmRmN2M3NjhjNjJjZWU4MTljOWE1YjJmZmY4
+    YTg4NzgxNmI0YWQzOTljZGJlNjUzNzI5NDI2NzMxNjI3Mzk4MTNjMDNkOGNi
+    YTQ1ZGExNjU0OGRiZWJmYzNlZTM1ZDY5NWMwNTQxNWViZGNmMTM=

data/README.md

@@ -340,9 +340,31 @@ If there’s no relationship data in the resource, Her makes a HTTP request to r
 
 Subsequent calls to `#comments`, `#role` and `#organization` will not trigger extra HTTP requests and will return the cached objects.
 
-### Hooks (callbacks)
+### Validations
 
-You can add *before* and *after* hooks to your models that are triggered on specific actions. You can use symbols or blocks.
+Her includes `ActiveModel::Validations` so you can declare validations the same way you do in Rails.
+
+However, validations must be triggered manually — they are not run, for example, when calling `#save` on an object, or `#create` on a model class.
+
+```ruby
+class User
+  include Her::Model
+
+  attr_accessor :fullname, :email
+  validates :fullname, :presence => true
+  validates :email, :presence => true
+end
+
+@user = User.new(:fullname => "Tobias Fünke")
+@user.valid? # => false
+
+@user.save
+# POST /users&fullname=Tobias+Fünke will still be called, even if the user is not valid
+```
+
+### Callbacks
+
+You can add *before* and *after* callbacks to your models that are triggered on specific actions. You can use symbols or blocks.
 
 ```ruby
 class User
@@ -362,7 +384,7 @@ end
 @user.fullname # => "TOBIAS FUNKE"
 ```
 
-The available hooks are:
+The available callbacks are:
 
 * `before_save`
 * `before_create`

data/UPGRADE.md

@@ -2,6 +2,12 @@
 
 Here is a list of backward-incompatible changes that were introduced while Her is pre-1.0. After reaching 1.0, it will follow the [Semantic Versioning](http://semver.org/) system.
 
+## 0.5
+
+* Her is now compatible with `ActiveModel` and includes `ActiveModel::Validations`.
+
+  Before 0.5, the `errors` method on an object would return an error list received from the server (the `:errors` key defined by the parsing middleware). But now, `errors` returns the error list generated after calling the `valid?` method (or any other similar validation method from `ActiveModel::Validations`). The error list returned from the server is now accessible from the `response_errors` method.
+
 ## 0.2.4
 
 * Her no longer includes default middleware when making HTTP requests. The user has now to define all the needed middleware. Before:

data/her.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", "~> 2.13"
   s.add_development_dependency "mocha", "~> 0.13"
 
+  s.add_runtime_dependency "activemodel", ">= 3.0.0"
   s.add_runtime_dependency "activesupport", ">= 3.0.0"
   s.add_runtime_dependency "faraday", "~> 0.8"
   s.add_runtime_dependency "multi_json", "~> 1.5"

data/lib/her/api.rb

@@ -96,7 +96,8 @@ module Her
           request.body = attrs
         end
       end
-      response.env[:body]
+
+      { :parsed_data => response.env[:body], :response => response }
     end
 
     private

data/lib/her/model.rb

@@ -2,10 +2,10 @@ require "her/model/base"
 require "her/model/http"
 require "her/model/orm"
 require "her/model/relationships"
-require "her/model/hooks"
 require "her/model/introspection"
 require "her/model/paths"
 require "her/model/nested_attributes"
+require "active_model"
 
 module Her
   # This module is the main element of Her. After creating a Her::API object,
@@ -27,12 +27,19 @@ module Her
     include Her::Model::Paths
     include Her::Model::Relationships
     include Her::Model::NestedAttributes
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+    include ActiveModel::Dirty
 
     # Class methods
     included do
       extend Her::Model::Base
       extend Her::Model::HTTP
-      extend Her::Model::Hooks
+      extend ActiveModel::Naming
+      extend ActiveModel::Translation
+
+      extend ActiveModel::Callbacks
+      define_model_callbacks :create, :update, :save, :find, :destroy
 
       # Define default settings
       root_element self.name.split("::").last.underscore

data/lib/her/model/http.rb

@@ -21,11 +21,11 @@ module Her
       # Main request wrapper around Her::API. Used to make custom request to the API.
       # @private
       def request(attrs={})
-        parsed_data = her_api.request(attrs)
+        request = her_api.request(attrs)
         if block_given?
-          yield parsed_data
+          yield request[:parsed_data], request[:response]
         else
-          parsed_data
+          { :parsed_data => request[:parsed_data], :response => request[:response] }
         end
       end
 
@@ -40,7 +40,7 @@ module Her
       #   # Fetched via GET "/users/popular"
       def get(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        get_raw(path, attrs) do |parsed_data|
+        get_raw(path, attrs) do |parsed_data, response|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
           else
@@ -58,7 +58,7 @@ module Her
       # Make a GET request and return a collection of resources
       def get_collection(path=nil, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        get_raw(path, attrs) do |parsed_data|
+        get_raw(path, attrs) do |parsed_data, response|
           new_collection(parsed_data)
         end
       end
@@ -66,7 +66,7 @@ module Her
       # Make a GET request and return a collection of resources
       def get_resource(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        get_raw(path, attrs) do |parsed_data|
+        get_raw(path, attrs) do |parsed_data, response|
           new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
         end
       end
@@ -74,7 +74,7 @@ module Her
       # Make a POST request and return either a collection or a resource
       def post(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        post_raw(path, attrs) do |parsed_data|
+        post_raw(path, attrs) do |parsed_data, response|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
           else
@@ -92,7 +92,7 @@ module Her
       # Make a POST request and return a collection of resources
       def post_collection(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        post_raw(path, attrs) do |parsed_data|
+        post_raw(path, attrs) do |parsed_data, response|
           new_collection(parsed_data)
         end
       end
@@ -100,7 +100,7 @@ module Her
       # Make a POST request and return a collection of resources
       def post_resource(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        post_raw(path, attrs) do |parsed_data|
+        post_raw(path, attrs) do |parsed_data, response|
           new(parse(parsed_data[:data]))
         end
       end
@@ -108,7 +108,7 @@ module Her
       # Make a PUT request and return either a collection or a resource
       def put(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        put_raw(path, attrs) do |parsed_data|
+        put_raw(path, attrs) do |parsed_data, response|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
           else
@@ -126,7 +126,7 @@ module Her
       # Make a PUT request and return a collection of resources
       def put_collection(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        put_raw(path, attrs) do |parsed_data|
+        put_raw(path, attrs) do |parsed_data, response|
           new_collection(parsed_data)
         end
       end
@@ -134,7 +134,7 @@ module Her
       # Make a PUT request and return a collection of resources
       def put_resource(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        put_raw(path, attrs) do |parsed_data|
+        put_raw(path, attrs) do |parsed_data, response|
           new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
         end
       end
@@ -142,7 +142,7 @@ module Her
       # Make a PATCH request and return either a collection or a resource
       def patch(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        patch_raw(path, attrs) do |parsed_data|
+        patch_raw(path, attrs) do |parsed_data, response|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
           else
@@ -160,7 +160,7 @@ module Her
       # Make a PATCH request and return a collection of resources
       def patch_collection(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        patch_raw(path, attrs) do |parsed_data|
+        patch_raw(path, attrs) do |parsed_data, response|
           new_collection(parsed_data)
         end
       end
@@ -168,7 +168,7 @@ module Her
       # Make a PATCH request and return a collection of resources
       def patch_resource(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        patch_raw(path, attrs) do |parsed_data|
+        patch_raw(path, attrs) do |parsed_data, response|
           new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
         end
       end
@@ -176,7 +176,7 @@ module Her
       # Make a DELETE request and return either a collection or a resource
       def delete(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        delete_raw(path, attrs) do |parsed_data|
+        delete_raw(path, attrs) do |parsed_data, response|
           if parsed_data[:data].is_a?(Array)
             new_collection(parsed_data)
           else
@@ -194,7 +194,7 @@ module Her
       # Make a DELETE request and return a collection of resources
       def delete_collection(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        delete_raw(path, attrs) do |parsed_data|
+        delete_raw(path, attrs) do |parsed_data, response|
           new_collection(parsed_data)
         end
       end
@@ -202,7 +202,7 @@ module Her
       # Make a DELETE request and return a collection of resources
       def delete_resource(path, attrs={})
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
-        delete_raw(path, attrs) do |parsed_data|
+        delete_raw(path, attrs) do |parsed_data, response|
           new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
         end
       end

data/lib/her/model/orm.rb

@@ -3,14 +3,15 @@ module Her
     # This module adds ORM-like capabilities to the model
     module ORM
       extend ActiveSupport::Concern
-      attr_accessor :data, :metadata, :errors
+      attr_accessor :data, :metadata, :response_errors
       alias :attributes :data
       alias :attributes= :data=
 
       # Initialize a new object with data received from an HTTP request
       def initialize(params={})
         @metadata = params.delete(:_metadata) || {}
-        @errors = params.delete(:_errors) || {}
+        @response_errors = params.delete(:_errors) || {}
+        @destroyed = params.delete(:_destroyed) || false
 
         update_data(params)
       end
@@ -20,7 +21,7 @@ module Her
       def self.initialize_collection(klass, parsed_data={})
         collection_data = parsed_data[:data].map do |item_data|
           resource = klass.new(klass.parse(item_data))
-          klass.wrap_in_hooks(resource, :find)
+          resource.run_callbacks :find
           resource
         end
         Her::Collection.new(collection_data, parsed_data[:metadata], parsed_data[:errors])
@@ -92,16 +93,6 @@ module Her
         !@data.include?(:id)
       end
 
-      # Return `true` if a resource does not contain errors
-      def valid?
-        @errors.empty?
-      end
-
-      # Return `true` if a resource contains errors
-      def invalid?
-        @errors.any?
-      end
-
       # Return `true` if the other object is also a Her::Model and has matching data
       def ==(other)
         other.is_a?(Her::Model) && @data == other.data
@@ -118,6 +109,11 @@ module Her
         @data.hash
       end
 
+      # Return whether the object has been destroyed
+      def destroyed?
+        @destroyed
+      end
+
       # Save a resource
       #
       # @example Save a resource after fetching it
@@ -136,20 +132,22 @@ module Her
         resource = self
 
         if @data[:id]
-          hooks = [:update, :save]
+          callback = :update
           method = :put
         else
-          hooks = [:create, :save]
+          callback = :create
           method = :post
         end
 
-        self.class.wrap_in_hooks(resource, *hooks) do |resource, klass|
-          klass.request(params.merge(:_method => method, :_path => "#{request_path}")) do |parsed_data|
-            update_data(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-            self.metadata = parsed_data[:metadata]
-            self.errors = parsed_data[:errors]
+        run_callbacks callback do
+          run_callbacks :save do
+            self.class.request(params.merge(:_method => method, :_path => "#{request_path}")) do |parsed_data, response|
+              update_data(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
+              self.metadata = parsed_data[:metadata]
+              self.response_errors = parsed_data[:errors]
 
-            return false if self.errors.any?
+              return false if self.response_errors.any?
+            end
           end
         end
 
@@ -164,11 +162,12 @@ module Her
       #   # Called via DELETE "/users/1"
       def destroy
         resource = self
-        self.class.wrap_in_hooks(resource, :destroy) do |resource, klass|
-          klass.request(:_method => :delete, :_path => "#{request_path}") do |parsed_data|
+        run_callbacks :destroy do
+          self.class.request(:_method => :delete, :_path => "#{request_path}") do |parsed_data, response|
             update_data(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
             self.metadata = parsed_data[:metadata]
-            self.errors = parsed_data[:errors]
+            self.response_errors = parsed_data[:errors]
+            @destroyed = true
           end
         end
         self
@@ -229,9 +228,13 @@ module Her
           params = ids.last.is_a?(Hash) ? ids.pop : {}
           results = ids.flatten.compact.uniq.map do |id|
             resource = nil
-            request(params.merge(:_method => :get, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data|
-              resource = new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
-              wrap_in_hooks(resource, :find)
+            request(params.merge(:_method => :get, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data, response|
+              if response.success?
+                resource = new(parse(parsed_data[:data]).merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
+                resource.run_callbacks :find
+              else
+                return nil
+              end
             end
             resource
           end
@@ -248,7 +251,7 @@ module Her
         #   @users = User.all
         #   # Fetched via GET "/users"
         def all(params={})
-          request(params.merge(:_method => :get, :_path => "#{build_request_path(params)}")) do |parsed_data|
+          request(params.merge(:_method => :get, :_path => "#{build_request_path(params)}")) do |parsed_data, response|
             new_collection(parsed_data)
           end
         end
@@ -260,14 +263,16 @@ module Her
         #   # Called via POST "/users/1"
         def create(params={})
           resource = new(params)
-          wrap_in_hooks(resource, :create, :save) do |resource, klass|
-            params = resource.to_params
-            request(params.merge(:_method => :post, :_path => "#{build_request_path(params)}")) do |parsed_data|
-              data = parse(parsed_data[:data])
-              resource.instance_eval do
-                update_data(data)
-                @metadata = parsed_data[:metadata]
-                @errors = parsed_data[:errors]
+          resource.run_callbacks :create do
+            resource.run_callbacks :save do
+              params = resource.to_params
+              request(params.merge(:_method => :post, :_path => "#{build_request_path(params)}")) do |parsed_data, response|
+                data = parse(parsed_data[:data])
+                resource.instance_eval do
+                  update_data(data)
+                  @metadata = parsed_data[:metadata]
+                  @response_errors = parsed_data[:errors]
+                end
               end
             end
           end
@@ -291,8 +296,8 @@ module Her
         #   User.destroy_existing(1)
         #   # Called via DELETE "/users/1"
         def destroy_existing(id, params={})
-          request(params.merge(:_method => :delete, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data|
-            new(parse(parsed_data[:data]))
+          request(params.merge(:_method => :delete, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data, response|
+            new(parse(parsed_data[:data]).merge(:_destroyed => true))
           end
         end
 

data/lib/her/model/relationships.rb

@@ -83,7 +83,7 @@ module Her
             method_attrs = method_attrs[0] || {}
             klass = self.class.nearby_class(attrs[:class_name])
             if method_attrs.any?
-              @data[name] = klass.get_collection("#{self.class.build_request_path(method_attrs.merge(:id => id))}#{attrs[:path]}")
+              @data[name] = klass.get_collection("#{self.class.build_request_path(method_attrs.merge(:id => id))}#{attrs[:path]}", method_attrs)
             else
               @data[name] ||= klass.get_collection("#{self.class.build_request_path(:id => id)}#{attrs[:path]}")
             end
@@ -131,7 +131,7 @@ module Her
             method_attrs = method_attrs[0] || {}
             klass = self.class.nearby_class(attrs[:class_name])
             if method_attrs.any?
-              klass.get_resource("#{self.class.build_request_path(method_attrs.merge(:id => id))}#{attrs[:path]}")
+              klass.get_resource("#{self.class.build_request_path(method_attrs.merge(:id => id))}#{attrs[:path]}", method_attrs)
             else
               @data[name] ||= klass.get_resource("#{self.class.build_request_path(:id => id)}#{attrs[:path]}")
             end
@@ -169,7 +169,7 @@ module Her
             method_attrs = method_attrs[0] || {}
             klass = self.class.nearby_class(attrs[:class_name])
             if method_attrs.any?
-              klass.get_resource("#{klass.build_request_path(method_attrs.merge(:id => @data[attrs[:foreign_key].to_sym]))}")
+              klass.get_resource("#{klass.build_request_path(method_attrs.merge(:id => @data[attrs[:foreign_key].to_sym]))}", method_attrs)
             else
               @data[name] ||= klass.get_resource("#{klass.build_request_path(:id => @data[attrs[:foreign_key].to_sym])}")
             end