lhs 15.2.0 → 15.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13a9d25e1f79ac50a05c978ee5f2ab7f7ed7abeb
-  data.tar.gz: 2dde05c8df403fdf57199f8cbeade1a024eec3ae
+  metadata.gz: b22ab9cad00592e285064f9e5423a0068cf0924c
+  data.tar.gz: '079d61d3f7a12423f689e64de210bb67243ec239'
 SHA512:
-  metadata.gz: decf3316e125e44703d005608fa43541b70160d861f7a11d8db2a7ee47af36e10bf5ecedb6eebf5b63c6c72401bc47acb97716b99a09c57af54d8e09b207d3d7
-  data.tar.gz: b9492d724ee365fa68183d959c2f245a3cd995ab26f62e5d1209a2b0ba58d472fecdb02a192063e222d796e2760b7d7e8d961cf1d1e2c9df5db12dcbff7b5705
+  metadata.gz: 94b77bb8a7a211acdf05d62f21138442a8d0a68e75fe6bde7190f939595287f7495a51c754f8cc50013ef019ac6a996e8a838a5bd318c62bdbec70530e424458
+  data.tar.gz: 5dc21e72c816d3437677965059f0ac9ae009e3b41f355aec95927b95b8885ba1a42b086ba685b113279bcf25a4cc75f45e12a7ee39d39e1590b3cf4d494a6e01

data/README.md

@@ -401,7 +401,29 @@ end
 
 See [Validation](#Validation) for handling validation errors when creating records.
 
-## Create records through associations (nested resources)
+### Endpoint paramters and paramter injection during creation
+
+LHS injects body parameters to generate target urls, used for creation requests:
+
+```ruby
+class Favorite << LHS::Record
+  endpoint '{+datastore}/content-ads/{content_ad_id}/feedbacks'
+end
+
+Favorite.create(content_ad_id: 51232, text: 'Great Restaurant!')
+# POST http://datastore/content_ads/51232
+# body: '{ "text" : "Great Restaurant!" }'
+```
+
+Because API's usually reject body paramters for foreign key attributes:
+
+```
+Not allowed to set or change foreign key: content_ad_id!
+```
+
+We remove it from the body, if the information was instead transported through the URL.
+
+### Create records through associations (nested resources)
 
 ```ruby
   class Review < LHS::Record
@@ -413,7 +435,7 @@ See [Validation](#Validation) for handling validation errors when creating recor
   end
 ```
 
-### Item
+#### Item
 ```ruby
   review = Review.find(1)
   # Review#1
@@ -435,7 +457,7 @@ See [Validation](#Validation) for handling validation errors when creating recor
 
 If the item already exists `ArgumentError` is raised.
 
-### Expanded collection
+#### Expanded collection
 ```ruby
   review = Review.includes(:comments).find(1)
   # Review#1
@@ -455,7 +477,7 @@ If the item already exists `ArgumentError` is raised.
   # :comments => { :href => '{+service}/reviews/1/comments, :items => [{ :href => '{+service}/reviews/1/comments/1', :text => 'Thank you!' }] }
 ```
 
-### Not expanded collection
+#### Not expanded collection
 ```ruby
   review = Review.find(1)
   # Review#1
@@ -484,6 +506,10 @@ Build and persist new items from scratch are done either with `new` or it's alia
   record.save
 ```
 
+### Endpoint parameters and paramter injection for saving records
+
+See: [Endpoint paramters and paramter injection during creation](#endpoint-paramters-and-paramter-injection-during-creation)
+
 ## Custom setters and getters
 
 Sometimes it is the case that you want to have your custom getters and setters and convert the data to a processable format behind the scenes.
@@ -726,6 +752,32 @@ record = Record.find('1z-5r1fkaj')
 record.update(recommended: false)
 ```
 
+### Endpoint paramters and paramter injection during updates
+
+LHS injects body parameters to generate target urls, used for update requests:
+
+```ruby
+class Customer << LHS::Record
+  endpoint '{+customers}/{id}'
+end
+
+customer = Customer.find(123)
+# GET http://customers/123
+# { id: '123', name: 'My old company name' }
+
+customer.update(name: 'My new company name')
+# POST http://customers/123
+# body: { "name": 'My new company name' }
+```
+
+Because API's usually reject body paramters for primary identifiers:
+
+```
+Not allowed to change primary id!
+```
+
+We remove it from the body, if the information was instead transported through the URL.
+
 ## 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.

data/lhs.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.requirements << 'Ruby >= 2.3.0'
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency 'lhc', '~> 9.1.1'
+  s.add_dependency 'lhc', '~> 9.1.2'
   s.add_dependency 'activesupport', '> 4.2'
   s.add_dependency 'activemodel'
 

data/lib/lhs/concerns/record/chainable.rb

@@ -114,6 +114,10 @@ class LHS::Record
       def class
         @data.keys.first
       end
+
+      def to_a
+        [self.class, handler]
+      end
     end
 
     # IgnoredError: Ignore certain LHC errors when resolving the chain

data/lib/lhs/concerns/record/request.rb

@@ -474,9 +474,9 @@ class LHS::Record
           return_data = nil
           error_class = LHC::Error.find(response)
           error = error_class.new(error_class, response)
-          handlers = handlers.to_a.select { |error_handler| error.is_a? error_handler.class }
+          handlers = handlers.map(&:to_a).to_a.select { |handler_error_class, _| error.is_a? handler_error_class }
           raise(error) unless handlers.any?
-          handlers.each do |handler|
+          handlers.each do |_, handler|
             handlers_return = handler.call(response)
             return_data = handlers_return if handlers_return.present?
           end

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = '15.2.0'
+  VERSION = '15.2.1'
 end

data/spec/record/handle_includes_errors_spec.rb

@@ -0,0 +1,30 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  let(:handler) { spy('handler') }
+
+  before(:each) do
+    class Record < LHS::Record
+      endpoint 'http://local.ch/v2/records/{id}'
+    end
+    class NestedRecord < LHS::Record
+      endpoint 'http://local.ch/v2/other_records/{id}'
+    end
+    stub_request(:get, "http://local.ch/v2/records/1")
+      .to_return(body: {
+        href: 'http://local.ch/v2/records/1',
+        other: {
+          href: 'http://local.ch/v2/other_records/2'
+        }
+      }.to_json)
+    stub_request(:get, "http://local.ch/v2/other_records/2")
+      .to_return(status: 404)
+  end
+
+  it 'allows to pass error_handling for includes to LHC' do
+    handler = ->(_) { return { deleted: true } }
+    record = Record.includes(:other).references(other: { error_handler: { LHC::NotFound => handler } }).find(id: 1)
+
+    expect(record.other.deleted).to be(true)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 15.2.0
+  version: 15.2.1
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.1.1
+        version: 9.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.1.1
+        version: 9.1.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -375,6 +375,7 @@ files:
 - spec/record/find_in_parallel_spec.rb
 - spec/record/find_spec.rb
 - spec/record/first_spec.rb
+- spec/record/handle_includes_errors_spec.rb
 - spec/record/has_many_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb
@@ -436,7 +437,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.3.0
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Rails gem providing an easy, active-record-like interface for http json services
@@ -562,6 +563,7 @@ test_files:
 - spec/record/find_in_parallel_spec.rb
 - spec/record/find_spec.rb
 - spec/record/first_spec.rb
+- spec/record/handle_includes_errors_spec.rb
 - spec/record/has_many_spec.rb
 - spec/record/ignore_errors_spec.rb
 - spec/record/immutable_chains_spec.rb