delivery-sdk-ruby 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59c57cb2cc1d228224b9951a2732716bb293b834b82bf866d12cafab02477e9d
-  data.tar.gz: a46e51465948bcf93109ef78c022112d90faf19a420835aca1dd80e750b86473
+  metadata.gz: dca4c3262d547c5c78bc08b50bae3eac4c5648c47d504b7e84eb275898dcf15b
+  data.tar.gz: b69230e0daeab4020129b5468828cd335cda552c178a17789a421b44b810cafd
 SHA512:
-  metadata.gz: 4652ca3d42dd905025d2c206a0d24b38c3ff45a9d330b309eb2fe19647b22e9153cae3f3f3abbe1f35f57457464842ea8676cc427dd9db5523bd4efa7c511a47
-  data.tar.gz: 850a8489c97d6dc94e59867f5bb4fddff783e829852c3ad9a0615cdfffc2b735bb97aa2e5d70266b40da12a1b70d8bb0e473d80759d1349df6f41fbec2fc969e
+  metadata.gz: 6ebb05000adcca618e7380b85ebed9be8ed0cd5485381297a918adef67e79e60430f86f8b10615be4d570a574a9ba9b8ab35166946f65134757ccb2023265e50
+  data.tar.gz: 37c0838a7dc73f6465424422f936e79b7f72a63bd1c8756b54b3755b332682deca5d9018d311d50991e470ddca105a50eb7a238d4456b742978c1ded2f05d4ff

data/README.md

@@ -6,6 +6,8 @@
 
 # Delivery Ruby SDK
 
