her 0.2.5 → 0.2.6

data/lib/her/collection.rb

@@ -0,0 +1,12 @@
+module Her
+  class Collection < ::Array
+    attr_reader :metadata, :errors
+
+    # @private
+    def initialize(items=[], metadata={}, errors=[]) # {{{
+      super(items)
+      @metadata = metadata || {}
+      @errors = errors || []
+    end # }}}
+  end
+end

data/lib/her/middleware.rb

@@ -1,8 +1,9 @@
+require "her/middleware/first_level_parse_json"
+require "her/middleware/second_level_parse_json"
+require "her/middleware/accept_json"
+
 module Her
   module Middleware
-    autoload :FirstLevelParseJSON,  "her/middleware/first_level_parse_json"
-    autoload :SecondLevelParseJSON, "her/middleware/second_level_parse_json"
-
     DefaultParseJSON = FirstLevelParseJSON
   end
 end

data/lib/her/middleware/accept_json.rb

@@ -0,0 +1,15 @@
+module Her
+  module Middleware
+    # This middleware adds a "Accept: application/json" HTTP header
+    class AcceptJSON < Faraday::Middleware
+      def add_header(headers) # {{{
+        headers.merge! "Accept" => "application/json"
+      end # }}}
+
+      def call(env) # {{{
+        add_header(env[:request_headers])
+        @app.call(env)
+      end # }}}
+    end
+  end
+end

data/lib/her/model.rb

@@ -1,3 +1,11 @@
+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"
+
 module Her
   # This module is the main element of Her. After creating a Her::API object,
   # include this module in your models to get a few magic methods defined in them.
@@ -10,14 +18,6 @@ module Her
   #   @user = User.new(:name => "Rémi")
   #   @user.save
   module Model
-    autoload :Base,          "her/model/base"
-    autoload :HTTP,          "her/model/http"
-    autoload :ORM,           "her/model/orm"
-    autoload :Relationships, "her/model/relationships"
-    autoload :Hooks,         "her/model/hooks"
-    autoload :Introspection, "her/model/introspection"
-    autoload :Paths,         "her/model/paths"
-
     extend ActiveSupport::Concern
 
     # Instance methods

data/lib/her/model/hooks.rb

@@ -51,6 +51,14 @@ module Her
       # @param [Symbol, &block] method A method or a block to be called
       def after_destroy(method=nil, &block); set_hook(:after, :destroy, method || block); end
 
+      # Wrap a block between “before” and “after” hooks
+      # @private
+      def wrap_in_hooks(resource, *hooks) # {{{
+        perform_before_hooks(resource, *hooks)
+        yield(resource, resource.class)
+        perform_after_hooks(resource, *hooks.reverse)
+      end # }}}
+
       private
       # @private
       def hooks # {{{
@@ -75,6 +83,22 @@ module Her
           end
         end
       end # }}}
+
+      # Perform “after” hooks on a resource
+      # @private
+      def perform_after_hooks(resource, *hooks) # {{{
+        hooks.each do |hook|
+          perform_hook(resource, :after, hook)
+        end
+      end # }}}
+
+      # Perform “before” hooks on a resource
+      # @private
+      def perform_before_hooks(resource, *hooks) # {{{
+        hooks.each do |hook|
+          perform_hook(resource, :before, hook)
+        end
+      end # }}}
     end
   end
 end

data/lib/her/model/http.rb

@@ -26,9 +26,9 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         get_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data[:data])
+            new_collection(parsed_data)
           else
-            new(parsed_data[:data])
+            new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
           end
         end
       end # }}}
@@ -43,7 +43,7 @@ module Her
       def get_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         get_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data[:data])
+          new_collection(parsed_data)
         end
       end # }}}
 
@@ -51,7 +51,7 @@ module Her
       def get_resource(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         get_raw(path, attrs) do |parsed_data|
-          new(parsed_data[:data])
+          new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
         end
       end # }}}
 
@@ -60,9 +60,9 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         post_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data[:data])
+            new_collection(parsed_data)
           else
-            new(parsed_data[:data])
+            new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
           end
         end
       end # }}}
@@ -77,7 +77,7 @@ module Her
       def post_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         post_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data[:data])
