heirloom 0.5.0rc1 → 0.5.0rc2

data/CHANGELOG

@@ -6,6 +6,8 @@
 * Fix error when .heirloom.yml does not exist.
 * Refactor cli option validation
 * Refactor cli specs
+* Add -x to download to extract heirloom to given output path
+* Verify -o specified in download is a directory
 
 ## v0.4.0:
 

data/lib/heirloom/archive/downloader.rb

@@ -2,6 +2,8 @@ module Heirloom
 
   class Downloader
 
+    include Heirloom::Misc::Tmp
+
     def initialize(args)
       @config = args[:config]
       @name = args[:name]
@@ -12,6 +14,8 @@ module Heirloom
     def download(args)
       region = args[:region]
       base_prefix = args[:base_prefix]
+      extract = args[:extract]
+      output = args[:output] ||= './'
 
       s3_downloader = Downloader::S3.new :config => @config,
                                          :logger => @logger,
@@ -20,16 +24,16 @@ module Heirloom
       bucket = get_bucket :region => region, :base_prefix => base_prefix
 
       @logger.info "Downloading s3://#{bucket}/#{key} from #{region}."
-
-      file = s3_downloader.download_file :bucket => bucket,
-                                         :key    => key
-
-      output = args[:output] ||= "./#{key.split('/').last}"
-
-      @logger.info "Writing file to #{output}."
-
-      File.open(output, 'w') do |local_file|
-        local_file.write file
+      archive = s3_downloader.download_file :bucket => bucket,
+                                            :key    => key
+
+      if extract
+        extracter = Extracter.new :config => @config
+        extracter.extract :archive => archive, :output => output
+      else
+        output_file = File.join output, file
+        @logger.info "Writing archive to '#{output_file}'."
+        File.open(output_file, 'w') { |local_file| local_file.write archive }
       end
 
       @logger.info "Download complete."
@@ -37,12 +41,16 @@ module Heirloom
 
     private
 
-    def get_bucket(args)
-      "#{args[:base_prefix]}-#{args[:region]}"
+    def file 
+      "#{@id}.tar.gz"
     end
 
     def key
-      "#{@name}/#{@id}.tar.gz"
+      "#{@name}/#{file}"
+    end
+
+    def get_bucket(args)
+      "#{args[:base_prefix]}-#{args[:region]}"
     end
 
   end

data/lib/heirloom/archive/extracter.rb

@@ -0,0 +1,38 @@
+module Heirloom
+  class Extracter
+
+    include Heirloom::Misc::Tmp
+
+    def initialize(args)
+      @config = args[:config]
+      @logger = @config.logger
+    end
+
+    def extract(args)
+      @tmp_archive = random_archive
+
+      create_tmp_archive args[:archive]
+      extract_tmp_archive args[:output]
+      delete_tmp_archive
+    end
+
+    private
+
+    def create_tmp_archive(archive)
+      File.open(@tmp_archive, 'w') { |local_file| local_file.write archive }
+    end
+
+    def extract_tmp_archive(output)
+      @logger.info "Extracting archive to '#{output}'."
+      cmd = "tar xzf #{@tmp_archive} -C #{output}"
+      @logger.debug "Executing '#{cmd}'."
+      `#{cmd}`
+    end
+  
+    def delete_tmp_archive
+      @logger.debug "Deleting '#{@tmp_archive}'."
+      File.delete @tmp_archive
+    end
+
+  end
+end

data/lib/heirloom/archive.rb

@@ -4,6 +4,7 @@ require 'heirloom/archive/builder.rb'
 require 'heirloom/archive/updater.rb'
 require 'heirloom/archive/uploader.rb'
 require 'heirloom/archive/downloader.rb'
+require 'heirloom/archive/extracter.rb'
 require 'heirloom/archive/authorizer.rb'
 require 'heirloom/archive/destroyer.rb'
 require 'heirloom/archive/verifier.rb'

data/lib/heirloom/cli/download.rb

@@ -14,14 +14,17 @@ module Heirloom
                              :required => [:base_prefix, :name, :id, :output],
                              :config   => @config
 
