uploadcare-ruby 2.1.2 → 3.1.0

data/lib/uploadcare/entity/uploader.rb

@@ -0,0 +1,81 @@
+# 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 (false) 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)
+        Uploadcare::Entity::File.info(response.success.to_a.flatten[-1])
+      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
+
+      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

@@ -0,0 +1,14 @@
+# 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/exception/conversion_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module Exception
+    # Standard error for invalid API conversion responses
+    class ConversionError < StandardError; end
+  end
+end

data/lib/uploadcare/exception/request_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module Exception
+    # Standard error for invalid API responses
+    class RequestError < StandardError
+    end
+  end
+end

data/lib/uploadcare/exception/throttle_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module Exception
+    # Exception for throttled requests
+    class ThrottleError < StandardError
+      attr_reader :timeout
+
+      # @param timeout [Float] Amount of seconds the request have been throttled for
+      def initialize(timeout = 10.0)
+        super
+        @timeout = timeout
+      end
+    end
+  end
+end

data/lib/uploadcare/param/authentication_header.rb

@@ -0,0 +1,25 @@
+# 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)
+        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
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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

@@ -0,0 +1,64 @@
+# 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

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'digest/md5'
+
+module Uploadcare
+  module Param
+    # This object returns headers needed for authentication
+    # This authentication method is more secure, but more tedious
+    class SecureAuthHeader
+      # @see https://uploadcare.com/docs/api_reference/rest/requests_auth/#auth-uploadcare
+      def self.call(**options)
+        @method = options[:method]
+        @body = options[:content] || ''
+        @content_type = options[:content_type]
+        @uri = options[:uri]
+        @date_for_header = timestamp
+        {
+          'Date': @date_for_header,
+          'Authorization': "Uploadcare #{Uploadcare.config.public_key}:#{signature}"
+        }
+      end
+
+      class << self
+        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
+      end
+    end
+  end
+end

data/lib/uploadcare/param/simple_auth_header.rb

@@ -0,0 +1,14 @@
+# 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

@@ -0,0 +1,24 @@
+# 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

@@ -0,0 +1,23 @@
+# 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/
+        def self.call(store = 'auto')
+          store = '1' if store == true
+          store = '0' if store == false
+          {
+            'UPLOADCARE_PUB_KEY' => Uploadcare.config.public_key,
+            'UPLOADCARE_STORE' => store,
+            'signature' => (Upload::SignatureGenerator.call if Uploadcare.config.sign_uploads)
+          }.reject { |_k, v| v.nil? }
+        end
+      end
+    end
+  end
+end

data/lib/uploadcare/param/user_agent.rb

@@ -0,0 +1,21 @@
+# 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/ruby/version.rb

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

data/lib/uploadcare.rb

@@ -1,38 +1,42 @@
-require 'faraday'
-require 'json'
-require 'ostruct'
+# frozen_string_literal: true
 
-require_relative 'uploadcare/api'
-require_relative 'uploadcare/version'
+# Gem version
+require 'ruby/version'
 
-module Uploadcare
-  DEFAULT_SETTINGS = {
-    public_key: 'demopublickey',
-    private_key: 'demoprivatekey',
-    upload_url_base: 'https://upload.uploadcare.com',
-    api_url_base: 'https://api.uploadcare.com',
-    static_url_base: 'https://ucarecdn.com',
-    api_version: '0.5',
-    cache_files: true,
-    autostore: :auto,
-    auth_scheme: :secure,
-  }
+# Exceptions
+require 'exception/throttle_error'
+require 'exception/request_error'
 
-  def self.default_settings
-    DEFAULT_SETTINGS
-  end
+# 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'
 
-  def self.user_agent(options={})
-    warn '[DEPRECATION] `Uploadcare::user_agent` method is deprecated and will be removed in version 3.0'
-    UserAgent.new.call(options)
-  end
+# General api
+require 'api/api'
 
-  def self.const_missing(name)
-    if name == :USER_AGENT
-      warn '[DEPRECATION] `Uploadcare::USER_AGENT` constant is deprecated and will be removed in version 3.0'
-      "uploadcare-ruby/#{Gem.ruby_version}/#{Uploadcare::VERSION}"
-    else
-      super
-    end
-  end
+# Ruby wrapper for Uploadcare API
+#
+# @see https://uploadcare.com/docs/api_reference
+module Uploadcare
+  extend Dry::Configurable
+  setting :public_key, ENV.fetch('UPLOADCARE_PUBLIC_KEY')
+  setting :secret_key, ENV.fetch('UPLOADCARE_SECRET_KEY')
+  setting :auth_type, 'Uploadcare'
+  setting :multipart_size_threshold, 100 * 1024 * 1024
+  setting :rest_api_root, 'https://api.uploadcare.com'
+  setting :upload_api_root, 'https://upload.uploadcare.com'
+  setting :max_request_tries, 100
+  setting :base_request_sleep, 1 # seconds
+  setting :max_request_sleep, 60.0 # seconds
+  setting :sign_uploads, false
+  setting :upload_signature_lifetime, 30 * 60 # seconds
+  setting :max_throttle_attempts, 5
+  setting :upload_threads, 2 # used for multiupload only ATM
+  setting :framework_data, ''
 end

data/uploadcare-ruby.gemspec

@@ -1,38 +1,51 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/uploadcare/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name          = 'uploadcare-ruby'
-  gem.authors       = ['@rastyagaev (Vadim Rastyagaev)',
-                       '@dimituri (Dimitry Solovyov)',
-                       '@romanonthego (Roman Dubinin)',
-                       '@vizvamitra (Dmitrii Krasnov)']
-  gem.email         = ['hello@uploadcare.com']
-  gem.summary       = 'Ruby gem for Uploadcare'
-  gem.description   = <<-EOF
-                        Ruby wrapper for Uploadcare service API.
-                        Full documentations on APIs can be found
-                        at https://uploadcare.com/documentation/rest/
-                        and https://uploadcare.com/documentation/upload/
-                      EOF
-  gem.metadata      = { 'github' => 'https://github.com/uploadcare/uploadcare-ruby',
-                        'issue_tracker' => 'https://github.com/uploadcare/uploadcare-ruby/issues',
-                      }
-  gem.homepage      = 'https://uploadcare.com/documentation/libs/'
-  gem.license       = 'MIT'
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
-  gem.version       = Uploadcare::VERSION
-  gem.add_runtime_dependency 'faraday', '~> 0.8'
-  gem.add_runtime_dependency 'faraday_middleware', '~> 0.9'
-  gem.add_runtime_dependency 'multipart-post'
-  gem.add_runtime_dependency 'mime-types'
-
-  gem.add_development_dependency 'rspec', '~> 3.6'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'coveralls'
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uploadcare/ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uploadcare-ruby'
+  spec.version       = Uploadcare::VERSION
+  spec.authors       = ['Stepan Redka']
+  spec.email         = ['stepan.redka@railsmuffin.com']
+
+  spec.summary       = 'Ruby wrapper for uploadcare API'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/uploadcare/uploadcare-ruby'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/uploadcare/uploadcare-ruby'
+    spec.metadata['changelog_uri'] = 'https://github.com/uploadcare/uploadcare-ruby/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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.add_dependency 'api_struct', '~> 1.0.1'
+  spec.add_dependency 'dry-configurable', '~> 0.9.0'
+  spec.add_dependency 'parallel'
+  spec.add_dependency 'retries'
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 end