lhs 9.0.4 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb534b7591faab4cd810b3cadc57187834180736
-  data.tar.gz: 10ebca98180dab9bf47532bba6b82ed9011dff59
+  metadata.gz: 6332862581250354312558fba4a8aa584b4a0611
+  data.tar.gz: 61d791ccc6b3153ad1928c9d743abfaac4005eff
 SHA512:
-  metadata.gz: ac2ab9727befddaabc2684dd021d906e8c0c58f41dda4e9695b1847ed8716a0148604a89c4f830883bd8bc62a5958017f2a927927eca77cd81ed06299896dda1
-  data.tar.gz: a71dfe943c674098b6195df7e9a26addfe2cc35cc6bef4ce8093ddd284a0ea7a114f0bc27f2553a006325728c574ea2dcba2fdced82c8269ae7376c96362d697
+  metadata.gz: e47a127a76131cb1cf82f65c525fdc55b29e32b24b9d57366a24aa7ce2d034e3fc1681e9b239527e8d98bd1628f56a69e8b03f30fce5d5ed544b3d22f4c00412
+  data.tar.gz: 3961c7b47fca9e438cc426cef6ea3daa873be38210ff46684726371019981397576c78235d08f50e893675abe0cddcdec83aa62e16d416b6e4905fd84e369bd4

data/README.md

@@ -71,6 +71,32 @@ This uses the `:service/v2/records` endpoint, cause `:association_id` was not pr
 
 Uses the `:service/v2/association/:association_id/records` endpoint.
 
+### Expand plain collection of links
+
+Some endpoints could respond a plain list of links without any expanded data. Like search endpoints.
+If you want to have LHS expand those items, use `expanded` as part of a Query-Chain:
+
+```json
+  { 
+    "items" : [
+      {"href": "http://local.ch/customer/1/accounts/1"},
+      {"href": "http://local.ch/customer/1/accounts/2"},
+      {"href": "http://local.ch/customer/1/accounts/3"}
+    ] 
+  }
+end
+```
+
+```ruby
+  Account.where(customer_id: 123).expanded
+```
+
+You can also apply options to `expanded` in order to apply anything on the requests made to expand the links:
+
+```ruby
+  Account.where(customer_id: 123).expanded(auth: { bearer: access_token })
+```
+
 ## Chaining where statements
 
 LHS supports chaining where statements. 

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

@@ -21,6 +21,10 @@ class LHS::Record
         chain
       end
 
+      def expanded(options = nil)
+        Chain.new(self, Option.new(expanded: options || true))
+      end
+
       def options(hash = nil)
         Chain.new(self, Option.new(hash))
       end
@@ -181,6 +185,10 @@ class LHS::Record
         push([Parameter.new(hash), Option.new(all: true)])
       end
 
+      def expanded(options = nil)
+        push(Option.new(expanded: options || true))
+      end
+
       def options(hash = nil)
         push(Option.new(hash))
       end

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

@@ -422,10 +422,22 @@ class LHS::Record
         response = LHC.request(process_options(options, endpoint))
         data = LHS::Data.new(response.body, nil, self, response.request, endpoint)
         load_and_merge_remaining_objects!(data, process_options(options, endpoint)) if paginated?(data._raw) && options[:all]
+        expand_items(data, options[:expanded]) if data.collection? && options[:expanded]
         handle_includes(including, data, referencing) if including.present? && data.present?
         data
       end
 
+      def expand_items(data, expand_options)
+        expand_options = {} unless expand_options.is_a?(Hash)
+        options = data.map do |item|
+          expand_options.merge(url: item.href)
+        end
+        expanded_data = request(options)
+        data.each_with_index do |item, index|
+          item.merge_raw!(expanded_data[index])
+        end
+      end
+
       def url_option_for(item, key = nil)
         link = key ? item[key] : item
         return if link.blank?

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "9.0.4"
+  VERSION = "9.1.0"
 end

data/spec/record/expanded_spec.rb

@@ -0,0 +1,67 @@
+require 'rails_helper'
+
+describe LHS::Record do
+  before(:each) do
+    class Record < LHS::Record
+      endpoint 'http://local.ch/v2/records'
+    end
+  end
+
+  let!(:request_collection) do
+    stub_request(:get, "http://local.ch/v2/records?color=blue")
+      .to_return(body: {
+        items: [
+          { href: 'http://local.ch/v2/records/1' },
+          { href: 'http://local.ch/v2/records/2' }
+        ]
+      }.to_json)
+  end
+
+  let!(:request_item_1) do
+    stub_request(:get, "http://local.ch/v2/records/1?via=collection")
+      .to_return(body: {
+        name: 'Steve'
+      }.to_json)
+  end
+
+  let!(:request_item_2) do
+    stub_request(:get, "http://local.ch/v2/records/2?via=collection")
+      .to_return(body: {
+        name: 'John'
+      }.to_json)
+  end
+
+  it 'expands collections that just contains links' do
+    records = Record.where(color: 'blue').expanded(params: { via: 'collection' })
+    expect(records[0].name).to eq 'Steve'
+    expect(records[1].name).to eq 'John'
+    assert_requested request_collection
+    assert_requested request_item_1
+    assert_requested request_item_2
+  end
+
+  context 'without options' do
+    let!(:request_item_1) do
+      stub_request(:get, "http://local.ch/v2/records/1")
+        .to_return(body: {
+          name: 'Steve'
+        }.to_json)
+    end
+
+    let!(:request_item_2) do
+      stub_request(:get, "http://local.ch/v2/records/2")
+        .to_return(body: {
+          name: 'John'
+        }.to_json)
+    end
+
+    it 'works also without options' do
+      records = Record.where(color: 'blue').expanded
+      expect(records[0].name).to eq 'Steve'
+      expect(records[1].name).to eq 'John'
+      assert_requested request_collection
+      assert_requested request_item_1
+      assert_requested request_item_2
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 9.0.4
+  version: 9.1.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -324,6 +324,7 @@ files:
 - spec/record/endpoint_options_spec.rb
 - spec/record/endpoints_spec.rb
 - spec/record/equality_spec.rb
+- spec/record/expanded_spec.rb
 - spec/record/find_by_chains_spec.rb
 - spec/record/find_by_spec.rb
 - spec/record/find_each_spec.rb
@@ -481,6 +482,7 @@ test_files:
 - spec/record/endpoint_options_spec.rb
 - spec/record/endpoints_spec.rb
 - spec/record/equality_spec.rb
+- spec/record/expanded_spec.rb
 - spec/record/find_by_chains_spec.rb
 - spec/record/find_by_spec.rb
 - spec/record/find_each_spec.rb