delivery-sdk-ruby 1.0.9 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 810bf0eebd44bb2fee47eebfe0920020052b093dd9c35d93d82aa2789e47b3f0
-  data.tar.gz: 7e7da7f14b27e2818682dac4a0560cc0e38349832a218d328cb7ff0bece752cc
+  metadata.gz: b7c12c35f279bbc41dbdc875ec09e599796708653e2d7a3f805e0576dd7ac03c
+  data.tar.gz: ebb3e28b29c84d7e8e3b694d1f6fa4c9999621fb426e7e1a0b62a03dad2a80e5
 SHA512:
-  metadata.gz: 72074bfb5bf3a63b381aff2ce362bc826f423f3b20ee62b88e8605b9b7993b25a442c6ca7fc734cdab2b7af7dd364ff289b5094a702dd7d1c6a1d34b26727f08
-  data.tar.gz: 8804147c3766b7fd4934cb4e285a080700c4d865a78d84538661bff769256738ec4231f0759a8dc73d9cf1d0ab5a53631eeb55e8f9cbbd1fc3d7f189b719d80e
+  metadata.gz: 6887dbaac36af78ba9e798141e351b0b001628b4ef6a291ff268e1f4a05e864b038353a9b6b926a23c6700ec6788a17d7d075523c1e5ee736021f3b5413e5abc
+  data.tar.gz: 0b6b5c0fca8a2a0e93b24ab91dab06b679735e8b5dcc949a0c9463c918582afcf9847e468ed4c8436c707ce1249bf11eb350f85bebe94cb6c670c12708000803

data/README.md

