lhs 14.0.3 → 14.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2cb43c14345dbda2239e8714ea2c43ff9c41c56
-  data.tar.gz: 4d076f553a644860357e8adf22e9fdf8598a0afa
+  metadata.gz: 504f8883ad45f75b004de4cbf3dbf5aa1e9e12bc
+  data.tar.gz: 1076be76ce857bc401a2222e7c1459cf9f300901
 SHA512:
-  metadata.gz: fe3a0437e13e0b82952da892e845625fb2c2039acbbf06f1c842fb8c726a957c9c0b7309ebb08d4d182bae14d605383f0108a67fb198b895b92da06c08b6fce8
-  data.tar.gz: 92686aae195ca9d03479f50971b3e3e3cd466f7dd615a8b1d7ab6cd9c4f43f115389b4aaef74877377baded2cfa878245fbc64676303a0dd0475328ab8ac88e2
+  metadata.gz: 41286eb7d5bcf95c24c39d67ac6c5d35460d66514ead66bebcbcda7256c8322ab7706058c1920ffceb00e1fd9e887baa05285d8eb43fd40e03c438b4b8f2f648
+  data.tar.gz: b1401bde9eb82be62b2d90750adfbaae6b23349054e088b9142db8b8ddfabdde92841c7a61701a24a53bb183d49e2b3b5f9301b4cdefd4c6bcdf1a8ef39b13ee

data/README.md

@@ -914,6 +914,8 @@ class Search < LHS::Record
 end
 ```
 
+`item_key` key used to unwrap the actuall object from within the response body.
+
 `items_key` key used to determine items of the current page (e.g. `docs`, `items`, etc.).
 
 `item_created_key` key used to merge record data thats nested in the creation response body.
@@ -926,6 +928,27 @@ end
 
 `total_key` key used to determine the total amount of items (e.g. `total`, `totalResults`, etc.).
 
+### Unwrap nested items
+
+```json
+{
+  "response": {
+    "location": {
+      "id": 123
+    }
+  }
+}
+```
+
+```ruby
+class Location < LHS::Record
+  configuration item_key: [:response, :location]
+end
+
+location = Location.find(123)
+location.id # 123
+```
+
 ### Configure complex accessors for nested data (EXPERIMENTAL)
 
 If items, limit, pagination, total etc. is nested in the responding objects, use complex data structures for configuring a record.

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

@@ -14,6 +14,12 @@ class LHS::Record
         @configuration = args.freeze || {}
       end
 
+      def item_key
+        symbolize_unless_complex(
+          @configuration.try(:[], :item_key) || :item
+        )
+      end
+
       def items_key
         symbolize_unless_complex(
           @configuration.try(:[], :items_key) || :items

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

@@ -17,8 +17,8 @@ class LHS::Record
           else
             find_by_id(args, options)
           end
-        return data if data && (data.is_a?(Array) || !data._record)
-        data ? data._record.new(data) : nil
+        return data if data && (data.is_a?(Array) || !data._record || data.collection?)
+        data ? data._record.new(data.unwrap_nested_item) : nil
       end
 
       private

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

@@ -27,7 +27,7 @@ class LHS::Record
         if data && data._proxy.is_a?(LHS::Collection)
           data.first || raise(LHC::NotFound.new('No item was found.', data._request.response))
         elsif data
-          data._record.new(data)
+          data._record.new(data.unwrap_nested_item)
         end
       end
     end

data/lib/lhs/item.rb

@@ -41,4 +41,11 @@ class LHS::Item < LHS::Proxy
     # We accept every message that does not belong to set of keywords
     BLACKLISTED_KEYWORDS.exclude?(name.to_s)
   end
+
+  def unwrap_nested_item
+    return _data unless _record.item_key
+    nested_data = _data.dig(*_record.item_key)
+    return _data unless nested_data
+    nested_data
+  end
 end

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = '14.0.3'
+  VERSION = '14.1.0'
 end

data/spec/record/item_key_spec.rb

@@ -0,0 +1,43 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  before(:each) do
+    class Location < LHS::Record
+      configuration item_key: [:response, :location]
+      endpoint 'http://uberall/location'
+      endpoint 'http://uberall/location/:id'
+    end
+  end
+
+  let(:json_body) do
+    {
+      response: {
+        location: {
+          id: 1
+        }
+      }
+    }.to_json
+  end
+
+  let(:stub_request_by_id) do
+    stub_request(:get, "http://uberall/location/1")
+      .to_return(body: json_body)
+  end
+
+  let(:stub_request_by_get_parameters) do
+    stub_request(:get, "http://uberall/location?identifier=1&limit=1")
+      .to_return(body: json_body)
+  end
+
+  it 'uses configured item_key to unwrap response data for find' do
+    stub_request_by_id
+    location = Location.find(1)
+    expect(location.id).to eq 1
+  end
+
+  it 'uses configured item_key to unwrap response data for find_by' do
+    stub_request_by_get_parameters
+    location = Location.find_by(identifier: 1)
+    expect(location.id).to eq 1
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 14.0.3
+  version: 14.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2017-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -365,6 +365,7 @@ files:
 - spec/record/includes_all_spec.rb
 - spec/record/includes_spec.rb
 - spec/record/includes_warning_spec.rb
+- spec/record/item_key_spec.rb
 - spec/record/items_created_key_configuration_spec.rb
 - spec/record/loading_twice_spec.rb
 - spec/record/mapping_spec.rb
@@ -418,7 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.3.0
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Rails gem providing an easy, active-record-like interface for http json services
@@ -540,6 +541,7 @@ test_files:
 - spec/record/includes_all_spec.rb
 - spec/record/includes_spec.rb
 - spec/record/includes_warning_spec.rb
+- spec/record/item_key_spec.rb
 - spec/record/items_created_key_configuration_spec.rb
 - spec/record/loading_twice_spec.rb
 - spec/record/mapping_spec.rb