her 0.8.2 → 0.10.4

data/lib/her/model/orm.rb

@@ -39,17 +39,13 @@ module Her
         callback = new? ? :create : :update
         method = self.class.method_for(callback)
 
-        run_callbacks callback do
-          run_callbacks :save do
-            params = to_params
+        run_callbacks :save do
+          run_callbacks callback do
             self.class.request(to_params.merge(:_method => method, :_path => request_path)) do |parsed_data, response|
-              assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-              @metadata = parsed_data[:metadata]
-              @response_errors = parsed_data[:errors]
-
+              load_from_parsed_data(parsed_data)
               return false if !response.success? || @response_errors.any?
               if self.changed_attributes.present?
-                @previously_changed = self.changed_attributes.clone
+                @previously_changed = self.changes.clone
                 self.changed_attributes.clear
               end
             end
@@ -77,15 +73,92 @@ module Her
         method = self.class.method_for(:destroy)
         run_callbacks :destroy do
           self.class.request(params.merge(:_method => method, :_path => request_path)) do |parsed_data, response|
-            assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
-            @metadata = parsed_data[:metadata]
-            @response_errors = parsed_data[:errors]
-            @destroyed = true
+            load_from_parsed_data(parsed_data)
+            @destroyed = response.success?
           end
         end
         self
       end
 
+      # Initializes +attribute+ to zero if +nil+ and adds the value passed as
+      # +by+ (default is 1). The increment is performed directly on the
+      # underlying attribute, no setter is invoked. Only makes sense for
+      # number-based attributes. Returns +self+.
+      def increment(attribute, by = 1)
+        attributes[attribute] ||= 0
+        attributes[attribute] += by
+        self
+      end
+
+      # Wrapper around #increment that saves the resource. Saving is subjected
+      # to validation checks. Returns +self+.
+      def increment!(attribute, by = 1)
+        increment(attribute, by) && save
+        self
+      end
+
+      # Initializes +attribute+ to zero if +nil+ and substracts the value passed as
+      # +by+ (default is 1). The decrement is performed directly on the
+      # underlying attribute, no setter is invoked. Only makes sense for
+      # number-based attributes. Returns +self+.
+      def decrement(attribute, by = 1)
+        increment(attribute, -by)
+      end
+
+      # Wrapper around #decrement that saves the resource. Saving is subjected
+      # to validation checks. Returns +self+.
+      def decrement!(attribute, by = 1)
+        increment!(attribute, -by)
+      end
+
+      # Assigns to +attribute+ the boolean opposite of <tt>attribute?</tt>. So
+      # if the predicate returns +true+ the attribute will become +false+. This
+      # method toggles directly the underlying value without calling any setter.
+      # Returns +self+.
+      #
+      # @example
+      #   user = User.first
+      #   user.admin? # => false
+      #   user.toggle(:admin)
+      #   user.admin? # => true
+      def toggle(attribute)
+        attributes[attribute] = !public_send("#{attribute}?")
+        self
+      end
+
+      # Wrapper around #toggle that saves the resource. Saving is subjected to
+      # validation checks. Returns +true+ if the record could be saved.
+      def toggle!(attribute)
+        toggle(attribute) && save
+      end
+
+      # Refetches the resource
+      #
+      # This method finds the resource by its primary key (which could be
+      # assigned manually) and modifies the object in-place.
+      #
+      # @example
+      #   user = User.find(1)
+      #   # => #<User(users/1) id=1 name="Tobias Fünke">
+      #   user.name = "Oops"
+      #   user.reload # Fetched again via GET "/users/1"
+      #   # => #<User(users/1) id=1 name="Tobias Fünke">
+      def reload(options = nil)
+        fresh_object = self.class.find(id)
+        assign_attributes(fresh_object.attributes)
+        self
+      end
+
+      # Uses parsed response to assign attributes and metadata
+      #
+      # @private
+      def load_from_parsed_data(parsed_data)
+        data = parsed_data[:data]
+        assign_attributes(self.class.parse(data)) if data.any?
+        @metadata = parsed_data[:metadata]
+        @response_errors = parsed_data[:errors]
+      end
+
       module ClassMethods
         # Create a new chainable scope
         #
