capistrano-blaze 0.1.0 → 0.2.0

data/.rvmrc

@@ -1 +1 @@
-rvm 1.9.3@capistrano-blaze
+rvm 1.9.3-p125@capistrano-blaze

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - ree

data/README.md

@@ -1,10 +1,10 @@
 # Capistrano::Blaze
 
-Because Capistrano::Campfire had to many dependencies and a hard setup, this is
-my attempt at making it easier.
+[![Build Status](https://secure.travis-ci.org/iain/capistrano-blaze.png?branch=master)](http://travis-ci.org/iain/capistrano-blaze)
 
-This gem has no runtime dependencies and should just work right out of the box.
-All you need to do is to provide your Campfire credentials.
+This tiny gem notifies you on Campfire when you use Capistrano.  The only
+thing you have to configure is your Campfire credentials, the proper hooks are
+automatically added.
 
 ## Installation
 
@@ -14,20 +14,6 @@ Add this line to your application's Gemfile:
 gem 'capistrano-blaze', :require => false
 ```
 
-And then execute:
-
-``` shell
-$ bundle
-```
-
-Or install it yourself as:
-
-``` shell
-$ gem install capistrano-blaze
-```
-
-## Usage
-
 Add to your `config/deploy.rb`:
 
 ``` ruby

data/capistrano-blaze.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rspec", "~> 2.9"
   gem.add_development_dependency "webmock", "~> 1.8.4"
+  gem.add_development_dependency "rake", "~> 0.9.2"
+  gem.add_dependency "json"
 end

data/lib/capistrano/blaze.rb

@@ -1,68 +1,44 @@
 require 'net/http'
 require 'json'
-require 'ostruct'
 require 'capistrano/blaze/version'
+require 'capistrano/blaze/message'
+require 'capistrano/blaze/configuration'
 require 'capistrano/blaze/recipes' if defined?(Capistrano::Configuration)
 
 module Capistrano
   module Blaze
     extend self
 
-    def configure(opts = {})
-      @config = OpenStruct.new(opts)
-      yield @config if block_given?
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
     end
 
     def speak(message)
-      port = @config.ssl ? 443 : 80
+      configuration.validate!
+      port = configuration.ssl ? 443 : 80
 
-      req = Net::HTTP::Post.new("/room/#{@config.room_id}/speak.json")
-      req.basic_auth @config.token, 'X'
+      req = Net::HTTP::Post.new("/room/#{configuration.room_id}/speak.json")
+      req.basic_auth configuration.token, 'X'
       req.body = { :message => { :body => message } }.to_json
       req.content_type = "application/json"
+      req["User-Agent"] = "Capistrano::Blaze"
 
-      res = Net::HTTP.start("#{@config.account}.campfirenow.com", port, :use_ssl => @config.ssl) do |http|
+      res = Net::HTTP.start("#{configuration.account}.campfirenow.com", port, :use_ssl => configuration.ssl) do |http|
         http.request(req)
       end
 
       if res.is_a?(Net::HTTPSuccess)
-        puts "Campfire message sent!"
+        warn "Campfire message sent!"
       else
-        puts "Campfire communication failed!"
-        puts res.inspect
-        puts res.body.inspect
+        warn "Campfire communication failed!"
+        warn res.inspect
+        warn res.body.inspect
       end
     end
 
-    def failure(context, exception)
-      speak ":warning: #{user} failed to deploy #{stage(context)}#{context.application}, via `#{command}`: #{exception.to_s} (#{exception.class.inspect})"
-    end
-
-    def success(context)
-      speak "#{user} succesfully deployed #{stage(context)}#{context.application}, via `#{command}`"
-    end
-
-    def test(context)
-      speak ":heart: #{context.application}!"
-    end
-
-    private
-
-    def stage(context)
-      if context.respond_to?(:stage)
-        "to the #{context.stage} stage of "
-      else
-        ""
-      end
-    end
-
-    def user
-      `whoami`.strip
-    end
-
-    def command
-      [ 'cap', *$* ] * ' '
-    end
-
   end
 end

data/lib/capistrano/blaze/configuration.rb

@@ -0,0 +1,38 @@
+module Capistrano
+  module Blaze
+
+    class Configuration
+
+      attr_accessor :account, :room_id, :token, :ssl
+
+      def []=(option, value)
+        send "#{option}=", value
+      end
+
+      def [](option)
+        send option
+      end
+
+      def validate!
+        %w(account room_id token).each do |option|
+          if send(option).nil?
+            fail MissingOption.new(option)
+          end
+        end
+      end
+
+      class MissingOption < RuntimeError
+
+        def initialize(option)
+          @option = option
+        end
+
+        def to_s
+          "Please specify the #{@option} option"
+        end
+
+      end
+    end
+
+  end
+end

data/lib/capistrano/blaze/message.rb

@@ -0,0 +1,75 @@
+module Capistrano
+  module Blaze
+    class Message
+
+      def self.start(context)
+        new(context).start
+      end
+
+      def self.failure(context, exception)
+        new(context, exception).failure
+      end
+
+      def self.success(context)
+        new(context).success
+      end
+
+      def self.test(context)
+        new(context).test
+      end
+
+      attr_reader :context, :exception
+
+      def initialize(context, exception = nil)
+        @context, @exception = context, exception
+      end
+
+      def start
+        speak "#{user} is deploying #{what}, via `#{command}`"
+      end
+
+      def failure
+        speak ":warning: #{user} failed to deploy #{what}, via `#{command}`: #{exception_message}"
+      end
+
+      def success
+        speak "#{user} succesfully deployed #{what}, via `#{command}`"
+      end
+
+      def test
+        speak ":heart: #{context.application}!"
+      end
+
+      private
+
+      def exception_message
+        "#{exception.to_s} (#{exception.class.inspect})"
+      end
+
+      def speak(message)
+        Blaze.speak(message)
+      end
+
+      def what
+        stage + context.application
+      end
+
+      def stage
+        if context.respond_to?(:stage)
+          "to the #{context.stage} stage of "
+        else
+          ""
+        end
+      end
+
+      def user
+        `whoami`.strip
+      end
+
+      def command
+        [ 'cap', *ARGV ] * ' '
+      end
+
+    end
+  end
+end

data/lib/capistrano/blaze/recipes.rb

@@ -2,23 +2,28 @@ Capistrano::Configuration.instance(:must_exist).load do
 
   at_exit do
     if exception = $!
-      Capistrano::Blaze.failure(self, exception)
+      Capistrano::Blaze::Message.failure(self, exception)
     end
   end
 
   namespace :campfire do
 
+    task :start do
+      Capistrano::Blaze::Message.start(self)
+    end
+
     task :success do
-      Capistrano::Blaze.success(self)
+      Capistrano::Blaze::Message.success(self)
     end
 
     desc "Sends a test message to Campfire"
     task :test_config do
-      Capistrano::Blaze.test(self)
+      Capistrano::Blaze::Message.test(self)
     end
 
   end
 
+  before "deploy",        "campfire:start"
   after "deploy:restart", "campfire:success"
 
 end

data/lib/capistrano/blaze/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Blaze
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/spec/blaze_spec.rb

@@ -0,0 +1,33 @@
+require 'capistrano/blaze'
+require 'webmock'
+
+describe Capistrano::Blaze do
+  include WebMock::API
+
+  around do |example|
+    $stderr = StringIO.new
+    example.run
+    $stderr = STDERR
+  end
+
+  it "can speak" do
+    token = "abc"
+    room_id = 1234
+    account = "abcd"
+
+    stub_request(:post, "http://#{token}:X@#{account}.campfirenow.com/room/#{room_id}/speak.json").
+    with(:body => "{\"message\":{\"body\":\"Ik ben een gem aan het maken\"}}",
+         :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Capistrano::Blaze'}).
+         to_return(:status => 200, :body => "", :headers => {})
+
+    subject.configure do |config|
+      config.account = account
+      config.room_id = room_id
+      config.token   = token
+      config.ssl     = false
+    end
+
+    subject.speak "Ik ben een gem aan het maken"
+  end
+
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,20 @@
+require 'capistrano/blaze/configuration'
+
+describe Capistrano::Blaze::Configuration do
+
+  REQUIRED = %W(account room_id token)
+
+  before do
+    REQUIRED.each do |option|
+      subject[option] = "foo"
+    end
+  end
+
+  REQUIRED.each do |option|
+    it "requires #{option} to be set" do
+      subject[option] = nil
+      expect { subject.validate! }.to raise_error("Please specify the #{option} option")
+    end
+  end
+
+end

data/spec/message_spec.rb

@@ -0,0 +1,68 @@
+require 'capistrano/blaze/message'
+
+describe Capistrano::Blaze::Message do
+
+  subject { Capistrano::Blaze::Message }
+  let(:exception) { RuntimeError.new("woops") }
+
+  before do
+    subject.any_instance.stub(:user) { "your mom" }
+  end
+
+  it "sends a test message" do
+    should_speak(":heart: basecamp!")
+    context = stub(:application => "basecamp")
+    subject.test(context)
+  end
+
+  context "with multistage extension" do
+
+    let(:context) { stub(:stage => "production", :application => "basecamp") }
+
+    it "displays a start message" do
+      should_speak("your mom is deploying to the production stage of basecamp, via `#{command}`")
+      subject.start(context)
+    end
+
+    it "displays a failure message" do
+      should_speak(":warning: your mom failed to deploy to the production stage of basecamp, via `#{command}`: woops (RuntimeError)")
+      subject.failure(context, exception)
+    end
+
+    it "displays success message" do
+      should_speak("your mom succesfully deployed to the production stage of basecamp, via `#{command}`")
+      subject.success(context)
+    end
+
+  end
+
+  context "without multistage extension" do
+
+    let(:context) { stub(:application => "basecamp") }
+
+    it "displays a start message" do
+      should_speak("your mom is deploying basecamp, via `#{command}`")
+      subject.start(context)
+    end
+
+    it "displays success message" do
+      should_speak("your mom succesfully deployed basecamp, via `#{command}`")
+      subject.success(context)
+    end
+
+    it "displays failure message" do
+      should_speak(":warning: your mom failed to deploy basecamp, via `#{command}`: woops (RuntimeError)")
+      subject.failure(context, exception)
+    end
+
+  end
+
+  def command
+    [ 'cap', *ARGV ] * ' '
+  end
+
+  def should_speak(message)
+    Capistrano::Blaze.should_receive(:speak).with(message)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-blaze
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70320790341820 !ruby/object:Gem::Requirement
+  requirement: &70252880436580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *70320790341820
+  version_requirements: *70252880436580
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70320790341320 !ruby/object:Gem::Requirement
+  requirement: &70252880436080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,29 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *70320790341320
+  version_requirements: *70252880436080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70252880435620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70252880435620
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70252880435240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70252880435240
 description: A simple campfire plugin for capistrano
 email:
 - iain@iain.nl
@@ -44,15 +66,20 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
 - capistrano-blaze.gemspec
 - lib/capistrano/blaze.rb
+- lib/capistrano/blaze/configuration.rb
+- lib/capistrano/blaze/message.rb
 - lib/capistrano/blaze/recipes.rb
 - lib/capistrano/blaze/version.rb
-- spec/camp_spec.rb
+- spec/blaze_spec.rb
+- spec/configuration_spec.rb
+- spec/message_spec.rb
 homepage: https://github.com/iain/capistrano-blaze
 licenses: []
 post_install_message: 
@@ -78,4 +105,6 @@ signing_key:
 specification_version: 3
 summary: A simple campfire plugin for capistrano
 test_files:
-- spec/camp_spec.rb
+- spec/blaze_spec.rb
+- spec/configuration_spec.rb
+- spec/message_spec.rb

data/spec/camp_spec.rb

@@ -1,63 +0,0 @@
-require 'capistrano/blaze'
-require 'webmock'
-
-describe Capistrano::Blaze do
-  include WebMock::API
-
-  it "can speak" do
-    token = "abc"
-    room_id = 1234
-    account = "abcd"
-
-    stub_request(:post, "https://#{token}:X@#{account}.campfirenow.com/room/#{room_id}/speak.json").
-    with(:body => "{\"message\":{\"body\":\"Ik ben een gem aan het maken\"}}",
-         :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
-    to_return(:status => 200, :body => "", :headers => {})
-
-    subject.configure do |config|
-      config.account = account
-      config.room_id = room_id
-      config.token   = token
-      config.ssl     = true
-    end
-    subject.speak "Ik ben een gem aan het maken"
-  end
-
-  before do
-    subject.stub(:user) { "iain" }
-  end
-
-  it "displays a failure message" do
-    subject.should_receive(:speak).with(":warning: iain failed to deploy to the production stage of basecamp, via `cap #{ARGV.join(' ')}`: woops (RuntimeError)")
-    context = stub(:stage => "production", :application => "basecamp")
-    exception = RuntimeError.new("woops")
-    subject.failure(context, exception)
-  end
-
-  it "displays success message" do
-    subject.should_receive(:speak).with("iain succesfully deployed to the production stage of basecamp, via `cap #{ARGV.join(' ')}`")
-    context = stub(:stage => "production", :application => "basecamp")
-    subject.success(context)
-  end
-
-  it "sends a test message" do
-    subject.should_receive(:speak).with(":heart: basecamp!")
-    context = stub(:application => "basecamp")
-    subject.test(context)
-  end
-
-  it "displays success message without a stage" do
-    subject.should_receive(:speak).with("iain succesfully deployed basecamp, via `cap #{ARGV.join(' ')}`")
-    context = stub(:application => "basecamp")
-    subject.success(context)
-  end
-
-  it "displays failure message without a stage" do
-    subject.should_receive(:speak).with(":warning: iain failed to deploy basecamp, via `cap #{ARGV.join(' ')}`: woops (RuntimeError)")
-    context = stub(:application => "basecamp")
-    exception = RuntimeError.new("woops")
-    subject.failure(context, exception)
-  end
-
-
-end