heirloom 0.7.4 → 0.8.0

data/lib/heirloom/cli/shared.rb

@@ -93,18 +93,18 @@ module Heirloom
       end
 
       def ensure_buckets_exist(args)
-        config  = args[:config]
-        base    = args[:base]
-        name    = args[:name]
-        regions = args[:regions]
-        logger  = config.logger
+        config        = args[:config]
+        bucket_prefix = args[:bucket_prefix]
+        name          = args[:name]
+        regions       = args[:regions]
+        logger        = config.logger
 
         archive = Archive.new :name   => name,
                               :config => config
 
         unless archive.buckets_exist? :regions       => regions,
-                                      :bucket_prefix => base
-          logger.error "Required buckets for '#{base}' do not exist."
+                                      :bucket_prefix => bucket_prefix
+          logger.error "Required buckets for '#{bucket_prefix}' do not exist."
           exit 1
         end
       end
@@ -170,6 +170,19 @@ module Heirloom
         end
       end
 
+      def ensure_entry_does_not_exist_in_catalog(args)
+        config  = args[:config]
+        catalog = args[:catalog]
+        entry   = args[:entry]
+        logger  = config.logger
+        region  = config.metadata_region
+
+        if catalog.entry_exists_in_catalog? entry
+          logger.error "Entry for #{entry} exists in #{region} catalog."
+          exit 1
+        end
+      end
+
       def latest_id(args)
         archive = Archive.new :name   => args[:name],
                               :config => args[:config]

data/lib/heirloom/cli/show.rb

@@ -30,7 +30,14 @@ module Heirloom
       end
       
       def show
-        jj @archive.show
+        data = @archive.show
+        if @opts[:json]
+          jj data
+        else
+          formatter = Heirloom::CLI::Formatter::Show.new
+          puts formatter.format :attributes => data,
+                                :all        => @opts[:all]
+        end
       end
 
       private
@@ -50,7 +57,9 @@ If -i is ommited, latest ID is displayed.
 
 EOS
           opt :help, "Display Help"
+          opt :all, "Display all attributes (includes internal heirloom settings)."
           opt :id, "ID of the Heirloom to display.", :type => :string
+          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/teardown.rb

@@ -34,11 +34,11 @@ module Heirloom
                                     :config  => @config
 
         @regions = @catalog.regions
-        @base    = @catalog.base
+        @bucket_prefix = @catalog.bucket_prefix
 
         unless @opts[:keep_buckets]
           @archive.delete_buckets :regions       => @regions,
-                                  :bucket_prefix => @base
+                                  :bucket_prefix => @bucket_prefix
         end
 
         @archive.delete_domain

data/lib/heirloom/cli/upload.rb

@@ -23,7 +23,7 @@ module Heirloom
                                :id     => @opts[:id],
                                :config => @config
         @regions = @catalog.regions
-        @base    = @catalog.base
+        @bucket_prefix = @catalog.bucket_prefix
       end
 
       def upload
@@ -31,10 +31,10 @@ module Heirloom
                             :config => @config
         ensure_domain_exists :name   => @opts[:name], 
                              :config => @config
-        ensure_buckets_exist :base    => @base,
-                             :name    => @opts[:name],
-                             :regions => @regions,
-                             :config  => @config
+        ensure_buckets_exist :bucket_prefix => @bucket_prefix,
+                             :name          => @opts[:name],
+                             :regions       => @regions,
+                             :config        => @config
         ensure_directory :path   => @opts[:directory], 
                          :config => @config
 
@@ -45,18 +45,18 @@ module Heirloom
 
         @archive.destroy if @archive.exists?
                           
-        build = @archive.build :base      => @base,
-                               :directory => @opts[:directory],
-                               :exclude   => @opts[:exclude],
-                               :git       => @opts[:git],
-                               :secret    => secret
+        build = @archive.build :bucket_prefix => @bucket_prefix,
+                               :directory     => @opts[:directory],
+                               :exclude       => @opts[:exclude],
+                               :git           => @opts[:git],
+                               :secret        => secret
 
         unless build
           @logger.error "Build failed."
           exit 1
         end
 
-        @archive.upload :bucket_prefix   => @base,
+        @archive.upload :bucket_prefix   => @bucket_prefix,
                         :regions         => @regions,
                         :public_readable => @opts[:public],
                         :file            => build

data/lib/heirloom/version.rb

@@ -1,3 +1,3 @@
 module Heirloom
-  VERSION = "0.7.4"
+  VERSION = "0.8.0"
 end

