lhs 19.6.0 → 19.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27484e8b67d86a110c1e880e53d42f605646754cd0fe7b52369a5dcc381f3d97
-  data.tar.gz: b359ed2464317011e78586fbc1804812b269fa6da8f053028d8bbca946acac18
+  metadata.gz: 267b853caadad4c6709bd01b799f4679fcc0a7efda0d9aba1241a2ec52948628
+  data.tar.gz: b627506faa83289f4b13b714fd459207ed81706236148a8dd98cca263f118e8e
 SHA512:
-  metadata.gz: 779e482a39d72b249c30ed2ab82ab9c26d5fcd922c5d8149bfc1d0bd2838daec87ad1ff170503f532962f6bb07e9806c932c00c630ecae77d4af600aa45f2e6c
-  data.tar.gz: 85ba8a79e1e6b0c8f66fd7c4592636140f61d8a12b1b2d86333bb5ef86f2a2f48a44aeeae51732e1fd54752bcd90456f6951539a59cc5c4f94f7d2a7a875bb95
+  metadata.gz: 80341435042e936ecc1d6cb3e80ab240836c5a4f885c75c0519823b697aa852c5c82ac9d355cd05a49964b8748926b70a4c0c159c2b978cac8917e77343b4dcd
+  data.tar.gz: c667486950b86fb685e9b58ac224d7125d448e92ba61a8341b53325089831773e2331c8d3a7ca45224fe4d2ec5c2b3a79581416b9eb26bcedc7f10cca7f56c99

data/README.md