@@ -105,10 +178,8 @@ module Her
             instance_exec(*args, &code)
           end
 
-          # Add the scope method to the Relation class
-          Relation.instance_eval do
-            define_method(name) { |*args| instance_exec(*args, &code) }
-          end
+          # Add the scope method to the default/blank relation
+          scoped.define_singleton_method(name) { |*args| instance_exec(*args, &code) }
         end
 
         # @private
@@ -134,7 +205,8 @@ module Her
         end
 
         # Delegate the following methods to `scoped`
-        [:all, :where, :create, :build, :find, :first_or_create, :first_or_initialize].each do |method|
+        [:all, :where, :create, :build, :find, :find_by, :find_or_create_by,
+         :find_or_initialize_by, :first_or_create, :first_or_initialize].each do |method|
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{method}(*params)
               scoped.send(#{method.to_sym.inspect}, *params)
@@ -160,7 +232,12 @@ module Her
         #   # Called via DELETE "/users/1"
         def destroy_existing(id, params={})
           request(params.merge(:_method => method_for(:destroy), :_path => build_request_path(params.merge(primary_key => id)))) do |parsed_data, response|
-            new(parse(parsed_data[:data]).merge(:_destroyed => true))
+            data = parse(parsed_data[:data])
+            metadata = parsed_data[:metadata]
+            response_errors = parsed_data[:errors]
+            record = new(data.merge(:_destroyed => response.success?, :metadata => metadata))
+            record.response_errors = response_errors
+            record
           end
         end
 
@@ -196,9 +273,9 @@ module Her
           resource
         end
 
-        private
         # @private
         def blank_relation
+          @blank_relation ||= superclass.blank_relation.clone.tap { |r| r.parent = self } if superclass.respond_to?(:blank_relation)
           @blank_relation ||= Relation.new(self)
         end
       end

data/lib/her/model/parse.rb

@@ -32,8 +32,18 @@ module Her
 
         # @private
         def to_params(attributes, changes={})
-          filtered_attributes = attributes.dup.symbolize_keys
+          filtered_attributes = attributes.each_with_object({}) do |(key, value), memo|
+            case value
+            when Her::Model
+            when ActiveModel::Serialization
+              value = value.serializable_hash.symbolize_keys
+            end
+
+            memo[key.to_sym] = value
+          end
+
           filtered_attributes.merge!(embeded_params(attributes))
+
           if her_api.options[:send_only_modified_attributes]
             filtered_attributes = changes.symbolize_keys.keys.inject({}) do |hash, attribute|
               hash[attribute] = filtered_attributes[attribute]
@@ -52,20 +62,16 @@ module Her
           end
         end
 
-
         # @private
-        # TODO: Handle has_one
         def embeded_params(attributes)
-          associations[:has_many].select { |a| attributes.include?(a[:data_key])}.compact.inject({}) do |hash, association|
-            params = attributes[association[:data_key]].map(&:to_params)
-            next if params.empty?
-            if association[:class_name].constantize.include_root_in_json?
-              root = association[:class_name].constantize.root_element
-              hash[association[:data_key]] = params.map { |n| n[root] }
-            else
-              hash[association[:data_key]] = params
-            end
-            hash
+          associations.values.flatten.each_with_object({}) do |definition, hash|
+            value = case association = attributes[definition[:name]]
+                    when Her::Collection, Array
+                      association.map { |a| a.to_params }.reject(&:empty?)
+                    when Her::Model
+                      association.to_params
+                    end
+            hash[definition[:data_key]] = value if value.present?
           end
         end
 
@@ -139,7 +145,8 @@ module Her
 
         # @private
         def root_element_included?(data)
-          data.keys.to_s.include? @_her_root_element.to_s
+          element = data[parsed_root_element]
+          element.is_a?(Hash) || element.is_a?(Array)
         end
 
         # @private
@@ -198,17 +205,20 @@ module Her
 
         # @private
         def request_new_object_on_build?
-          @_her_request_new_object_on_build || (superclass.respond_to?(:request_new_object_on_build?) && superclass.request_new_object_on_build?)
+          return @_her_request_new_object_on_build unless @_her_request_new_object_on_build.nil?
+          superclass.respond_to?(:request_new_object_on_build?) && superclass.request_new_object_on_build?
         end
 
         # @private
         def include_root_in_json?
-          @_her_include_root_in_json || (superclass.respond_to?(:include_root_in_json?) && superclass.include_root_in_json?)
+          return @_her_include_root_in_json unless @_her_include_root_in_json.nil?
+          superclass.respond_to?(:include_root_in_json?) && superclass.include_root_in_json?
         end
 
         # @private
         def parse_root_in_json?
-          @_her_parse_root_in_json || (superclass.respond_to?(:parse_root_in_json?) && superclass.parse_root_in_json?)
+          return @_her_parse_root_in_json unless @_her_parse_root_in_json.nil?
+          superclass.respond_to?(:parse_root_in_json?) && superclass.parse_root_in_json?
         end
       end
     end

data/lib/her/model/relation.rb

@@ -3,6 +3,7 @@ module Her
     class Relation
       # @private
       attr_accessor :params
+      attr_writer :parent
 
       # @private
       def initialize(parent)
@@ -65,7 +66,7 @@ module Her
       # @private
       def fetch
         @_fetch ||= begin
-          path = @parent.build_request_path(@params)
+          path = @parent.build_request_path(@parent.collection_path, @params)
           method = @parent.method_for(:find)
           @parent.request(@params.merge(:_method => method, :_path => path)) do |parsed_data, response|
             @parent.new_collection(parsed_data)
@@ -96,7 +97,6 @@ module Her
           @parent.request(request_params) do |parsed_data, response|
             if response.success?
               resource = @parent.new_from_parsed_data(parsed_data)
-              resource.instance_variable_set(:@changed_attributes, {})
               resource.run_callbacks :find
             else
               return nil
@@ -109,6 +109,50 @@ module Her
         ids.length > 1 || ids.first.kind_of?(Array) ? results : results.first
       end
 
+      # Fetch first resource with the given attributes.
+      #
+      # If no resource is found, returns <tt>nil</tt>.
+      #
+      # @example
+      #   @user = User.find_by(name: "Tobias", age: 42)
+      #   # Called via GET "/users?name=Tobias&age=42"
+      def find_by(params)
+        where(params).first
+      end
+
+      # Fetch first resource with the given attributes, or create a resource
+      # with the attributes if one is not found.
+      #
+      # @example
+      #   @user = User.find_or_create_by(email: "remi@example.com")
+      #
+      #   # Returns the first item in the collection if present:
+      #   # Called via GET "/users?email=remi@example.com"
+      #
+      #   # If collection is empty:
+      #   # POST /users with `email=remi@example.com`
+      #   @user.email # => "remi@example.com"
+      #   @user.new? # => false
+      def find_or_create_by(attributes)
+        find_by(attributes) || create(attributes)
+      end
+
+      # Fetch first resource with the given attributes, or initialize a resource
+      # with the attributes if one is not found.
+      #
+      # @example
+      #   @user = User.find_or_initialize_by(email: "remi@example.com")
+      #
+      #   # Returns the first item in the collection if present:
+      #   # Called via GET "/users?email=remi@example.com"
+      #
+      #   # If collection is empty:
+      #   @user.email # => "remi@example.com"
+      #   @user.new? # => true
+      def find_or_initialize_by(attributes)
+        find_by(attributes) || build(attributes)
+      end
+
       # Create a resource and return it
       #
       # @example

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.8.2"
+  VERSION = "0.10.4"
 end

data/spec/api_spec.rb

@@ -8,21 +8,24 @@ describe Her::API do
     describe "#setup" do
       context "when setting custom middleware" do
         before do
-          class Foo; end;
-          class Bar; end;
+          class Foo; end
+          class Bar; end
 
-          subject.setup :url => "https://api.example.com" do |connection|
+          subject.setup url: "https://api.example.com" do |connection|
             connection.use Foo
             connection.use Bar
           end
         end
 
-        specify { subject.connection.builder.handlers.should == [Foo, Bar] }
+        specify { expect(subject.connection.builder.handlers).to eq([Foo, Bar]) }
       end
 
       context "when setting custom options" do
-        before { subject.setup :foo => { :bar => "baz" }, :url => "https://api.example.com" }
-        its(:options) { should == { :foo => { :bar => "baz" }, :url => "https://api.example.com" } }
+        before { subject.setup foo: { bar: "baz" }, url: "https://api.example.com" }
+
+        describe "#options" do
+          it { expect(subject.options).to eq(foo: { bar: "baz" }, url: "https://api.example.com") }
+        end
       end
     end
 
@@ -30,83 +33,83 @@ describe Her::API do
       before do
         class SimpleParser < Faraday::Response::Middleware
           def on_complete(env)
-            env[:body] = { :data => env[:body] }
+            env[:body] = { data: env[:body] }
           end
         end
       end
 
       context "making HTTP requests" do
-        let(:parsed_data) { subject.request(:_method => :get, :_path => "/foo")[:parsed_data] }
+        let(:parsed_data) { subject.request(_method: :get, _path: "/foo")[:parsed_data] }
         before do
-          subject.setup :url => "https://api.example.com" do |builder|
+          subject.setup url: "https://api.example.com" do |builder|
             builder.use SimpleParser
-            builder.adapter(:test) { |stub| stub.get("/foo") { |env| [200, {}, "Foo, it is."] } }
+            builder.adapter(:test) { |stub| stub.get("/foo") { [200, {}, "Foo, it is."] } }
           end
         end
 
-        specify { parsed_data[:data].should == "Foo, it is." }
+        specify { expect(parsed_data[:data]).to eq("Foo, it is.") }
       end
 
       context "making HTTP requests while specifying custom HTTP headers" do
-        let(:parsed_data) { subject.request(:_method => :get, :_path => "/foo", :_headers => { "X-Page" => 2 })[:parsed_data] }
+        let(:parsed_data) { subject.request(_method: :get, _path: "/foo", _headers: { "X-Page" => 2 })[:parsed_data] }
 
         before do
-          subject.setup :url => "https://api.example.com" do |builder|
+          subject.setup url: "https://api.example.com" do |builder|
             builder.use SimpleParser
-            builder.adapter(:test) { |stub| stub.get("/foo") { |env| [200, {}, "Foo, it is page #{env[:request_headers]["X-Page"]}."] } }
+            builder.adapter(:test) { |stub| stub.get("/foo") { |env| [200, {}, "Foo, it is page #{env[:request_headers]['X-Page']}."] } }
           end
         end
 
-        specify { parsed_data[:data].should == "Foo, it is page 2." }
+        specify { expect(parsed_data[:data]).to eq("Foo, it is page 2.") }
       end
 
       context "parsing a request with the default parser" do
-        let(:parsed_data) { subject.request(:_method => :get, :_path => "users/1")[:parsed_data] }
+        let(:parsed_data) { subject.request(_method: :get, _path: "users/1")[:parsed_data] }
         before do
-          subject.setup :url => "https://api.example.com" do |builder|
+          subject.setup url: "https://api.example.com" do |builder|
             builder.use Her::Middleware::FirstLevelParseJSON
             builder.adapter :test do |stub|
-              stub.get("/users/1") { |env| [200, {}, MultiJson.dump({ :id => 1, :name => "George Michael Bluth", :errors => ["This is a single error"], :metadata => { :page => 1, :per_page => 10 } })] }
+              stub.get("/users/1") { [200, {}, MultiJson.dump(id: 1, name: "George Michael Bluth", errors: ["This is a single error"], metadata: { page: 1, per_page: 10 })] }
             end
           end
         end
 
         specify do
-          parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
-          parsed_data[:errors].should == ["This is a single error"]
-          parsed_data[:metadata].should == { :page => 1, :per_page => 10 }
+          expect(parsed_data[:data]).to eq(id: 1, name: "George Michael Bluth")
+          expect(parsed_data[:errors]).to eq(["This is a single error"])
+          expect(parsed_data[:metadata]).to eq(page: 1, per_page: 10)
         end
       end
 
       context "parsing a request with a custom parser" do
-        let(:parsed_data) { subject.request(:_method => :get, :_path => "users/1")[:parsed_data] }
+        let(:parsed_data) { subject.request(_method: :get, _path: "users/1")[:parsed_data] }
         before do
           class CustomParser < Faraday::Response::Middleware
             def on_complete(env)
-              json = MultiJson.load(env[:body], :symbolize_keys => true)
+              json = MultiJson.load(env[:body], symbolize_keys: true)
               errors = json.delete(:errors) || []
               metadata = json.delete(:metadata) || {}
               env[:body] = {
-                :data => json,
-                :errors => errors,
-                :metadata => metadata,
+                data: json,
+                errors: errors,
+                metadata: metadata
               }
             end
           end
 
-          subject.setup :url => "https://api.example.com" do |builder|
+          subject.setup url: "https://api.example.com" do |builder|
             builder.use CustomParser
             builder.use Faraday::Request::UrlEncoded
             builder.adapter :test do |stub|
-              stub.get("/users/1") { |env| [200, {}, MultiJson.dump(:id => 1, :name => "George Michael Bluth")] }
+              stub.get("/users/1") { [200, {}, MultiJson.dump(id: 1, name: "George Michael Bluth")] }
             end
           end
         end
 
         specify do
-          parsed_data[:data].should == { :id => 1, :name => "George Michael Bluth" }
-          parsed_data[:errors].should == []
-          parsed_data[:metadata].should == {}
+          expect(parsed_data[:data]).to eq(id: 1, name: "George Michael Bluth")
+          expect(parsed_data[:errors]).to eq([])
+          expect(parsed_data[:metadata]).to eq({})
         end
       end
     end

data/spec/collection_spec.rb

@@ -1,26 +1,41 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Her::Collection do
-
   let(:items) { [1, 2, 3, 4] }
-  let(:metadata) { { :name => 'Testname' } }
-  let(:errors) { { :name => ['not_present'] } }
+  let(:metadata) { { name: "Testname" } }
+  let(:errors) { { name: ["not_present"] } }
 
   describe "#new" do
     context "without parameters" do
       subject { Her::Collection.new }
 
-      it { should eq([]) }
-      its(:metadata) { should eq({}) }
-      its(:errors) { should eq({}) }
+      it { is_expected.to eq([]) }
+
+      describe "#metadata" do
+        subject { super().metadata }
+        it { is_expected.to eq({}) }
+      end
+
+      describe "#errors" do
+        subject { super().errors }
+        it { is_expected.to eq({}) }
+      end
     end
 
     context "with parameters" do
       subject { Her::Collection.new(items, metadata, errors) }
 
-      it { should eq([1,2,3,4]) }
-      its(:metadata) { should eq({ :name => 'Testname' }) }
-      its(:errors) { should eq({ :name => ['not_present'] }) }
+      it { is_expected.to eq([1, 2, 3, 4]) }
+
+      describe "#metadata" do
+        subject { super().metadata }
+        it { is_expected.to eq(name: "Testname") }
+      end
+
+      describe "#errors" do
+        subject { super().errors }
+        it { is_expected.to eq(name: ["not_present"]) }
+      end
     end
   end
 end