kontent-delivery-sdk-ruby 2.0.11 → 2.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10a1940690541523126a2bd9f3767e54a68de48c14ca7acfb311f392e0cb3707
-  data.tar.gz: 80b485b19bef5ddc40e8964133b96dc0c1d3543f2c477c704973502c86495832
+  metadata.gz: 63493f8b5e33379100aa54f2f2b4ce45c6ef5ea07d16b837681522bbbcd8ba74
+  data.tar.gz: 552a3f50c6fcda4a363d5312c0c483956f56d35f11661831a8520f325c34b089
 SHA512:
-  metadata.gz: e11259c855f2dc4caf3146a704b0330acf6314d68cff4259a1acb03c60bee8359b567f68d10c033e2fef3bd36a51da864f8f5501485b032e05feba6b37f0a57b
-  data.tar.gz: 0a4ab01bb8be8744d83faf31ed25e35fa986b1fedaf531e7c85978138a3e58563ead1e5d19ba42e494af9d79ba73bedc87e3f1c0ea80088582a3b06790f6dbeb
+  metadata.gz: 90500abcbe775f08759ae9439e7d388db95cf8072825c0010054a63ccb79334d8055629794ff22b472cb995439f8fa737d9a297f9afe8b87172557ed8c87ad1d
+  data.tar.gz: 3e80ccb8eb5df8d5a8f898c19e15203494e680b0700d8b751174590c3942eecf0d4dd99a4ec90b0976e131620a3c42f83bfd84bfdfeee883e4ece9e09112be1a

data/README.md

@@ -244,6 +244,18 @@ delivery_client.item('about_us')
   .execute
 ```
 
+### Providing custom headers
+
+If you want to pass custom headers in the request, you can use `custom_headers`. This could be useful when you are developing your package on top of the SDK.
+
+Note that you can not override internal headers such as `Authorization`. If headers with an existing key are passed into the method, they will be ignored.
+
+```ruby
+delivery_client.items
+  .custom_headers({ 'MY-HEADER' => 'HEADER VALUE' })
+  .execute
+```
+
 ### Custom URLs
 
 When you have a URL (i.e. `next_page` for paging, for testing purposes, or if you prefer to build it on your own) and still want to leverage SDK functionality such as rich text resolving, use the .url method:

data/lib/delivery/client/delivery_query.rb

@@ -62,11 +62,6 @@ module Kentico
         # * *Returns*:
         #   - Kentico::Kontent::Delivery::Responses::ResponseBase or a class extending it
         def execute
-          headers = @headers.clone
-          headers['X-KC-SDKID'] = provide_sdk_header
-          headers['Authorization'] = "Bearer #{preview_key}" if should_preview
-          headers['Authorization'] = "Bearer #{secure_key}" if !should_preview && secure_key
-
           resp = Kentico::Kontent::Delivery::RequestManager.start self, headers
           yield resp if block_given?
           resp
@@ -230,8 +225,39 @@ module Kentico
           @url
         end
 
+        # Allows providing custom headers for client requests.
+        # See https://github.com/Kentico/kontent-delivery-sdk-ruby#providing-custom-headers
+        #
+        # * *Args*:
+        #   - *headers* (+Hash+) A hash that corresponds to provided headers
+        #
+        # * *Returns*:
+        #   - +self+
+        def custom_headers(headers)
+          @custom_headers = headers
+          self
+        end
+
         private
 
+        # Returns request headers that are extended with custom headers.
+        # Custom headers do not override existing headers.
+        #
+        # * *Returns*
+        #   - +Hash+
+        def headers
+          headers = @headers.clone
+          headers['X-KC-SDKID'] = provide_sdk_header
+          headers['Authorization'] = "Bearer #{preview_key}" if should_preview
+          headers['Authorization'] = "Bearer #{secure_key}" if !should_preview && secure_key
+
+          if @custom_headers
+            headers.merge!(@custom_headers) { |key, v1, v2| v1 }
+          end
+
+          headers
+        end
+
         # Initializes the +query_string+ attribute with the passed array of
         # Kentico::Kontent::Delivery::QueryParameters::Filter objects.
         #

data/lib/delivery/version.rb

@@ -1,7 +1,7 @@
 module Kentico
   module Kontent
     module Delivery
-      VERSION = '2.0.11'.freeze
+      VERSION = '2.0.12'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kontent-delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.11
+  version: 2.0.12
 platform: ruby
 authors:
 - Eric Dugre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -28,40 +28,40 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.4
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.4
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0.rc1
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0.rc1
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0.rc1
 - !ruby/object:Gem::Dependency
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Kentico Kontent Delivery SDK for Ruby