uploadcare-ruby 1.2.1 → 3.0.3

data/Rakefile

@@ -1,6 +1,8 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-task :default => :spec
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'uploadcare/ruby'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/uploadcare.rb

@@ -1,32 +1,42 @@
-require 'faraday'
-require 'json'
-require 'ostruct'
+# frozen_string_literal: true
 
-require 'uploadcare/api'
-require '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.3',
-      cache_files: true,
-      auth_scheme: :secure
-    }
-
-  warn '[DEPRECATION] `Uploadcare::USER_AGENT` constant is deprecated and will be removed in version 3.0'
-  USER_AGENT = "uploadcare-ruby/#{Gem.ruby_version}/#{Uploadcare::VERSION}"
+# Exceptions
+require 'exception/throttle_error'
+require 'exception/request_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'
 
-  def self.default_settings
-    DEFAULT_SETTINGS
-  end
+# General api
+require 'api/api'
 
-  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
+# 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/lib/uploadcare/api/api.rb

@@ -0,0 +1,25 @@
+# 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/file_client.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'rest_client'
+
+module Uploadcare
+  module Client
+    # API client for handling single files
+    # @see https://uploadcare.com/docs/api_reference/rest/accessing_files/
+    # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#tag/File
+    class FileClient < RestClient
+      # Gets list of files without pagination fields
+      def index
+        response = get(uri: '/files/')
+        response.fmap { |i| i[:results] }
+      end
+
+      # Acquire file info
+      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/fileInfo
+      def info(uuid)
+        get(uri: "/files/#{uuid}/")
+      end
+      alias file info
+
+      # 'copy' method is used to copy original files or their modified versions to default storage.
+      # Source files MAY either be stored or just uploaded and MUST NOT be deleted.
+      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/copyFile
+      def copy(**options)
+        body = options.compact.to_json
+        post(uri: '/files/', content: body)
+      end
+
+      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/deleteFile
+      def delete(uuid)
+        request(method: 'DELETE', uri: "/files/#{uuid}/")
+      end
+
+      # Store a single file, preventing it from being deleted in 2 weeks
+      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/storeFile
+      def store(uuid)
+        put(uri: "/files/#{uuid}/storage/")
+      end
+    end
+  end
+end

data/lib/uploadcare/client/file_list_client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'rest_client'
+
+module Uploadcare
+  module Client
+    # API client for handling file lists
+    class FileListClient < RestClient
+      # Returns a pagination json of files stored in project
+      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/filesList
+      #
+      # valid options:
+      # removed: [true|false]
+      # stored: [true|false]
+      # limit: (1..1000)
+      # ordering: ["datetime_uploaded"|"-datetime_uploaded"|"size"|"-size"]
+      # from: number of files skipped
+      def file_list(**options)
+        query = options.empty? ? '' : '?' + URI.encode_www_form(options)
+        get(uri: "/files/#{query}")
+      end
+
+      # Make a set of files "stored". This will prevent them from being deleted automatically
+      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/filesStoring
+      # uuids: Array
+      def batch_store(uuids)
+        body = uuids.to_json
+        put(uri: '/files/storage/', body: body)
+      end
+
+      alias request_delete delete
+
+      # Delete several files by list of uids
+      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/filesDelete
+      # uuids: Array
+      def batch_delete(uuids)
+        body = uuids.to_json
+        request_delete(uri: '/files/storage/', body: body)
+      end
+
+      alias store_files batch_store
+      alias delete_files batch_delete
+      alias list file_list
+    end
+  end
+end

data/lib/uploadcare/client/group_client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'upload_client'
+
+module Uploadcare
+  module Client
+    # Groups serve a purpose of better organizing files in your Uploadcare projects.
+    # You can create one from a set of files by using their UUIDs.
+    # @see https://uploadcare.com/docs/api_reference/upload/groups/
+    class GroupClient < UploadClient
+      # Create files group from a set of files by using their UUIDs.
+      # @see https://uploadcare.com/api-refs/upload-api/#operation/createFilesGroup
+      def create(file_list, **options)
+        body_hash = group_body_hash(file_list, **options)
+        body = HTTP::FormData::Multipart.new(body_hash)
+        post(path: 'group/',
+             headers: { 'Content-type': body.content_type },
+             body: body)
+      end
+
+      # Get group info
+      # @see https://uploadcare.com/api-refs/upload-api/#operation/filesGroupInfo
+      def info(group_id)
+        get(path: 'group/info/', params: { 'pub_key': Uploadcare.config.public_key, 'group_id': group_id })
+      end
+
+      private
+
+      def file_params(file_ids)
+        ids = (0...file_ids.size).map { |i| "files[#{i}]" }
+        ids.zip(file_ids).to_h
+      end
+
+      def group_body_hash(file_list, **options)
+        { pub_key: Uploadcare.config.public_key }.merge(file_params(parse_file_list(file_list))).merge(**options)
+      end
+
+      # API accepts only list of ids, but some users may want to upload list of files
+      # @return [Array] of [String]
+      def parse_file_list(file_list)
+        file_list.map { |file| file.methods.include?(:uuid) ? file.uuid : file }
+      end
+    end
+  end
+end

