capistrano-graphite 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18deacceaca3890caa99490258ed690811809046
-  data.tar.gz: e2fc734a73eb86aa383fb8aea34d67115d172077
+  metadata.gz: 70d0ed119d1db1f582739a0c79a67738d70868da
+  data.tar.gz: 6ee519436aab9d5aacfb09fa9e33c01cbd290ed9
 SHA512:
-  metadata.gz: c403ed3564b6cfee20be9ea3da31f1b2dd754c86af188f99cddf2664c30f33dc0c7ad350538cc785157dcdfc52675169a35859295420dbd576a171513d742bd2
-  data.tar.gz: b631cd59c8fc6cf95e1c2eb23f42212da10033256e4ae1176ed0ed05c5ad0a2ee1600a00fedce1951fcee69557dbe33a44eb451fb1fbf4a004534731148d6141
+  metadata.gz: 58570d882766488334b815965e85713b25efd6398901fe7288302d1c623db36f03f371f572c37f44042f1169699396631fb9fe34c4dc8fb2872fb9836c62bee1
+  data.tar.gz: 4f6ebe2ec90c0b33b43d033c21f1b3a1b4a219aef84760956f366895f9d903a8384f60e9512242f8506c6c647ecc04fe74b001aad7e44a01a235af1a79d8b989

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
   - 2.1.0
+  - 2.0.0
+  - 1.9.3

data/README.md

