lhs 14.4.0 → 14.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 915b54df82b092a12fef1395a21e854e4f95738d
-  data.tar.gz: ff5e0fbca423676b763606ebcdf2d2b2a4562084
+  metadata.gz: 66878335134271a8a2adadfb4a3318d029f0a854
+  data.tar.gz: c579b0f2377f06413b247d58023f10ed1bb908b6
 SHA512:
-  metadata.gz: 5fbbe1749a1266a6b4fc2df4d4aaf9b55b4d24a69d3af3af000c6c9d4b159eea16d7435e93799fcbfc28f0db46f4e86a84283938578edb62b05b4bdf47f1ca2f
-  data.tar.gz: 4f2652ef35ec40aa670901203fcbbf02de58fffe900090f90af7acb9fcdc032b40dbe86a350a2cc8c83efb7e25cb7bbb21aa34e74a7586956c6d313c88e2df80
+  metadata.gz: 48df46b051c333e615122cf5fda68298b2bf3f4116631f93a987408c8942e7e295e52b4d24830861867f099bc74f473e28bd6a9c1c7ae16c43007d7be81f9c31
+  data.tar.gz: f138b1a4a1d25b7b43de711b7bdf4038a13330cd34c94784123234cf9b0be62f25c9cd2c02593916f111542bb1c9c24b70c60d356be90fed82a87a3a5d908f1e

data/README.md

@@ -997,8 +997,20 @@ end
 
 `limit_key` key used to work with page limits (e.g. `size`, `limit`, etc.)
 
+In case the `limit_key` parameter differs for where it's located in the body and how it's provided as get parameter, when retreiving pages, provide a hash with `body` and `paramter` key, to keep those two use cases separated:
+
+```ruby
+  configuration limit_key: { body: [:response, :max], parameter: :max }
+```
+
 `pagination_key` key used to paginate multiple pages (e.g. `offset`, `page`, `startAt` etc.).
 
+In case the `pagination_key` parameter differs for where it's located in the body and how it's provided as get parameter, when retreiving pages, provide a hash with `body` and `paramter` key, to keep those two use cases separated:
+
+```ruby
+  configuration pagination_key: { body: [:response, :page], parameter: :page }
+```
+
 `pagination_strategy` used to configure the strategy used for navigating (e.g. `offset`, `page`, `start`, etc.).
 
 `total_key` key used to determine the total amount of items (e.g. `total`, `totalResults`, etc.).

data/cider-ci/bin/bundle

@@ -22,6 +22,9 @@ fi
 DIGEST=$(echo "$DIGEST $PATH" \
  | openssl dgst -sha1 | cut -d ' ' -f 2)
 
+echo "DIGEST"
+echo "${DIGEST}"
+
 CACHE_SIGNATURE_FILE="/tmp/bundle_cache_signature_${DIGEST}"
 
 if [ ! -f  $CACHE_SIGNATURE_FILE ] ; then

data/lhs.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport', '> 4.2'
   s.add_dependency 'activemodel'
 
-  s.add_development_dependency 'rspec-rails', '>= 3.0.0'
+  s.add_development_dependency 'rspec-rails', '>= 3.7.0'
   s.add_development_dependency 'rails', '>= 4.0.0'
   s.add_development_dependency 'webmock'
   s.add_development_dependency 'pry'

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

@@ -23,9 +23,9 @@ class LHS::Record
         batch_size = options[:batch_size] || LHS::Pagination::Base::DEFAULT_LIMIT
         params = options[:params] || {}
         loop do # as suggested by Matz
-          data = request(params: params.merge(limit_key => batch_size, pagination_key => start))
-          batch_size = data._raw[limit_key]
-          left = data._raw[total_key].to_i - data._raw[pagination_key].to_i - data._raw[limit_key].to_i
+          data = request(params: params.merge(limit_key(:parameter) => batch_size, pagination_key(:parameter) => start))
+          batch_size = data._raw[limit_key(:parameter)]
+          left = data._raw.dig(*total_key).to_i - data._raw[pagination_key(:parameter)].to_i - data._raw[limit_key(:paramter)].to_i
           yield new(data)
           break if left <= 0
           start += batch_size

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

@@ -418,8 +418,8 @@ class LHS::Record
         end
         pagination = @record_class.pagination_class
         {
-          @record_class.pagination_key => pagination.page_to_offset(page, per),
-          @record_class.limit_key => per
+          @record_class.pagination_key(:parameter) => pagination.page_to_offset(page, per),
+          @record_class.limit_key(:parameter) => per
         }
       end
 

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

@@ -32,9 +32,10 @@ class LHS::Record
         )
       end
 
-      def limit_key
+      def limit_key(type = nil)
         symbolize_unless_complex(
-          @configuration.try(:[], :limit_key) || :limit
+          pagination_parameter(@configuration.try(:[], :limit_key), type) ||
+          :limit
         )
       end
 
@@ -45,9 +46,10 @@ class LHS::Record
       end
 
       # Key used for determine current page
-      def pagination_key
+      def pagination_key(type = nil)
         symbolize_unless_complex(
-          @configuration.try(:[], :pagination_key) || :offset
+          pagination_parameter(@configuration.try(:[], :pagination_key), type) ||
+          :offset
         )
       end
 
@@ -65,6 +67,11 @@ class LHS::Record
         return value.to_sym unless value.is_a?(Array)
         value
       end
+
+      def pagination_parameter(configuration, type)
+        return configuration unless configuration.is_a?(Hash)
+        configuration[type]
+      end
     end
   end
 end

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

@@ -41,7 +41,7 @@ class LHS::Record
       # returned by the endpoint to make further requests
       def apply_limit!(options)
         options[:params] ||= {}
-        options[:params] = options[:params].merge(limit_key => options[:params][limit_key] || LHS::Pagination::Base::DEFAULT_LIMIT)
+        options[:params] = options[:params].merge(limit_key(:parameter) => options[:params][limit_key(:parameter)] || LHS::Pagination::Base::DEFAULT_LIMIT)
       end
 
       # Convert URLs in options to endpoint templates
@@ -230,11 +230,11 @@ class LHS::Record
       def load_and_merge_not_paginated_collection!(data, options)
         return if data.length.zero?
         options = options.is_a?(Hash) ? options : {}
-        limit = options.dig(:params, limit_key) || pagination_class::DEFAULT_LIMIT
-        offset = options.dig(:params, pagination_key) || pagination_class::DEFAULT_OFFSET
+        limit = options.dig(:params, limit_key(:parameter)) || pagination_class::DEFAULT_LIMIT
+        offset = options.dig(:params, pagination_key(:parameter)) || pagination_class::DEFAULT_OFFSET
         options[:params] = options.fetch(:params, {}).merge(
-          limit_key => limit,
-          pagination_key => pagination_class.next_offset(
+          limit_key(:parameter) => limit,
+          pagination_key(:parameter) => pagination_class.next_offset(
             offset,
             limit
           )
@@ -245,8 +245,16 @@ class LHS::Record
         end
       end
 
+      # sets nested data for a source object that needs to be accessed with a given path e.g. [:response, :total]
+      def set_nested_data(source, path, value)
+        return source[path] = value unless path.is_a?(Array)
+        path = path.dup
+        last = path.pop
+        path.inject(source, :fetch)[last] = value
+      end
+
       def load_and_merge_paginated_collection!(data, options)
-        data._raw[limit_key] = data.length if data._raw[limit_key].blank? && !data.length.zero?
+        set_nested_data(data._raw, limit_key(:body), data.length) if data._raw.dig(*limit_key(:body)).blank? && !data.length.zero?
         pagination = data._record.pagination(data)
         return data if pagination.pages_left.zero?
         record = data._record
@@ -315,7 +323,7 @@ class LHS::Record
 
       # Checks if given raw is paginated or not
       def paginated?(raw)
-        !!(raw.is_a?(Hash) && raw[total_key])
+        !!(raw.is_a?(Hash) && raw.dig(*total_key))
       end
 
       def prepare_options_for_include_all_request!(options)
@@ -336,10 +344,10 @@ class LHS::Record
         uri = parse_uri(option[:url], option)
         get_params = Rack::Utils.parse_nested_query(uri.query)
           .symbolize_keys
-          .except(limit_key, pagination_key)
+          .except(limit_key(:parameter), pagination_key(:parameter))
         option[:params] ||= {}
         option[:params].reverse_merge!(get_params)
-        option[:params][limit_key] ||= LHS::Pagination::Base::DEFAULT_LIMIT
+        option[:params][limit_key(:parameter)] ||= LHS::Pagination::Base::DEFAULT_LIMIT
         option[:url] = option[:url].gsub("?#{uri.query}", '')
         option.delete(:including)
         option.delete(:referencing)
@@ -357,9 +365,13 @@ class LHS::Record
 
       def merge_batch_data_with_parent!(batch_data, parent_data)
         parent_data.concat(input: parent_data._raw, items: batch_data.raw_items, record: self)
-        parent_data._raw[limit_key] = batch_data._raw[limit_key]
-        parent_data._raw[total_key] = batch_data._raw[total_key]
-        parent_data._raw[pagination_key] = batch_data._raw[pagination_key]
+        [limit_key(:body), total_key, pagination_key(:body)].each do |pagination_attribute|
+          set_nested_data(
+            parent_data._raw,
+            pagination_attribute,
+            batch_data._raw.dig(*pagination_attribute)
+          )
+        end
       end
 
       # Merge explicit params nested in 'params' namespace with original hash.
@@ -415,8 +427,8 @@ class LHS::Record
         pagination.pages_left.times do |index|
           page_options = {
             params: {
-              record.limit_key => pagination.limit,
-              record.pagination_key => pagination.next_offset(index + 1)
+              record.limit_key(:parameter) => pagination.limit,
+              record.pagination_key(:parameter) => pagination.next_offset(index + 1)
             }
           }
           page_options[:parent_data] = parent_data if parent_data

data/lib/lhs/pagination/base.rb

@@ -19,11 +19,11 @@ module LHS::Pagination
     alias count total
 
     def limit
-      data._raw.dig(*_record.limit_key) || DEFAULT_LIMIT
+      data._raw.dig(*_record.limit_key(:body)) || DEFAULT_LIMIT
     end
 
     def offset
-      data._raw.dig(*_record.pagination_key) || self.class::DEFAULT_OFFSET
+      data._raw.dig(*_record.pagination_key(:body)) || self.class::DEFAULT_OFFSET
     end
     alias current_page offset
     alias start offset

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = '14.4.0'
+  VERSION = '14.5.0'
 end

data/spec/pagination/parameters_spec.rb

@@ -0,0 +1,59 @@
+require 'rails_helper'
+require 'webrick'
+
+describe LHS::Record do
+
+  before(:each) do
+    class Location < LHS::Record
+      endpoint 'http://uberall/locations'
+      configuration(
+        limit_key: { body: %i[response max], parameter: :max },
+        pagination_key: { body: %i[response offset], parameter: :offset },
+        total_key: %i[response count],
+        items_key: %i[response locations],
+        pagination_strategy: :offset
+      )
+    end
+  end
+
+  context 'explicit pagination paramters for retreiving pages' do
+
+    it 'uses explicit parameters when retreiving pages' do
+      stub_request(:get, "http://uberall/locations?max=100")
+        .to_return(body: {
+          response: {
+            locations: 10.times.map { |_| { name: WEBrick::Utils.random_string(10) } },
+            max: 10,
+            offset: 0,
+            count: 30
+          }
+        }.to_json)
+
+      stub_request(:get, "http://uberall/locations?max=10&offset=10")
+        .to_return(body: {
+          response: {
+            locations: 10.times.map { |_| { name: WEBrick::Utils.random_string(10) } },
+            max: 10,
+            offset: 10,
+            count: 30
+          }
+        }.to_json)
+
+      stub_request(:get, "http://uberall/locations?max=10&offset=20")
+        .to_return(body: {
+          response: {
+            locations: 10.times.map { |_| { name: WEBrick::Utils.random_string(10) } },
+            max: 10,
+            offset: 20,
+            count: 30
+          }
+        }.to_json)
+
+      locations = Location.all.fetch
+      expect(locations.length).to eq 30
+      expect(locations.count).to eq 30
+      expect(locations.offset).to eq 20
+      expect(locations.limit).to eq 10
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 14.4.0
+  version: 14.5.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -344,6 +344,7 @@ files:
 - spec/item/warning_codes_spec.rb
 - spec/item/warnings_spec.rb
 - spec/pagination/pages_left_spec.rb
+- spec/pagination/parameters_spec.rb
 - spec/proxy/create_sub_resource_spec.rb
 - spec/proxy/load_spec.rb
 - spec/proxy/record_identification_spec.rb
@@ -526,6 +527,7 @@ test_files:
 - spec/item/warning_codes_spec.rb
 - spec/item/warnings_spec.rb
 - spec/pagination/pages_left_spec.rb
+- spec/pagination/parameters_spec.rb
 - spec/proxy/create_sub_resource_spec.rb
 - spec/proxy/load_spec.rb
 - spec/proxy/record_identification_spec.rb