data/lib/uploadcare/client/multipart_upload/chunks_client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'parallel'
+
+module Uploadcare
+  module Client
+    module MultipartUpload
+      # This class splits file into chunks of set chunk_size
+      # and uploads them into cloud storage.
+      # Used for multipart uploads
+      # @see https://uploadcare.com/api-refs/upload-api/#tag/Upload/paths/https:~1~1uploadcare.s3-accelerate.amazonaws.com~1%3C%3Cpresigned-url%3E/put
+      class ChunksClient < ApiStruct::Client
+        CHUNK_SIZE = 5_242_880
+
+        # In multiple threads, split file into chunks and upload those chunks into respective Amazon links
+        # @param object [File]
+        # @param links [Array] of strings; by default list of Amazon storage urls
+        def upload_chunks(object, links)
+          Parallel.each(0...links.count, in_threads: Uploadcare.config.upload_threads) do |link_id|
+            offset = link_id * CHUNK_SIZE
+            chunk = IO.read(object, CHUNK_SIZE, offset)
+            upload_chunk(chunk, links[link_id])
+          end
+        end
+
+        def api_root
+          ''
+        end
+
+        def headers
+          {}
+        end
+
+        private
+
+        def upload_chunk(chunk, link)
+          put(path: link, body: chunk, headers: { 'Content-type': 'application/octet-stream' })
+        end
+
+        def default_params
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/uploadcare/client/multipart_upload_client.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'client/multipart_upload/chunks_client'
+require_relative 'upload_client'
+
+module Uploadcare
+  module Client
+    # Client for multipart uploads
+    #
+    # @see https://uploadcare.com/api-refs/upload-api/#tag/Upload
+    class MultipartUploaderClient < UploadClient
+      include MultipartUpload
+
+      # Upload a big file by splitting it into parts and sending those parts into assigned buckets
+      # object should be File
+      def upload(object, store: false)
+        response = upload_start(object, store: store)
+        return response unless response.success[:parts] && response.success[:uuid]
+
+        links = response.success[:parts]
+        uuid = response.success[:uuid]
+        ChunksClient.new.upload_chunks(object, links)
+        upload_complete(uuid)
+      end
+
+      # Asks Uploadcare server to create a number of storage bin for uploads
+      def upload_start(object, store: false)
+        body = HTTP::FormData::Multipart.new(
+          Param::Upload::UploadParamsGenerator.call(store).merge(multiupload_metadata(object))
+        )
+        post(path: 'multipart/start/',
+             headers: { 'Content-type': body.content_type },
+             body: body)
+      end
+
+      # When every chunk is uploaded, ask Uploadcare server to finish the upload
+      def upload_complete(uuid)
+        body = HTTP::FormData::Multipart.new(
+          'UPLOADCARE_PUB_KEY': Uploadcare.config.public_key,
+          'uuid': uuid
+        )
+        post(path: 'multipart/complete/', body: body, headers: { 'Content-type': body.content_type })
+      end
+
+      private
+
+      def multiupload_metadata(file)
+        file = HTTP::FormData::File.new(file)
+        {
+          filename: file.filename,
+          size: file.size,
+          content_type: file.content_type
+        }
+      end
+
+      alias api_struct_post post
+      def post(**args)
+        handle_throttling { api_struct_post(**args) }
+      end
+    end
+  end
+end

data/lib/uploadcare/client/project_client.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module Client
+    # API client for getting project info
+    # @see https://uploadcare.com/docs/api_reference/rest/handling_projects/
+    class ProjectClient < RestClient
+      # get information about current project
+      # current project is determined by public and private key combination
+      # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#tag/Project
+      def show
+        get(uri: '/project/')
+      end
+
+      alias project show
+    end
+  end
+end

data/lib/uploadcare/client/rest_client.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'rest_client'
+require 'uploadcare/concern/error_handler'
+require 'uploadcare/concern/throttle_handler'
+require 'param/authentication_header'
+
+module Uploadcare
+  module Client
+    # @abstract
+    # General client for signed REST requests
+    class RestClient < ApiStruct::Client
+      include Uploadcare::Concerns::ErrorHandler
+      include Uploadcare::Concerns::ThrottleHandler
+      include Exception
+
+      alias api_struct_delete delete
+      alias api_struct_get get
+      alias api_struct_post post
+      alias api_struct_put put
+
+      # Send request with authentication header
+      #
+      # Handle throttling as well
+      def request(method: 'GET', uri:, **options)
+        request_headers = Param::AuthenticationHeader.call(method: method.upcase, uri: uri,
+                                                           content_type: headers[:'Content-type'], **options)
+        handle_throttling do
+          send('api_struct_' + method.downcase, path: remove_trailing_slash(uri),
+                                                headers: request_headers, body: options[:content])
+        end
+      end
+
+      def get(**options)
+        request(method: 'GET', **options)
+      end
+
+      def post(**options)
+        request(method: 'POST', **options)
+      end
+
+      def put(**options)
+        request(method: 'PUT', **options)
+      end
+
+      def delete(**options)
+        request(method: 'DELETE', **options)
+      end
+
+      def api_root
+        Uploadcare.config.rest_api_root
+      end
+
+      def headers
+        {
+          'Content-type': 'application/json',
+          'Accept': 'application/vnd.uploadcare-v0.5+json',
+          'User-Agent': Uploadcare::Param::UserAgent.call
+        }
+      end
+
+      private
+
+      def remove_trailing_slash(str)
+        str.gsub(%r{^\/}, '')
+      end
+
+      def default_params
+        {}
+      end
+    end
+  end
+end