uploadcare-rails 2.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3c5916f2216660149f3cc0d08f1f8a1bca1b52c6fe7b8b1ee826d7ae1335819
-  data.tar.gz: cef6ef0b56ded82cb1ef598dfd46c7bf1de58df8f7c8bf6f9f1bb7f938547db1
+  metadata.gz: 8244c46a6ef52e75965e01f0cfe4471c998e57b6243d220ee2a20ea4a2c088fb
+  data.tar.gz: bc192f9e03115994b300f32a7de2fe31e033efc5b04df3de54f0efc8d4790775
 SHA512:
-  metadata.gz: e7798988d8b02a4f862b5d7853e54e78b5c03e3ca80465abccc25f4978d0d9e3b5d3e26c711cfa19a22014ca396a9b051a2bc6eaac2e56a6f566ed8662f79ce8
-  data.tar.gz: 4b9dad88ccf27cae203052b064983718fc7f1276c2b222562e2f660a4c305fbb572e17534b35984da782acf3d383819bb75c5f158dea1285b0640bf133e5183e
+  metadata.gz: 0a717bf7a7f5ca9f0a9ca683583fa554e0d25145e35dc994520be5e290247a13e4eec22faf19ab2a1883a3fd7c01df0624256889d0ef1af3583d616a303134bb
+  data.tar.gz: 30ceb8ee793d456914cb051ffc907bd18639bdf44d06ac9456ee8a2fe05de45054215db6899db6e46a8d8a3a13b29f4ede28de93d14e6e1e92562df73090cb1f

data/lib/uploadcare/rails/api/rest/addons_api.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'uploadcare/rails/api/rest/base'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Rest
+        # A class that contains AddonsApi related methods for Uploadcare REST API
+        class AddonsApi < Base
+          class << self
+            # Execute ClamAV virus checking Add-On for a given target.
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/ucClamavVirusScanExecute
+            def virus_scan(uuid, params = {})
+              Uploadcare::Addons.uc_clamav_virus_scan(uuid, params)
+            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 virus_scan_status(uuid)
+              Uploadcare::Addons.uc_clamav_virus_scan_status(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 rekognition_detect_labels(uuid)
+              Uploadcare::Addons.ws_rekognition_detect_labels(uuid)
+            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 rekognition_detect_labels_status(uuid)
+              Uploadcare::Addons.ws_rekognition_detect_labels_status(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 = {})
+              Uploadcare::Addons.remove_bg(uuid, params)
+            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)
+              Uploadcare::Addons.remove_bg_status(uuid)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Uploadcare::AddonsApi = Uploadcare::Rails::Api::Rest::AddonsApi

data/lib/uploadcare/rails/api/rest/base.rb

@@ -6,8 +6,9 @@ module Uploadcare
   module Rails
     module Api
       module Rest
-        class Base
-        end
+        # rubocop:disable Lint/EmptyClass
+        class Base; end
+        # rubocop:enable Lint/EmptyClass
       end
     end
   end

data/lib/uploadcare/rails/api/rest/conversion_api.rb

@@ -10,25 +10,25 @@ module Uploadcare
         class ConversionApi < Base
           class << self
             # Converts video files
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/videoConvert
-            def convert_video(video_params, **options)
-              Uploadcare::VideoConverter.convert(video_params, **options)
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/videoConvert
+            def convert_video(video_params, options = {})
+              Uploadcare::VideoConverter.convert(video_params, options)
             end
 
             # Returns a status of video conversion job
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/videoConvertStatus
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/videoConvertStatus
             def get_video_conversion_status(token)
               Uploadcare::VideoConverter.status(token)
             end
 
             # Converts documents
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/documentConvert
-            def convert_document(document_params, **options)
-              Uploadcare::DocumentConverter.convert(document_params, **options)
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/documentConvert
+            def convert_document(document_params, options = {})
+              Uploadcare::DocumentConverter.convert(document_params, options)
             end
 
             # Returns a status of video conversion job
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/documentConvertStatus
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/documentConvertStatus
             def get_document_conversion_status(token)
               Uploadcare::DocumentConverter.status(token)
             end

data/lib/uploadcare/rails/api/rest/file_api.rb

@@ -10,51 +10,58 @@ module Uploadcare
         class FileApi < Base
           class << self
             # Returns a pagination json of files stored in project
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/filesList
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/filesList
             #
             # valid options:
             # removed: [true|false]
             # stored: [true|false]
             # limit: (1..1000)
-            # ordering: ["datetime_uploaded"|"-datetime_uploaded"|"size"|"-size"]
+            # ordering: ["datetime_uploaded"|"-datetime_uploaded"]
             # from: A starting point for filtering files. The value depends on your ordering parameter value.
