uploadcare-ruby 4.4.1 → 4.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cd6e50f0d12bc1cd65c531fa7e5656e41149433c042aedeb5d8899425ae6e53
-  data.tar.gz: baa9f7cc358eba65895e608073d2ad188bc68ff1b5a44b8c51e6d5b2e72fc8bb
+  metadata.gz: 9bf27040e7e061caf3e4810f1e40ab9421f0a063eee05b2338a4b1e7255524bd
+  data.tar.gz: b41c835893fc836263ba7e354fce6427a9fbbaec26efbea485fac9874d162af1
 SHA512:
-  metadata.gz: eab5bac3add563b090d18e7f82e2c7c852e95ff0d99530f8a3d25ec2d9eb47f1d146d38fc3dec9335af3bb9cebb74079b5fb27d3f46c7c1971d892185607df06
-  data.tar.gz: 2edc0a691512ac31210f5fada71d7515c59ac8305c5a522e04f2f90924af313cdba4707860e8bb6d1aaeec4053cff0869f0f5f14a458d33832c57587d3ab9822
+  metadata.gz: 810bd3ad7369ddbb2f44a932d12699c5b969bec1feb33ade6805a31a61d18afc102043ba1e61b0b53c7996956c4b6c8496a8e807598436d7325ad33c3a3bf33e
+  data.tar.gz: ef9f05f9f586ba804de9e424ee9634abaebf8cff8a7d47be13147206fa2ff3e3adeac56f61f8ea54ccea77e36a523df100438647df01a92c0f1e0f42d5dff5b3

data/.rubocop.yml

@@ -34,3 +34,7 @@ Style/Documentation:
 
 Style/OptionalBooleanParameter:
   AllowedMethods: ['create']
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'api_examples/**/*'

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 4.4.3 — 2024-07-06
+
+### Added
+* Multi page conversion parameter (`save_in_group`) added to `DocumentConverter#convert` options.
+
+### Fixed
+* Fixed that signed URLs now work with ~ in the path. This also fixes signed URLs with grouped file URLs. 
+
+## 4.4.2 — 2024-05-29
+
+### 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
 
 ### Added

data/README.md

@@ -556,7 +556,7 @@ An `Add-On` is an application implemented by Uploadcare that accepts uploaded fi
 ##### AWS Rekognition
 
 ```ruby
-# Execute AWS Rekognition Add-On for a given target to detect labels in an image. 
+# Execute AWS Rekognition Add-On for a given target to detect labels in an image.
 # Note: Detected labels are stored in the file's appdata.
 Uploadcare::Addons.ws_rekognition_detect_labels('FILE_UUID')
 
@@ -567,7 +567,7 @@ Uploadcare::Addons.ws_rekognition_detect_labels_status('RETURNED_ID_FROM_WS_REKO
 ##### AWS Rekognition Moderation
 
 ```ruby
-# Execute AWS Rekognition Moderation Add-On for a given target to detect moderation labels in an image. 
+# Execute AWS Rekognition Moderation Add-On for a given target to detect moderation labels in an image.
 # Note: Detected moderation labels are stored in the file's appdata.
 
 Uploadcare::Addons.ws_rekognition_detect_moderation_labels('FILE_UUID')