+![Banner](https://github.com/Kentico/delivery-sdk-ruby/blob/master/banner.png)
+
 The Delivery Ruby SDK can be used in Ruby/Rails projects to retrieve content from Kentico Cloud. This is a community project and not an official Kentico SDK. If you find a bug in the SDK or have a feature request, please submit a GitHub issue.
 
 See [How to setup a development environment on Windows](https://github.com/Kentico/delivery-sdk-ruby/wiki/How-to-setup-development-environment-on-Windows) for local development.

data/lib/delivery/client/delivery_query.rb

@@ -71,6 +71,19 @@ module KenticoCloud
         resp
       end
 
+      # Determines whether the query should use preview mode.
+      #
+      # * *Returns*:
+      #   - +boolean+ Whether preview mode should be used for the query
+      #
+      # * *Raises*:
+      #   - +StandardError+ if +use_preview+ is true, but +preview_key+ is +nil+
+      def should_preview
+        raise ERROR_PREVIEW if use_preview && preview_key.nil?
+
+        use_preview && !preview_key.nil?
+      end
+
       # Sets a content link resolver to render links contained in rich text. See
       # https://github.com/Kentico/delivery-sdk-ruby#resolving-links
       #
@@ -226,19 +239,6 @@ module KenticoCloud
         end
       end
 
-      # Determines whether the query should use preview mode.
-      #
-      # * *Returns*:
-      #   - +boolean+ Whether preview mode should be used for the query
-      #
-      # * *Raises*:
-      #   - +StandardError+ if +use_preview+ is true, but +preview_key+ is +nil+
-      def should_preview
-        raise ERROR_PREVIEW if use_preview && preview_key.nil?
-
-        use_preview && !preview_key.nil?
-      end
-
       def provide_sdk_header
         "rubygems.org;delivery-sdk-ruby;#{KenticoCloud::Delivery::VERSION}"
       end

data/lib/delivery/client/request_manager.rb

@@ -1,4 +1,5 @@
 require 'rest-client'
+require 'dotenv/load'
 
 module KenticoCloud
   module Delivery
@@ -31,15 +32,24 @@ module KenticoCloud
         end
 
         def continue
-          resp = RestClient.get @url, @headers
-        rescue RestClient::ExceptionWithResponse => err
-          should_retry KenticoCloud::Delivery::Responses::ResponseBase.new err.http_code, err.response
-        rescue RestClient::SSLCertificateNotVerified => err
-          should_retry KenticoCloud::Delivery::Responses::ResponseBase.new 500, err
-        rescue SocketError => err
-          should_retry KenticoCloud::Delivery::Responses::ResponseBase.new 500, err.message
-        else
-          make_response resp
+          if ENV['TEST'] == '1'
+            resp = KenticoCloud::Delivery::Tests::FakeResponder.get_response @query, @url, @headers
+            return resp if resp.is_a? KenticoCloud::Delivery::Responses::ResponseBase
+
+            make_response resp # resp is pure JSON
+          else
+            begin
+              resp = RestClient.get @url, @headers
+            rescue RestClient::ExceptionWithResponse => err
+              should_retry KenticoCloud::Delivery::Responses::ResponseBase.new err.http_code, err.response
+            rescue RestClient::SSLCertificateNotVerified => err
+              should_retry KenticoCloud::Delivery::Responses::ResponseBase.new 500, err
+            rescue SocketError => err
+              should_retry KenticoCloud::Delivery::Responses::ResponseBase.new 500, err.message
+            else
+              make_response resp
+            end
+          end
         end
 
         # Converts a standard REST response based on the type of query.

data/lib/delivery/tests/401.json

@@ -0,0 +1,6 @@
+{
+    "message": "Missing or invalid access token. Please include the valid access token value in the Authorization header field as an HTTP bearer authorization scheme.",
+    "request_id": "|89bb1503b14c254a91bd57c135329822.d31c99c5_",
+    "error_code": 3,
+    "specific_code": 0
+}

data/lib/delivery/tests/fake_responder.rb

@@ -0,0 +1,65 @@
+require 'dotenv/load'
+require 'pathname'
+require 'cgi'
+
+module KenticoCloud
+  module Delivery
+    module Tests
+      class FakeResponder
+        PROJECT_ID = ENV['PROJECT_ID']
+        IS_SECURE = ENV['TEST_SECURE_API_ENABLED']
+        SECURE_KEY = ENV['SECURE_KEY']
+        PREVIEW_KEY = ENV['PREVIEW_KEY']
+        BASE_URL = "https://deliver.kenticocloud.com/#{PROJECT_ID}".freeze
+        PREVIEW_URL = "https://preview-deliver.kenticocloud.com/#{PROJECT_ID}".freeze
+
+        class << self
+          def get_response(query, url, headers)
+            @query = query
+            if IS_SECURE && !(
+               headers['Authorization'] == "Bearer #{SECURE_KEY}" ||
+               headers['Authorization'] == "Bearer #{PREVIEW_KEY}"
+             )
+              return respond_401
+            end
+
+            url =
+              if @query.should_preview
+                url[PREVIEW_URL.length...url.length]
+              else
+                url[BASE_URL.length...url.length]
+              end
+
+            qs = url.contains('?') ? url.split('?')[1] : nil
+            return respond_filtering qs unless qs.nil? # e.g. /items/about_us?skip=0&limit=5
+
+            respond_generic url # Didn't match other clauses, so response should be located in corresponding filepath
+          end
+
+          def respond_generic(url)
+            path = Pathname.new(File.dirname(__FILE__) + "/generic#{url}.json")
+            path.read if path.exist?
+          end
+
+          def respond_filtering(query)
+            path =
+              case CGI.unescape query
+              when 'skip=0&limit=5'
+                Pathname.new(File.dirname(__FILE__) + '/filtering/pagination_about_us.json')
+              when 'elements.price[gt]=20'
+                Pathname.new(File.dirname(__FILE__) + '/filtering/items_gt.json')
+              when 'elements.price[gt]=20&system.type=grinder'
+                Pathname.new(File.dirname(__FILE__) + '/filtering/multiple.json')
+              end
+            path.read unless path.nil? && !path.exist?
+          end
+
+          def respond_401
+            path = Pathname.new(File.dirname(__FILE__) + '/401.json')
+            KenticoCloud::Delivery::Responses::ResponseBase.new 401, '', path.read if path.exist?
+          end
+        end
+      end
+    end
+  end
+end