+
         @archive = Archive.new :name   => @opts[:name],
                                :id     => @opts[:id],
                                :config => @config
       end
       
       def download
+        ensure_directory :path => @opts[:output], :config => @config
         @archive.download :output      => @opts[:output],
                           :region      => @opts[:region],
+                          :extract     => @opts[:extract],
                           :base_prefix => @opts[:base_prefix]
       end
 
@@ -46,7 +49,8 @@ EOS
           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 :output, "Path to download archive.", :type => :string
+          opt :extract, "Extract the archive in the given output path.", :short => "-x"
           opt :region, "Region to download archive.", :type    => :string,
                                                       :default => 'us-west-1'
           opt :secret, "AWS Secret Access Key", :type => :string

data/lib/heirloom/cli/shared.rb

@@ -36,6 +36,17 @@ module Heirloom
         exit 1 unless missing_opts.empty?
       end
 
+      def ensure_directory(args)
+        config = args[:config]
+        path = args[:path]
+        logger = config.logger
+
+        unless File.directory? path
+          logger.error "#{path} is not a directory."
+          exit 1
+        end
+      end
+
       def ensure_domain_exists(args)
         config = args[:config]
         name = args[:name]

data/lib/heirloom/directory/directory.rb

@@ -1,11 +1,11 @@
-require 'tmpdir'
-
 module Heirloom
 
   class Directory
 
     attr_reader :local_build
 
+    include Heirloom::Misc::Tmp
+
     def initialize(args)
       @config = args[:config]
       @exclude = args[:exclude]
@@ -14,9 +14,7 @@ module Heirloom
     end
 
     def build_artifact_from_directory
-      random_text = (0...8).map{65.+(Kernel.rand(25)).chr}.join
-
-      @local_build = File.join(Dir.tmpdir, random_text + ".tar.gz")
+      @local_build = random_archive
 
       @logger.info "Building Heirloom '#{@local_build}' from '#{@path}'."
       @logger.info "Excluding #{@exclude.to_s}."

data/lib/heirloom/misc/tmp.rb

@@ -0,0 +1,12 @@
+require 'tmpdir'
+
+module Heirloom
+  module Misc
+    module Tmp
+      def random_archive
+        random_text = (0...8).map{65.+(Kernel.rand(25)).chr}.join
+        local_build = File.join(Dir.tmpdir, random_text + ".tar.gz")
+      end
+    end
+  end
+end

data/lib/heirloom/misc.rb

@@ -0,0 +1 @@
+require 'heirloom/misc/tmp'

data/lib/heirloom/version.rb

@@ -1,3 +1,3 @@
 module Heirloom
-  VERSION = "0.5.0rc1"
+  VERSION = "0.5.0rc2"
 end

data/lib/heirloom.rb

@@ -1,6 +1,7 @@
+require "heirloom/misc"
+require "heirloom/config"
 require "heirloom/acl"
 require "heirloom/aws"
-require "heirloom/config"
 require "heirloom/logger"
 require "heirloom/archive"
 require "heirloom/directory"

data/spec/archive/downloader_spec.rb

@@ -22,22 +22,49 @@ describe Heirloom do
     @file_mock = mock 'file'
   end
 
-  context "with base_prefix specified" do
+  context "extract set to false" do
     it "should download to the current path if output is not specified" do
       File.should_receive(:open).with('./123.tar.gz', 'w').
                                  and_return @file_mock
 
       @downloader.download :region      => 'us-west-1',
-                           :base_prefix => 'bucket'
+                           :base_prefix => 'bucket',
+                           :extract     => false
     end
 
     it "should download arhcive to specified output" do
-      File.should_receive(:open).with('/tmp/file', 'w').
+      File.should_receive(:open).with('/tmp/dir/123.tar.gz', 'w').
                                  and_return @file_mock
 
-      @downloader.download :output      => '/tmp/file',
+      @downloader.download :output      => '/tmp/dir',
                            :region      => 'us-west-1',
