A Crystal shard for S3 and compatible services.
Add this to your application's shard.yml:
dependencies: awscr-s3: github: taylorfinnell/awscr-s3require "awscr-s3"client = Awscr::S3::Client.new("us-east1", "key", "secret")For S3 compatible services, like DigitalOcean Spaces or Minio, you'll need to set a custom endpoint:
client = Awscr::S3::Client.new("nyc3", "key", "secret", endpoint: "https://nyc3.digitaloceanspaces.com")If you wish you wish to you version 2 request signing you may specify the signer
client = Awscr::S3::Client.new("us-east1", "key", "secret", signer: :v2)resp = client.list_buckets resp.buckets # => ["bucket1", "bucket2"]client = Client.new("region", "key", "secret") resp = client.delete_bucket("test") resp # => trueclient = Client.new("region", "key", "secret") resp = client.put_bucket("test") resp # => trueresp = client.put_object("bucket_name", "object_key", "myobjectbody") resp.etag # => ...You can also pass additional headers (e.g. metadata):
client.put_object("bucket_name", "object_key", "myobjectbody", {"x-amz-meta-name" => "myobject"})resp = client.delete_object("bucket_name", "object_key") resp # => trueresp = client.head_bucket("bucket_name") resp # => trueRaises an exception if bucket does not exist.
resp = client.batch_delete("bucket_name", ["key1", "key2"]) resp.success? # => trueresp = client.get_object("bucket_name", "object_key") resp.body # => myobjectbodyclient.list_objects("bucket_name").each do |resp| p resp.contents.map(&.key) enduploader = Awscr::S3::FileUploader.new(client) File.open(File.expand_path("myfile"), "r") do |file| puts uploader.upload("bucket_name", "someobjectkey", file) endYou can also pass additional headers (e.g. metadata):
uploader = Awscr::S3::FileUploader.new(client) File.open(File.expand_path("myfile"), "r") do |file| puts uploader.upload("bucket_name", "someobjectkey", file, {"x-amz-meta-name" => "myobject"}) endform = Awscr::S3::Presigned::Form.build("us-east-1", "access key", "secret key") do |form| form.expiration(Time.unix(Time.now.to_unix + 1000)) form.condition("bucket", "mybucket") form.condition("acl", "public-read") form.condition("key", SecureRandom.uuid) form.condition("Content-Type", "text/plain") form.condition("success_action_status", "201") endYou may use version 2 request signing via
form = Awscr::S3::Presigned::Form.build("us-east-1", "access key", "secret key", signer: :v2) do |form| ... endConverting the form to raw HTML (for browser uploads, etc).
puts form.to_htmlSubmitting the form.
data = IO::Memory.new("Hello, S3!") form.submit(data)options = Awscr::S3::Presigned::Url::Options.new( aws_access_key: "key", aws_secret_key: "secret", region: "us-east-1", object: "test.txt", bucket: "mybucket", additional_options: { "Content-Type" => "image/png" }) url = Awscr::S3::Presigned::Url.new(options) p url.for(:put)You may use version 2 request signing via
options = Awscr::S3::Presigned::Url::Options.new( aws_access_key: "key", aws_secret_key: "secret", region: "us-east-1", object: "test.txt", bucket: "mybucket", signer: :v2 )