Harden file metadata paths and add coverage

Author: vipulnsward

lib/uploadcare/clients/file_metadata_client.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 # Client for file metadata operations.
+require 'uri'
 class Uploadcare::FileMetadataClient < Uploadcare::RestClient
   # Retrieves all metadata associated with a specific file by UUID.
   # @param uuid [String] The UUID of the file.
   # @return [Hash] A hash containing all metadata key-value pairs for the file.
   # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata/operation/_fileMetadata
   def index(uuid:, request_options: {})
-    get(path: "/files/#{uuid}/metadata/", params: {}, headers: {}, request_options: request_options)
+    encoded_uuid = URI.encode_www_form_component(uuid)
+    get(path: "/files/#{encoded_uuid}/metadata/", params: {}, headers: {}, request_options: request_options)
   end
 
   # Gets the value of a specific metadata key for a file by UUID
@@ -16,7 +18,9 @@ def index(uuid:, request_options: {})
   # @return [String] The value of the metadata key
   # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata/operation/fileMetadata
   def show(uuid:, key:, request_options: {})
-    get(path: "/files/#{uuid}/metadata/#{key}/", params: {}, headers: {}, request_options: request_options)
+    encoded_uuid = URI.encode_www_form_component(uuid)
+    encoded_key = URI.encode_www_form_component(key)
+    get(path: "/files/#{encoded_uuid}/metadata/#{encoded_key}/", params: {}, headers: {}, request_options: request_options)
   end
 
   # Updates or creates a metadata key for a specific file by UUID
@@ -26,7 +30,9 @@ def show(uuid:, key:, request_options: {})
   # @return [String] The value of the updated or added metadata key
   # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata/operation/updateFileMetadataKey
   def update(uuid:, key:, value:, request_options: {})
-    put(path: "/files/#{uuid}/metadata/#{key}/", params: value, headers: {}, request_options: request_options)
+    encoded_uuid = URI.encode_www_form_component(uuid)
+    encoded_key = URI.encode_www_form_component(key)
+    put(path: "/files/#{encoded_uuid}/metadata/#{encoded_key}/", params: value, headers: {}, request_options: request_options)
   end
 
   # Deletes a specific metadata key for a file by UUID
@@ -35,6 +41,8 @@ def update(uuid:, key:, value:, request_options: {})
   # @return [Nil] Returns nil on successful deletion
   # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata/operation/deleteFileMetadata
   def delete(uuid:, key:, request_options: {})
-    super(path: "/files/#{uuid}/metadata/#{key}/", params: {}, headers: {}, request_options: request_options)
+    encoded_uuid = URI.encode_www_form_component(uuid)
+    encoded_key = URI.encode_www_form_component(key)
+    super(path: "/files/#{encoded_uuid}/metadata/#{encoded_key}/", params: {}, headers: {}, request_options: request_options)
   end
 end

lib/uploadcare/resources/file_metadata.rb

@@ -11,9 +11,9 @@ def initialize(attributes = {}, config = Uploadcare.configuration)
   # Retrieves metadata for the file
   # @return [Hash] The metadata keys and values for the file
   # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata/operation/_fileMetadata
-  # TODO - Remove uuid if the opeartion is being perfomed on same file
-  def index(uuid:, request_options: {})
-    response = Uploadcare::Result.unwrap(@file_metadata_client.index(uuid: uuid, request_options: request_options))
+  def index(uuid: nil, request_options: {})
+    response = Uploadcare::Result.unwrap(@file_metadata_client.index(uuid: uuid || @uuid,
+                                                                     request_options: request_options))
     @metadata = response if response.is_a?(Hash)
     self
   end
@@ -36,27 +36,26 @@ def to_h
   # Updates metadata key's value
   # @return [String] The updated value of the metadata key
   # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata/operation/updateFileMetadataKey
