lhs 14.2.0 → 14.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e02a2c879954de6557dc437da50cddf53fbcb054
-  data.tar.gz: cf5c0881ae67770796703f483d3cdd3939a47425
+  metadata.gz: a6435e1ce72c8bd918fc9a4b1f5fde544c47ba90
+  data.tar.gz: f12a4d30361c30793c3a79b182be4acf9bd213f2
 SHA512:
-  metadata.gz: 5309110a6cc3d2a6afae3562c1297cc25a85959c5bdc3b4b3b28742c0d515aca862dcbf5572691631318818ad7b1cae1c1e7db9b2f8eb9e92c50e1a364c8ff4d
-  data.tar.gz: 8bae589cb78ec9f43df90df959aa113e81c9000814ae5d8157e96311e1912fbd169a475dd75a80431145769ca8fe961f1dc447beca8797d1b812fe905da7fd6c
+  metadata.gz: c40a3b2b6d1f0942837fae1e2e0ee44794708b51a4927e4b52c8d0771f05f442ebf8313d0658053cb8ee7114f23ffaf8c6f0cb780d44da1e5e6bea271c7b46cb
+  data.tar.gz: ab234e491cf9e16141610dc9f3d8bda6423757b96daf2ba992b68f91e972d053409adcf3cb15b90a15a41b6f7cfe8ea0eb0149b9f2cb4fad25b6ecc138ef9720

data/README.md

@@ -696,6 +696,23 @@ record = Record.find('1z-5r1fkaj')
 record.update(recommended: false)
 ```
 
+## Partial Update
+
+Often you just want to update a single attribute on an existing record. As ActiveRecord's `update_attribute` skips validation, which is unlikely with api services, and `update_attributes` is just an alias for `update`, LHS introduces `partial_update` for that matter.
+
+`partial_update` will return false if persisting fails. `partial_update!` instead will an raise exception.
+
+`partial_update` always updates the data of the local object first, before it tries to sync with an endpoint. So even if persisting fails, the local object is updated.
+
+```ruby
+record = Record.find('1z-5r1fkaj')
+record.partial_update(recommended: false)
+# POST /records/1z-5r1fkaj
+{
+  recommended: true
+}
+```
+
 ## Becomes
 
 Based on [ActiveRecord's implementation](http://api.rubyonrails.org/classes/ActiveRecord/Persistence.html#method-i-becomes), LHS implements `becomes`, too.
@@ -978,7 +995,7 @@ location = Location.find(123)
 location.id # 123
 ```
 
-### Configure complex accessors for nested data (EXPERIMENTAL)
+### Configure complex accessors for nested data
 
 If items, limit, pagination, total etc. is nested in the responding objects, use complex data structures for configuring a record.
 
@@ -1171,7 +1188,7 @@ end
 Add to your spec_helper.rb:
 
 ```ruby
-  require 'lhs/test/request_cycle_cache'
+  require 'lhs/test/request_cycle_cache_helper'
 ```
 
 This will initialize a MemoryStore cache for LHC::Caching interceptor and resets the cache before every test.

data/lib/lhs/concerns/item/save.rb

@@ -34,11 +34,12 @@ class LHS::Item < LHS::Proxy
 
     def create_and_merge_data!(options)
       direct_response_data = record.request(options)
-      _data.merge_raw!(direct_response_data)
+      nested_path = record.item_created_key ? record.item_created_key : nil
+      _data.merge_raw!(direct_response_data, nested_path)
       response_headers = direct_response_data._request.response.headers
       if response_headers && response_headers['Location']
         location_data = record.request(options.merge(url: response_headers['Location'], method: :get, body: nil))
-        _data.merge_raw!(location_data)
+        _data.merge_raw!(location_data, nested_path)
       end
       true
     end

data/lib/lhs/concerns/item/update.rb

@@ -12,18 +12,34 @@ class LHS::Item < LHS::Proxy
       false
     end
 
-    def update!(params, options = {})
+    def partial_update(params, options = nil)
+      update!(params, options, true)
+    rescue LHC::Error => e
+      self.errors = LHS::Problems::Errors.new(e.response, record)
+      false
+    end
+
+    def partial_update!(params, options = nil)
+      update!(params, options, true)
+    end
+
+    def update!(params, options = {}, partial_update = false)
       options ||= {}
-      _data.merge_raw!(LHS::Data.new(params, _data.parent, record))
+      partial_data = LHS::Data.new(params, _data.parent, record)
+      nested_path = record.item_created_key ? record.item_created_key : nil
+      _data.merge_raw!(partial_data, nested_path)
+      data_sent = partial_update ? partial_data : _data
+      url = href || record.find_endpoint(id: id).compile(id: id)
       response_data = record.request(
         options.merge(
-          method: :post,
-          url: href,
-          body: _data.to_json,
+          method: options.fetch(:method, :post),
+          url: url,
+          body: data_sent.to_json,
           headers: { 'Content-Type' => 'application/json' }
         )
       )
-      _data.merge_raw!(response_data)
+      nested_path = record.item_created_key ? record.item_created_key : nil
+      _data.merge_raw!(response_data, nested_path)
       true
     end
   end

data/lib/lhs/data.rb

@@ -28,13 +28,11 @@ class LHS::Data
 
   # merging data
   # e.g. when loading remote data via link
-  def merge_raw!(data)
+  def merge_raw!(data, nested_path = nil)
     return false if data.blank? || !data._raw.is_a?(Hash)
