her 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e484ba1a9e290f7fd1d8f64feed7b6ceb0a4e6b0
-  data.tar.gz: fc62b8ba7f6de6a75fe121debb564fffd7e0773d
+  metadata.gz: c0f87d36e43920519c831bffab58456dd03219dd
+  data.tar.gz: 8f347722b32acb8f9a7f8f372683b09e9c305d8f
 SHA512:
-  metadata.gz: 87b66eb01fd1376323334646ce77d8ea114ab5d2947215a7b5bc66a3bbcd895ec38df0bce59d28bbd92e11b818394dc52136607f141024dc20263edf6a42a123
-  data.tar.gz: 79629aa61a794ff563838665953051fb03a07784820a87fc649b9247379461cb537df9b5cd2c8ab4615df63c0029f7df8a8bf7f3f2fe24531aa231c7fd08a187
+  metadata.gz: 4a239ac856dd17577b9adcfbf96d454a20ec12cdfa605bd45625261aeb93a31b04d95712b2ed5c7901f48371eadbfb08076a4318cc85276373e3e0dfb6de31a8
+  data.tar.gz: 9a9b886cc0050fecb2d3bff8fcec90dddd3ffac98c1af8c61c177ef5314036f19939ab29542a52305c427ebd6f8b78100199d2fddf66a4031299cbb800dff9fa

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/.travis.yml

@@ -38,6 +38,7 @@ matrix:
       rvm: 2.1.6
 
 before_install:
-  - gem install bundler
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
 
 script: "echo 'COME ON!' && bundle exec rake spec"

data/README.md

@@ -91,6 +91,10 @@ user.fullname = "Lindsay Fünke" # OR user.assign_attributes(fullname: "Lindsay
 user.save # returns false if it fails, errors in user.response_errors array
 # PUT "/users/1" with `fullname=Lindsay+Fünke`
 
+user.update_attributes(fullname: "Maeby Fünke")
+# PUT "/users/1" with `fullname=Maeby+Fünke`
+
+# => PUT /users/1 { "id": 1, "name": "new new name" }
 # Update a resource without fetching it
 User.save_existing(1, fullname: "Lindsay Fünke")
 # PUT "/users/1" with `fullname=Lindsay+Fünke`

data/lib/her/model/associations.rb

@@ -116,7 +116,7 @@ module Her
         # @param [Hash] opts Options
         # @option opts [String] :class_name The name of the class to map objects to
         # @option opts [Symbol] :data_key The attribute where the data is stored
-        # @option opts [Path] :path The relative path where to fetch the data (defaults to `/{class_name}.pluralize/{id}`)
+        # @option opts [Path] :path The relative path where to fetch the data
         # @option opts [Symbol] :foreign_key The foreign key used to build the `:id` part of the path (defaults to `{name}_id`)
         #
         # @example

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

@@ -10,8 +10,7 @@ module Her
             :name => name,
             :data_key => name,
             :default => nil,
-            :foreign_key => "#{name}_id",
-            :path => "/#{name.to_s.pluralize}/:id"
+            :foreign_key => "#{name}_id"
           }.merge(opts)
           klass.associations[:belongs_to] << opts
 

data/lib/her/model/attributes.rb

@@ -69,7 +69,15 @@ module Her
       #   user.assign_attributes(name: "Lindsay")
       #   user.changes # => { :name => ["Tobias", "Lindsay"] }
       def assign_attributes(new_attributes)
+        if !new_attributes.respond_to?(:to_hash)
+          raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
+        end
+
+        # Coerce new_attributes to hash in case of strong parameters
+        new_attributes = new_attributes.to_hash
+
         @_her_attributes ||= attributes
+
         # Use setter methods first
         unset_attributes = self.class.use_setter_methods(self, new_attributes)
 

data/lib/her/model/orm.rb

@@ -61,6 +61,16 @@ module Her
         self
       end
 
+      # Update a resource and return it
+      #
+      # @example
+      #   @user = User.find(1)
+      #   @user.update_attributes(:name => "Tobias Fünke")
+      #   # Called via PUT "/users/1"
+      def update_attributes(attributes)
+        assign_attributes(attributes) && save
+      end
+
       # Destroy a resource
       #
       # @example

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/spec/model/associations_spec.rb

@@ -112,8 +112,7 @@ describe Her::Model::Associations do
             data_key: :organization,
             default: nil,
             class_name: "Organization",
-            foreign_key: "organization_id",
-            path: "/organizations/:id"
+            foreign_key: "organization_id"
           }
         end
         before { Foo::User.belongs_to :organization }
@@ -121,7 +120,8 @@ describe Her::Model::Associations do
         it { is_expected.to eql [organization_association] }
       end
 
