uploadcare-ruby 4.4.3 → 5.0.0.rc1

data/lib/uploadcare/client/uploader_client.rb

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'upload_client'
-require 'retries'
-require 'param/upload/upload_params_generator'
-require 'param/upload/signature_generator'
-
-module Uploadcare
-  module Client
-    # This is client for general uploads
-    #
-    # @see https://uploadcare.com/api-refs/upload-api/#tag/Upload
-    class UploaderClient < UploadClient
-      # @see https://uploadcare.com/api-refs/upload-api/#operation/baseUpload
-
-      def upload_many(arr, options = {})
-        body = upload_many_body(arr, options)
-        post(path: 'base/',
-             headers: { 'Content-Type': body.content_type },
-             body: body)
-      end
-
-      # syntactic sugar for upload_many
-      # There is actual upload method for one file, but it is redundant
-
-      def upload(file, options = {})
-        upload_many([file], options)
-      end
-
-      # Upload files from url
-      # @see https://uploadcare.com/api-refs/upload-api/#operation/fromURLUpload
-      # options:
-      # - check_URL_duplicates
-      # - filename
-      # - save_URL_duplicates
-      # - async - returns upload token instead of upload data
-      # - metadata - file metadata, hash
-      def upload_from_url(url, options = {})
-        body = upload_from_url_body(url, options)
-        token_response = post(path: 'from_url/', headers: { 'Content-Type': body.content_type }, body: body)
-        return token_response if options[:async]
-
-        uploaded_response = poll_upload_response(token_response.success[:token])
-        return uploaded_response if uploaded_response.success[:status] == 'error'
-
-        Dry::Monads::Result::Success.call(files: [uploaded_response.success])
-      end
-
-      # Check upload status
-      #
-      # @see https://uploadcare.com/api-refs/upload-api/#operation/fromURLUploadStatus
-      def get_upload_from_url_status(token)
-        query_params = { token: token }
-        get(path: 'from_url/status/', params: query_params)
-      end
-
-      # Get information about an uploaded file
-      # Secret key not needed
-      #
-      # https://uploadcare.com/api-refs/upload-api/#tag/Upload/operation/fileUploadInfo
-      def file_info(uuid)
-        query_params = {
-          file_id: uuid,
-          pub_key: Uploadcare.config.public_key
-        }
-        get(path: 'info/', params: query_params)
-      end
-
-      private
-
-      alias api_struct_post post
-      def post(args = {})
-        handle_throttling { api_struct_post(**args) }
-      end
-
-      def poll_upload_response(token)
-        with_retries(max_tries: Uploadcare.config.max_request_tries,
-                     base_sleep_seconds: Uploadcare.config.base_request_sleep,
-                     max_sleep_seconds: Uploadcare.config.max_request_sleep,
-                     rescue: RetryError) do
-          response = get_upload_from_url_status(token)
-          handle_polling_response(response)
-        end
-      end
-
-      def handle_polling_response(response)
-        case response.success[:status]
-        when 'error'
-          raise RequestError, response.success[:error]
-        when 'progress', 'waiting', 'unknown'
-          raise RetryError, response.success[:error] || 'Upload is taking longer than expected. Try increasing the max_request_tries config if you know your file uploads will take more time.' # rubocop:disable Layout/LineLength
-        end
-
-        response
-      end
-
-      # Prepares body for upload_many method
-      def upload_many_body(arr, options = {})
-        files_formdata = arr.to_h do |file|
-          [HTTP::FormData::File.new(file).filename,
-           form_data_for(file)]
-        end
-        HTTP::FormData::Multipart.new(
-          Param::Upload::UploadParamsGenerator.call(options).merge(files_formdata)
-        )
-      end
-
-      # Prepare upload_from_url initial request body
-      def upload_from_url_body(url, options = {})
-        opts = {
-          'pub_key' => Uploadcare.config.public_key,
-          'source_url' => url,
-          'store' => store_value(options[:store])
-        }
-        opts.merge!(Param::Upload::SignatureGenerator.call) if Uploadcare.config.sign_uploads
-        HTTP::FormData::Multipart.new(options.merge(opts))
-      end
-
-      def store_value(store)
-        case store
-        when true, '1', 1 then '1'
-        when false, '0', 0 then '0'
-        else 'auto'
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/client/webhook_client.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'rest_client'
-
-module Uploadcare
-  module Client
-    # client for webhook management
-    # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Webhook
-    class WebhookClient < RestClient
-      # Create webhook
-      # @see https://uploadcare.com/docs/api_reference/rest/webhooks/#subscribe
-      def create(options = {})
-        body = {
-          target_url: options[:target_url],
-          event: options[:event] || 'file.uploaded',
-          is_active: options[:is_active].nil? ? true : options[:is_active]
-        }.merge(
-          { signing_secret: options[:signing_secret] }.compact
-        ).to_json
-        post(uri: '/webhooks/', content: body)
-      end
-
-      # Returns array (not paginated list) of webhooks
-      # @see https://uploadcare.com/docs/api_reference/rest/webhooks/#get-list
-      def list
-        get(uri: '/webhooks/')
-      end
-
-      # Permanently deletes subscription
-      # @see https://uploadcare.com/docs/api_reference/rest/webhooks/#unsubscribe
-      def delete(target_url)
-        body = { target_url: target_url }.to_json
-        request(method: 'DELETE', uri: '/webhooks/unsubscribe/', content: body)
-      end
-
-      # Updates webhook
-      # @see https://uploadcare.com/docs/api_reference/rest/webhooks/#subscribe-update
-      def update(id, options = {})
-        body = options.to_json
-        put(uri: "/webhooks/#{id}/", content: body)
-      end
-
-      alias create_webhook create
-      alias list_webhooks list
-      alias delete_webhook delete
-      alias update_webhook update
-    end
-  end
-end

