refactor: standardize method naming for URL and transformation string generation

Author: manu4543

lib/imagekit/helpers/helper.rb

@@ -7,7 +7,7 @@ class Helper
       #
       # @param transformations [Array<Imagekit::Models::Transformation>] Array of transformation objects
       # @return [String] The built URL with transformations
-      def buildURL(transformations)
+      def build_url(transformations)
         # TODO: Implement actual URL building logic
         # For now, return a fixed URL as requested
         "https://ik.imagekit.io/your_imagekit_id/sample-image.jpg?tr=w-400,h-300"
@@ -17,23 +17,31 @@ def buildURL(transformations)
       #
       # @param transformations [Array<Imagekit::Models::Transformation>] Array of transformation objects
       # @return [String] The transformation string (e.g., "w-400,h-300")
-      def buildTransformationString(transformations)
+      def build_transformation_string(transformations)
         # TODO: Implement actual transformation string generation
         # For now, return a fixed transformation string
         "w-400,h-300"
       end
 
-      # Gets authentication parameters for ImageKit requests
+      # Generates authentication parameters for client-side file uploads using ImageKit's Upload API V1.
       #
-      # @param token [String, nil] Optional token for authentication
-      # @return [Hash] Authentication parameters
-      def GetAuthenticationParameters(token = nil)
+      # This method creates the required authentication signature that allows secure file uploads
+      # directly from the browser or mobile applications without exposing your private API key.
+      # The generated parameters include a unique token, expiration timestamp, and HMAC signature.
+      #
+      # @param token [String, nil] Custom token for the upload session. If not provided, a UUID v4 will be generated automatically.
+      # @param expire [Integer, nil] Expiration time in seconds from now. If not provided, defaults to 1800 seconds (30 minutes).
+      # @return [Hash] Authentication parameters object containing:
+      #   - token: Unique identifier for this upload session
+      #   - expire: Unix timestamp when these parameters expire
+      #   - signature: HMAC-SHA1 signature for authenticating the upload
+      def get_authentication_parameters(token = nil, expire = nil)
         # TODO: Implement actual authentication parameter generation
         # For now, return a fixed hash
         {
-          signature: "dummy_signature",
-          expire: Time.now.to_i + 3600,
-          token: token || "dummy_token"
+          token: token || "dummy_token",
+          expire: expire || (Time.now.to_i + 1800),
+          signature: "dummy_signature"
         }
       end
 

rbi/imagekit/helpers/helper.rbi

@@ -12,23 +12,24 @@ module Imagekit
           transformations: T::Array[Imagekit::Models::Transformation]
         ).returns(String)
       end
-      def buildURL(transformations); end
+      def build_url(transformations); end
 
       # Generates transformation string from transformation objects
       sig do
         params(
           transformations: T::Array[Imagekit::Models::Transformation]
         ).returns(String)
       end
-      def buildTransformationString(transformations); end
+      def build_transformation_string(transformations); end
 
-      # Gets authentication parameters for ImageKit requests
+      # Generates authentication parameters for client-side file uploads
       sig do
-        params(token: T.nilable(String)).returns(
-          T::Hash[Symbol, T.any(String, Integer)]
-        )
+        params(
+          token: T.nilable(String),
+          expire: T.nilable(Integer)
+        ).returns(T::Hash[Symbol, T.any(String, Integer)])
       end
-      def GetAuthenticationParameters(token = nil); end
+      def get_authentication_parameters(token = nil, expire = nil); end
     end
   end
 end

sig/imagekit/helpers/helper.rbs

@@ -4,13 +4,13 @@ module Imagekit
       def initialize: (client: Imagekit::Client) -> void
 
       # Builds a URL with transformations applied
-      def buildURL: (Array[Imagekit::Models::Transformation] transformations) -> String
+      def build_url: (Array[Imagekit::Models::Transformation] transformations) -> String
 
       # Generates transformation string from transformation objects
-      def buildTransformationString: (Array[Imagekit::Models::Transformation] transformations) -> String
+      def build_transformation_string: (Array[Imagekit::Models::Transformation] transformations) -> String
 
-      # Gets authentication parameters for ImageKit requests
-      def GetAuthenticationParameters: (?String? token) -> Hash[Symbol, (String | Integer)]
+      # Generates authentication parameters for client-side file uploads
+      def get_authentication_parameters: (?String? token, ?Integer? expire) -> Hash[Symbol, (String | Integer)]
     end
   end
 end