kontent-delivery-sdk-ruby 2.0.7 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15d6504831ff409615c5246cefb03d1321b4afd54b948e10b020d720d95df6d
-  data.tar.gz: 7712d740ab508da9855b256789dc0c2d683946571b536cbdab1f67c47d88a7e1
+  metadata.gz: 06b0e73160343a8de41de7a8db925bc10aa4c41731408a23942f601852ec00bd
+  data.tar.gz: 1920f1c86c61b75b0e70178cfb77014b926d51414ac6376ce485b3ddaa196843
 SHA512:
-  metadata.gz: 4115b781c67632b2897208b159f22cac02af5aeeb39a6c050a54d40a71332ab36706881866564f67dd7b8446df43b6f80c5ad0dbf741ff3fd35c58e4c2bbb297
-  data.tar.gz: a4d1548dc6a71f64926531c2f27e1eddcd7459191b80256a1ba9812721f1fcc14c47ee35d03fe19c14bee586b80660eb45d9b78d6abdc67a15cd0f07e4e8e24d
+  metadata.gz: 036a5de7909f8ac0be6a73193b1f8fbf934c42666ad83ef3ee819346d9b48c200cb5db5fe8006af17881ad058c21b10c1a437288a3d342996ffd7afadb303149
+  data.tar.gz: 2ebfa148a25fdb4585b8550e51ea0921338c79db07a6e8eff50e8a449e4a1c749f2f90044aefa5a97c27095b9b893292a6573725bc59029f7ee5228ae1329e02

data/README.md