@@ -1,20 +1,26 @@
 # Capistrano::Graphite
 [![Gem Version](http://img.shields.io/gem/v/capistrano-graphite.svg)][gem]
+[![Dependency Status](http://img.shields.io/gemnasium/scottsuch/capistrano-graphite.svg)][gemnasium]
 [![Build Status](http://img.shields.io/travis/scottsuch/capistrano-graphite.svg)][travis]
 [![Code Climate](http://img.shields.io/codeclimate/github/scottsuch/capistrano-graphite.svg)][codeclimate]
 
 [gem]: https://rubygems.org/gems/capistrano-graphite
+[gemnasium]: https://gemnasium.com/scottsuch/capistrano-graphite
 [travis]: http://travis-ci.org/scottsuch/capistrano-graphite
-[codeclimate]: https://codeclimate.com/githubscottsuch/capistrano-graphite
-This gem extends capistrano's deploy functionality by pushing events to graphite.
+[codeclimate]: https://codeclimate.com/github/scottsuch/capistrano-graphite
+This gem works with Capistrano v3.1.0 and above and was based off the work on [this gem](For a gem that works with older versions of Capistrano look [here](https://github.com/hellvinz/graphite-notify) which works with Capistrano v2.x.
+
+Adding this gem to [Capistrano](https://github.com/capistrano/capistrano) deploy extends functionality by pushing events to graphite.
 Currently events are only pushed after ```deploy:updated``` and ```deploy:reverted```.
-Some information on events can be found in [this nice writeup](http://obfuscurity.com/2014/01/Graphite-Tip-A-Better-Way-to-Store-Events).
-This gem works with capistrano v3.1.0 and above.
-For a gem that works with older versions of capistrano go [here](https://github.com/hellvinz/graphite-notify).
+
+Some information on events can be found in [this article](http://obfuscurity.com/2014/01/Graphite-Tip-A-Better-Way-to-Store-Events).
 
 ## Installation
+Install it manually:
 
-Add this line to your application's Gemfile:
+    $ gem install capistrano-graphite
+
+Otherwise, add this line to your application's Gemfile:
 
     gem 'capistrano-graphite'
 
@@ -22,23 +28,29 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
+### Setup your application
+Add the following line to your ```Capfile```.
+
+    require "capistrano/graphite"
 
-    $ gem install capistrano-graphite
+### Configurable options
+Path to your graphite instance
 
-## Usage
+    set :graphite_url, "http://example.com:8000/events/"  # The port distinction is optional
 
-Require in ```Capfile``` to use the default tasks:
+Disable sending events for a particular stage by setting the following to 0
 
-    require "capistrano/graphite"
+    set :graphite_enable_events, 0                        # This is set to 1 by default
 
-Configurable options
+### Test that it's working
+You can run the following on it's own assuming you have configured the graphite url
 
-    set :graphite_url, "http://example.com:8000/events/"
+    $ bundle exec cap <stage> deploy:graphite_deploy
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/capistrano-graphite/fork )
+1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/capistrano-graphite.gemspec

@@ -8,13 +8,16 @@ Gem::Specification.new do |spec|
   spec.version       = Capistrano::Graphite::VERSION
   spec.authors       = ["scottsuch"]
   spec.email         = ["sgorsuch@gmail.com"]
-  spec.summary       = %q{Send deploy events to graphite via capistrano}
+  spec.summary       = %q{A gem for pushing graphite events via capistrano v3
+                          deployment}
   spec.description   = %q{This gem plugs into the deploy task in capistrano to
                           help provide visibility to when deployments were
                           deployed.}
   spec.homepage      = "https://github.com/scottsuch/capistrano-graphite"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '> 1.9'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})

data/lib/capistrano/graphite.rb

@@ -4,24 +4,34 @@ require 'uri'
 
 set :local_user, ENV['USER']
 
-namespace :deploy do
-  desc 'notify graphite that a deployment occured'
-  task :graphite_deploy do
+class GraphiteInterface
+  def self.post_event(action)
     uri = URI::parse("#{fetch(:graphite_url)}")
     Net::HTTP.start(uri.host, uri.port)  do |http|
-      http.post(uri.path, "{\"what\": \"deploy #{fetch(:application)} in #{fetch(:stage)}\", \"tags\": \"#{fetch(:application)},#{fetch(:stage)},#{release_timestamp},deploy\", \"data\": \"#{fetch(:local_user)}\"}")
+      http.post(uri.path, "{\"what\": \"#{action} #{fetch(:application)} in #{fetch(:stage)}\", \"tags\": \"#{fetch(:application)},#{fetch(:stage)},#{release_timestamp},#{action}\", \"data\": \"#{fetch(:local_user)}\"}")
     end
   end
+end
+
+namespace :deploy do
+  desc 'notify graphite that a deployment occured'
+  task :graphite_deploy do
+    action = "deploy"
+    GraphiteInterface.post_event(action)
+  end
 
   desc 'notify graphite that a rollback occured'
   task :graphite_rollback do
-    uri = URI::parse("#{fetch(:graphite_url)}")
-    Net::HTTP.start(uri.host, uri.port)  do |http|
-      http.post(uri.path, "{\"what\": \"rollback #{fetch(:application)} in #{fetch(:stage)}\", \"tags\": \"#{fetch(:application)},#{fetch(:stage)},#{release_timestamp},rollback\", \"data\": \"#{fetch(:local_user)}\"}")
-    end
+    action = "rollback"
+    GraphiteInterface.post_event(action)
   end
 
-  # Set the order for these tasks
-  after 'deploy:updated', 'deploy:graphite_deploy'
-  after 'deploy:reverted', 'deploy:graphite_rollback'
+  # Check the graphite_enable_events option
+  if "#{fetch(:graphite_enable_events)}".to_i == 0
+    puts "No events will be sent to graphite."
+  else
+    # Set the order for these tasks
+    after 'deploy:updated', 'deploy:graphite_deploy'
+    after 'deploy:reverted', 'deploy:graphite_rollback'
+  end
 end

data/lib/capistrano/graphite/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Graphite
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/spec/README.md

@@ -1,2 +1 @@
 TODO: Add test
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-graphite
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - scottsuch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,9 +82,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -95,7 +95,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Send deploy events to graphite via capistrano
+summary: A gem for pushing graphite events via capistrano v3 deployment
 test_files:
 - spec/README.md
 has_rdoc: