heirloom 0.12.4 → 0.12.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 387329119518755b3986e46b25f5bf67213cbff2
-  data.tar.gz: ebfd043ec1a6bb70acbb49cf76532b4dbb2ca8e7
+  metadata.gz: 6e53875623addc8598279fefdfec8c4a71d29a68
+  data.tar.gz: bcbc2a1ab5f612bc66a8a2b6f0f037fbb1a8bb0b
 SHA512:
-  metadata.gz: b37e92d8b09bef36e6cf1acf078383e62d6c2cd7812e5a18a3d3a9751a36b57d18076ce089dc08cb9271bcbc6b46e74f94c50e55c0fb14adae04929588dc2697
-  data.tar.gz: 0e2084f9ed3d225aae3989bac5bc6b181454a806a18a96fd68fa1d3d427070ad71cad3164cb5590c63cfe5a6e17551f691a8b9d507bfdf9e9f45d4e1fc663a4c
+  metadata.gz: 00dc8d2c29b1d01cf3d6796cc82de0141f21cf9efb7e9c9fcc545ad6a59b49e9f1a27d5df4468db08cc041fc7a234b26d050d031378cfc52a9ab5d6653be14c2
+  data.tar.gz: 555db1a43b07d64393361199307373706e7ebdb22a59e2fc07b44319d86233b0da141b166680884cc9b52cd6d5540fd88d04dd33b2af2ddfcd181b46543307e4

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## 0.12.4: (04/02/2014):
+## 0.12.5 (04/03/2014):
+
+* Updated download CLI argument validation
+
+## 0.12.4 (04/02/2014):
 
 * Bug fix in setup to properly read metadata region from config
 * Update to CLI environment message

data/README.md

@@ -25,16 +25,16 @@ gem install heirloom --no-ri --no-rdoc
 To get started, copy the sample below to ~/.heirloom.yml and update the specified fields.
 
 ```
-# default environment
-
 default:
   access_key: UPDATE_ME
   secret_key: UPDATE_ME
   metadata_region: us-west-1
+```
 
-# multiple environments can be defined in heirloom.yml and selected
-# via the cli with the -e or --environment option
+Multiple environments can be defined in heirloom.yml and selected via the cli 
+with the -e or --environment option
 
+```
 prod:
   access_key: UPDATE_ME
   secret_key: UPDATE_ME
@@ -46,14 +46,17 @@ preprod:
   metadata_region: us-west-1
 ```
 
-By default, heirloom will load **.heirloom.yml** from your home directory.
+You can now use Heirloom. For a list of commands
 
-You can specify an alternate config file by setting the HEIRLOOM_CONFIG_FILE
-environment variable
+    heirloom -h
 
