her 0.1.5 → 0.1.6

data/README.md

@@ -166,6 +166,23 @@ For `belongs_to` relationship, an extra HTTP request (to `GET /organizations/2`)
 
 However, subsequent calls to `#comments` or `#role` will not trigger the extra HTTP request.
 
+## Hooks
+
+You can add *before* and *after* hooks to your models that are triggered on specific actions (`save`, `update`, `create`, `destroy`):
+
+```ruby
+class User
+  include Her::Model
+  before_save :set_internal_id
+
+  def set_internal_id
+    self.internal_id = 42 # Will be passed in the HTTP request
+  end
+end
+```
+
+In the future, adding hooks to all models will be possible, as well as defining and triggering your own hooks (eg. for your custom requests).
+
 ## Custom requests
 
 You can easily add custom methods for your models. You can either use `get_collection` (which maps the returned data to a collection of resources), `get_resource` (which maps the returned data to a single resource) or `get_raw` (which yields the parsed data return from the HTTP request). Other HTTP methods are supported (`post_raw`, `put_resource`, etc.)
@@ -224,7 +241,6 @@ Category.all
 
 ## Things to be done
 
-* Deleting resources
 * Support for Faraday middleware to handle caching, alternative formats, etc.
 * Hooks before save, update, create, destroy, etc.
 * Better error handling

data/lib/her/model.rb

@@ -14,6 +14,7 @@ module Her
     autoload :HTTP,          "her/model/http"
     autoload :ORM,           "her/model/orm"
     autoload :Relationships, "her/model/relationships"
+    autoload :Hooks,         "her/model/hooks"
 
     extend ActiveSupport::Concern
 
@@ -26,6 +27,7 @@ module Her
       extend Her::Model::HTTP
       extend Her::Model::ORM
       extend Her::Model::Relationships
+      extend Her::Model::Hooks
 
       # Define default settings
       collection_path "#{self.to_s.downcase.pluralize}"

data/lib/her/model/hooks.rb

@@ -0,0 +1,40 @@
+module Her
+  module Model
+    module Hooks
+      # Return hooks
+      # @private
+      def hooks # {{{
+        @her_hooks
+      end # }}}
+
+      # @private
+      def set_hook(time, name, action) # {{{
+        @her_hooks ||= {}
+        (@her_hooks["#{time}_#{name}".to_sym] ||= []) << action
+      end # }}}
+
+      # @private
+      def perform_hook(record, time, name) # {{{
+        @her_hooks ||= {}
+        hooks = @her_hooks["#{time}_#{name}".to_sym] || []
+        hooks.each do |hook|
+          if hook.is_a? Symbol
+            record.send(hook)
+          else
+            hook.call(record)
+          end
+        end
+      end # }}}
+
+      def before_save(method=nil, &block); set_hook(:before, :save, method || block); end
+      def before_create(method=nil, &block); set_hook(:before, :create, method || block); end
+      def before_update(method=nil, &block); set_hook(:before, :update, method || block); end
+      def before_destroy(method=nil, &block); set_hook(:before, :destroy, method || block); end
+
+      def after_save(method=nil, &block); set_hook(:after, :save, method || block); end
+      def after_create(method=nil, &block); set_hook(:after, :create, method || block); end
+      def after_update(method=nil, &block); set_hook(:after, :update, method || block); end
+      def after_destroy(method=nil, &block); set_hook(:after, :destroy, method || block); end
+    end # }}}
+  end
+end

data/lib/her/model/orm.rb

@@ -20,14 +20,14 @@ module Her
       def method_missing(method, attrs=nil) # {{{
         assignment_method = method.to_s =~ /\=$/
         method = method.to_s.gsub(/(\?|\!|\=)$/, "").to_sym
-        if @data.include?(method)
-          if attrs and assignment_method
-            @data[method.to_s.gsub(/\=$/, "").to_sym] = attrs
-          else
+        if attrs and assignment_method
+          @data[method.to_s.gsub(/\=$/, "").to_sym] = attrs
+        else
+          if @data.include?(method)
             @data[method]
+          else
+            super
           end
-        else
-          super
         end
       end # }}}
 
@@ -38,6 +38,9 @@ module Her
       end # }}}
 
       # Fetch a specific resource based on an ID
+      #
+      # @example
+      #   @user = User.find(1) GET /users/1
       def find(id, params={}) # {{{
         request(params.merge(:_method => :get, :_path => "#{@her_collection_path}/#{id}")) do |parsed_data|
           new(parsed_data[:data])
@@ -45,28 +48,100 @@ module Her
       end # }}}
 
       # Fetch a collection of resources
+      #
+      # @example
+      #   @users = User.all # GET /users
       def all(params={}) # {{{
         request(params.merge(:_method => :get, :_path => "#{@her_collection_path}")) do |parsed_data|
           new_collection(parsed_data)
         end
       end # }}}
 
-      # Create a resource
+      # Create a resource and return it
+      #
+      # @example
+      #   @user = User.create({ :fullname => "Tobias Fünke" }) # 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 => "#{@her_collection_path}")) do |parsed_data|
-          new(parsed_data[:data])
+          resource.instance_eval do
+            @data = parsed_data[:data]
+          end
         end
+        perform_hook(resource, :after, :save)
+        perform_hook(resource, :after, :create)
+
+        resource
+      end # }}}
+
+      # Save an existing resource and return it
+      #
+      # @example
+      #   @user = User.save_existing(1, { :fullname => "Tobias Fünke" }) # PUT /users/1
+      def save_existing(id, params) # {{{
+        resource = new(params.merge(:id => id))
+        resource.save
       end # }}}
 
       # Save a resource
