capistrano-grove 1.0.1 → 2.0.0pre

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7
+  - ree
+script: bundle exec rspec spec

data/CHANGELOG

@@ -1,3 +1,10 @@
+2013-04-XX => v2.0.0pre
+
+* complete rewrite to be a true Capistrano extension
+* now built on Capnotify
+* changed grove_channel_key to grove_channel_token
+* got rid of grove_message
+
 2012-05-29 => v1.0.1
 
 documentation changes

data/Gemfile

@@ -2,4 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in capistrano-grove.gemspec
 gemspec
-gem 'rspec'

data/README.md

@@ -1,78 +1,104 @@
-# Capistrano grove.io notifications
+# Capistrano::Grove [![Build Status](https://travis-ci.org/spikegrobstein/capistrano-grove.png)](https://travis-ci.org/spikegrobstein/capistrano-grove)
 
-Easily send notifications to your [grove.io](http://grove.io) channel after a deploy.
+Note: This documentation is for the as yet to be released version 2.0.0 of Capistrano::Grove.
+I expect this to be ready for release in the next few days.
 
-## Getting started
+Send deployment notifications to your [grove.io](http://grove.io) channel via Capistrano.
+Never again will members of your team not be made aware of events during your deployment.
+Alert them to maintenance page changes, migrations and deployment events by using this gem.
+
+## Installation
 
-In your application's `Gemfile` put the following:
+Add this line to your application's Gemfile:
 
     gem 'capistrano-grove'
 
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-grove
+
+In your `Capfile`, add:
 
-Once you get your gems installed via `bundle install`, you can configure
-`capistrano-grove`.
+    require 'capistrano-grove'
 
-Alternatively, you can install `capistrano-grove` via `gem`:
+## Getting started
+
+Capistrano::Grove is built on Capnotify which provides a series of built-in notifications.
+This gem plugs into those notifications and sends them to your grove.io channel.
+
+Once you've gone through the above installation procedure, all you need to do is set
+your `grove_channel_token` as a Capistrano variable as follows:
 
-    gem install capistrano-grove
+    set :grove_channel_token, 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 
-At the top of your `Capfile` you should also add the following:
+With that, you'll start receiving notifications to your channel for migrations,
+deployment and maintenance page changes.
 
-    require 'grove/capistrano'
+In addition to the above, you can configure how your messages appear:
 
-The only required parameter to use this plugin is the `grove_channel_key` variable.
-You can get your channel key from the grove.io website. Initialize it as follows:
+    set :grove_service_name, 'MyDeployer'
+    set :grove_icon_url, 'https://grove.io/static/img/webapp-logo.png'
+    set :grove_url, 'http://example.com'
 
-    set :grove_channel_key, 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+Because Capistrano::Grove is built on Capnotify, you should refer to that documentation
+for further customizing the messages that are posted to your channel:
 
-`capistrano-grove` comes with one task: `grove:notify`. This task posts the
-`grove_message` variable to the grove.io service and will be usable after you set
-the above variable.
+https://github.com/spikegrobstein/capnotify
 
-To automatially notify on grove.io after a deploy, set an `after` hook:
+You can also use the `grove.notify` function anywhere in your Capistrano recipes to post
+messages to your channel ad-hoc. For example:
 
-    after 'deploy', 'grove:notify'
+    grove.notify 'Greetings from Capistrano!'
 
 ## Variables
 
-### grove_channel_key
+The following are Capistrano variables and are used via the `set` function.
 
-The channel key from the grove.io website. This is the only variable that is required
-to get `capistrano-grove` working.
+### grove_channel_token
+
+The channel token from the grove.io website. This is the only variable that is required
+to get Capistrano::Grove working.
 
 ### grove_service
 
-The name of the service that the notification comes from. This should not contain
-spaces as that causes the grove.io webservice some grief.
+The name of the service, aka the handle of the user, that the notification comes from.
+This defaults to 'Deploybot'
+
+*This should not contain spaces as that causes the grove.io webservice some grief.*
 
 ### grove_icon_url
 
-This is the URL to the icon that your notification uses.
+This should be a URL to an image that the service will use as its avatar in the channel.
 
 ### grove_url
 
 When clicking your notification in the grove.io notification window, this is the URL
 that you're taken to.
 
-### grove_message
+## Functions
+
+### grove.notify
 
-Each time that the `grove:notify` task is run, `grove_message` is the message that
-is posted. Typically, you'd want to set this with a block so it can be lazily
-evaluated.
+Capistrano::Grove comes with a single function: `grove.notify` for posting messages
+to your channel. It takes a single parameter-the message to post.
 
-It defaults to:
+Example:
 
-    "Successful deployment of #{ fetch(:application, 'application') }."
+    grove.notify "That was easy!"
 
 ## Author
 
-`capistrano-grove` is written by Spike Grobstein  
+Capistrano::Grove is written by Spike Grobstein  
 spikegrobstein@mac.com  
 http://spike.grobste.in  
 https://github.com/spikegrobstein  
 
 ## License
 
-©2012 Spike Grobstein
+©2012-2013 Spike Grobstein  
 MIT License (see `LICENSE` file included in this package).
 

data/capistrano-grove.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency('capistrano', '>= 2.12.0')
+  s.add_dependency('capnotify', "~> 0.1pre")
   s.add_dependency('grove-rb', '>= 0.2.0')
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('pry')
 end

data/lib/capistrano-grove/client.rb

@@ -0,0 +1,16 @@
+module Capistrano
+  module Grove
+    class Client
+      attr_accessor :grove_client
+
+      def initialize(channel_key, options)
+        @grove_client = ::Grove.new(channel_key, options)
+      end
+
+      # post +message+ as a notification. Returns true om-success and false on-failure.
+      def notify(message)
+        !( @grove_client.post(message).status >= 400 )
+      end
+    end
+  end
+end

data/lib/capistrano-grove/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Grove
-    VERSION = "1.0.1"
+    VERSION = "2.0.0pre"
   end
 end

data/lib/capistrano-grove.rb

@@ -1,21 +1,61 @@
+require "capnotify"
 require "capistrano-grove/version"
+require "capistrano-grove/client"
 require "grove-rb"
 
 module Capistrano
   module Grove
 
-    class Client
-      attr_accessor :grove_client
+    def self.load_into(config)
+      config.load do
+        Capistrano.plugin :grove, Capistrano::Grove
+
+        def _cset(name, *args, &block)
+          unless exists?(name)
+            set(name, *args, &block)
+          end
+        end
+
+        # the channel's API key
+        _cset(:grove_channel_token) { abort "Please set grove_channel_token!" }
+
+        # the name of the service doing the posting
+        _cset :grove_service, 'DeployBot'
+
+        # url to the icon to use.
+        _cset :grove_icon_url, nil
+
+        # the url you want to use for your bot
+        _cset :grove_url, nil
+
+        # capnotify hooks
+        on(:deploy_start) { grove.notify fetch(:capnotify_deploy_start_msg) }
+        on(:deploy_complete) { grove.notify fetch(:capnotify_deploy_complete_msg) }
+        on(:migrate_start) { grove.notify fetch(:capnotify_migrate_start_msg) }
+        on(:migrate_complete) { grove.notify fetch(:capnotify_migrate_complete_msg) }
+        on(:maintenance_page_up) { grove.notify fetch(:capnotify_maintenance_page_up_msg) }
+        on(:maintenance_page_down) { grove.notify fetch(:capnotify_maintenance_page_down_msg) }
 
-      def initialize(channel_key, options)
-        @grove_client = ::Grove.new(channel_key, options)
       end
+    end
+
+    # send a notification to the grove service
+    def notify(message)
+      g = Client.new(grove_channel_token,
+        :service => grove_service,
+        :icon_url => grove_icon_url,
+        :url => grove_url
+      )
 
-      # post +message+ as a notification. Returns true om-success and false on-failure.
-      def notify(message)
-        !( @grove_client.post(message).status >= 400 )
+      unless g.notify(message)
+        # error
+        logger.important "Failed to send notification to grove.io"
       end
     end
 
   end
 end
+
+if Capistrano::Configuration.instance
+  Capistrano::Grove.load_into(Capistrano::Configuration.instance)
+end

data/spec/capistrano-grove_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Capistrano::Grove do
+
+  let(:config) { Capistrano::Configuration.new }
+  let(:client) { double('grove').as_null_object }
+
+  before do
+    Capistrano::Grove.load_into(config)
+  end
+
+
+  context "when notifying" do
+    context "when failing to set grove_channel_token" do
+
+      it "should raise an error" do
+        expect { config.grove.notify }.to raise_error
+      end
+
+    end
+
+    context "when grove_channel_token is set" do
+      before do
+        config.load do
+          set :grove_channel_token, 'asdfasdfasdf'
+        end
+      end
+
+      after do
+        config.grove.notify 'msg'
+      end
+
+      it "should use :grove_channel_token" do
+        new_channel_token = '12345678901234567890123456789012'
+        config.set(:grove_channel_token, new_channel_token)
+
+        client.stub(:notify => true)
+
+        Capistrano::Grove::Client.should_receive(:new).with do |channel_token, options|
+          channel_token.should == new_channel_token
+        end.and_return(client)
+      end
+
+      it "should use :grove_service" do
+        new_grove_service = 'testing-service'
+        config.set(:grove_service, new_grove_service)
+
+        client.stub(:notify => true)
+
+        Capistrano::Grove::Client.should_receive(:new).with do |channel_token, options|
+          options[:service].should == new_grove_service
+        end.and_return(client)
+      end
+
+      it "should use :grove_icon_url" do
+        new_grove_icon_url = 'http://example.com/testing/icon.png'
+        config.set(:grove_icon_url, new_grove_icon_url)
+
+        client.stub(:notify => true)
+
+        Capistrano::Grove::Client.should_receive(:new).with do |channel_token, options|
+          options[:icon_url].should == new_grove_icon_url
+        end.and_return(client)
+      end
+
+      it "should use :grove_url" do
+        new_grove_url = 'http://testing.com/capistrano-grove'
+        config.set(:grove_url, new_grove_url)
+
+        client.stub(:notify => true)
+
+        Capistrano::Grove::Client.should_receive(:new).with do |channel_token, options|
+          options[:url].should == new_grove_url
+        end.and_return(client)
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,7 +2,5 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'capistrano-grove'
+require 'pry'
 
-Rspec.configure do |config|
-  # config
-end

metadata

@@ -1,66 +1,90 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: capistrano-grove
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
+version: !ruby/object:Gem::Version
+  version: 2.0.0pre
+  prerelease: 5
 platform: ruby
-authors: 
+authors:
 - Spike Grobstein
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: capistrano
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2013-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capnotify
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 2
-        - 12
-        - 0
-        version: 2.12.0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1pre
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: grove-rb
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1pre
+- !ruby/object:Gem::Dependency
+  name: grove-rb
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 0
-        - 2
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Customizable Capistrano tasks for communicating with the grove.io webservice.
-email: 
+email:
 - spikegrobstein@mac.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -68,43 +92,37 @@ files:
 - Rakefile
 - capistrano-grove.gemspec
 - lib/capistrano-grove.rb
+- lib/capistrano-grove/client.rb
 - lib/capistrano-grove/version.rb
-- lib/grove/capistrano.rb
-- spec/grove/capistrano_spec.rb
+- spec/capistrano-grove/client_spec.rb
+- spec/capistrano-grove_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/spikegrobstein/capistrano-grove
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: capistrano-grove
-rubygems_version: 1.8.12
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Post to grove.io after a deploy.
-test_files: 
-- spec/grove/capistrano_spec.rb
+test_files:
+- spec/capistrano-grove/client_spec.rb
+- spec/capistrano-grove_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/grove/capistrano.rb

@@ -1,43 +0,0 @@
-require 'capistrano'
-require 'capistrano-grove'
-
-module Capistrano
-  module Grove
-
-    def self.load_into(config)
-      config.load do
-        set :grove_channel_key, '' # the channel's API key
-        set :grove_service, 'DeployBot' # the name of the service posting
-        set :grove_icon_url, nil # url to the icon to use.
-        set :grove_url, nil # the url you want to use for your bot
-
-        # the message that gets posted.
-        # set this before calling grove:notify to customize
-        set(:grove_message) {
-          "Successful deployment of #{ fetch(:application, 'application') }."
-        }
-
-        namespace :grove do
-
-          desc "Notify the grove.io service."
-          task :notify do
-            g = Client.new(grove_channel_key,
-              :service => grove_service,
-              :icon_url => grove_icon_url,
-              :url => grove_url
-            )
-
-            unless g.notify(grove_message)
-              # error
-              logger.important "Failed to send notification to grove.io"
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-if Capistrano::Configuration.instance
-  Capistrano::Grove.load_into(Capistrano::Configuration.instance)
-end

data/spec/grove/capistrano_spec.rb

@@ -1,73 +0,0 @@
-require 'capistrano'
-require 'grove-rb'
-
-require File.dirname(__FILE__) + '/../../lib/grove/capistrano'
-
-describe Capistrano::Grove do
-
-  let(:config) { Capistrano::Configuration.new }
-  let(:grove) { double('grove').as_null_object }
-
-  context "when notifying" do
-
-    before do
-      Capistrano::Grove.load_into(config)
-    end
-
-    after do
-      config.find_and_execute_task('grove:notify')
-    end
-
-    it "should notify with the :grove_message" do
-      Capistrano::Grove::Client.should_receive(:new).and_return(grove)
-
-      grove.should_receive(:notify).with(config.fetch(:grove_message)).and_return(true)
-    end
-
-    it "should use :grove_channel_key" do
-      new_channel_key = '12345678901234567890123456789012'
-      config.set(:grove_channel_key, new_channel_key)
-
-      grove.stub(:notify => true)
-
-      Capistrano::Grove::Client.should_receive(:new).with do |channel_key, options|
-        channel_key.should == new_channel_key
-      end.and_return(grove)
-    end
-
-    it "should use :grove_service" do
-      new_grove_service = 'testing-service'
-      config.set(:grove_service, new_grove_service)
-
-      grove.stub(:notify => true)
-
-      Capistrano::Grove::Client.should_receive(:new).with do |channel_key, options|
-        options[:service].should == new_grove_service
-      end.and_return(grove)
-    end
-
-    it "should use :grove_icon_url" do
-      new_grove_icon_url = 'http://example.com/testing/icon.png'
-      config.set(:grove_icon_url, new_grove_icon_url)
-
-      grove.stub(:notify => true)
-
-      Capistrano::Grove::Client.should_receive(:new).with do |channel_key, options|
-        options[:icon_url].should == new_grove_icon_url
-      end.and_return(grove)
-    end
-
-    it "should use :grove_url" do
-      new_grove_url = 'http://testing.com/capistrano-grove'
-      config.set(:grove_url, new_grove_url)
-
-      grove.stub(:notify => true)
-
-      Capistrano::Grove::Client.should_receive(:new).with do |channel_key, options|
-        options[:url].should == new_grove_url
-      end.and_return(grove)
-    end
-
-  end
-
-end