@@ -1,7 +1,7 @@
 [![Build Status](https://api.travis-ci.com/Kentico/kontent-delivery-sdk-ruby.svg?branch=master)](https://travis-ci.com/Kentico/kontent-delivery-sdk-ruby)
 [![Join the chat at https://kentico-community.slack.com](https://img.shields.io/badge/join-slack-E6186D.svg)](https://kentico-community.slack.com)
 [![Stack Overflow](https://img.shields.io/badge/Stack%20Overflow-ASK%20NOW-FE7A16.svg?logo=stackoverflow&logoColor=white)](https://stackoverflow.com/tags/kentico-kontent)
- [![Version](https://img.shields.io/gem/v/delivery-sdk-ruby.svg?style=flat)](https://rubygems.org/gems/delivery-sdk-ruby)
+ [![Version](https://img.shields.io/gem/v/kontent-delivery-sdk-ruby.svg?style=flat)](https://rubygems.org/gems/kontent-delivery-sdk-ruby)
  [![Maintainability](https://api.codeclimate.com/v1/badges/b2e3fae28a2b2601d815/maintainability)](https://codeclimate.com/github/Kentico/kontent-delivery-sdk-ruby/maintainability)
  [![Test coverage](https://api.codeclimate.com/v1/badges/b2e3fae28a2b2601d815/test_coverage)](https://codeclimate.com/github/Kentico/delivery-sdk-ruby/test_coverage)
 
@@ -37,7 +37,7 @@ The site should be accessible at localhost:3000. You can also follow a step-by-s
 To use the SDK in your own project, add the gem to your Gemfile:
 
 ```ruby
-gem 'delivery-sdk-ruby'
+gem 'kontent-delivery-sdk-ruby'
 ```
 
 Then run `bundle install`. You can also download the gem from [RubyGems.org](https://rubygems.org/gems/delivery-sdk-ruby). To use the SDK in an `.rb` file, you need to require it:
@@ -213,7 +213,13 @@ delivery_client.items
 
 ### Responses
 
-All responses from the `.execute` method will be/extend the `Kentico::Kontent::Delivery::Responses::ResponseBase` class which contains an `http_code` attribute and a friendly message that can be displayed by calling `.to_s`. You can check the code to determine if the request was successful:
+All responses from the `.execute` method will be/extend the `Kentico::Kontent::Delivery::Responses::ResponseBase` class which contains the following attributes:
+
+- **http_code**: The HTTP status code of the response
+- **headers**: The headers of the response
+- **json**: The full JSON body of the response
+
+You can check the response code to determine if the request was successful:
 
 ```ruby
 delivery_client.items.execute do |response|
@@ -223,6 +229,7 @@ delivery_client.items.execute do |response|
   when 401
     # Did you forget the secure key?
   else
+    # to_s displays a friendly message with details of the response
     puts response.to_s
   end
 end

data/lib/delivery/client/request_manager.rb

@@ -66,36 +66,38 @@ module Kentico
             when Kentico::Kontent::Delivery::QUERY_TYPE_TAXONOMIES
               respond_taxonomy response
             when Kentico::Kontent::Delivery::QUERY_TYPE_ELEMENT
-              Kentico::Kontent::Delivery::Responses::DeliveryElementResponse.new JSON.parse(response)
+              Kentico::Kontent::Delivery::Responses::DeliveryElementResponse.new response.headers, response.body
             end
           end
 
           def respond_type(response)
             if @query.code_name.nil?
-              Kentico::Kontent::Delivery::Responses::DeliveryTypeListingResponse.new JSON.parse(response)
+              Kentico::Kontent::Delivery::Responses::DeliveryTypeListingResponse.new response.headers, response.body
             else
-              Kentico::Kontent::Delivery::Responses::DeliveryTypeResponse.new JSON.parse(response)
+              Kentico::Kontent::Delivery::Responses::DeliveryTypeResponse.new response.headers, response.body
             end
           end
 
           def respond_taxonomy(response)
             if @query.code_name.nil?
-              Kentico::Kontent::Delivery::Responses::DeliveryTaxonomyListingResponse.new JSON.parse(response)
+              Kentico::Kontent::Delivery::Responses::DeliveryTaxonomyListingResponse.new response.headers, response.body
             else
-              Kentico::Kontent::Delivery::Responses::DeliveryTaxonomyResponse.new JSON.parse(response)
+              Kentico::Kontent::Delivery::Responses::DeliveryTaxonomyResponse.new response.headers, response.body
             end
           end
 
           def respond_item(response)
             if @query.code_name.nil?
               Kentico::Kontent::Delivery::Responses::DeliveryItemListingResponse.new(
-                JSON.parse(response),
+                response.headers,
+                response.body,
                 @query.content_link_url_resolver,
                 @query.inline_content_item_resolver
               )
             else
               Kentico::Kontent::Delivery::Responses::DeliveryItemResponse.new(
-                JSON.parse(response),
+                response.headers,
+                response.body,
                 @query.content_link_url_resolver,
                 @query.inline_content_item_resolver
               )

data/lib/delivery/query_parameters/parameter_base.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module Kentico
   module Kontent
     module Delivery
@@ -6,7 +8,7 @@ module Kentico
         # QueryParameters will appear in the query string.
         class ParameterBase
           attr_accessor :key
-          SEPARATOR = CGI.escape(',')
+          SEPARATOR = CGI::escape(',')
 
           # Constructor.
           #

data/lib/delivery/responses/delivery_element_response.rb

@@ -20,10 +20,11 @@ module Kentico
             )
           end
 
-          def initialize(response)
-            @response = response
+          def initialize(headers, body)
+            @response = JSON.parse(body)
             super 200,
               "Success, '#{element.codename}' returned",
+              headers,
               JSON.generate(@response)
           end
         end

data/lib/delivery/responses/delivery_item_listing_response.rb

@@ -38,12 +38,13 @@ module Kentico
             @items = items
           end
 
-          def initialize(response, content_link_url_resolver, inline_content_item_resolver)
-            @response = response
+          def initialize(headers, body, content_link_url_resolver, inline_content_item_resolver)
+            @response = JSON.parse(body)
             @content_link_url_resolver = content_link_url_resolver
             @inline_content_item_resolver = inline_content_item_resolver
             super 200,
               "Success, #{items.length} items returned",
+              headers,
               JSON.generate(@response)
           end
         end

data/lib/delivery/responses/delivery_item_response.rb

@@ -24,12 +24,13 @@ module Kentico
             )
           end
 
-          def initialize(response, content_link_url_resolver, inline_content_item_resolver)
-            @response = response
+          def initialize(headers, body, content_link_url_resolver, inline_content_item_resolver)
+            @response = JSON.parse(body)
             @content_link_url_resolver = content_link_url_resolver
             @inline_content_item_resolver = inline_content_item_resolver
             super 200,
               "Success, '#{item.system.codename}' returned",
+              headers,
               JSON.generate(@response)
           end
         end

data/lib/delivery/responses/delivery_taxonomy_listing_response.rb

@@ -32,11 +32,12 @@ module Kentico
             @taxonomies = taxonomies
           end
 
-          def initialize(response)
-            @response = response
+          def initialize(headers, body)
+            @response = JSON.parse(body)
 
             super 200,
                   "Success, #{taxonomies.length} taxonomies returned",
+                  headers,
                   JSON.generate(@response)
           end
         end

data/lib/delivery/responses/delivery_taxonomy_response.rb

@@ -18,11 +18,12 @@ module Kentico
             @taxonomy = Kentico::Kontent::Delivery::TaxonomyGroup.new(@response)
           end
 
-          def initialize(response)
-            @response = response
+          def initialize(headers, body)
+            @response = JSON.parse(body)
 
             super 200,
                   "Success, '#{taxonomy.system.codename}' returned",
+                  headers,
                   JSON.generate(@response)
           end
         end

data/lib/delivery/responses/delivery_type_listing_response.rb

@@ -32,10 +32,11 @@ module Kentico
             @types = types
           end
 
-          def initialize(response)
-            @response = response
+          def initialize(headers, body)
+            @response = JSON.parse(body)
             super 200,
                   "Success, #{types.length} types returned",
+                  headers,
                   JSON.generate(@response)
           end
         end

data/lib/delivery/responses/delivery_type_response.rb

@@ -18,10 +18,11 @@ module Kentico
             @type = Kentico::Kontent::Delivery::ContentType.new(@response)
           end
 
-          def initialize(response)
-            @response = response
+          def initialize(headers, body)
+            @response = JSON.parse(body)
             super 200,
                   "Success, type '#{type.system.codename}' returned",
+                  headers,
                   JSON.generate(@response)
           end
         end

data/lib/delivery/responses/response_base.rb

@@ -7,6 +7,7 @@ module Kentico
         class ResponseBase
           attr_accessor :http_code,
                         :message,
+                        :headers,
                         :json
 
           # Constructor.
@@ -14,10 +15,12 @@ module Kentico
           # * *Args*:
           #   - *http_code* (+integer+) The status code returned by the REST request
           #   - *message* (+string+) An informative message about the response, visible when calling +to_s+
+          #   - *headers* (+hash+) The headers of the REST response
           #   - *json* (+string+) _optional_ The complete, unmodified JSON response from the server
-          def initialize(http_code, message, json = '')
+          def initialize(http_code, message, headers, json = '')
             self.http_code = http_code
             self.message = message
+            self.headers = headers
             self.json = json
           end
 

data/lib/delivery/tests/fake_responder.rb

@@ -1,6 +1,7 @@
 require 'dotenv/load'
 require 'pathname'
 require 'cgi'
+require 'ostruct'
 
 module Kentico
   module Kontent
@@ -39,7 +40,10 @@ module Kentico
 
             def respond_generic(url)
               path = Pathname.new(File.dirname(__FILE__) + "/generic#{url}.json")
-              path.read if path.exist?
+              OpenStruct.new(
+                headers: '',
+                body: path.read
+              )
             end
 
             def respond_filtering(query)
@@ -52,12 +56,16 @@ module Kentico
                 when 'elements.price[gt]=20&system.type=grinder'
                   Pathname.new(File.dirname(__FILE__) + '/filtering/multiple.json')
                 end
-              path.read unless path.nil? && !path.exist?
+              OpenStruct.new(
+                headers: '',
+                body: path.read
+              )
+              ##Kentico::Kontent::Delivery::Responses::ResponseBase.new 200, '', '', path.read if path.exist?
             end
 
             def respond_401
               path = Pathname.new(File.dirname(__FILE__) + '/401.json')
-              Kentico::Kontent::Delivery::Responses::ResponseBase.new 401, '', path.read if path.exist?
+              Kentico::Kontent::Delivery::Responses::ResponseBase.new 401, '', '', path.read if path.exist?
             end
           end
         end

data/lib/delivery/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kontent-delivery-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.9
 platform: ruby
 authors:
 - Eric Dugre