heirloom 0.7.4 → 0.8.0

data/CHANGELOG

@@ -1,3 +1,21 @@
+## v0.8.0:
+
+* Change base to bucket prefix through out code base
+* Prevent setup from overwriting existing heirlooms
+* Add human readable format as default for show
+* Included JSON option to show
+* Hide heirloom internal attribts in show
+* Added all option to display all attributes via show
+* Add human readable format as default for list
+* Included JSON option in list
+* Add human readable format as default for catalog
+* Included JSON option in catalog
+* Add name filter option to catalog
+
+## v0.7.5:
+
+* Create random base if not specified by setup.
+
 ## v0.7.4:
 
 * Add support to read password from file

data/lib/heirloom/archive/builder.rb

@@ -9,20 +9,20 @@ module Heirloom
 
     def initialize(args)
       @config = args[:config]
-      @name = args[:name]
+      @name   = args[:name]
       @domain = "heirloom_#{@name}"
-      @id = args[:id]
+      @id     = args[:id]
       @logger = @config.logger
     end
 
     def build(args)
-      @source = args[:directory] ||= '.'
-      @secret = args[:secret]
-      @base = args[:base]
+      @source        = args[:directory] ||= '.'
+      @secret        = args[:secret]
+      @bucket_prefix = args[:bucket_prefix]
 
-      directory = Directory.new :path      => @source,
-                                :exclude   => args[:exclude],
-                                :config    => @config
+      directory = Directory.new :path    => @source,
+                                :exclude => args[:exclude],
+                                :config  => @config
 
       unless directory.build_artifact_from_directory :secret => @secret
         return false
@@ -63,11 +63,11 @@ module Heirloom
     end
 
     def create_artifact_record
-      attributes = { 'built_by'  => "#{user}@#{hostname}",
-                     'built_at'  => Time.now.utc.iso8601,
-                     'encrypted' => encrypted?,
-                     'base'      => @base,
-                     'id'        => @id }
+      attributes = { 'built_by'      => "#{user}@#{hostname}",
+                     'built_at'      => Time.now.utc.iso8601,
+                     'encrypted'     => encrypted?,
+                     'bucket_prefix' => @bucket_prefix,
+                     'id'            => @id }
       @logger.info "Adding entry #{@id}."
       sdb.put_attributes @domain, @id, attributes
     end

data/lib/heirloom/archive/downloader.rb

@@ -4,17 +4,17 @@ module Heirloom
 
     def initialize(args)
       @config = args[:config]
-      @name = args[:name]
-      @id = args[:id]
+      @name   = args[:name]
+      @id     = args[:id]
       @logger = @config.logger
     end
 
     def download(args)
-      @region = args[:region]
-      @base_prefix = args[:base_prefix]
-      extract = args[:extract]
-      secret = args[:secret]
-      output = args[:output] ||= './'
+      @region        = args[:region]
+      @bucket_prefix = args[:bucket_prefix]
+      extract        = args[:extract]
+      secret         = args[:secret]
+      output         = args[:output] ||= './'
 
       @logger.info "Downloading s3://#{bucket}/#{key} from #{@region}."
 
@@ -51,7 +51,7 @@ module Heirloom
     end
 
     def bucket
-      "#{@base_prefix}-#{@region}"
+      "#{@bucket_prefix}-#{@region}"
     end
 
     def writer

data/lib/heirloom/archive/writer.rb

@@ -26,7 +26,7 @@ module Heirloom
 
     def write_archive
       output_file = File.join @output, @file
-      @logger.info "Writing archive to '#{output_file}'."
+      @logger.info "Writing Heirloom to '#{output_file}'."
       File.open(output_file, 'w') { |local_file| local_file.write @archive }
     end
 
@@ -35,15 +35,15 @@ module Heirloom
     end
 
     def extract_tmp_archive
