uploadcare-ruby 4.4.2 → 5.0.0.rc1

data/lib/uploadcare/entity/uploader.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Entity
-    # This serializer lets user upload files by various means, and usually returns an array of files
-    # @see https://uploadcare.com/api-refs/upload-api/#tag/Upload
-    class Uploader < Entity
-      client_service UploaderClient
-      client_service MultipartUploaderClient, only: :upload, prefix: :multipart
-
-      attr_entity :files
-      has_entities :files, as: Uploadcare::Entity::File
-
-      # Upload file or group of files from array, File, or url
-      #
-      # @param object [Array], [String] or [File]
-      # @param [Hash] options options for upload
-      # @option options [Boolean] :store whether to store file on servers.
-      def self.upload(object, options = {})
-        if big_file?(object)
-          multipart_upload(object, options)
-        elsif file?(object)
-          upload_file(object, options)
-        elsif object.is_a?(Array)
-          upload_files(object, options)
-        elsif object.is_a?(String)
-          upload_from_url(object, options)
-        else
-          raise ArgumentError, "Expected input to be a file/Array/URL, given: `#{object}`"
-        end
-      end
-
-      # upload single file
-      def self.upload_file(file, options = {})
-        response = UploaderClient.new.upload_many([file], options)
-        uuid = response.success.values.first
-        if Uploadcare.config.secret_key.nil?
-          Uploadcare::Entity::File.new(file_info(uuid).success)
-        else
-          # we can get more info about the uploaded file
-          Uploadcare::Entity::File.info(uuid)
-        end
-      end
-
-      # upload multiple files
-      def self.upload_files(arr, options = {})
-        response = UploaderClient.new.upload_many(arr, options)
-        response.success.map { |pair| Uploadcare::Entity::File.new(uuid: pair[1], original_filename: pair[0]) }
-      end
-
-      # upload file of size above 10mb (involves multipart upload)
-      def self.multipart_upload(file, options = {}, &block)
-        response = MultipartUploaderClient.new.upload(file, options, &block)
-        Uploadcare::Entity::File.new(response.success)
-      end
-
-      # upload files from url
-      # @param url [String]
-      def self.upload_from_url(url, options = {})
-        response = UploaderClient.new.upload_from_url(url, options)
-        return response.success[:token] unless response.success[:files]
-
-        response.success[:files].map { |file_data| Uploadcare::Entity::File.new(file_data) }
-      end
-
-      # gets a status of upload from url
-      # @param url [String]
-      def self.get_upload_from_url_status(token)
-        UploaderClient.new.get_upload_from_url_status(token)
-      end
-
-      # Get information about an uploaded file (without the secret key)
-      # @param uuid [String]
-      def self.file_info(uuid)
-        UploaderClient.new.file_info(uuid)
-      end
-
-      class << self
-        private
-
-        # check if object is a file
-        def file?(object)
-          object.respond_to?(:path) && ::File.exist?(object.path)
-        end
-
-        # check if object needs to be uploaded using multipart upload
-        def big_file?(object)
-          file?(object) && object.size >= Uploadcare.config.multipart_size_threshold
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/entity/webhook.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Entity
-    # This serializer is responsible for webhook handling
-    #
-    # @see https://uploadcare.com/docs/api_reference/rest/webhooks/
-    class Webhook < Entity
-      client_service WebhookClient
-
-      attr_entity :id, :created, :updated, :event, :target_url, :project, :is_active
-    end
-  end
-end

data/lib/uploadcare/param/authentication_header.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest/md5'
-require 'param/secure_auth_header'
-require 'param/simple_auth_header'
-
-module Uploadcare
-  module Param
-    # This object returns headers needed for authentication
-    # This authentication method is more secure, but more tedious
-    class AuthenticationHeader
-      # @see https://uploadcare.com/docs/api_reference/rest/requests_auth/#auth-uploadcare
-      def self.call(options = {})
-        validate_auth_config
-        case Uploadcare.config.auth_type
-        when 'Uploadcare'
-          SecureAuthHeader.call(options)
-        when 'Uploadcare.Simple'
-          SimpleAuthHeader.call
-        else
-          raise ArgumentError, "Unknown auth_scheme: '#{Uploadcare.config.auth_type}'"
-        end
-      end
-
-      def self.validate_auth_config
-        raise Uploadcare::Exception::AuthError, 'Public Key is blank.' if is_blank?(Uploadcare.config.public_key)
-        raise Uploadcare::Exception::AuthError, 'Secret Key is blank.' if is_blank?(Uploadcare.config.secret_key)
-      end
-
-      # rubocop:disable Naming/PredicateName
-      def self.is_blank?(value)
-        value.nil? || value.empty?
-      end
-      # rubocop:enable Naming/PredicateName
-    end
-  end
-end