+      #
+      # @example Save a resource after fetching it
+      #   @user = User.find(1) # GET /users/1
+      #   @user.fullname = "Tobias Fünke"
+      #   @user.save # PUT /users/1
+      #
+      # @example Save a new resource by creating it
+      #   @user = User.new({ :fullname => "Tobias Fünke" })
+      #   @user.save # POST /users
       def save # {{{
         params = @data.dup
         if @data[:id]
+          self.class.perform_hook(self, :before, :update)
+          self.class.perform_hook(self, :before, :save)
           self.class.request(params.merge(:_method => :put, :_path => "#{self.class.collection_path}/#{id}")) do |parsed_data|
             @data = parsed_data[:data]
           end
+          self.class.perform_hook(self, :after, :save)
+          self.class.perform_hook(self, :after, :update)
+          self
         else
-          self.class.create(params)
+          self.class.perform_hook(self, :before, :create)
+          self.class.perform_hook(self, :before, :save)
+          self.class.request(params.merge(:_method => :post, :_path => "#{self.class.collection_path}")) do |parsed_data|
+            @data = parsed_data[:data]
+          end
+          self.class.perform_hook(self, :after, :save)
+          self.class.perform_hook(self, :after, :create)
+        end
+        self
+      end # }}}
+
+      # Destroy a resource
+      #
+      # @example
+      #   @user = User.find(1) # GET /users/1
+      #   @user.destroy # DELETE /users/1
+      def destroy # {{{
+        params = @data.dup
+        self.class.perform_hook(self, :before, :destroy)
+        self.class.request(params.merge(:_method => :delete, :_path => "#{self.class.collection_path}/#{id}")) do |parsed_data|
+          @data = parsed_data[:data]
+        end
+        self.class.perform_hook(self, :after, :destroy)
+        self
+      end # }}}
+
+      # Destroy an existing resource
+      #
+      # @example
+      #   User.destroy_existing(1) # DELETE /users/1
+      def destroy_existing(id) # {{{
+        params = {}
+        request(params.merge(:_method => :delete, :_path => "#{collection_path}/#{id}")) do |parsed_data|
+          new(parsed_data[:data])
         end
       end # }}}
     end

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/model/hooks_spec.rb

