capistrano-grove 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Spike Grobstein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Capistrano grove.io notifications
+
+Easily send notifications to your [grove.io](http://grove.io) channel after a deploy.
+
+## Getting started
+
+In your application's `Gemfile` put the following:
+
+    gem 'capistrano-grove', 'git://github.com/spikegrobstein/capistrano-grove.git'
+
+At the top of your `Capfile` you should also add the following:
+
+    require 'grove/capistrano'
+
+Once you get your gems installed via `bundle install`, you can configure
+`capistrano-grove`.
+
+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_channel_key, 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+
+`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.
+
+To automatially notify on grove.io after a deploy, set an `after` hook:
+
+    after 'deploy', 'grove:notify'
+
+## Variables
+
+### grove_channel_key
+
+The channel key 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.
+
+### grove_icon_url
+
+This is the URL to the icon that your notification uses.
+
+### grove_url
+
+When clicking your notification in the grove.io notification window, this is the URL
+that you're taken to.
+
+### grove_message
+
+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.
+
+It defaults to:
+
+    "Successful deployment of #{ fetch(:application, 'application') }."
+
+## Author
+
+`capistrano-grove` is written by Spike Grobstein  
+spikegrobstein@mac.com  
+http://spike.grobste.in  
+https://github.com/spikegrobstein  
+
+## License
+
+©2012 Spike Grobstein
+MIT License (see `LICENSE` file included in this package).
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano-grove.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "capistrano-grove/version"
+
+Gem::Specification.new do |s|
+  s.name        = "capistrano-grove"
+  s.version     = Capistrano::Grove::VERSION
+  s.authors     = ["Spike Grobstein"]
+  s.email       = ["spikegrobstein@mac.com"]
+  s.homepage    = "https://github.com/spikegrobstein/capistrano-grove"
+  s.summary     = %q{Post to grove.io after a deploy.}
+  s.description = %q{Customizable Capistrano tasks for communicating with the grove.io webservice.}
+
+  s.rubyforge_project = "capistrano-grove"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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('grove-rb', '>= 0.2.0')
+end

data/lib/capistrano-grove/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Grove
+    VERSION = "1.0.0"
+  end
+end

data/lib/capistrano-grove.rb

@@ -0,0 +1,20 @@
+require "capistrano-grove/version"
+require "grove-rb"
+
+module Capistrano
+  module Grove
+
+    class Client
+      attr_accessor :grove_client
+
+      def initialize(channel_key, options)
+        @grove_client = ::Grove.new(channel_key, options)
+      end
+
+      def notify(message)
+        !( @grove_client.post(message).status >= 400 )
+      end
+    end
+
+  end
+end

data/lib/grove/capistrano.rb

@@ -0,0 +1,43 @@
+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

@@ -0,0 +1,73 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'capistrano-grove'
+
+Rspec.configure do |config|
+  # config
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-grove
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Spike Grobstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 2
+        - 12
+        - 0
+        version: 2.12.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: grove-rb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id002
+description: Customizable Capistrano tasks for communicating with the grove.io webservice.
+email: 
+- spikegrobstein@mac.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-grove.gemspec
+- lib/capistrano-grove.rb
+- lib/capistrano-grove/version.rb
+- lib/grove/capistrano.rb
+- spec/grove/capistrano_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spikegrobstein/capistrano-grove
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: capistrano-grove
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Post to grove.io after a deploy.
+test_files: 
+- spec/grove/capistrano_spec.rb
+- spec/spec_helper.rb