heirloom 0.2.0 → 0.3.0.rc1

data/CHANGELOG

@@ -1,3 +1,13 @@
+## v0.3.0:
+
+* Move account authorization out of config to cli
+* Move region select out of config to cli
+* Updated obtions for update to use -u (not -v) for update
+* Cleaned up archive specs
+* Added authorize cli class
+* Changed output of show / list to JSON
+* Updated readme & cli help
+
 ## v0.2.0:
 
 * Command line options updates for each sub command.

data/README.md

@@ -1,31 +1,33 @@
 Heirloom
 ========
 
-I help building and deploying .tar.gz files to cloud based storage services and tracking meta data about those 'Heirlooms' for easy deployments.  
+Heirloom is packages and distributes files to cloud storage services.  Heirloom tracks metadata about those deployments, both about the file locations, as well as arbitrary metadata which can be set by an engineer or build process.
 
-How To Use Heirloom
--------------------
+Installation
+------------
 
-To get started copy the sample below into .heirloom.yml and update the specified fields.
+First things first, install heirloom:
+
+```
+gem install heirloom
+```
+
+To get started copy the sample below into ~/.heirloom.yml and update the specified fields.
 
 ```
 aws:
   access_key: UPDATE_ME
   secret_key: UPDATE_ME
-  regions:
-    - us-west-1
-    - us-west-2
-    - us-east-1
-  authorized_aws_accounts:
-    - UPDATE@ME
-    - UPDATE@ME
 ```
 
-* **access_key / secret_key**: Account where you would like the Heirlooms storaged.
-* **regions**: AWS regions where the Heirlooms should be uploaded
-* **authorized_aws_accounts**: Heirloom expects you to deploy to seperate accounts from where the Heirloom is stored.  authorized_aws_accounts specifices the **email** address of other accounts to be authorized to access private Heirlooms.
+* **access_key / secret_key**: AWS account credentials where you would like the archives stored.
 
 Platforms
 ---------
 