@@ -0,0 +1,264 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Her::Model::Hooks do
+  context "adding hooks to a model" do
+    before do # {{{
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+    end # }}}
+
+    describe "method hooks" do
+    it "handles “before save” method hooks" do # {{{
+      User.before_save :set_internal_id
+      User.hooks[:before_save].length.should == 1
+      User.hooks[:before_save].first.class.should == Symbol
+    end # }}}
+
+    it "handles “before create” method hooks" do # {{{
+      User.before_create :set_internal_id
+      User.hooks[:before_create].length.should == 1
+      User.hooks[:before_create].first.class.should == Symbol
+    end # }}}
+
+    it "handles “before update” method hooks" do # {{{
+      User.before_update :set_internal_id
+      User.hooks[:before_update].length.should == 1
+      User.hooks[:before_update].first.class.should == Symbol
+    end # }}}
+
+    it "handles “before destroy” method hooks" do # {{{
+      User.before_destroy :set_internal_id
+      User.hooks[:before_destroy].length.should == 1
+      User.hooks[:before_destroy].first.class.should == Symbol
+    end # }}}
+
+    it "handles “after save” method hooks" do # {{{
+      User.after_save :set_internal_id
+      User.hooks[:after_save].length.should == 1
+      User.hooks[:after_save].first.class.should == Symbol
+    end # }}}
+
+    it "handles “after create” method hooks" do # {{{
+      User.after_create :set_internal_id
+      User.hooks[:after_create].length.should == 1
+      User.hooks[:after_create].first.class.should == Symbol
+    end # }}}
+
+    it "handles “after update” method hooks" do # {{{
+      User.after_update :set_internal_id
+      User.hooks[:after_update].length.should == 1
+      User.hooks[:after_update].first.class.should == Symbol
+    end # }}}
+
+    it "handles “after destroy” method hooks" do # {{{
+      User.after_destroy :set_internal_id
+      User.hooks[:after_destroy].length.should == 1
+      User.hooks[:after_destroy].first.class.should == Symbol
+    end # }}}
+    end
+
+    describe "block hooks" do
+    it "handles “before save” block hooks" do # {{{
+      User.before_save { |record| record.internal_id = 42 }
+      User.hooks[:before_save].length.should == 1
+      User.hooks[:before_save].first.class.should == Proc
+    end # }}}
+
+    it "handles “before create” block hooks" do # {{{
+      User.before_create { |record| record.internal_id = 42 }
+      User.hooks[:before_create].length.should == 1
+      User.hooks[:before_create].first.class.should == Proc
+    end # }}}
+
+    it "handles “before update” block hooks" do # {{{
+      User.before_update { |record| record.internal_id = 42 }
+      User.hooks[:before_update].length.should == 1
+      User.hooks[:before_update].first.class.should == Proc
+    end # }}}
+
+    it "handles “before destroy” block hooks" do # {{{
+      User.before_destroy { |record| record.internal_id = 42 }
+      User.hooks[:before_destroy].length.should == 1
+      User.hooks[:before_destroy].first.class.should == Proc
+    end # }}}
+
+    it "handles “after save” block hooks" do # {{{
+      User.after_save { |record| record.internal_id = 42 }
+      User.hooks[:after_save].length.should == 1
+      User.hooks[:after_save].first.class.should == Proc
+    end # }}}
+
+    it "handles “after create” block hooks" do # {{{
+      User.after_create { |record| record.internal_id = 42 }
+      User.hooks[:after_create].length.should == 1
+      User.hooks[:after_create].first.class.should == Proc
+    end # }}}
+
+    it "handles “after update” block hooks" do # {{{
+      User.after_update { |record| record.internal_id = 42 }
+      User.hooks[:after_update].length.should == 1
+      User.hooks[:after_update].first.class.should == Proc
+    end # }}}
+
+    it "handles “after destroy” block hooks" do # {{{
+      User.after_destroy { |record| record.internal_id = 42 }
+      User.hooks[:after_destroy].length.should == 1
+      User.hooks[:after_destroy].first.class.should == Proc
+    end # }}}
+    end
+  end
+
+  context "perform hooks on a model" do
+      before do # {{{
+        Her::API.setup :base_uri => "https://api.example.com"
+        FakeWeb.register_uri(:post, "https://api.example.com/users", :body => { :data => { :id => 1, :name => "Tobias Fünke" } }.to_json)
+        FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1, :name => "Tobias Fünke" } }.to_json)
+        FakeWeb.register_uri(:put, "https://api.example.com/users/1", :body => { :data => { :id => 1, :name => "Tobias Fünke" } }.to_json)
+        FakeWeb.register_uri(:delete, "https://api.example.com/users/1", :body => { :data => { :id => 1, :name => "Tobias Fünke" } }.to_json)
+
+        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+        class User
+          include Her::Model
+          attr_accessor :internal_save_id, :internal_create_id, :internal_update_id, :internal_destroy_id
+          attr_accessor :internal_after_save_id, :internal_after_create_id, :internal_after_update_id, :internal_after_destroy_id
+
+          def change_internal_save_id; @internal_save_id = 100; end
+          def change_internal_create_id; @internal_create_id = 101; end
+          def change_internal_update_id; @internal_update_id = 102; end
+          def change_internal_destroy_id; @internal_destroy_id = 103; end
+
+          def change_internal_after_save_id; @internal_after_save_id = 100; end
+          def change_internal_after_create_id; @internal_after_create_id = 101; end
+          def change_internal_after_update_id; @internal_after_update_id = 102; end
+          def change_internal_after_destroy_id; @internal_after_destroy_id = 103; end
+        end
+      end # }}}
+
+    describe "method hooks" do
+      before do # {{{
+        User.before_save :change_internal_save_id
+        User.before_update :change_internal_update_id
+        User.before_create :change_internal_create_id
+        User.before_destroy :change_internal_destroy_id
+
+        User.after_save :change_internal_after_save_id
+        User.after_update :change_internal_after_update_id
+        User.after_create :change_internal_after_create_id
+        User.after_destroy :change_internal_after_destroy_id
+      end # }}}
+
+      it "perform “before save” “before create” method hook on Model#save without an ID" do # {{{
+        @user = User.new(:fullname => "Tobias Fünke")
+        @user.save
+        @user.internal_save_id.should == 100
+        @user.internal_create_id.should == 101
+        @user.internal_update_id.should == nil
+      end # }}}
+
+      it "perform “before save” and “before update” method hook on Model#save with an ID" do # {{{
+        @user = User.find(1)
+        @user.save
+        @user.internal_save_id.should == 100
+        @user.internal_create_id.should == nil
+        @user.internal_update_id.should == 102
+      end # }}}
+
+      it "perform “before destroy” method hook on Model#destroy" do # {{{
+        @user = User.find(1)
+        @user.destroy
+        @user.internal_save_id.should == nil
+        @user.internal_create_id.should == nil
+        @user.internal_update_id.should == nil
+        @user.internal_destroy_id.should == 103
+      end # }}}
+
+      it "perform “after save” “after create” method hook on Model#save without an ID" do # {{{
+        @user = User.new(:fullname => "Tobias Fünke")
+        @user.save
+        @user.internal_after_save_id.should == 100
+        @user.internal_after_create_id.should == 101
+        @user.internal_after_update_id.should == nil
+      end # }}}
+
+      it "perform “after save” “after update” method hook on Model#save with an ID" do # {{{
+        @user = User.find(1)
+        @user.save
+        @user.internal_after_save_id.should == 100
+        @user.internal_after_create_id.should == nil
+        @user.internal_after_update_id.should == 102
+      end # }}}
+
+      it "perform “after save” “after update” method hook on Model.save_existing" do # {{{
+        @user = User.save_existing(1, { :fullname => "Tobias Fünke" })
+        @user.internal_after_save_id.should == 100
+        @user.internal_after_create_id.should == nil
+        @user.internal_after_update_id.should == 102
+      end # }}}
+
+      it "perform “after save” “after create” method hook on Model.create" do # {{{
+        @user = User.create({ :fullname => "Tobias Fünke" })
+        @user.internal_after_save_id.should == 100
+        @user.internal_after_create_id.should == 101
+        @user.internal_after_update_id.should == nil
+      end # }}}
+    end
+
+    describe "block hooks" do
+      before do # {{{
+        User.before_save { |record| record.internal_save_id = 200 }
+        User.before_create { |record| record.internal_create_id = 201 }
+        User.before_update { |record| record.internal_update_id = 202 }
+        User.before_destroy { |record| record.internal_destroy_id = 203 }
+
+        User.after_save { |record| record.internal_after_save_id = 200 }
+        User.after_create { |record| record.internal_after_create_id = 201 }
+        User.after_update { |record| record.internal_after_update_id = 202 }
+        User.after_destroy { |record| record.internal_after_destroy_id = 203 }
+      end # }}}
+
+      it "perform “before save” and “before create” block hook on Model#save without an ID" do # {{{
+        @user = User.new(:fullname => "Tobias Fünke")
+        @user.save
+        @user.internal_save_id.should == 200
+        @user.internal_create_id.should == 201
+        @user.internal_update_id.should == nil
+      end # }}}
+
+      it "perform “before save” and “before update” block hook on Model#save with an ID" do # {{{
+        @user = User.find(1)
+        @user.save
+        @user.internal_save_id.should == 200
+        @user.internal_create_id.should == nil
+        @user.internal_update_id.should == 202
+      end # }}}
+
+      it "perform “before destroy” block hook on Model#destroy" do # {{{
+        @user = User.find(1)
+        @user.destroy
+        @user.internal_save_id.should == nil
+        @user.internal_create_id.should == nil
+        @user.internal_update_id.should == nil
+        @user.internal_destroy_id.should == 203
+      end # }}}
+
+      it "perform “after save” “after create” block hook on Model#save without an ID" do # {{{
+        @user = User.new(:fullname => "Tobias Fünke")
+        @user.save
+        @user.internal_after_save_id.should == 200
+        @user.internal_after_create_id.should == 201
+        @user.internal_after_update_id.should == nil
+      end # }}}
+
+      it "perform “after save” “after update” block hook on Model#save with an ID" do # {{{
+        @user = User.find(1)
+        @user.save
+        @user.internal_after_save_id.should == 200
+        @user.internal_after_create_id.should == nil
+        @user.internal_after_update_id.should == 202
+      end # }}}
+    end
+  end
+end

