buckler 1.0.0

data/lib/buckler/actions/destroy_bucket.rb

@@ -0,0 +1,22 @@
+module Buckler
+
+  def self.destroy_bucket!(name:, confirmation:nil)
+
+    connect_to_s3!
+    @bucket = get_bucket!(name)
+    require_confirmation!(name_required:name, confirmation:confirmation)
+
+    if @bucket.versioning.status == "Enabled"
+      log "The bucket #{name.bucketize} has versioning enabled, it cannot be deleted."
+      log "You must disable versioning in the AWS Mangement Console."
+      exit false
+    end
+
+    log "Destroying bucket #{name.bucketize}…"
+    @bucket.delete!(max_attempts:3)
+    log "Bucket #{name.bucketize} was destroyed ✔"
+    exit true
+
+  end
+
+end

data/lib/buckler/actions/empty_bucket.rb

@@ -0,0 +1,16 @@
+module Buckler
+
+  def self.empty_bucket!(name:, confirmation:nil)
+
+    connect_to_s3!
+    @bucket = get_bucket!(name)
+    require_confirmation!(name_required:name, confirmation:confirmation)
+
+    log "Deleting all objects in bucket #{name.bucketize}…"
+    @bucket.clear!
+    log "Bucket #{name.bucketize} is now empty ✔"
+    exit true
+
+  end
+
+end

data/lib/buckler/actions/list_buckets.rb

@@ -0,0 +1,21 @@
+module Buckler
+
+  def self.list_buckets!
+
+    connect_to_s3!
+
+    verbose "Fetching buckets visible to #{@aws_access_key_id}…"
+    table = [["NAME", "REGION", "VERSIONING"]]
+
+    @s3.list_buckets.buckets.each do |bucket|
+      region = @s3.get_bucket_location(bucket:bucket.name).location_constraint.presence || "us-east-1"
+      versioning = @s3.get_bucket_versioning(bucket:bucket.name).status.presence || "Not Configured"
+      table << [bucket.name, region, versioning]
+    end
+
+    puts_table!(table)
+    exit true
+
+  end
+
+end

data/lib/buckler/actions/list_regions.rb

@@ -0,0 +1,23 @@
+module Buckler
+
+  def self.list_regions!
+
+    table = [["REGION", "NAME", nil]]
+
+    S3_BUCKET_REGIONS.each do |name, human_name|
+      case name
+      when "us-east-1"
+        table << [name, human_name, "Default region"]
+      when "cn-north-1"
+        table << [name, human_name, "Requires chinese account"]
+      else
+        table << [name, human_name, nil]
+      end
+    end
+
+    puts_table!(table)
+    exit true
+
+  end
+
+end

data/lib/buckler/actions/sync_buckets.rb

@@ -0,0 +1,106 @@
+module Buckler
+
+  def self.sync_buckets!(source_name:, target_name:, confirmation:nil)
+
+    unless source_name.present? && target_name.present?
+      alert "You must provide both a source bucket and a target bucket"
+      alert "Usage: bucket sync <source-bucket> <target-bucket>"
+      exit false
+    end
+
+    unless source_name != target_name
+      alert "The source bucket name and target bucket name must be different"
+      exit false
+    end
+
+    connect_to_s3!
+    @source_bucket = get_bucket!(source_name)
+    @target_bucket = get_bucket!(target_name)
+
+    source_name = @source_bucket.name.bucketize(:pink).freeze
+    target_name = @target_bucket.name.bucketize.freeze
+
+    require_confirmation!(name_required:@target_bucket.name, confirmation:confirmation, additional_lines:[
+      "The contents of #{source_name} will be synced into #{target_name}.",
+      "Objects in #{target_name} that aren’t in the source bucket will be removed.",
+    ])
+
+    log "Syncing #{source_name} into #{target_name}…"
+    log "Fetching bucket file lists…"
+
+    @source_bucket_keys = @source_bucket.objects.collect(&:key)
+    @target_bucket_keys = @target_bucket.objects.collect(&:key)
+
+    # -------------------------------------------------------------------------
+    # Delete bucket differences
+    # -------------------------------------------------------------------------
+
+    @keys_to_delete = @target_bucket_keys - @source_bucket_keys
+
+    @dispatch = Buckler::ThreadDispatch.new
+
+    log "Deleting unshared objects from target bucket…"
+
+    @keys_to_delete.lazy.each do |key|
+      @dispatch.queue(lambda {
+        log "Deleting #{target_name}/#{key}"
+        @target_bucket.object(key).delete
+      })
+    end
+
+    time_elapsed = @dispatch.perform_and_wait
+    log "Unshared objects deleted from target bucket (#{time_elapsed} seconds) ✔"
+
+    # -------------------------------------------------------------------------
+    # Sync files
+    # -------------------------------------------------------------------------
+
+    @dispatch = Buckler::ThreadDispatch.new
+
+    @source_bucket_keys.lazy.each do |object_key|
+
+      @dispatch.queue(lambda {
+
+        source_object = Aws::S3::Object.new(@source_bucket.name, object_key, client:@s3)
+        target_object = Aws::S3::Object.new(@target_bucket.name, object_key, client:@s3)
+
+        options = {
+          storage_class: source_object.storage_class,
+          metadata: source_object.metadata,
+          content_encoding: source_object.content_encoding,
+          content_language: source_object.content_language,
+          content_type: source_object.content_type,
+          cache_control: source_object.cache_control,
+          expires: source_object.expires,
+        }
+
+        if source_object.content_disposition.present?
+          options[:content_disposition] = ActiveSupport::Inflector.transliterate(source_object.content_disposition, "")
+        end
+
+        if source_object.content_length > 5242882 # 5 megabytes + 2 bytes
+          options[:multipart_copy] = true
+          options[:content_length] = source_object.content_length
+        end
+
+        target_object.copy_from(source_object, options)
+        target_object.acl.put({
+          access_control_policy: {
+            grants: source_object.acl.grants,
+            owner: source_object.acl.owner,
+          }
+        })
+
+        log "Copied #{source_name} → #{target_name}/#{object_key}"
+
+      })
+
+    end
+
+    time_elapsed = @dispatch.perform_and_wait
+    log "#{@source_bucket_keys.count} objects synced in #{target_name} (#{time_elapsed} seconds) ✔"
+    exit true
+
+  end
+
+end

data/lib/buckler/aws.rb

@@ -0,0 +1,81 @@
+module Buckler
+
+  # Returns the discovered AWS Access Key ID
+  # Prerequisite: `Buckler.discover_aws_credentials!`
+  def self.aws_access_key_id
+    @aws_access_key_id
+  end
+
+  # Returns an Aws::S3::Client in the given `region`
+  # Prerequisite: `Buckler.discover_aws_credentials!`
+  def self.connect_to_s3!(region:"us-east-1")
+    return @s3 if @s3.present?
+    @s3 = Aws::S3::Client.new(
+      region: region,
+      access_key_id: @aws_access_key_id,
+      secret_access_key: @aws_secret_access_key,
+    )
+    return @s3
+  end
+
+  # Attempts to find the AWS Access Key ID and Secret Access Key
+  # by searching the command line paramters, the environment, the .env, and Heroku in that order.
+  # The parameters are the values of --id and --secret on the command line.
+  # The program ends if credentials cannot be discovered.
+  def self.discover_aws_credentials!(key_id:nil, key:nil)
+
+    verbose "Attempting to find AWS credentials…"
+
+    # Try to find keys as command line parameters, if the invoker has set them directly
+    if key_id.present? && key.present?
+      verbose "The Access Key ID and Secret Access Key were set as command line options ✔"
+      @aws_access_key_id = key_id
+      @aws_secret_access_key = key
+      return true
+    end
+
+    # Try to find keys in the current environment, if the invoker has set them directly
+    key_id = ENV["AWS_ACCESS_KEY_ID"]
+    key = ENV["AWS_SECRET_ACCESS_KEY"]
+    if key_id.present? && key.present?
+      verbose "AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY found as environment variables ✔"
+      @aws_access_key_id = key_id
+      @aws_secret_access_key = key
+      return true
+    end
+
+    # Try to find keys in a .env file in this directory
+    Dotenv.load
+    key_id = ENV["AWS_ACCESS_KEY_ID"]
+    key = ENV["AWS_SECRET_ACCESS_KEY"]
+    if key_id.present? && key.present?
+      verbose "AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY found in the .env file ✔"
+      @aws_access_key_id = key_id
+      @aws_secret_access_key = key
+      return true
+    end
+
+    # Try to find keys by asking Heroku about the project in this directory
+    if heroku_available?
+      key_id = heroku_config_get("AWS_ACCESS_KEY_ID")
+      key = heroku_config_get("AWS_SECRET_ACCESS_KEY")
+      if key_id.present? && key.present?
+        verbose "AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY found on your Heroku application ✔"
+        @aws_access_key_id = key_id
+        @aws_secret_access_key = key
+        return true
+      end
+    end
+
+    alert "Could not discover any AWS credentials."
+    alert "Set command line options --id and --secret"
+    alert "Or, set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as environment variables."
+    alert "Or, set them in a .env file in this directory."
+    if heroku_available?
+      alert "Or, set them on a Heroku application in this directory with `heroku config:set`."
+    end
+    exit false
+
+  end
+
+end