data/lib/uploadcare/param/conversion/document/processing_job_url_builder.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Param
-    module Conversion
-      module Document
-        class ProcessingJobUrlBuilder
-          class << self
-            def call(uuid:, format: nil, page: nil)
-              [
-                uuid_part(uuid),
-                format_part(format),
-                page_part(page)
-              ].compact.join('-')
-            end
-
-            private
-
-            def uuid_part(uuid)
-              "#{uuid}/document/"
-            end
-
-            def format_part(format)
-              return if format.nil?
-
-              "/format/#{format}/"
-            end
-
-            def page_part(page)
-              return if page.nil?
-
-              "/page/#{page}/"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/param/conversion/video/processing_job_url_builder.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Param
-    module Conversion
-      module Video
-        class ProcessingJobUrlBuilder
-          class << self
-            # rubocop:disable Metrics/ParameterLists
-            def call(uuid:, size: {}, quality: nil, format: nil, cut: {}, thumbs: {})
-              [
-                uuid_part(uuid),
-                size_part(size),
-                quality_part(quality),
-                format_part(format),
-                cut_part(cut),
-                thumbs_part(thumbs)
-              ].compact.join('-')
-            end
-            # rubocop:enable Metrics/ParameterLists
-
-            private
-
-            def uuid_part(uuid)
-              "#{uuid}/video/"
-            end
-
-            def size_part(size)
-              return if size.empty?
-
-              dimensions = "#{size[:width]}x#{size[:height]}" if size[:width] || size[:height]
-              resize_mode = (size[:resize_mode]).to_s
-              "/size/#{dimensions}/#{resize_mode}/".squeeze('/')
-            end
-
-            def quality_part(quality)
-              return if quality.nil?
-
-              "/quality/#{quality}/"
-            end
-
-            def format_part(format)
-              return if format.nil?
-
-              "/format/#{format}/"
-            end
-
-            def cut_part(cut)
-              return if cut.empty?
-
-              "/cut/#{cut[:start_time]}/#{cut[:length]}/"
-            end
-
-            def thumbs_part(thumbs)
-              return if thumbs.empty?
-
-              "/thumbs~#{thumbs[:N]}/#{thumbs[:number]}/".squeeze('/')
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/param/param.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  # @abstract
-  # This module is responsible for everything related to generation of request params -
-  # such as authentication headers, signatures and serialized uploads
-  module Param
-  end
-  include Param
-end

data/lib/uploadcare/param/secure_auth_header.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest/md5'
-require 'addressable/uri'
-
-module Uploadcare
-  module Param
-    # This object returns headers needed for authentication
-    # This authentication method is more secure, but more tedious
-    class SecureAuthHeader
-      class << self
-        # @see https://uploadcare.com/docs/api_reference/rest/requests_auth/#auth-uploadcare
-        def call(options = {})
-          @method = options[:method]
-          @body = options[:content] || ''
-          @content_type = options[:content_type]
-          @uri = make_uri(options)
-
-          @date_for_header = timestamp
-          {
-            Date: @date_for_header,
-            Authorization: "Uploadcare #{Uploadcare.config.public_key}:#{signature}"
-          }
-        end
-
-        def signature
-          content_md5 = Digest::MD5.hexdigest(@body)
-          sign_string = [@method, content_md5, @content_type, @date_for_header, @uri].join("\n")
-          digest = OpenSSL::Digest.new('sha1')
-          OpenSSL::HMAC.hexdigest(digest, Uploadcare.config.secret_key, sign_string)
-        end
-
-        def timestamp
-          Time.now.gmtime.strftime('%a, %d %b %Y %H:%M:%S GMT')
-        end
-
-        private
-
-        def make_uri(options)
-          if options[:params] && !options[:params].empty?
-            uri = Addressable::URI.parse options[:uri]
-            uri.query_values = uri.query_values(Array).to_a.concat(options[:params].to_a)
-            uri.to_s
-          else
-            options[:uri]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/param/simple_auth_header.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  module Param
-    # This object returns simple header for authentication
-    # Simple header is relatively unsafe, but can be useful for debug and development
-    class SimpleAuthHeader
-      # @see https://uploadcare.com/docs/api_reference/rest/requests_auth/#auth-simple
-      def self.call
-        { Authorization: "Uploadcare.Simple #{Uploadcare.config.public_key}:#{Uploadcare.config.secret_key}" }
-      end
-    end
-  end
-end