-```
-export HEIRLOOM_CONFIG_FILE="~/special_config.yml"
-```
+For help on a specific command, append -h to the command:
+
+    heirloom setup -h
+
+For help an overview of heirloom, see the [Overview Wiki](https://github.com/intuit/heirloom/wiki/Overview).
+
+For detailed setup instructions, see the [Getting Started Guide](https://github.com/intuit/heirloom/wiki/GettingStarted).
 
 Documentation
 -------------

data/lib/heirloom/cli/download.rb

@@ -21,23 +21,20 @@ module Heirloom
         @catalog = Heirloom::Catalog.new :name    => @opts[:name],
                                          :config  => @config
 
+        # Determine if we can download directly from S3
+        # Or if we need to query additional information from the catalog
+        validate_or_bypass_catalog
+
+        # Lookup id, region & bucket_prefix from simpledb unless specified
         # Can't use fetch as Trollop sets :id to nil
-        id = @opts[:id] ||( latest_id :name   => @opts[:name],
-                                      :config => @config)
+        @region        = @opts[:region] || @catalog.regions.first
+        @bucket_prefix = @opts[:bucket_prefix] || @catalog.bucket_prefix
+        id             = @opts[:id] || (latest_id :name   => @opts[:name],
+                                                  :config => @config)
 
         @archive = Archive.new :name   => @opts[:name],
                                :config => @config,
                                :id     => id
-
-        unless @opts[:bucket_prefix]
-          ensure_archive_exists :archive => @archive,
-                                :config  => @config
-        end
-
-        # Lookup region & bucket_prefix from simpledb unless specified
-        # To Do, valid validation message that simpledb exists
-        @region = @opts[:region] || @catalog.regions.first
-        @bucket_prefix = @opts[:bucket_prefix] || @catalog.bucket_prefix
       end
 
       def download
@@ -55,6 +52,25 @@ module Heirloom
 
       private
 
+      def validate_or_bypass_catalog
+        missing_bypass_catalog_args = [:bucket_prefix, :id, :region].reject {|a| @opts[a]}
+
+        if missing_bypass_catalog_args.none?
+          @logger.info "Required arguments to download Heirloom without querying catalog provided. Downloading..."
+        else
+          @logger.info "Querying catalog for '#{@opts[:name]}' information."
+          @logger.info "Add #{missing_bypass_catalog_args.join(', ')} to bypass querying catalog."
+
+          # Only verify the domain exists in Heirloom
+          # if we don't bypass the catalog
+          ensure_catalog_domain_exists :config  => @config,
+                                       :catalog => @catalog
+          ensure_entry_exists_in_catalog :config  => @config,
+                                         :catalog => @catalog,
+                                         :entry   => @opts[:name]
+        end
+      end
+
       def read_options
         Trollop::options do
           version Heirloom::VERSION
@@ -80,14 +96,13 @@ EOS
           opt :metadata_region, "AWS region to store Heirloom metadata.", :type => :string
           opt :name, "Name of Heirloom.", :type => :string
           opt :output, "Path to output downloaded Heirloom. Must be existing directory.", :type => :string
-          opt :region, "Region to download Heirloom.", :type    => :string,
-                                                       :default => 'us-west-1'
+          opt :region, "Region to download Heirloom.", :type => :string
           opt :secret, "Secret for encrypted Heirloom.", :type => :string
           opt :secret_file, "Read secret from file.", :type  => :string,
                                                       :short => :none
-          opt :aws_access_key, "AWS Access Key ID", :type => :string, 
+          opt :aws_access_key, "AWS Access Key ID", :type => :string,
                                                     :short => :none
-          opt :aws_secret_key, "AWS Secret Access Key", :type => :string, 
+          opt :aws_secret_key, "AWS Secret Access Key", :type => :string,
                                                         :short => :none
           opt :use_iam_profile, "Use IAM EC2 Profile", :short => :none
           opt :environment, "Environment (defined in heirloom config file)", :type => :string

data/lib/heirloom/version.rb

@@ -1,3 +1,3 @@
 module Heirloom
-  VERSION = "0.12.4"
+  VERSION = "0.12.5"
 end

data/spec/cli/download_spec.rb

@@ -4,7 +4,7 @@ require 'heirloom/cli'
 describe Heirloom do
 
   before do
-    @logger_double = double 'logger'
+    @logger_double = double 'logger', :info => true
     @config_double = double_config :logger => @logger_double
     @archive_double = double 'archive'
     Heirloom::HeirloomLogger.should_receive(:new).
@@ -56,8 +56,10 @@ describe Heirloom do
 
   context "id, region and bucket prefix not specified" do
     before do
-      @catalog_double = double 'catalog', :regions       => ['us-east-1', 'us-west-1'],
-                                          :bucket_prefix => 'bp'
+      @catalog_double = double 'catalog', :regions                  => ['us-east-1', 'us-west-1'],
+                                          :bucket_prefix            => 'bp',
+                                          :entry_exists_in_catalog? => true,
+                                          :catalog_domain_exists?   => true
       @archive_double.stub :exists? => true
       options = { :name            => 'archive_name',
                   :level           => 'info',
@@ -84,10 +86,10 @@ describe Heirloom do
 
     it "should download the latest archive from the first region" do
       @archive_double.should_receive(:download).with(:output        => '/tmp/test123',
-                                                   :region        => 'us-east-1',
-                                                   :bucket_prefix => 'bp',
-                                                   :extract       => false,
-                                                   :secret        => nil).
+                                                     :region        => 'us-east-1',
+                                                     :bucket_prefix => 'bp',
+                                                     :extract       => false,
+                                                     :secret        => nil).
                       and_return '/tmp/test123'
       @cli_download.should_receive(:ensure_path_is_directory).
                     with(:config => @config_double,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heirloom
 version: !ruby/object:Gem::Version
-  version: 0.12.4
+  version: 0.12.5
 platform: ruby
 authors:
 - Brett Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake