s3-list-buckets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1b62a416e731b81b585b94ea0b6d438ade56fc7
+  data.tar.gz: 226b73bb87bdde5c157743c5a9a87799ae80c388
+SHA512:
+  metadata.gz: 846915c1e8679430b42d5582802a4269e79022e29d0c03c9ac3849b56c3b9b19d4744250682b6f223561631f56d32ad31977bc2c2cbd0e67084cc18d073cb2e8
+  data.tar.gz: cabceda215be9a0a96a0c06dce766602631432ae03351265d1d969c808a434c2326d72bb026154cd102a7a3667d81dd9a4e6e4cd8a1be14a54a2de9f92693956

data/bin/s3-list-buckets

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require 's3-list-buckets'
+
+config = S3ListBuckets::Config.new
+
+opts_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: s3-list-buckets [OPTIONS] [PATTERN ...]"
+  opts.separator ""
+  opts.on("-l", "--location", "Show the location") do
+    config.show_location = true
+  end
+  opts.on("-j", "--json", "Show output in json format") do
+    config.json_format = true
+  end
+  opts.separator ""
+  opts.separator <<-EOF
+If one or more PATTERNs are given, a bucket is only shown if the bucket name
+matches at least one PATTERN (each of which is implicitly prefixed by "^", the
+start-of-string pattern).
+
+Examples:
+
+  # Show all your buckets (just bucket names):
+  s3-list-buckets
+
+  # Show buckets, prefixed by the location constraint
+  s3-list-buckets --location
+
+  # Show names and location constraints of buckets whose names start with "a"
+  # or "b", as json:
+  s3-list-buckets --location --json a b
+
+  EOF
+end
+
+opts_parser.parse!
+
+unless ARGV.empty?
+  config.patterns = ARGV
+end
+
+config.validate
+
+rc = S3ListBuckets::Runner.new(config).run
+exit rc
+
+# eof s3-list-buckets

data/lib/s3-list-buckets.rb

@@ -0,0 +1,4 @@
+require_relative './s3-list-buckets/client.rb'
+require_relative './s3-list-buckets/config.rb'
+require_relative './s3-list-buckets/runner.rb'
+require_relative './s3-list-buckets/version.rb'

data/lib/s3-list-buckets/client.rb

@@ -0,0 +1,25 @@
+module S3ListBuckets
+
+  class Client
+
+    def self.configure
+      Aws.config.merge! core_v2_options
+    end
+
+    def self.core_v2_options
+      {
+	http_proxy: get_proxy,
+	user_agent_suffix: "s3-list-buckets #{VERSION}",
+	# http_wire_trace: true,
+      }
+    end
+
+    def self.get_proxy
+      e = ENV['https_proxy']
+      e = "https://#{e}" if e && !e.empty? && !e.start_with?('http')
+      return e
+    end
+
+  end
+  
+end

data/lib/s3-list-buckets/config.rb

@@ -0,0 +1,21 @@
+module S3ListBuckets
+
+  class Config
+    # Stronger builder pattern would be nice
+    attr_accessor :client_options, :s3_client,
+      :patterns,
+      :show_location,
+      :json_format
+
+    def initialize
+      @client_options = {}
+      @patterns = nil
+      @show_location = false
+      @json_format = false
+    end
+
+    def validate
+    end
+  end
+
+end

data/lib/s3-list-buckets/runner.rb

@@ -0,0 +1,87 @@
+require 'aws-sdk'
+require 'json'
+require 'rosarium'
+
+module S3ListBuckets
+
+  class Runner
+
+    def initialize(config)
+      @config = config
+
+      @config.s3_client ||= begin
+                              effective_options = S3ListBuckets::Client.core_v2_options.merge(config.client_options)
+                              Aws::S3::Client.new(effective_options)
+                            end
+    end
+
+    def promise
+      Rosarium::Promise.execute do
+        @config.s3_client.list_buckets
+      end.then do |response|
+        # list_buckets doesn't paginate so this is relatively simple
+        Rosarium::Promise.all(
+          response.buckets.map {|bucket| promise_bucket bucket}.reject &:nil?
+        )
+      end
+    end
+
+    def promise_bucket(bucket)
+      return nil unless name_matches_patterns?(bucket.name)
+
+      Rosarium::Promise.execute do
+        r = {
+          name: bucket.name,
+          creation_date: bucket.creation_date,
+        }
+
+        if @config.show_location
+          r[:location_constraint] = @config.s3_client.get_bucket_location(bucket: bucket.name).location_constraint
+        end
+
+        r
+      end
+    end
+
+    def name_matches_patterns?(bucket_name)
+      return true if @config.patterns.nil?
+
+      @config.patterns.any? do |pattern|
+        bucket_name.match("^" + pattern)
+      end
+    end
+
+    def display_json(buckets)
+      buckets.each do |bucket|
+        bucket[:creation_date] = bucket[:creation_date].utc.strftime '%Y-%m-%dT%H:%M:%SZ'
+        puts JSON.generate(bucket)
+      end
+    end
+
+    def display_location_text(buckets)
+      unless buckets.empty?
+        width = buckets.map {|d| (d[:location_constraint] || "-").length }.max
+        format = "%-#{width}.#{width}s %s"
+        buckets.each do |d|
+          puts format % [ d[:location_constraint] || "-", d[:name] ]
+        end
+      end
+    end
+
+    def run
+      promise.then do |buckets|
+        if @config.json_format
+          display_json(buckets)
+        elsif @config.show_location
+          display_location_text(buckets)
+        else
+          buckets.each {|bucket| puts bucket[:name]}
+        end
+      end.value!
+
+      0
+    end
+
+  end
+
+end

data/lib/s3-list-buckets/version.rb

@@ -0,0 +1,3 @@
+module S3ListBuckets
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: s3-list-buckets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rachel Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rosarium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: "\n    s3-list-buckets shows the names and (optionally) location constraints
+  of\n    your S3 buckets.\n\n    Options are available to control display of location
+  constraint and json\n    output.\n\n    Respects $https_proxy.\n  "
+email: s3-list-buckets-git@rve.org.uk
+executables:
+- s3-list-buckets
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/s3-list-buckets
+- lib/s3-list-buckets.rb
+- lib/s3-list-buckets/client.rb
+- lib/s3-list-buckets/config.rb
+- lib/s3-list-buckets/runner.rb
+- lib/s3-list-buckets/version.rb
+homepage: https://github.com/rvedotrc/s3-list-buckets
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: List S3 bucket names and their location constraints
+test_files: []