-      @logger.info "Extracting archive to '#{@output}'."
+      @logger.info "Extracting Heirloom to '#{@output}'."
       cmd = "tar xzf #{@tmp_archive} -C #{@output}"
       @logger.debug "Executing '#{cmd}'."
       `#{cmd}`
       if $?.success?
-        @logger.debug "Archive succesfully extracted."
+        @logger.debug "Heirloom succesfully extracted."
         true
       else
-        @logger.error "Error extracting archive."
+        @logger.error "Error extracting Heirloom."
         false
       end
     end

data/lib/heirloom/catalog.rb

@@ -37,8 +37,8 @@ module Heirloom
       show.regions
     end
 
-    def base
-      show.base
+    def bucket_prefix
+      show.bucket_prefix
     end
 
     def all

data/lib/heirloom/catalog/add.rb

@@ -9,14 +9,15 @@ module Heirloom
       end
 
       def add_to_catalog(args)
-        regions = args[:regions]
-        base    = args[:base]
+        regions       = args[:regions]
+        bucket_prefix = args[:bucket_prefix]
 
         @logger.info "Adding #{@name} to catalog."
 
         sdb.put_attributes 'heirloom', 
                            "heirloom_#{@name}", 
-                           "regions" => regions, "base" => base
+                           { "regions" => regions, 
+                             "bucket_prefix" => bucket_prefix }
 
       end
 

data/lib/heirloom/catalog/show.rb

@@ -11,8 +11,8 @@ module Heirloom
         lookup :name => @name, :attribute => 'regions'
       end
 
-      def base
-        lookup(:name => @name, :attribute => 'base').first
+      def bucket_prefix
+        lookup(:name => @name, :attribute => 'bucket_prefix').first
       end
 
       private

data/lib/heirloom/cipher/data.rb

@@ -15,7 +15,7 @@ module Heirloom
 
         return data unless args[:secret]
 
-        @logger.info "Secret provided. Decrypting archive."
+        @logger.info "Secret provided. Decrypting Heirloom."
 
         @aes = OpenSSL::Cipher::AES256.new(:CBC)
         @aes.decrypt
@@ -25,9 +25,9 @@ module Heirloom
           @aes.update(data) + @aes.final
         rescue OpenSSL::Cipher::CipherError => e
           if e.message == 'wrong final block length'
-            @logger.error 'This archive does not appear to be encrypted.'
+            @logger.error 'This Heirloom does not appear to be encrypted.'
           end
-          @logger.error "Unable to decrypt archive: '#{e.message}'"
+          @logger.error "Unable to decrypt Heirloom: '#{e.message}'"
           false
         end
       end

data/lib/heirloom/cli.rb

@@ -12,6 +12,7 @@ require 'heirloom/cli/tag'
 require 'heirloom/cli/download'
 require 'heirloom/cli/destroy'
 require 'heirloom/cli/teardown'
+require 'heirloom/cli/formatter'
 
 module Heirloom
   module CLI

data/lib/heirloom/cli/catalog.rb

@@ -21,10 +21,12 @@ module Heirloom
       end
       
       def all
-        if @opts[:details]
+        if @opts[:json]
           jj catalog_with_heirloom_prefix_removed
         else
-          jj catalog_with_heirloom_prefix_removed.keys
+          formatter = Heirloom::CLI::Formatter::Catalog.new 
+          puts formatter.format :catalog => catalog_with_heirloom_prefix_removed,
+                                :name    => @opts[:name]
         end
       end
 
@@ -49,7 +51,8 @@ EOS
           opt :help, "Display Help"
           opt :level, "Log level [debug|info|warn|error].", :type    => :string,
                                                             :default => 'info'
-          opt :details, "Include details."
+          opt :json, "Dump full catalog as raw JSON."
+          opt :name, "Name of Heirloom to show full details.", :type => :string
           opt :metadata_region, "AWS region to store Heirloom metadata.", :type    => :string,   
                                                                           :default => 'us-west-1'
           opt :aws_access_key, "AWS Access Key ID", :type => :string, 

data/lib/heirloom/cli/download.rb