data/spec/model/http_spec.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Her::Model::HTTP do
+  context "binding a model with an API" do
+    it "binds a model to an instance of Her::API" do # {{{
+      @api = Her::API.new
+      @api.setup :base_uri => "https://api.example.com"
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+      User.uses_api @api
+
+      User.class_eval do
+        @her_api.should_not == nil
+        @her_api.base_uri.should == "https://api.example.com"
+      end
+    end # }}}
+
+    it "binds a model directly to Her::API" do # {{{
+      Her::API.setup :base_uri => "https://api.example.com"
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+
+      User.class_eval do
+        @her_api.should_not == nil
+        @her_api.base_uri.should == "https://api.example.com"
+      end
+    end # }}}
+
+    it "binds two models to two different instances of Her::API" do # {{{
+      @api1 = Her::API.new
+      @api1.setup :base_uri => "https://api1.example.com"
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User; include Her::Model; end
+      User.uses_api @api1
+
+      User.class_eval do
+        @her_api.base_uri.should == "https://api1.example.com"
+      end
+
+      @api2 = Her::API.new
+      @api2.setup :base_uri => "https://api2.example.com"
+
+      Object.instance_eval { remove_const :Comment } if Object.const_defined?(:Comment)
+      class Comment; include Her::Model; end
+      Comment.uses_api @api2
+
+      Comment.class_eval do
+        @her_api.base_uri.should == "https://api2.example.com"
+      end
+    end # }}}
+
+    it "binds one model to Her::API and another one to an instance of Her::API" do # {{{
+      Her::API.setup :base_uri => "https://api1.example.com"
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User; include Her::Model; end
+
+      User.class_eval do
+        @her_api.base_uri.should == "https://api1.example.com"
+      end
+
+      @api = Her::API.new
+      @api.setup :base_uri => "https://api2.example.com"
+
+      Object.instance_eval { remove_const :Comment } if Object.const_defined?(:Comment)
+      class Comment; include Her::Model; end
+      Comment.uses_api @api
+
+      Comment.class_eval do
+        @her_api.base_uri.should == "https://api2.example.com"
+      end
+    end # }}}
+  end
+
+  context "making HTTP requests" do
+    before do # {{{
+      @api = Her::API.new
+      @api.setup :base_uri => "https://api.example.com"
+      FakeWeb.register_uri(:get, "https://api.example.com/users", :body => { :data => [{ :id => 1 }] }.to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/users?page=2", :body => { :data => [{ :id => 2 }] }.to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/users/popular", :body => { :data => [{ :id => 1 }, { :id => 2 }] }.to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1 } }.to_json)
+      FakeWeb.register_uri(:post, "https://api.example.com/users", :body => { :data => [{ :id => 3 }] }.to_json)
+      FakeWeb.register_uri(:put, "https://api.example.com/users/4", :body => { :data => [{ :id => 4 }] }.to_json)
+      FakeWeb.register_uri(:patch, "https://api.example.com/users/6", :body => { :data => [{ :id => 6 }] }.to_json)
+      FakeWeb.register_uri(:delete, "https://api.example.com/users/5", :body => { :data => [{ :id => 5 }] }.to_json)
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+      User.uses_api @api
+    end # }}}
+
+    it "handle raw GET" do # {{{
+      User.get_raw("/users") do |parsed_data|
+        parsed_data[:data].should == [{ :id => 1 }]
+      end
+    end # }}}
+
+    it "handle raw POST" do # {{{
+      User.post_raw("/users") do |parsed_data|
+        parsed_data[:data].should == [{ :id => 3 }]
+      end
+    end # }}}
+
+    it "handle raw PUT" do # {{{
+      User.put_raw("/users/4") do |parsed_data|
+        parsed_data[:data].should == [{ :id => 4 }]
+      end
+    end # }}}
+
+    it "handle raw PATCH" do # {{{
+      User.patch_raw("/users/6") do |parsed_data|
+        parsed_data[:data].should == [{ :id => 6 }]
+      end
+    end # }}}
+
+    it "handle raw DELETE" do # {{{
+      User.delete_raw("/users/5") do |parsed_data|
+        parsed_data[:data].should == [{ :id => 5 }]
+      end
+    end # }}}
+
+    it "handle querystring parameters" do # {{{
+      User.get_raw("/users", :page => 2) do |parsed_data|
+        parsed_data[:data].should == [{ :id => 2 }]
+      end
+    end # }}}
+
+    it "handle GET collection" do # {{{
+      @users = User.get_collection("/users/popular")
+      @users.length.should == 2
+      @users.first.id.should == 1
+    end # }}}
+
+    it "handle GET resource" do # {{{
+      @user = User.get_resource("/users/1")
+      @user.id.should == 1
+    end # }}}
+  end
+end