data/lib/uploadcare/concern/error_handler.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Concerns
-    # Wrapper for responses
-    # raises errors instead of returning monads
-    module ErrorHandler
-      include Exception
-
-      # Extension of ApiStruct's failure method
-      #
-      # Raises errors instead of returning falsey objects
-      # @see https://github.com/rubygarage/api_struct/blob/master/lib/api_struct/client.rb#L55
-      def failure(response)
-        catch_upload_errors(response)
-        parsed_response = JSON.parse(response.body.to_s)
-        raise RequestError, parsed_response['detail'] || parsed_response.map { |k, v| "#{k}: #{v}" }.join('; ')
-      rescue JSON::ParserError
-        raise RequestError, response.body.to_s
-      end
-
-      # Extension of ApiStruct's wrap method
-      #
-      # Catches throttling errors and Upload API errors
-      #
-      # @see https://github.com/rubygarage/api_struct/blob/master/lib/api_struct/client.rb#L45
-      def wrap(response)
-        raise_throttling_error(response) if response.status == 429
-        return failure(response) if response.status >= 300
-
-        catch_upload_errors(response)
-        success(response)
-      end
-
-      private
-
-      # Raise ThrottleError. Also, tells in error when server will be ready for next request
-      def raise_throttling_error(response)
-        retry_after = (response.headers['Retry-After'].to_i + 1) || 11
-        raise ThrottleError.new(retry_after), "Response throttled, retry #{retry_after} seconds later"
-      end
-
-      # Upload API returns its errors with code 200, and stores its actual code and details within response message
-      # This methods detects that and raises apropriate error
-      def catch_upload_errors(response)
-        return unless response.code == 200
-
-        parsed_response = JSON.parse(response.body.to_s)
-        error = parsed_response['error'] if parsed_response.is_a?(Hash)
-        raise RequestError, error if error
-      end
-    end
-  end
-end

data/lib/uploadcare/concern/throttle_handler.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Concerns
-    # This module lets clients send request multiple times if request is throttled
-    module ThrottleHandler
-      # call given block. If ThrottleError is returned, it will wait and attempt again 4 more times
-      # @yield executable block (HTTP request that may be throttled)
-      def handle_throttling
-        (Uploadcare.config.max_throttle_attempts - 1).times do
-          # rubocop:disable Style/RedundantBegin
-          begin
-            return yield
-          rescue(Exception::ThrottleError) => e
-            wait_time = e.timeout
-            sleep(wait_time)
-            next
-          end
-          # rubocop:enable Style/RedundantBegin
-        end
-        yield
-      end
-    end
-  end
-end

data/lib/uploadcare/concern/upload_error_handler.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Concerns
-    # Wrapper for responses
-    # raises errors instead of returning monads
-    module UploadErrorHandler
-      include Exception
-
-      # Extension of ApiStruct's failure method
-      #
-      # Raises errors instead of returning falsey objects
-      # @see https://github.com/rubygarage/api_struct/blob/master/lib/api_struct/client.rb#L55
-      def failure(response)
-        catch_throttling_error(response)
-        parsed_response = JSON.parse(response.body.to_s)
-        raise RequestError, parsed_response['detail']
-      rescue JSON::ParserError
-        raise RequestError, response.status
-      end
-
-      private
-
-      def catch_throttling_error(response)
-        return unless response.code == 429
-
-        retry_after = (response.headers['Retry-After'].to_i + 1) || 11
-        raise ThrottleError.new(retry_after), "Response throttled, retry #{retry_after} seconds later"
-      end
-    end
-  end
-end

data/lib/uploadcare/entity/addons.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Entity
-    # This serializer is responsible for addons handling
-    #
-    # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Add-Ons
-    class Addons < Entity
-      client_service AddonsClient
-
-      attr_entity :request_id, :status, :result
-    end
-  end
-end

