her 0.3.7 → 0.3.8

data/Rakefile

@@ -1,6 +1,5 @@
 require "bundler"
 require "rake"
-require "yard"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
@@ -10,18 +9,3 @@ desc "Run all specs"
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.pattern = "spec/**/*_spec.rb"
 end
-
-desc "Generate YARD Documentation"
-YARD::Rake::YardocTask.new do |task|
-  task.options = [
-    "-o", File.expand_path("../doc", __FILE__),
-    "--readme=README.md",
-    "--markup=markdown",
-    "--markup-provider=redcarpet",
-    "--no-private",
-    "--no-cache",
-    "--protected",
-    "--title=Her",
-  ]
-  task.files   = ["lib/**/*.rb"]
-end

data/{UPGRADE.md → docs/UPGRADE.md}

@@ -1,3 +1,5 @@
+# Upgrade Her
+
 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.2.4

data/her.gemspec

@@ -18,16 +18,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rspec", "~> 2.11"
-  s.add_development_dependency "yard", "~> 0.8"
-  s.add_development_dependency "redcarpet", "~> 2.1"
-  s.add_development_dependency "mocha", "~> 0.12"
-  s.add_development_dependency "guard", "~> 1.2"
-  s.add_development_dependency "guard-rspec", "~> 2.3"
-  s.add_development_dependency "rb-fsevent", "~> 0.9"
-  s.add_development_dependency "growl", "~> 1.0"
+  s.add_development_dependency "rspec", "~> 2.12"
+  s.add_development_dependency "mocha", "~> 0.13"
 
   s.add_runtime_dependency "activesupport", ">= 3.0.0"
   s.add_runtime_dependency "faraday", "~> 0.8"
-  s.add_runtime_dependency "multi_json", "~> 1.3"
+  s.add_runtime_dependency "multi_json", "~> 1.5"
 end

data/lib/her/api.rb

@@ -53,7 +53,7 @@ module Her
       attrs[:url] = attrs.delete(:base_uri) if attrs.include?(:base_uri) # Support legacy :base_uri option
       @base_uri = attrs[:url]
       @options = attrs
-      @connection = Faraday.new(attrs.slice(:url, :ssl)) do |connection|
+      @connection = Faraday.new(@options) do |connection|
         yield connection if block_given?
       end
     end

data/lib/her/model/hooks.rb

@@ -35,6 +35,9 @@ module Her
       # @param [Symbol, &block] method A method or a block to be called
       def before_destroy(method=nil, &block); set_hook(:before, :destroy, method || block); end
 
+      # Do not add a *before find* callback. Only *after find* is supported.
+      def before_find(method=nil, &block); raise NoMethodError, "undefined method `before_find' for #{self}"; end
+
       # Add a *after save* callback. Triggered after a resource is created or updated.
       # @param [Symbol, &block] method A method or a block to be called
       def after_save(method=nil, &block); set_hook(:after, :save, method || block); end
@@ -51,11 +54,15 @@ 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
 
+      # Add a *after find* callback. Triggered after a resource is found.
+      # @param [Symbol, &block] method A method or a block to be called
+      def after_find(method=nil, &block); set_hook(:after, :find, 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)
+        yield(resource, resource.class) if block_given?
         perform_after_hooks(resource, *hooks.reverse)
       end
 

data/lib/her/model/introspection.rb

@@ -12,7 +12,7 @@ module Her
       #   @user = User.find(1)
       #   p @user # => #<User(/users/1) id=1 name="Tobias Fünke">
       def inspect
-        "#<#{self.class}(#{request_path}) #{@data.inject([]) { |memo, item| key, value = item; memo << "#{key}=#{attribute_for_inspect(value)}"}.join(" ")}>"
+        "#<#{self.class}(#{request_path}) #{@data.keys.map { |k| "#{k}=#{attribute_for_inspect(send(k))}" }.join(" ")}>"
       end
 
       private

data/lib/her/model/orm.rb

@@ -23,7 +23,11 @@ module Her
       # Initialize a collection of resources
       # @private
       def self.initialize_collection(klass, parsed_data={})
-        collection_data = parsed_data[:data].map { |item_data| klass.new(item_data) }
+        collection_data = parsed_data[:data].map do |item_data|
+          resource = klass.new(item_data)
+          klass.wrap_in_hooks(resource, :find)
+          resource
+        end
         Her::Collection.new(collection_data, parsed_data[:metadata], parsed_data[:errors])
       end
 
