Fix Uploadcare::File.remote_copy raising response errors (#171)

* Fix Uploadcare::File.remote_copy raising response errors

* Fix rubocop offences

* Update CHANGELOG.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+### Fixed
+* Fixed the `Uploadcare::File.remote_copy` method which raised an `ApiStruct::EntityError: {url} must be Hash`. Now returns a string instead of a `File` entity instance.
 ### Added
 * `Document Info` API added in `DocumentConverter`.
 ## 4.4.1 — 2024-04-27

api_examples/rest_api/post_files_remote_copy.rb

@@ -2,7 +2,7 @@
 Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
 Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
 
-source = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+source_object = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
 target = 'custom_storage_connected_to_the_project'
-copied_file = Uploadcare::File.remote_copy(source, target, make_public: true)
-puts copied_file.uuid
+copied_file_url = Uploadcare::File.remote_copy(source_object, target, make_public: true)
+puts copied_file_url

lib/uploadcare/client/multipart_upload_client.rb

@@ -47,7 +47,7 @@ def upload_complete(uuid)
       private
 
       def form_data_for(file)
-        form_data_file = super(file)
+        form_data_file = super
         {
           filename: form_data_file.filename,
           size: form_data_file.size,

lib/uploadcare/entity/file.rb

@@ -64,8 +64,7 @@ def self.local_copy(source, args = {})
       #
       # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/File/operation/createRemoteCopy
       def self.remote_copy(source, target, args = {})
-        response = FileClient.new.remote_copy(source: source, target: target, **args).success[:result]
-        File.new(response)
+        FileClient.new.remote_copy(source: source, target: target, **args).success[:result]
       end
 
       # Instance version of {internal_copy}

spec/support/vcr.rb

@@ -6,6 +6,8 @@
 VCR.configure do |config|
   config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   config.hook_into :webmock
+  config.filter_sensitive_data('<uploadcare_public_key>') { Uploadcare.config.public_key }
+  config.filter_sensitive_data('<uploadcare_secret_key>') { Uploadcare.config.secret_key }
   config.before_record do |i|
     if i.request.body && i.request.body.size > 1024 * 1024
       i.request.body = "Big string (#{i.request.body.size / (1024 * 1024)}) MB"

spec/uploadcare/entity/file_spec.rb

@@ -44,7 +44,16 @@ module Entity
       end
 
       describe 'external_copy' do
-        it 'copies file to different project' do
+        it 'copies file to remote storage' do
+          VCR.use_cassette('rest_file_remote_copy') do
+            target = 'uploadcare-test'
+            uuid = '1b959c59-9605-4879-946f-08fdb5ea3e9d'
+            file = subject.file(uuid)
+            expect(file.remote_copy(target)).to match(%r{#{target}/#{uuid}/})
+          end
+        end
+
+        it 'raises an error when project does not have given storage' do
           VCR.use_cassette('rest_file_external_copy') do
             file = subject.file('5632fc94-9dff-499f-a373-f69ea6f67ff8')
             # I don't have custom storage, but this error recognises what this method tries to do