+          new_collection(parsed_data)
         end
       end # }}}
 
@@ -94,9 +94,9 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         put_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data[:data])
+            new_collection(parsed_data)
           else
-            new(parsed_data[:data])
+            new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
           end
         end
       end # }}}
@@ -111,7 +111,7 @@ module Her
       def put_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         put_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data[:data])
+          new_collection(parsed_data)
         end
       end # }}}
 
@@ -119,7 +119,7 @@ module Her
       def put_resource(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         put_raw(path, attrs) do |parsed_data|
-          new(parsed_data[:data])
+          new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
         end
       end # }}}
 
@@ -128,9 +128,9 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         patch_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data[:data])
+            new_collection(parsed_data)
           else
-            new(parsed_data[:data])
+            new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
           end
         end
       end # }}}
@@ -145,7 +145,7 @@ module Her
       def patch_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         patch_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data[:data])
+          new_collection(parsed_data)
         end
       end # }}}
 
@@ -153,7 +153,7 @@ module Her
       def patch_resource(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         patch_raw(path, attrs) do |parsed_data|
-          new(parsed_data[:data])
+          new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
         end
       end # }}}
 
@@ -162,9 +162,9 @@ module Her
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         delete_raw(path, attrs) do |parsed_data|
           if parsed_data[:data].is_a?(Array)
-            new_collection(parsed_data[:data])
+            new_collection(parsed_data)
           else
-            new(parsed_data[:data])
+            new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
           end
         end
       end # }}}
@@ -179,7 +179,7 @@ module Her
       def delete_collection(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         delete_raw(path, attrs) do |parsed_data|
-          new_collection(parsed_data[:data])
+          new_collection(parsed_data)
         end
       end # }}}
 
@@ -187,7 +187,7 @@ module Her
       def delete_resource(path, attrs={}) # {{{
         path = "#{build_request_path(attrs)}/#{path}" if path.is_a?(Symbol)
         delete_raw(path, attrs) do |parsed_data|
-          new(parsed_data[:data])
+          new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
         end
       end # }}}
 

data/lib/her/model/orm.rb

@@ -2,17 +2,29 @@ module Her
   module Model
     # This module adds ORM-like capabilities to the model
     module ORM
+      attr_reader :metadata, :errors
+
       # Initialize a new object with data received from an HTTP request
       # @private
-      def initialize(single_data) # {{{
-        @data = single_data
-        @data = self.class.parse_relationships(@data)
+      def initialize(data={}) # {{{
+        @data = {}
+        @metadata = data.delete(:_metadata) || {}
+        @errors = data.delete(:_errors) || {}
+        cleaned_data = data.inject({}) do |memo, item|
+          key, value = item
+          send "#{key}=".to_sym, value unless value.nil?
+          respond_to?("#{key}=") ? memo : memo.merge({ key => value })
+        end
+        @data.merge! self.class.parse_relationships(cleaned_data)
       end # }}}
 
       # Initialize a collection of resources
       # @private
-      def self.initialize_collection(name, collection_data) # {{{
-        collection_data.map { |item_data| Object.const_get(name.to_s.classify).new(item_data) }
+      def self.initialize_collection(name, parsed_data={}) # {{{
+        collection_data = parsed_data[:data].map do |item_data|
+          Object.const_get(name.to_s.classify).new(item_data)
+        end
+        Her::Collection.new(collection_data, parsed_data[:metadata], parsed_data[:errors])
       end # }}}
 
       # Handles missing methods by routing them through @data
@@ -20,10 +32,11 @@ module Her
       def method_missing(method, attrs=nil) # {{{
         assignment_method = method.to_s =~ /\=$/
         method = method.to_s.gsub(/(\?|\!|\=)$/, "").to_sym
-        if attrs and assignment_method
+        if !attrs.nil? and assignment_method
+          @data ||= {}
           @data[method.to_s.gsub(/\=$/, "").to_sym] = attrs
         else
-          if @data.include?(method)
+          if @data and @data.include?(method)
             @data[method]
           else
             super
@@ -39,9 +52,9 @@ module Her
 
       # Initialize a collection of resources with raw data from an HTTP request
       #
-      # @param [Array] collection_data An array of model hashes
-      def new_collection(collection_data) # {{{
-        Her::Model::ORM.initialize_collection(self.to_s.underscore, collection_data)
+      # @param [Array] parsed_data
+      def new_collection(parsed_data) # {{{
+        Her::Model::ORM.initialize_collection(self.to_s.underscore, parsed_data)
       end # }}}
 
       # Return `true` if a resource was not saved yet
@@ -49,6 +62,16 @@ 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 # }}}
+
       # Fetch a specific resource based on an ID
       #
       # @example
@@ -67,7 +90,7 @@ module Her
       #   # Fetched via GET "/users"
       def all(params={}) # {{{
         request(params.merge(:_method => :get, :_path => "#{build_request_path(params)}")) do |parsed_data|
-          new_collection(parsed_data[:data])
+          new_collection(parsed_data)
         end
       end # }}}
 
@@ -78,17 +101,16 @@ module Her
       #   # Called via POST "/users/1"
       def create(params={}) # {{{
         resource = new(params)
-        perform_hook(resource, :before, :create)
-        perform_hook(resource, :before, :save)
-        params = resource.instance_eval { @data }
-        request(params.merge(:_method => :post, :_path => "#{build_request_path(params)}")) do |parsed_data|
-          resource.instance_eval do
-            @data = parsed_data[:data]
+        wrap_in_hooks(resource, :create, :save) do |resource, klass|
+          params = resource.instance_eval { @data }
+          request(params.merge(:_method => :post, :_path => "#{build_request_path(params)}")) do |parsed_data|
+            resource.instance_eval do
+              @data = parsed_data[:data]
+              @metadata = parsed_data[:metadata]
+              @errors = parsed_data[:errors]
+            end
           end
         end
-        perform_hook(resource, :after, :save)
-        perform_hook(resource, :after, :create)
-
         resource
       end # }}}
 
@@ -118,30 +140,20 @@ module Her
       def save # {{{
         params = @data.dup
         resource = self
+
         if @data[:id]
-          self.class.class_eval do
-            perform_hook(resource, :before, :update)
-            perform_hook(resource, :before, :save)
-          end
-          self.class.request(params.merge(:_method => :put, :_path => "#{request_path}")) do |parsed_data|
-            @data = parsed_data[:data]
-          end
-          self.class.class_eval do
-            perform_hook(resource, :after, :save)
-            perform_hook(resource, :after, :update)
-          end
-          self
+          hooks = [:update, :save]
+          method = :put
         else
-          self.class.class_eval do
-            perform_hook(resource, :before, :create)
-            perform_hook(resource, :before, :save)
-          end
-          self.class.request(params.merge(:_method => :post, :_path => "#{request_path}")) do |parsed_data|
+          hooks = [:create, :save]
+          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|
             @data = parsed_data[:data]
-          end
-          self.class.class_eval do
-            perform_hook(resource, :after, :save)
-            perform_hook(resource, :after, :create)
+            @metadata = parsed_data[:metadata]
+            @errors = parsed_data[:errors]
           end
         end
         self
@@ -154,13 +166,14 @@ module Her
       #   @user.destroy
       #   # Called via DELETE "/users/1"
       def destroy # {{{
-        params = @data.dup
         resource = self
-        self.class.class_eval { perform_hook(resource, :before, :destroy) }
-        self.class.request(params.merge(:_method => :delete, :_path => "#{request_path}")) do |parsed_data|
-          @data = parsed_data[:data]
+        self.class.wrap_in_hooks(resource, :destroy) do |resource, klass|
+          klass.request(:_method => :delete, :_path => "#{request_path}") do |parsed_data|
+            @data = parsed_data[:data]
+            @metadata = parsed_data[:metadata]
+            @errors = parsed_data[:errors]
+          end
         end
-        self.class.class_eval { perform_hook(resource, :after, :destroy) }
         self
       end # }}}
 

data/lib/her/model/relationships.rb

@@ -14,14 +14,16 @@ module Her
         @her_relationships ||= {}
         @her_relationships.each_pair do |type, relationships|
           relationships.each do |relationship|
-            if data.include?(relationship[:name])
-              if type == :has_many
-                data[relationship[:name]] = Her::Model::ORM.initialize_collection(relationship[:class_name], data[relationship[:name]])
-              elsif type == :has_one
-                data[relationship[:name]] = Object.const_get(relationship[:class_name]).new(data[relationship[:name]])
-              elsif type == :belongs_to
-                data[relationship[:name]] = Object.const_get(relationship[:class_name]).new(data[relationship[:name]])
-              end
+            name = relationship[:name]
+            class_name = relationship[:class_name]
+            next if !data.include?(name) or data[name].nil?
+            data[name] = case type
+              when :has_many
+                Her::Model::ORM.initialize_collection(class_name, :data => data[name])
+              when :has_one, :belongs_to
+                Object.const_get(class_name).new(data[name])
+              else
+                nil
             end
           end
         end
@@ -47,14 +49,8 @@ module Her
       #   @user.articles # => [#<Article(articles/2) id=2 title="Hello world.">]
       #   # Fetched via GET "/users/1/articles"
       def has_many(name, attrs={}) # {{{
-        @her_relationships ||= {}
         attrs = { :class_name => name.to_s.classify, :name => name }.merge(attrs)
-        (@her_relationships[:has_many] ||= []) << attrs
-
-        define_method(name) do
-          return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          Object.const_get(attrs[:class_name]).get_collection("#{self.class.build_request_path(:id => id)}/#{name.to_s.pluralize}")
-        end
+        define_relationship(:has_many, attrs)
       end # }}}
 
       # Define an *has_one* relationship.
@@ -76,14 +72,8 @@ module Her
       #   @user.organization # => #<Organization(organizations/2) id=2 name="Foobar Inc.">
       #   # Fetched via GET "/users/1/organization"
       def has_one(name, attrs={}) # {{{
-        @her_relationships ||= {}
-        attrs = { :class_name => name.to_s.classify, :name => name, :foreign_key => "#{name}_id" }.merge(attrs)
-        (@her_relationships[:has_one] ||= []) << attrs
-
-        define_method(name) do
-          return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          Object.const_get(attrs[:class_name]).get_resource("#{self.class.build_request_path(:id => id)}/#{name.to_s.singularize}")
-        end
+        attrs = { :class_name => name.to_s.classify, :name => name }.merge(attrs)
+        define_relationship(:has_one, attrs)
       end # }}}
 
       # Define a *belongs_to* relationship.
@@ -105,13 +95,36 @@ module Her
       #   @user.team # => #<Team(teams/2) id=2 name="Developers">
       #   # Fetched via GET "/teams/2"
       def belongs_to(name, attrs={}) # {{{
-        @her_relationships ||= {}
         attrs = { :class_name => name.to_s.classify, :name => name, :foreign_key => "#{name}_id" }.merge(attrs)
-        (@her_relationships[:belongs_to] ||= []) << attrs
+        define_relationship(:belongs_to, attrs)
+      end # }}}
 
+      private
+      # @private
+      def define_relationship(type, attrs) # {{{
+        @her_relationships ||= {}
+        (@her_relationships[type] ||= []) << attrs
+        relationship_accessor(type, attrs)
+      end # }}}
+
+      # @private
+      def relationship_accessor(type, attrs) # {{{
+        name = attrs[:name]
+        class_name = attrs[:class_name]
         define_method(name) do
-          return @data[name] if @data.include?(name) # Do not fetch from API again if we have it in @data
-          Object.const_get(attrs[:class_name]).get_resource("#{Object.const_get(name.to_s.classify).build_request_path(:id => @data["#{name}_id".to_sym])}")
+          return @data[name] if @data.include?(name)
+
+          klass = Object.const_get(class_name)
+          path = self.class.build_request_path(:id => id)
+          @data[name] = case type
+            when :belongs_to
+              foreign_key = attrs[:foreign_key].to_sym
+              klass.get_resource("#{klass.build_request_path(:id => @data[foreign_key])}")
+            when :has_many
+              klass.get_collection("#{path}/#{name.to_s.pluralize}")
+            when :has_one
+              klass.get_resource("#{path}/#{name.to_s.singularize}")
+          end
         end
       end # }}}
     end