@@ -204,9 +208,12 @@ module Her
         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 => :get, :_path => "#{build_request_path(params.merge(:id => id))}")) do |parsed_data|
-              new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
+              resource = new(parsed_data[:data].merge :_metadata => parsed_data[:data], :_errors => parsed_data[:errors])
+              wrap_in_hooks(resource, :find)
             end
+            resource
           end
           if ids.length > 1 || ids.first.kind_of?(Array)
             results

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/spec/api_spec.rb

@@ -17,6 +17,12 @@ describe Her::API do
         @api.base_uri.should == "https://api.example.com"
       end
 
+      it "supports the base_uri legacy option" do
+        @api = Her::API.new
+        @api.setup :base_uri => "https://api.example.com"
+        @api.base_uri.should == "https://api.example.com"
+      end
+
       it "sets custom middleware with #use" do
         class Foo; end;
         class Bar; end;

data/spec/model/hooks_spec.rb

@@ -32,6 +32,12 @@ describe Her::Model::Hooks do
         Foo::User.hooks[:before_destroy].first.class.should == Symbol
       end
 
+      it "does not handle “before find” method hooks" do
+        expect {
+          Foo::User.before_find :set_internal_id
+        }.should raise_error(NoMethodError)
+      end
+
       it "handles “after save” method hooks" do
         Foo::User.after_save :set_internal_id
         Foo::User.hooks[:after_save].length.should == 1
@@ -55,6 +61,12 @@ describe Her::Model::Hooks do
         Foo::User.hooks[:after_destroy].length.should == 1
         Foo::User.hooks[:after_destroy].first.class.should == Symbol
       end
+
+      it "handles “after find” method hooks" do
+        Foo::User.after_find :set_internal_id
+        Foo::User.hooks[:after_find].length.should == 1
+        Foo::User.hooks[:after_find].first.class.should == Symbol
+      end
     end
 
     describe "block hooks" do
@@ -82,6 +94,12 @@ describe Her::Model::Hooks do
         Foo::User.hooks[:before_destroy].first.class.should == Proc
       end
 
+      it "does not handle “before find” block hooks" do
+        expect {
+          Foo::User.before_find :set_internal_id
+        }.should raise_error(NoMethodError)
+      end
+
       it "handles “after save” block hooks" do
         Foo::User.after_save { |record| record.internal_id = 42 }
         Foo::User.hooks[:after_save].length.should == 1
@@ -105,6 +123,12 @@ describe Her::Model::Hooks do
         Foo::User.hooks[:after_destroy].length.should == 1
         Foo::User.hooks[:after_destroy].first.class.should == Proc
       end
+
+      it "handles “after find” block hooks" do
+        Foo::User.after_find { |record| record.internal_id = 42 }
+        Foo::User.hooks[:after_find].length.should == 1
+        Foo::User.hooks[:after_find].first.class.should == Proc
+      end
     end
 
     context "inheriting hooks from a superclass" do
@@ -125,8 +149,10 @@ describe Her::Model::Hooks do
         builder.use Her::Middleware::FirstLevelParseJSON
         builder.use Faraday::Request::UrlEncoded
         builder.adapter :test do |stub|
+          stub.get("/users")      { |env| [200, {}, [{ :id => 1, :name => "Tobias Fünke" }, { :id => 2, :name => "Lindsay Fünke" }].to_json] }
           stub.post("/users")     { |env| [200, {}, { :id => 1, :name => "Tobias Fünke" }.to_json] }
           stub.get("/users/1")    { |env| [200, {}, { :id => 1, :name => "Tobias Fünke" }.to_json] }
+          stub.get("/users/2")    { |env| [200, {}, { :id => 2, :name => "Lindsay Fünke" }.to_json] }
           stub.put("/users/1")    { |env| [200, {}, { :id => 1, :name => "Tobias Fünke" }.to_json] }
           stub.delete("/users/1") { |env| [200, {}, { :id => 1, :name => "Tobias Fünke" }.to_json] }
         end
@@ -135,6 +161,7 @@ describe Her::Model::Hooks do
       spawn_model "Foo::User" do
         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
+        attr_accessor :internal_after_find_id
 
         def change_internal_save_id; @internal_save_id = 100; end
         def change_internal_create_id; @internal_create_id = 101; end
@@ -145,6 +172,8 @@ describe Her::Model::Hooks do
         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
+
+        def change_internal_after_find_id; @internal_after_find_id = 104; end
       end
     end
 
