restful_resource 2.2.5 → 2.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: fe060c35468d46b0d26af25f25d4ee1e076dbc93d7002a3d3fd34d724ca7f8ab
-  data.tar.gz: 8eaad0324ee6834eee65ac50d190b1502bc6479825a29dbd7351c35b2a5efb6d
+SHA1:
+  metadata.gz: b0958e356e2525fc286894548cc434ff68486f4c
+  data.tar.gz: e7ca6b8704b648c7d55482d988fa59ee8ab648a0
 SHA512:
-  metadata.gz: 628811833dd6340f11595c8bbab15dfd2928857d0f0669533923b48cafa037016aced821665f71868e43668d07abfa79b66a810cd60e0d7caca14fdacbcaf5a9
-  data.tar.gz: 9adb954ac975fe831bd416de7f1461511ba4a3e3dd0946c7a6c77131e6ad887e98c370967dee289b74c7242d22e57ce542dbe15c34905427004108533b7720e3
+  metadata.gz: c6bde5bde53b14d936f6afbe2e483fc1a99502f6d6b9f58a19f4e4b2b1e50c532d2aae7367b626a8797355ba1439c69d69bc8789d0ca816c19033e9ee8b78fa4
+  data.tar.gz: 7ef2459add247da55d390c2c7dc2caac34f6473d9bd53e23f4be19f455daf054d973c0df27651a5713da024ba4edfb775757a7548be3b8b96dfa9271748d2746

data/lib/restful_resource/base.rb

@@ -8,9 +8,11 @@ module RestfulResource
                        logger: nil,
                        cache_store: nil,
                        instrumentation: {},
+                       context_lambda: nil,
                        faraday_config: nil)
 
       @base_url = URI.parse(base_url)