-            def get_files(**options)
-              Uploadcare::FileList.file_list(**options)
+            def get_files(options = {})
+              Uploadcare::FileList.file_list(options)
             end
 
             # Acquire file info
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/fileInfo
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileInfo
             def get_file(uuid)
               Uploadcare::File.info(uuid)
             end
 
-            # 'copy' method is used to copy original files or their modified versions to default storage.
+            # 'local_copy' method is used to copy original files or their modified versions to a 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_file(source, **options)
-              Uploadcare::File.copy(source, **options)
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File/operation/createLocalCopy
+            def local_copy_file(source, options = {})
+              Uploadcare::File.local_copy(source, options)
             end
 
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/deleteFile
+            # 'remote_copy' method is used to copy original files or their modified versions to a custom storage.
+            # Source files MAY either be stored or just uploaded and MUST NOT be deleted.
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File/operation/createRemoteCopy
+            def remote_copy_file(source, target, options = {})
+              Uploadcare::File.remote_copy(source, target, options)
+            end
+
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/deleteFile
             def delete_file(uuid)
               Uploadcare::File.delete(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
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/storeFile
             def store_file(uuid)
               Uploadcare::File.store(uuid)
             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
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/filesStoring
             # uuids: Array
             def store_files(uuids)
               Uploadcare::FileList.batch_store(uuids)
             end
 
             # Delete several files by list of uids
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/filesDelete
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/filesDelete
             # uuids: Array
             def delete_files(uuids)
               Uploadcare::FileList.batch_delete(uuids)

data/lib/uploadcare/rails/api/rest/file_metadata_api.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'uploadcare/rails/api/rest/base'
+
+module Uploadcare
+  module Rails
+    module Api
+      module Rest
+        # A class that contains FileMetadata related methods for Uploadcare REST API
+        class FileMetadataApi < Base
+          class << self
+            # Get file's metadata keys and values
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileMetadata
+            def file_metadata(uuid)
+              Uploadcare::FileMetadata.index(uuid)
+            end
+
+            # Get the value of a single metadata key
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileMetadataKey
+            def file_metadata_value(uuid, key)
+              Uploadcare::FileMetadata.show(uuid, key)
+            end
+
+            # Update the value of a single metadata key. If the key does not exist, it will be created
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/updateFileMetadataKey
+            def update_file_metadata(uuid, key, value)
+              Uploadcare::FileMetadata.update(uuid, key, value)
+            end
+
+            # Delete a file's metadata key
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/deleteFileMetadataKey
+            def delete_file_metadata(uuid, key)
+              Uploadcare::FileMetadata.delete(uuid, key)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Uploadcare::FileMetadataApi = Uploadcare::Rails::Api::Rest::FileMetadataApi

data/lib/uploadcare/rails/api/rest/group_api.rb

@@ -10,15 +10,15 @@ module Uploadcare
         class GroupApi < Base
           class << self
             # Returns paginated list of groups
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/groupsList
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/groupsList
             #
             # valid options:
             # limit: (1..1000)
             # ordering: ["datetime_created"|"-datetime_created"]
             # from: A starting point for filtering group lists. MUST be a datetime value with T used as a separator.
             #   example: '2015-01-02T10:00:00'
-            def get_groups(**options)
-              Uploadcare::GroupList.list(**options)
+            def get_groups(options = {})
+              Uploadcare::GroupList.list(options)
             end
 
             # Get group info
@@ -28,15 +28,21 @@ module Uploadcare
             end
 
             # Stores all files in a group
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#tag/Group/paths/~1groups~1%3Cuuid%3E~1storage~1/put
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Group/paths/~1groups~1%3Cuuid%3E~1storage~1/put
             def store_group(uuid)
               Uploadcare::Group.store(uuid)
             end
 
+            # Delete a file group by its ID.
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/deleteGroup
+            def delete_group(uuid)
+              Uploadcare::Group.delete(uuid)
+            end
+
             # Create files group from a set of files by using their UUIDs.
             # @see https://uploadcare.com/api-refs/upload-api/#operation/createFilesGroup
-            def create_group(files, **options)
-              Uploadcare::Group.create(files, **options)
+            def create_group(files, options = {})
+              Uploadcare::Group.create(files, options)
             end
           end
         end

data/lib/uploadcare/rails/api/rest/project_api.rb

@@ -11,7 +11,7 @@ module Uploadcare
           class << self
             # Get information about the current project.
             # Current project is determined by public and secret keys combination.
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#tag/Project
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Project
             # rubocop:disable Naming/AccessorMethodName
             def get_project
               Uploadcare::Project.show

data/lib/uploadcare/rails/api/rest/webhook_api.rb

@@ -10,7 +10,7 @@ module Uploadcare
         class WebhookApi < Base
           class << self
             # Returns a list (not paginated) of webhooks
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/webhooksList
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/webhooksList
             # rubocop:disable Naming/AccessorMethodName
             def get_webhooks
               Uploadcare::Webhook.list
@@ -18,20 +18,20 @@ module Uploadcare
             # rubocop:enable Naming/AccessorMethodName
 
             # Create a webhook
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/webhookCreate
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/webhookCreate
             def create_webhook(target_url, event: 'file.uploaded', is_active: true, signing_secret: nil)
               options = { target_url: target_url, event: event, is_active: is_active, signing_secret: signing_secret }
               Uploadcare::Webhook.create(**options.compact)
             end
 
             # Updates a webhook
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/updateWebhook
-            def update_webhook(id, **options)
-              Uploadcare::Webhook.update(id, **options)
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/updateWebhook
+            def update_webhook(id, options = {})
+              Uploadcare::Webhook.update(id, options)
             end
 
             # Permanently deletes a webhook
-            # @see https://uploadcare.com/api-refs/rest-api/v0.5.0/#operation/webhookUnsubscribe
+            # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/webhookUnsubscribe
             def delete_webhook(target_url)
               Uploadcare::Webhook.delete(target_url)
             end

data/lib/uploadcare/rails/api/upload/base.rb

@@ -6,7 +6,9 @@ module Uploadcare
   module Rails
     module Api
       module Upload
+        # rubocop:disable Lint/EmptyClass
         class Base; end
+        # rubocop:enable Lint/EmptyClass
       end
     end
   end

data/lib/uploadcare/rails/api/upload/upload_api.rb

@@ -15,7 +15,7 @@ module Uploadcare
             #
             # @see https://uploadcare.com/api-refs/upload-api/#operation/baseUpload
             # @see https://uploadcare.com/api-refs/upload-api/#operation/multipartFileUploadStart
-            def upload_file(file, **options)
+            def upload_file(file, options = {})
               return upload(file, options) if file?(file) || file.is_a?(String)
 
               raise TypeError, "The first argument must be a File or String (URL), #{file.class} given"
@@ -24,7 +24,7 @@ module Uploadcare
             # Uploads several files smaller than 100MB.
             #
             # https://uploadcare.com/api-refs/upload-api/#operation/multipartFileUploadStart
-            def upload_files(files, **options)
+            def upload_files(files, options = {})
               return upload(files, options) if array_of_files?(files)
 
               raise TypeError, 'The first argument must be an Array of File objects'
@@ -40,8 +40,8 @@ module Uploadcare
               object.respond_to?(:path) && ::File.exist?(object.path)
             end
 
-            def upload(files, options)
-              Uploadcare::Uploader.upload(files, **options)
+            def upload(files, options = {})
+              Uploadcare::Uploader.upload(files, options)
             end
           end
         end

data/lib/uploadcare/rails/configuration.rb

@@ -35,7 +35,9 @@ module Uploadcare
       end
 
       def widget
-        OpenStruct.new(WIDGET_PARAMS.map { |param| [param, public_send(param)] }.to_h)
+        Struct
+          .new(WIDGET_PARAMS)
+          .new(WIDGET_PARAMS.map { |param| public_send(param) })
       end
 
       private

data/lib/uploadcare/rails/objects/group.rb

@@ -32,9 +32,7 @@ module Uploadcare
       end
 
       def store
-        group_info = Uploadcare::GroupApi.store_group(id).to_h
-        ::Rails.cache.write(cache_key, group_info, expires_in: cache_expires_in) if caching_enabled?
-        update_attrs(group_info)
+        Uploadcare::GroupApi.store_group(id)
       end
 
       def to_s

data/lib/uploadcare/rails/transformations/image_transformations.rb

@@ -10,7 +10,7 @@ module Uploadcare
         def initialize(options = {})
           raise ArgumentError, "Options argument must be a Hash, #{options.class} is given?" unless options.is_a?(Hash)
 
-          @options = options.map { |k, v| [k.to_sym, v] }.to_h
+          @options = options.to_h { |k, v| [k.to_sym, v] }
         end
 
         def call

data/lib/uploadcare/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Uploadcare
   module Rails
-    VERSION = '2.1.1'
+    VERSION = '3.3.0'
   end
 end

data/lib/uploadcare-rails.rb

@@ -9,6 +9,8 @@ require 'uploadcare/rails/api/rest/group_api'
 require 'uploadcare/rails/api/rest/project_api'
 require 'uploadcare/rails/api/rest/webhook_api'
 require 'uploadcare/rails/api/rest/conversion_api'
+require 'uploadcare/rails/api/rest/file_metadata_api'
+require 'uploadcare/rails/api/rest/addons_api'
 require 'uploadcare/rails/api/upload/upload_api'
 
 module Uploadcare