imagekitio 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7426d823c34ead157150f2413efda3f1f8fd12b0d53a400cd530f4b7f5f9819
-  data.tar.gz: 646a956c5bbf90bc438b4ca594644f76004fa5363a2cd955947ad7e5547789ab
+  metadata.gz: 6aa3937bea9d3b4ff1bbc6a5f7bde28eeee0de07c423ed5daf702f2bbcba00ff
+  data.tar.gz: 3b83ee3b6a677905be5f03eb7023c53495fb0b79c7f623e5f8844fffd48d74c1
 SHA512:
-  metadata.gz: 73453ebcb67186cecc40163a8c8033f2823fe001c550785ee806913d4ef7cda9e2258a22f3af24f6655276604f4509c55b9f5ec627acadb8f899138be5835735
-  data.tar.gz: d59c94eca505d2b44cb02846e46a9a866ce2acfa475599b95bc54ab3a51bcc762bd3c35222b2b8c33928a363e6f78db44fd70e8f82406d5884c93647d2b3d475
+  metadata.gz: 548b8b9820cea02e34a10d939c962af956fe54a25027d69c8362153a33ef936db770520b4522947cfd0fa7a7003af308c2f4eef9b39286406ea1b2a70ec3a1e0
+  data.tar.gz: cfa61aefd6ec06f1b6b246cff9a36aebb8315dc1b9fd0b40c0f8ab595ff3060010c6df64780a707d65246de7af1ad3b44bdf07cf083c991ebfb1472f3bb3ee6a

data/README.md

