uploadcare-ruby 4.4.3 → 5.0.0

data/lib/uploadcare.rb

@@ -1,54 +1,88 @@
 # frozen_string_literal: true
 
-# Gem version
-require 'ruby/version'
-
-# Exceptions
-require 'exception/throttle_error'
-require 'exception/request_error'
-require 'exception/retry_error'
-require 'exception/auth_error'
-
-# Entities
-require 'entity/entity'
-require 'entity/file'
-require 'entity/file_list'
-require 'entity/group'
-require 'entity/group_list'
-require 'entity/project'
-require 'entity/uploader'
-require 'entity/webhook'
-
-# Param
-require 'param/webhook_signature_verifier'
-
-# General api
-require 'api/api'
-
-# SignedUrlGenerators
-require 'signed_url_generators/akamai_generator'
-require 'signed_url_generators/base_generator'
-
-# Ruby wrapper for Uploadcare API
-#
-# @see https://uploadcare.com/docs/api_reference
+require 'zeitwerk'
+require 'faraday'
+
 module Uploadcare
-  extend Dry::Configurable
-
-  setting :public_key,                default: ENV.fetch('UPLOADCARE_PUBLIC_KEY', '')
-  setting :secret_key,                default: ENV.fetch('UPLOADCARE_SECRET_KEY', '')
-  setting :auth_type,                 default: 'Uploadcare'
-  setting :multipart_size_threshold,  default: 100 * 1024 * 1024
-  setting :rest_api_root,             default: 'https://api.uploadcare.com'
-  setting :upload_api_root,           default: 'https://upload.uploadcare.com'
-  setting :max_request_tries,         default: 100
-  setting :base_request_sleep,        default: 1 # seconds
-  setting :max_request_sleep,         default: 60.0 # seconds
-  setting :sign_uploads,              default: false
-  setting :upload_signature_lifetime, default: 30 * 60 # seconds
-  setting :max_throttle_attempts,     default: 5
-  setting :upload_threads,            default: 2 # used for multiupload only ATM
-  setting :framework_data,            default: ''
-  setting :file_chunk_size,           default: 100
-  setting :logger,                    default: Logger.new($stdout)
+  @loader = Zeitwerk::Loader.for_gem
+
+  @loader.setup
+
+  require_relative 'uploadcare/cname_generator'
+
+  class << self
+    # Configure the global Uploadcare instance.
+    #
+    # @yield [config] Configuration block
+    # @yieldparam config [Uploadcare::Configuration] The configuration object
+    def configure
+      yield configuration if block_given?
+    ensure
+      @client = nil
+    end
+
+    # Access the global configuration.
+    #
+    # @return [Uploadcare::Configuration]
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Access a global client instance, or create one with overrides.
+    #
+    # @param config [Uploadcare::Configuration, nil] Custom configuration
+    # @param options [Hash] Configuration overrides
+    # @return [Uploadcare::Client]
+    def client(config: nil, **options)
+      if options.empty? && (config.nil? || config.equal?(configuration))
+        return (@client ||= Client.new(config: configuration))
+      end
+
+      Client.new(config: config || configuration, **options)
+    end
+
+    # @return [Uploadcare::Client::FilesAccessor]
+    def files
+      client.files
+    end
+
+    # @return [Uploadcare::Client::GroupsAccessor]
+    def groups
+      client.groups
+    end
+
+    # @return [Uploadcare::Operations::UploadRouter]
+    def uploads
+      client.uploads
+    end
+
+    # @return [Uploadcare::Client::ProjectAccessor]
+    def project
+      client.project
+    end
+
+    # Eager-load the gem namespace through Zeitwerk.
+    #
+    # @return [void]
+    def eager_load!
+      @loader.eager_load
+    end
+  end
+
+  # Top-level aliases for the public resource classes.
+  File = Resources::File
+  # Alias for the group resource.
+  Group = Resources::Group
+  # Alias for the project resource.
+  Project = Resources::Project
+  # Alias for the webhook resource.
+  Webhook = Resources::Webhook
+  # Alias for the file metadata resource.
+  FileMetadata = Resources::FileMetadata
+  # Alias for the add-on execution resource.
+  AddonExecution = Resources::AddonExecution
+  # Alias for the document conversion resource.
+  DocumentConversion = Resources::DocumentConversion
+  # Alias for the video conversion resource.
+  VideoConversion = Resources::VideoConversion
 end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "4.0.1"