@@ -738,6 +738,20 @@ More examples and options can be found [here](https://uploadcare.com/docs/transf
 ##### Document
 
 After each document file upload you obtain a file identifier in UUID format.
+
+You can use file identifier to determine the document format and possible conversion formats.
+```ruby
+Uploadcare::DocumentConverter.info("dc99200d-9bd6-4b43-bfa9-aa7bfaefca40")
+
+# Response
+{:error=>nil, :format=>{
+  :name=>"jpg",
+  :conversion_formats=>[
+    {:name=>"avif"}, {:name=>"bmp"}, {:name=>"gif"}, {:name=>"ico"}, {:name=>"pcx"}, {:name=>"pdf"}, {:name=>"png"}, {:name=>"ps"}, {:name=>"svg"}, {:name=>"tga"}, {:name=>"thumbnail"}, {:name=>"tiff"}, {:name=>"wbmp"}, {:name=>"webp"}
+  ]
+}}
+```
+
 Then you can use this file identifier to convert your document to a new format:
 
 ```ruby
@@ -841,7 +855,7 @@ You can use custom domain and CDN provider to deliver files with authenticated U
 To generate authenticated URL from the library, you should choose `Uploadcare::SignedUrlGenerators::AkamaiGenerator` (or create your own generator implementation):
 
 ```ruby
-generator = Uploadcare::SignedUrlGenerators::AkamaiGenerator.new(cdn_host: 'example.com', secret_key: 'secret_key') 
+generator = Uploadcare::SignedUrlGenerators::AkamaiGenerator.new(cdn_host: 'example.com', secret_key: 'secret_key')
 # Optional parameters: ttl: 300, algorithm: 'sha256'
 generator.generate_url(uuid, acl = optional)
 
@@ -849,13 +863,13 @@ generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3")
 # https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1649405263~acl=/a7d5645e-5cd7-4046-819f-a6a2933bafe3/~hmac=a989cae5342f17013677f5a0e6577fc5594cc4e238fb4c95eda36634eb47018b
 
 # You can pass in ACL as a second parameter to generate_url. See https://uploadcare.com/docs/security/secure-delivery/#authenticated-urls for supported acl formats
-generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3", '/*/') 
+generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3", '/*/')
 # https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1649405263~acl=/*/~hmac=3ce1152c6af8864b36d4dc721f08ca3cf0b3a20278d7f849e82c6c930d48ccc1
 
 # Optionally you can use wildcard: true to generate a wildcard acl token
 generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3", wildcard: true)
 # https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1714233449~acl=/a7d5645e-5cd7-4046-819f-a6a2933bafe3/*~hmac=a568ee2a85dd90a8a8a1ef35ea0cc0ef0acb84fe81990edd3a06eacf10a52b4e
- 
+
 # You can also pass in a custom ttl and algorithm to AkamaiGenerator
 generator = Uploadcare::SignedUrlGenerators::AkamaiGenerator.new(cdn_host: 'example.com', secret_key: 'secret_key', ttl: 10)
 generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3")

data/api_examples/rest_api/delete_files_storage.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuids = %w[21975c81-7f57-4c7a-aef9-acfe28779f78 cbaf2d73-5169-4b2b-a543-496cf2813dff]
+puts Uploadcare::FileList.batch_delete(uuids)

data/api_examples/rest_api/delete_files_uuid_metadata_key.rb

@@ -0,0 +1,5 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+puts Uploadcare::FileMetadata.delete('1bac376c-aa7e-4356-861b-dd2657b5bfd2', 'pet')

data/api_examples/rest_api/delete_files_uuid_storage.rb

@@ -0,0 +1,5 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+puts Uploadcare::File.delete('1bac376c-aa7e-4356-861b-dd2657b5bfd2')

data/api_examples/rest_api/delete_groups_uuid.rb

@@ -0,0 +1,5 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+puts Uploadcare::Group.delete('c5bec8c7-d4b6-4921-9e55-6edb027546bc~1')

data/api_examples/rest_api/delete_webhooks_unsubscribe.rb

@@ -0,0 +1,5 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+puts Uploadcare::Webhook.delete('https://yourwebhook.com')

data/api_examples/rest_api/get_addons_aws_rekognition_detect_labels_execute_status.rb

@@ -0,0 +1,7 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+request_id = 'd1fb31c6-ed34-4e21-bdc3-4f1485f58e21'
+result = Uploadcare::Addons.ws_rekognition_detect_labels_status(request_id)
+puts result.status

data/api_examples/rest_api/get_addons_aws_rekognition_detect_moderation_labels_execute_status.rb

@@ -0,0 +1,7 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+request_id = 'd1fb31c6-ed34-4e21-bdc3-4f1485f58e21'
+result = Uploadcare::Addons.ws_rekognition_detect_moderation_labels_status(request_id)
+puts result.status

data/api_examples/rest_api/get_addons_remove_bg_execute_status.rb

@@ -0,0 +1,7 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+request_id = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+result = Uploadcare::Addons.remove_bg_status(request_id)
+puts result.status

data/api_examples/rest_api/get_addons_uc_clamav_virus_scan_execute_status.rb

@@ -0,0 +1,7 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+request_id = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+result = Uploadcare::Addons.uc_clamav_virus_scan_status(request_id)
+puts result.status

data/api_examples/rest_api/get_convert_document_status_token.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+token = 32_921_143
+puts Uploadcare::DocumentConverter.status(token)

data/api_examples/rest_api/get_convert_document_uuid.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '740e1b8c-1ad8-4324-b7ec-112c79d8eac2'
+puts Uploadcare::DocumentConverter.info(uuid)

data/api_examples/rest_api/get_convert_video_status_token.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+token = 1_201_016_744
+puts Uploadcare::VideoConverter.status(token)

data/api_examples/rest_api/get_files.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+list = Uploadcare::FileList.file_list(stored: true, removed: false, limit: 100)
+list.each { |file| puts file.inspect }

data/api_examples/rest_api/get_files_uuid.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+puts Uploadcare::File.info(uuid).inspect

data/api_examples/rest_api/get_files_uuid_metadata.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+puts Uploadcare::FileMetadata.show(uuid, 'pet')

data/api_examples/rest_api/get_files_uuid_metadata_key.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+puts Uploadcare::FileMetadata.index(uuid).inspect

data/api_examples/rest_api/get_groups.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+groups = Uploadcare::GroupList.list(limit: 10)
+groups.each { |group| puts group.inspect }

data/api_examples/rest_api/get_groups_uuid.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = 'c5bec8c7-d4b6-4921-9e55-6edb027546bc~1'
+puts Uploadcare::Group.info(uuid).inspect

data/api_examples/rest_api/get_project.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+project_info = Uploadcare::Project.show
+puts project_info.inspect

data/api_examples/rest_api/get_webhooks.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+webhooks = Uploadcare::Webhook.list
+webhooks.each { |webhook| puts webhook.inspect }

data/api_examples/rest_api/post_addons_aws_rekognition_detect_labels_execute.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+Uploadcare::Addons.ws_rekognition_detect_labels(uuid)

data/api_examples/rest_api/post_addons_aws_rekognition_detect_moderation_labels_execute.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+Uploadcare::Addons.ws_rekognition_detect_moderation_labels(uuid)

data/api_examples/rest_api/post_addons_remove_bg_execute.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+Uploadcare::Addons.remove_bg(uuid, crop: true)

data/api_examples/rest_api/post_addons_uc_clamav_virus_scan_execute.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+Uploadcare::Addons.uc_clamav_virus_scan(uuid, purge_infected: true)

data/api_examples/rest_api/post_convert_document.rb

@@ -0,0 +1,9 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+document_params = { uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2', format: :pdf }
+options = { store: '1' }
+# for multipage conversion
+# options = { store: '1', save_in_group: '1' }
+Uploadcare::DocumentConverter.convert(document_params, options)

data/api_examples/rest_api/post_convert_video.rb

@@ -0,0 +1,11 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+video_params = {
+  uuid: '1bac376c-aa7e-4356-861b-dd2657b5bfd2',
+  format: :mp4,
+  quality: :lighter
+}
+options = { store: true }
+Uploadcare::VideoConverter.convert(video_params, options)

data/api_examples/rest_api/post_files_local_copy.rb

@@ -0,0 +1,7 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+source = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+copied_file = Uploadcare::File.local_copy(source, store: true)
+puts copied_file.uuid

data/api_examples/rest_api/post_files_remote_copy.rb

@@ -0,0 +1,8 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+source_object = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+target = 'custom_storage_connected_to_the_project'
+copied_file_url = Uploadcare::File.remote_copy(source_object, target, make_public: true)
+puts copied_file_url

data/api_examples/rest_api/post_webhooks.rb

@@ -0,0 +1,10 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+options = {
+  target_url: 'https://yourwebhook.com',
+  event: 'file.uploaded',
+  is_active: true
+}
+Uploadcare::Webhook.create(**options)

data/api_examples/rest_api/put_files_storage.rb

@@ -0,0 +1,9 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuids = %w[
+  b7a301d1-1bd0-473d-8d32-708dd55addc0
+  1bac376c-aa7e-4356-861b-dd2657b5bfd2
+]
+Uploadcare::FileList.batch_store(uuids)

data/api_examples/rest_api/put_files_uuid_metadata_key.rb

@@ -0,0 +1,8 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+key = 'pet'
+value = 'dog'
+Uploadcare::FileMetadata.update(uuid, key, value)

data/api_examples/rest_api/put_files_uuid_storage.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '1bac376c-aa7e-4356-861b-dd2657b5bfd2'
+Uploadcare::File.store(uuid)

data/api_examples/rest_api/put_webhooks_id.rb

@@ -0,0 +1,12 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+webhook_id = 1_473_151
+options = {
+  target_url: 'https://yourwebhook.com',
+  event: 'file.uploaded',
+  is_active: true,
+  signing_secret: 'webhook-secret'
+}
+Uploadcare::Webhook.update(webhook_id, options)

data/api_examples/upload_api/get_from_url_status.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+token = '945ebb27-1fd6-46c6-a859-b9893712d650'
+puts Uploadcare::Uploader.get_upload_from_url_status(token)

data/api_examples/upload_api/get_group_info.rb

@@ -0,0 +1,7 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '0d712319-b970-4602-850c-bae1ced521a6~1'
+info = Uploadcare::Group.info(uuid)
+puts info.inspect

data/api_examples/upload_api/get_info.rb

@@ -0,0 +1,7 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuid = '740e1b8c-1ad8-4324-b7ec-112c79d8eac2'
+info = Uploadcare::File.info(uuid)
+puts info.inspect

data/api_examples/upload_api/post_base.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+source_file = File.open('image.png')
+Uploadcare::Uploader.upload(source_file, store: 'auto')

data/api_examples/upload_api/post_from_url.rb

@@ -0,0 +1,6 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+source_url = 'https://source.unsplash.com/featured'
+Uploadcare::Uploader.upload(source_url, store: 'auto')

data/api_examples/upload_api/post_group.rb

@@ -0,0 +1,9 @@
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+uuids = [
+  'd6d34fa9-addd-472c-868d-2e5c105f9fcd',
+  'b1026315-8116-4632-8364-607e64fca723/-/resize/x800/'
+]
+Uploadcare::Group.create(uuids)

data/api_examples/upload_api/post_multipart_complete.rb

@@ -0,0 +1,8 @@
+# Uploadcare lib provides high level API for multipart uploads that does everything for you
+
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+source_file = File.open('image.png')
+Uploadcare::Uploader.upload(source_file, store: 'auto')

data/api_examples/upload_api/post_multipart_start.rb

@@ -0,0 +1,8 @@
+# Uploadcare lib provides high level API for multipart uploads that does everything for you
+
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+source_file = File.open('image.png')
+Uploadcare::Uploader.upload(source_file, store: 'auto')

data/api_examples/upload_api/put_presigned_url_x.rb

@@ -0,0 +1,8 @@
+# Uploadcare lib provides high level API for multipart uploads that does everything for you
+
+require 'uploadcare'
+Uploadcare.config.public_key = 'YOUR_PUBLIC_KEY'
+Uploadcare.config.secret_key = 'YOUR_SECRET_KEY'
+
+source_file = File.open('image.png')
+Uploadcare::Uploader.upload(source_file, store: 'auto')

data/lib/uploadcare/client/conversion/base_conversion_client.rb

@@ -50,7 +50,8 @@ module Uploadcare
                 **build_paths_body(params)
               )
             end,
-            store: options[:store]
+            store: options[:store],
+            save_in_group: options[:save_in_group]
           }.compact.to_json
         end
       end

