lhs 19.10.0 → 21.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57094afc8763a8fe1aab390ad385ac4ddee8c2abd59dd8b8651cd83c07826fef
-  data.tar.gz: 2b06402e0aceb84e5d21aefeb15321610a6b13ada2959b6286434d8725578b13
+  metadata.gz: 80228cca0e4b14a7a21cf408db24114f85648afccc58fbc658fbe7ef579b69a9
+  data.tar.gz: 774070abf3a426ef7f68c9ee707c540f53c91499f8576220fcae2e610baca1bd
 SHA512:
-  metadata.gz: ae00456701d8fa85fdf0e3f8d3d14eb58d87f1c87719b5ac2916959ebd449853f7a061a239fda5debc45faa0d34bb265f3cf429b584eba63cf2969a38b3c3ebe
-  data.tar.gz: 0b142fc761ccda98c5524bd0810ca0147fd9a5d4ec923b4986cdc3698bce8f1881b240c8c3113d9f09d1c57ca92925848d29690d0da5fde0a099a7757b3e81a0
+  metadata.gz: 33f14c2fe5cd5e6cc9a8bdbee060d247bc3f62fe9a3dfde38ff87aadb4370de371996455a4ea55865c2ee13aa7b3728e405c73ad7185e29ec48a8f2a657b750d
+  data.tar.gz: 8aebc91f90fe095c4dc7d0d10dd8c389c0b1935928299421fce9df6c6245caa69a4991ce9f9a73758b5e316ea871a4437b7128243413634e4e7949ce96ac9405

data/Gemfile

@@ -1,13 +1,4 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org/'
-
-# Declare your gem's dependencies in lhs.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
 gemspec
-
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.

data/README.md

@@ -139,7 +139,9 @@ record.review # "Lunch was great
       * [Request tracing](#request-tracing)
       * [Extended Rollbar Logging](#extended-rollbar-logging)
       * [Testing with LHS](#testing-with-lhs)
-         * [Test helper for request cycle cache](#test-helper-for-request-cycle-cache)
+         * [Test helper](#test-helper)
+            * [Stub](#stub)
+               * [Stub All](#stub-all)
          * [Test query chains](#test-query-chains)
             * [By explicitly resolving the chain: fetch](#by-explicitly-resolving-the-chain-fetch)
             * [Without resolving the chain: where_values_hash](#without-resolving-the-chain-where_values_hash)
@@ -1629,6 +1631,15 @@ POST https://service.example.com/records/1z-5r1fkaj { body: "{ 'name': 'Starbuck
 
 -> See [record validation](#record-validation) for how to handle validation errors when updating records.
 
+You can also pass explicit request options to `update`, by passing two explicit hashes:
+
+```ruby
+# app/controllers/some_controller.rb
+
+record.update({ recommended: true }, { method: 'put' })
+
+```
+
 ##### partial_update
 
 `partial_update` updates just the provided parameters.
@@ -1660,6 +1671,15 @@ POST https://service.example.com/records/1z-5r1fkaj { body: "{ 'name': 'Starbuck
 
 -> See [record validation](#record-validation) for how to handle validation errors when updating records.
 
+You can also pass explicit request options to `partial_update`, by passing two explicit hashes:
+
+```ruby
+# app/controllers/some_controller.rb
+
+record.partial_update({ recommended: true }, { method: 'put' })
+
+```
+
 #### Endpoint url parameter injection during record creation/change
 
 LHS injects parameters provided to `create`, `update`, `partial_update`, `save` etc. into an endpoint's URL when matching:
@@ -2502,17 +2522,70 @@ it 'displays contracts' do
 end
 ```
 
-### Test helper for request cycle cache
+### Test helper
 
-In order to not run into caching issues during your tests, when (request cycle cache)[#request-cycle-cache] is enabled, simply require the following helper in your tests:
+In order to load LHS test helpers into your tests, add the following to your spec helper:
 
 ```ruby
 # spec/spec_helper.rb
 
-require 'lhs/test/request_cycle_cache_helper'
+require 'lhs/rspec'
+```
+
+This e.g. will prevent running into caching issues during your tests, when (request cycle cache)[#request-cycle-cache] is enabled.
+It will initialize a MemoryStore cache for LHC::Caching interceptor and resets the cache before every test.
+
+#### Stub
+
+LHS offers stub helpers that simplify stubbing https request to your apis through your defined Records.
+
+##### stub_all
+
+`Record.stub_all(url, items, additional_options)`
+
+```ruby
+# your_spec.rb
+
+before do
+  class Record < LHS::Record
+    endpoint 'https://records'
+  end
+
+  Record.stub_all(
+    'https://records',
+    200.times.map{ |index| { name: "Item #{index}" } },
+    headers: {
+      'Authorization' => 'Bearer 123'
+    }
+  )
+end
+```
+```
+GET https://records?limit=100
+GET https://records?limit=100&offset=100
 ```
 
-This will initialize a MemoryStore cache for LHC::Caching interceptor and resets the cache before every test.
+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
 

data/lhs.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activemodel'
   s.add_dependency 'activesupport', '>= 4.2.11'
   s.add_dependency 'lhc', '~> 10.2'
+  s.add_dependency 'local_uri'
 
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'json', '>=  1.8.2'
@@ -35,6 +36,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails', '>= 3.7.0'
   s.add_development_dependency 'rubocop', '~> 0.57.1'
   s.add_development_dependency 'rubocop-rspec', '~> 1.26.0'
+  s.add_development_dependency 'sprockets', '< 4'
   s.add_development_dependency 'webmock'
 
   s.license = 'GPL-3'

data/lib/lhs/concerns/option_blocks.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require 'active_support/per_thread_registry'
 
 module LHS
   module OptionBlocks

data/lib/lhs/interceptors/extended_rollbar/thread_registry.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require 'active_support/per_thread_registry'
 
 module LHS
   module Interceptors

data/lib/lhs/interceptors/request_cycle_cache/thread_registry.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support'
+require 'active_support/per_thread_registry'
 
 module LHS
   module Interceptors

data/lib/lhs/{test/request_cycle_cache_helper.rb → rspec.rb}

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'lhs'
+require 'lhs/test/stubbable_records'
+
 RSpec.configure do |config|
   config.before(:each) do
     LHS.config.request_cycle_cache.clear

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 = '19.10.0'
+  VERSION = '21.0.0'
 end

data/spec/stubs/all_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'lhs/rspec'
+
+describe LHS do
+
+  before do
+    class Record < LHS::Record
+      endpoint 'https://records'
+    end
+
+    Record.stub_all(
+      'https://records',
+      200.times.map { |index| { name: "Item #{index}" } },
+      headers: {
+        'Authorization' => 'Bearer 123'
+      }
+    )
+  end
+
+  it 'stubs all requests' do
+    records = Record.options(headers: { 'Authorization' => 'Bearer 123' }).all.fetch
+    expect(records.count).to eq 200
+    expect(records.length).to eq 200
+    expect(records.first.name).to eq 'Item 0'
+  end
+
+  context 'without conditions' do
+
+    before do
+      class Record < LHS::Record
+        endpoint 'https://records'
+      end
+
+      Record.stub_all(
+        'https://records',
+        200.times.map { |index| { name: "Item #{index}" } }
+      )
+    end
+
+    it 'stubs all requests without a webmock "with"' 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
+
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 19.10.0
+  version: 21.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-12 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: local_uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.26.0
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -300,7 +328,8 @@ files:
 - lib/lhs/proxy.rb
 - lib/lhs/railtie.rb
 - lib/lhs/record.rb
-- lib/lhs/test/request_cycle_cache_helper.rb
+- lib/lhs/rspec.rb
+- lib/lhs/test/stubbable_records.rb
 - lib/lhs/unprocessable.rb
 - lib/lhs/version.rb
 - script/ci/build.sh
@@ -487,6 +516,7 @@ files:
 - spec/request_cycle_cache_spec.rb
 - spec/require_lhs_spec.rb
 - spec/spec_helper.rb
+- spec/stubs/all_spec.rb
 - spec/support/fixtures/json/feedback.json
 - spec/support/fixtures/json/feedbacks.json
 - spec/support/fixtures/json/localina_content_ad.json
@@ -514,8 +544,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Ruby >= 2.3.0
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: 'REST services accelerator: Rails gem providing an easy, active-record-like
@@ -703,6 +732,7 @@ test_files:
 - spec/request_cycle_cache_spec.rb
 - spec/require_lhs_spec.rb
 - spec/spec_helper.rb
+- spec/stubs/all_spec.rb
 - spec/support/fixtures/json/feedback.json
 - spec/support/fixtures/json/feedbacks.json
 - spec/support/fixtures/json/localina_content_ad.json