@@ -25,10 +25,10 @@ module Heirloom
                                :id     => id,
                                :config => @config
 
-        # Lookup region & base from simpledb unless specified
+        # Lookup region & bucket_prefix from simpledb unless specified
         # To Do, valid validation message that simpledb exists
         @region = @opts[:region] || @catalog.regions.first
-        @base   = @opts[:base]   || @catalog.base
+        @bucket_prefix = @opts[:bucket_prefix] || @catalog.bucket_prefix
       end
       
       def download
@@ -37,11 +37,11 @@ module Heirloom
                              :config => @config
         ensure_valid_secret :secret => secret, 
                             :config => @config
-        archive = @archive.download :output      => @opts[:output],
-                                    :extract     => @opts[:extract],
-                                    :region      => @region,
-                                    :base_prefix => @base,
-                                    :secret      => secret
+        archive = @archive.download :output        => @opts[:output],
+                                    :extract       => @opts[:extract],
+                                    :region        => @region,
+                                    :bucket_prefix => @bucket_prefix,
+                                    :secret        => secret
         exit 1 unless archive
       end
 
@@ -60,10 +60,10 @@ heirloom download -n NAME -o OUTPUT_DIRECTORY
 
 If id (-i) is not specified, the latest id will be downloaded.
 
-To download Heirloom without looking up details in SimpleDB, specify region (-r), ID (-i) and base (-b) options.
+To download Heirloom without looking up details in SimpleDB, specify region (-r), ID (-i) and bucket_prefix (-b) options.
 
 EOS
-          opt :base, "Base of the Heirloom to download.", :type => :string
+          opt :bucket_prefix, "Bucket prefix of the Heirloom to download.", :type => :string
           opt :extract, "Extract the Heirloom into the given output path.", :short => "-x"
           opt :help, "Display Help"
           opt :id, "ID of the Heirloom to download.", :type => :string

data/lib/heirloom/cli/formatter.rb

@@ -0,0 +1,2 @@
+require 'heirloom/cli/formatter/catalog'
+require 'heirloom/cli/formatter/show'

data/lib/heirloom/cli/formatter/catalog.rb

@@ -0,0 +1,42 @@
+module Heirloom
+  module CLI
+    module Formatter
+      class Catalog
+        def format(args)
+          @catalog = args[:catalog]
+          @name    = args[:name]
+
+          return summary unless @name
+
+          return "Heirloom #{@name} not found in catalog." unless name_exists?
+
+          filter_by_name
+          details
+        end
+
+        private
+
+        def name_exists?
+          @catalog.include? @name
+        end
+
+        def filter_by_name
+          @catalog.select! {|k| @name == k }
+        end
+
+        def summary
+          @catalog.keys.join "\n"
+        end
+
+        def details
+          data = @catalog.each_pair.map do |k,v|
+            d = k + "\n"
+            d << "  Regions       : " + @catalog[k]["regions"].join(", ") + "\n"
+            d << "  Bucket Prefix : " + @catalog[k]["bucket_prefix"].first
+          end
+          data.join "\n"
+        end
+      end
+    end
+  end
+end

data/lib/heirloom/cli/formatter/show.rb

@@ -0,0 +1,55 @@
+module Heirloom
+  module CLI
+    module Formatter
+      class Show
+
+        def format(args)
+          @all        = args[:all]
+          @attributes = args[:attributes]
+          format_attributes
+        end
+
+        private
+
+        def format_attributes
+          remove_internal_attributes unless @all
+          formated = @attributes.each_pair.map do |key,value|
+            "#{padded_key(key)}: #{value}"
+          end
+          formated.join("\n")
+        end
+
+        def padded_key(key)
+          max_length ||= longest_attribute_length
+          key + (" " * (max_length - key.length + 1))
+        end
+
+        def longest_attribute_length
+          longest_length = 0
+          @attributes.keys.each do |k|
+            longest_length = k.length if k.length > longest_length
+          end
+          longest_length 
+        end
+
+        def remove_internal_attributes
+          @attributes.delete_if { |key| is_internal_attribute? key }
+        end
+
+        def is_internal_attribute?(attribute)
+          return true if is_reserved? attribute
+          return true if is_endpoint? attribute
+          false
+        end
+
+        def is_reserved?(attribute)
+          ['bucket_prefix', 'built_at', 'built_by'].include? attribute
+        end
+        
+        def is_endpoint?(attribute)
+          attribute.match('^.*-.*-\d*-s3|http|https-url$')
+        end
+      end
+    end
+  end
+end