data/uploadcare-ruby.gemspec

@@ -2,7 +2,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'uploadcare/ruby/version'
+require 'uploadcare/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'uploadcare-ruby'
@@ -41,12 +41,13 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib', 'lib/uploadcare', 'lib/uploadcare/rest']
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 3.0'
+  spec.required_ruby_version = '>= 3.3' # Compatible with Ruby 3.3+ and Ruby 4.0+
 
-  spec.add_dependency 'mimemagic', '~> 0.4'
-  spec.add_dependency 'parallel', '~> 1.22'
-  spec.add_dependency 'retries', '~> 0.0'
-  spec.add_dependency 'uploadcare-api_struct', '>= 1.1', '< 2'
+  spec.add_dependency 'addressable', '~> 2.8'
+  spec.add_dependency 'faraday', '~> 2.14'
+  spec.add_dependency 'faraday-multipart', '~> 1.0'
+  spec.add_dependency 'mime-types', '~> 3.7'
+  spec.add_dependency 'zeitwerk', '~> 2.7'
 end

metadata

@@ -1,78 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: uploadcare-ruby
 version: !ruby/object:Gem::Version
-  version: 4.4.3
+  version: 5.0.0
 platform: ruby
 authors:
 - "@dmitrijivanchenko (Dmitrij Ivanchenko), @T0mbery (Andrey Aksenov)"
 - kraft001 (Konstantin Rafalskii)
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mimemagic
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: parallel
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: retries
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: uploadcare-api_struct
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - "<"
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.7'
 description: Ruby API client that handles uploads and further operations with files
   by wrapping Uploadcare Upload and REST APIs.
 email:
@@ -81,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -91,8 +99,10 @@ files:
 - DEVELOPMENT.md
 - Gemfile
 - LICENSE
+- MIGRATING_V5.md
 - README.md
 - Rakefile
+- api_examples/README.md
 - api_examples/rest_api/delete_files_storage.rb
 - api_examples/rest_api/delete_files_uuid_metadata_key.rb
 - api_examples/rest_api/delete_files_uuid_storage.rb
@@ -126,6 +136,9 @@ files:
 - api_examples/rest_api/put_files_uuid_metadata_key.rb
 - api_examples/rest_api/put_files_uuid_storage.rb
 - api_examples/rest_api/put_webhooks_id.rb
+- api_examples/support/example_helper.rb
+- api_examples/support/run_rest_example.rb
+- api_examples/support/run_upload_example.rb
 - api_examples/upload_api/get_from_url_status.rb
 - api_examples/upload_api/get_group_info.rb
 - api_examples/upload_api/get_info.rb
@@ -134,62 +147,82 @@ files:
 - api_examples/upload_api/post_group.rb
 - api_examples/upload_api/post_multipart_complete.rb
 - api_examples/upload_api/post_multipart_start.rb
-- api_examples/upload_api/put_presigned_url_x.rb
+- api_examples/upload_api/put_multipart_part.rb
 - bin/console
 - bin/setup
+- context7.json
+- docs/release-notes-5.0.0.md
+- examples/README.md
+- examples/batch_upload.rb
+- examples/group_creation.rb
+- examples/large_file_upload.rb
+- examples/simple_upload.rb
+- examples/upload_with_progress.rb
+- examples/url_upload.rb
 - lib/uploadcare.rb