data/spec/model/orm_spec.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Her::Model::ORM do
+  context "mapping data to Ruby objects" do
+    before do # {{{
+      @api = Her::API.new
+      @api.setup :base_uri => "https://api.example.com"
+      FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1, :name => "Tobias Fünke" } }.to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/users", :body => { :data => [{ :id => 1, :name => "Tobias Fünke" }, { :id => 2, :name => "Lindsay Fünke" }] }.to_json)
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+      User.uses_api @api
+    end # }}}
+
+    it "maps a single resource to a Ruby object" do # {{{
+      @user = User.find(1)
+      @user.id.should == 1
+      @user.name.should == "Tobias Fünke"
+    end # }}}
+
+    it "maps a collection of resources to an array of Ruby objects" do # {{{
+      @users = User.all
+      @users.length.should == 2
+      @users.first.name.should == "Tobias Fünke"
+    end # }}}
+  end
+
+  context "creating resources" do
+    before do # {{{
+      Her::API.setup :base_uri => "https://api.example.com"
+      FakeWeb.register_uri(:post, "https://api.example.com/users", :body => { :data => { :id => 1, :fullname => "Tobias Fünke" } }.to_json)
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+    end # }}}
+
+    it "handle one-line resource creation" do # {{{
+      @user = User.create(:fullname => "Tobias Fünke")
+      @user.id.should == 1
+      @user.fullname.should == "Tobias Fünke"
+    end # }}}
+
+    it "handle resource creation through Model.new + #save" do # {{{
+      @user = User.new(:fullname => "Tobias Fünke")
+      @user.save
+      @user.fullname.should == "Tobias Fünke"
+    end # }}}
+  end
+
+  context "updating resources" do
+    before do # {{{
+      @api = Her::API.new
+      @api.setup :base_uri => "https://api.example.com"
+      FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1, :fullname => "Tobias Fünke" } }.to_json)
+      FakeWeb.register_uri(:put, "https://api.example.com/users/1", :body => { :data => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json)
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+    end # }}}
+
+    it "handle resource data update without saving it" do # {{{
+      @user = User.find(1)
+      @user.fullname.should == "Tobias Fünke"
+      @user.fullname = "Kittie Sanchez"
+      @user.fullname.should == "Kittie Sanchez"
+    end # }}}
+
+    it "handle resource update through the .update class method" do # {{{
+      @user = User.save_existing(1, { :fullname => "Lindsay Fünke" })
+      @user.fullname.should == "Lindsay Fünke"
+    end # }}}
+
+    it "handle resource update through #save on an existing resource" do # {{{
+      @user = User.find(1)
+      @user.fullname = "Lindsay Fünke"
+      @user.save
+      @user.fullname.should == "Lindsay Fünke"
+    end # }}}
+  end
+
+  context "deleting resources" do
+    before do # {{{
+      @api = Her::API.new
+      @api.setup :base_uri => "https://api.example.com"
+      FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1, :fullname => "Tobias Fünke", :active => true } }.to_json)
+      FakeWeb.register_uri(:delete, "https://api.example.com/users/1", :body => { :data => { :id => 1, :fullname => "Lindsay Fünke", :active => false } }.to_json)
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+    end # }}}
+
+    it "handle resource deletion through the .destroy class method" do # {{{
+      @user = User.destroy_existing(1)
+      @user.active.should be_false
+    end # }}}
+
+    it "handle resource deletion through #destroy on an existing resource" do # {{{
+      @user = User.find(1)
+      @user.destroy
+      @user.active.should be_false
+    end # }}}
+  end
+end