+      @context_lambda = context_lambda
 
       @http = RestfulResource::HttpClient.new(username: username,
                                               password: password,
@@ -54,7 +56,7 @@ module RestfulResource
 
     def self.put(id, data: {}, headers: {}, **params)
       params_without_options, options = format_params(params)
-      options.delete(:headers)
+      headers.merge! options.delete(:headers)
 
       url = member_url(id, params_without_options)
 
@@ -64,7 +66,7 @@ module RestfulResource
 
     def self.post(data: {}, headers: {}, **params)
       params_without_options, options = format_params(params)
-      options.delete(:headers)
+      headers.merge! options.delete(:headers)
 
       url = collection_url(params_without_options)
 
@@ -119,12 +121,18 @@ module RestfulResource
       replace_parameters(url, params)
     end
 
+    def self.context_lambda
+      superclass.instance_variable_get :@context_lambda
+    end
+
     private
 
     def self.format_params(params = {})
       headers = params.delete(:headers) || {}
 
       headers.merge!(cache_control: 'no-cache') if params.delete(:no_cache)
+      headers.merge!(context_headers) if self.context_lambda
+
       open_timeout = params.delete(:open_timeout)
       timeout = params.delete(:timeout)
 
@@ -184,5 +192,12 @@ module RestfulResource
       array = parse_json(response.body).map { |attributes| self.new(attributes) }
       PaginatedArray.new(array, previous_page_url: prev_url, next_page_url: next_url, total_count: response.headers[:x_total_count])
     end
+
+    def self.context_headers
+      self
+      .context_lambda
+      .call
+      .select { |k,_| k.to_s.start_with?('source_') }
+    end
   end
 end

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '2.2.5'
+  VERSION = '2.2.6'
 end

data/spec/restful_resource/base_spec.rb

@@ -65,6 +65,32 @@ RSpec.describe RestfulResource::Base do
 
       Make.find(12, no_cache: true)
     end
+
+    it 'skips context headers when context_lambda is not set' do
+      expect_get("http://api.carwow.co.uk/makes/12",
+        RestfulResource::Response.new,
+        headers: { cache_control: 'no-cache' })
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(nil)
+
+      Make.find(12, no_cache: true)
+    end
+
+    it 'adds context headers when context_lambda is set' do
+      expect_get("http://api.carwow.co.uk/makes/12",
+        RestfulResource::Response.new,
+        headers: {
+          cache_control: 'no-cache',
+          source_type: 'controller',
+          source_class: 'SomeController',
+          source_identifier: 'index',
+        }
+      )
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(context_lambda).twice
+
+      Make.find(12, no_cache: true)
+    end
   end
 
   describe "#where" do
@@ -106,6 +132,32 @@ RSpec.describe RestfulResource::Base do
 
       Model.where(make_slug: 'Volkswagen', on_sale: true, group_id: 15, no_cache: true)
     end
+
+    it 'skips context headers when context_lambda is not set' do
+      expect_get("http://api.carwow.co.uk/groups/15/makes/Volkswagen/models?on_sale=true",
+        RestfulResource::Response.new,
+        headers: { cache_control: 'no-cache' })
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(nil)
+
+      Model.where(make_slug: 'Volkswagen', on_sale: true, group_id: 15, no_cache: true)
+    end
+
+    it 'adds context headers when context_lambda is set' do
+      expect_get("http://api.carwow.co.uk/groups/15/makes/Volkswagen/models?on_sale=true",
+        RestfulResource::Response.new,
+        headers: {
+          cache_control: 'no-cache',
+          source_type: 'controller',
+          source_class: 'SomeController',
+          source_identifier: 'index',
+        }
+      )
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(context_lambda).twice
+
+      Model.where(make_slug: 'Volkswagen', on_sale: true, group_id: 15, no_cache: true)
+    end
   end
 
   describe "#all" do
@@ -134,6 +186,32 @@ RSpec.describe RestfulResource::Base do
 
       Make.all(no_cache: true)
     end
+
+    it 'skips context headers when context_lambda is not set' do
+      expect_get("http://api.carwow.co.uk/makes",
+        RestfulResource::Response.new,
+        headers: { cache_control: 'no-cache' })
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(nil)
+
+      Make.all(no_cache: true)
+    end
+
+    it 'adds context headers when context_lambda is set' do
+      expect_get("http://api.carwow.co.uk/makes",
+        RestfulResource::Response.new,
+        headers: {
+          cache_control: 'no-cache',
+          source_type: 'controller',
+          source_class: 'SomeController',
+          source_identifier: 'index',
+        }
+      )
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(context_lambda).twice
+
+      Make.all(no_cache: true)
+    end
   end
 
   describe "#base_url" do
@@ -194,6 +272,32 @@ RSpec.describe RestfulResource::Base do
 
       Make.action(:average_score).get(no_cache: true)
     end
+
+    it 'skips context headers when context_lambda is not set' do
+      expect_get("http://api.carwow.co.uk/makes/average_score",
+        RestfulResource::Response.new,
+        headers: { cache_control: 'no-cache' })
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(nil)
+
+      Make.action(:average_score).get(no_cache: true)
+    end
+
+    it 'adds context headers when context_lambda is set' do
+      expect_get("http://api.carwow.co.uk/makes/average_score",
+        RestfulResource::Response.new,
+        headers: {
+          cache_control: 'no-cache',
+          source_type: 'controller',
+          source_class: 'SomeController',
+          source_identifier: 'index',
+        }
+      )
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(context_lambda).twice
+
+      Make.action(:average_score).get(no_cache: true)
+    end
   end
 
   describe "#put" do
@@ -244,6 +348,32 @@ RSpec.describe RestfulResource::Base do
 
       Make.put(1, data: {}, headers: { accept: 'application/json' })
     end
+
+    it 'skips context headers when context_lambda is not set' do
+      expect_put("http://api.carwow.co.uk/makes/1",
+        RestfulResource::Response.new,
+        headers: { accept: 'application/json' })
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(nil)
+
+      Make.put(1, data: {}, headers: { accept: 'application/json' })
+    end
+
+    it 'adds context headers when context_lambda is set' do
+      expect_put("http://api.carwow.co.uk/makes/1",
+        RestfulResource::Response.new,
+        headers: {
+          accept: 'application/json',
+          source_type: 'controller',
+          source_class: 'SomeController',
+          source_identifier: 'index',
+        }
+      )
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(context_lambda).twice
+
+      Make.put(1, data: {}, headers: { accept: 'application/json' })
+    end
   end
 
   describe "#post" do
@@ -266,6 +396,32 @@ RSpec.describe RestfulResource::Base do
 
       Make.post(data: {}, headers: { accept: 'application/json' })
     end
+
+    it 'skips context headers when context_lambda is not set' do
+      expect_post("http://api.carwow.co.uk/makes",
+        RestfulResource::Response.new,
+        headers: { accept: 'application/json' })
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(nil)
+
+      Make.post(data: {}, headers: { accept: 'application/json' })
+    end
+
+    it 'adds context headers when context_lambda is set' do
+      expect_post("http://api.carwow.co.uk/makes",
+        RestfulResource::Response.new,
+        headers: {
+          accept: 'application/json',
+          source_type: 'controller',
+          source_class: 'SomeController',
+          source_identifier: 'index',
+        }
+      )
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(context_lambda).twice
+
+      Make.post(data: {}, headers: { accept: 'application/json' })
+    end
   end
 
   describe "#delete" do
@@ -285,6 +441,32 @@ RSpec.describe RestfulResource::Base do
 
       Make.delete(1, headers: { accept: 'application/json' })
     end
+
+    it 'skips context headers when context_lambda is not set' do
+      expect_delete("http://api.carwow.co.uk/makes/1",
+        RestfulResource::Response.new,
+        headers: { accept: 'application/json' })
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(nil)
+
+      Make.delete(1, headers: { accept: 'application/json' })
+    end
+
+    it 'adds context headers when context_lambda is set' do
+      expect_delete("http://api.carwow.co.uk/makes/1",
+        RestfulResource::Response.new,
+        headers: {
+          accept: 'application/json',
+          source_type: 'controller',
+          source_class: 'SomeController',
+          source_identifier: 'index',
+        }
+      )
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(context_lambda).twice
+
+      Make.delete(1, headers: { accept: 'application/json' })
+    end
   end
 
   describe ".as_json" do
@@ -334,6 +516,43 @@ RSpec.describe RestfulResource::Base do
                                       instrumentation: instrumentation,
                                       faraday_config: faraday_config)
     end