-- lib/uploadcare/api/api.rb
-- lib/uploadcare/client/addons_client.rb
-- lib/uploadcare/client/conversion/base_conversion_client.rb
-- lib/uploadcare/client/conversion/document_conversion_client.rb
-- lib/uploadcare/client/conversion/video_conversion_client.rb
-- lib/uploadcare/client/file_client.rb
-- lib/uploadcare/client/file_list_client.rb
-- lib/uploadcare/client/file_metadata_client.rb
-- lib/uploadcare/client/group_client.rb
-- lib/uploadcare/client/multipart_upload/chunks_client.rb
-- lib/uploadcare/client/multipart_upload_client.rb
-- lib/uploadcare/client/project_client.rb
-- lib/uploadcare/client/rest_client.rb
-- lib/uploadcare/client/rest_group_client.rb
-- lib/uploadcare/client/upload_client.rb
-- lib/uploadcare/client/uploader_client.rb
-- lib/uploadcare/client/webhook_client.rb
-- lib/uploadcare/concern/error_handler.rb
-- lib/uploadcare/concern/throttle_handler.rb
-- lib/uploadcare/concern/upload_error_handler.rb
-- lib/uploadcare/entity/addons.rb
-- lib/uploadcare/entity/conversion/base_converter.rb
-- lib/uploadcare/entity/conversion/document_converter.rb
-- lib/uploadcare/entity/conversion/video_converter.rb
-- lib/uploadcare/entity/decorator/paginator.rb
-- lib/uploadcare/entity/entity.rb
-- lib/uploadcare/entity/file.rb
-- lib/uploadcare/entity/file_list.rb
-- lib/uploadcare/entity/file_metadata.rb
-- lib/uploadcare/entity/group.rb
-- lib/uploadcare/entity/group_list.rb
-- lib/uploadcare/entity/project.rb
-- lib/uploadcare/entity/uploader.rb
-- lib/uploadcare/entity/webhook.rb
+- lib/uploadcare/api/rest.rb
+- lib/uploadcare/api/rest/addons.rb
+- lib/uploadcare/api/rest/document_conversions.rb
+- lib/uploadcare/api/rest/file_metadata.rb
+- lib/uploadcare/api/rest/files.rb
+- lib/uploadcare/api/rest/groups.rb
+- lib/uploadcare/api/rest/project.rb
+- lib/uploadcare/api/rest/video_conversions.rb
+- lib/uploadcare/api/rest/webhooks.rb
+- lib/uploadcare/api/upload.rb
+- lib/uploadcare/api/upload/files.rb
+- lib/uploadcare/api/upload/groups.rb
+- lib/uploadcare/client.rb
+- lib/uploadcare/client/addons_accessor.rb
+- lib/uploadcare/client/api.rb
+- lib/uploadcare/client/conversions_accessor.rb
+- lib/uploadcare/client/document_conversions_accessor.rb
+- lib/uploadcare/client/file_metadata_accessor.rb
+- lib/uploadcare/client/files_accessor.rb
+- lib/uploadcare/client/groups_accessor.rb
+- lib/uploadcare/client/project_accessor.rb
+- lib/uploadcare/client/video_conversions_accessor.rb
+- lib/uploadcare/client/webhooks_accessor.rb
+- lib/uploadcare/cname_generator.rb
+- lib/uploadcare/collections/batch_result.rb
+- lib/uploadcare/collections/paginated.rb
+- lib/uploadcare/configuration.rb
 - lib/uploadcare/exception/auth_error.rb
+- lib/uploadcare/exception/configuration_error.rb
 - lib/uploadcare/exception/conversion_error.rb
+- lib/uploadcare/exception/invalid_request_error.rb
+- lib/uploadcare/exception/multipart_upload_error.rb
+- lib/uploadcare/exception/not_found_error.rb
 - lib/uploadcare/exception/request_error.rb
 - lib/uploadcare/exception/retry_error.rb
 - lib/uploadcare/exception/throttle_error.rb