data/lib/uploadcare/entity/conversion/base_converter.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Entity
-    module Conversion
-      # This serializer lets a user convert uploaded documents
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/documentConvert
-      class BaseConverter < Entity
-        class << self
-          # Converts files
-          #
-          # @param params [Array] of hashes with params or [Hash]
-          # @option options [Boolean] :store whether to store file on servers.
-          def convert(params, options = {})
-            files_params = params.is_a?(Hash) ? [params] : params
-            conversion_client.new.convert_many(files_params, options)
-          end
-
-          # Returns a status of a conversion job
-          #
-          # @param token [Integer, String] token obtained from a server in convert method
-          def status(token)
-            conversion_client.new.get_conversion_status(token)
-          end
-
-          # Returns the document format and possible conversion formats.
-          #
-          # @param uuid [String] UUID of the document
-          def info(uuid)
-            conversion_client.new.document_info(uuid)
-          end
-
-          private
-
-          def conversion_client
-            clients[:base]
-          end
-        end
-      end
-    end
-  end
-  include Conversion
-end

data/lib/uploadcare/entity/conversion/document_converter.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_converter'
-
-module Uploadcare
-  module Entity
-    module Conversion
-      # This serializer lets a user convert uploaded documents
-      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/documentConvert
-      class DocumentConverter < BaseConverter
-        client_service Client::Conversion::DocumentConversionClient
-      end
-    end
-  end
-end

data/lib/uploadcare/entity/conversion/video_converter.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_converter'
-
-module Uploadcare
-  module Entity
-    module Conversion
-      # This serializer lets a user convert uploaded videos, and usually returns an array of results
-      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/videoConvert
-      class VideoConverter < BaseConverter
-        client_service Client::Conversion::VideoConversionClient
-      end
-    end
-  end
-end

data/lib/uploadcare/entity/decorator/paginator.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Entity
-    # @abstract
-    module Decorator
-      # provides pagination methods for things in Uploadcare that paginate,
-      # namely [FileList] and [Group]
-      #
-      # Requirements:
-      # - Should be Entity with Client
-      # - Associated Client should have `list` method that returns objects with pagination
-      # - Response should have :next, :previous, :total, :per_page params and :results fields
-      module Paginator
-        @entity ||= Hashie::Mash.new
-
-        # meta data of a pagination object
-        def meta
-          Hashie::Mash.new(next: @entity[:next], previous: @entity[:previous],
-                           total: @entity[:total], per_page: @entity[:per_page])
-        end
-
-        # Returns new instance of current object on next page
-        def next_page
-          url = @entity[:next]
-          return unless url
-
-          query = URI.decode_www_form(URI(url).query).to_h
-          query = query.to_h { |k, v| [k.to_sym, v] }
-          self.class.list(**query)
-        end
-
-        # Returns new instance of current object on previous page
-        def previous_page
-          url = @entity[:previous]
-          return unless url
-
-          query = URI.decode_www_form(URI(url).query).to_h
-          query = query.to_h { |k, v| [k.to_sym, v] }
-          self.class.list(**query)
-        end
-
-        # Attempts to load the entire list after offset into results of current object
-        #
-        # It's possible to avoid loading objects on previous pages by offsetting them first
-        def load
-          return self if @entity[:next].nil? || @entity[:results].length == @entity[:total]
-
-          np = self
-          until np.next.nil?
-            np = np.next_page
-            @entity[:results].concat(np.results.map(&:to_h))
-          end
-          @entity[:next] = nil
-          @entity[:per_page] = @entity[:total]
-          self
-        end
-
-        # iterate through pages, starting with current one
-        #
-        # @yield [Block]
-        def each(&block)
-          current_page = self
-          while current_page
-            current_page.results.each(&block)
-            current_page = current_page.next_page
-          end
-        end
-
-        # Load and return all objects in list
-        #
-        # @return [Array]
-        def all
-          load[:results]
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/entity/entity.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-Gem.find_files('client/**/*.rb').each { |path| require path }
-
-module Uploadcare
-  # Entities represent objects existing in Uploadcare cloud
-  #
-  # Typically, Entities inherit class methods from {Client} instance methods
-  # @see Client
-  module Entity
-    # @abstract
-    class Entity < ApiStruct::Entity
-      include Client
-    end
-  end
-
-  include Entity
-end

