lilypad 0.2.4 → 0.3.0

data/README.markdown

@@ -10,46 +10,67 @@ Install
 sudo gem install lilypad --source http://gemcutter.org
 </pre>
 
+Basic Usage
+-----------
+
+<pre>
+require 'lilypad'
+use Rack::Lilypad, 'hoptoad_api_key_goes_here'
+</pre>
+
 Rails
 -----
 
 **config/environment.rb**
 
 <pre>
-require 'rack/lilypad'
+require 'lilypad'
 
 Rails::Initializer.run do |config|
-  config.middleware.insert_after(ActionController::Failsafe, Rack::Lilypad, 'hoptoad_api_key_goes_here')
+  config.middleware.insert_after(ActionController::Failsafe, Rack::Lilypad)
 end
 
-require 'rack/lilypad/rails'
+Lilypad do
+  api_key 'hoptoad_api_key_goes_here'
+  rails
+end
 </pre>
 
 Sinatra
 -------
 
 <pre>
-require 'rack/lilypad'
+require 'lilypad'
 
 class MyApp < Sinatra::Application
-  enable :raise_errors # Not needed when inheriting from Sinatra::Base
-  use Rack::Lilypad, 'hoptoad_api_key_goes_here'
+  use Rack::Lilypad do
+    api_key 'hoptoad_api_key_goes_here'
+    sinatra
+  end
 end
 </pre>
 
-Filters
--------
+Error Redirection
+-----------------
 
-Don't send certain environment variables to Hoptoad.
+Conditionally redirect errors to different Hoptoad buckets.
 
 <pre>
-use Rack::Lilypad, 'hoptoad_api_key_goes_here' do |hoptoad|
-  hoptoad.filters << %w(AWS_ACCESS_KEY AWS_SECRET_ACCESS_KEY AWS_ACCOUNT SSH_AUTH_SOCK)
+Lilypad do
+  api_key do |env, exception|
+    if exception && exception.message =~ /No route matches/
+      'hoptoad_api_key_goes_here'
+    elsif env && env['HTTP_USER_AGENT'] =~ /Googlebot/
+      'hoptoad_api_key_goes_here'
+    else
+      'hoptoad_api_key_goes_here'
+    end
+  end
 end
 </pre>
 
-Direct Access
--------------
+Notify
+------
 
 Send exceptions to Hoptoad from a rescue block.
 
@@ -57,18 +78,48 @@ Send exceptions to Hoptoad from a rescue block.
 begin
   raise 'Test'
 rescue Exception => e
-  Rack::Lilypad.notify(e)
+  Lilypad.notify(e)
 end
 </pre>
 
-Log
----
+Deploy
+------
+
+Send deploy notifications to Hoptoad.
+
+**deploy.rb**
+
+<pre>
+require 'capistrano/lilypad'
+Lilypad { api_key 'hoptoad_api_key_goes_here' }
+</pre>
+
+Or you can do it manually:
+
+<pre>
+Lilypad.deploy(
+  :environment => 'production',
+  :repository => 'git@github.com:winton/lilypad.git',
+  :revision => '8acc488967085987f0a9f2c662383119f83e1bb8',
+  :username => 'winton'
+)
+</pre>
+
+Options
+-------
 
-See what you are sending and receiving from Hoptoad.
+Below are the available options and their default values:
 
 <pre>
-use Rack::Lilypad, 'hoptoad_api_key_goes_here' do |hoptoad|
-  hoptoad.log = '/var/www/log/hoptoad.log'
+Lilypad do
+  api_key nil
+  environments %w(production staging)
+  deploy_url 'http://hoptoadapp.com:80/deploys.txt'
+  notify_url 'http://hoptoadapp.com:80/notifier_api/v2/notices'
+  filters []  # Array of environment variables to hide from Hoptoad
+  log nil     # Path of Hoptoad log
+  rails       # Requires the Rails adapter
+  sinatra     # Requires the Sinatra adapter
 end
 </pre>
 

data/gemspec.rb

@@ -14,5 +14,5 @@ GEM_SPEC = Gem::Specification.new do |s|
   s.name = GEM_NAME
   s.platform = Gem::Platform::RUBY
   s.require_path = "lib"
-  s.version = "0.2.4"
+  s.version = "0.3.0"
 end

data/lib/capistrano/lilypad.rb