@@ -1,16 +1,17 @@
-[![Build Status](https://api.travis-ci.com/Kentico/delivery-sdk-ruby.svg?branch=master)](https://travis-ci.com/Kentico/delivery-sdk-ruby)
+[![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-cloud)
- [![Version](https://img.shields.io/gem/v/delivery-sdk-ruby.svg?style=flat)](https://rubygems.org/gems/delivery-sdk-ruby)
- [![Maintainability](https://api.codeclimate.com/v1/badges/b2e3fae28a2b2601d815/maintainability)](https://codeclimate.com/github/Kentico/delivery-sdk-ruby/maintainability)
+ [![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)
 
 # Delivery Ruby SDK
 
-![Banner](https://github.com/Kentico/delivery-sdk-ruby/blob/master/banner.png)
+![Banner](https://github.com/Kentico/kontent-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.
+See [How to setup a development environment on Windows](https://github.com/Kentico/kontent-delivery-sdk-ruby/wiki/How-to-setup-development-environment-on-Windows) for local development.
 
 
 ## Demo Rails application
@@ -22,42 +23,42 @@ class ApplicationController < ActionController::Base
   PROJECT_ID = '<your-project-id>'.freeze
 ```
 
-If you don't have the sample project installed in Kentico Cloud, you can generate a new project [here](https://app.kenticocloud.com/sample-project-generator). Save the file, then open a terminal in the `/dancing_goat` directory and run the following commands:
+If you don't have the sample project installed in Kentico Cloud, you can generate a new project [here](https://app.kontent.ai/sample-project-generator). Save the file, then open a terminal in the `/dancing_goat` directory and run the following commands:
 
 ```
 bundle install
 rails server
 ```
 
-The site should be accessible at localhost:3000. You can also follow a step-by-step guide to creating a basic Rails application on the [Kentico Cloud Blog](https://kenticocloud.com/blog/creating-a-kentico-cloud-ruby-on-rails-application).
+The site should be accessible at localhost:3000. You can also follow a step-by-step guide to creating a basic Rails application on the [Kentico Cloud Blog](https://kontent.ai/blog/creating-a-kentico-cloud-ruby-on-rails-application).
 
 ## Installation
 
 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:
+Then run `bundle install`. You can also download the gem from [RubyGems.org](https://rubygems.org/gems/kontent-delivery-sdk-ruby). To use the SDK in an `.rb` file, you need to require it:
 
 ```ruby
-require 'delivery-sdk-ruby'
+require 'kontent-delivery-sdk-ruby'
 ```
 
 ## Creating a client
 
-You will use `KenticoCloud::Delivery::DeliveryClient` to obtain content from Kentico Cloud. Create an instance of the client and pass your project ID:
+You will use `Kentico::Kontent::Delivery::DeliveryClient` to obtain content from Kentico Cloud. Create an instance of the client and pass your project ID:
 
 ```ruby
-delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>'
+delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>'
 ```
 
 :gem: **Pro tip:** You can alias namespaces to make them shorter, e.g.
 
 ```ruby
-KC = KenticoCloud::Delivery
-delivery_client = KC::DeliveryClient.new project_id: '<your-project-id>'
+KK = Kentico::Kontent::Delivery
+delivery_client = KK::DeliveryClient.new project_id: '<your-project-id>'
 ```
 
 ### Previewing unpublished content
@@ -65,8 +66,8 @@ delivery_client = KC::DeliveryClient.new project_id: '<your-project-id>'
 To enable [preview](https://developer.kenticocloud.com/docs/previewing-content-in-a-separate-environment "preview"), pass the Preview API Key to the constructor:
 
 ```ruby
-delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
-                                                             preview_key: '<your-preview-key>'
+delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>',
+                                                                 preview_key: '<your-preview-key>'
 ```
 
 This enables preview, but you can toggle preview at any time by setting the `use_preview` attribute of DeliveryClient which is propogated to all queries created by the client, _or_ per-query by setting it's `use_preview` attribute:
@@ -88,7 +89,7 @@ end
 If you've [secured access](https://developer.kenticocloud.com/docs/securing-public-access "Securing public access") to your project, you need to provide the DeliveryClient with the primary or secondary key:
 
 ```ruby
-KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
+Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                            secure_key: '<your-secure-key>'
 ```
 
@@ -107,7 +108,7 @@ The default policy retries requests 5 times, totaling 6 overall attempts to retr
 To disable the retry policy, you can use the `with_retry_policy` argument:
 
 ```ruby
-KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
+Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                            secure_key: '<your-secure-key>',
                                            with_retry_policy: false
 ```
@@ -115,7 +116,7 @@ KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
 ## Listing items
 
 
-Use `.item` or `.items` to create a `KenticoCloud::Delivery::DeliveryQuery`, then call `.execute` to perform the request.
+Use `.item` or `.items` to create a `Kentico::Kontent::Delivery::DeliveryQuery`, then call `.execute` to perform the request.
 
 ```ruby
 delivery_client.items.execute do |response|
@@ -163,7 +164,7 @@ delivery_client.items [
 
 ### Parameters
 
-The `.item` and `.items` methods return a `KenticoCloud::Delivery::DeliveryQuery` object which you can further configure before executing. The methods you can call are:
+The `.item` and `.items` methods return a `Kentico::Kontent::Delivery::DeliveryQuery` object which you can further configure before executing. The methods you can call are:
 
 |Method|Example|REST equivalent
 |--|--|--|
@@ -204,7 +205,7 @@ When you have a URL (i.e. `next_page` for paging, for testing purposes, or if yo
 
 ```ruby
 delivery_client.items
-  .url('https://deliver.kenticocloud.com/<your-project-id>/items?system.type=grinder')
+  .url('https://deliver.kontent.ai/<your-project-id>/items?system.type=grinder')
   .execute do |response|
     # Do something
   end
@@ -212,7 +213,7 @@ delivery_client.items
 
 ### Responses
 
-All responses from the `.execute` method will be/extend the `KenticoCloud::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 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:
 
 ```ruby
 delivery_client.items.execute do |response|
@@ -298,7 +299,7 @@ end
 
 ### Responses
 
-As with content item queries, all content type queries will return a `KenticoCloud::Delivery::Responses::ResponseBase` of the class `DeliveryTypeResponse` or `DeliveryTypeListingResponse` for single and multiple type queries, respectively.
+As with content item queries, all content type queries will return a `Kentico::Kontent::Delivery::Responses::ResponseBase` of the class `DeliveryTypeResponse` or `DeliveryTypeListingResponse` for single and multiple type queries, respectively.
 
 For multiple type queries, you can access the array of `ContentType` objects at `.types`, and at `.type` for singe type queries. You can access information about the type(s) dynamically:
 
@@ -327,7 +328,7 @@ delivery_client.taxonomy('personas').execute do |response|
 end
 ```
 
-Each response will return either a single `KenticoCloud::Delivery::TaxonomyGroup` or an array of groups. The taxonomy group(s) are accessible at `.taxonomy` and `.taxonomies` for single and multiple queries, respectively.
+Each response will return either a single `Kentico::Kontent::Delivery::TaxonomyGroup` or an array of groups. The taxonomy group(s) are accessible at `.taxonomy` and `.taxonomies` for single and multiple queries, respectively.
 
 The `TaxonomyGroup` object contains two attributes `.system` and `.terms` which are dynamic OStruct objects containing the same elements as a standard JSON reponse. For example, given a successful query you could access information about the first term of a group using:
 
@@ -362,16 +363,16 @@ delivery_client.element('brewer', 'product_status').execute do |response|
 end
 ```
 
-This returns a `KenticoCloud::Delivery::Responses::DeliveryElementResponse` where the `element` attribute is a dynamic OStruct representation of the JSON response. This means that you can access any property of the element by simply typing the name as in the above example.
+This returns a `Kentico::Kontent::Delivery::Responses::DeliveryElementResponse` where the `element` attribute is a dynamic OStruct representation of the JSON response. This means that you can access any property of the element by simply typing the name as in the above example.
 
 The element will always contain __codename__, __type__, and __name__, but multiple choice elements will also contain __options__ and taxonomy elements will contain __taxonomy_group__. The Ruby SDK fully supports obtaining [custom elements](https://developer.kenticocloud.com/v1/reference#custom-elements-api) using this approach and any other methods.
 
 ## Resolving links
 
-If a rich text element contains links to other content items, you will need to generate the URLs to those items. You can do this by registering a `KenticoCloud::Delivery::Resolvers::ContentLinkResolver` when you instantiate the DeliveryClient. When you create a ContentLinkResolver, you must pass a method that will return the URL, and you may pass another method that will be called if the content contains a link, but the content item is not present in the response:
+If a rich text element contains links to other content items, you will need to generate the URLs to those items. You can do this by registering a `Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver` when you instantiate the DeliveryClient. When you create a ContentLinkResolver, you must pass a method that will return the URL, and you may pass another method that will be called if the content contains a link, but the content item is not present in the response:
 
 ```ruby
-link_resolver = KenticoCloud::Delivery::Resolvers::ContentLinkResolver.new(lambda do |link|
+link_resolver = Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver.new(lambda do |link|
         # Link valid
         return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
         return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
@@ -379,14 +380,14 @@ link_resolver = KenticoCloud::Delivery::Resolvers::ContentLinkResolver.new(lambd
         # Link broken
         return "/notfound?id=#{id}"
       end)
-delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
+delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                                              content_link_url_resolver: link_resolver
 ```
 
-You can also build the logic for your resolver in a separate class and register an instance of that class in the DeliveryClient. The class must extend `KenticoCloud::Delivery::Resolvers::ContentLinkResolver` and contain a `resolve_link(link)` method, as well as the `resolve_404(id)` method for broken links. For example, you can create `MyLinkResolver.rb`:
+You can also build the logic for your resolver in a separate class and register an instance of that class in the DeliveryClient. The class must extend `Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver` and contain a `resolve_link(link)` method, as well as the `resolve_404(id)` method for broken links. For example, you can create `MyLinkResolver.rb`:
 
 ```ruby
-class MyLinkResolver < KenticoCloud::Delivery::Resolvers::ContentLinkResolver
+class MyLinkResolver < Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver
   def resolve_link(link)
     return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
     return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
@@ -401,14 +402,14 @@ end
 Then create an object of this class when instantiating the DeliveryClient:
 
 ```ruby
-delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
+delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                                              content_link_url_resolver: MyLinkResolver.new
 ```
 
 You can pass a `ContentLinkResolver` to the DeliveryQuery instead of the client if you only want to resolve links for that query, or they should be resolved differently:
 
 ```ruby
-delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>'
+delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>'
 # Client doesn't use ContentLinkResolver, but query below will
 delivery_client.items
                .with_link_resolver MyLinkResolver.new
@@ -424,11 +425,11 @@ The `ContentLink` object that is passed to your resolver contains the following
 To resolve links in rich text elements, you must retrieve the text using `get_string`:
 
 ```ruby
-item_resolver = KenticoCloud::Delivery::Resolvers::ContentLinkResolver.new(lambda do |link|
+item_resolver = Kentico::Kontent::Delivery::Resolvers::ContentLinkResolver.new(lambda do |link|
   return "/coffees/#{link.url_slug}" if link.type.eql? 'coffee'
   return "/brewers/#{link.url_slug}" if link.type.eql? 'brewer'
 end)
-delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
+delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                                              content_link_url_resolver: item_resolver
 delivery_client.item('coffee_processing_techniques').execute do |response|
   text = response.item.get_string 'body_copy'
@@ -440,18 +441,18 @@ end
 Existing content items can be inserted into a rich text element, or you can create new content items as components. You need to resolve these in your application just as with content links. You can register a resolver when you instantiate the client by passing it with the hash key `inline_content_item_resolver`:
 
 ```ruby
-item_resolver = KenticoCloud::Delivery::Resolvers::InlineContentItemResolver.new(lambda do |item|
+item_resolver = Kentico::Kontent::Delivery::Resolvers::InlineContentItemResolver.new(lambda do |item|
       return "<h1>#{item.elements.zip_code.value}</h1>" if item.system.type.eql? 'cafe'
       return "<div>$#{item.elements.price.value}</div>" if item.system.type.eql? 'brewer'
     end)
-delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>',
+delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>',
                                                              inline_content_item_resolver: item_resolver
 ```
 
-The object passed to the resolving method is a complete ContentItem. Similar to content link resolvers, you can create your own class which extends `KenticoCloud::Delivery::Resolvers::InlineContentItemResolver` and implements the `resolve_item` method:
+The object passed to the resolving method is a complete ContentItem. Similar to content link resolvers, you can create your own class which extends `Kentico::Kontent::Delivery::Resolvers::InlineContentItemResolver` and implements the `resolve_item` method:
 
 ```ruby
-class MyItemResolver < KenticoCloud::Delivery::Resolvers::InlineContentItemResolver
+class MyItemResolver < Kentico::Kontent::Delivery::Resolvers::InlineContentItemResolver
   def resolve_item(item)
     return "<h1>#{item.elements.zip_code.value}</h1>" if item.system.type.eql? 'cafe'
     return "<div>$#{item.elements.price.value}</div>" if item.system.type.eql? 'brewer'
@@ -462,7 +463,7 @@ end
 You can also set the inline content resolver per-query:
 
 ```ruby
-delivery_client = KenticoCloud::Delivery::DeliveryClient.new project_id: '<your-project-id>'
+delivery_client = Kentico::Kontent::Delivery::DeliveryClient.new project_id: '<your-project-id>'
 # Client doesn't use InlineContentItemResolver, but query below will
 delivery_client.items
                .with_inline_content_item_resolver MyItemResolver.new
@@ -470,11 +471,11 @@ delivery_client.items
 
 ## Image transformation
 
-When you've obtained the URL for an asset, you can use our [Image Transformation API](https://developer.kenticocloud.com/v1/reference#image-transformation) to make on-the-fly modifications to the image. To do this, use the static `.transform` method of `KenticoCloud::Delivery::Builders::ImageTransformationBuilder`, then call the transformation methods. When you're done, call the `.url` method to get the new URL:
+When you've obtained the URL for an asset, you can use our [Image Transformation API](https://developer.kenticocloud.com/v1/reference#image-transformation) to make on-the-fly modifications to the image. To do this, use the static `.transform` method of `Kentico::Kontent::Delivery::Builders::ImageTransformationBuilder`, then call the transformation methods. When you're done, call the `.url` method to get the new URL:
 
 ```ruby
 url = response.item.get_assets('teaser_image').first.url
-url = KenticoCloud::Delivery::Builders::ImageTransformationBuilder.transform(url)
+url = Kentico::Kontent::Delivery::Builders::ImageTransformationBuilder.transform(url)
                                                                   # methods...
                                                                   .url
 ```
@@ -486,18 +487,18 @@ The available methods are:
 |`.with_width`| positive integer, or float between 0 and 1| ?w=200
 |`.with_height`| positive integer, or float between 0 and 1| ?h=200
 |`.with_pixel_ratio`| float greater than 0 but less than 5| ?dpr=1.5
-|`.with_fit_mode`| constants available at `KenticoCloud::Delivery::Builders::ImageTransformationBuilder` <ul><li>FITMODE_CROP</li><li>FITMODE_CLIP</li><li>FITMODE_SCALE</li></ul>| ?fit=crop
+|`.with_fit_mode`| constants available at `Kentico::Kontent::Delivery::Builders::ImageTransformationBuilder` <ul><li>FITMODE_CROP</li><li>FITMODE_CLIP</li><li>FITMODE_SCALE</li></ul>| ?fit=crop
 |`.with_rect`| 4 integer values representing pixels or floats representing percentages|rect=100,100,0.7,0.7
 |`.with_focal_point`| 2 floats between 0 and 1 and one integer between 1 and 100| ?fp-x=0.2&fp-y=0.7&fp-z=5
 |`.with_background_color`| string containing 3, 4, 6, or 8 characters | ?bg=7A0099EE
-|`.with_output_format`| constants available at `KenticoCloud::Delivery::Builders::ImageTransformationBuilder` <ul><li>FORMAT_GIF</li><li>FORMAT_PNG</li><li>FORMAT_PNG8</li><li>FORMAT_JPG</li><li>FORMAT_PJPG</li><li>FORMAT_WEBP</li></ul> | ?fm=webp
+|`.with_output_format`| constants available at `Kentico::Kontent::Delivery::Builders::ImageTransformationBuilder` <ul><li>FORMAT_GIF</li><li>FORMAT_PNG</li><li>FORMAT_PNG8</li><li>FORMAT_JPG</li><li>FORMAT_PJPG</li><li>FORMAT_WEBP</li></ul> | ?fm=webp
 |`.with_quality`| integer between 1 to 100 | ?quality=50
 |`.with_lossless`| 'true', 'false', 0, or 1| ?lossless=1
 |`.with_auto_format_selection`| 'true', 'false', 0, or 1 | ?auto=format
 
 ## Feedback & Contributing
 
-Check out the [contributing](https://github.com/Kentico/delivery-sdk-ruby/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions, and begin contributing.
+Check out the [contributing](https://github.com/Kentico/kontent-delivery-sdk-ruby/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions, and begin contributing.
 
 ## License
 
@@ -505,6 +506,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Delivery project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Kentico/delivery-sdk-net/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Delivery project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Kentico/kontent-delivery-sdk-net/blob/master/CODE_OF_CONDUCT.md).
 
-![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/delivery-sdk-ruby?pixel)
+![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/kontent-delivery-sdk-ruby?pixel)

data/lib/delivery/builders/image_transformation_builder.rb

@@ -1,267 +1,269 @@
 require 'delivery/query_parameters/query_string'
 
-module KenticoCloud
-  module Delivery
-    module Builders
-      # Provides methods for manipulating the URL of an asset to adjust the image's
-      # size, cropping behavior, background color, output format, and quality.
-      #
-      # See https://developer.kenticocloud.com/v1/reference#image-transformation and
-      # https://github.com/Kentico/delivery-sdk-ruby#image-transformation.
-      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
+module Kentico
+  module Kontent
+    module Delivery
+      module Builders
+        # Provides methods for manipulating the URL of an asset to adjust the image's
+        # size, cropping behavior, background color, output format, and quality.
+        #
+        # See https://developer.kenticocloud.com/v1/reference#image-transformation and
+        # https://github.com/Kentico/kontent-delivery-sdk-ruby#image-transformation.
+        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
+          class << self
+            def transform(url)
+              AssetURL.new url
+            end
           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 parameter must be a boolean, 0, or 1.'.freeze
+        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 parameter must be a boolean, 0, or 1.'.freeze
 
-        # Constructor. Generally, you obtain an +AssetURL+ object by calling
-        # KenticoCloud::Delivery::Builders::ImageTransformationBuilder.transform
-        # instead of using this constructor.
-        def initialize(url)
-          @url = url
-          @query_string = KenticoCloud::Delivery::QueryParameters::QueryString.new
-        end
+          # Constructor. Generally, you obtain an +AssetURL+ object by calling
+          # Kentico::Kontent::Delivery::Builders::ImageTransformationBuilder.transform
+          # instead of using this constructor.
+          def initialize(url)
+            @url = url
+            @query_string = Kentico::Kontent::Delivery::QueryParameters::QueryString.new
+          end
 
-        # Applies all transformation options to the asset URL.
-        #
-        # * *Returns*:
-        #   - +string+ The full URL to the asset with all query string parameters set
-        def url
-          @url + @query_string.to_s
-        end
+          # Applies all transformation options to the asset URL.
+          #
+          # * *Returns*:
+          #   - +string+ The full URL to the asset with all query string parameters set
+          def url
+            @url + @query_string.to_s
+          end
 
-        # Sets the width of the image
-        #
-        # * *Args*:
-        #   - *width*
-        #     - +integer+ Width in pixels, between 1 and 8192.
-        #     - +float+ Width in percentage, between 0 and 1.
-        #
-        # * *Returns*:
-        #   - +self+
-        def with_width(width)
-          @query_string.set_param 'w', width
-          self
-        end
+          # Sets the width of the image
+          #
+          # * *Args*:
+          #   - *width*
+          #     - +integer+ Width in pixels, between 1 and 8192.
+          #     - +float+ Width in percentage, between 0 and 1.
+          #
+          # * *Returns*:
+          #   - +self+
+          def with_width(width)
+            @query_string.set_param 'w', width
+            self
+          end
 
-        # Sets the height of the image
-        #
-        # * *Args*:
-        #   - *height*
-        #     - +integer+ Height in pixels, between 1 and 8192.
-        #     - +float+ Height in percentage, between 0 and 1.
-        #
-        # * *Returns* :
-        #   - +self+
-        def with_height(height)
-          @query_string.set_param 'h', height
-          self
-        end
+          # Sets the height of the image
+          #
+          # * *Args*:
+          #   - *height*
+          #     - +integer+ Height in pixels, between 1 and 8192.
+          #     - +float+ Height in percentage, between 0 and 1.
+          #
+          # * *Returns* :
+          #   - +self+
+          def with_height(height)
+            @query_string.set_param 'h', height
+            self
+          end
 
-        # Sets the device pixel ratio. Either width or height
-        # (or both) must be set.
-        #
-        # * *Args*:
-        #   - *dpr* (+float+) Pixel ratio between 0 and 5.
-        #
-        # * *Returns*:
-        #   - +self+
-        def with_pixel_ratio(dpr)
-          @query_string.set_param 'dpr', dpr
-          self
-        end
+          # Sets the device pixel ratio. Either width or height
+          # (or both) must be set.
+          #
+          # * *Args*:
+          #   - *dpr* (+float+) Pixel ratio between 0 and 5.
+          #
+          # * *Returns*:
+          #   - +self+
+          def with_pixel_ratio(dpr)
+            @query_string.set_param 'dpr', dpr
+            self
+          end
 
-        # Defines how the image is constrained while resizing. Either width
-        # or height (or both) must be set.
-        #
-        # * *Args*:
-        #   - *fit* (+string+) Use constants from KenticoCloud::Delivery::Builders::ImageTransformationBuilder
-        #
-        # * *Returns*:
-        #   - +self+
-        def with_fit_mode(fit)
-          @query_string.set_param 'fit', fit
-          self
-        end
+          # Defines how the image is constrained while resizing. Either width
+          # or height (or both) must be set.
+          #
+          # * *Args*:
+          #   - *fit* (+string+) Use constants from Kentico::Kontent::Delivery::Builders::ImageTransformationBuilder
+          #
+          # * *Returns*:
+          #   - +self+
+          def with_fit_mode(fit)
+            @query_string.set_param 'fit', fit
+            self
+          end
 
-        # Selects a region of the image to perform transformations on.
-        # Setting this will remove focal point cropping from the image,
-        # as the two options are incompatible.
-        #
-        # * *Args*:
-        #   - *x*
-        #     - +integer+ The left border of the rect in pixels
-        #     - +float+ The left border of the rect as a percentage between 0 and 1
-        #   - *y*
-        #     - +integer+ The top border of the rect in pixels
-        #     - +float+ The top border of the rect as a percentage between 0 and 1
-        #   - *width*
-        #     - +integer+ The width of the rect in pixels
-        #     - +float+ The width of the rect as a percentage between 0 and 1
-        #   - *height*
-        #     - +integer+ The height of the rect in pixels
-        #     - +float+ The height of the rect as a percentage between 0 and 1
-        #
-        # * *Returns*:
-        #   - +self+
-        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'
-          @query_string.set_param 'rect', "#{x},#{y},#{width},#{height}"
-          self
-        end
+          # Selects a region of the image to perform transformations on.
+          # Setting this will remove focal point cropping from the image,
+          # as the two options are incompatible.
+          #
+          # * *Args*:
+          #   - *x*
+          #     - +integer+ The left border of the rect in pixels
+          #     - +float+ The left border of the rect as a percentage between 0 and 1
+          #   - *y*
+          #     - +integer+ The top border of the rect in pixels
+          #     - +float+ The top border of the rect as a percentage between 0 and 1
+          #   - *width*
+          #     - +integer+ The width of the rect in pixels
+          #     - +float+ The width of the rect as a percentage between 0 and 1
+          #   - *height*
+          #     - +integer+ The height of the rect in pixels
+          #     - +float+ The height of the rect as a percentage between 0 and 1
+          #
+          # * *Returns*:
+          #   - +self+
+          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'
+            @query_string.set_param 'rect', "#{x},#{y},#{width},#{height}"
+            self
+          end
 
-        # Sets the point of interest when cropping the image.
-        # Setting this will remove the source rectangle region,
-        # as the two options are incompatible. It also automatically sets the
-        # crop to "focalpoint" and fit to "crop"
-        #
-        # * *Args*:
-        #   - *x* (+float+) Percentage of the image's width between 0 and 1
-        #   - *y* (+float+) Percentage of the image's height between 0 and 1
-        #   - *z* (+integer+) Amount of zoom to apply. A value of 1 is the default zoom, and each step represents 100% additional zoom.
-        #
-        # * *Returns*:
-        #   - +self+
-        def with_focal_point(x, y, z)
-          raise ArgumentError, INVALID_PARAMS unless valid_dims?(x, y, z)
+          # Sets the point of interest when cropping the image.
+          # Setting this will remove the source rectangle region,
+          # as the two options are incompatible. It also automatically sets the
+          # crop to "focalpoint" and fit to "crop"
+          #
+          # * *Args*:
+          #   - *x* (+float+) Percentage of the image's width between 0 and 1
+          #   - *y* (+float+) Percentage of the image's height between 0 and 1
+          #   - *z* (+integer+) Amount of zoom to apply. A value of 1 is the default zoom, and each step represents 100% additional zoom.
+          #
+          # * *Returns*:
+          #   - +self+
+          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 'fit', ImageTransformationBuilder::FIT_MODE_CROP
-          @query_string.set_param 'crop', 'focalpoint'
-          self
-        end
+            @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 'fit', ImageTransformationBuilder::FIT_MODE_CROP
+            @query_string.set_param 'crop', 'focalpoint'
+            self
+          end
 
-        # Sets the background color of any transparent areas of the image.
-        #
-        # * *Args*:
-        #   - *color* (+string+) A valid 3, 4, 6, or 8 digit hexadecimal color, without the # symbol
-        #
-        # * *Returns*:
-        #   - +self+
-        def with_background_color(color)
-          @query_string.set_param 'bg', color
-          self
-        end
+          # Sets the background color of any transparent areas of the image.
+          #
+          # * *Args*:
+          #   - *color* (+string+) A valid 3, 4, 6, or 8 digit hexadecimal color, without the # symbol
+          #
+          # * *Returns*:
+          #   - +self+
+          def with_background_color(color)
+            @query_string.set_param 'bg', color
+            self
+          end
 
-        # Sets the output format of the request for the image.
-        #
-        # * *Args*:
-        #   - *format* (+string+) Use constants from KenticoCloud::Delivery::Builders::ImageTransformationBuilder
-        #
-        # * *Returns*:
-        #   - +self+
-        def with_output_format(format)
-          @query_string.set_param 'fm', format
-          self
-        end
+          # Sets the output format of the request for the image.
+          #
+          # * *Args*:
+          #   - *format* (+string+) Use constants from Kentico::Kontent::Delivery::Builders::ImageTransformationBuilder
+          #
+          # * *Returns*:
+          #   - +self+
+          def with_output_format(format)
+            @query_string.set_param 'fm', format
+            self
+          end
 
-        # Configure the amount of compression for lossy file formats. Lower quality
-        # images will have a smaller file size. Only affects *jpg*, *pjpg*, and
-        # *webp* files.
-        #
-        # When no quality is specified for an image transformation, the default
-        # value of 85 is used.
-        #
-        # * *Args*:
-        #   - *quality* (+integer+) The quality of the image between 1 and 100
-        #
-        # * *Returns*:
-        #   - +self+
-        #
-        # * *Raises*:
-        #   - +ArgumentError+ if +quality+ is not between 1 and 100 inclusive
-        def with_quality(quality)
-          raise ArgumentError, ONE_TO_100 unless quality.to_i >= 1 && quality.to_i <= 100
+          # Configure the amount of compression for lossy file formats. Lower quality
+          # images will have a smaller file size. Only affects *jpg*, *pjpg*, and
+          # *webp* files.
+          #
+          # When no quality is specified for an image transformation, the default
+          # value of 85 is used.
+          #
+          # * *Args*:
+          #   - *quality* (+integer+) The quality of the image between 1 and 100
+          #
+          # * *Returns*:
+          #   - +self+
+          #
+          # * *Raises*:
+          #   - +ArgumentError+ if +quality+ is not between 1 and 100 inclusive
+          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
+            @query_string.set_param 'q', quality
+            self
+          end
 
-        # Sets the lossless parameter. If +true+, automatically sets the format
-        # to WebP.
-        #
-        # * *Args*:
-        #   - *lossless*
-        #     - +integer+ Either 1 or 0
-        #     - +bool+ Either +true+ or +false+
-        #     - +string+ Either 'true' or 'false'
-        #
-        # * *Returns*:
-        #   - +self+
-        #
-        # * *Raises*:
-        #   - +ArgumentError+ if +lossless+ cannot be parsed as a boolean
-        def with_lossless(lossless)
-          lossless = lossless.to_s.downcase
-          raise ArgumentError, BOOLEAN_PARAM unless bool? lossless
+          # Sets the lossless parameter. If +true+, automatically sets the format
+          # to WebP.
+          #
+          # * *Args*:
+          #   - *lossless*
+          #     - +integer+ Either 1 or 0
+          #     - +bool+ Either +true+ or +false+
+          #     - +string+ Either 'true' or 'false'
+          #
+          # * *Returns*:
+          #   - +self+
+          #
+          # * *Raises*:
+          #   - +ArgumentError+ if +lossless+ cannot be parsed as a boolean
+          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
+            @query_string.set_param 'lossless', lossless
+            @query_string.set_param 'fm', Kentico::Kontent::Delivery::Builders::ImageTransformationBuilder::FORMAT_WEBP if %w[true 1].include? lossless
+            self
+          end
 
-        # Enables or disables automatic format selection. If enabled, it will
-        # override the format parameter and deliver WebP instead. If the browser
-        # does not support WebP, the value of the format parameter will be used.
-        #
-        # * *Args*:
-        #   - *auto*
-        #     - +integer+ Either 1 or 0
-        #     - +bool+ Either +true+ or +false+
-        #     - +string+ Either 'true' or 'false'
-        #
-        # * *Returns*:
-        #   - +self+
-        #
-        # * *Raises*:
-        #   - +ArgumentError+ if +auto+ cannot be parsed as a boolean
-        def with_auto_format_selection(auto)
-          auto = auto.to_s.downcase
-          raise ArgumentError, BOOLEAN_PARAM unless bool? auto
+          # Enables or disables automatic format selection. If enabled, it will
+          # override the format parameter and deliver WebP instead. If the browser
+          # does not support WebP, the value of the format parameter will be used.
+          #
+          # * *Args*:
+          #   - *auto*
+          #     - +integer+ Either 1 or 0
+          #     - +bool+ Either +true+ or +false+
+          #     - +string+ Either 'true' or 'false'
+          #
+          # * *Returns*:
+          #   - +self+
+          #
+          # * *Raises*:
+          #   - +ArgumentError+ if +auto+ cannot be parsed as a boolean
+          def with_auto_format_selection(auto)
+            auto = auto.to_s.downcase
+            raise ArgumentError, BOOLEAN_PARAM unless bool? auto
 
-          if %w[true 1].include? auto
-            @query_string.set_param 'auto', 'format'
-          else
-            @query_string.remove_param 'auto'
+            if %w[true 1].include? auto
+              @query_string.set_param 'auto', 'format'
+            else
+              @query_string.remove_param 'auto'
+            end
+            self
           end
-          self
-        end
 
-        private
+          private
 
-        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
+          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
 
-        def bool?(value)
-          %w[true false 0 1].include? value
+          def bool?(value)
+            %w[true false 0 1].include? value
+          end
         end
       end
     end