-- lib/uploadcare/param/authentication_header.rb
-- lib/uploadcare/param/conversion/document/processing_job_url_builder.rb
-- lib/uploadcare/param/conversion/video/processing_job_url_builder.rb
-- lib/uploadcare/param/param.rb
-- lib/uploadcare/param/secure_auth_header.rb
-- lib/uploadcare/param/simple_auth_header.rb
-- lib/uploadcare/param/upload/signature_generator.rb
-- lib/uploadcare/param/upload/upload_params_generator.rb
-- lib/uploadcare/param/user_agent.rb
-- lib/uploadcare/param/webhook_signature_verifier.rb
-- lib/uploadcare/ruby/version.rb
+- lib/uploadcare/exception/unknown_status_error.rb
+- lib/uploadcare/exception/upload_error.rb
+- lib/uploadcare/exception/upload_timeout_error.rb
+- lib/uploadcare/internal/authenticator.rb
+- lib/uploadcare/internal/error_handler.rb
+- lib/uploadcare/internal/signature_generator.rb
+- lib/uploadcare/internal/throttle_handler.rb
+- lib/uploadcare/internal/upload_io.rb
+- lib/uploadcare/internal/upload_params_generator.rb
+- lib/uploadcare/internal/user_agent.rb
+- lib/uploadcare/operations/multipart_upload.rb
+- lib/uploadcare/operations/upload_router.rb
+- lib/uploadcare/resources/addon_execution.rb
+- lib/uploadcare/resources/base_resource.rb
+- lib/uploadcare/resources/document_conversion.rb
+- lib/uploadcare/resources/file.rb
+- lib/uploadcare/resources/file_metadata.rb
+- lib/uploadcare/resources/group.rb
+- lib/uploadcare/resources/project.rb
+- lib/uploadcare/resources/video_conversion.rb
+- lib/uploadcare/resources/webhook.rb
+- lib/uploadcare/result.rb
 - lib/uploadcare/signed_url_generators/akamai_generator.rb
 - lib/uploadcare/signed_url_generators/base_generator.rb
+- lib/uploadcare/version.rb
+- lib/uploadcare/webhook_signature_verifier.rb
+- mise.toml
 - uploadcare-ruby.gemspec
 homepage: https://uploadcare.com/
 licenses:
@@ -202,25 +235,21 @@ metadata:
   bug_tracker_uri: https://github.com/uploadcare/uploadcare-ruby/issues
   documentation_uri: https://www.rubydoc.info/gems/uploadcare-ruby/
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
-- lib/uploadcare
-- lib/uploadcare/rest
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby wrapper for uploadcare API
 test_files: []

data/api_examples/upload_api/put_presigned_url_x.rb

@@ -1,8 +0,0 @@
-# Uploadcare lib provides high level API for multipart uploads that does everything for you
-
-require 'uploadcare'
-Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
-Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
-
-source_file = File.open('image.png')
-Uploadcare::Uploader.upload(source_file, store: 'auto')

data/lib/uploadcare/api/api.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-Gem.find_files('client/**/*.rb').each { |path| require path }
-Gem.find_files('entity/**/*.rb').each { |path| require path }
-
-module Uploadcare
-  # End-user interface
-  #
-  # It delegates methods to other classes:
-  # * To class methods of Entity objects
-  # * To instance methods of Client objects
-  # @see Uploadcare::Entity
-  # @see Uploadcare::Client
-  class Api
-    extend Forwardable
-    include Entity
-
-    def_delegator File, :file
-    def_delegators FileList, :file_list, :store_files, :delete_files
-    def_delegators Group, :group
-    def_delegators Project, :project
-    def_delegators Uploader, :upload, :upload_files, :upload_url
-    def_delegators Webhook, :create_webhook, :list_webhooks, :delete_webhook, :update_webhook
-  end
-end