-                           :base_prefix => 'bucket'
+                           :base_prefix => 'bucket',
+                           :extract     => false
+    end
+  end
+
+  context "extract set to true" do
+    before do
+      @extracter_mock = mock 'extracter'
+      Heirloom::Extracter.should_receive(:new).with(:config => @config_mock).
+                          and_return @extracter_mock
+    end
+
+    it "should download and extract the to specified output" do
+      @extracter_mock.should_receive(:extract).with :archive => 'filename',
+                                                    :output  => '/tmp/dir'
+      @downloader.download :output      => '/tmp/dir',
+                           :region      => 'us-west-1',
+                           :base_prefix => 'bucket',
+                           :extract     => true
+    end
+
+    it "should download and extract the to the cwd" do
+      @extracter_mock.should_receive(:extract).with :archive => 'filename',
+                                                    :output  => './'
+      @downloader.download :region      => 'us-west-1',
+                           :base_prefix => 'bucket',
+                           :extract     => true
     end
   end
 

data/spec/archive/extracter_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Heirloom do
+
+  before do
+    @logger_stub = stub 'logger', :info => true, :debug => true
+    @config_mock = mock 'config'
+    @config_mock.stub :logger => @logger_stub
+    @extracter = Heirloom::Extracter.new :config => @config_mock
+  end
+
+  it "should extract the given archive object into the output directory" do
+    @extracter.should_receive(:random_archive).and_return '/tmp/file'
+    File.should_receive(:open).with('/tmp/file', 'w')
+    Heirloom::Extracter.any_instance.should_receive(:`).
+                        with('tar xzf /tmp/file -C /output')
+    File.should_receive(:delete).with '/tmp/file'
+    @extracter.extract :archive => 'test', :output => '/output'
+  end
+
+end

data/spec/cli/download_spec.rb

@@ -9,6 +9,7 @@ describe Heirloom do
                 :level       => 'info',
                 :output      => '/tmp/test123',
                 :region      => 'us-east-1',
+                :extract     => false,
                 :base_prefix => 'base' }
     @logger_stub = stub 'logger'
     @config_mock = mock 'config'
@@ -35,7 +36,12 @@ describe Heirloom do
   it "should download an archive" do
     @archive_mock.should_receive(:download).with :output      => '/tmp/test123',
                                                  :region      => 'us-east-1',
-                                                 :base_prefix => 'base'
+                                                 :base_prefix => 'base',
+                                                 :extract     => false
+    @cli_download.should_receive(:ensure_directory).
+                  with(:config => @config_mock, 
+                       :path => '/tmp/test123').
+                  and_return true
     @cli_download.download
   end
 

data/spec/cli/shared_spec.rb

@@ -90,6 +90,31 @@ describe Heirloom do
 
   end
 
+  context "test ensure directory" do
+    before do
+      @logger_stub = mock 'logger', :error => true
+      @config_mock = mock 'config'
+      @config_mock.stub :logger => @logger_stub
+      @object = Object.new
+      @object.extend Heirloom::CLI::Shared
+    end
+
+    it "should exit when path is not a directory" do
+      File.should_receive(:directory?).with('/tmp/test').
+                                       and_return false
+      lambda { @object.ensure_directory(:path => '/tmp/test', 
+                                        :config => @config_mock) }.
+                       should raise_error SystemExit
+    end
+
+    it "should not exit when path is a directory" do
+      File.should_receive(:directory?).with('/tmp/test').
+                                       and_return true
+      @object.ensure_directory :path => '/tmp/test', :config => @config_mock
+    end
+
+  end
+
   context "testing ensure domain" do
     before do
       @archive_mock = mock 'archive'

data/spec/directory/directory_spec.rb

@@ -10,14 +10,14 @@ describe Heirloom::Directory do
       @directory = Heirloom::Directory.new :config  => @config_mock,
                                            :exclude => ['.', '..', 'dont_pack_me'],
                                            :path    => '/target/dir'
+      @directory.stub :random_archive => '/tmp/dir/file.tar.gz'
       output_mock  = double 'output mock'
       Dir.stub :tmpdir => '/tmp/dir'
-      Kernel.stub :rand => 0
       Dir.should_receive(:entries).with('/target/dir').
                                    exactly(2).times.
                                    and_return(['pack_me', '.hidden', 'dont_pack_me'])
       Heirloom::Directory.any_instance.should_receive(:`).