data/lib/buckler/commands.rb

@@ -0,0 +1,271 @@
+module Buckler::Commands; end
+
+Buckler::Commands::Root = Cri::Command.define do
+
+  name "bucket"
+  usage "bucket <command> [options]"
+  summary "peform common actions on Amazon S3 buckets"
+  description %{
+    Buckler allows you perform common actions on your Amazon S3 buckets.
+
+    Run #{"bucket help <command>".bold} for more information about the commands below.
+
+    You will need a AWS Access Key ID and AWS Secret Access Key pair with
+    permission to mange your S3 buckets. Do not use your root keys.
+    Generate a new set of keys with S3 permissions only.
+    https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#lock-away-credentials
+
+    When you run the bucket command, Buckler tries to automatically
+    discover AWS credentials around your working directory.
+
+    #{"Dotenv:".bold} If the current folder has a file named .env, Buckler will look
+    for variables called AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY in the file.
+    See Heroku’s documentation on this environment file format.
+    https://devcenter.heroku.com/articles/heroku-local#set-up-your-local-environment-variables
+
+    #{"Heroku:".bold} If the current folder has a Git repository with a Heroku remote,
+    Buckler will ask your Heroku application for variables
+    named AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY using heroku config:get
+
+    #{"Command Line:".bold} You can set the pair directly by providing the
+    command line options --id and --secret:
+
+    bucket list --id YOUR_AWS_ID --secret YOUR_AWS_SECRET
+
+    #{"Environment:".bold} You can set the pair directly as environment variables.
+
+    AWS_ACCESS_KEY_ID=your-id AWS_SECRET_ACCESS_KEY=your-secret bucket list
+  }
+
+  flag :v, :verbose, "Output additional information for all commands"
+  option nil, :id, "Your AWS Access Key ID", argument: :required
+  option nil, :secret, "Your AWS Secret Access Key", argument: :required
+
+  run do |opts, args, cmd|
+    puts Buckler::Commands::Root.help
+  end
+
+end
+
+Buckler::Commands::Version = Cri::Command.define do
+
+  name "version"
+  usage "version"
+  summary "Print Buckler’s version"
+  description %{
+    Prints Buckler’s version number.
+  }
+
+  run do |opts, args, cmd|
+    log Buckler::VERSION::STRING
+  end
+
+end
+
+Buckler::Commands::Regions = Cri::Command.define do
+
+  name "regions"
+  usage "regions"
+  summary "list all Amazon S3 regions"
+  description %{
+    Prints a list of all Amazon S3 bucket region names and where they are on Earth.
+
+    When creating buckets, you should select the region that is
+    closest to the users or computers that will be using the bucket.
+
+    Heroku applications in Heroku’s America region should use Amazon region us-east-1.
+
+    Heroku applications in Heroku’s Europe region should use Amazon region eu-west-1.
+  }
+
+  run do |opts, args, cmd|
+    Buckler.list_regions!
+  end
+
+end
+
+Buckler::Commands::List = Cri::Command.define do
+
+  name "list"
+  usage "list"
+  summary "List all buckets on your account"
+  description %{
+    Prints a list of all Amazon S3 buckets on your account.
+
+    “All” may be releative, AWS access keys can be generated without
+    the power to see every bucket available to the master keys.
+  }
+
+  run do |opts, args, cmd|
+    $buckler_verbose_mode = true if opts[:verbose].present?
+    Buckler.discover_aws_credentials!(key_id:opts[:id], key:opts[:secret])
+    Buckler.list_buckets!
+  end
+
+end
+
+Buckler::Commands::Create = Cri::Command.define do
+
+  name "create"
+  usage "create <bucket-name>"
+  summary "Create a new bucket"
+  description %{
+    Creates a new bucket on your Amazon S3 account with the given name.
+    The bucket will be empty. The bucket is created in AWS region us-east-1 unless
+    you specify a different region with the --region option.
+    Get a list of all valid regions with `Buckler regions`.
+
+    For maximum compatability, Amazon always recomends that you use
+    DNS and TLS-safe bucket names,
+    which contain only the ASCII characters a-z, 0-9, or the hypen (-)
+
+    Bucket names with dots or uppercase letters may be unable
+    to use certain Amazon Web Service features.
+
+    Some example good bucket names:
+    your-project-name,
+    your-project-name-staging,
+    and your-project-name-dev1
+
+    For more information:
+    http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html
+  }
+
+  option :r, :region, "The AWS region where the bucket should be created (default: us-east-1)", argument: :required
+
+  run do |opts, args, cmd|
+    $buckler_verbose_mode = true if opts[:verbose].present?
+    Buckler.discover_aws_credentials!(key_id:opts[:id], key:opts[:secret])
+    Buckler.create_bucket!(name:args.first.to_s, region:opts[:region])
+  end
+
+end
+
+Buckler::Commands::Empty = Cri::Command.define do
+
+  name "empty"
+  usage "empty <bucket-name>"
+  summary "Delete all files in a bucket"
+  description %{
+    Discards all objects in the target bucket. The result will be an empty bucket.
+
+    If you have not set up versioning for your bucket,
+    or you have not set up Amazon Glacier backups for your bucket,
+    you will be unable to recover any deleted objects.
+
+    For more information:
+    https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-or-empty-bucket.html
+  }
+
+  option :c, :confirm, "Confirm destructive actions without prompting", argument: :required
+
+  run do |opts, args, cmd|
+    $buckler_verbose_mode = true if opts[:verbose].present?
+    Buckler.discover_aws_credentials!(key_id:opts[:id], key:opts[:secret])
+    Buckler.empty_bucket!(name:args.first.to_s, confirmation:opts[:confirm])
+  end
+
+end
+
+Buckler::Commands::Destroy = Cri::Command.define do
+
+  name "destroy"
+  usage "destroy <bucket-name>"
+  summary "Delete all files in a bucket and remove it"
+  description %{
+    Discards all objects in the target bucket and then removes
+    the bucket from Amazon S3.
+
+    Amazon may not immediately make the bucket name
+    available for use again.
+
+    You CANNOT delete a bucket that has versioning enabled.
+    You must first disable versioning on the AWS Mangement Console.
+
+    For more information:
+    https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-or-empty-bucket.html
+    https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html
+  }
+
+  option :c, :confirm, "Confirm destructive actions without prompting", argument: :required
+
+  run do |opts, args, cmd|
+    $buckler_verbose_mode = true if opts[:verbose].present?
+    Buckler.discover_aws_credentials!(key_id:opts[:id], key:opts[:secret])
+    Buckler.destroy_bucket!(name:args.first.to_s, confirmation:opts[:confirm])
+  end
+
+end
+
+Buckler::Commands::Sync = Cri::Command.define do
+
+  name "sync"
+  usage "sync <source-bucket> <target-bucket>"
+  summary "Copy the contents of one bucket into another"
+  description %{
+    Copies all objects in the source bucket into the target bucket.
+    Objects in the target bucket that don’t exist in the source bucket will be deleted.
+    The end result will be two buckets with identical objects.
+
+    The following properties on each object are also transfered:
+    ACLs,
+    Amazon S3 metadata,
+    Amazon S3 storage class,
+    Cache-Control header,
+    Content-Type header,
+    Content-Encoding header,
+    Content-Disposition header,
+    Content-Language header,
+    and Expires header.
+
+    The source bucket will not be changed.
+
+    If you have not set up versioning for your bucket,
+    or you have not set up Amazon Glacier archives for your bucket,
+    you will be unable to recover any objects deleted from the target bucket.
+  }
+
+  option :c, :confirm, "Confirm destructive actions without prompting", argument: :required
+
+  run do |opts, args, cmd|
+    $buckler_verbose_mode = true if opts[:verbose].present?
+    Buckler.discover_aws_credentials!(key_id:opts[:id], key:opts[:secret])
+    Buckler.sync_buckets!(source_name:args.first.to_s, target_name:args.second.to_s, confirmation:opts[:confirm])
+  end
+
+end
+
+Buckler::Commands::Help = Cri::Command.define do
+  name "help"
+  usage "buckler help"
+  summary "Show help for a command"
+  description "x"
+  run do |opts, args, cmd|
+    case args.first.to_s
+    when "list"
+      puts Buckler::Commands::List.help
+    when "regions"
+      puts Buckler::Commands::Regions.help
+    when "create"
+      puts Buckler::Commands::Create.help
+    when "empty"
+      puts Buckler::Commands::Empty.help
+    when "destroy"
+      puts Buckler::Commands::Destroy.help
+    when "sync"
+      puts Buckler::Commands::Sync.help
+    else
+      puts Buckler::Commands::Root.help
+    end
+    exit true
+  end
+end
+
+Buckler::Commands::Root.add_command(Buckler::Commands::Version)
+Buckler::Commands::Root.add_command(Buckler::Commands::Help)
+Buckler::Commands::Root.add_command(Buckler::Commands::Regions)
+Buckler::Commands::Root.add_command(Buckler::Commands::List)
+Buckler::Commands::Root.add_command(Buckler::Commands::Create)
+Buckler::Commands::Root.add_command(Buckler::Commands::Empty)
+Buckler::Commands::Root.add_command(Buckler::Commands::Destroy)
+Buckler::Commands::Root.add_command(Buckler::Commands::Sync)