-    if _record && _record.item_created_key
-      _raw.merge! data._raw.dig(*_record.item_created_key)
-    else
-      _raw.merge! data._raw
-    end
+    raw = data._raw.dig(*nested_path) if nested_path
+    raw ||= data._raw
+    _raw.merge! raw
   end
 
   def _root

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = '14.2.0'
+  VERSION = '14.3.0'
 end

data/spec/item/errors_spec.rb

@@ -241,7 +241,7 @@ describe LHS::Item do
       it 'does not raise an error when trying to find error record model name' do
         expect(lambda do
           record.reviews.first.errors[:name]
-        end).not_to raise_error(NoMethodError)
+        end).not_to raise_error
       end
     end
 

data/spec/item/partial_update_spec.rb

@@ -0,0 +1,110 @@
+require 'rails_helper'
+
+describe LHS::Item do
+  before(:each) do
+    class Record < LHS::Record
+      endpoint ':datastore/v2/:campaign_id/feedbacks'
+      endpoint ':datastore/v2/feedbacks'
+    end
+  end
+
+  let(:json) do
+    load_json(:feedbacks)
+  end
+
+  let(:data) do
+    LHS::Data.new(json, nil, Record)
+  end
+
+  let(:item) do
+    data[0]
+  end
+
+  context 'update' do
+    it 'persists changes on the backend' do
+      stub_request(:post, item.href)
+        .with(body: { name: 'Steve' }.to_json)
+      result = item.partial_update(name: 'Steve')
+      expect(result).to eq true
+    end
+
+    it 'returns false if persisting went wrong' do
+      stub_request(:post, item.href).to_return(status: 500)
+      result = item.partial_update(name: 'Steve')
+      expect(result).to eq false
+    end
+
+    it 'merges reponse data with object' do
+      stub_request(:post, item.href)
+        .to_return(status: 200, body: item._raw.merge(likes: 'Banana').to_json)
+      item.partial_update(name: 'Steve')
+      expect(item.name).to eq 'Steve'
+      expect(item.likes).to eq 'Banana'
+    end
+
+    it 'updates local version of an object even if BE request fails' do
+      stub_request(:post, item.href)
+        .to_return(status: 400, body: item._raw.merge(likes: 'Banana').to_json)
+      item.update(name: 'Andrea')
+      expect(item.name).to eq 'Andrea'
+      expect(item.likes).not_to eq 'Banana'
+    end
+  end
+
+  context 'update!' do
+    it 'raises if something goes wrong' do
+      stub_request(:post, item.href)
+        .with(body: { name: 'Steve' }.to_json)
+        .to_return(status: 500)
+      expect(-> { item.partial_update!(name: 'Steve') }).to raise_error LHC::ServerError
+    end
+  end
+
+  context 'records without hrefs and nested items' do
+
+    before(:each) do
+      class Location < LHS::Record
+        endpoint 'http://uberall/locations'
+        endpoint 'http://uberall/locations/:id'
+      end
+    end
+
+    it 'finds and compiles existing endpoints to determine update url' do
+      stub_request(:get, "http://uberall/locations/1").to_return(body: { id: 1 }.to_json)
+      stub_request(:post, "http://uberall/locations/1").to_return(body: { id: 1, listings: [{ directory: 'facebook' }] }.to_json)
+      location = Location.find(1)
+      location.partial_update(autoSync: true)
+      expect(location.autoSync).to eq true
+      expect(location.listings.first.directory).to eq 'facebook'
+    end
+
+    context 'records with nested items' do
+
+      before(:each) do
+        class Location < LHS::Record
+          endpoint 'http://uberall/locations'
+          endpoint 'http://uberall/locations/:id'
+          configuration item_created_key: [:response, :location], item_key: [:response, :location]
+        end
+      end
+
+      it 'finds and compiles existing endpoints to determine update url' do
+        stub_request(:get, "http://uberall/locations/1").to_return(body: { response: { location: { id: 1 } } }.to_json)
+        stub_request(:post, "http://uberall/locations/1").to_return(body: { response: { location: { id: 1, listings: [{ directory: 'facebook' }] } } }.to_json)
+        location = Location.find(1)
+        location.partial_update(autoSync: true)
+        expect(location.autoSync).to eq true
+        expect(location.listings.first.directory).to eq 'facebook'
+      end
+
+      it 'use given update http method' do
+        stub_request(:get, "http://uberall/locations/1").to_return(body: { response: { location: { id: 1 } } }.to_json)
+        stub_request(:patch, "http://uberall/locations/1").to_return(body: { response: { location: { id: 1, listings: [{ directory: 'facebook' }] } } }.to_json)
+        location = Location.find(1)
+        location.partial_update({ autoSync: true }, { method: :patch })
+        expect(location.autoSync).to eq true
+        expect(location.listings.first.directory).to eq 'facebook'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 14.2.0
+  version: 14.3.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -331,6 +331,7 @@ files:
 - spec/item/getter_spec.rb
 - spec/item/internal_data_structure_spec.rb
 - spec/item/map_spec.rb
+- spec/item/partial_update_spec.rb
 - spec/item/respond_to_spec.rb
 - spec/item/save_spec.rb
 - spec/item/setter_spec.rb
@@ -508,6 +509,7 @@ test_files:
 - spec/item/getter_spec.rb
 - spec/item/internal_data_structure_spec.rb
 - spec/item/map_spec.rb
+- spec/item/partial_update_spec.rb
 - spec/item/respond_to_spec.rb
 - spec/item/save_spec.rb
 - spec/item/setter_spec.rb