data/spec/archive/downloader_spec.rb

@@ -42,10 +42,10 @@ describe Heirloom do
                         :file    => "123.tar.gz",
                         :output  => './',
                         :extract => false).and_return true
-      @downloader.download(:region      => 'us-west-1',
-                           :base_prefix => 'bucket',
-                           :extract     => false,
-                           :secret      => nil).should == './'
+      @downloader.download(:region        => 'us-west-1',
+                           :bucket_prefix => 'bucket',
+                           :extract       => false,
+                           :secret        => nil).should == './'
     end
 
     it "should download arhcive to specified output" do
@@ -54,11 +54,11 @@ describe Heirloom do
                         :file    => "123.tar.gz",
                         :output  => '/tmp/dir',
                         :extract => false).and_return true
-      @downloader.download(:output      => '/tmp/dir',
-                           :region      => 'us-west-1',
-                           :base_prefix => 'bucket',
-                           :extract     => false,
-                           :secret      => nil).should == '/tmp/dir'
+      @downloader.download(:output        => '/tmp/dir',
+                           :region        => 'us-west-1',
+                           :bucket_prefix => 'bucket',
+                           :extract       => false,
+                           :secret        => nil).should == '/tmp/dir'
     end
   end
 
@@ -87,10 +87,10 @@ describe Heirloom do
                           :file    => "123.tar.gz",
                           :output  => './',
                           :extract => false).and_return true
-        @downloader.download :region      => 'us-west-1',
-                             :base_prefix => 'bucket',
-                             :extract     => false,
-                             :secret      => 'supersecret'
+        @downloader.download :region        => 'us-west-1',
+                             :bucket_prefix => 'bucket',
+                             :extract       => false,
+                             :secret        => 'supersecret'
       end
 
       it "should decrypt and extract the downloaded file with secret" do
@@ -100,7 +100,7 @@ describe Heirloom do
                           :output  => './',
                           :extract => true).and_return true
         @downloader.download :region      => 'us-west-1',
-                             :base_prefix => 'bucket',
+                             :bucket_prefix => 'bucket',
                              :extract     => true,
                              :secret      => 'supersecret'
       end
@@ -115,7 +115,7 @@ describe Heirloom do
 
       it "should return false if the decrypt_data returns false" do
         @downloader.download(:region      => 'us-west-1',
-                             :base_prefix => 'bucket',
+                             :bucket_prefix => 'bucket',
                              :extract     => false,
                              :secret      => 'badsecret').should be_false
       end 

data/spec/archive/setup_spec.rb

@@ -28,14 +28,14 @@ describe Heirloom do
       @verifier_mock.stub :domain_exists? => false
       @sdb_mock.should_receive(:create_domain).with 'heirloom_archive'
       @setuper.setup :regions       => ['us-west-1'],
-                     :bucket_prefix => 'base'
+                     :bucket_prefix => 'bp'
                      
     end
 
     it "should not create the domain if alrady exists" do
       @verifier_mock.stub :domain_exists? => true
       @setuper.setup :regions       => ['us-west-1'],
-                     :bucket_prefix => 'base'
+                     :bucket_prefix => 'bp'
     end
   end
 
@@ -46,10 +46,10 @@ describe Heirloom do
 
     it "should create required buckets that don't exist" do
       @verifier_mock.should_receive(:bucket_exists?).
-                     with(:region => "us-west-1", :bucket_prefix => "base").
+                     with(:region => "us-west-1", :bucket_prefix => "bp").
                      and_return true
       @verifier_mock.should_receive(:bucket_exists?).
-                     with(:region => "us-east-1", :bucket_prefix => "base").
+                     with(:region => "us-east-1", :bucket_prefix => "bp").
                      and_return false
       @s3_mock = mock 's3'
       Heirloom::AWS::S3.should_receive(:new).
@@ -57,9 +57,9 @@ describe Heirloom do
                              :region => 'us-east-1').
                         and_return @s3_mock
       @s3_mock.should_receive(:put_bucket).
-               with 'base-us-east-1', 'us-east-1'
+               with 'bp-us-east-1', 'us-east-1'
       @setuper.setup :regions       => ['us-west-1', 'us-east-1'],
-                     :bucket_prefix => 'base'
+                     :bucket_prefix => 'bp'
     end
   end
 

data/spec/archive/teardowner_spec.rb

@@ -24,10 +24,10 @@ describe Heirloom::Teardowner do
                       with(:config => @config_stub,
                            :region => 'us-west-2').
                       and_return @s3_mock2
