her 0.8.2 → 0.9.0

data/.travis.yml

@@ -3,6 +3,8 @@ language: ruby
 sudo: false
 
 rvm:
+  - 2.4.1
+  - 2.3.1
   - 2.2.2
   - 2.1.6
   - 2.0.0

data/README.md

@@ -1,4 +1,5 @@
 # Maintenance Update 29th Sept 2016
+
 Hi folks, [@edtjones](https://github.com/edtjones) here. Rémi has handed me the keys to Her and [@foxpaul](https://github.com/foxpaul) and I will be trying to do the library justice with the help of the community. There's loads to do; we'll get in touch with everyone who's raised a PR as soon as possible and figure out a plan of action.
 
 # Rails 5 support
@@ -15,6 +16,7 @@ If you need Rails 5 support, version 0.8.2 is for you!
   <a href="https://codeclimate.com/github/remiprev/her"><img src="http://img.shields.io/codeclimate/github/remiprev/her.svg" /></a>
   <a href='https://gemnasium.com/remiprev/her'><img src="http://img.shields.io/gemnasium/remiprev/her.svg" /></a>
   <a href="https://travis-ci.org/remiprev/her"><img src="http://img.shields.io/travis/remiprev/her/master.svg" /></a>
+  <a href="https://gitter.im/her-orm/Lobby"><img src="https://badges.gitter.im/her-orm/Lobby.png" alt="Gitter chat" title="" data-pin-nopin="true"></a>
 </p>
 
 ---
@@ -173,6 +175,24 @@ end
 
 Now, each HTTP request made by Her will have the `X-API-Token` header.
 
+### Basic Http Authentication
+Her can use basic http auth by adding a line to your initializer
+
+```ruby
+# config/initializers/her.rb
+Her::API.setup url: "https://api.example.com" do |c|
+  # Request
+  c.use Faraday::Request::BasicAuthentication, 'myusername', 'mypassword'
+  c.use Faraday::Request::UrlEncoded
+
+  # Response
+  c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
+  c.use Faraday::Adapter::NetHttp
+end
+```
+
 ### OAuth
 
 Using the `faraday_middleware` and `simple_oauth` gems, it’s fairly easy to use OAuth authentication with Her.
@@ -397,8 +417,8 @@ You can use the association methods to build new objects and save them.
 @user.comments.build(body: "Just a draft")
 # => [#<Comment body="Just a draft" user_id=1>]
 
-@user.comments.create(body: "Hello world.")
-# POST "/users/1/comments" with `body=Hello+world.`
+@user.comments.create(body: "Hello world.", user_id: 1)
+# POST "/comments" with `body=Hello+world.&user_id=1`
 # => [#<Comment id=3 body="Hello world." user_id=1>]
 ```
 
@@ -593,7 +613,7 @@ users = Users.all
 #### JSON API support
 
 To consume a JSON API 1.0 compliant service, it must return data in accordance with the [JSON API spec](http://jsonapi.org/). The general format
-of the data is as follows: 
+of the data is as follows:
 
 ```json
 { "data": {

data/her.gemspec

@@ -18,9 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake", "~> 10.0"
-  s.add_development_dependency "rspec", "~> 2.13"
-  s.add_development_dependency "rspec-its", "~> 1.0"
-  s.add_development_dependency "fivemat", "~> 1.2"
+  s.add_development_dependency "rspec", "~> 3.5"
   s.add_development_dependency "json", "~> 1.8"
 
   s.add_runtime_dependency "activemodel", ">= 3.0.0", "<= 6.0.0"

data/lib/her/middleware/json_api_parser.rb

@@ -25,7 +25,7 @@ module Her
       # @private
       def on_complete(env)
         env[:body] = case env[:status]
-        when 204
+        when 204, 304
           parse('{}')
         else
           parse(env[:body])

data/lib/her/model/associations/association.rb

@@ -49,6 +49,7 @@ module Her
 
           return @cached_result unless @params.any? || @cached_result.nil?
           return @parent.attributes[@name] unless @params.any? || @parent.attributes[@name].blank?
+          return @opts[:default].try(:dup) if @parent.new?
 
           path = build_association_path lambda { "#{@parent.request_path(@params)}#{@opts[:path]}" }
           @klass.get(path, @params).tap do |result|
@@ -65,6 +66,13 @@ module Her
           end
         end
 
+        # @private
+        def reset
+          @params = {}
+          @cached_result = nil
+          @parent.attributes.delete(@name)
+        end
+
         # Add query parameters to the HTTP request performed to fetch the data
         #
         # @example
@@ -97,6 +105,29 @@ module Her
           @klass.get_resource(path, @params)
         end
 
+        # Refetches the association and puts the proxy back in its initial state,
+        # which is unloaded. Cached associations are cleared.
+        #
+        # @example
+        #   class User
+        #     include Her::Model
+        #     has_many :comments
+        #   end
+        #
+        #   class Comment
+        #     include Her::Model
+        #   end
+        #
+        #   user = User.find(1)
+        #   user.comments = [#<Comment(comments/2) id=2 body="Hello!">]
+        #   user.comments.first.id = "Oops"
+        #   user.comments.reload # => [#<Comment(comments/2) id=2 body="Hello!">]
+        #   # Fetched again via GET "/users/1/comments"
+        def reload
+          reset
+          fetch
+        end
+
       end
     end
   end

data/lib/her/model/associations/association_proxy.rb

@@ -15,7 +15,7 @@ module Her
         end
 
         install_proxy_methods :association,
-          :build, :create, :where, :find, :all, :assign_nested_attributes
+          :build, :create, :where, :find, :all, :assign_nested_attributes, :reload
 
         # @private
         def initialize(association)

data/lib/her/model/attributes.rb

@@ -25,6 +25,8 @@ module Her
 
         attributes = self.class.default_scope.apply_to(attributes)
         assign_attributes(attributes)
+
+        yield self if block_given?
         run_callbacks :initialize
       end
 

data/lib/her/model/orm.rb

@@ -39,8 +39,8 @@ module Her
         callback = new? ? :create : :update
         method = self.class.method_for(callback)
 
-        run_callbacks callback do
-          run_callbacks :save do
+        run_callbacks :save do
+          run_callbacks callback do
             params = to_params
             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?
@@ -49,7 +49,7 @@ module Her
 
               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
@@ -80,12 +80,81 @@ module Her
             assign_attributes(self.class.parse(parsed_data[:data])) if parsed_data[:data].any?
             @metadata = parsed_data[:metadata]
             @response_errors = parsed_data[:errors]
-            @destroyed = true
+            @destroyed = response.success?
           end
         end
         self
       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
+
+      # 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
+
+      # 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
+
       module ClassMethods
         # Create a new chainable scope
         #
@@ -134,7 +203,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 +230,10 @@ 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]
+            new(data.merge(:_destroyed => response.success?, :metadata => metadata, :response_errors => response_errors))
           end
         end
 

data/lib/her/model/parse.rb

@@ -52,20 +52,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
 

data/lib/her/model/relation.rb

@@ -65,7 +65,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)
@@ -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.9.0"
 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