@@ -0,0 +1,21 @@
+require File.expand_path("#{File.dirname __FILE__}/../lilypad")
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  after "deploy", "hoptoad:notify"
+  after "deploy:long", "hoptoad:notify"
+  after "deploy:migrations", "hoptoad:notify"
+
+  namespace :hoptoad do
+    desc "Notify Hoptoad of the deployment"
+    task :notify, :except => { :no_release => true } do
+      ENV['RACK_ENV'] = fetch(:rails_env, "production")
+      Lilypad.deploy(
+        :environment => ENV['RACK_ENV'],
+        :repository => repository,
+        :revision => current_revision,
+        :username => ENV['USER'] || ENV['USERNAME']
+      )
+    end
+  end
+end

data/lib/lilypad.rb

@@ -0,0 +1,52 @@
+require 'builder'
+require 'net/http'
+require 'rack'
+
+unless defined?(::Lilypad)
+  lib = File.dirname(__FILE__)
+  require "#{lib}/lilypad/config"
+  require "#{lib}/lilypad/config/request"
+  require "#{lib}/lilypad/log"
+  require "#{lib}/lilypad/hoptoad/deploy"
+  require "#{lib}/lilypad/hoptoad/notify"
+  require "#{lib}/lilypad/hoptoad/xml"
+  require "#{lib}/rack/lilypad"
+end
+
+class Lilypad
+  class <<self
+    
+    def active?
+      Config.api_key
+    end
+    
+    def config(api_key=nil, &block)
+      if api_key
+        Config.api_key api_key
+      end
+      if block_given?
+        Config.class_eval &block
+      end
+    end
+    
+    def deploy(options)
+      if active? && production?
+        Hoptoad::Deploy.new options
+      end
+    end
+    
+    def notify(exception, env=nil)
+      if active? && production?
+        Hoptoad::Notify.new env, exception
+      end
+    end
+    
+    def production?
+      Config.environments.include? ENV['RACK_ENV']
+    end
+  end
+end
+
+def Lilypad(api_key=nil, &block)
+  Lilypad.config api_key, &block
+end

data/lib/lilypad/adapters/rails.rb

@@ -0,0 +1,41 @@
+class Lilypad
+  module Rails
+    
+    def self.included(base)
+      ENV['RACK_ENV'] = ENV['RAILS_ENV']
+      if Lilypad.production? && !base.included_modules.include?(InstanceMethods)
+        base.send :extend, ClassMethods
+        base.send :include, InstanceMethods
+        base.send :alias_method_chain, :rescue_action, :lilypad
+        base.class_eval do
+          class <<self
+            alias_method_chain :call_with_exception, :lilypad
+          end
+        end
+      end
+    end
+    
+    module ClassMethods
+      
+      def call_with_exception_with_lilypad(env, exception)
+        raise exception
+      end
+    end
+    
+    module InstanceMethods
+      
+      private
+      
+      def rescue_action_with_lilypad(exception)
+        rescue_action_without_lilypad exception
+        Config::Request.action params[:action]
+        Config::Request.component params[:controller]
+        raise exception
+      end
+    end
+  end
+end
+
+if defined?(ActionController::Base)
+  ActionController::Base.send(:include, Lilypad::Rails)
+end

data/lib/lilypad/adapters/sinatra.rb

@@ -0,0 +1,16 @@
+class Lilypad
+  module Sinatra
+    
+    def self.included(base)
+      base.set(:raise_errors, true) if Lilypad.production?
+    end
+  end
+end
+
+if defined?(Sinatra::Base)
+  Sinatra::Base.send(:include, Lilypad::Sinatra)
+end
+
+if defined?(Sinatra::Application)
+  Sinatra::Application.send(:include, Lilypad::Sinatra)
+end

data/lib/lilypad/config.rb

@@ -0,0 +1,57 @@
+class Lilypad
+  class Config
+    class <<self
+      
+      def api_key(api_key=nil, &block)
+        @api_key = api_key unless api_key.nil?
+        @api_key_block = block if block_given?
+        @api_key || @api_key_block
+      end
+      
+      def deploy_url(url=nil)
+        @deploy_url = url unless url.nil?
+        @deploy_url || "http://hoptoadapp.com:80/deploys.txt"
+      end
+      
+      def environments(environments=nil)
+        @environments = environments unless environments.nil?
+        @environments || %w(production staging)
+      end
+      
+      def filters(filters=nil)
+        @filters = filters unless filters.nil?
+        @filters || []
+      end
+      
+      def log(log=nil)
+        @log = log unless log.nil?
+        @log
+      end
+      
+      def notify_url(url=nil)
+        @notify_url = url unless url.nil?
+        @notify_url || "http://hoptoadapp.com:80/notifier_api/v2/notices"
+      end
+      
+      def rails
+        require "#{File.dirname(__FILE__)}/adapters/rails"
+      end
+      
+      def sinatra
+        require "#{File.dirname(__FILE__)}/adapters/sinatra"
+      end
+      
+    end
+    
+    module Methods
+      
+      def api_key(env=nil, exception=nil)
+        if Config.api_key.respond_to?(:call)
+          Config.api_key.call env, exception
+        else
+          Config.api_key
+        end
+      end
+    end
+  end
+end