-    @s3_mock1.should_receive(:delete_bucket).with('base-us-west-1')
-    @s3_mock2.should_receive(:delete_bucket).with('base-us-west-2')
+    @s3_mock1.should_receive(:delete_bucket).with('bp-us-west-1')
+    @s3_mock2.should_receive(:delete_bucket).with('bp-us-west-2')
     @teardowner.delete_buckets :regions       => @regions,
-                               :bucket_prefix => 'base'
+                               :bucket_prefix => 'bp'
   end
 
   it "should delete the domain" do

data/spec/archive/writer_spec.rb

@@ -29,7 +29,7 @@ describe Heirloom do
       Heirloom::Writer.any_instance.should_receive(:`).
                        with('tar xzf /tmp/tempfile -C /output')
       $?.stub :success? => false
-      @logger_mock.should_receive(:error).with "Error extracting archive."
+      @logger_mock.should_receive(:error)
       @writer.save_archive(:archive => 'archive_data', 
                            :output  => '/output',
                            :file    => 'id.tar.gz',

data/spec/catalog/add_spec.rb

@@ -3,10 +3,11 @@ require 'spec_helper'
 describe Heirloom::Catalog::Add do
 
   before do
-    @regions     = ['us-west-1', 'us-west-2']
-    @base        = 'base'
-    @logger_stub = stub 'logger', :info => true
-    @config_stub = stub 'config', :logger => @logger_stub
+    @regions       = ['us-west-1', 'us-west-2']
+    @bucket_prefix = 'bucket_prefix'
+    @logger_stub   = stub 'logger', :info => true
+    @config_stub   = stub 'config', :logger => @logger_stub
+
     @add = Heirloom::Catalog::Add.new :config => @config_stub,
                                       :name   => 'new_archive'
   end
@@ -19,9 +20,9 @@ describe Heirloom::Catalog::Add do
     @sdb_mock.should_receive(:put_attributes).
               with 'heirloom',
                    'heirloom_new_archive',
-                   "regions" => @regions, "base" => @base
-    @add.add_to_catalog :regions => @regions,
-                        :base    => @base
+                   "regions" => @regions, "bucket_prefix" => @bucket_prefix
+    @add.add_to_catalog :regions       => @regions,
+                        :bucket_prefix => @bucket_prefix
   end
 
 end

data/spec/catalog/show_spec.rb

@@ -12,12 +12,14 @@ describe Heirloom::Catalog::Show do
                                         :name   => 'a_archive'
   end
 
-  it "should return the base" do
-    result = { 'heirloom_a_archive' => { 'base' => [ 'thebase' ] } }
+  it "should return the bucket_prefix" do
+    result = { 'heirloom_a_archive' => 
+               { 'bucket_prefix' => [ 'bp' ] } 
+             }
     @sdb_mock.should_receive(:select).
-              with("select base from heirloom where itemName() = 'heirloom_a_archive'").
+              with("select bucket_prefix from heirloom where itemName() = 'heirloom_a_archive'").
               and_return result
-    @show.base.should == 'thebase'
+    @show.bucket_prefix.should == 'bp'
   end
 
   it "should return the regions" do

data/spec/catalog_spec.rb

@@ -3,10 +3,10 @@ require 'spec_helper'
 describe Heirloom::Catalog do
 
   before do 
-    @config_mock = mock 'catalog'
-    @regions     = ['us-west-1', 'us-west-2']
-    @base        = 'thebase'
-    @catalog     = Heirloom::Catalog.new :config => @config_mock,
+    @config_mock   = mock 'catalog'
+    @regions       = ['us-west-1', 'us-west-2']
+    @bucket_prefix = 'bp'
+    @catalog       = Heirloom::Catalog.new :config => @config_mock,
                                          :name   => 'new_archive'
   end
 
@@ -29,19 +29,19 @@ describe Heirloom::Catalog do
                                   :name   => 'new_archive').
                              and_return @catalog_add_mock
       @catalog_add_mock.should_receive(:add_to_catalog).
-                        with(:base    => @base,
-                             :regions => @regions).
+                        with(:bucket_prefix => @bucket_prefix,
+                             :regions       => @regions).
                         and_return true
-      @catalog.add_to_catalog(:base    => @base,
-                              :regions => @regions).
+      @catalog.add_to_catalog(:bucket_prefix => @bucket_prefix,
+                              :regions       => @regions).
                should be_true
     end
   end
 
   context "testing show" do
     before do
-      @catalog_show_stub = stub 'show', :regions => @regions,
-                                        :base    => @base
+      @catalog_show_stub = stub 'show', :regions       => @regions,
+                                        :bucket_prefix => @bucket_prefix
       Heirloom::Catalog::Show.should_receive(:new).
                               with(:config => @config_mock,
                                    :name   => 'new_archive').
@@ -52,8 +52,8 @@ describe Heirloom::Catalog do
       @catalog.regions.should == @regions
     end
 
-    it "should call base from the show object" do
-      @catalog.base.should == @base
+    it "should call bucket_prefix from the show object" do
+      @catalog.bucket_prefix.should == @bucket_prefix
     end
   end
 

data/spec/cipher/data_spec.rb

@@ -29,7 +29,7 @@ describe Heirloom do
 
     it "should rescue bad key error and return false" do
       @logger_mock.should_receive(:error).
-                   with "Unable to decrypt archive: 'OpenSSL::Cipher::CipherError'"
+                   with "Unable to decrypt Heirloom: 'OpenSSL::Cipher::CipherError'"
       @aes_mock.should_receive(:decrypt)
       @aes_mock.should_receive(:key=).with Digest::SHA256.hexdigest 'badsecret'
       @aes_mock.should_receive(:iv=).with 'firstsixteenchar'

data/spec/cli/catalog_spec.rb

@@ -4,12 +4,11 @@ require 'heirloom/cli'
 describe Heirloom do
 
   before do
-    options = { :level           => 'info',
-                :metadata_region => 'us-west-1',
-                :details         => true }
+    @options = { :level           => 'info',
+                 :metadata_region => 'us-west-1' }
     @result = { 'heirloom_test' => 
-                { 'regions' => ['us-west-1'],
-                  'base'    => ['base'] } }
+                { 'regions'       => ['us-west-1'],
+                  'bucket_prefix' => ['bp'] } }
     @logger_stub = stub :debug => true
     @config_mock = mock 'config'
     @catalog_mock = mock 'catalog'
@@ -18,26 +17,58 @@ describe Heirloom do
                       :access_key      => 'key',
                       :secret_key      => 'secret',
                       :metadata_region => 'us-west-1'
-    Trollop.stub(:options).and_return options
     Heirloom::HeirloomLogger.should_receive(:new).with(:log_level => 'info').
                              and_return @logger_stub
     Heirloom::CLI::Catalog.any_instance.should_receive(:load_config).
                            with(:logger => @logger_stub,
-                                :opts   => options).
+                                :opts   => @options).
                            and_return @config_mock
     Heirloom::Catalog.should_receive(:new).
                       with(:config => @config_mock).
                       and_return @catalog_mock
-    @cli_catalog = Heirloom::CLI::Catalog.new
   end
 
-  it "should list the details about all heirlooms in the catalog" do
-    @catalog_mock.should_receive(:all).and_return @result
-    formated_result = { 'test' => 
-                        { 'regions' => ['us-west-1'],
-                          'base'    => ['base'] } }
-    @cli_catalog.should_receive(:jj).with formated_result
-    @cli_catalog.all
+  context "as json" do
+    before do
+      @options[:json] = true
+      Trollop.stub :options => @options
+    end
+
+    it "should list the details about all heirlooms in the catalog" do
+      @cli_catalog = Heirloom::CLI::Catalog.new
+      @catalog_mock.stub :all => @result
+      formated_result = { 'test' => 
+                          { 'regions'       => ['us-west-1'],
+                            'bucket_prefix' => ['bp'] } }
+      @cli_catalog.should_receive(:jj).with formated_result
+      @cli_catalog.all
+    end
+  end
+
+  context "as human readable" do
+    before do
+      @options[:json] = nil
+      Trollop.stub :options => @options
+    end
+
+    it "should list all heirlooms in the catalog" do
+      @cli_catalog = Heirloom::CLI::Catalog.new
+      @catalog_mock.stub :all => @result
+      formatter_mock = mock 'formatter'
+      catalog = { :catalog =>
+                  { "test" =>
+                    {
+                      "regions"       => ["us-west-1"], 
+                      "bucket_prefix" => ["bp"] 
+                    }
+                  },
+                  :name => nil
+                }
+      Heirloom::CLI::Formatter::Catalog.stub :new => formatter_mock
+      formatter_mock.should_receive(:format).with(catalog).and_return 'theoutput'
+      @cli_catalog.should_receive(:puts).with 'theoutput'
+      @cli_catalog.all
+    end
   end
 
 end