data/spec/model/relationships_spec.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Her::Model::Relationships do
+  context "setting relationships" do
+    before do # {{{
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+      end
+    end # }}}
+
+    it "handles a single 'has_many' relationship" do # {{{
+      User.has_many :comments
+      User.relationships[:has_many].should == [{ :name => :comments }]
+    end # }}}
+
+    it "handles multiples 'has_many' relationship" do # {{{
+      User.has_many :comments
+      User.has_many :posts
+      User.relationships[:has_many].should == [{ :name => :comments }, { :name => :posts }]
+    end # }}}
+
+    it "handles a single 'has_one' relationship" do # {{{
+      User.has_one :category
+      User.relationships[:has_one].should == [{ :name => :category }]
+    end # }}}
+
+    it "handles multiples 'has_one' relationship" do # {{{
+      User.has_one :category
+      User.has_one :role
+      User.relationships[:has_one].should == [{ :name => :category }, { :name => :role }]
+    end # }}}
+
+    it "handles a single belongs_to relationship" do # {{{
+      User.belongs_to :organization
+      User.relationships[:belongs_to].should == [{ :name => :organization }]
+    end # }}}
+
+    it "handles multiples 'belongs_to' relationship" do # {{{
+      User.belongs_to :organization
+      User.belongs_to :family
+      User.relationships[:belongs_to].should == [{ :name => :organization }, { :name => :family }]
+    end # }}}
+  end
+
+  context "handling relationships" do
+    before do # {{{
+      Her::API.setup :base_uri => "https://api.example.com"
+      FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1, :name => "Tobias Fünke", :comments => [{ :id => 2, :body => "Tobias, you blow hard!" }, { :id => 3, :body => "I wouldn't mind kissing that man between the cheeks, so to speak" }], :role => { :id => 1, :body => "Admin" }, :organization => { :id => 1, :name => "Bluth Company" }, :organization_id => 1 } }.to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/users/2", :body => { :data => { :id => 2, :name => "Lindsay Fünke", :organization_id => 1 } }.to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/users/2/comments", :body => { :data => [{ :id => 4, :body => "They're having a FIRESALE?" }, { :id => 5, :body => "Is this the tiny town from Footloose?" }] }.to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/users/2/role", :body => { :data => { :id => 2, :body => "User" } }.to_json)
+      FakeWeb.register_uri(:get, "https://api.example.com/organizations/1", :body => { :data => { :id => 1, :name => "Bluth Company" } }.to_json)
+
+      Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
+      class User
+        include Her::Model
+        has_many :comments
+        has_one :role
+        belongs_to :organization
+      end
+
+      Object.instance_eval { remove_const :Organization } if Object.const_defined?(:Organization)
+      class Organization
+        include Her::Model
+      end
+
+      Object.instance_eval { remove_const :Comment } if Object.const_defined?(:Comment)
+      class Comment
+        include Her::Model
+      end
+
+      Object.instance_eval { remove_const :Role } if Object.const_defined?(:Role)
+      class Role
+        include Her::Model
+      end
+
+      @user_with_included_data = User.find(1)
+      @user_without_included_data = User.find(2)
+    end # }}}
+
+    it "maps an array of included data through has_many" do # {{{
+      @user_with_included_data.comments.length.should == 2
+      @user_with_included_data.comments.first.id.should == 2
+      @user_with_included_data.comments.first.body.should == "Tobias, you blow hard!"
+    end # }}}
+
+    it "fetches data that was not included through has_many" do # {{{
+      @user_without_included_data.comments.length.should == 2
+      @user_without_included_data.comments.first.id.should == 4
+      @user_without_included_data.comments.first.body.should == "They're having a FIRESALE?"
+    end # }}}
+
+    it "maps an array of included data through has_one" do # {{{
+      @user_with_included_data.role.id.should == 1
+      @user_with_included_data.role.body.should == "Admin"
+    end # }}}
+
+    it "fetches data that was not included through has_one" do # {{{
+      @user_without_included_data.role.id.should == 2
+      @user_without_included_data.role.body.should == "User"
+    end # }}}
+
+    it "maps an array of included data through belongs_to" do # {{{
+      @user_with_included_data.organization.id.should == 1
+      @user_with_included_data.organization.name.should == "Bluth Company"
+    end # }}}
+
+    it "fetches data that was not included through belongs_to" do # {{{
+      @user_without_included_data.organization.id.should == 1
+      @user_without_included_data.organization.name.should == "Bluth Company"
+    end # }}}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-11 00:00:00.000000000Z
+date: 2012-04-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -173,12 +173,16 @@ files:
 - lib/her/api.rb
 - lib/her/model.rb
 - lib/her/model/base.rb
+- lib/her/model/hooks.rb
 - lib/her/model/http.rb
 - lib/her/model/orm.rb
 - lib/her/model/relationships.rb
 - lib/her/version.rb
 - spec/api_spec.rb
-- spec/model_spec.rb
+- spec/model/hooks_spec.rb
+- spec/model/http_spec.rb
+- spec/model/orm_spec.rb
+- spec/model/relationships_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/remiprev/her
 licenses: []
@@ -194,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4167601811325738400
+      hash: 1685847524195482169
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -203,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4167601811325738400
+      hash: 1685847524195482169
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.18
@@ -213,6 +217,9 @@ summary: A simple Representational State Transfer-based Hypertext Transfer Proto
   Object Relational Mapper. Her?
 test_files:
 - spec/api_spec.rb
-- spec/model_spec.rb
+- spec/model/hooks_spec.rb
+- spec/model/http_spec.rb
+- spec/model/orm_spec.rb
+- spec/model/relationships_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/model_spec.rb

