delivery-sdk-ruby 0.15.0 → 0.16.0

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "delivery"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "delivery"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/delivery-sdk-ruby.rb

@@ -1,17 +1,17 @@
-require File.dirname(__FILE__) + '/delivery/client/delivery_client'
-require File.dirname(__FILE__) + '/delivery/client/delivery_query'
-require File.dirname(__FILE__) + '/delivery/models/content_item'
-require File.dirname(__FILE__) + '/delivery/models/content_type'
-require File.dirname(__FILE__) + '/delivery/models/taxonomy_group'
-require File.dirname(__FILE__) + '/delivery/query_parameters/filters'
-require File.dirname(__FILE__) + '/delivery/responses/delivery_item_listing_response'
-require File.dirname(__FILE__) + '/delivery/responses/delivery_item_response'
-require File.dirname(__FILE__) + '/delivery/responses/delivery_type_listing_response'
-require File.dirname(__FILE__) + '/delivery/responses/delivery_type_response'
-require File.dirname(__FILE__) + '/delivery/responses/delivery_taxonomy_listing_response'
-require File.dirname(__FILE__) + '/delivery/responses/delivery_taxonomy_response'
-require File.dirname(__FILE__) + '/delivery/responses/delivery_element_response'
-require File.dirname(__FILE__) + '/delivery/resolvers/content_link_resolver'
-require File.dirname(__FILE__) + '/delivery/resolvers/inline_content_item_resolver'
-require File.dirname(__FILE__) + '/delivery/resolvers/linked_item_resolver'
-require File.dirname(__FILE__) + '/delivery/builders/image_transformation_builder'
+require File.dirname(__FILE__) + '/delivery/client/delivery_client'
+require File.dirname(__FILE__) + '/delivery/client/delivery_query'
+require File.dirname(__FILE__) + '/delivery/models/content_item'
+require File.dirname(__FILE__) + '/delivery/models/content_type'
+require File.dirname(__FILE__) + '/delivery/models/taxonomy_group'
+require File.dirname(__FILE__) + '/delivery/query_parameters/filters'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_item_listing_response'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_item_response'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_type_listing_response'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_type_response'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_taxonomy_listing_response'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_taxonomy_response'
+require File.dirname(__FILE__) + '/delivery/responses/delivery_element_response'
+require File.dirname(__FILE__) + '/delivery/resolvers/content_link_resolver'
+require File.dirname(__FILE__) + '/delivery/resolvers/inline_content_item_resolver'
+require File.dirname(__FILE__) + '/delivery/resolvers/linked_item_resolver'
+require File.dirname(__FILE__) + '/delivery/builders/image_transformation_builder'

data/lib/delivery/builders/image_transformation_builder.rb

