better_s3's Introduction

better_s3

An idiomatic pattern for working with s3 in Ruby

Get the contents of a remote file

require "better_s3"
s3 = BetterS3.new
s3.get "some-filename.txt"
 => "filescontentshere"

Delete local copy of remote file

When downloading files from s3 there are benefits associated with storing a copy locally (most notably it enables retry during download). As such BetterS3 stores a copy of files you get locally. If you want to delete one ...

require "better_s3"
s3 = BetterS3.new
s3.delete_local_file_copy "some-filename.txt"

Put an arbitrary String to a remote file

require "better_s3"
s3 = BetterS3.new
content = { foo: "bar" }.to_json
s3.put "filename.ext", content

Override the client's bucket name

If you need to change buckets, you don't have to create a new client or modify the configuration.

require "better_s3"
BetterS3.configure do |c|
    c.bucket = "bucketname"
end
s3 = BetterS3.new
s3.bucket
 => "bucketname"
s3.bucket = "otherbucket"
s3.bucket
 => "otherbucket"
BetterS3.configuration.bucket
 => "bucketname"

Configuration

To configure BetterS3 use the configuration block pattern

require "better_s3"
BetterS3.configure do |config|
    # The name of the S3 bucket you plan to interact with
    config.bucket = "your-bucket-name"
    
    # The local path you want to use for temporary file
    # storage
    config.tmp_dir_path = "../tmp"
    
    # If you want to hardcode which region of SQS should be used then you can set this option. It is recommended
    # to use the environment variable ENV["AWS_REGION"] instead
    config.region = "us-west-2"
    
    # for aws_access_key_id and aws_secret_access_key you can set them in this fashion, but it is strongly
    # recommended that you just use the environment variables instead: ENV["AWS_ACCESS_KEY_ID"], 
    # ENV["AWS_SECRET_ACCESS_KEY"]
end

Recommend Projects