data/lib/uploadcare/entity/file.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Entity
-    # This serializer returns a single file
-    #
-    # @see https://uploadcare.com/docs/api_reference/rest/handling_projects/
-    class File < Entity
-      RESPONSE_PARAMS = %i[
-        datetime_removed datetime_stored datetime_uploaded is_image is_ready mime_type original_file_url
-        original_filename size url uuid variations content_info metadata appdata source
-      ].freeze
-
-      client_service FileClient
-
-      attr_entity(*RESPONSE_PARAMS)
-
-      def datetime_stored
-        Uploadcare.config.logger&.warn 'datetime_stored property has been deprecated, and will be removed without a replacement in future.' # rubocop:disable Layout/LineLength
-        @entity.datetime_stored
-      end
-
-      # gets file's uuid - even if it's only initialized with url
-      # @returns [String]
-      def uuid
-        return @entity.uuid if @entity.uuid
-
-        uuid = @entity.url.gsub('https://ucarecdn.com/', '')
-        uuid.gsub(%r{/.*}, '')
-      end
-
-      # loads file metadata, if it's initialized with url or uuid
-      def load
-        initialize(File.info(uuid).entity)
-      end
-
-      # The method to convert a document file to another file
-      # gets (conversion) params [Hash], options (store: Boolean) [Hash], converter [Class]
-      # @returns [File]
-      def convert_document(params = {}, options = {}, converter = Conversion::DocumentConverter)
-        convert_file(params, converter, options)
-      end
-
-      # The method to convert a video file to another file
-      # gets (conversion) params [Hash], options (store: Boolean) [Hash], converter [Class]
-      # @returns [File]
-      def convert_video(params = {}, options = {}, converter = Conversion::VideoConverter)
-        convert_file(params, converter, options)
-      end
-
-      # Copies file to current project
-      #
-      # source can be UID or full CDN link
-      #
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File/operation/createLocalCopy
-      def self.local_copy(source, args = {})
-        response = FileClient.new.local_copy(source: source, **args).success[:result]
-        File.new(response)
-      end
-
-      # copy file to different project
-      #
-      # source can be UID or full CDN link
-      #
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File/operation/createRemoteCopy
-      def self.remote_copy(source, target, args = {})
-        FileClient.new.remote_copy(source: source, target: target, **args).success[:result]
-      end
-
-      # Instance version of {internal_copy}
-      def local_copy(args = {})
-        File.local_copy(uuid, **args)
-      end
-
-      # Instance version of {external_copy}
-      def remote_copy(target, args = {})
-        File.remote_copy(uuid, target, **args)
-      end
-
-      # Store a single file, preventing it from being deleted in 2 weeks
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/storeFile
-      def store
-        File.store(uuid)
-      end
-
-      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/deleteFileStorage
-      def delete
-        File.delete(uuid)
-      end
-
-      private
-
-      def convert_file(params, converter, options = {})
-        raise Uploadcare::Exception::ConversionError, 'The first argument must be a Hash' unless params.is_a?(Hash)
-
-        params_with_symbolized_keys = params.to_h { |k, v| [k.to_sym, v] }
-        params_with_symbolized_keys[:uuid] = uuid
-        result = converter.convert(params_with_symbolized_keys, options)
-        result.success? ? File.info(result.value![:result].first[:uuid]) : result
-      end
-    end
-  end
-end

data/lib/uploadcare/entity/file_list.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'uploadcare/entity/file'
-require 'uploadcare/entity/decorator/paginator'
-require 'dry/monads'
-require 'api_struct'
-
-module Uploadcare
-  module Entity
-    # This serializer returns lists of files
-    #
-    # This is a paginated list, so all pagination methods apply
-    # @see Uploadcare::Entity::Decorator::Paginator
-    class FileList < ApiStruct::Entity
-      include Uploadcare::Entity::Decorator::Paginator
-      client_service Client::FileListClient
-
-      attr_entity :next, :previous, :total, :per_page
-
-      has_entities :results, as: Uploadcare::Entity::File
-      has_entities :result, as: Uploadcare::Entity::File
-
-      # alias for result/results, depending on which API this FileList was initialized from
-      # @return [Array] of [Uploadcare::Entity::File]
-      def files
-        results
-      rescue ApiStruct::EntityError
-        result
-      end
-    end
-  end
-end

data/lib/uploadcare/entity/file_metadata.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Entity
-    # This serializer is responsible for file metadata handling
-    #
-    # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata
-    class FileMetadata < Entity
-      client_service FileMetadataClient
-
-      class << self
-        def index(uuid)
-          ::Uploadcare::Client::FileMetadataClient.new.index(uuid).success
-        end
-
-        def show(uuid, key)
-          ::Uploadcare::Client::FileMetadataClient.new.show(uuid, key).success
-        end
-
-        def update(uuid, key, value)
-          ::Uploadcare::Client::FileMetadataClient.new.update(uuid, key, value).success
-        end
-
-        def delete(uuid, key)
-          ::Uploadcare::Client::FileMetadataClient.new.delete(uuid, key).success || '200 OK'
-        end
-      end
-    end
-  end
-end