uploadcare-ruby 5.0.0 → 5.1.0

data/lib/uploadcare/resources/file_tags.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Resource for reading and changing the ordered tag list associated with a file.
+#
+# @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-tags
+class Uploadcare::Resources::FileTags < Uploadcare::Resources::BaseResource
+  attr_accessor :uuid, :tags, :added, :deleted
+
+  def initialize(attributes = {}, client_or_config = nil)
+    @tags = []
+    @added = []
+    @deleted = []
+    super
+  end
+
+  # Fetch the current tags.
+  #
+  # @param request_options [Hash] Request options
+  # @return [self]
+  def list(request_options: {})
+    response = Uploadcare::Result.unwrap(
+      client.api.rest.file_tags.list(uuid: uuid, request_options: request_options)
+    )
+    self.tags = response.fetch('tags', [])
+    self.added = []
+    self.deleted = []
+    self
+  end
+  alias index list
+
+  # Replace the complete tag list. An empty array clears all tags.
+  #
+  # @param tags [Array<String>]
+  # @param request_options [Hash] Request options
+  # @return [self]
+  def replace(tags:, request_options: {})
+    normalized = Uploadcare::Internal::FileTagNormalizer.call(tags)
+    response = Uploadcare::Result.unwrap(
+      client.api.rest.file_tags.replace(uuid: uuid, tags: normalized, request_options: request_options)
+    )
+    assign_attributes(response)
+    self
+  end
+
+  # Atomically add and delete tags. Deletions are applied first.
+  #
+  # @param add [Array<String>] Tags to add
+  # @param delete [Array<String>] Tags to delete
+  # @param request_options [Hash] Request options
+  # @return [self]
+  def update(add: [], delete: [], request_options: {})
+    normalized_add = Uploadcare::Internal::FileTagNormalizer.call(add)
+    normalized_delete = Uploadcare::Internal::FileTagNormalizer.call(delete, max_count: nil)
+    response = Uploadcare::Result.unwrap(
+      client.api.rest.file_tags.update(
+        uuid: uuid, add: normalized_add, delete: normalized_delete, request_options: request_options
+      )
+    )
+    assign_attributes(response)
+    self
+  end
+
+  # Get the current tag list for a file.
+  #
+  # @return [Array<String>]
+  def self.list(uuid:, client: nil, config: Uploadcare.configuration, request_options: {})
+    resolved_client = resolve_client(client: client, config: config)
+    new({ uuid: uuid }, resolved_client).list(request_options: request_options).tags.dup
+  end
+
+  class << self
+    alias index list
+  end
+
+  # Replace the complete tag list for a file.
+  #
+  # @return [Uploadcare::Resources::FileTags]
+  def self.replace(uuid:, tags:, client: nil, config: Uploadcare.configuration, request_options: {})
+    resolved_client = resolve_client(client: client, config: config)
+    new({ uuid: uuid }, resolved_client).replace(tags: tags, request_options: request_options)
+  end
+
+  # Atomically add and delete tags for a file.
+  #
+  # @return [Uploadcare::Resources::FileTags]
+  def self.update(uuid:, add: [], delete: [], client: nil, config: Uploadcare.configuration, request_options: {})
+    resolved_client = resolve_client(client: client, config: config)
+    new({ uuid: uuid }, resolved_client).update(
+      add: add, delete: delete, request_options: request_options
+    )
+  end
+end

data/lib/uploadcare/version.rb

@@ -3,5 +3,5 @@
 # Root namespace for the Uploadcare Ruby SDK.
 module Uploadcare
   # Gem version.
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

data/lib/uploadcare.rb

@@ -79,6 +79,8 @@ module Uploadcare
   Webhook = Resources::Webhook
   # Alias for the file metadata resource.
   FileMetadata = Resources::FileMetadata
+  # Alias for the file tags resource.
+  FileTags = Resources::FileTags
   # Alias for the add-on execution resource.
   AddonExecution = Resources::AddonExecution
   # Alias for the document conversion resource.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uploadcare-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - "@dmitrijivanchenko (Dmitrij Ivanchenko), @T0mbery (Andrey Aksenov)"
@@ -119,10 +119,12 @@ files:
 - api_examples/rest_api/get_files_uuid.rb
 - api_examples/rest_api/get_files_uuid_metadata.rb
 - api_examples/rest_api/get_files_uuid_metadata_key.rb
