toadhopper 1.0.6 → 1.1

data/.gitignore

@@ -1,6 +1,5 @@
 pkg
 .yardoc
 doc
-toadhopper.gemspec
 coverage
 .bundle

data/Gemfile

@@ -1,12 +1,4 @@
-source :gemcutter
+source :rubygems
 
-group :development do
-  gem 'yard'
-  gem 'jeweler'
-  gem 'rake'
-end
-
-group :test do
-  gem 'rake'
-  gem 'test-unit', :require => nil
-end
+# Specify your gem's dependencies in toadhopper.gemspec
+gemspec

data/Gemfile.lock

@@ -1,24 +1,20 @@
+PATH
+  remote: .
+  specs:
+    toadhopper (1.1)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    gemcutter (0.6.1)
-    git (1.2.5)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
-      git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json_pure (1.4.6)
+    fakeweb (1.3.0)
     rake (0.8.7)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
     test-unit (2.1.1)
-    yard (0.6.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  jeweler
+  fakeweb
   rake
   test-unit
-  yard
+  toadhopper!

data/README.md

@@ -13,6 +13,20 @@ You can install it via rubygems:
 
     gem install toadhopper
 
+## Deploy tracking
+
+You can use Toadhopper to notify Hoptoad of deployments:
+
+    Toadhopper('YOURAPIKEY').deploy!
+    
+The method accepts options to set the environment, SCM revision, etc.
+
+There is Capistrano support for deploy tracking. Simply require `toadhopper/capistrano` in your deploy config and set the variable `hoptoad_api_key`:
+
+    require 'toadhopper/capistrano'
+    
+    set :hoptoad_api_key, 'YOURAPIKEY'
+
 ## Development
 
 Install Bundler 0.9.x, then:
@@ -40,4 +54,5 @@ To build the gem:
 * [Samuel Tesla](http://github.com/stesla)
 * [Corey Donohoe](http://github.com/atmos)
 * [Andre Arko](http://github.com/indirect)
-* [Loren Segal](http://github.com/lsegal)
+* [Loren Segal](http://github.com/lsegal)
+* [Theo Hultberg](http://github.com/iconara)

data/Rakefile

@@ -1,23 +1,11 @@
-Bundler.setup(:development, :test)
-Bundler.require(:development, :test)
-
+require 'bundler/setup'
 require 'rake/testtask'
 
+Bundler::GemHelper.install_tasks
+
+
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/test*.rb']
   t.verbose = true
 end
-
-Jeweler::Tasks.new do |s|
-  s.name     = "toadhopper"
-  s.summary  = "Post error notifications to Hoptoad"
-  s.email    = "t.lucas@toolmantim.com"
-  s.homepage = "http://github.com/toolmantim/toadhopper"
-  s.authors  = ["Tim Lucas", "Samuel Tesla", "Corey Donohoe", "Andre Arko"]
-  s.extra_rdoc_files  = ["README.md", "LICENSE"]
-  s.executables = nil # stops jeweler automatically adding bin/*
-
-  require File.join(File.dirname(__FILE__), 'lib', 'toadhopper')
-  s.version  = Toadhopper::VERSION
-end

data/lib/toadhopper.rb

@@ -4,7 +4,7 @@ require 'ostruct'
 
 # Posts errors to the Hoptoad API
 class Toadhopper
-  VERSION = "1.0.6"
+  VERSION = "1.1"
   FILTER_REPLACEMENT = "[FILTERED]"
 
   # Hoptoad API response
@@ -52,6 +52,26 @@ class Toadhopper
     post_document(document_for(error, options), {'X-Hoptoad-Client-Name' => options[:notifier_name]})
   end
 
+  # Posts a deployment notification
+  # 
+  # @param [Hash] options
+  # @option options [String] framework_env  The framework environment your app is running under, defaults to development
+  # @option options [String] scm_repository The repository URL
+  # @option options [String] scm_revision   The current repository revision
+  # @option options [String] username       Your name, defaults to `whoami`
+  #
+  # @return [Response]
+  def deploy!(options={})
+    params = {}
+    params['api_key'] = @api_key
+    params['deploy[rails_env]'] = options[:framework_env] || 'development'
+    params['deploy[local_username]'] = options[:username] || %x(whoami).strip
+    params['deploy[scm_repository]'] = options[:scm_repository]
+    params['deploy[scm_revision]'] = options[:scm_revision]
+    response = Net::HTTP.post_form(URI.parse('http://hoptoadapp.com/deploys.txt'), params)
+    parse_response(response)
+  end
+
   private
 
   def document_defaults(error)
@@ -92,14 +112,18 @@ class Toadhopper
         response = http.post uri.path,
                              document,
                              {'Content-type' => 'text/xml', 'Accept' => 'text/xml, application/xml'}.merge(headers)
-        Response.new response.code.to_i,
-                     response.body,
-                     response.body.scan(%r{<error>(.+)<\/error>}).flatten
+        parse_response(response)
       rescue TimeoutError => e
         Response.new(500, '', ['Timeout error'])
       end
     end
   end
+  
+  def parse_response(response)
+    Response.new(response.code.to_i,
+                 response.body,
+                 response.body.scan(%r{<error>(.+)<\/error>}).flatten)
+  end
 
   def document_for(exception, options={})
     data = document_data(exception, options)

data/lib/toadhopper/capistrano.rb

@@ -0,0 +1,19 @@
+require 'toadhopper'
+
+
+Capistrano::Configuration.instance(:must_exist).load do
+  after 'deploy',            'deploy:notify_hoptoad'
+  after 'deploy:migrations', 'deploy:notify_hoptoad'
+
+  namespace :deploy do
+    desc 'Notify Hoptoad of the deployment'
+    task :notify_hoptoad, :except => {:no_release => true} do
+      framework_env = fetch(:rails_env, fetch(:hoptoad_env, 'production'))
+      api_key = fetch(:hoptoad_api_key)
+      puts 'Notifying Hoptoad of deploy'
+      options = {:framework_env => framework_env, :scm_revision => current_revision, :scm_repository => repository}
+      Toadhopper(api_key).deploy!(options)
+      puts 'Hoptoad notification complete'
+    end
+  end
+end

data/test/helper.rb

@@ -1,8 +1,9 @@
-Bundler.setup(:test)
-Bundler.require(:test)
-
+require 'bundler/setup'
 require 'test/unit'
-require "toadhopper"
+require 'fakeweb'
+require 'toadhopper'
+
+FakeWeb.allow_net_connect = true
 
 def toadhopper
   @toadhopper ||= Toadhopper.new(ENV['HOPTOAD_API_KEY'] || "test api key")

data/test/test_deploy_tracking.rb

@@ -0,0 +1,15 @@
+require 'helper'
+require 'cgi'
+require 'fakeweb'
+
+class Toadhopper::TestDeployTracking < Test::Unit::TestCase
+  def test_deploy
+    FakeWeb.register_uri(:post, 'http://hoptoadapp.com/deploys.txt', :status => ['200', 'Ok'])
+    options = {:framework_env => 'test', :scm_revision => 3, :scm_repository => 'some/where', :username => 'phil'}
+    response = Toadhopper('bogus key').deploy!(options)
+    request = FakeWeb.last_request
+    expected_parameters = {'api_key' => 'bogus key', 'deploy[rails_env]' => 'test', 'deploy[scm_revision]' => '3', 'deploy[scm_repository]' => 'some/where', 'deploy[local_username]' => 'phil'}
+    assert_equal 200, response.status
+    assert_equal expected_parameters, Hash[CGI.unescape(FakeWeb.last_request.body).split('&').map { |x| x.split('=') }]
+  end
+end

data/toadhopper.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+$: << File.expand_path('../lib', __FILE__)
+
+require 'toadhopper'
+
+
+Gem::Specification.new do |s|
+  s.name        = 'toadhopper'
+  s.version     = Toadhopper::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Tim Lucas', 'Samuel Tesla', 'Corey Donohoe', 'Andre Arko', 'Theo Hultberg']
+  s.email       = ['t.lucas@toolmantim.com']
+  s.homepage    = 'http://github.com/toolmantim/toadhopper'
+  s.summary     = %q{Post error notifications to Hoptoad}
+  s.description = %q{A base library for Hoptoad error reporting}
+
+  s.rubyforge_project = 'toadhopper'
+
+  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.extra_rdoc_files  = ['README.md', 'LICENSE']
+  
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'fakeweb'
+end

metadata

@@ -4,32 +4,71 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 0
-  - 6
-  version: 1.0.6
+  - 1
+  version: "1.1"
 platform: ruby
 authors: 
 - Tim Lucas
 - Samuel Tesla
 - Corey Donohoe
 - Andre Arko
+- Theo Hultberg
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-10-24 00:00:00 +11:00
+date: 2011-01-31 00:00:00 +11:00
 default_executable: 
-dependencies: []
-
-description: 
-email: t.lucas@toolmantim.com
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: A base library for Hoptoad error reporting
+email: 
+- t.lucas@toolmantim.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.md
+- LICENSE
 files: 
 - .gitignore
 - .yardopts
@@ -40,17 +79,20 @@ files:
 - Rakefile
 - lib/notice.erb
 - lib/toadhopper.rb
+- lib/toadhopper/capistrano.rb
 - test/helper.rb
 - test/test_convenience_constructor.rb
+- test/test_deploy_tracking.rb
 - test/test_filtering.rb
 - test/test_posting.rb
+- toadhopper.gemspec
 has_rdoc: true
 homepage: http://github.com/toolmantim/toadhopper
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -58,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2492547853952482404
+      hash: 3677881866856613108
       segments: 
       - 0
       version: "0"
@@ -67,12 +109,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3677881866856613108
       segments: 
       - 0
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: toadhopper
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
@@ -80,5 +123,6 @@ summary: Post error notifications to Hoptoad
 test_files: 
 - test/helper.rb
 - test/test_convenience_constructor.rb
+- test/test_deploy_tracking.rb
 - test/test_filtering.rb
 - test/test_posting.rb