lhs 19.7.0 → 19.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267b853caadad4c6709bd01b799f4679fcc0a7efda0d9aba1241a2ec52948628
-  data.tar.gz: b627506faa83289f4b13b714fd459207ed81706236148a8dd98cca263f118e8e
+  metadata.gz: a6e339382991cfdddacfa4fe2c8e63b3fe03e6a25f897d7d2d0d87cdc3ebd28f
+  data.tar.gz: 65ecc97eac88e673a47bca919d7573c874806a13cb487a787100afffccf71ec9
 SHA512:
-  metadata.gz: 80341435042e936ecc1d6cb3e80ab240836c5a4f885c75c0519823b697aa852c5c82ac9d355cd05a49964b8748926b70a4c0c159c2b978cac8917e77343b4dcd
-  data.tar.gz: c667486950b86fb685e9b58ac224d7125d448e92ba61a8341b53325089831773e2331c8d3a7ca45224fe4d2ec5c2b3a79581416b9eb26bcedc7f10cca7f56c99
+  metadata.gz: 407bc810256e1503ab507385ef10e5711c47935ca7f2d070da8c5298c889a198bbd86401bd0206d3c3bef9c9ba4ad76d66654bce8e451a5ad278361488bba39b
+  data.tar.gz: 35d7f32e5eb28a95071b63d26d2c6211b37ea1354d90fb2c9e740fe93856e723ccaacddc5982f9663515261eac712454cf1443fef24b53ee660f82a75689198a

data/README.md

@@ -46,6 +46,7 @@ record.review # "Lunch was great
          * [Endpoints](#endpoints)
             * [Configure endpoint hosts](#configure-endpoint-hosts)
             * [Endpoint Priorities](#endpoint-priorities)
+         * [Provider](#provider)
          * [Record inheritance](#record-inheritance)
          * [Find multiple records](#find-multiple-records)
             * [fetch](#fetch)
@@ -260,6 +261,44 @@ GET https://service.example.com/records
 
 **Be aware that, if you configure ambigious endpoints accross multiple classes, the order of things is not deteministic. Ambigious endpoints accross multiple classes need to be avoided.**
 
+### Provider
+
+Providers in LHS allow you to group shared endpoint options under a common provider.
+
+```ruby
+# app/models/provider/base_record.rb
+
+module Provider
+  class BaseRecord < LHS::Record
+    provider params: { api_key: 123 }
+  end
+end
+```
+
+Now every record, part of that particular provider can inherit the provider's `BaseRecord`.
+
+```ruby
+# app/models/provider/account.rb
+
+module Provider
+  class Account < BaseRecord
+    endpoint '{+host}/records'
+    endpoint '{+host}/records/{id}'
+  end
+end
+```
+
+```ruby
+# app/controllers/some_controller.rb
+
+Provider::Account.find(1)
+```
+```
+GET https://provider/records/1?api_key=123
+```
+
+And requests made via those provider records apply the common provider options.
+
 ### Record inheritance
 
 You can inherit from previously defined records and also inherit endpoints that way:

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext'
+
+class LHS::Record
+
+  # A provider can define options used for that specific provider
+  module Provider
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :provider_options unless defined? provider_options
+      self.provider_options = nil
+    end
+
+    module ClassMethods
+      def provider(options = nil)
+        self.provider_options = options
+      end
+    end
+  end
+end

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

@@ -495,7 +495,9 @@ class LHS::Record
         options[:ignored_errors] = ignored_errors if ignored_errors.present?
         options[:params]&.deep_symbolize_keys!
         options[:error_handler] = merge_error_handlers(options[:error_handler]) if options[:error_handler]
-        options = (endpoint.options || {}).deep_merge(options)
+        options = (provider_options || {})
+          .deep_merge(endpoint.options || {})
+          .deep_merge(options)
         options[:url] = compute_url!(options[:params]) unless options.key?(:url)
         merge_explicit_params!(options[:params])
         options.delete(:params) if options[:params]&.empty?

data/lib/lhs/record.rb

@@ -33,6 +33,8 @@ class LHS::Record
     'lhs/concerns/record/model'
   autoload :Pagination,
     'lhs/concerns/record/pagination'
+  autoload :Provider,
+    'lhs/concerns/record/provider'
   autoload :Request,
     'lhs/concerns/record/request'
   autoload :Relations,
@@ -69,6 +71,7 @@ class LHS::Record
   include Merge
   include Model
   include Pagination
+  include Provider
   include Request
   include Relations
   include RequestCycleCache

data/lib/lhs/version.rb

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

data/spec/record/provider_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe LHS::Record do
+  context 'provider' do
+
+    before do
+      module Provider
+        class BaseRecord < LHS::Record
+          provider params: { api_key: 123 }
+        end
+
+        class Record < Provider::BaseRecord
+          endpoint 'http://provider/records'
+        end
+      end
+
+      class AnotherRecord < LHS::Record
+        endpoint 'http://other_provider/records'
+      end
+
+      stub_request(:get, "http://provider/records?id=1&api_key=123")
+        .to_return(body: { name: 'Steve' }.to_json)
+
+      stub_request(:get, "http://other_provider/records?id=1")
+        .to_return(body: { name: 'Not Steve' }.to_json)
+    end
+
+    it 'applies provider options when making requests to that provider' do
+      record = Provider::Record.find(1)
+      expect(record.name).to eq 'Steve'
+    end
+
+    it 'does not apply provider options when making requests to other records' do
+      Provider::Record.find(1)
+      record = AnotherRecord.find(1)
+      expect(record.name).to eq 'Not Steve'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 19.7.0
+  version: 19.8.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -257,6 +257,7 @@ files:
 - lib/lhs/concerns/record/merge.rb
 - lib/lhs/concerns/record/model.rb
 - lib/lhs/concerns/record/pagination.rb
+- lib/lhs/concerns/record/provider.rb
 - lib/lhs/concerns/record/relations.rb
 - lib/lhs/concerns/record/request.rb
 - lib/lhs/concerns/record/request_cycle_cache/interceptor.rb
@@ -445,6 +446,7 @@ files:
 - spec/record/pagination_links_spec.rb
 - spec/record/pagination_spec.rb
 - spec/record/persisted_spec.rb
+- spec/record/provider_spec.rb
 - spec/record/references_spec.rb
 - spec/record/relation_caching_spec.rb
 - spec/record/reload_by_id_spec.rb
@@ -656,6 +658,7 @@ test_files:
 - spec/record/pagination_links_spec.rb
 - spec/record/pagination_spec.rb
 - spec/record/persisted_spec.rb
+- spec/record/provider_spec.rb
 - spec/record/references_spec.rb
 - spec/record/relation_caching_spec.rb
 - spec/record/reload_by_id_spec.rb