data/lib/lilypad/config/request.rb

@@ -0,0 +1,23 @@
+class Lilypad
+  class Config
+    class Request
+      class <<self
+        
+        def action(action=nil)
+          @action = action unless action.nil?
+          @action
+        end
+        
+        def component(component=nil)
+          @component = component unless component.nil?
+          @component
+        end
+        
+        def reset!
+          @action = nil
+          @component = nil
+        end
+      end
+    end
+  end
+end

data/lib/lilypad/hoptoad/deploy.rb

@@ -0,0 +1,48 @@
+class Lilypad
+  class Hoptoad
+    class Deploy
+      
+      include Config::Methods
+      include Log::Methods
+      
+      def initialize(options)
+        @options = options
+        
+        begin
+          post
+        rescue Exception => e
+        end
+        
+        log :deploy, @response
+        success?
+      end
+      
+      class <<self
+        def last_request
+          defined?(@@last_request) ? @@last_request : nil
+        end
+      end
+      
+      private
+      
+      def params
+        @@last_request = {
+          'api_key' => api_key,
+          'deploy[local_username]' => @options[:username],
+          'deploy[rails_env]' => @options[:environment],
+          'deploy[scm_revision]' => @options[:revision],
+          'deploy[scm_repository]' => @options[:repository]
+        }
+      end
+      
+      def post
+        url = URI.parse Config.deploy_url
+        @response = Net::HTTP.post_form url, params
+      end
+      
+      def success?
+        @response.class.superclass == Net::HTTPSuccess
+      end
+    end
+  end
+end

data/lib/lilypad/hoptoad/notify.rb

@@ -0,0 +1,87 @@
+class Lilypad
+  class Hoptoad
+    class Notify
+      
+      include Log::Methods
+      
+      def initialize(env, exception)
+        @exception = exception
+        @env = env
+        
+        http_start do |http|
+          begin
+            xml = XML.build *parse
+            http.post @uri.path, xml, headers
+          rescue Exception => e
+          end
+        end
+        
+        if env && success?
+          env['hoptoad.notified'] = true
+        end
+        
+        Config::Request.reset!
+        log :notify, @response
+        success?
+      end
+      
+      private
+      
+      class Backtrace < Struct.new(:file, :number, :method)
+      end
+      
+      def backtrace
+        regex = %r{^([^:]+):(\d+)(?::in `([^']+)')?$}
+        @exception.backtrace.map do |line|
+          _, file, number, method = line.match(regex).to_a
+          Backtrace.new file, number, method
+        end
+      end
+
+      def filter(hash)
+        return hash if Config.filters.empty?
+        hash.inject({}) do |acc, (key, val)|
+          match = Config.filters.any? { |f| key.to_s =~ Regexp.new(f) }
+          acc[key] = match ? "[FILTERED]" : val
+          acc
+        end
+      end
+      
+      def headers
+        {
+          'Content-type' => 'text/xml',
+          'Accept' => 'text/xml, application/xml'
+        }
+      end
+      
+      def http_start(&block)
+        @uri = URI.parse Config.notify_url
+        Net::HTTP.start @uri.host, @uri.port do |http|
+          http.read_timeout = 5 # seconds
+          http.open_timeout = 2 # seconds
+          @response = yield http
+        end
+      end
+
+      def parse
+        env = filter ENV.to_hash.merge(@env || {})
+        
+        if @env
+          request = Rack::Request.new @env
+          params = request.params rescue Hash.new
+          params = filter params
+          request_path = request.script_name + request.path_info
+        else
+          params = {}
+          request_path = 'Internal'
+        end
+        
+        [ backtrace, env, @exception, params, request_path ]
+      end
+      
+      def success?
+        @response.class.superclass == Net::HTTPSuccess
+      end
+    end
+  end
+end