metaforce 1.0.0a → 1.0.0

data/.gitignore

@@ -6,3 +6,4 @@ examples/tmp
 deploy.zip
 retrieve.zip
 test.rb
+.metaforce.yml

data/README.md

@@ -125,6 +125,40 @@ client.send_email(
 )
 ```
 
+## Command-line
+
+Metaforce also comes with a handy command line utility that can deploy and retrieve
+code from Salesforce. It also allows you to watch a directory and deploy when
+anything changes.
+
+When you deploy, it will also run all tests and provide you with a report,
+similar to rspec.
+
+```bash
+$ metaforce deploy ./src
+Deploying: ./src
+```
+
+```bash
+$ metaforce watch ./src
+Watching: ./src
+```
+
+```bash
+$ metaforce retrieve ./src
+Retrieving: ./src/package.xml
+
+$ metaforce retrieve ./src/package.xml ./other-location
+Retrieving: ./src/package.xml
+```
+
+### .metaforce.yml
+
+The metaforce command will pull it's configuration from a `.metaforce.yml`
+file, if present. You can provide options for multiple environments, then use
+the `-e` swtich on the command line to use an environment. See the
+[examples](examples) directory for an example.
+
 ## Contributing
 
 1. Fork it

data/bin/metaforce

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+require 'metaforce'
+
+begin
+  require 'metaforce/cli'
+  Metaforce::CLI.start
+rescue Interrupt => e
+  puts "\nQuitting..."
+  exit 1
+rescue SystemExit => e
+  exit e.status
+end

data/examples/example.rb

@@ -11,18 +11,12 @@ client = Metaforce.new :username => ENV['USER'],
 Metaforce::Job.disable_threading!
 
 # Test sending an email.
-print 'send email to: '
+print 'send email to: '; email = STDIN.gets.chomp
 client.send_email(
-  to_addresses: [STDIN.gets.chomp],
+  to_addresses: [email],
   subject: 'Test',
   plain_text_body: 'Test'
-)
-
-# Test deployment.
-client.deploy('../spec/fixtures/payload.zip')
-  .on_complete { |job| puts "Deploy Completed: #{job.id}."}
-  .on_error    { |job| puts "Deploy Failed: #{job.id}."}
-  .perform
+) if email
 
 # Test retrieve.
 manifest = Metaforce::Manifest.new(:custom_object => ['Account'])
@@ -32,6 +26,13 @@ client.retrieve_unpackaged(manifest)
   .extract_to('./tmp')
   .perform
 
+# Test deployment.
+client.deploy('./tmp')
+  .on_complete { |job| puts "Deploy Completed: #{job.id}. #{job.result}"}
+  .on_error    { |job| puts "Deploy Failed: #{job.id}."}
+  .on_poll     { |job| puts "Deploy: Polled status for #{job.id}."}
+  .perform
+
 # Test delete.
 client.delete(:apex_page, 'TestPage')
   .on_complete { |job| puts "Delete Completed: #{job.id}."}

data/lib/metaforce/cli.rb

@@ -0,0 +1,124 @@
+require 'listen'
+require 'thor'
+require 'metaforce/reporters'
+require 'metaforce/reporters'
+
+Metaforce.configuration.log = false
+Metaforce::Job.disable_threading!
+
+module Metaforce
+  class CLI < Thor
+    CONFIG_FILE = '.metaforce.yml'
+
+    include Thor::Actions
+
+    class << self
+      def credential_options
+        method_option :username, :aliases => '-u', :desc => 'Username.'
+        method_option :password, :aliases => '-p', :desc => 'Password.'
+        method_option :security_token, :aliases => '-t', :desc => 'Security Token.'
+        method_option :environment, :aliases => '-e', :default => 'production', :desc => 'Environment to use from config file (if present).'
+        method_option :host, :aliases => '-h', :desc => 'Salesforce host to connect to.'
+      end
+
+      def deploy_options
+        method_option :deploy_options, :aliases => '-o', :type => :hash, :default => { :run_all_tests => true }, :desc => 'Deploy Options'
+      end
+
+      def retrieve_options
+        method_option :retrieve_options, :aliases => '-o', :type => :hash, :default => {}, :desc => 'Retrieve Options'
+      end
+    end
+
+    desc 'deploy <path>', 'Deploy <path> to the target organization.'
+
+    credential_options
+    deploy_options
+
+    def deploy(path)
+      say "Deploying: #{path} ", :cyan
+      say "#{options[:deploy_options].inspect}"
+      client(options).deploy(path, options[:deploy_options].symbolize_keys!)
+        .on_complete { |job| report job.result, :deploy }
+        .on_error(&error)
+        .on_poll(&polling)
+        .perform
+    end
+
+    desc 'retrieve <manifest> <path>', 'Retrieve the components specified in <manifest> (package.xml) to <path>.'
+
+    credential_options
+    retrieve_options
+
+    def retrieve(manifest, path=nil)
+      unless path
+        path = manifest
+        manifest = File.join(path, 'package.xml')
+      end
+      say "Retrieving: #{manifest} ", :cyan
+      say "#{options[:retrieve_options].inspect}"
+      client(options).retrieve_unpackaged(manifest, options[:retrieve_options].symbolize_keys!)
+        .extract_to(path)
+        .on_complete { |job| report(job.result, :retrieve) }
+        .on_complete { |job| say "Extracted: #{path}", :green }
+        .on_error(&error)
+        .on_poll(&polling)
+        .perform
+    end
+
+    desc 'watch <path>', 'Deploy <path> to the target organization whenever files are changed.'
+
+    credential_options
+    deploy_options
+
+    def watch(path)
+      say "Watching: #{path}"
+      @watching = true
+      Listen.to(path) { deploy path }
+    end
+
+  private
+
+    def report(results, type)
+      reporter = "Metaforce::Reporters::#{type.to_s.camelize}Reporter".constantize.new(results)
+      reporter.report
+      exit 1 if reporter.issues?
+    end
+
+    def exit(status)
+      super(status) if not watching?
+    end
+
+    def watching?
+      !!@watching
+    end
+
+    def error
+      proc { |job| say "Error: #{job.result.inspect}" }
+    end
+
+    def polling
+      proc { |job| say 'Polling ...', :cyan }
+    end
+
+    def client(options)
+      credentials = Thor::CoreExt::HashWithIndifferentAccess.new(config ? config[options[:environment]] : {})
+      credentials.merge!(options.slice(:username, :password, :security_token, :host))
+      credentials.tap do |credentials|
+        credentials[:username] ||= ask('username:')
+        credentials[:password] ||= ask('password:')
+        credentials[:security_token] ||= ask('security token:')
+      end
+      Metaforce.new credentials
+    end
+
+    def config
+      YAML.load(File.open(config_file)) if File.exists?(config_file)
+    end
+
+    def config_file
+      File.expand_path(CONFIG_FILE)
+    end
+
+  end
+end

data/lib/metaforce/job.rb

@@ -3,6 +3,9 @@ require 'base64'
 
 module Metaforce
   class Job
+    DELAY_START = 1
+    DELAY_MULTIPLIER = 2
+
     autoload :Deploy,   'metaforce/job/deploy'
     autoload :Retrieve, 'metaforce/job/retrieve'
     autoload :CRUD,     'metaforce/job/crud'
@@ -39,11 +42,18 @@ module Metaforce
       self
     end
 
-    # Public: Register a block to be called when the job has completed.
+    # Public: Utility method to determine if .perform has been called yet.
+    #
+    # Returns true if @id is set, false otherwise.
+    def started?
+      !!@id
+    end
+
+    # Public: Register a block to be called when an event occurs.
     #
     # Yields the job.
     #
-    # &block - Proc or Lambda to be run when the job completes.
+    # &block - Proc or Lambda to be run when the event is triggered.
     #
     # Examples
     #
@@ -51,28 +61,26 @@ module Metaforce
     #     puts "Job ##{job.id} completed!"
     #   end
     #
-    # Returns self.
-    def on_complete(&block)
-      @_callbacks[:on_complete] << block
-      self
-    end
-
-    # Public: Register a block to be called when if the job fails.
-    #
-    # Yields the job.
-    #
-    # &block - Proc or Lambda to be run when the job fails.
-    #
-    # Examples
-    #
     #   job.on_error do |job|
-    #     puts "Job ##{job.id} failed!"
+    #     puts "Job failed!"
+    #   end
+    #
+    #   job.on_poll do |job|
+    #     puts "Polled status for #{job.id}"
     #   end
     #
     # Returns self.
-    def on_error(&block)
-      @_callbacks[:on_error] << block
-      self
+    #
+    # Signature
+    #
+    #   on_complete(&block)
+    #   on_error(&block)
+    #   on_poll(&block)
+    %w[complete error poll].each do |type|
+      define_method :"on_#{type}" do |&block|
+        @_callbacks[:"on_#{type}"] << block
+        self
+      end
     end
 
     # Public: Queries the job status from the API.
@@ -84,7 +92,7 @@ module Metaforce
     #
     # Returns the AsyncResult (http://www.salesforce.com/us/developer/docs/api_meta/Content/meta_asyncresult.htm).
     def status
-      client.status(id)
+      @status ||= client.status(id)
     end
 
     # Public: Returns true if the job has completed. 
@@ -106,9 +114,9 @@ module Metaforce
     #   job.state
     #   # => 'Completed'
     #
-    # Returns the state if the job is done, false otherwise.
+    # Returns the state of the job.
     def state
-      done? && status.state
+      status.state
     end
 
     # Public: Check if the job is in a given state.
@@ -140,7 +148,11 @@ module Metaforce
       def disable_threading!
         self.class_eval do
           def start_heart_beat
+            delay = DELAY_START
             loop do
+              @status = nil
+              wait (delay = delay * DELAY_MULTIPLIER)
+              trigger_poll_callbacks
               trigger_callbacks && break if completed? || error?
             end
           end
@@ -157,14 +169,26 @@ module Metaforce
     def start_heart_beat
       Thread.abort_on_exception = true
       @heart_beat ||= Thread.new do
-        delay = 1
+        delay = DELAY_START
         loop do
-          sleep (delay = delay * 2)
+          @status = nil
+          wait (delay = delay * DELAY_MULTIPLIER)
+          trigger_poll_callbacks
           trigger_callbacks && Thread.stop if completed? || error?
         end
       end
     end
 
+    def trigger_poll_callbacks
+      @_callbacks[:on_poll].each do |block|
+        block.call(self)
+      end
+    end
+
+    def wait(duration)
+      sleep duration
+    end
+
     def trigger_callbacks
       @_callbacks[callback_type].each do |block|
         block.call(self)

data/lib/metaforce/job/deploy.rb

@@ -37,7 +37,7 @@ module Metaforce
     #
     # Returns the DeployResult (http://www.salesforce.com/us/developer/docs/api_meta/Content/meta_deployresult.htm).
     def result
-      client.status(id, :deploy)
+      @result ||= client.status(id, :deploy)
     end
 
     # Public: Returns true if the deploy was successful.
@@ -52,7 +52,9 @@ module Metaforce
       result.success
     end
 
-    # Public: Base64 encodes the contents of the zip file.
+  private
+
+    # Internal: Base64 encodes the contents of the zip file.
     #
     # Examples
     #
@@ -64,8 +66,6 @@ module Metaforce
       Base64.encode64(File.open(file, 'rb').read)
     end
 
-  private
-
     # Internal: Returns the path to the zip file.
     def file
       File.file?(@path) ? @path : zip_file

data/lib/metaforce/job/retrieve.rb

@@ -37,7 +37,7 @@ module Metaforce
     #
     # Returns the RetrieveResult (http://www.salesforce.com/us/developer/docs/api_meta/Content/meta_retrieveresult.htm).
     def result
-      client.status(id, :retrieve)
+      @result ||= client.status(id, :retrieve)
     end
 
     # Public: Decodes the content of the returned zip file.
@@ -63,7 +63,7 @@ module Metaforce
     #
     # Returns self.
     def extract_to(destination)
-      return on_complete { |job| job.extract_to(destination) } unless @id
+      return on_complete { |job| job.extract_to(destination) } unless started?
       Zip::ZipFile.open(tmp_zip_file) do |zip|
         zip.each do |f|
           path = File.join(destination, f.name)

data/lib/metaforce/metadata/client/crud.rb

@@ -36,7 +36,7 @@ module Metaforce
         #
         # Examples
         #
-        #   client._update(:apex_page, 'OldPage', :full_name => 'NewPage')
+        #   client._update(:apex_page, 'OldPage', :full_name => 'TestPage', :label => 'Test page', :content => '<apex:page>hello world</apex:page>')
         def _update(type, current_name, metadata={})
           type = type.to_s.camelize
           request :update do |soap|
@@ -70,7 +70,7 @@ module Metaforce
 
         # Internal: Prepare metadata by base64 encoding any content keys.
         def prepare(metadata)
-          metadata = [metadata] unless metadata.is_a? Array
+          metadata = Array[metadata].compact.flatten
           metadata.each { |m| encode_content(m) }
           metadata
         end

data/lib/metaforce/metadata/client/file.rb

@@ -97,7 +97,7 @@ module Metaforce
           package = if manifest.is_a?(Metaforce::Manifest)
             manifest
           elsif manifest.is_a?(String)
-            Metaforce::Manifest.new(File.open(manifest).read)
+            Metaforce::Manifest.new(::File.open(manifest).read)
           end
           options = {
             :api_version    => Metaforce.configuration.api_version,

data/lib/metaforce/reporters.rb

@@ -0,0 +1,2 @@
+require 'metaforce/reporters/deploy_reporter'
+require 'metaforce/reporters/retrieve_reporter'

data/lib/metaforce/reporters/base_reporter.rb

@@ -0,0 +1,56 @@
+require 'thor/shell/color'
+
+module Metaforce
+  module Reporters
+    class BaseReporter < Thor::Shell::Color
+      def initialize(results)
+        super()
+        @results = results
+      end
+
+      def report
+      end
+
+      def report_problems
+        return unless problems?
+        say
+        say "Problems:", :red
+        say
+        problems.each { |message| problem(message) }
+      end
+
+      def problem(message)
+        say "#{short_padding}#{message.file_name}:#{message.line_number}", :red
+        say "#{long_padding}#{message.problem}"
+        say
+      end
+
+      def short_padding
+        '  '
+      end
+
+      def long_padding
+        '     '
+      end
+
+      def problems?
+        problems.any?
+      end
+
+      def issues?
+        problems?
+      end
+
+    private
+
+      def messages
+        @messages ||= Array[@results.messages].compact.flatten
+      end
+
+      def problems
+        messages.select { |message| message.problem }
+      end
+
+    end
+  end
+end

data/lib/metaforce/reporters/deploy_reporter.rb

@@ -0,0 +1,69 @@
+require 'metaforce/reporters/base_reporter'
+
+module Metaforce
+  module Reporters
+    class DeployReporter < BaseReporter
+
+      def report
+        report_problems
+        report_failed_tests
+        report_test_results if report_test_results?
+      end
+
+      def report_failed_tests
+        return unless failures?
+        say
+        say "Failures:", :red
+        say
+        failures.each { |failure| failed(failure) }
+      end
+
+      def report_test_results
+        say
+        say "Finished in #{total_time} seconds"
+        say "#{num_tests} tests, #{num_failures} failures", failures? ? :red : :green
+      end
+
+      def failed(failure)
+        say "#{short_padding}#{failure.stack_trace}:", :red
+        say "#{long_padding}#{failure.message}"
+        say
+      end
+
+      def failures?
+        num_failures > 0
+      end
+
+      def issues?
+        problems? || failures?
+      end
+
+    private
+
+      def report_test_results?
+        @results.success && problems.empty?
+      end
+
+      def test_results
+        @results.run_test_result
+      end
+
+      def failures
+        @failures ||= Array[test_results.failures].compact.flatten
+      end
+
+      def total_time
+        test_results.total_time
+      end
+
+      def num_tests
+        test_results.num_tests_run.to_i
+      end
+
+      def num_failures
+        test_results.num_failures.to_i
+      end
+
+    end
+  end
+end

data/lib/metaforce/reporters/retrieve_reporter.rb

@@ -0,0 +1,11 @@
+require 'metaforce/reporters/base_reporter'
+
+module Metaforce
+  module Reporters
+    class RetrieveReporter < BaseReporter
+      def report
+        report_problems
+      end
+    end
+  end
+end

data/lib/metaforce/version.rb

@@ -1,3 +1,3 @@
 module Metaforce
-  VERSION = '1.0.0a'
+  VERSION = '1.0.0'
 end

data/metaforce.gemspec

@@ -24,7 +24,10 @@ EOL
   s.add_dependency 'savon', '~> 1.2.0'
   s.add_dependency 'rubyzip', '~> 0.9.9'
   s.add_dependency 'activesupport'
-  s.add_dependency 'hashie'
+  s.add_dependency 'hashie', '~> 1.2.0'
+  s.add_dependency 'thor', '~> 0.16.0'
+  s.add_dependency 'listen', '~> 0.6.0'
+  s.add_dependency 'rb-fsevent', '~> 0.9.1'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/spec/lib/cli_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'metaforce/cli'
+
+describe Metaforce::CLI do
+  before do
+    Metaforce::Client.any_instance.stub(:deploy).and_return(double('deploy job').as_null_object)
+    Metaforce::Client.any_instance.stub(:retrieve).and_return(double('retrieve job').as_null_object)
+    subject.stub(:config).and_return(nil)
+  end
+
+  describe 'credentials' do
+    let(:output) { capture(:stdout) { subject.deploy('./path') } }
+
+    context 'when supplied credentials from the command line' do
+      let(:options) { indifferent_hash(:username => 'foo', :password => 'bar', :security_token => 'token', :deploy_options => {}) }
+
+      it 'uses supplied credentials from command line' do
+        subject.options = options
+        Metaforce.should_receive(:new).with(indifferent_hash(options).slice(:username, :password, :security_token)).and_call_original
+        output.should include('Deploying: ./path')
+      end
+    end
+
+    context 'when supplied credentials from config file' do
+      let(:options) { indifferent_hash(:environment => 'production', :deploy_options => {}) }
+      let(:config) { { 'username' => 'foo', 'password' => 'bar', 'security_token' => 'token' } }
+
+      it 'uses credentials from the config file' do
+        subject.options = options
+        subject.stub(:config).and_return('production' => config)
+        Metaforce.should_receive(:new).with(indifferent_hash(config)).and_call_original
+        output.should include('Deploying: ./path')
+      end
+    end
+  end
+
+  def indifferent_hash(hash)
+    Thor::CoreExt::HashWithIndifferentAccess.new(hash)
+  end
+end

data/spec/lib/job/deploy_spec.rb

@@ -5,28 +5,29 @@ describe Metaforce::Job::Deploy do
   let(:path) { File.expand_path('../../../fixtures/payload.zip', __FILE__) }
   let(:job) { described_class.new client, path }
 
-  describe '.payload' do
-    subject { job.payload }
+  describe '.perform' do
+    subject { job.perform }
 
     context 'when the path is a file' do
-      it { should be_a String }
+      before do
+        client.should_receive(:_deploy).with(/^UEsDBA.*/, {}).and_return(Hashie::Mash.new(id: '1234'))
+        client.should_receive(:status).any_number_of_times.and_return(Hashie::Mash.new(done: true, state: 'Completed'))
+      end
+
+      it { should eq job }
+      its(:id) { should eq '1234' }
     end
 
     context 'when the path is a directory' do
-      let(:path) { File.expand_path('../../../fixtures', __FILE__) }
-      it { should be_a String }
-    end
-  end
+      before do
+        client.should_receive(:_deploy).with(/.*1stwAAAJI.*/, {}).and_return(Hashie::Mash.new(id: '1234'))
+        client.should_receive(:status).any_number_of_times.and_return(Hashie::Mash.new(done: true, state: 'Completed'))
+      end
 
-  describe '.perform' do
-    before do
-      client.should_receive(:_deploy).with(job.payload, {}).and_return(Hashie::Mash.new(id: '1234'))
-      client.should_receive(:status).any_number_of_times.and_return(Hashie::Mash.new(done: true, state: 'Completed'))
+      let(:path) { File.expand_path('../../../fixtures', __FILE__) }
+      it { should eq job }
+      its(:id) { should eq '1234' }
     end
-
-    subject { job.perform }
-    it { should eq job }
-    its(:id) { should eq '1234' }
   end
 
   describe '.result' do

data/spec/lib/job_spec.rb

@@ -11,6 +11,22 @@ describe Metaforce::Job do
     end
   end
 
+  describe '.started?' do
+    subject { job.started? }
+
+    context 'when .perform has been called and an @id has been set' do
+      before do
+        job.instance_variable_set(:@id, '1234')
+      end
+
+      it { should be_true }
+    end
+
+    context 'when .perform has not been called and no @id has been set' do
+      it { should be_false }
+    end
+  end
+
   describe '.on_complete' do
     it 'allows the user to register an on_complete callback' do
       client.should_receive(:status).any_number_of_times.and_return(Hashie::Mash.new(done: true, state: 'Completed'))
@@ -67,7 +83,7 @@ describe Metaforce::Job do
 
     context 'when done' do
       before do
-        client.should_receive(:status).twice.and_return(Hashie::Mash.new(done: true, state: 'Completed'))
+        client.should_receive(:status).and_return(Hashie::Mash.new(done: true, state: 'Completed'))
       end
 
       it { should eq 'Completed' }
@@ -85,7 +101,7 @@ describe Metaforce::Job do
   %w[Queued InProgress Completed Error].each do |state|
     describe ".#{state.underscore}?" do
       before do
-        client.should_receive(:status).twice.and_return(Hashie::Mash.new(done: true, state: state))
+        client.should_receive(:status).and_return(Hashie::Mash.new(done: true, state: state))
       end
 
       subject { job.send(:"#{state.underscore}?") }

data/spec/lib/reporters/base_reporter_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'metaforce/reporters/base_reporter'
+
+describe Metaforce::Reporters::BaseReporter do
+  let(:results) { Hashie::Mash.new(success: true) }
+  let(:reporter) { described_class.new results }
+
+  describe '.problem' do
+    context 'when a line_number is present' do
+      let(:problem) { Hashie::Mash.new(file_name: 'path/file', line_number: '10', problem: 'Foobar') }
+
+      it 'prints the problem' do
+        reporter.should_receive(:say).with('  path/file:10', :red)
+        reporter.should_receive(:say).with('     Foobar')
+        reporter.should_receive(:say).with
+        reporter.problem(problem)
+      end
+    end
+
+    context 'when there is no line number present' do
+      let(:problem) { Hashie::Mash.new(file_name: 'path/file', problem: 'Foobar') }
+
+      it 'prints the problem' do
+        reporter.should_receive(:say).with('  path/file:', :red)
+        reporter.should_receive(:say).with('     Foobar')
+        reporter.should_receive(:say).with
+        reporter.problem(problem)
+      end
+    end
+  end
+
+  describe '.report_problems' do
+    context 'when there are no problems' do
+      it 'does not report any problems' do
+        reporter.should_receive(:say).never
+        reporter.should_receive(:problem).never
+        reporter.report_problems
+      end
+    end
+
+    context 'when there are problems' do
+      let(:results) { Hashie::Mash.new(success: true, messages: { problem: 'Problem', file_name: 'path/file', line_number: '10' }) }
+
+      it 'prints each problem' do
+        reporter.should_receive(:say)
+        reporter.should_receive(:say).with('Problems:', :red)
+        reporter.should_receive(:say)
+        reporter.should_receive(:problem)
+        reporter.report_problems
+      end
+    end
+  end
+
+  describe '.problems?' do
+    subject { reporter.problems? }
+
+    context 'when there are no problems' do
+      it { should be_false }
+    end
+
+    context 'when there are problems' do
+      let(:results) { Hashie::Mash.new(success: true, messages: { problem: 'Problem', file_name: 'path/file', line_number: '10' }) }
+      it { should be_true }
+    end
+  end
+
+  describe '.issues?' do
+    subject { reporter.issues? }
+
+    context 'when there are no problems' do
+      it { should be_false }
+    end
+
+    context 'when there are problems' do
+      let(:results) { Hashie::Mash.new(success: true, messages: { problem: 'Problem', file_name: 'path/file', line_number: '10' }) }
+      it { should be_true }
+    end
+  end
+end

data/spec/lib/reporters/deploy_reporter_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'metaforce/reporters/deploy_reporter'
+
+describe Metaforce::Reporters::DeployReporter do
+  let(:results) { Hashie::Mash.new(success: true) }
+  let(:reporter) { described_class.new results }
+
+  describe '.failed' do
+    let(:failure) { Hashie::Mash.new(stack_trace: 'stack trace', message: 'message') }
+
+    it 'prints the failure' do
+      reporter.should_receive(:say).with('  stack trace:', :red)
+      reporter.should_receive(:say).with('     message')
+      reporter.should_receive(:say).with
+      reporter.failed(failure)
+    end
+  end
+
+  describe '.report' do
+    context 'when the deploy was successfull' do
+      it 'should report everything' do
+        reporter.should_receive(:report_problems)
+        reporter.should_receive(:report_failed_tests)
+        reporter.should_receive(:report_test_results)
+        reporter.report
+      end
+    end
+
+    context 'when the deploy was not successful' do
+      let(:results) { Hashie::Mash.new(success: false) }
+
+      it 'should report everything except test results' do
+        reporter.should_receive(:report_problems)
+        reporter.should_receive(:report_failed_tests)
+        reporter.should_receive(:report_test_results).never
+        reporter.report
+      end
+    end
+  end
+
+  describe '.report_failed_tests' do
+    let(:results) { Hashie::Mash.new(success: true, run_test_result: { num_failures: num_failures, failures: failures }) }
+
+    context 'when there are no failed tests' do
+      let(:failures) { nil }
+      let(:num_failures) { '0' }
+
+      it 'does not report any failed tests' do
+        reporter.should_receive(:say).never
+        reporter.should_receive(:failed).never
+        reporter.report_failed_tests
+      end
+    end
+
+    context 'when there are failed tests' do
+      context 'passed as an object' do
+        let(:failures) { { stack_trace: 'stack trace', message: 'message' } }
+        let(:num_failures) { '1' }
+
+        it 'prints each failed tests' do
+          reporter.should_receive(:say)
+          reporter.should_receive(:say).with('Failures:', :red)
+          reporter.should_receive(:say)
+          reporter.should_receive(:failed)
+          reporter.report_failed_tests
+        end
+      end
+      
+      context 'passed as an array' do
+        let(:failures) { [{ stack_trace: 'stack trace', message: 'message' }, { stack_trace: 'stack trace 2', message: 'message 2' }] }
+        let(:num_failures) { '2' }
+
+        it 'prints each failed tests' do
+          reporter.should_receive(:say)
+          reporter.should_receive(:say).with('Failures:', :red)
+          reporter.should_receive(:say)
+          reporter.should_receive(:failed).twice
+          reporter.report_failed_tests
+        end
+      end
+    end
+  end
+
+  describe '.report_test_results' do
+    let(:results) { Hashie::Mash.new(success: true, run_test_result: { total_time: '20', num_tests_run: '10', num_failures: num_failures }) }
+
+    context 'when there are failures' do
+      let(:num_failures) { '5' }
+
+      it 'prints the test results in red' do
+        reporter.should_receive(:say)
+        reporter.should_receive(:say).with("Finished in 20 seconds")
+        reporter.should_receive(:say).with("10 tests, 5 failures", :red)
+        reporter.report_test_results
+      end
+    end
+
+    context 'when there are no failures' do
+      let(:num_failures) { '0' }
+
+      it 'prints the test results in red' do
+        reporter.should_receive(:say)
+        reporter.should_receive(:say).with("Finished in 20 seconds")
+        reporter.should_receive(:say).with("10 tests, 0 failures", :green)
+        reporter.report_test_results
+      end
+    end
+  end
+
+  describe '.failures?' do
+    let(:results) { Hashie::Mash.new(success: true, run_test_result: { total_time: '20', num_tests_run: '10', num_failures: num_failures }) }
+    subject { reporter.failures? }
+
+    context 'when there are failures' do
+      let(:num_failures) { '5' }
+      it { should be_true }
+    end
+
+    context 'when there are no failures' do
+      let(:num_failures) { '0' }
+      it { should be_false }
+    end
+  end
+end

data/spec/lib/reporters/retrieve_reporter_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'metaforce/reporters/retrieve_reporter'
+
+describe Metaforce::Reporters::RetrieveReporter do
+  let(:results) { Hashie::Mash.new(success: true) }
+  let(:reporter) { described_class.new results }
+
+  describe '.report' do
+    it 'reports the problems' do
+      reporter.should_receive(:report_problems)
+      reporter.report
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,17 @@
 require 'bundler'
 Bundler.require :default, :development
 require 'pp'
+require 'rspec/mocks'
 
 Dir['./spec/support/**/*.rb'].sort.each {|f| require f}
 
 RSpec.configure do |config|
+  config.mock_with :rspec
   config.include Savon::Spec::Macros
 
-  config.before(:suite) do
+  config.before(:each) do
     Metaforce::Job.disable_threading!
+    Metaforce::Job.any_instance.stub(:wait)
   end
 end
 

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: metaforce
 version: !ruby/object:Gem::Version
-  version: 1.0.0a
-  prerelease: 5
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2012-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -65,17 +65,65 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +192,8 @@ description: A Ruby gem for interacting with the Salesforce Metadata API
 email:
 - eric@ejholmes.net
 - Kevinp@madronasg.com
-executables: []
+executables:
+- metaforce
 extensions: []
 extra_rdoc_files: []
 files:
@@ -155,9 +204,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/metaforce
+- examples/.metaforce.yml
 - examples/example.rb
 - lib/metaforce.rb
 - lib/metaforce/abstract_client.rb
+- lib/metaforce/cli.rb
 - lib/metaforce/client.rb
 - lib/metaforce/config.rb
 - lib/metaforce/job.rb
@@ -169,6 +221,10 @@ files:
 - lib/metaforce/metadata/client.rb
 - lib/metaforce/metadata/client/crud.rb
 - lib/metaforce/metadata/client/file.rb
+- lib/metaforce/reporters.rb
+- lib/metaforce/reporters/base_reporter.rb
+- lib/metaforce/reporters/deploy_reporter.rb
+- lib/metaforce/reporters/retrieve_reporter.rb
 - lib/metaforce/services/client.rb
 - lib/metaforce/version.rb
 - metaforce.gemspec
@@ -192,6 +248,7 @@ files:
 - spec/fixtures/requests/retrieve/in_progress.xml
 - spec/fixtures/requests/send_email/success.xml
 - spec/fixtures/requests/update/in_progress.xml
+- spec/lib/cli_spec.rb
 - spec/lib/client_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/job/deploy_spec.rb
@@ -201,6 +258,9 @@ files:
 - spec/lib/manifest_spec.rb
 - spec/lib/metadata/client_spec.rb
 - spec/lib/metaforce_spec.rb
+- spec/lib/reporters/base_reporter_spec.rb
+- spec/lib/reporters/deploy_reporter_spec.rb
+- spec/lib/reporters/retrieve_reporter_spec.rb
 - spec/lib/services/client_spec.rb
 - spec/spec_helper.rb
 - spec/support/client.rb
@@ -223,15 +283,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4477921491118908816
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: metaforce
 rubygems_version: 1.8.23
@@ -259,6 +316,7 @@ test_files:
 - spec/fixtures/requests/retrieve/in_progress.xml
 - spec/fixtures/requests/send_email/success.xml
 - spec/fixtures/requests/update/in_progress.xml
+- spec/lib/cli_spec.rb
 - spec/lib/client_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/job/deploy_spec.rb
@@ -268,6 +326,10 @@ test_files:
 - spec/lib/manifest_spec.rb
 - spec/lib/metadata/client_spec.rb
 - spec/lib/metaforce_spec.rb
+- spec/lib/reporters/base_reporter_spec.rb
+- spec/lib/reporters/deploy_reporter_spec.rb
+- spec/lib/reporters/retrieve_reporter_spec.rb
 - spec/lib/services/client_spec.rb
 - spec/spec_helper.rb
 - spec/support/client.rb
+has_rdoc: