lhs 20.1.4 → 21.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90bb5680db8b584ee9597cf6e3029014f05a56704de09cecb8f4b9788ff0bbdf
-  data.tar.gz: 1403e9844367ef3cc13c2987368d219b12db90700178b26bfacba1f3690346f7
+  metadata.gz: 80228cca0e4b14a7a21cf408db24114f85648afccc58fbc658fbe7ef579b69a9
+  data.tar.gz: 774070abf3a426ef7f68c9ee707c540f53c91499f8576220fcae2e610baca1bd
 SHA512:
-  metadata.gz: 5c8c37a17da7d96fb7f397425dcf74440e3a3d3a562eecf142992546b58c07cefa7527166b8ba26131e3e025ca823b3d78c3f98a1d8cb0c974394e9887b623c6
-  data.tar.gz: 187cf1be11baf4d8c32cb9521e4eeb283152b5b026b06e67d2e548deb649c36957fc6fa91b2d5d577e45de90382faf4fed80dd999cdfad161ae647753df28a94
+  metadata.gz: 33f14c2fe5cd5e6cc9a8bdbee060d247bc3f62fe9a3dfde38ff87aadb4370de371996455a4ea55865c2ee13aa7b3728e405c73ad7185e29ec48a8f2a657b750d
+  data.tar.gz: 8aebc91f90fe095c4dc7d0d10dd8c389c0b1935928299421fce9df6c6245caa69a4991ce9f9a73758b5e316ea871a4437b7128243413634e4e7949ce96ac9405

data/README.md

@@ -2537,17 +2537,21 @@ It will initialize a MemoryStore cache for LHC::Caching interceptor and resets t
 
 #### Stub
 
-LHS offers stub helpers that simplify stubbing https request to your apis.
+LHS offers stub helpers that simplify stubbing https request to your apis through your defined Records.
 
-##### Stub All
+##### stub_all
 
-`LHS.stub.all(url, items, additional_options)`
+`Record.stub_all(url, items, additional_options)`
 
 ```ruby
 # your_spec.rb
 
 before do
-  LHS.stub.all(
+  class Record < LHS::Record
+    endpoint 'https://records'
+  end
+
+  Record.stub_all(
     'https://records',
     200.times.map{ |index| { name: "Item #{index}" } },
     headers: {
@@ -2561,6 +2565,28 @@ GET https://records?limit=100
 GET https://records?limit=100&offset=100
 ```
 
+LHS also uses Record configuration when stubbing all.
+```ruby
+# your_spec.rb
+
+before do
+  class Record < LHS::Record
+    configuration limit_key: :per_page, pagination_strategy: :page, pagination_key: :page
+
+    endpoint 'https://records'
+  end
+
+  Record.stub_all(
+    'https://records',
+    200.times.map{ |index| { name: "Item #{index}" } }
+  )
+end
+```
+```
+GET https://records?per_page=100
+GET https://records?per_page=100&page=2
+```
+
 ### Test query chains
 
 #### By explicitly resolving the chain: fetch

data/lib/lhs/rspec.rb

@@ -1,19 +1,10 @@
 # frozen_string_literal: true
 
 require 'lhs'
-require 'lhs/test/stub'
+require 'lhs/test/stubbable_records'
 
 RSpec.configure do |config|
   config.before(:each) do
     LHS.config.request_cycle_cache.clear
   end
-
-  config.before(:all) do
-
-    module LHS
-      def self.stub
-        LHS::Test::Stub
-      end
-    end
-  end
 end

data/lib/lhs/test/stubbable_records.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'local_uri'
+require 'webmock'
+
+class LHS::Record
+  DEFAULT_LIMIT = LHS::Pagination::Base::DEFAULT_LIMIT
+
+  def self.stub_all(url, items, options = {})
+    extend WebMock::API
+
+    items.each_slice(DEFAULT_LIMIT).with_index do |(*batch), index|
+      uri = LocalUri::URI.new(url)
+      uri.query.merge!(
+        limit_key(:parameter) => DEFAULT_LIMIT
+      )
+      offset = pagination_class.page_to_offset(index + 1, DEFAULT_LIMIT)
+      unless index.zero?
+        uri.query.merge!(
+          pagination_key(:parameter) => offset
+        )
+      end
+      request_stub = stub_request(:get, uri.to_s)
+      request_stub.with(options) if options.present?
+      request_stub.to_return(
+        body: {
+          items: batch,
+          offset: index.zero? ? 0 : offset,
+          total: items.length
+        }.to_json
+      )
+    end
+  end
+end

data/lib/lhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LHS
-  VERSION = '20.1.4'
+  VERSION = '21.0.0'
 end

data/spec/stubs/all_spec.rb

@@ -10,7 +10,7 @@ describe LHS do
       endpoint 'https://records'
     end
 
-    LHS.stub.all(
+    Record.stub_all(
       'https://records',
       200.times.map { |index| { name: "Item #{index}" } },
       headers: {
@@ -33,7 +33,7 @@ describe LHS do
         endpoint 'https://records'
       end
 
-      LHS.stub.all(
+      Record.stub_all(
         'https://records',
         200.times.map { |index| { name: "Item #{index}" } }
       )
@@ -46,4 +46,27 @@ describe LHS do
       expect(records.first.name).to eq 'Item 0'
     end
   end
+
+  context 'with configured record' do
+
+    before do
+      class Record < LHS::Record
+        configuration limit_key: :per_page, pagination_strategy: :page, pagination_key: :page
+
+        endpoint 'https://records'
+      end
+
+      Record.stub_all(
+        'https://records',
+        200.times.map { |index| { name: "Item #{index}" } }
+      )
+    end
+
+    it 'stubs all requests with record configurations for pagination' do
+      records = Record.all.fetch
+      expect(records.count).to eq 200
+      expect(records.length).to eq 200
+      expect(records.first.name).to eq 'Item 0'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 20.1.4
+  version: 21.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -329,7 +329,7 @@ files:
 - lib/lhs/railtie.rb
 - lib/lhs/record.rb
 - lib/lhs/rspec.rb
-- lib/lhs/test/stub.rb
+- lib/lhs/test/stubbable_records.rb
 - lib/lhs/unprocessable.rb
 - lib/lhs/version.rb
 - script/ci/build.sh

data/lib/lhs/test/stub.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'local_uri'
-require 'webmock'
-module LHS
-  module Test
-    class Stub
-      extend WebMock::API
-      DEFAULT_LIMIT = LHS::Pagination::Base::DEFAULT_LIMIT
-
-      def self.all(url, items, options = {})
-        items.each_slice(DEFAULT_LIMIT).with_index do |(*batch), index|
-          uri = LocalUri::URI.new(url)
-          uri.query.merge!(limit: DEFAULT_LIMIT)
-          uri.query.merge!(offset: DEFAULT_LIMIT * index) unless index.zero?
-          request_stub = stub_request(:get, uri.to_s)
-          request_stub.with(options) if options.present?
-          request_stub.to_return(
-            body: {
-              items: batch,
-              offset: index * DEFAULT_LIMIT,
-              total: items.length
-            }.to_json
-          )
-        end
-      end
-    end
-  end
-end