data/lib/uploadcare/param/upload/signature_generator.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-module Uploadcare
-  module Param
-    module Upload
-      # This class generates signatures for protected uploads
-      class SignatureGenerator
-        # @see https://uploadcare.com/docs/api_reference/upload/signed_uploads/
-        # @return [Hash] signature and its expiration time
-        def self.call
-          expires_at = Time.now.to_i + Uploadcare.config.upload_signature_lifetime
-          to_sign = Uploadcare.config.secret_key + expires_at.to_s
-          signature = Digest::MD5.hexdigest(to_sign)
-          {
-            signature: signature,
-            expire: expires_at
-          }
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/param/upload/upload_params_generator.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest'
-
-module Uploadcare
-  module Param
-    module Upload
-      # This class generates body params for uploads
-      class UploadParamsGenerator
-        # @see https://uploadcare.com/docs/api_reference/upload/request_based/
-        class << self
-          def call(options = {})
-            {
-              'UPLOADCARE_PUB_KEY' => Uploadcare.config.public_key,
-              'UPLOADCARE_STORE' => store_value(options[:store]),
-              'signature' => (Upload::SignatureGenerator.call if Uploadcare.config.sign_uploads)
-            }.merge(metadata(options)).compact
-          end
-
-          private
-
-          def store_value(store)
-            case store
-            when true, '1', 1 then '1'
-            when false, '0', 0 then '0'
-            else 'auto'
-            end
-          end
-
-          def metadata(options = {})
-            return {} if options[:metadata].nil?
-
-            options[:metadata].each_with_object({}) do |(k, v), res|
-              res.merge!("metadata[#{k}]" => v)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/param/user_agent.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'uploadcare'
-
-module Uploadcare
-  module Param
-    # This header is added to track libraries using Uploadcare API
-    class UserAgent
-      # Generate header from Gem's config
-      #
-      # @example Uploadcare::Param::UserAgent.call
-      #   UploadcareRuby/3.0.0-dev/Pubkey_(Ruby/2.6.3;UploadcareRuby)
-      def self.call
-        framework_data = Uploadcare.config.framework_data || ''
-        framework_data_string = "; #{Uploadcare.config.framework_data}" unless framework_data.empty?
-        public_key = Uploadcare.config.public_key
-        "UploadcareRuby/#{VERSION}/#{public_key} (Ruby/#{RUBY_VERSION}#{framework_data_string})"
-      end
-    end
-  end
-end

data/lib/uploadcare/param/webhook_signature_verifier.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest/md5'
-
-module Uploadcare
-  module Param
-    # This object verifies a signature received along with webhook headers
-    class WebhookSignatureVerifier
-      # @see https://uploadcare.com/docs/security/secure-webhooks/
-      def self.valid?(options = {})
-        webhook_body_json = options[:webhook_body]
-        signing_secret = options[:signing_secret] || ENV.fetch('UC_SIGNING_SECRET', nil)
-        x_uc_signature_header = options[:x_uc_signature_header]
-
-        digest = OpenSSL::Digest.new('sha256')
-
-        calculated_signature = "v1=#{OpenSSL::HMAC.hexdigest(digest, signing_secret, webhook_body_json)}"
-
-        calculated_signature == x_uc_signature_header
-      end
-    end
-  end
-end

data/lib/uploadcare/ruby/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Uploadcare
-  VERSION = '4.4.2'
-end