heirloom 0.7.4 → 0.8.0

data/spec/cli/download_spec.rb

@@ -21,11 +21,11 @@ describe Heirloom do
                       and_return @archive_mock
   end
 
-  context "with id, region and base specified" do
+  context "with id, region and bucket_prefix specified" do
     before do
       options = { :name            => 'archive_name',
                   :id              => '1.0.0',
-                  :base            => 'base',
+                  :bucket_prefix   => 'bp',
                   :region          => 'us-east-1',
                   :level           => 'info',
                   :output          => '/tmp/test123',
@@ -40,9 +40,9 @@ describe Heirloom do
     end
 
     it "should download an archive" do
-      @archive_mock.should_receive(:download).with(:output      => '/tmp/test123',
-                                                   :region      => 'us-east-1',
-                                                   :base_prefix => 'base',
+      @archive_mock.should_receive(:download).with(:output        => '/tmp/test123',
+                                                   :region        => 'us-east-1',
+                                                   :bucket_prefix => 'bp',
                                                    :extract     => false,
                                                    :secret      => nil).
                     and_return '/tmp/test123'
@@ -54,10 +54,10 @@ describe Heirloom do
     end
   end
 
-  context "id, region and base not specified" do
+  context "id, region and bucket prefix not specified" do
     before do
-      @catalog_stub = stub 'catalog', :regions => ['us-east-1', 'us-west-1'],
-                                      :base    => 'base'
+      @catalog_stub = stub 'catalog', :regions       => ['us-east-1', 'us-west-1'],
+                                      :bucket_prefix => 'bp'
       options = { :name            => 'archive_name',
                   :level           => 'info',
                   :output          => '/tmp/test123',
@@ -82,11 +82,11 @@ describe Heirloom do
     end
 
     it "should download the latest archive from the first region" do
-      @archive_mock.should_receive(:download).with(:output      => '/tmp/test123',
-                                                   :region      => 'us-east-1',
-                                                   :base_prefix => 'base',
-                                                   :extract     => false,
-                                                   :secret      => nil).
+      @archive_mock.should_receive(:download).with(:output        => '/tmp/test123',
+                                                   :region        => 'us-east-1',
+                                                   :bucket_prefix => 'bp',
+                                                   :extract       => false,
+                                                   :secret        => nil).
                     and_return '/tmp/test123'
       @cli_download.should_receive(:ensure_directory).
                     with(:config => @config_mock, 

data/spec/cli/formatter/catalog_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'heirloom/cli'
+
+describe Heirloom do
+
+  before do
+    @catalog = { 'test1' =>
+                   { 'regions'       => ['us-west-1', 'us-east-1'],
+                     'bucket_prefix' => ['bp1'] },
+                 'test2' => 
+                   { 'regions'       => ['us-west-2'],
+                     'bucket_prefix' => ['bp2'] }
+               } 
+    @formatter = Heirloom::CLI::Formatter::Catalog.new
+  end
+
+  context "unfiltered" do
+    it "should return the formated list" do
+      @formatter.format(:catalog => @catalog,
+                        :details => nil,
+                        :name    => nil ).should == "test1\ntest2"
+    end
+  end
+
+  context "filtered" do
+    it "should return the name with details" do
+      format = "test1\n  Regions       : us-west-1, us-east-1\n  Bucket Prefix : bp1"
+      @formatter.format(:catalog => @catalog,
+                        :name    => 'test1').should == format
+    end
+
+    it "should return not found if name does not exist in catalog" do
+      format = "Heirloom not_here not found in catalog."
+      @formatter.format(:catalog => @catalog,
+                        :name    => 'not_here').should == format
+    end
+  end
+
+end

data/spec/cli/formatter/show_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'heirloom/cli'
+
+describe Heirloom do
+
+  before do
+    @attributes = { 'id'                  => '123',
+                    'another_data'        => 'more_data',
+                    'built_at'            => 'today',
+                    'built_by'            => 'me',
+                    'bucket_prefix'       => 'bp',
+                    'us-west-1-s3-url'    => 's3',
+                    'us-west-1-http-url'  => 'http',
+                    'us-west-1-https-url' => 'https' }
+  end
+
+  it "should remove reserved / endpoint attribs" do
+    formatter = Heirloom::CLI::Formatter::Show.new
+    formatter.format(:attributes => @attributes).
+              should_not match 'bucket_prefix|us-west-1-s3-url'
+  end
+
+  it "should format the id output correctly" do
+    formatter = Heirloom::CLI::Formatter::Show.new
+    formatter.format(:attributes => @attributes).
+              should == "id           : 123\nanother_data : more_data"
+  end
+
+end

data/spec/cli/list_spec.rb

@@ -4,10 +4,10 @@ require 'heirloom/cli'
 describe Heirloom do
 
   before do
-    options = { :name            => 'archive_name',
-                :level           => 'info',
-                :metadata_region => 'us-west-1',
-                :count           => 100 }
+    @options = { :name            => 'archive_name',
+                 :level           => 'info',
+                 :metadata_region => 'us-west-1',
+                 :count           => 100 }
     @logger_stub = stub :debug => true
     @config_mock = mock 'config'
     @archive_mock = mock 'archive'
@@ -15,12 +15,11 @@ 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::List.any_instance.should_receive(:load_config).
                         with(:logger => @logger_stub,
-                             :opts   => options).
+                             :opts   => @options).
                         and_return @config_mock
     Heirloom::Archive.should_receive(:new).
                       with(:name => 'archive_name',
@@ -32,13 +31,34 @@ describe Heirloom do
                       and_return @archive_mock
     @archive_mock.should_receive(:domain_exists?).and_return true
     @archive_mock.should_receive(:count)
-    @cli_list = Heirloom::CLI::List.new
   end
 
-  it "should list ids for given archive" do
-    @archive_mock.should_receive(:list).with(100).and_return(['1','2'])
-    @cli_list.should_receive(:jj).with ['1','2']
-    @cli_list.list
+  context "as json" do
+    before do
+      @options[:json] = true
+      Trollop.stub :options => @options
+    end
+
+    it "should list ids for given archive" do
+      @cli_list = Heirloom::CLI::List.new
+      @archive_mock.should_receive(:list).with(100).and_return(['1','2'])
+      @cli_list.should_receive(:jj).with ['1','2']
+      @cli_list.list
+    end
+  end
+
+  context "as human readable" do
+    before do
+      @options[:json] = nil
+      Trollop.stub :options => @options
+    end
+
+    it "should list ids for given archive" do
+      @cli_list = Heirloom::CLI::List.new
+      @archive_mock.should_receive(:list).with(100).and_return(['1','2'])
+      @cli_list.should_receive(:puts).with "1\n2"
+      @cli_list.list
+    end
   end
 
 end

data/spec/cli/setup_spec.rb

@@ -6,7 +6,7 @@ describe Heirloom do
   before do
     @regions = ['us-west-1', 'us-west-2']
     options = { :level           => 'info',
-                :base            => 'base',
+                :bucket_prefix   => 'bp',
                 :region          => @regions,
                 :name            => 'archive_name',
                 :metadata_region => 'us-west-1' }
@@ -39,13 +39,14 @@ describe Heirloom do
 
   it "should setup s3 buckets, catalog and simpledb domain" do
     @catalog_mock.should_receive(:create_catalog_domain)
+    @catalog_mock.stub :entry_exists_in_catalog? => false
     @catalog_mock.should_receive(:add_to_catalog).
-                  with(:regions => @regions, 
-                       :base    => 'base').
+                  with(:regions       => @regions, 
+                       :bucket_prefix => 'bp').
                   and_return true
     @archive_mock.should_receive(:setup).
                   with(:regions       => @regions,
-                       :bucket_prefix => 'base')
+                       :bucket_prefix => 'bp')
     @setup.setup 
   end
 

data/spec/cli/shared_spec.rb

@@ -237,7 +237,7 @@ describe Heirloom do
     end
   end
 
-  context "testing ensure entry exists in catalog" do
+  context "testing ensure entry (does not) exists in catalog" do
     before do
       @catalog_mock = mock 'catalog'
       @logger_stub = stub 'logger', :error => true
@@ -257,6 +257,14 @@ describe Heirloom do
       lambda { @object.ensure_entry_exists_in_catalog @options }.
                        should raise_error SystemExit
     end
+
+    it "should exit if the entry exists in catalog" do
+      @catalog_mock.should_receive(:entry_exists_in_catalog?).
+                    with('entry').
+                    and_return true
+      lambda { @object.ensure_entry_does_not_exist_in_catalog @options }.
+                       should raise_error SystemExit
+    end
   end
 
   context "testing latest id" do

data/spec/cli/show_spec.rb

@@ -4,10 +4,11 @@ require 'heirloom/cli'
 describe Heirloom do
 
   before do
-    options = { :name            => 'archive_name',
-                :id              => '1.0.0',
-                :level           => 'info',
-                :metadata_region => 'us-west-1' }
+    @options = { :name            => 'archive_name',
+                 :json            => true,
+                 :id              => '1.0.0',
+                 :level           => 'info',
+                 :metadata_region => 'us-west-1' }
     @logger_stub = stub :debug => true
     @config_mock = mock 'config'
     @archive_mock = mock 'archive'
@@ -15,12 +16,11 @@ 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::Show.any_instance.should_receive(:load_config).
                         with(:logger => @logger_stub,
-                             :opts   => options).
+                             :opts   => @options).
                         and_return @config_mock
     Heirloom::Archive.should_receive(:new).
                       with(:name => 'archive_name',
@@ -33,13 +33,46 @@ describe Heirloom do
                       and_return @archive_mock
     @archive_mock.stub :exists? => true
     @archive_mock.stub :domain_exists? => true
-    @cli_show = Heirloom::CLI::Show.new
   end
 
-  it "should show a given id" do
-    @archive_mock.should_receive(:show).and_return( { 'id' => '1.0.0' } )
-    @cli_show.should_receive(:jj).with 'id' => '1.0.0'
-    @cli_show.show
-  end
+  context "returning base attributes" do
+    before do
+      @attributes = { 'id' => '1.0.0' }
+    end
+
+    context "as json" do
+      before do
+        @options[:json] = true
+        Trollop.stub(:options).and_return @options
+      end
+
+      it "should show a given id as json" do
+        @cli_show = Heirloom::CLI::Show.new
+        @archive_mock.stub :show => @attributes
+        @cli_show.should_receive(:jj).with @attributes
+        @cli_show.show
+      end
+    end
 
+    context "as human readable" do
+      before do
+        @options[:json] = false
+        @options[:all] = true
+        Trollop.stub(:options).and_return @options
+      end
+
+      it "should show a given id using the show formatter" do
+        @cli_show = Heirloom::CLI::Show.new
+        @archive_mock.stub :show => @attributes
+        formatter_mock = mock 'format'
+        Heirloom::CLI::Formatter::Show.stub :new => formatter_mock
+        formatter_mock.should_receive(:format).
+                       with(:attributes => @attributes,
+                            :all        => true).
+                       and_return 'the attribs'
+        @cli_show.should_receive(:puts).with 'the attribs'
+        @cli_show.show
+      end
+    end
+  end
 end

data/spec/cli/teardown_spec.rb

@@ -17,7 +17,8 @@ describe Heirloom do
     @archive_mock = mock 'archive'
     @catalog_mock = mock 'catalog'
     @catalog_mock.stub :regions => ['us-west-1', 'us-west-2']
-    @catalog_mock.stub :base => 'base', :catalog_domain_exists? => true
+    @catalog_mock.stub :bucket_prefix          => 'bp', 
+                       :catalog_domain_exists? => true
     @catalog_mock.should_receive(:entry_exists_in_catalog?).
                   with('archive_name').
                   and_return true

data/spec/cli/upload_spec.rb

@@ -23,8 +23,8 @@ describe Heirloom do
                       :metadata_region => 'us-west-1'
     @archive_mock = mock 'archive'
     @catalog_mock = mock 'catalog'
-    @catalog_mock.stub :regions => @regions,
-                       :base    => 'base',
+    @catalog_mock.stub :regions                => @regions,
+                       :bucket_prefix          => 'bp',
                        :catalog_domain_exists? => true
     Trollop.stub(:options).and_return options
     Heirloom::HeirloomLogger.should_receive(:new).with(:log_level => 'info').
@@ -53,10 +53,10 @@ describe Heirloom do
             with(:name   => 'archive_name',
                  :config => @config_mock)
     @upload.should_receive(:ensure_buckets_exist).
-            with(:base    => 'base',
-                 :name    => 'archive_name',
-                 :regions => @regions,
-                 :config  => @config_mock)
+            with(:bucket_prefix => 'bp',
+                 :name          => 'archive_name',
+                 :regions       => @regions,
+                 :config        => @config_mock)
     @upload.should_receive(:ensure_directory).
             with(:path   => '/buildme',
                  :config => @config_mock)
@@ -65,14 +65,14 @@ describe Heirloom do
                  :config => @config_mock)
     @archive_mock.stub :exists? => false
     @archive_mock.should_receive(:build).
-                  with(:base      => 'base',
-                       :directory => '/buildme',
-                       :exclude   => ["exclude1", "exclude2"],
-                       :git       => false,
-                       :secret    => 'secret12').
+                  with(:bucket_prefix => 'bp',
+                       :directory     => '/buildme',
+                       :exclude       => ["exclude1", "exclude2"],
+                       :git           => false,
+                       :secret        => 'secret12').
                   and_return '/tmp/build123.tar.gz'
     @archive_mock.should_receive(:upload).
-                  with(:bucket_prefix   => 'base',
+                  with(:bucket_prefix   => 'bp',
                        :regions         => @regions,
                        :public_readable => false,
                        :file            => '/tmp/build123.tar.gz')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heirloom
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70113954151760 !ruby/object:Gem::Requirement
+  requirement: &70260713581820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113954151760
+  version_requirements: *70260713581820
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70113954150340 !ruby/object:Gem::Requirement
+  requirement: &70260713581300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70113954150340
+  version_requirements: *70260713581300
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70113954149460 !ruby/object:Gem::Requirement
+  requirement: &70260713580800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70113954149460
+  version_requirements: *70260713580800
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70113954148360 !ruby/object:Gem::Requirement
+  requirement: &70260713580320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,7 +54,7 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70113954148360
+  version_requirements: *70260713580320
 description: I help build and manage building tar.gz files and deploying them into
   the cloud
 email:
@@ -107,6 +107,9 @@ files:
 - lib/heirloom/cli/catalog.rb
 - lib/heirloom/cli/destroy.rb
 - lib/heirloom/cli/download.rb
+- lib/heirloom/cli/formatter.rb
+- lib/heirloom/cli/formatter/catalog.rb
+- lib/heirloom/cli/formatter/show.rb
 - lib/heirloom/cli/list.rb
 - lib/heirloom/cli/setup.rb
 - lib/heirloom/cli/shared.rb
@@ -156,6 +159,8 @@ files:
 - spec/cli/catalog_spec.rb
 - spec/cli/destroy_spec.rb
 - spec/cli/download_spec.rb
+- spec/cli/formatter/catalog_spec.rb
+- spec/cli/formatter/show_spec.rb
 - spec/cli/list_spec.rb
 - spec/cli/setup_spec.rb
 - spec/cli/shared_spec.rb
@@ -184,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 719472930190387548
+      hash: -176871004567933972
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -193,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 719472930190387548
+      hash: -176871004567933972
 requirements: []
 rubyforge_project: heirloom
 rubygems_version: 1.8.16
@@ -230,6 +235,8 @@ test_files:
 - spec/cli/catalog_spec.rb
 - spec/cli/destroy_spec.rb
 - spec/cli/download_spec.rb
+- spec/cli/formatter/catalog_spec.rb
+- spec/cli/formatter/show_spec.rb
 - spec/cli/list_spec.rb
 - spec/cli/setup_spec.rb
 - spec/cli/shared_spec.rb