feat(tests): add support for plain hashes in various helper methods and tests

Author: manu4543

lib/imagekit/helpers/helper.rb

@@ -448,8 +448,12 @@ def path_join(parts, separator = "/")
       def process_overlay(overlay)
         return "" unless overlay
 
-        # All overlay inputs are expected to be BaseModel objects with type accessor
-        type = overlay.type
+        # Support both BaseModel objects and plain hashes
+        type = if overlay.is_a?(Hash)
+          overlay[:type] || overlay["type"]
+        else
+          overlay.type
+        end
         return "" unless type
 
         # Determine overlay type based on explicit type field
@@ -595,12 +599,18 @@ def process_solid_color_overlay(overlay)
         parts.join(",")
       end
 
-      # Safe property access for model objects
+      # Safe property access for model objects and hashes
       def safe_get(obj, key)
         return nil unless obj
 
-        # All inputs are expected to be BaseModel objects with property accessors
-        obj.respond_to?(key.to_sym) ? obj.send(key.to_sym) : nil
+        # Support both BaseModel objects and plain hashes
+        if obj.is_a?(Hash)
+          obj[key.to_sym] || obj[key.to_s]
+        elsif obj.respond_to?(key.to_sym)
+          obj.send(key.to_sym)
+        else
+          nil
+        end
       end
 
       # Add overlay properties like position, timing, transformations (matching Node.js)

test/imagekit/custom-tests/responsive_image_attributes_test.rb

@@ -184,6 +184,36 @@ def test_using_query_parameters_and_transformation_position
     assert_equal(expected, result.to_h)
   end
 
+  # Hash-based API test - verify that plain hashes work for responsive image attributes
+  def test_should_work_with_plain_hashes_for_responsive_image_attributes
+    # Using plain hashes instead of model objects
+    result = @client.helper.get_responsive_image_attributes(
+      {
+        src: "sample.jpg",
+        url_endpoint: "https://ik.imagekit.io/demo",
+        width: 450,
+        transformation: [
+          {
+            height: 300
+          },
+          {
+            ai_remove_background: true
+          }
+        ]
+      }
+    )
+
+    # Multiple caller transformations should be combined appropriately
+    expected = {
+      src: "https://ik.imagekit.io/demo/sample.jpg?tr=h-300:e-bgremove:w-1080,c-at_max",
+      src_set: "https://ik.imagekit.io/demo/sample.jpg?tr=h-300:e-bgremove:w-640,c-at_max 1x, https://ik.imagekit.io/demo/sample.jpg?tr=h-300:e-bgremove:w-1080,c-at_max 2x",
+      sizes: nil,
+      width: 450
+    }
+
+    assert_equal(expected, result.to_h)
+  end
+
   def test_fallback_when_no_usable_vw_tokens
     result = @client.helper.get_responsive_image_attributes(
       src: "sample.jpg",

test/imagekit/custom-tests/url-generation/advanced_url_generation_test.rb

@@ -450,4 +450,30 @@ def test_should_generate_the_correct_url_with_many_transformations_including_vid
     expected = "https://ik.imagekit.io/test_url_endpoint/test_path.jpg?tr=h-300,w-400,ar-4-3,q-40,c-force,cm-extract,fo-left,f-jpeg,r-50,bg-A94D34,b-5-A94D34,rt-90,bl-10,n-some_name,pr-true,lo-true,t-5,md-true,cp-true,di-folder@@file.jpg,dpr-3,x-10,y-20,xc-30,yc-40,fl-h,o-0.8,z-2,vc-h264,ac-aac,so-5,eo-15,du-10,sr-1440_1080,e-grayscale,e-upscale,e-retouch,e-genvar,e-dropshadow,e-changebg-prompt-car,e-edit-prompt-make it vintage,e-bgremove,e-contrast,e-shadow-bl-15_st-40_x-10_y-N5,e-sharpen-10,e-usm-2-2-0.8-0.024,e-gradient-from-red_to-white,orig-true,pg-2_4,h-200,w-300,l-image,i-logo.png,l-end"
     assert_equal(expected, url)
   end
+
+  # Hash-based API test - verify that plain hashes work for both transformations and options
+  # Developers can use hashes instead of model objects for a more concise, Ruby-idiomatic syntax
+  def test_should_work_with_plain_hashes_for_transformations_and_options
+    # Using plain hashes instead of Transformation.new and SrcOptions.new
+    url = @client.helper.build_url(
+      {
+        src: "/test_path1.jpg",
+        url_endpoint: "https://ik.imagekit.io/test_url_endpoint",
+        transformation_position: :query,
+        transformation: [
+          {
+            width: 300,
+            height: 200,
+            quality: 85,
+            border: "5_FF0000",
+            ai_remove_background: true,
+            ai_drop_shadow: true
+          }
+        ]
+      }
+    )
+
+    expected = "https://ik.imagekit.io/test_url_endpoint/test_path1.jpg?tr=w-300,h-200,q-85,b-5_FF0000,e-bgremove,e-dropshadow"
+    assert_equal(expected, url)
+  end
 end

test/imagekit/custom-tests/url-generation/overlay_test.rb

@@ -724,4 +724,40 @@ def test_should_properly_encode_overlay_text_when_transformations_are_in_query_p
     expected = "https://ik.imagekit.io/demo/sample.jpg?tr=l-text,i-Minimal%20Text,l-end"
     assert_equal(expected, url)
   end
+
+  # Hash-based API test - verify that plain hashes work for overlays
+  def test_should_work_with_plain_hashes_for_text_overlay
+    # Using plain hashes for everything including overlay
+    url = @client.helper.build_url(
+      {
+        src: "/base-image.jpg",
+        url_endpoint: "https://ik.imagekit.io/test_url_endpoint",
+        transformation_position: :path,
+        transformation: [
+          {
+            width: 300,
+            height: 200,
+            overlay: {
+              type: :text,
+              text: "Hello World",
+              position: {
+                x: "10",
+                y_: "20",
+                focus: :center
+              },
+              transformation: [
+                {
+                  font_size: 20,
+                  font_color: "FF0000"
+                }
+              ]
+            }
+          }
+        ]
+      }
+    )
+
+    expected = "https://ik.imagekit.io/test_url_endpoint/tr:w-300,h-200,l-text,i-Hello%20World,lx-10,ly-20,lfo-center,fs-20,co-FF0000,l-end/base-image.jpg"
+    assert_equal(expected, url)
+  end
 end

test/imagekit/custom-tests/url-generation/signing_test.rb

@@ -209,4 +209,28 @@ def test_should_generate_signed_url_with_transformations_in_path_position_and_qu
     expected = "https://ik.imagekit.io/demo/tr:w-300,h-200/sdk-testing-files/future-search.png?version=2.0&ik-s=dd1ee8f83d019bc59fd57a5fc4674a11eb8a3496"
     assert_equal(expected, url)
   end
+
+  # Hash-based API test - verify that plain hashes work for signed URLs
+  def test_should_work_with_plain_hashes_for_signed_url_with_transformations
+    # Using plain hashes instead of model objects
+    url = @client.helper.build_url(
+      {
+        src: "sdk-testing-files/future-search.png",
+        url_endpoint: "https://ik.imagekit.io/demo/",
+        transformation: [
+          {
+            width: 300,
+            height: 200
+          }
+        ],
+        query_parameters: {
+          "version" => "2.0"
+        },
+        signed: true
+      }
+    )
+
+    expected = "https://ik.imagekit.io/demo/sdk-testing-files/future-search.png?version=2.0&tr=w-300,h-200&ik-s=601d97a7834b7554f4dabf0d3fc3a219ceeb6b31"
+    assert_equal(expected, url)
+  end
 end