data/lib/heirloom/cli/list.rb

@@ -22,8 +22,13 @@ module Heirloom
       end
       
       def list(count = @opts[:count])
-        @logger.debug "#{@archive.count} archives found."
-        jj @archive.list(count)
+        @logger.debug "#{@archive.count} IDs found."
+        list = @archive.list count
+        if @opts[:json]
+          jj list
+        else
+          puts list.join "\n"
+        end
       end
 
       private
@@ -43,6 +48,7 @@ EOS
           opt :count, "Number of IDs to return.", :type    => :integer,
                                                   :default => 10
           opt :help, "Display Help"
+          opt :json, "Display output as raw JSON."
           opt :level, "Log level [debug|info|warn|error].", :type    => :string,
                                                             :default => 'info'
           opt :metadata_region, "AWS region to store Heirloom metadata.", :type    => :string,   

data/lib/heirloom/cli/setup.rb

@@ -11,8 +11,9 @@ module Heirloom
                               :opts   => @opts
 
         ensure_valid_options :provided => @opts, 
-                             :required => [:metadata_region, :region, 
-                                           :name, :base],
+                             :required => [:metadata_region, 
+                                           :bucket_prefix,
+                                           :region, :name],
                              :config   => @config
 
         @catalog = Heirloom::Catalog.new :name    => @opts[:name],
@@ -30,18 +31,16 @@ module Heirloom
                                          :regions => @opts[:region]
 
         @catalog.create_catalog_domain
-        unless @catalog.add_to_catalog :regions => @opts[:region],
-                                       :base    => @opts[:base]
-           if @opts[:force]
-             @logger.warn "#{@opts[:name]} already exists."
-           else
-             @logger.warn "#{@opts[:name]} already exists, exiting."
-             exit 1
-           end
-        end
+
+        ensure_entry_does_not_exist_in_catalog :config  => @config,
+                                               :catalog => @catalog,
+                                               :entry   => @opts[:name]
+
+        @catalog.add_to_catalog :regions       => @opts[:region],
+                                :bucket_prefix => @opts[:bucket_prefix]
 
         @archive.setup :regions       => @opts[:region],
-                       :bucket_prefix => @opts[:base]
+                       :bucket_prefix => @opts[:bucket_prefix]
       end
 
       private
@@ -55,14 +54,13 @@ Setup S3 and SimpleDB in the given regions.
 
 Usage:
 
-heirloom setup -b BASE -n NAME -m REGION1 -r REGION1 -r REGION2
+heirloom setup -b BUCKET_PREFIX -n NAME -m REGION1 -r REGION1 -r REGION2
 
 EOS
-          opt :base, "Base prefix which will be combined with given regions \
-region. For example: '-b test -r us-west-1 -r us-east-1' will create bucket test-us-west-1 \
-in us-west-1 and test-us-east-1 in us-east-1.", :type => :string
+          opt :bucket_prefix, "The bucket prefix will be combined with specified \
+regions to create the required buckets. For example: '-b test -r us-west-1 -r \
+us-east-1' will create bucket test-us-west-1 in us-west-1 and test-us-east-1 in us-east-1.", :type => :string
           opt :help, "Display Help"
-          opt :force, "Force setup even if entry already exists in catalog."
           opt :level, "Log level [debug|info|warn|error].", :type    => :string,
                                                             :default => 'info'
           opt :metadata_region, "AWS region to store Heirloom metadata.", :type    => :string,