@@ -13,6 +13,7 @@ Ruby on Rails gem for [ImageKit](https://imagekit.io/) implements the new APIs a
 ImageKit is complete media storage, optimization, and transformation solution that comes with an [image and video CDN](https://imagekit.io/features/imagekit-infrastructure). It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.
 
 Table of contents -
+ * [Changelog](#changelog)
  * [Installation](#installation)
  * [Initialization](#initialization)
     - [CarrierWave](#carrierwave)
@@ -28,7 +29,14 @@ Table of contents -
 
 
 # Quick start guide
-Get started with [official quick start guide](https://docs.imagekit.io/getting-started/quickstart-guides/ruby-on-rails) for integrating ImageKit in Ruby on Rails.
+Get started with [official quick start guide](https://docs.imagekit.io/getting-started/quickstart-guides/ruby-guides) for integrating ImageKit in Ruby on Rails.
+
+## Changelog
+### SDK Version 3.0.0
+#### Breaking changes
+**1. Overlay syntax update**
+* In version 3.0.0, we've removed the old overlay syntax parameters for transformations, such as `oi`, `ot`, `obg`, and [more](https://docs.imagekit.io/features/image-transformations/overlay). These parameters are deprecated and will start returning errors when used in URLs. Please migrate to the new layers syntax that supports overlay nesting, provides better positional control, and allows more transformations at the layer level. You can start with [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples) to learn quickly.
+* You can migrate to the new layers syntax using the `raw` transformation parameter.
 
 ## Installation
 
@@ -282,6 +290,99 @@ image_url = imagekit.url({
 https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400/default-image.jpg?v=123&ik-t=1567358667&ik-s=f2c7cdacbe7707b71a83d49cf1c6110e3d701054
 ```
 
+**4. Adding overlays**
+
+ImageKit.io enables you to apply overlays to [images](https://docs.imagekit.io/features/image-transformations/overlay-using-layers) and [videos](https://docs.imagekit.io/features/video-transformation/overlay) using the raw parameter with the concept of [layers](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#layers). The raw parameter facilitates incorporating transformations directly in the URL. A layer is a distinct type of transformation that allows you to define an asset to serve as an overlay, along with its positioning and additional transformations.
+
+**Text as overlays**
+
+You can add any text string over a base video or image using a text layer (l-text).
+
+For example:
+
+```ruby
+image_url = imagekit.url({
+    path: "/default-image",
+    url_endpoint: "https://ik.imagekit.io/your_imagekit_id/endpoint/",
+    transformation: [{
+        height: "300",
+        width: "400",
+        raw: "l-text,i-Imagekit,fs-50,l-end"
+    }],
+})
+```
+**Sample Result URL**
+```
+https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400,l-text,i-Imagekit,fs-50,l-end/default-image.jpg
+```
+
+**Image as overlays**
+
+You can add an image over a base video or image using an image layer (l-image).
+
+For example:
+
+```ruby
+image_url = imagekit.url({
+    path: "/default-image",
+    url_endpoint: "https://ik.imagekit.io/your_imagekit_id/endpoint/",
+    transformation: [{
+        height: "300",
+        width: "400",
+        raw: "l-image,i-default-image.jpg,w-100,b-10_CDDC39,l-end"
+    }],
+})
+```
+**Sample Result URL**
+```
+https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400,l-image,i-default-image.jpg,w-100,b-10_CDDC39,l-end/default-image.jpg
+```
+
+**Solid color blocks as overlays**
+
+You can add solid color blocks over a base video or image using an image layer (l-image).
+
+For example:
+
+```ruby
+image_url = imagekit.url({
+    path: "/img/sample-video",
+    url_endpoint: "https://ik.imagekit.io/your_imagekit_id/endpoint/",
+    transformation: [{
+        height: "300",
+        width: "400",
+        raw: "l-image,i-ik_canvas,bg-FF0000,w-300,h-100,l-end"
+    }],
+})
+```
+**Sample Result URL**
+```
+https://ik.imagekit.io/your_imagekit_id/tr:h-300,w-400,l-image,i-ik_canvas,bg-FF0000,w-300,h-100,l-end/img/sample-video.mp4
+```
+
+**5. Arithmetic expressions in transformations**
+
+ImageKit allows use of [arithmetic expressions](https://docs.imagekit.io/features/arithmetic-expressions-in-transformations) in certain dimension and position-related parameters, making media transformations more flexible and dynamic.
+
+For example:
+
+```ruby
+image_url = imagekit.url({
+    path: "/default-image.jpg",
+    url_endpoint: "https://ik.imagekit.io/your_imagekit_id/endpoint/",
+    transformation: [{
+        width: "iw_div_4",
+        height: "ih_div_2",
+        border: "cw_mul_0.05_yellow"
+    }]
+});
+```
+
+**Sample Result URL**
+```
+https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=w-iw_div_4,h-ih_div_2,b-cw_mul_0.05_yellow
+```
+
 **List of transformations**
 
 The complete list of transformations supported and their usage in ImageKit can be found [here](https://docs.imagekit.io/features/image-transformations/resize-crop-and-other-transformations). The SDK gives a name to each transformation parameter, making the code simpler, making the code simpler, and readable.
@@ -294,10 +395,10 @@ If you want to generate transformations in your application and add them to the
 |-------------------------------|-------------------------|
 | height | h |
 | width | w |
-| aspectRatio | ar |
+| aspect_ratio | ar |
 | quality | q |
 | crop | c |
-| cropMode | cm |
+| crop_mode | cm |
 | x | x |
 | y | y |
 | focus | fo |
@@ -308,45 +409,19 @@ If you want to generate transformations in your application and add them to the
 | rotation | rt |
 | blur | bl |
 | named | n |
-| overlayX | ox |
-| overlayY | oy |
-| overlayFocus | ofo |
-| overlayHeight | oh |
-| overlayWidth | ow |
-| overlayImage | oi |
-| overlayImageTrim | oit |
-| overlayImageAspectRatio | oiar |
-| overlayImageBackground | oibg |
-| overlayImageBorder | oib |
-| overlayImageDPR | oidpr |
-| overlayImageQuality | oiq |
-| overlayImageCropping | oic |
-| overlayImageTrim | oit |
-| overlayText | ot |
-| overlayTextFontSize | ots |
-| overlayTextFontFamily | otf |
-| overlayTextColor | otc |
-| overlayTextTransparency | oa |
-| overlayAlpha | oa |
-| overlayTextTypography | ott |
-| overlayBackground | obg |
-| overlayTextEncoded | ote |
-| overlayTextWidth | otw |
-| overlayTextBackground | otbg |
-| overlayTextPadding | otp |
-| overlayTextInnerAlignment | otia |
-| overlayRadius | or |
 | progressive | pr |
 | lossless | lo |
 | trim | t |
 | metadata | md |
-| colorProfile | cp |
-| defaultImage | di |
+| color_profile | cp |
+| default_image | di |
 | dpr | dpr |
-| effectSharpen | e-sharpen |
-| effectUSM | e-usm |
-| effectContrast | e-contrast |
-| effectGray | e-grayscale |
+| effect_sharpen | e-sharpen |
+| effect_usm | e-usm |
+| effect_contrast | e-contrast |
+| effect_gray | e-grayscale |
+| effect_shadow | e-shadow |
+| effect_gradient | e-gradient |
 | original | orig |
 | raw | `replaced by the parameter value` |
 

data/lib/active_storage/service/ik_file.rb

@@ -106,6 +106,10 @@ module ImageKiIo
       def extension_status
         identifier['extensionStatus']
       end
+
+      def transformation
+        identifier['transformation']
+      end
     end
   end
 end

data/lib/imagekitio/api_service/file.rb

@@ -36,6 +36,7 @@ module ImageKitIo
         content_type = options.delete(:content_type) || ''
         options = format_to_json(options, :extensions, Array)
         options = format_to_json(options, :custom_metadata, Hash)
+        options = format_to_json(options, :transformation, Hash)
         options = validate_upload_options(options || {})
         if options.is_a?(FalseClass)
           raise ArgumentError, "Invalid Upload option"

data/lib/imagekitio/constants/file.rb

@@ -5,7 +5,7 @@ module ImageKitIo
 
       VALID_FILE_DETAIL_OPTIONS = ["fileID"]
 
-      VALID_UPLOAD_OPTIONS = %w[file file_name use_unique_file_name tags folder is_private_file custom_coordinates response_fields extensions webhook_url overwrite_file overwrite_AI_tags overwrite_custom_metadata custom_metadata mime overwrite_tags content_type  ]
+      VALID_UPLOAD_OPTIONS = %w[file file_name use_unique_file_name tags folder is_private_file custom_coordinates response_fields extensions webhook_url overwrite_file overwrite_AI_tags overwrite_custom_metadata custom_metadata mime overwrite_tags content_type transformation ]
     end
   end
 end

data/lib/imagekitio/constants/supported_transformation.rb

@@ -18,33 +18,6 @@ module ImageKitIo
         'rotation': "rt",
         'blur': "bl",
         'named': "n",
-        'overlay_image': "oi",
-        'overlay_image_trim': "oit",
-        'overlay_image_cropping': "oic",
-        'overlay_image_quality': "oiq",
-        'overlay_image_DPR': "oidpr",
-        'overlay_image_border': "oib",
-        'overlay_image_background': "oibg",
-        'overlay_image_aspect_ratio': "oiar",
-        'overlay_x': "ox",
-        'overlay_y': "oy",
-        'overlay_focus': "ofo",
-        'overlay_height': "oh",
-        'overlay_width': "ow",
-        'overlay_text': "ot",
-        'overlay_text_font_size': "ots",
-        'overlay_text_font_family': "otf",
-        'overlay_text_encoded': "ote",
-        'overlay_text_color': "otc",
-        'overlay_text_width': "otw",
-        'overlay_text_background': "otbg",
-        'overlay_text_padding': "otp",
-        'overlay_text_inner_alignment': "otia",
-        'overlay_text_transparency': "oa",
-        'overlay_alpha': "oa",
-        'overlay_radius': "or",
-        'overlay_text_typography': "ott",
-        'overlay_background': "obg",
         'progressive': "pr",
         'lossless': "lo",
         'trim': "t",
@@ -56,6 +29,8 @@ module ImageKitIo
         'effect_usm': "e-usm",
         'effect_contrast': "e-contrast",
         'effect_gray': "e-grayscale",
+        'effect_shadow': "e-shadow",
+        'effect_gradient': "e-gradient",
         'original': "orig",
         'raw': 'raw',
       }

data/lib/imagekitio/sdk/version.rb

@@ -1,5 +1,5 @@
 module ImageKitIo
   module Sdk
-    VERSION = '2.3.0'
+    VERSION = '3.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imagekitio
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - ImageKit.io team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable