lhs 20.0.0 → 20.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a7bf20f71cff5e170d43991a6bd79ab90fd35e32798663055b074a44d123dc8
-  data.tar.gz: d05a41113ba4e00868cd7c02cb8ca26ff0d0f1ea745ef24f1a8a09771748e42c
+  metadata.gz: 3217c5628886888aef5df940a80a386e8c1a268739bd8937e3580b20937b6601
+  data.tar.gz: 04d3f83972975f96a18b3191a1c922a81c3ede6df18c99fbf386731d103df013
 SHA512:
-  metadata.gz: '0709a3da6db7dcf227254a4aaff48a54a75315ab1a7a281e5ed9ead269a04850a94fb3a906a3192bf86626185af1f0b9f84cd016fb19756f1c9ffa602e6352a4'
-  data.tar.gz: fe62a75e751b4f37215740368a2b68c55a1c130e59e938d5d42b769f1ca4d66f008dde1b2c21dbbc0d9bc1b0cf0bb1492d4385adf0b119e8ef1ec2ff781f63be
+  metadata.gz: bfbbf1039908900cad487407b4d3886cc8f371d7deef76ea4ed59fdd77f8df175ad9ca52786ee64f2bc7f900dfa6bf63b05b8de1a6e17ea4ad9eccefdd16fb60
+  data.tar.gz: ef68c523a6cb8c6aec0bf34d37c9997879961b87621ec24308cf218607eea5f747981be8ff3991949a71a3eaba8282d6bd9857ede708888a3aee26b3024b323f

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)
@@ -2533,6 +2535,32 @@ 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.
+
+##### Stub All
+
+`LHS.stub.all(url, items, additional_options)`
+
+```ruby
+# your_spec.rb
+
+before do
+  LHS.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
+```
+
 ### Test query chains
 
 #### By explicitly resolving the chain: fetch

data/lhs.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'json', '>=  1.8.2'
+  s.add_development_dependency 'local_uri'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rails', '>= 4.2.11'

data/lib/lhs/rspec.rb

@@ -1,9 +1,19 @@
 # frozen_string_literal: true
 
 require 'lhs'
+require 'lhs/test/stub'
 
 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/stub.rb

@@ -0,0 +1,29 @@
+# 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?
+          stub_request(:get, uri.to_s)
+            .with(options)
+            .to_return(
+              body: {
+                items: batch,
+                offset: index * DEFAULT_LIMIT,
+                total: items.length
+              }.to_json
+            )
+        end
+      end
+    end
+  end
+end

data/lib/lhs/version.rb

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

data/spec/stubs/all_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require 'lhs/rspec'
+
+describe LHS do
+
+  before do
+    class Record < LHS::Record
+      endpoint 'https://records'
+    end
+
+    LHS.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
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 20.0.0
+  version: 20.1.1
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: local_uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -301,6 +315,7 @@ files:
 - lib/lhs/railtie.rb
 - lib/lhs/record.rb
 - lib/lhs/rspec.rb
+- lib/lhs/test/stub.rb
 - lib/lhs/unprocessable.rb
 - lib/lhs/version.rb
 - script/ci/build.sh
@@ -487,6 +502,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
@@ -703,6 +719,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