-      context "multiple" do
+      context "specifying non-default path" do
+        let(:path) { 'my_special_path' }
         let(:organization_association) do
           {
             name: :organization,
@@ -129,7 +129,22 @@ describe Her::Model::Associations do
             default: nil,
             class_name: "Organization",
             foreign_key: "organization_id",
-            path: "/organizations/:id"
+            path: path
+          }
+        end
+        before { Foo::User.belongs_to :organization, path: path }
+
+        it { is_expected.to eql [organization_association] }
+      end
+
+      context "multiple" do
+        let(:organization_association) do
+          {
+            name: :organization,
+            data_key: :organization,
+            default: nil,
+            class_name: "Organization",
+            foreign_key: "organization_id"
           }
         end
         let(:family_association) do
@@ -138,8 +153,7 @@ describe Her::Model::Associations do
             data_key: :family,
             default: nil,
             class_name: "Family",
-            foreign_key: "family_id",
-            path: "/families/:id"
+            foreign_key: "family_id"
           }
         end
         before do
@@ -216,8 +230,7 @@ describe Her::Model::Associations do
               data_key: :org,
               default: true,
               class_name: "Business",
-              foreign_key: "org_id",
-              path: "/organizations/:id"
+              foreign_key: "org_id"
             }
           end
           before do
@@ -527,6 +540,74 @@ describe Her::Model::Associations do
     end
   end
 
+  context "handling associations with collection_path" do
+    before do
+      spawn_model "Foo::Organization" do
+        has_many :users
+        parse_root_in_json true
+        collection_path '/special/organizations'
+      end
+      spawn_model "Foo::User" do
+        belongs_to :organization
+      end
+    end
+
+    context "without included data" do
+      before(:context) do
+        Her::API.setup url: "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.use Faraday::Request::UrlEncoded
+          builder.adapter :test do |stub|
+            stub.get("/users/2") { [200, {}, { id: 2, name: "Lindsay Fünke", organization_id: 2 }.to_json] }
+            stub.get("/special/organizations/2") { [200, {}, { organization: { id: 2, name: "Bluth Company" } }.to_json] }
+          end
+        end
+      end
+
+      let(:user) { Foo::User.find(2) }
+
+      it "fetches data that was not included through belongs_to" do
+        expect(user.organization).to be_a(Foo::Organization)
+        expect(user.organization.id).to eq(2)
+        expect(user.organization.name).to eq("Bluth Company")
+      end
+    end
+  end
+
+  context "handling associations with path_prefix" do
+    before do
+      spawn_model "Foo::Organization" do
+        has_many :users
+        parse_root_in_json true
+      end
+      spawn_model "Foo::User" do
+        belongs_to :organization
+      end
+    end
+
+    context "without included data" do
+      before(:context) do
+        Her::API.setup url: "https://api.example.com" do |builder|
+          builder.use Her::Middleware::FirstLevelParseJSON
+          builder.use Faraday::Request::UrlEncoded
+          builder.path_prefix = 'special'
+          builder.adapter :test do |stub|
+            stub.get("/special/users/2") { [200, {}, { id: 2, name: "Lindsay Fünke", organization_id: 2 }.to_json] }
+            stub.get("/special/organizations/2") { [200, {}, { organization: { id: 2, name: "Bluth Company" } }.to_json] }
+          end
+        end
+      end
+
+      let(:user) { Foo::User.find(2) }
+
+      it "fetches data that was not included through belongs_to" do
+        expect(user.organization).to be_a(Foo::Organization)
+        expect(user.organization.id).to eq(2)
+        expect(user.organization.name).to eq("Bluth Company")
+      end
+    end
+  end
+
   context "handling associations with details in active_model_serializers format" do
     before do
       spawn_model "Foo::User" do

data/spec/model/attributes_spec.rb

@@ -86,6 +86,10 @@ describe Her::Model::Attributes do
       @user.assign_attributes active: true
       expect(@user).to be_active
     end
+
+    it "expects to receive hash" do
+      expect { @user.assign_attributes(1) }.to raise_error(ArgumentError, 'When assigning attributes, you must pass a hash as an argument.')
+    end
   end
 
   context "checking resource equality" do

data/spec/model/orm_spec.rb

@@ -430,6 +430,13 @@ describe Her::Model::ORM do
       expect(@user.fullname).to eq("Lindsay Fünke")
     end
 
+    it "handle resource update through #update_attributes" do
+      @user = Foo::User.find(1)
+      expect(@user).to receive(:save).and_return(true)
+      @user.update_attributes(fullname: "Lindsay Fünke")
+      expect(@user.fullname).to eq("Lindsay Fünke")
+    end
+
     it "handles resource update through #toggle without saving it" do
       @user = Foo::User.find(1)
       expect(@user.admin).to be_falsey

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: her
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -111,6 +111,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
 - CONTRIBUTING.md