@@ -1,141 +1,143 @@
-require 'delivery/query_parameters/query_string'
-
-module Delivery
-  module Builders
-    class ImageTransformationBuilder
-      FIT_MODE_CLIP = 'clip'.freeze
-      FIT_MODE_SCALE = 'scale'.freeze
-      FIT_MODE_CROP = 'crop'.freeze
-      FORMAT_GIF = 'gif'.freeze
-      FORMAT_PNG = 'png'.freeze
-      FORMAT_PNG8 = 'png8'.freeze
-      FORMAT_JPG = 'jpg'.freeze
-      FORMAT_PJPG = 'pjpg'.freeze
-      FORMAT_WEBP = 'webp'.freeze
-
-      class << self
-        def transform(url)
-          AssetURL.new url
-        end
-      end
-    end
-
-    class AssetURL
-      INVALID_PARAMS = 'One or more of the parameters is invalid. '\
-      'See https://developer.kenticocloud.com/v1/reference#focal-point-crop'\
-      'for more information.'.freeze
-      ONE_TO_100 = 'Quality parameter must be between 1 and 100.'.freeze
-      BOOLEAN_PARAM = 'The lossless parameter must be "true," "false," '\
-      '1, or 0.'.freeze
-
-      def initialize(url)
-        @url = url
-        @query_string = Delivery::QueryParameters::QueryString.new
-      end
-
-      def url
-        @url + @query_string.to_s
-      end
-
-      def with_width(width)
-        @query_string.set_param 'w', width
-        self
-      end
-
-      def with_height(height)
-        @query_string.set_param 'h', height
-        self
-      end
-
-      def with_pixel_ratio(dpr)
-        @query_string.set_param 'dpr', dpr
-        self
-      end
-
-      def with_fit_mode(fit)
-        @query_string.set_param 'fit', fit
-        self
-      end
-
-      # Setting this will remove focal point cropping from the image,
-      # as the two options are incompatible.
-      # @param x
-      # @param y
-      # @param width
-      # @param height
-      def with_rect(x, y, width, height)
-        @query_string.remove_param 'fp-x'
-        @query_string.remove_param 'fp-y'
-        @query_string.remove_param 'fp-z'
-        @query_string.remove_param 'crop', 'focalpoint'
-        @query_string.set_param 'rect', "#{x},#{y},#{width},#{height}"
-        self
-      end
-
-      # Setting this will remove the source rectangle region,
-      # as the two options are incompatible.
-      def with_focal_point(x, y, z)
-        raise ArgumentError, INVALID_PARAMS unless valid_dims?(x, y, z)
-
-        @query_string.remove_param 'rect'
-        @query_string.set_param 'fp-x', x
-        @query_string.set_param 'fp-y', y
-        @query_string.set_param 'fp-z', z
-        @query_string.set_param 'crop', 'focalpoint'
-        self
-      end
-
-      def valid_dims?(x, y, z)
-        (x.to_f >= 0.0 && x.to_f <= 1.0) &&
-          (y.to_f >= 0.0 && y.to_f <= 1.0) &&
-          (z.to_i >= 1)
-      end
-
-      # Sets the background color.
-      # @param [String] color a valid 3, 4, 6, or 8 digit hexadecimal color, without the # symbol
-      def with_background_color(color)
-        @query_string.set_param 'bg', color
-        self
-      end
-
-      def with_output_format(format)
-        @query_string.set_param 'fm', format
-        self
-      end
-
-      def with_quality(quality)
-        raise ArgumentError, ONE_TO_100 unless quality.to_i >= 1 && quality.to_i <= 100
-
-        @query_string.set_param 'q', quality
-        self
-      end
-
-      # Sets lossless to true or false. If true, automatically sets the format to WebP
-      def with_lossless(lossless)
-        lossless = lossless.to_s.downcase
-        raise ArgumentError, BOOLEAN_PARAM unless bool? lossless
-
-        @query_string.set_param 'lossless', lossless
-        @query_string.set_param 'fm', Delivery::Builders::ImageTransformationBuilder::FORMAT_WEBP if %w[true 1].include? lossless
-        self
-      end
-
-      def bool?(value)
-        (value == 'true') ||
-          (value == 'false') ||
-          (value == '0') ||
-          (value == '1')
-      end
-
-      def with_auto_format_selection(auto)
-        auto = auto.to_s.downcase
-        if %w[true 1].include? auto
-          @query_string.set_param 'auto', 'format'
-        else
-          @query_string.remove_param 'auto'
-        end
-        self
-      end
-    end
-  end
-end
+require 'delivery/query_parameters/query_string'
+
+module KenticoCloud
+  module Delivery
+    module Builders
+      class ImageTransformationBuilder
+        FIT_MODE_CLIP = 'clip'.freeze
+        FIT_MODE_SCALE = 'scale'.freeze
+        FIT_MODE_CROP = 'crop'.freeze
+        FORMAT_GIF = 'gif'.freeze
+        FORMAT_PNG = 'png'.freeze
+        FORMAT_PNG8 = 'png8'.freeze
+        FORMAT_JPG = 'jpg'.freeze
+        FORMAT_PJPG = 'pjpg'.freeze
+        FORMAT_WEBP = 'webp'.freeze
+
+        class << self
+          def transform(url)
+            AssetURL.new url
+          end
+        end
+      end
+
+      class AssetURL
+        INVALID_PARAMS = 'One or more of the parameters is invalid. '\
+        'See https://developer.kenticocloud.com/v1/reference#focal-point-crop'\
+        'for more information.'.freeze
+        ONE_TO_100 = 'Quality parameter must be between 1 and 100.'.freeze
+        BOOLEAN_PARAM = 'The lossless parameter must be "true," "false," '\
+        '1, or 0.'.freeze
+
+        def initialize(url)
+          @url = url
+          @query_string = KenticoCloud::Delivery::QueryParameters::QueryString.new
+        end
+
+        def url
+          @url + @query_string.to_s
+        end
+
+        def with_width(width)
+          @query_string.set_param 'w', width
+          self
+        end
+
+        def with_height(height)
+          @query_string.set_param 'h', height
+          self
+        end
+
+        def with_pixel_ratio(dpr)
+          @query_string.set_param 'dpr', dpr
+          self
+        end
+
+        def with_fit_mode(fit)
+          @query_string.set_param 'fit', fit
+          self
+        end
+
+        # Setting this will remove focal point cropping from the image,
+        # as the two options are incompatible.
+        # @param x
+        # @param y
+        # @param width
+        # @param height
+        def with_rect(x, y, width, height)
+          @query_string.remove_param 'fp-x'
+          @query_string.remove_param 'fp-y'
+          @query_string.remove_param 'fp-z'
+          @query_string.remove_param 'crop', 'focalpoint'
+          @query_string.set_param 'rect', "#{x},#{y},#{width},#{height}"
+          self
+        end
+
+        # Setting this will remove the source rectangle region,
+        # as the two options are incompatible.
+        def with_focal_point(x, y, z)
+          raise ArgumentError, INVALID_PARAMS unless valid_dims?(x, y, z)
+
+          @query_string.remove_param 'rect'
+          @query_string.set_param 'fp-x', x
+          @query_string.set_param 'fp-y', y
+          @query_string.set_param 'fp-z', z
+          @query_string.set_param 'crop', 'focalpoint'
+          self
+        end
+
+        def valid_dims?(x, y, z)
+          (x.to_f >= 0.0 && x.to_f <= 1.0) &&
+            (y.to_f >= 0.0 && y.to_f <= 1.0) &&
+            (z.to_i >= 1)
+        end
+
+        # Sets the background color.
+        # @param [String] color a valid 3, 4, 6, or 8 digit hexadecimal color, without the # symbol
+        def with_background_color(color)
+          @query_string.set_param 'bg', color
+          self
+        end
+
+        def with_output_format(format)
+          @query_string.set_param 'fm', format
+          self
+        end
+
+        def with_quality(quality)
+          raise ArgumentError, ONE_TO_100 unless quality.to_i >= 1 && quality.to_i <= 100
+
+          @query_string.set_param 'q', quality
+          self
+        end
+
+        # Sets lossless to true or false. If true, automatically sets the format to WebP
+        def with_lossless(lossless)
+          lossless = lossless.to_s.downcase
+          raise ArgumentError, BOOLEAN_PARAM unless bool? lossless
+
+          @query_string.set_param 'lossless', lossless
+          @query_string.set_param 'fm', KenticoCloud::Delivery::Builders::ImageTransformationBuilder::FORMAT_WEBP if %w[true 1].include? lossless
+          self
+        end
+
+        def bool?(value)
+          (value == 'true') ||
+            (value == 'false') ||
+            (value == '0') ||
+            (value == '1')
+        end
+
+        def with_auto_format_selection(auto)
+          auto = auto.to_s.downcase
+          if %w[true 1].include? auto
+            @query_string.set_param 'auto', 'format'
+          else
+            @query_string.remove_param 'auto'
+          end
+          self
+        end
+      end
+    end
+  end
+end