+
+    it "stores a lambda when it is defined" do
+      a_lambda = lambda { {context: 'info'} }
+
+      RestfulResource::Base.configure(base_url: 'http://foo.bar',
+                                      instrumentation: {context_lambda: a_lambda})
+
+      RestfulResource::Base.instance_variable_get(:@context_lambda).equal?(a_lambda)
+    end
+  end
+
+  describe ".context_headers" do
+    it "builds headers from keys in context_lambda starting with 'source_' only" do
+      a_lambda = context_lambda(
+        source_present: 'value',
+        random_key: 'should not be present'
+      )
+
+      expect(RestfulResource::Base).to receive(:context_lambda).and_return(a_lambda)
+
+      expect(RestfulResource::Base.context_headers).to eq(
+        source_type: 'controller',
+        source_class: 'SomeController',
+        source_identifier: 'index',
+        source_present: 'value'
+      )
+    end
+  end
+
+  def context_lambda(args = {})
+    lambda do
+      {
+        source_type: 'controller',
+        source_class: 'SomeController',
+        source_identifier: 'index',
+      }.merge(args)
+    end
   end
 
   def response_with_page_information

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 2.2.6
 platform: ruby
 authors:
 - David Santoro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-08 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -258,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A simple activerecord inspired rest resource base class implemented using