data/lib/uploadcare/client/conversion/document_conversion_client.rb

@@ -22,6 +22,10 @@ module Uploadcare
           get(uri: "/convert/document/status/#{token}/")
         end
 
+        def document_info(uuid)
+          get(uri: "/convert/document/#{uuid}/")
+        end
+
         private
 
         def convert_uri

data/lib/uploadcare/client/multipart_upload_client.rb

@@ -47,7 +47,7 @@ module Uploadcare
       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,

data/lib/uploadcare/entity/conversion/base_converter.rb

@@ -23,6 +23,13 @@ module Uploadcare
             conversion_client.new.get_conversion_status(token)
           end
 
+          # Returns the document format and possible conversion formats.
+          #
+          # @param uuid [String] UUID of the document
+          def info(uuid)
+            conversion_client.new.document_info(uuid)
+          end
+
           private
 
           def conversion_client

data/lib/uploadcare/entity/file.rb

@@ -64,8 +64,7 @@ module Uploadcare
       #
       # @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}

data/lib/uploadcare/param/authentication_header.rb

@@ -23,8 +23,8 @@ module Uploadcare
       end
 
       def self.validate_auth_config
-        raise AuthError, 'Public Key is blank.' if is_blank?(Uploadcare.config.public_key)
-        raise AuthError, 'Secret Key is blank.' if is_blank?(Uploadcare.config.secret_key)
+        raise Uploadcare::Exception::AuthError, 'Public Key is blank.' if is_blank?(Uploadcare.config.public_key)
+        raise Uploadcare::Exception::AuthError, 'Secret Key is blank.' if is_blank?(Uploadcare.config.secret_key)
       end
 
       # rubocop:disable Naming/PredicateName