-Currently I support s3 and simpledb but would one day like to expand (Big Table, etc).
+Currently I support AWS S3 for object storage and AWS SimpleDB for metadata management.  One day I'd like to expand to other providers.
+
+Documentation
+-------------
+
+For more information, please view the [Heirloom Wiki](https://github.com/live-community/heirloom/wiki).

data/lib/heirloom/acl/s3.rb

@@ -8,13 +8,13 @@ module Heirloom
         self.config = args[:config]
         self.region = args[:region]
         self.logger = config.logger
-        self.accounts = config.authorized_aws_accounts
       end
 
       def allow_read_access_from_accounts(args)
         bucket = args[:bucket]
         key_name = args[:key_name]
         key_folder = args[:key_folder]
+        accounts = args[:accounts]
 
         key = "#{key_folder}/#{key_name}.tar.gz"
 
@@ -38,11 +38,12 @@ module Heirloom
       def build_bucket_grants(args)
         id = args[:id]
         name = args[:name]
+        accounts = args[:accounts]
 
         a = Array.new
 
         # Add each account email as read access
-        @accounts.each do |g|
+        accounts.each do |g|
           a << {
                  'Grantee' => { 'EmailAddress' => g } ,
                  'Permission' => 'READ'

data/lib/heirloom/archive/authorizer.rb

@@ -9,18 +9,22 @@ module Heirloom
       @logger = @config.logger
     end
 
-    def authorize
+    def authorize(args)
+      regions = args[:regions]
+      accounts = args[:accounts]
+
       @logger.info "Authorizing access to artifact."
 
-      @config.regions.each do |region|
+      regions.each do |region|
         bucket = reader.get_bucket :region => region
 
         s3_acl = ACL::S3.new :config => @config,
                              :region => region
 
-        s3_acl.allow_read_access_from_accounts :key_name => @id,
+        s3_acl.allow_read_access_from_accounts :key_name   => @id,
                                                :key_folder => @name,
-                                               :bucket => bucket
+                                               :bucket     => bucket,
+                                               :accounts   => accounts
       end
 
       @logger.info "Authorization complete."

data/lib/heirloom/archive/builder.rb

@@ -47,14 +47,6 @@ module Heirloom
       add_git_commit_to_artifact_record git_commit
     end
 
-    def create_artifact_record
-      attributes = { 'built_by'        => "#{user}@#{hostname}",
-                     'built_at'        => Time.now.utc.iso8601,
-                     'id'              => id }
-      logger.info "Create artifact record #{id}."
-      sdb.put_attributes name, id, attributes
-    end
-
     def add_git_commit_to_artifact_record(commit)
       attributes = { 'sha'             => id,
                      'abbreviated_sha' => commit.id_abbrev,
@@ -69,6 +61,14 @@ module Heirloom
       sdb.put_attributes name, id, attributes
     end
 
+    def create_artifact_record
+      attributes = { 'built_by'        => "#{user}@#{hostname}",
+                     'built_at'        => Time.now.utc.iso8601,
+                     'id'              => id }
+      logger.info "Create artifact record #{id}."
+      sdb.put_attributes name, id, attributes
+    end
+
     def sdb
       @sdb ||= AWS::SimpleDB.new :config => config
     end

data/lib/heirloom/archive/destroyer.rb

@@ -11,10 +11,12 @@ module Heirloom
       self.logger = config.logger
     end
 
-    def destroy
+    def destroy(args)
+      regions = args[:regions]
+
       logger.info "Destroying #{@name} - #{@id}"
 
-      config.regions.each do |region|
+      regions.each do |region|
         bucket = reader.get_bucket :region => region
 
         key = "#{id}.tar.gz"

data/lib/heirloom/archive/reader.rb

@@ -21,6 +21,13 @@ module Heirloom
       end
     end
 
+    def regions
+      data = show.keys.map do |key|
+        key.gsub('-s3-url', '') if key =~ /-s3-url$/
+      end
+      data.compact
+    end
+
     def get_bucket(args)
       @logger.debug "Looking for bucket in #{args[:region]} for #{id}"
       url = get_url(args)
@@ -47,8 +54,13 @@ module Heirloom
     end
 
     def show
-      items = sdb.select "select * from #{name} where itemName() = '#{id}'"
-      items[id] ? items[id] : {}
+      query = sdb.select "select * from #{name} where itemName() = '#{id}'"
+      items = query[id] ? query[id] : {}
+      r = {}
+      items.each_pair.map do |key,value|
+        r[key] = value.first
+      end
+      r
     end
 
     private
@@ -59,7 +71,7 @@ module Heirloom
       url = "#{args[:region]}-s3-url"
       if show[url]
         @logger.debug "Found #{url} for #{id}."
-        show[url].first
+        show[url]
       else
         @logger.debug "#{args[:region]} endpoint for #{id} not found."
         nil

data/lib/heirloom/archive/uploader.rb

@@ -12,9 +12,10 @@ module Heirloom
     def upload(args)
       heirloom_file = args[:file]
       bucket_prefix = args[:bucket_prefix]
+      regions = args[:regions]
       public_readable = args[:public_readable]
 
-      @config.regions.each do |region|
+      regions.each do |region|
         bucket = "#{bucket_prefix}-#{region}"
 
         s3_uploader = Uploader::S3.new :config => @config,

data/lib/heirloom/archive/verifier.rb

@@ -10,9 +10,10 @@ module Heirloom
 
     def buckets_exist?(args)
       bucket_prefix = args[:bucket_prefix]
+      regions = args[:regions]
       result = true
 
-      @config.regions.each do |region|
+      regions.each do |region|
         bucket = "#{bucket_prefix}-#{region}"
         
         s3 ||= AWS::S3.new :config => @config,

data/lib/heirloom/archive.rb

@@ -19,8 +19,9 @@ module Heirloom
       @id = args[:id]
     end
 
-    def authorize
-      authorizer.authorize
+    def authorize(accounts)
+      authorizer.authorize :accounts => accounts,
+                           :regions  => regions
     end
 
     def build(args)
@@ -36,7 +37,7 @@ module Heirloom
     end
 
     def upload(args)
-      uploader.upload args
+      uploader.upload({ :regions => regions }.merge(args))
     end
 
     def exists?
@@ -48,7 +49,7 @@ module Heirloom
     end
 
     def destroy
-      destroyer.destroy
+      destroyer.destroy :regions => regions
     end
 
     def show
@@ -63,6 +64,10 @@ module Heirloom
       builder.cleanup
     end
 
+    def regions
+      reader.regions
+    end
+
     private
 
     def lister
@@ -89,9 +94,9 @@ module Heirloom
     end
 
     def uploader
-      @uploader ||= Uploader.new :config => @config,
-                                 :name   => @name,
-                                 :id     => @id
+      @uploader ||= Uploader.new :config  => @config,
+                                 :name    => @name,
+                                 :id      => @id
     end
 
     def downloader
@@ -101,15 +106,15 @@ module Heirloom
     end
 
     def authorizer
-      @authorizer ||= Authorizer.new :config => @config,
-                                     :name   => @name,
-                                     :id     => @id
+      @authorizer ||= Authorizer.new :config  => @config,
+                                     :name    => @name,
+                                     :id      => @id
     end
 
     def destroyer
-      @destroyer ||= Destroyer.new :config => @config,
-                                   :name   => @name,
-                                   :id     => @id
+      @destroyer ||= Destroyer.new :config  => @config,
+                                   :name    => @name,
+                                   :id      => @id
     end
 
     def verifier

data/lib/heirloom/cli/authorize.rb

@@ -0,0 +1,52 @@
+require 'json'
+
+module Heirloom
+  module CLI
+    class Authorize
+
+      def initialize
+        @opts = read_options
+        @logger = HeirloomLogger.new :log_level => @opts[:level]
+
+        exit 1 unless CLI::Shared.valid_options? :provided => @opts,
+                                                 :required => [:accounts, 
+                                                               :name, :id],
+                                                 :logger   => @logger
+        @archive = Archive.new :name   => @opts[:name],
+                               :id     => @opts[:id],
+                               :logger => @logger
+      end
+
+      def authorize
+        @archive.authorize @opts[:accounts]
+      end
+
+      private
+
+      def read_options
+        Trollop::options do
+          version Heirloom::VERSION
+          banner <<-EOS
+
+Authorize access from another AWS account to an archive.
+
+Usage:
+
+heirloom authorize -n NAME -i ID -a AWS_ACCOUNT1-a AWS_ACCOUNT2
+
+Note: This will replace all current authorizations with those specified and make the archive private.
+
+EOS
+          opt :accounts, "AWS Account(s) email to authorize. Can be specified multiple times.", :type  => :string,
+                                                                                                :multi => true
+          opt :help, "Display Help"
+          opt :id, "id of the archive to authorize.", :type => :string
+          opt :level, "Log level [debug|info|warn|error].", :type    => :string,
+                                                            :default => 'info'
+          opt :name, "Name of archive.", :type => :string
+        end
+      end
+
+    end
+  end
+end

data/lib/heirloom/cli/build.rb

@@ -7,29 +7,34 @@ module Heirloom
       def initialize
         @opts = read_options
         @logger = HeirloomLogger.new :log_level => @opts[:level]
+        exit 1 unless CLI::Shared.valid_options? :provided => @opts, 
+                                                 :required => [:name, :id, :regions, 
+                                                               :bucket_prefix, 
+                                                               :directory],
+                                                 :logger   => @logger
         @archive = Archive.new :name   => @opts[:name],
                                :id     => @opts[:id],
                                :logger => @logger
       end
 
       def build
-        unless @archive.buckets_exist? :bucket_prefix => @opts[:bucket_prefix]
+        unless @archive.buckets_exist? :bucket_prefix => @opts[:bucket_prefix],
+                                       :regions       => @opts[:regions]
           @logger.error "Buckets do no exist in required regions."
           exit 1
         end
 
         @archive.destroy if @archive.exists?
                           
-        archive_file = @archive.build :bucket_prefix  => @opts[:bucket_prefix],
-                                      :directory      => @opts[:directory],
-                                      :exclude        => @opts[:exclude].split(','),
-                                      :public         => @opts[:public],
-                                      :git            => @opts[:git]
+        archive_file = @archive.build :bucket_prefix   => @opts[:bucket_prefix],
+                                      :directory       => @opts[:directory],
+                                      :exclude         => @opts[:exclude].split(','),
+                                      :git             => @opts[:git]
 
-        @archive.upload :bucket_prefix => @opts[:bucket_prefix],
-                        :file          => archive_file
-
-        @archive.authorize unless @public
+        @archive.upload :bucket_prefix   => @opts[:bucket_prefix],
+                        :regions         => @opts[:regions],
+                        :public_readable => @opts[:public],
+                        :file            => archive_file
 
         @archive.cleanup
       end
@@ -45,21 +50,24 @@ Build and upload a new archive.
 
 Usage:
 
-heirloom build -n NAME -i ID -b BUCKET_PREFIX [-d DIRECTORY] [-p] [-g] [-e DIRECTORIES_TO_EXCLUDE]
+heirloom build -n NAME -i ID -b BUCKET_PREFIX -r REGION [-d DIRECTORY_TO_BUILD] [-p] [-g] [-e DIRECTORIES_TO_EXCLUDE] [-l LOG_LEVEL]
 
 EOS
-          opt :bucket_prefix, "Bucket prefix which will be combined with region.", :type => :string
+          opt :bucket_prefix, "Bucket prefix which will be combined with region.\
+For example: -b 'test' -r 'us-west-1'  will expect bucket 'test-us-west-1' to be present", :type => :string
           opt :directory, "Source directory of build.", :type    => :string, 
                                                         :default => '.'
-          opt :exclude, "Comma spereate list of files or directories to exclude.", :type => :string,
+          opt :exclude, "Comma spereate list of files or directories to exclude.", :type    => :string,
                                                                                    :default => '.git'
-          opt :git, "Read git commit information from directory."
+          opt :git, "Read git commit information from directory and set as archive attributes."
           opt :help, "Display Help"
-          opt :id, "ID of the archive to display.", :type => :string
-          opt :level, "Log level.", :type    => :string,
-                                    :default => 'info'
+          opt :id, "id for archive (when -g specified, assumed to be GIT sha).", :type => :string
+          opt :level, "Log level [debug|info|warn|error].", :type    => :string,
+                                                            :default => 'info'
           opt :name, "Name of archive.", :type => :string
           opt :public, "Set this archive as public readable?"
+          opt :regions, "Region(s) to upload archive.  Can be set multiple times.", :type  => :string,
+                                                                                    :multi => true
         end
       end
 

data/lib/heirloom/cli/destroy.rb

@@ -4,9 +4,12 @@ module Heirloom
 
       def initialize
         @opts = read_options
+        @logger = HeirloomLogger.new :log_level => @opts[:level]
+        exit 1 unless CLI::Shared.valid_options? :provided => @opts,
+                                                 :required => [:name, :id],
+                                                 :logger   => @logger
         @name = @opts[:name]
         @id = @opts[:id]
-        @logger = HeirloomLogger.new :log_level => @opts[:level]
         @archive = Archive.new :name   => @name,
                                :id     => @id,
                                :logger => @logger
@@ -32,8 +35,8 @@ heirloom destroy -n NAME -i ID [-l LOG_LEVEL]
 EOS
           opt :help, "Display Help"
           opt :id, "ID of the archive to display.", :type => :string
-          opt :level, "Log level.", :type    => :string,
-                                    :default => 'info'
+          opt :level, "Log level [debug|info|warn|error].", :type    => :string,
+                                                            :default => 'info'
           opt :name, "Name of archive.", :type => :string
         end
       end

data/lib/heirloom/cli/download.rb

@@ -5,6 +5,10 @@ module Heirloom
       def initialize
         @opts = read_options
         @logger = HeirloomLogger.new :log_level => @opts[:level]
+        exit 1 unless CLI::Shared.valid_options? :provided => @opts,
+                                                 :required => [:name, :id, :output],
+                                                 :logger   => @logger
+
         @archive = Archive.new :name   => @opts[:name],
                                :id     => @opts[:id],
                                :logger => @logger
@@ -30,13 +34,13 @@ heirloom download -n NAME -i ID -r REGION -o OUTPUT_FILE
 
 EOS
           opt :help, "Display Help"
-          opt :id, "ID of the archive to display.", :type => :string
-          opt :level, "Log level.", :type    => :string,
-                                    :default => 'info'
+          opt :id, "id of the archive to download.", :type => :string
           opt :name, "Name of archive.", :type => :string
+          opt :level, "Log level [debug|info|warn|error].", :type    => :string,
+                                                            :default => 'info'
           opt :output, "Location to download archive.", :type => :string
           opt :region, "Region to download archive.", :type    => :string,
-                                                       :default => 'us-west-1'
+                                                      :default => 'us-west-1'
         end
       end
     end

data/lib/heirloom/cli/list.rb

@@ -5,12 +5,15 @@ module Heirloom
       def initialize
         @opts = read_options
         @logger = HeirloomLogger.new :log_level => @opts[:level]
+        exit 1 unless CLI::Shared.valid_options? :provided => @opts,
+                                                 :required => [:name],
+                                                 :logger   => @logger
         @archive = Archive.new :name   => @opts[:name],
                                :logger => @logger
       end
       
       def list(count = @opts[:count])
-        puts @archive.list(count)
+        jj @archive.list(count)
       end
 
       private
@@ -28,8 +31,8 @@ heirloom list -n NAME
 
 EOS
           opt :help, "Display Help"
-          opt :level, "Log level.", :type    => :string,
-                                    :default => 'info'
+          opt :level, "Log level [debug|info|warn|error].", :type    => :string,
+                                                            :default => 'info'
           opt :name, "Name of archive.", :type => :string
           opt :count, "Number of versions to return.", :type    => :integer,
                                                        :default => 10

data/lib/heirloom/cli/shared.rb

@@ -0,0 +1,31 @@
+module Heirloom
+  module CLI
+    module Shared
+
+      def self.valid_options?(args)
+        provided = args[:provided]
+        required = args[:required]
+        logger = args[:logger]
+
+        missing_opts = required.map do |opt|
+          case provided[opt]
+          when nil
+            "Option '#{opt} (-#{opt[0]})' required but not specified."
+          when []
+            "Option '#{opt} (-#{opt[0]})' required but not specified."
+          end
+        end
+
+        missing_opts.compact!
+
+        if missing_opts.any?
+          missing_opts.each {|missing_opt| logger.error missing_opt}
+        end
+
+        missing_opts.any? ? false : true
+
+      end
+
+    end
+  end
+end

data/lib/heirloom/cli/show.rb

@@ -4,15 +4,18 @@ module Heirloom
 
       def initialize
         @opts = read_options
-        id = @opts[:id] ? @opts[:id] : latest_id
         @logger = HeirloomLogger.new :log_level => @opts[:level]
+        exit 1 unless CLI::Shared.valid_options? :provided => @opts,
+                                                 :required => [:name],
+                                                 :logger   => @logger
+        id = @opts[:id] ? @opts[:id] : latest_id
         @archive = Archive.new :name   => @opts[:name],
-                               :id     => id,
-                               :logger => @logger
+                               :logger => @logger,
+                               :id     => id
       end
       
       def show
-        puts @archive.show.to_yaml
+        jj @archive.show
       end
 
       private
@@ -37,10 +40,10 @@ If -i is ommited, latest version is displayed.
 
 EOS
           opt :help, "Display Help"
-          opt :level, "Log level.", :type    => :string,
-                                    :default => 'info'
+          opt :level, "Log level [debug|info|warn|error].", :type    => :string,
+                                                            :default => 'info'
           opt :name, "Name of archive.", :type => :string
-          opt :id, "ID of the archive to display.", :type => :string
+          opt :id, "id of the archive to display.", :type => :string
         end
       end
 

data/lib/heirloom/cli/update.rb

@@ -1,18 +1,23 @@
-module Heirloom
+module Heirloom 
   module CLI
     class Update
 
       def initialize
         @opts = read_options
         @logger = HeirloomLogger.new :log_level => @opts[:level]
+        exit 1 unless CLI::Shared.valid_options? :provided => @opts,
+                                                 :required => [:name, :id, 
+                                                               :attribute, 
+                                                               :updated_value],
+                                                 :logger   => @logger
         @archive = Archive.new :name   => @opts[:name],
                                :id     => @opts[:id],
                                :logger => @logger
       end
       
       def update
-        @archive.update :attribute => @opts[:attribute],
-                        :value     => @opts[:value]
+        @archive.update :attribute  => @opts[:attribute],
+                        :value      => @opts[:updated_value]
       end
 
       private
@@ -26,16 +31,16 @@ Update an archive's attribute.
 
 Usage:
 
-heirloom update -n NAME -i ID -a ATTRIBUTE_TO_UPDATE -v NEW_VALUE
+heirloom update -n NAME -i ID -a ATTRIBUTE_TO_UPDATE -u UPDATED_VALUE
 
 EOS
           opt :attribute, "Attribute to update.", :type => :string
           opt :help, "Display Help"
           opt :id, "ID of the archive to display.", :type => :string
-          opt :level, "Log level.", :type    => :string,
-                                    :default => 'info'
+          opt :level, "Log level [debug|info|warn|error].", :type    => :string,
+                                                            :default => 'info'
           opt :name, "Name of archive.", :type => :string
-          opt :value, "New value of attribute.", :type => :string
+          opt :updated_value, "Updated value of attribute.", :type => :string
         end
       end
     end