@@ -159,6 +188,8 @@ describe Her::Model::Hooks do
         Foo::User.after_update :change_internal_after_update_id
         Foo::User.after_create :change_internal_after_create_id
         Foo::User.after_destroy :change_internal_after_destroy_id
+
+        Foo::User.after_find :change_internal_after_find_id
       end
 
       it "perform “before save” “before create” method hook on Model#save without an ID" do
@@ -167,6 +198,7 @@ describe Her::Model::Hooks do
         @user.internal_save_id.should == 100
         @user.internal_create_id.should == 101
         @user.internal_update_id.should == nil
+        @user.internal_after_find_id.should == nil
       end
 
       it "perform “before save” and “before update” method hook on Model#save with an ID" do
@@ -175,6 +207,7 @@ describe Her::Model::Hooks do
         @user.internal_save_id.should == 100
         @user.internal_create_id.should == nil
         @user.internal_update_id.should == 102
+        @user.internal_after_find_id.should == 104
       end
 
       it "perform “before destroy” method hook on Model#destroy" do
@@ -184,6 +217,7 @@ describe Her::Model::Hooks do
         @user.internal_create_id.should == nil
         @user.internal_update_id.should == nil
         @user.internal_destroy_id.should == 103
+        @user.internal_after_find_id.should == 104
       end
 
       it "perform “after save” “after create” method hook on Model#save without an ID" do
@@ -192,6 +226,7 @@ describe Her::Model::Hooks do
         @user.internal_after_save_id.should == 100
         @user.internal_after_create_id.should == 101
         @user.internal_after_update_id.should == nil
+        @user.internal_after_find_id.should == nil
       end
 
       it "perform “after save” “after update” method hook on Model#save with an ID" do
@@ -200,6 +235,7 @@ describe Her::Model::Hooks do
         @user.internal_after_save_id.should == 100
         @user.internal_after_create_id.should == nil
         @user.internal_after_update_id.should == 102
+        @user.internal_after_find_id.should == 104
       end
 
       it "perform “after save” “after update” method hook on Model.save_existing" do
@@ -207,6 +243,7 @@ describe Her::Model::Hooks do
         @user.internal_after_save_id.should == 100
         @user.internal_after_create_id.should == nil
         @user.internal_after_update_id.should == 102
+        @user.internal_after_find_id.should == nil
       end
 
       it "perform “after save” “after create” method hook on Model.create" do
@@ -214,6 +251,38 @@ describe Her::Model::Hooks do
         @user.internal_after_save_id.should == 100
         @user.internal_after_create_id.should == 101
         @user.internal_after_update_id.should == nil
+        @user.internal_after_find_id.should == nil
+      end
+
+      it "perform “after find” method hook on Model.find" do
+        @user = Foo::User.find(1)
+        @user.internal_after_find_id.should == 104
+        @user.internal_save_id.should == nil
+        @user.internal_create_id.should == nil
+        @user.internal_update_id.should == nil
+        @user.internal_destroy_id.should == nil
+      end
+
+      it "perform “after find” method hook on Model#find with IDs" do
+        @users = Foo::User.find([1,2])
+        @users.each do |user|
+          user.internal_after_find_id.should == 104
+          user.internal_save_id.should == nil
+          user.internal_create_id.should == nil
+          user.internal_update_id.should == nil
+          user.internal_destroy_id.should == nil
+        end
+      end
+
+      it "perform “after find” method hook on Model.all" do
+        @users = Foo::User.all
+        @users.each do |user|
+          user.internal_after_find_id.should == 104
+          user.internal_save_id.should == nil
+          user.internal_create_id.should == nil
+          user.internal_update_id.should == nil
+          user.internal_destroy_id.should == nil
+        end
       end
     end
 
@@ -228,6 +297,7 @@ describe Her::Model::Hooks do
         Foo::User.after_create { |record| record.internal_after_create_id = 201 }
         Foo::User.after_update { |record| record.internal_after_update_id = 202 }
         Foo::User.after_destroy { |record| record.internal_after_destroy_id = 203 }
+        Foo::User.after_find { |record| record.internal_after_find_id = 204 }
       end
 
       it "perform “before save” and “before create” block hook on Model#save without an ID" do
@@ -236,6 +306,7 @@ describe Her::Model::Hooks do
         @user.internal_save_id.should == 200
         @user.internal_create_id.should == 201
         @user.internal_update_id.should == nil