@@ -1,336 +0,0 @@
-# encoding: utf-8
-require File.join(File.dirname(__FILE__), "spec_helper.rb")
-
-describe Her::Model do
-  describe Her::Model::HTTP do
-    context "binding a model with an API" do
-      it "binds a model to an instance of Her::API" do # {{{
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com"
-
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User
-          include Her::Model
-        end
-        User.uses_api @api
-
-        User.class_eval do
-          @her_api.should_not == nil
-          @her_api.base_uri.should == "https://api.example.com"
-        end
-      end # }}}
-
-      it "binds a model directly to Her::API" do # {{{
-        Her::API.setup :base_uri => "https://api.example.com"
-
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User
-          include Her::Model
-        end
-
-        User.class_eval do
-          @her_api.should_not == nil
-          @her_api.base_uri.should == "https://api.example.com"
-        end
-      end # }}}
-
-      it "binds two models to two different instances of Her::API" do # {{{
-        @api1 = Her::API.new
-        @api1.setup :base_uri => "https://api1.example.com"
-
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User; include Her::Model; end
-        User.uses_api @api1
-
-        User.class_eval do
-          @her_api.base_uri.should == "https://api1.example.com"
-        end
-
-        @api2 = Her::API.new
-        @api2.setup :base_uri => "https://api2.example.com"
-
-        Object.instance_eval { remove_const :Comment } if Object.const_defined?(:Comment)
-        class Comment; include Her::Model; end
-        Comment.uses_api @api2
-
-        Comment.class_eval do
-          @her_api.base_uri.should == "https://api2.example.com"
-        end
-      end # }}}
-
-      it "binds one model to Her::API and another one to an instance of Her::API" do # {{{
-        Her::API.setup :base_uri => "https://api1.example.com"
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User; include Her::Model; end
-
-        User.class_eval do
-          @her_api.base_uri.should == "https://api1.example.com"
-        end
-
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api2.example.com"
-
-        Object.instance_eval { remove_const :Comment } if Object.const_defined?(:Comment)
-        class Comment; include Her::Model; end
-        Comment.uses_api @api
-
-        Comment.class_eval do
-          @her_api.base_uri.should == "https://api2.example.com"
-        end
-      end # }}}
-    end
-
-    context "making HTTP requests" do
-      before do # {{{
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com"
-        FakeWeb.register_uri(:get, "https://api.example.com/users", :body => { :data => [{ :id => 1 }] }.to_json)
-        FakeWeb.register_uri(:get, "https://api.example.com/users?page=2", :body => { :data => [{ :id => 2 }] }.to_json)
-        FakeWeb.register_uri(:get, "https://api.example.com/users/popular", :body => { :data => [{ :id => 1 }, { :id => 2 }] }.to_json)
-        FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1 } }.to_json)
-        FakeWeb.register_uri(:post, "https://api.example.com/users", :body => { :data => [{ :id => 3 }] }.to_json)
-        FakeWeb.register_uri(:put, "https://api.example.com/users/4", :body => { :data => [{ :id => 4 }] }.to_json)
-        FakeWeb.register_uri(:patch, "https://api.example.com/users/6", :body => { :data => [{ :id => 6 }] }.to_json)
-        FakeWeb.register_uri(:delete, "https://api.example.com/users/5", :body => { :data => [{ :id => 5 }] }.to_json)
-
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User
-          include Her::Model
-        end
-        User.uses_api @api
-      end # }}}
-
-      it "handle raw GET" do # {{{
-        User.get_raw("/users") do |parsed_data|
-          parsed_data[:data].should == [{ :id => 1 }]
-        end
-      end # }}}
-
-      it "handle raw POST" do # {{{
-        User.post_raw("/users") do |parsed_data|
-          parsed_data[:data].should == [{ :id => 3 }]
-        end
-      end # }}}
-
-      it "handle raw PUT" do # {{{
-        User.put_raw("/users/4") do |parsed_data|
-          parsed_data[:data].should == [{ :id => 4 }]
-        end
-      end # }}}
-
-      it "handle raw PATCH" do # {{{
-        User.patch_raw("/users/6") do |parsed_data|
-          parsed_data[:data].should == [{ :id => 6 }]
-        end
-      end # }}}
-
-      it "handle raw DELETE" do # {{{
-        User.delete_raw("/users/5") do |parsed_data|
-          parsed_data[:data].should == [{ :id => 5 }]
-        end
-      end # }}}
-
-      it "handle querystring parameters" do # {{{
-        User.get_raw("/users", :page => 2) do |parsed_data|
-          parsed_data[:data].should == [{ :id => 2 }]
-        end
-      end # }}}
-
-      it "handle GET collection" do # {{{
-        @users = User.get_collection("/users/popular")
-        @users.length.should == 2
-        @users.first.id.should == 1
-      end # }}}
-
-      it "handle GET resource" do # {{{
-        @user = User.get_resource("/users/1")
-        @user.id.should == 1
-      end # }}}
-    end
-  end
-
-  describe Her::Model::ORM do
-    context "mapping data to Ruby objects" do
-      before do # {{{
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com"
-        FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1, :name => "Tobias Fünke" } }.to_json)
-        FakeWeb.register_uri(:get, "https://api.example.com/users", :body => { :data => [{ :id => 1, :name => "Tobias Fünke" }, { :id => 2, :name => "Lindsay Fünke" }] }.to_json)
-
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User
-          include Her::Model
-        end
-        User.uses_api @api
-      end # }}}
-
-      it "maps a single resource to a Ruby object" do # {{{
-        @user = User.find(1)
-        @user.id.should == 1
-        @user.name.should == "Tobias Fünke"
-      end # }}}
-
-      it "maps a collection of resources to an array of Ruby objects" do # {{{
-        @users = User.all
-        @users.length.should == 2
-        @users.first.name.should == "Tobias Fünke"
-      end # }}}
-    end
-
-    context "creating resources" do
-      before do # {{{
-        Her::API.setup :base_uri => "https://api.example.com"
-        FakeWeb.register_uri(:post, "https://api.example.com/users", :body => { :data => { :id => 1, :fullname => "Tobias Fünke" } }.to_json)
-
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User
-          include Her::Model
-        end
-      end # }}}
-
-      it "handle one-line resource creation" do # {{{
-        @user = User.create(:fullname => "Tobias Fünke")
-        @user.id.should == 1
-        @user.fullname.should == "Tobias Fünke"
-      end # }}}
-
-      it "handle resource creation through Model.new + #save" do # {{{
-        @user = User.new(:fullname => "Tobias Fünke")
-        @user.save
-        @user.fullname.should == "Tobias Fünke"
-      end # }}}
-    end
-
-    context "updating resources" do
-      before do # {{{
-        @api = Her::API.new
-        @api.setup :base_uri => "https://api.example.com"
-        FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1, :fullname => "Tobias Fünke" } }.to_json)
-        FakeWeb.register_uri(:put, "https://api.example.com/users/1", :body => { :data => { :id => 1, :fullname => "Lindsay Fünke" } }.to_json)
-
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User
-          include Her::Model
-        end
-      end # }}}
-
-      it "handle resource data update without saving it" do # {{{
-        @user = User.find(1)
-        @user.fullname.should == "Tobias Fünke"
-        @user.fullname = "Kittie Sanchez"
-        @user.fullname.should == "Kittie Sanchez"
-      end # }}}
-
-      it "handle resource update through #save on an existing resource" do # {{{
-        @user = User.find(1)
-        @user.fullname = "Lindsay Fünke"
-        @user.save
-        @user.fullname.should == "Lindsay Fünke"
-      end # }}}
-    end
-  end
-
-  describe Her::Model::Relationships do
-    context "setting relationships" do
-      before do # {{{
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User
-          include Her::Model
-        end
-      end # }}}
-
-      it "handles a single 'has_many' relationship" do # {{{
-        User.has_many :comments
-        User.relationships[:has_many].should == [{ :name => :comments }]
-      end # }}}
-
-      it "handles multiples 'has_many' relationship" do # {{{
-        User.has_many :comments
-        User.has_many :posts
-        User.relationships[:has_many].should == [{ :name => :comments }, { :name => :posts }]
-      end # }}}
-
-      it "handles a single 'has_one' relationship" do # {{{
-        User.has_one :category
-        User.relationships[:has_one].should == [{ :name => :category }]
-      end # }}}
-
-      it "handles multiples 'has_one' relationship" do # {{{
-        User.has_one :category
-        User.has_one :role
-        User.relationships[:has_one].should == [{ :name => :category }, { :name => :role }]
-      end # }}}
-
-      it "handles a single belongs_to relationship" do # {{{
-        User.belongs_to :organization
-        User.relationships[:belongs_to].should == [{ :name => :organization }]
-      end # }}}
-
-      it "handles multiples 'belongs_to' relationship" do # {{{
-        User.belongs_to :organization
-        User.belongs_to :family
-        User.relationships[:belongs_to].should == [{ :name => :organization }, { :name => :family }]
-      end # }}}
-    end
-
-    context "handling relationships" do
-      before do # {{{
-        Her::API.setup :base_uri => "https://api.example.com"
-        FakeWeb.register_uri(:get, "https://api.example.com/users/1", :body => { :data => { :id => 1, :name => "Tobias Fünke", :comments => [{ :id => 2, :body => "Tobias, you blow hard!" }, { :id => 3, :body => "I wouldn't mind kissing that man between the cheeks, so to speak" }], :role => { :id => 1, :body => "Admin" }, :organization => { :id => 1, :name => "Bluth Company" }, :organization_id => 1 } }.to_json)
-        FakeWeb.register_uri(:get, "https://api.example.com/users/2", :body => { :data => { :id => 2, :name => "Lindsay Fünke", :organization_id => 1 } }.to_json)
-        FakeWeb.register_uri(:get, "https://api.example.com/users/2/comments", :body => { :data => [{ :id => 4, :body => "They're having a FIRESALE?" }, { :id => 5, :body => "Is this the tiny town from Footloose?" }] }.to_json)
-        FakeWeb.register_uri(:get, "https://api.example.com/users/2/role", :body => { :data => { :id => 2, :body => "User" } }.to_json)
-        FakeWeb.register_uri(:get, "https://api.example.com/organizations/1", :body => { :data => { :id => 1, :name => "Bluth Company" } }.to_json)
-
-        Object.instance_eval { remove_const :User } if Object.const_defined?(:User)
-        class User
-          include Her::Model
-          has_many :comments
-          has_one :role
-          belongs_to :organization
-        end
-
-        Object.instance_eval { remove_const :Organization } if Object.const_defined?(:Organization)
-        class Organization
-          include Her::Model
-        end
-
-        Object.instance_eval { remove_const :Comment } if Object.const_defined?(:Comment)
-        class Comment
-          include Her::Model
-        end
-
-        Object.instance_eval { remove_const :Role } if Object.const_defined?(:Role)
-        class Role
-          include Her::Model
-        end
-      end # }}}
-
-      it "maps an array of included data" do # {{{
-        @user = User.find(1)
-        @user.comments.length.should == 2
-        @user.comments.first.id.should == 2
-        @user.comments.first.body.should == "Tobias, you blow hard!"
-
-        @user.role.id.should == 1
-        @user.role.body.should == "Admin"
-
-        @user.organization.id.should == 1
-        @user.organization.name.should == "Bluth Company"
-      end # }}}
-
-      it "fetches data that was not included" do # {{{
-        @user = User.find(2)
-        @user.comments.length.should == 2
-        @user.comments.first.id.should == 4
-        @user.comments.first.body.should == "They're having a FIRESALE?"
-
-        @user.role.id.should == 2
-        @user.role.body.should == "User"
-
-        @user.organization.id.should == 1
-        @user.organization.name.should == "Bluth Company"
-      end # }}}
-    end
-  end
-end