+- api_examples/rest_api/get_files_uuid_tags.rb
 - api_examples/rest_api/get_groups.rb
 - api_examples/rest_api/get_groups_uuid.rb
 - api_examples/rest_api/get_project.rb
 - api_examples/rest_api/get_webhooks.rb
+- api_examples/rest_api/patch_files_uuid_tags.rb
 - api_examples/rest_api/post_addons_aws_rekognition_detect_labels_execute.rb
 - api_examples/rest_api/post_addons_aws_rekognition_detect_moderation_labels_execute.rb
 - api_examples/rest_api/post_addons_remove_bg_execute.rb
@@ -131,10 +133,12 @@ files:
 - api_examples/rest_api/post_convert_video.rb
 - api_examples/rest_api/post_files_local_copy.rb
 - api_examples/rest_api/post_files_remote_copy.rb
+- api_examples/rest_api/post_files_search.rb
 - api_examples/rest_api/post_webhooks.rb
 - api_examples/rest_api/put_files_storage.rb
 - api_examples/rest_api/put_files_uuid_metadata_key.rb
 - api_examples/rest_api/put_files_uuid_storage.rb
+- api_examples/rest_api/put_files_uuid_tags.rb
 - api_examples/rest_api/put_webhooks_id.rb
 - api_examples/support/example_helper.rb
 - api_examples/support/run_rest_example.rb
@@ -152,8 +156,11 @@ files:
 - bin/setup
 - context7.json
 - docs/release-notes-5.0.0.md
+- docs/release-notes-5.1.0.md
 - examples/README.md
 - examples/batch_upload.rb
+- examples/file_search.rb
+- examples/file_tags.rb
 - examples/group_creation.rb
 - examples/large_file_upload.rb
 - examples/simple_upload.rb
@@ -164,6 +171,7 @@ files:
 - lib/uploadcare/api/rest/addons.rb
 - lib/uploadcare/api/rest/document_conversions.rb
 - lib/uploadcare/api/rest/file_metadata.rb
+- lib/uploadcare/api/rest/file_tags.rb
 - lib/uploadcare/api/rest/files.rb
 - lib/uploadcare/api/rest/groups.rb
 - lib/uploadcare/api/rest/project.rb
@@ -178,6 +186,7 @@ files:
 - lib/uploadcare/client/conversions_accessor.rb
 - lib/uploadcare/client/document_conversions_accessor.rb
 - lib/uploadcare/client/file_metadata_accessor.rb
+- lib/uploadcare/client/file_tags_accessor.rb
 - lib/uploadcare/client/files_accessor.rb
 - lib/uploadcare/client/groups_accessor.rb
 - lib/uploadcare/client/project_accessor.rb
@@ -185,6 +194,7 @@ files:
 - lib/uploadcare/client/webhooks_accessor.rb
 - lib/uploadcare/cname_generator.rb
 - lib/uploadcare/collections/batch_result.rb
+- lib/uploadcare/collections/file_search_result.rb
 - lib/uploadcare/collections/paginated.rb
 - lib/uploadcare/configuration.rb
 - lib/uploadcare/exception/auth_error.rb
@@ -201,11 +211,13 @@ files:
 - lib/uploadcare/exception/upload_timeout_error.rb
 - lib/uploadcare/internal/authenticator.rb
 - lib/uploadcare/internal/error_handler.rb
+- lib/uploadcare/internal/file_tag_normalizer.rb
 - lib/uploadcare/internal/signature_generator.rb
 - lib/uploadcare/internal/throttle_handler.rb
 - lib/uploadcare/internal/upload_io.rb
 - lib/uploadcare/internal/upload_params_generator.rb
 - lib/uploadcare/internal/user_agent.rb
+- lib/uploadcare/operations/file_search.rb
 - lib/uploadcare/operations/multipart_upload.rb
 - lib/uploadcare/operations/upload_router.rb
 - lib/uploadcare/resources/addon_execution.rb
@@ -213,6 +225,7 @@ files:
 - lib/uploadcare/resources/document_conversion.rb
 - lib/uploadcare/resources/file.rb
 - lib/uploadcare/resources/file_metadata.rb
+- lib/uploadcare/resources/file_tags.rb
 - lib/uploadcare/resources/group.rb
 - lib/uploadcare/resources/project.rb
 - lib/uploadcare/resources/video_conversion.rb