+        @user.internal_after_find_id.should == nil
       end
 
       it "perform “before save” and “before update” block hook on Model#save with an ID" do
@@ -244,6 +315,7 @@ describe Her::Model::Hooks do
         @user.internal_save_id.should == 200
         @user.internal_create_id.should == nil
         @user.internal_update_id.should == 202
+        @user.internal_after_find_id.should == 204
       end
 
       it "perform “before destroy” block hook on Model#destroy" do
@@ -253,6 +325,7 @@ describe Her::Model::Hooks do
         @user.internal_create_id.should == nil
         @user.internal_update_id.should == nil
         @user.internal_destroy_id.should == 203
+        @user.internal_after_find_id.should == 204
       end
 
       it "perform “after save” “after create” block hook on Model#save without an ID" do
@@ -261,15 +334,73 @@ describe Her::Model::Hooks do
         @user.internal_after_save_id.should == 200
         @user.internal_after_create_id.should == 201
         @user.internal_after_update_id.should == nil
+        @user.internal_after_find_id.should == nil
       end
 
       it "perform “after save” “after update” block hook on Model#save with an ID" do
         @user = Foo::User.find(1)
         @user.save
+        @user.internal_after_find_id.should == 204
         @user.internal_after_save_id.should == 200
         @user.internal_after_create_id.should == nil
         @user.internal_after_update_id.should == 202
       end
+
+      it "perform “after find” block hook on Model#find" do
+        @user = Foo::User.find(1)
+        @user.internal_after_find_id.should == 204
+        @user.internal_save_id.should == nil
+        @user.internal_create_id.should == nil
+        @user.internal_update_id.should == nil
+      end
+
+      it "perform “after find” method hook on Model#find with IDs" do
+        @users = Foo::User.find([1,2])
+        @users.each do |user|
+          user.internal_after_find_id.should == 204
+          user.internal_save_id.should == nil
+          user.internal_create_id.should == nil
+          user.internal_update_id.should == nil
+        end
+      end
+
+      it "perform “after find” method hook on Model.all" do
+        @users = Foo::User.all
+        @users.each do |user|
+          user.internal_after_find_id.should == 204
+          user.internal_save_id.should == nil
+          user.internal_create_id.should == nil
+          user.internal_update_id.should == nil
+        end
+      end
+
+      it "perform “after find” block hook on Model#find" do
+        @user = Foo::User.find(1)
+        @user.internal_after_find_id.should == 204
+        @user.internal_save_id.should == nil
+        @user.internal_create_id.should == nil
+        @user.internal_update_id.should == nil
+      end
+
+      it "perform “after find” method hook on Model#find with IDs" do
+        @users = Foo::User.find([1,2])
+        @users.each do |user|
+          user.internal_after_find_id.should == 204
+          user.internal_save_id.should == nil
+          user.internal_create_id.should == nil
+          user.internal_update_id.should == nil
+        end
+      end
+
+      it "perform “after find” method hook on Model.all" do
+        @users = Foo::User.all
+        @users.each do |user|
+          user.internal_after_find_id.should == 204
+          user.internal_save_id.should == nil
+          user.internal_create_id.should == nil
+          user.internal_update_id.should == nil
+        end
+      end
     end
   end
 end

data/spec/model/introspection_spec.rb

@@ -19,15 +19,23 @@ describe Her::Model::Introspection do
     end
 
     describe "#inspect" do
-      it "outputs resource attributs for an existing resource" do
+      it "outputs resource attributes for an existing resource" do
         @user = Foo::User.find(1)
         ["#<Foo::User(users/1) name=\"Tobias Funke\" id=1>", "#<Foo::User(users/1) id=1 name=\"Tobias Funke\">"].should include(@user.inspect)
       end
 
-      it "outputs resource attributs for an not-saved-yet resource" do
+      it "outputs resource attributes for an not-saved-yet resource" do
         @user = Foo::User.new(:name => "Tobias Funke")
         @user.inspect.should == "#<Foo::User(users) name=\"Tobias Funke\">"
       end
+
+      it "outputs resource attributes using getters" do
+        @user = Foo::User.new(:name => "Tobias Funke", :password => "Funke")
+        @user.instance_eval {def password; 'filtered'; end}
+        @user.inspect.should include("name=\"Tobias Funke\"")
+        @user.inspect.should include("password=\"filtered\"")
+        @user.inspect.should_not include("password=\"Funke\"")
+      end
     end
   end