-                          with("tar czf /tmp/dir/AAAAAAAA.tar.gz pack_me .hidden").
+                          with("tar czf /tmp/dir/file.tar.gz pack_me .hidden").
                           and_return output_mock
     end
 
@@ -29,7 +29,9 @@ describe Heirloom::Directory do
     context 'when unable to create the tar' do
       before { $?.stub(:success?).and_return(false) }
 
-      it { @directory.build_artifact_from_directory.should be_false }
+      it "should build return false" do
+        @directory.build_artifact_from_directory.should be_false
+      end
     end
 
   end

data/spec/misc/tmp_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Heirloom do
+
+  describe 'misc' do
+    before do
+      @object = Object.new
+      @object.extend Heirloom::Misc::Tmp
+    end
+
+    it "should return a temporary archive file" do
+      Kernel.stub :rand => 0
+      Dir.stub :tmpdir => '/tmp'
+      @object.random_archive.should == '/tmp/AAAAAAAA.tar.gz'
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heirloom
 version: !ruby/object:Gem::Version
-  version: 0.5.0rc1
+  version: 0.5.0rc2
   prerelease: 5
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70238839864540 !ruby/object:Gem::Requirement
+  requirement: &70122355909400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70238839864540
+  version_requirements: *70122355909400
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70238839863940 !ruby/object:Gem::Requirement
+  requirement: &70122355908680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70238839863940
+  version_requirements: *70122355908680
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70238839863260 !ruby/object:Gem::Requirement
+  requirement: &70122355908000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70238839863260
+  version_requirements: *70122355908000
 - !ruby/object:Gem::Dependency
   name: logger
-  requirement: &70238839862320 !ruby/object:Gem::Requirement
+  requirement: &70122355907160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70238839862320
+  version_requirements: *70122355907160
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70238839861680 !ruby/object:Gem::Requirement
+  requirement: &70122355906660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70238839861680
+  version_requirements: *70122355906660
 description: I help build and manage building tar.gz files and deploying them into
   the cloud
 email:
@@ -92,6 +92,7 @@ files:
 - lib/heirloom/archive/builder.rb
 - lib/heirloom/archive/destroyer.rb
 - lib/heirloom/archive/downloader.rb
+- lib/heirloom/archive/extracter.rb
 - lib/heirloom/archive/lister.rb
 - lib/heirloom/archive/reader.rb
 - lib/heirloom/archive/updater.rb
@@ -118,6 +119,8 @@ files:
 - lib/heirloom/downloader.rb
 - lib/heirloom/downloader/s3.rb
 - lib/heirloom/logger.rb
+- lib/heirloom/misc.rb
+- lib/heirloom/misc/tmp.rb
 - lib/heirloom/uploader.rb
 - lib/heirloom/uploader/s3.rb
 - lib/heirloom/version.rb
@@ -127,6 +130,7 @@ files:
 - spec/archive/builder_spec.rb
 - spec/archive/destroyer_spec.rb
 - spec/archive/downloader_spec.rb
+- spec/archive/extracter_spec.rb
 - spec/archive/lister_spec.rb
 - spec/archive/reader_spec.rb
 - spec/archive/updater_spec.rb
@@ -149,6 +153,7 @@ files:
 - spec/directory/git_directory_spec.rb
 - spec/downloader/s3_spec.rb
 - spec/logger_spec.rb
+- spec/misc/tmp_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -164,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 911003878403684883
+      hash: -3832291684396607232
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -183,6 +188,7 @@ test_files:
 - spec/archive/builder_spec.rb
 - spec/archive/destroyer_spec.rb
 - spec/archive/downloader_spec.rb
+- spec/archive/extracter_spec.rb
 - spec/archive/lister_spec.rb
 - spec/archive/reader_spec.rb
 - spec/archive/updater_spec.rb
@@ -205,4 +211,5 @@ test_files:
 - spec/directory/git_directory_spec.rb
 - spec/downloader/s3_spec.rb
 - spec/logger_spec.rb
+- spec/misc/tmp_spec.rb
 - spec/spec_helper.rb