data/lib/uploadcare/client/addons_client.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'rest_client'
-
-module Uploadcare
-  module Client
-    # API client for handling uploaded files
-    # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Add-Ons
-    class AddonsClient < RestClient
-      # Execute ClamAV virus checking Add-On for a given target.
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/ucClamavVirusScanExecute
-      def uc_clamav_virus_scan(uuid, params = {})
-        content = { target: uuid, params: params }.to_json
-        post(uri: '/addons/uc_clamav_virus_scan/execute/', content: content)
-      end
-
-      # Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/ucClamavVirusScanExecutionStatus
-      def uc_clamav_virus_scan_status(uuid)
-        get(uri: "/addons/uc_clamav_virus_scan/execute/status/#{query_params(uuid)}")
-      end
-
-      # Execute AWS Rekognition Add-On for a given target to detect labels in an image.
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/awsRekognitionExecute
-      def ws_rekognition_detect_labels(uuid)
-        content = { target: uuid }.to_json
-        post(uri: '/addons/aws_rekognition_detect_labels/execute/', content: content)
-      end
-
-      # Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/awsRekognitionExecutionStatus
-      def ws_rekognition_detect_labels_status(uuid)
-        get(uri: "/addons/aws_rekognition_detect_labels/execute/status/#{query_params(uuid)}")
-      end
-
-      # Execute remove.bg background image removal Add-On for a given target.
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/removeBgExecute
-      def remove_bg(uuid, params = {})
-        content = { target: uuid, params: params }.to_json
-        post(uri: '/addons/remove_bg/execute/', content: content)
-      end
-
-      # Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/removeBgExecutionStatus
-      def remove_bg_status(uuid)
-        get(uri: "/addons/remove_bg/execute/status/#{query_params(uuid)}")
-      end
-
-      # Execute AWS Rekognition Moderation Add-On for a given target to detect labels in an image.
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Add-Ons/operation/awsRekognitionDetectModerationLabelsExecute
-      def ws_rekognition_detect_moderation_labels(uuid)
-        content = { target: uuid }.to_json
-        post(uri: '/addons/aws_rekognition_detect_moderation_labels/execute/', content: content)
-      end
-
-      # Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Add-Ons/operation/awsRekognitionDetectModerationLabelsExecutionStatus
-      def ws_rekognition_detect_moderation_labels_status(uuid)
-        get(uri: "/addons/aws_rekognition_detect_moderation_labels/execute/status/#{query_params(uuid)}")
-      end
-
-      private
-
-      def query_params(uuid)
-        "?#{URI.encode_www_form(request_id: uuid)}"
-      end
-    end
-  end
-end

data/lib/uploadcare/client/conversion/base_conversion_client.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../rest_client'
-require 'exception/conversion_error'
-
-module Uploadcare
-  module Client
-    module Conversion
-      # This is a base client for conversion operations
-      #
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Conversion
-      class BaseConversionClient < RestClient
-        API_VERSION_HEADER_VALUE = 'application/vnd.uploadcare-v0.7+json'
-
-        def headers
-          {
-            'Content-Type': 'application/json',
-            Accept: API_VERSION_HEADER_VALUE,
-            'User-Agent': Uploadcare::Param::UserAgent.call
-          }
-        end
-
-        private
-
-        def send_convert_request(arr, options, url_builder_class)
-          body = build_body_for_many(arr, options, url_builder_class)
-          post(uri: convert_uri, content: body)
-        end
-
-        def success(response)
-          body = response.body.to_s
-          extract_result(body)
-        end
-
-        def extract_result(response_body)
-          return if response_body.empty?
-
-          parsed_body = JSON.parse(response_body, symbolize_names: true)
-          errors = parsed_body[:error] || parsed_body[:problems]
-          return Dry::Monads::Result::Failure.call(errors) unless errors.nil? || errors.empty?
-
-          Dry::Monads::Result::Success.call(parsed_body)
-        end
-
-        # Prepares body for convert_many method
-        def build_body_for_many(arr, options, url_builder_class)
-          {
-            paths: arr.map do |params|
-              url_builder_class.call(
-                **build_paths_body(params)
-              )
-            end,
-            store: options[:store],
-            save_in_group: options[:save_in_group]
-          }.compact.to_json
-        end
-      end
-    end
-  end
-end