Unofficial AWS SDK integration for Crystal.
Status: This is still very much WIP (Work in Progress).
Add this to your application's shard.yml
:
dependencies:
aws:
github: sdogruyol/aws
require "aws"
KEY = "your-aws-key"
SECRET = "your-aws-secret"
REGION = "eu-west-1"
client = Aws::Sqs::Client.new(REGION, KEY, SECRET)
# Create a queue first
client.create_queue("sqs-crystal")
# Send a message to previously created queue
client.send_message("sqs-crystal", "Hi from Crystal!")
client = Aws::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 = Aws::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 = Aws::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 # => true
client = Client.new("region", "key", "secret")
resp = client.create_bucket("test")
resp # => true
resp = 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 # => true
resp = client.head_bucket("bucket_name")
resp # => true
Raises an exception if bucket does not exist.
resp = client.batch_delete("bucket_name", ["key1", "key2"])
resp.success? # => true
resp = client.put_object("bucket_name", "object_key")
resp.body # => myobjectbody
client.list_objects("bucket_name").each do |resp|
p resp.contents.map(&.key)
end
uploader = Aws::S3::FileUploader.new(client)
File.open(File.expand_path("myfile"), "r") do |file|
puts uploader.upload("bucket_name", "someobjectkey", file)
end
You can also pass additional headers (e.g. metadata):
uploader = Aws::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"})
end
form = Aws::S3::Presigned::Form.build("us-east-1", "access key", "secret key") do |form|
form.expiration(Time.utc_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")
end
You may use version 2 request signing via
form = Aws::S3::Presigned::Form.build("us-east-1", "access key", "secret key", signer: :v2) do |form|
...
end
Converting the form to raw HTML (for browser uploads, etc).
puts form.to_html
Submitting the form.
data = IO::Memory.new("Hello, S3!")
form.submit(data)
options = Aws::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 = Aws::S3::Presigned::Url.new(options)
p url.for(:put)
You may use version 2 request signing via
options = Aws::S3::Presigned::Url::Options.new(
aws_access_key: "key",
aws_secret_key: "secret",
region: "us-east-1",
object: "test.txt",
bucket: "mybucket",
signer: :v2
)
- Fork it (https://github.com/sdogruyol/aws/fork)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
- sdogruyol Serdar Dogruyol - creator, maintainer
Thanks to @taylorfinnell for his work on https://github.com/taylorfinnell/awscr-signer and https://github.com/taylorfinnell/awscr-s3.