imagekitio 3.1.0 → 4.0.0

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by ImageKit, please follow the respective company's security reporting guidelines.
+
+### ImageKit Terms and Policies
+
+Please contact developer@imagekit.io for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/imagekitio/client.rb

@@ -1,202 +1,129 @@
 # frozen_string_literal: true
 
-$VERBOSE = nil
-
-require_relative "./request"
-require_relative "./url"
-require_relative "./utils/calculation"
-require_relative './constant'
-require_relative './configurable'
-require_relative './api_service/custom_metadata_field'
-require_relative './api_service/folder'
-require_relative './api_service/file'
-require_relative './api_service/bulk'
-
-module ImageKitIo
-  # ImageKitIo class holds each method will be used by user
-  class Client
-    include Utils::Calculation
-    include Constantable
-
-    attr_reader :file_service, :custom_metadata_field_service, :folder_service, :bulk_service
-
-    def initialize(private_key, public_key, url_endpoint, transformation_pos = nil, options = nil)
-      unless(private_key.is_a?(String) && private_key.to_s.strip.length != 0)
-        raise ArgumentError, constants.MISSING_PRIVATE_KEY
+module Imagekitio
+  class Client < Imagekitio::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # Your ImageKit private API key (starts with `private_`). You can find this in the
+    # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).
+    # @return [String]
+    attr_reader :private_key
+
+    # ImageKit uses your API key as username and ignores the password. The SDK sets a
+    # dummy value. You can ignore this field.
+    # @return [String, nil]
+    attr_reader :password
+
+    # @return [Imagekitio::Resources::CustomMetadataFields]
+    attr_reader :custom_metadata_fields
+
+    # @return [Imagekitio::Resources::Files]
+    attr_reader :files
+
+    # @return [Imagekitio::Resources::Assets]
+    attr_reader :assets
+
+    # @return [Imagekitio::Resources::Cache]
+    attr_reader :cache
+
+    # @return [Imagekitio::Resources::Folders]
+    attr_reader :folders
+
+    # @return [Imagekitio::Resources::Accounts]
+    attr_reader :accounts
+
+    # @return [Imagekitio::Resources::Beta]
+    attr_reader :beta
+
+    # @return [Imagekitio::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # @return [Imagekitio::Helper]
+    attr_reader :helper
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @private_key.nil? || @password.nil?
+
+      base64_credentials = ["#{@private_key}:#{@password}"].pack("m0")
+      {"authorization" => "Basic #{base64_credentials}"}
+    end
+
+    # @api private
+    #
+    # @return [Boolean]
+    def base_url_overridden? = @base_url_overridden
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param private_key [String, nil] Your ImageKit private API key (starts with `private_`). You can find this in the
+    # [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys). Defaults
+    # to `ENV["IMAGEKIT_PRIVATE_KEY"]`
+    #
+    # @param password [String, nil] ImageKit uses your API key as username and ignores the password. The SDK sets a
+    # dummy value. You can ignore this field. Defaults to
+    # `ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["IMAGE_KIT_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      private_key: ENV["IMAGEKIT_PRIVATE_KEY"],
+      password: ENV.fetch("OPTIONAL_IMAGEKIT_IGNORES_THIS", "do_not_set"),
+      base_url: ENV["IMAGE_KIT_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      @base_url_overridden = !base_url.nil?
+
+      base_url ||= "https://api.imagekit.io"
+
+      if private_key.nil? || private_key.to_s.empty?
+        raise ArgumentError.new("private_key is required, and can be set via environ: \"IMAGEKIT_PRIVATE_KEY\"")
       end
-      unless(public_key.is_a?(String) && public_key.to_s.strip.length != 0)
-        raise ArgumentError, constants.MISSING_PUBLIC_KEY
-      end
-      unless(url_endpoint.is_a?(String) && url_endpoint.to_s.strip.length != 0)
-        raise ArgumentError, constants.MISSING_URL_ENDPOINT
-      end
-
-      @private_key = private_key
-      @public_key = public_key
-      @url_endpoint = url_endpoint
-      @transformation_position = transformation_pos
-      @options = options
-
-      @ik_req = Request.new(private_key, public_key, url_endpoint)
-      @url_obj = Url.new(@ik_req)
-      @file_service = ApiService::File.new(@ik_req)
-      @custom_metadata_field_service = ApiService::CustomMetadataField.new(@ik_req)
-      @folder_service = ApiService::Folder.new(@ik_req)
-      @bulk_service = ApiService::Bulk.new(@ik_req)
-    end
-
-    def set_ik_request(ik_req)
-      # setter for imagekit request mainly will be used for
-      # test
-      @ik_req = ik_req
-    end
-
-    def url(options = {})
-      @url_obj.generate_url(options)
-    end
-
-    def upload_file(file: nil, file_name: nil, **options)
-      # upload file to imagekit server
-      @file_service.upload(file: file, file_name: file_name, **options)
-    end
-
-    def list_files(options = {})
-      # list all files
-      @file_service.list(**options)
-    end
-
-    def file_versions(file_id: nil)
-      @file_service.get_file_versions(file_id: file_id)
-    end
-
-    def file_version_detail(file_id: nil, version_id: nil)
-      @file_service.get_file_version_detail(file_id: file_id, version_id: version_id)
-    end
-
-    def delete_file_version(file_id: nil, version_id: nil)
-      @file_service.delete_file_version(file_id: file_id, version_id: version_id)
-    end
-
-    def restore_file_version(file_id: nil, version_id: nil)
-      @file_service.restore_file_version(file_id: file_id, version_id: version_id)
-    end
-
-    def get_file_details(file_id: nil)
-      # Get file detail by file-id or file_url
-      @file_service.details(file_identifier: file_id)
-    end
-
-    def update_file_details(file_id: nil, **options)
-      # update file details by file id and other options payload
-      @file_service.update_details(file_id: file_id, **options)
-    end
-
-    def delete_file(file_id: nil)
-      # Delete a file by file-id
-      @file_service.delete(file_id: file_id)
-    end
-
-    def get_file_metadata(file_id: nil)
-      # Get metadata of a file by file-id
-      @file_service.get_metadata(file_id: file_id)
-    end
-
-    def purge_file_cache(file_url: nil)
-      # Purge cache from ImageKitIo server by file_url
-      @file_service.purge_cache(file_url: file_url)
-    end
-
-    def purge_file_cache_status(request_id: nil)
-      @file_service.purge_cache_status(request_id: request_id.to_s)
-    end
-
-    # Get metadata from remote_file_url
-    # param remote_file_url: url string of remote file
-    def get_remote_file_url_metadata(remote_file_url: "")
-      @file_service.get_metadata_from_remote_url(remote_file_url: remote_file_url)
-    end
-
-    def stream_file(file_url: nil, &block)
-      @file_service.stream_file(remote_file_url: file_url, &block)
-    end
-
-    def copy_file(source_file_path: nil, destination_path: nil, include_file_versions: false)
-      @file_service.copy(source_file_path: source_file_path, destination_path: destination_path, include_file_versions: include_file_versions)
-    end
-
-    def move_file(source_file_path: nil, destination_path: nil)
-      @file_service.move(source_file_path: source_file_path, destination_path: destination_path)
-    end
-
-    def rename_file(file_path: nil, new_file_name: nil, **options)
-      @file_service.rename(file_path: file_path, new_file_name: new_file_name, **options)
-    end
-
-    def add_bulk_tags(file_ids: [], tags: [])
-      @bulk_service.add_tags(file_ids: file_ids, tags: tags)
-    end
-
-    def delete_bulk_files(file_ids: [])
-      # Delete file in bulks by list of file id
-      @bulk_service.remove_files(file_ids: file_ids)
-    end
-
-    def delete_bulk_tags(file_ids: [], tags: [])
-      @bulk_service.remove_tags(file_ids: file_ids, tags: tags)
-    end
-
-    def delete_bulk_ai_tags(file_ids: [], ai_tags: [])
-      @bulk_service.remove_ai_tags(file_ids: file_ids, ai_tags: ai_tags)
-    end
-
-    def bulk_job_status(job_id: nil)
-      @bulk_service.job_status(job_id: job_id)
-    end
-
-    def create_folder(folder_name: nil, parent_folder_path: "/")
-      @folder_service.create(folder_name: folder_name, parent_folder_path: parent_folder_path)
-    end
-
-    def delete_folder(folder_path: nil)
-      @folder_service.delete(folder_path: folder_path)
-    end
-
-    def copy_folder(source_folder_path: nil, destination_path: nil, include_file_versions: false)
-      @folder_service.copy(source_folder_path: source_folder_path, destination_path: destination_path, include_file_versions: include_file_versions)
-    end
-
-    def move_folder(source_folder_path: nil, destination_path: nil)
-      @folder_service.move(source_folder_path: source_folder_path, destination_path: destination_path)
-    end
-
-    def create_custom_metadata_field(name: nil, label: nil, schema: {})
-      @custom_metadata_field_service.create(name: name, label: label, schema: schema)
-    end
-
-    def get_custom_metadata_fields(options = {})
-      @custom_metadata_field_service.list(**options)
-    end
-
-    def update_custom_metadata_field(id: nil, label: nil, schema: nil)
-      @custom_metadata_field_service.update(id: id, label: label, schema: schema)
-    end
-
-    def delete_custom_metadata_field(id: nil)
-      @custom_metadata_field_service.delete(id: id)
-    end
-
-    def phash_distance(first, second)
-      # Get hamming distance between two phash(image hash) to check
-      # similarity between images
-      if first.to_s.strip == "" || second.to_s.strip == ""
-        raise ArgumentError, constants.MISSING_PHASH_VALUE
-      end
-      hamming_distance(first, second)
-    end
 
-    def get_authentication_parameters(token = nil, expire = nil)
-      # Get Authentication params
-      get_authenticated_params(token, expire, @ik_req.private_key)
+      @private_key = private_key.to_s
+      @password = password.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @custom_metadata_fields = Imagekitio::Resources::CustomMetadataFields.new(client: self)
+      @files = Imagekitio::Resources::Files.new(client: self)
+      @assets = Imagekitio::Resources::Assets.new(client: self)
+      @cache = Imagekitio::Resources::Cache.new(client: self)
+      @folders = Imagekitio::Resources::Folders.new(client: self)
+      @accounts = Imagekitio::Resources::Accounts.new(client: self)
+      @beta = Imagekitio::Resources::Beta.new(client: self)
+      @webhooks = Imagekitio::Resources::Webhooks.new(client: self)
+      @helper = Imagekitio::Helper.new(client: self)
     end
   end
 end

data/lib/imagekitio/errors.rb

@@ -1,4 +1,228 @@
-module ImageKitIo
-  class Error < StandardError
+# frozen_string_literal: true
+
+module Imagekitio
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < Imagekitio::Errors::Error
+      # @return [StandardError, nil]
+      def cause = @cause.nil? ? super : @cause
+
+      # @api private
+      #
+      # @param on [Class<StandardError>]
+      # @param method [Symbol]
+      # @param target [Object]
+      # @param value [Object]
+      # @param cause [StandardError, nil]
+      def initialize(on:, method:, target:, value:, cause: nil)
+        cls = on.name.split("::").last
+
+        message = [
+          "Failed to parse #{cls}.#{method} from #{value.class} to #{target.inspect}.",
+          "To get the unparsed API response, use #{cls}[#{method.inspect}].",
+          cause && "Cause: #{cause.message}"
+        ].filter(&:itself).join(" ")
+
+        @cause = cause
+        super(message)
+      end
+    end
+
+    class APIError < Imagekitio::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @headers = headers
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
+    end
+
+    class APIConnectionError < Imagekitio::Errors::APIError
+      # @!attribute status
+      #
+      #   @return [nil]
+
+      # @!attribute body
+      #
+      #   @return [nil]
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
+      end
+    end
+
+    class APITimeoutError < Imagekitio::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+        super
+      end
+    end
+
+    class APIStatusError < Imagekitio::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [self]
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
+
+        case status
+        in 400
+          Imagekitio::Errors::BadRequestError.new(**kwargs)
+        in 401
+          Imagekitio::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          Imagekitio::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          Imagekitio::Errors::NotFoundError.new(**kwargs)
+        in 409
+          Imagekitio::Errors::ConflictError.new(**kwargs)
+        in 422
+          Imagekitio::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          Imagekitio::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          Imagekitio::Errors::InternalServerError.new(**kwargs)
+        else
+          Imagekitio::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          headers: headers,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
+
+    class BadRequestError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Imagekitio::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
   end
 end

data/lib/imagekitio/file_part.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Imagekitio
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [Pathname, String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content_type = content_type
+      @filename =
+        case [filename, (@content = content)]
+        in [String | Pathname, _]
+          ::File.basename(filename)
+        in [nil, Pathname]
+          content.basename.to_path
+        in [nil, IO]
+          content.to_path
+        else
+          filename
+        end
+    end
+  end
+end

data/lib/imagekitio/helpers/crypto_utils.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "digest"
+
+module Imagekitio
+  # @api private
+  # Crypto utilities for ImageKit SDK
+  # Provides HMAC-SHA1 functionality for URL signing and authentication
+  module CryptoUtils
+    class << self
+      # Creates an HMAC-SHA1 hash
+      #
+      # @param key [String] The secret key for HMAC generation
+      # @param data [String] The data to be signed
+      # @return [String] Hex-encoded HMAC-SHA1 hash
+      # @raise [StandardError] if HMAC generation fails
+      def create_hmac_sha1(key, data)
+        OpenSSL::HMAC.hexdigest("SHA1", key, data)
+      rescue StandardError => e
+        raise StandardError, "Failed to generate HMAC-SHA1 signature: #{e.message}"
+      end
+    end
+  end
+end