@@ -45,7 +45,7 @@ record.review # "Lunch was great
       * [Record](#record)
          * [Endpoints](#endpoints)
             * [Configure endpoint hosts](#configure-endpoint-hosts)
-            * [Endpoint priorities](#endpoint-priorities)
+            * [Endpoint Priorities](#endpoint-priorities)
          * [Record inheritance](#record-inheritance)
          * [Find multiple records](#find-multiple-records)
             * [fetch](#fetch)
@@ -81,6 +81,7 @@ record.review # "Lunch was great
                * [Pagination strategy: offset (default)](#pagination-strategy-offset-default)
                * [Pagination strategy: page](#pagination-strategy-page)
                * [Pagination strategy: start](#pagination-strategy-start)
+               * [Pagination strategy: link](#pagination-strategy-link)
             * [Pagination keys](#pagination-keys)
                * [limit_key](#limit_key)
                * [pagination_key](#pagination_key)
@@ -123,7 +124,7 @@ record.review # "Lunch was great
             * [Identify and cast known records when including records](#identify-and-cast-known-records-when-including-records)
             * [Apply options for requests performed to fetch included records](#apply-options-for-requests-performed-to-fetch-included-records)
          * [Record batch processing](#record-batch-processing)
-            * [all](#all)
+            * [all](#all-1)
                * [Using all, when endpoint does not implement response pagination meta data](#using-all-when-endpoint-does-not-implement-response-pagination-meta-data)
             * [find_each](#find_each)
             * [find_in_batches](#find_in_batches)
@@ -132,6 +133,7 @@ record.review # "Lunch was great
       * [Request Cycle Cache](#request-cycle-cache)
          * [Change store for LHS' request cycle cache](#change-store-for-lhs-request-cycle-cache)
          * [Disable request cycle cache](#disable-request-cycle-cache)
+      * [Option Blocks](#option-blocks)
       * [Request tracing](#request-tracing)
       * [Testing with LHS](#testing-with-lhs)
          * [Test helper for request cycle cache](#test-helper-for-request-cycle-cache)
@@ -2315,6 +2317,25 @@ LHS.configure do |config|
   config.request_cycle_cache_enabled = false
 end
 ```
+
+## Option Blocks
+
+In order to apply options to all requests performed in a give block, LHS provides option blocks.
+
+```ruby
+# app/controllers/records_controller.rb
+
+LHS.options(headers: { 'Tracking-Id' => 123 }) do
+  Record.find(1)
+end
+
+Record.find(2)
+```
+```
+GET https://records/1 { headers: { 'Tracking-Id' => '123' } }
+GET https://records/2 { headers: { } }
+```
+
 ## Request tracing
 
 LHS supports tracing the source (in your application code) of http requests being made with methods like `find find_by find_by! first first! last last!`.

data/lib/lhs.rb

@@ -23,6 +23,8 @@ module LHS
     'lhs/concerns/is_href'
   autoload :Item,
     'lhs/item'
+  autoload :OptionBlocks,
+    'lhs/concerns/option_blocks'
   autoload :Pagination,
     'lhs/pagination/base'
   module Pagination
@@ -59,12 +61,12 @@ module LHS
     'lhs/proxy'
   autoload :Record,
     'lhs/record'
-
   autoload :Unprocessable,
     'lhs/unprocessable'
 
   include Configuration
   include AutoloadRecords if defined?(Rails)
+  include OptionBlocks
 
   require 'lhs/record' # as lhs records in an application are directly inheriting it
 

data/lib/lhs/concerns/option_blocks.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module LHS
+  module OptionBlocks
+    extend ActiveSupport::Concern
+
+    class CurrentOptionBlock
+      # Using ActiveSupports PerThreadRegistry to be able to support Active Support v4.
+      # Will switch to thread_mattr_accessor (which comes with Activesupport) when we dropping support for Active Support v5.
+      extend ActiveSupport::PerThreadRegistry
+      attr_accessor :options
+    end
+
+    module ClassMethods
+      def options(options, &block)
+        CurrentOptionBlock.options = options
+        block.call
+      ensure
+        CurrentOptionBlock.options = nil
+      end
+    end
+  end
+end

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

@@ -11,6 +11,7 @@ class LHS::Record
     module ClassMethods
       def request(options)
         options ||= {}
+        options = deep_merge_with_option_blocks(options)
         options = options.freeze
         if options.is_a?(Array)
           multiple_requests(
@@ -23,6 +24,11 @@ class LHS::Record
 
       private
 
+      def deep_merge_with_option_blocks(options)
+        return options if LHS::OptionBlocks::CurrentOptionBlock.options.blank?
+        options.deep_merge(LHS::OptionBlocks::CurrentOptionBlock.options)
+      end
+
       def single_request_load_and_merge_remaining_objects!(data, options, endpoint)
         return if options[:all].blank? || !paginated
         load_and_merge_remaining_objects!(

data/lib/lhs/railtie.rb

@@ -7,6 +7,7 @@ module LHS
 
         def initialize
           prepare_lhs_request_cycle_cache
+          reset_option_blocks
           super
         end
 
@@ -16,6 +17,10 @@ module LHS
           return unless LHS.config.request_cycle_cache_enabled
           LHS::Record::RequestCycleCache::RequestCycleThreadRegistry.request_id = [Time.now.to_f, request.object_id].join('#')
         end
+
+        def reset_option_blocks
+          LHS::OptionBlocks::CurrentOptionBlock.options = nil
+        end
       end
     end
   end

data/lib/lhs/version.rb

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

data/spec/dummy/app/controllers/option_blocks_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class OptionBlocksController < ApplicationController
+
+  def first
+    LHS::OptionBlocks::CurrentOptionBlock.options = { params: { request: 'first' } }
+    Record.where(request: 'second').fetch
+    render text: 'ok'
+  end
+
+  def second
+    Record.where(request: 'second').fetch
+    render text: 'ok'
+  end
+end

data/spec/dummy/config/routes.rb

@@ -12,4 +12,8 @@ Rails.application.routes.draw do
   # Error handling with chains
   get 'error_handling_with_chains/fetch_in_controller' => 'error_handling_with_chains#fetch_in_controller'
   get 'error_handling_with_chains/fetch_in_view' => 'error_handling_with_chains#fetch_in_view'
+
+  # Option Blocks
+  get 'option_blocks/first' => 'option_blocks#first'
+  get 'option_blocks/second' => 'option_blocks#second'
 end

data/spec/option_blocks/ensure_reset_between_requests_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe 'Option Blocks', type: :request do
+  let!(:first_request) do
+    stub_request(:get, "http://datastore/v2/records?request=first")
+      .to_return(status: 200)
+  end
+
+  let!(:second_request) do
+    stub_request(:get, "http://datastore/v2/records?request=second")
+      .to_return(status: 200)
+  end
+
+  it 'always ensures option blocks are always reset for new requests', dummy_models: true do
+    get '/option_blocks/first'
+    expect(first_request).to have_been_made.once
+    get '/option_blocks/second'
+    expect(second_request).to have_been_made.once
+  end
+end

data/spec/option_blocks/main_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::OptionBlocks do
+  let(:status) { 200 }
+
+  before do
+    class Record < LHS::Record
+      endpoint 'http://records'
+    end
+
+    stub_request(:get, 'http://records/?id=1234')
+      .with(headers: { 'Tracking-Id' => 1 })
+      .to_return(status: status)
+  end
+
+  it 'allows to apply options to all requests made within a certain block' do
+    LHS.options(headers: { 'Tracking-Id': 1 }) do
+      Record.find(1234)
+    end
+  end
+
+  it 'ensures that option blocks are reset after the block has been executed' do
+    expect(LHS::OptionBlocks::CurrentOptionBlock.options).to eq nil
+    LHS.options(headers: { 'Tracking-Id': 1 }) do
+      Record.find(1234)
+    end
+    expect(LHS::OptionBlocks::CurrentOptionBlock.options).to eq nil
+  end
+
+  context 'failing request' do
+    let(:status) { 400 }
+
+    it 'ensures that option blocks are reset when an exception occures in the block' do
+      expect(LHS::OptionBlocks::CurrentOptionBlock.options).to eq nil
+      LHS.options(headers: { 'Tracking-Id': 1 }) do
+        begin
+          Record.find(1234)
+        rescue LHC::Error
+        end
+      end
+      expect(LHS::OptionBlocks::CurrentOptionBlock.options).to eq nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 19.6.0
+  version: 19.7.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-12 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -235,6 +235,7 @@ files:
 - lib/lhs/concerns/item/save.rb
 - lib/lhs/concerns/item/update.rb
 - lib/lhs/concerns/item/validation.rb
+- lib/lhs/concerns/option_blocks.rb
 - lib/lhs/concerns/proxy/accessors.rb
 - lib/lhs/concerns/proxy/create.rb
 - lib/lhs/concerns/proxy/link.rb
@@ -319,6 +320,7 @@ files:
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/.keep
 - spec/dummy/app/controllers/error_handling_with_chains_controller.rb
+- spec/dummy/app/controllers/option_blocks_controller.rb
 - spec/dummy/app/controllers/request_cycle_cache_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.keep
@@ -382,6 +384,8 @@ files:
 - spec/item/validation_spec.rb
 - spec/item/warning_codes_spec.rb
 - spec/item/warnings_spec.rb
+- spec/option_blocks/ensure_reset_between_requests_spec.rb
+- spec/option_blocks/main_spec.rb
 - spec/pagination/link/current_page_spec.rb
 - spec/pagination/link/pages_left_spec.rb
 - spec/pagination/link/parallel_spec.rb
@@ -527,6 +531,7 @@ test_files:
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/.keep
 - spec/dummy/app/controllers/error_handling_with_chains_controller.rb
+- spec/dummy/app/controllers/option_blocks_controller.rb
 - spec/dummy/app/controllers/request_cycle_cache_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.keep
@@ -590,6 +595,8 @@ test_files:
 - spec/item/validation_spec.rb
 - spec/item/warning_codes_spec.rb
 - spec/item/warnings_spec.rb
+- spec/option_blocks/ensure_reset_between_requests_spec.rb
+- spec/option_blocks/main_spec.rb
 - spec/pagination/link/current_page_spec.rb
 - spec/pagination/link/pages_left_spec.rb
 - spec/pagination/link/parallel_spec.rb