-  # TODO - Remove uuid if the opeartion is being perfomed on same file
-  def update(uuid:, key:, value:, request_options: {})
-    Uploadcare::Result.unwrap(@file_metadata_client.update(uuid: uuid, key: key, value: value,
+  def update(uuid: nil, key:, value:, request_options: {})
+    Uploadcare::Result.unwrap(@file_metadata_client.update(uuid: uuid || @uuid, key: key, value: value,
                                                            request_options: request_options))
   end
 
   # Retrieves the value of a specific metadata key for the file
   # @param key [String] The metadata key to retrieve
   # @return [String] The value of the metadata key
   # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata/operation/fileMetadata
-  # TODO - Remove uuid if the opeartion is being perfomed on same file
-  def show(uuid:, key:, request_options: {})
-    Uploadcare::Result.unwrap(@file_metadata_client.show(uuid: uuid, key: key, request_options: request_options))
+  def show(uuid: nil, key:, request_options: {})
+    Uploadcare::Result.unwrap(@file_metadata_client.show(uuid: uuid || @uuid, key: key,
+                                                         request_options: request_options))
   end
 
   # Deletes a specific metadata key for the file
   # @param key [String] The metadata key to delete
   # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File-metadata/operation/deleteFileMetadata
-  # TODO - Remove uuid if the opeartion is being perfomed on same file
-  def delete(uuid:, key:, request_options: {})
-    Uploadcare::Result.unwrap(@file_metadata_client.delete(uuid: uuid, key: key, request_options: request_options))
+  def delete(uuid: nil, key:, request_options: {})
+    Uploadcare::Result.unwrap(@file_metadata_client.delete(uuid: uuid || @uuid, key: key,
+                                                           request_options: request_options))
   end
 
   # Get file's metadata keys and values

spec/uploadcare/clients/file_metadata_client_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'uri'
 
 RSpec.describe Uploadcare::FileMetadataClient do
   subject(:client) { described_class.new }
@@ -68,4 +69,22 @@
       expect(response.success).to be_nil
     end
   end
+
+  describe 'URL encoding' do
+    let(:encoded_uuid) { URI.encode_www_form_component(uuid) }
+    let(:encoded_key) { URI.encode_www_form_component(key) }
+
+    before do
+      stub_request(:get, "https://api.uploadcare.com/files/#{encoded_uuid}/metadata/#{encoded_key}/")
+        .to_return(status: 200, body: value.to_json, headers: { 'Content-Type' => 'application/json' })
+    end
+
+    let(:uuid) { 'file~uuid' }
+    let(:key) { 'custom key' }
+
+    it 'encodes uuid and key in metadata paths' do
+      response = client.show(uuid: uuid, key: key)
+      expect(response.success).to eq(value)
+    end
+  end
 end

spec/uploadcare/resources/file_metadata_spec.rb

@@ -19,6 +19,16 @@
       result = file_metadata.index(uuid: uuid)
       expect(result).to be_a(described_class)
     end
+
+    it 'uses existing uuid when not provided' do
+      file_metadata.instance_variable_set(:@uuid, uuid)
+      allow_any_instance_of(Uploadcare::FileMetadataClient).to receive(:index)
+        .with(uuid: uuid, request_options: {})
+        .and_return(response_body)
+
+      result = file_metadata.index
+      expect(result).to be_a(described_class)
+    end
   end
 
   describe '#[]' do
@@ -63,6 +73,16 @@
       result = file_metadata.show(uuid: uuid, key: key)
       expect(result).to eq(value)
     end
+
+    it 'uses existing uuid when not provided' do
+      file_metadata.instance_variable_set(:@uuid, uuid)
+      allow_any_instance_of(Uploadcare::FileMetadataClient).to receive(:show)
+        .with(uuid: uuid, key: key, request_options: {})
+        .and_return(value)
+
+      result = file_metadata.show(key: key)
+      expect(result).to eq(value)
+    end
   end
 
   describe '#update' do
@@ -74,6 +94,16 @@
       result = file_metadata.update(uuid: uuid, key: key, value: value)
       expect(result).to eq(value)
     end
+
+    it 'uses existing uuid when not provided' do
+      file_metadata.instance_variable_set(:@uuid, uuid)
+      allow_any_instance_of(Uploadcare::FileMetadataClient).to receive(:update)
+        .with(uuid: uuid, key: key, value: value, request_options: {})
+        .and_return(value)
+
+      result = file_metadata.update(key: key, value: value)
+      expect(result).to eq(value)
+    end
   end
 
   describe '#delete' do
@@ -85,6 +115,16 @@
       result = file_metadata.delete(uuid: uuid, key: key)
       expect(result).to be_nil
     end
+
+    it 'uses existing uuid when not provided' do
+      file_metadata.instance_variable_set(:@uuid, uuid)
+      allow_any_instance_of(Uploadcare::FileMetadataClient).to receive(:delete)
+        .with(uuid: uuid, key: key, request_options: {})
+        .and_return(nil)
+
+      result = file_metadata.delete(key: key)
+      expect(result).to be_nil
+    end
   end
   describe '.index' do
     it 'retrieves all metadata keys and values' do