data/lib/uploadcare/ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uploadcare
-  VERSION = '4.4.1'
+  VERSION = '4.4.3'
 end

data/lib/uploadcare/signed_url_generators/akamai_generator.rb

@@ -35,12 +35,17 @@ module Uploadcare
 
       def build_acl(uuid, acl, wildcard: false)
         if wildcard
-          "/#{sanitized_string(uuid)}/*"
+          "/#{sanitized_delimiter_path(uuid)}/*"
         else
-          "/#{sanitized_string(acl)}/"
+          "/#{sanitized_delimiter_path(acl)}/"
         end
       end
 
+      # Delimiter sanitization referenced from: https://github.com/uploadcare/pyuploadcare/blob/main/pyuploadcare/secure_url.py#L74
+      def sanitized_delimiter_path(path)
+        sanitized_string(path).gsub('~') { |escape_char| "%#{escape_char.ord.to_s(16).downcase}" }
+      end
+
       def build_expire
         (Time.now.to_i + ttl).to_s
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uploadcare-ruby
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.4.3
 platform: ruby
 authors:
 - "@dmitrijivanchenko (Dmitrij Ivanchenko), @T0mbery (Andrey Aksenov)"
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-28 00:00:00.000000000 Z
+date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimemagic
@@ -93,6 +93,48 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- api_examples/rest_api/delete_files_storage.rb
+- api_examples/rest_api/delete_files_uuid_metadata_key.rb
+- api_examples/rest_api/delete_files_uuid_storage.rb
+- api_examples/rest_api/delete_groups_uuid.rb
+- api_examples/rest_api/delete_webhooks_unsubscribe.rb
+- api_examples/rest_api/get_addons_aws_rekognition_detect_labels_execute_status.rb
+- api_examples/rest_api/get_addons_aws_rekognition_detect_moderation_labels_execute_status.rb
+- api_examples/rest_api/get_addons_remove_bg_execute_status.rb
+- api_examples/rest_api/get_addons_uc_clamav_virus_scan_execute_status.rb
+- api_examples/rest_api/get_convert_document_status_token.rb
+- api_examples/rest_api/get_convert_document_uuid.rb
+- api_examples/rest_api/get_convert_video_status_token.rb
+- api_examples/rest_api/get_files.rb
+- 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_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/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
+- api_examples/rest_api/post_addons_uc_clamav_virus_scan_execute.rb
+- api_examples/rest_api/post_convert_document.rb
+- 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_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_webhooks_id.rb
+- api_examples/upload_api/get_from_url_status.rb
+- api_examples/upload_api/get_group_info.rb
+- api_examples/upload_api/get_info.rb
+- api_examples/upload_api/post_base.rb
+- api_examples/upload_api/post_from_url.rb
+- api_examples/upload_api/post_group.rb
+- api_examples/upload_api/post_multipart_complete.rb
+- api_examples/upload_api/post_multipart_start.rb
+- api_examples/upload_api/put_presigned_url_x.rb
 - bin/console
 - bin/setup
 - lib/uploadcare.rb
@@ -177,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for uploadcare API