data/lib/delivery/builders/url_builder.rb

@@ -1,73 +1,75 @@
-module Delivery
-  module Builders
-    # Generates the URL required for Delivery REST API
-    class UrlBuilder
-      URL_TEMPLATE_BASE = 'https://deliver.kenticocloud.com/%s'.freeze
-      URL_TEMPLATE_PREVIEW = 'https://preview-deliver.kenticocloud.com/%s'.freeze
-      URL_TEMPLATE_ITEM = '/items/%s'.freeze
-      URL_TEMPLATE_ITEMS = '/items'.freeze
-      URL_TEMPLATE_TYPE = '/types/%s'.freeze
-      URL_TEMPLATE_TYPES = '/types'.freeze
-      URL_TEMPLATE_ELEMENTS = '/types/%s/elements/%s'.freeze
-      URL_TEMPLATE_TAXONOMY = '/taxonomies/%s'.freeze
-      URL_TEMPLATE_TAXONOMIES = '/taxonomies'.freeze
-
-      URL_MAX_LENGTH = 65_519
-      MSG_LONG_QUERY = 'The request url is too long. Split your query into multiple calls.'.freeze
-
-      class << self
-        def provide_url(query)
-          url = provide_base_url(query)
-          url += provide_path_part(query)
-
-          if query.query_string.empty?
-            url
-          else
-            url + query.query_string.to_s
-          end
-        end
-
-        def validate_url(url)
-          raise UriFormatException, MSG_LONG_QUERY if url.length > URL_MAX_LENGTH
-        end
-
-        private
-
-        # Returns relative path part of URL depending on query type
-        def provide_path_part(query)
-          case query.query_type
-          when Delivery::QUERY_TYPE_ITEMS
-            if query.code_name.nil?
-              URL_TEMPLATE_ITEMS
-            else
-              format(URL_TEMPLATE_ITEM, query.code_name)
-            end
-          when Delivery::QUERY_TYPE_TYPES
-            if query.code_name.nil?
-              URL_TEMPLATE_TYPES
-            else
-              format(URL_TEMPLATE_TYPE, query.code_name)
-            end
-          when Delivery::QUERY_TYPE_TAXONOMIES
-            if query.code_name.nil?
-              URL_TEMPLATE_TAXONOMIES
-            else
-              format(URL_TEMPLATE_TAXONOMY, query.code_name)
-            end
-          when Delivery::QUERY_TYPE_ELEMENT
-            format(URL_TEMPLATE_ELEMENTS, query.content_type, query.code_name)
-          end
-        end
-
-        # Returns the protocol and domain with project ID
-        def provide_base_url(query)
-          if query.use_preview
-            format(URL_TEMPLATE_PREVIEW, query.project_id)
-          else
-            format(URL_TEMPLATE_BASE, query.project_id)
-          end
-        end
-      end
-    end
-  end
-end
+module KenticoCloud
+  module Delivery
+    module Builders
+      # Generates the URL required for Delivery REST API
+      class UrlBuilder
+        URL_TEMPLATE_BASE = 'https://deliver.kenticocloud.com/%s'.freeze
+        URL_TEMPLATE_PREVIEW = 'https://preview-deliver.kenticocloud.com/%s'.freeze
+        URL_TEMPLATE_ITEM = '/items/%s'.freeze
+        URL_TEMPLATE_ITEMS = '/items'.freeze
+        URL_TEMPLATE_TYPE = '/types/%s'.freeze
+        URL_TEMPLATE_TYPES = '/types'.freeze
+        URL_TEMPLATE_ELEMENTS = '/types/%s/elements/%s'.freeze
+        URL_TEMPLATE_TAXONOMY = '/taxonomies/%s'.freeze
+        URL_TEMPLATE_TAXONOMIES = '/taxonomies'.freeze
+
+        URL_MAX_LENGTH = 65_519
+        MSG_LONG_QUERY = 'The request url is too long. Split your query into multiple calls.'.freeze
+
+        class << self
+          def provide_url(query)
+            url = provide_base_url(query)
+            url += provide_path_part(query)
+
+            if query.query_string.empty?
+              url
+            else
+              url + query.query_string.to_s
+            end
+          end
+
+          def validate_url(url)
+            raise UriFormatException, MSG_LONG_QUERY if url.length > URL_MAX_LENGTH
+          end
+
+          private
+
+          # Returns relative path part of URL depending on query type
+          def provide_path_part(query)
+            case query.query_type
+            when KenticoCloud::Delivery::QUERY_TYPE_ITEMS
+              if query.code_name.nil?
+                URL_TEMPLATE_ITEMS
+              else
+                format(URL_TEMPLATE_ITEM, query.code_name)
+              end
+            when KenticoCloud::Delivery::QUERY_TYPE_TYPES
+              if query.code_name.nil?
+                URL_TEMPLATE_TYPES
+              else
+                format(URL_TEMPLATE_TYPE, query.code_name)
+              end
+            when KenticoCloud::Delivery::QUERY_TYPE_TAXONOMIES
+              if query.code_name.nil?
+                URL_TEMPLATE_TAXONOMIES
+              else
+                format(URL_TEMPLATE_TAXONOMY, query.code_name)
+              end
+            when KenticoCloud::Delivery::QUERY_TYPE_ELEMENT
+              format(URL_TEMPLATE_ELEMENTS, query.content_type, query.code_name)
+            end
+          end
+
+          # Returns the protocol and domain with project ID
+          def provide_base_url(query)
+            if query.use_preview
+              format(URL_TEMPLATE_PREVIEW, query.project_id)
+            else
+              format(URL_TEMPLATE_BASE, query.project_id)
+            end
+          end
+        end
+      end
+    end
+  end
+end