Ruby API Client

1
gem 'uploadcare-ruby'

1
# Preferred: explicit client
2
client = Uploadcare::Client.new(
3
  public_key: ENV.fetch('UPLOADCARE_PUBLIC_KEY'),
4
  secret_key: ENV.fetch('UPLOADCARE_SECRET_KEY')
5
)
6
7
# Alternative: global configuration (still supported)
8
Uploadcare.configure do |config|
9
  config.public_key = ENV.fetch('UPLOADCARE_PUBLIC_KEY')
10
  config.secret_key = ENV.fetch('UPLOADCARE_SECRET_KEY')
11
end

1
require 'uploadcare'
2
3
client = Uploadcare::Client.new(
4
  public_key: ENV.fetch('UPLOADCARE_PUBLIC_KEY'),
5
  secret_key: ENV.fetch('UPLOADCARE_SECRET_KEY')
6
)
7
8
file = File.open('image.png', 'rb') do |io|
9
  client.files.upload(io, store: 'auto')
10
end

1
file = client.files.upload_from_url("https://example.com/image.jpg", store: true)
2
puts file.cdn_url

1
File.open('big_file.bin', 'rb') do |io|
2
  file = client.uploads.multipart_upload(file: io, store: true)
3
  puts file.uuid
4
end

1
file = client.files.find(uuid: 'YOUR_FILE_UUID')
2
puts file.mime_type

1
webhook = client.webhooks.create(
2
  target_url: "https://example.com/callback",
3
  event: "file.uploaded",
4
  is_active: true
5
)
6
puts webhook.id

1
@uc_file = File.open('your-file.png', 'rb') do |io|
2
  client.files.upload(io, store: true)
3
end
4
5
puts @uc_file.uuid
6
puts @uc_file.cdn_url

1
# Smart upload: accepts an IO, array of IOs, or a URL string
2
client.uploads.upload('https://example.com/image.jpg')
3
4
# Multiple files
5
client.uploads.upload([file1, file2], store: true)
6
7
# URL upload
8
client.files.upload_from_url('https://example.com/image.jpg', store: true)
9
10
# Multipart upload for large files
11
File.open('big_file.bin', 'rb') do |io|
12
  client.uploads.multipart_upload(file: io, store: true)
13
end

1
client.uploads.upload(files, store: true)
2
client.files.upload_from_url(url, store: 'auto')

1
client.uploads.upload('https://example.com/image.jpg')

1
@file = client.files.find(uuid: 'FILE_UUID')
2
# => #<Uploadcare::Resources::File ...>
3
4
# Metadata is read through accessor methods, not hash keys:
5
@file.uuid              # => "8f64f313-e6b1-4731-96c0-6751f1e7a50a"
6
@file.mime_type         # => "image/jpeg"
7
@file.size              # => 5345
8
@file.is_image          # => true
9
@file.is_ready          # => true
10
@file.original_filename # => "image.jpeg"
11
@file.datetime_uploaded # => "2020-01-16T15:03:14.676902Z"
12
@file.datetime_stored   # => "2020-01-16T15:03:15.315064Z"
13
@file.datetime_removed  # => nil
14
@file.url               # => "https://api.uploadcare.com/files/FILE_UUID/"
15
@file.cdn_url           # => "https://PROJECT_SUBDOMAIN.ucarecd.net/FILE_UUID/image.jpeg"
16
@file.content_info      # => { "mime" => { "mime" => "image/jpeg", "type" => "image", "subtype" => "jpeg" },
17
                        #      "image" => { "width" => 190, "height" => 183, "format" => "JPEG",
18
                        #                   "color_mode" => "RGB", "dpi" => nil, "orientation" => nil } }
19
@file.metadata          # => {}  custom key/value metadata you attach to the file
20
@file.appdata           # => {}  add-on results (virus scan, moderation, etc.)

1
@file.copy_to_local(options: { store: true })
2
@file.copy_to_remote(target: "custom_storage")
3
4
@file.store #stores file, returns updated metadata
5
6
@file.delete #deletes file. Returns updated metadata

1
@list = client.files.list(limit: 100)
2
@list.each { |file| puts file.uuid }
3
4
# Paginate
5
@list.next_page
6
@list.previous_page
7
8
# Load all pages
9
@all_files = @list.all