hydraulic_brake 0.0.0 → 0.1.0

data/README.md

@@ -12,7 +12,16 @@ gem](https://github.com/airbrake/airbrake) and takes a different design
 approach. HydraulicBrake doesn't attempt to integrate with any
 frameworks and has few dependencies. HydraulicBrake doesn't change
 anything outside its own namespace. It doesn't do any automatic
-exception handling or configuration.
+exception handling or configuration. HydraulicBrake doesn't ignore any
+exceptions. If you don't want to send a notification, then don't call
+HydraulicBrake#notify.
+
+If you were previously using the Airbrake gem, and you want to use
+HydraulicBrake instead, you'll need to install error handlers wherever
+you intend to catch errors. The right place to do that depends entirely
+on your application, but a good place to start would be
+rescue_action_in_public for rails apps and Rack middleware for Rack
+apps.
 
 Configuration
 -------------
@@ -20,13 +29,15 @@ Configuration
 Configure HydraulicBrake when your app starts with a configuration block
 like this one:
 
-    HydraulicBrake.configure do |config|
-      config.host = "api.airbrake.io"
-      config.port = "443"
-      config.secure = true
-      config.environment_name = "staging"
-      config.api_key = "<api-key-from-your-airbrake-server>"
-    end
+```ruby
+HydraulicBrake.configure do |config|
+  config.host = "api.airbrake.io"
+  config.port = "443"
+  config.secure = true
+  config.environment_name = "staging"
+  config.api_key = "<api-key-from-your-airbrake-server>"
+end
+```
 
 Usage
 -----
@@ -34,70 +45,95 @@ Usage
 Wherever you want to notify an Airbrake server, just call
 HydraulicBrake#notify
 
-    begin
-      params = {
-        # params that you pass to a method that can throw an exception
-      }
-      my_unpredicable_method(params)
-    rescue => e
-      HydraulicBrake.notify(
-        :error_class   => "Special Error",
-        :error_message => "Special Error: #{e.message}",
-        :parameters    => params
-      )
-    end
+```ruby
+begin
+  my_unpredicable_method
+rescue => e
+  HydraulicBrake.notify(
+    :error_class   => "Special Error",
+    :error_message => "Special Error: #{e.message}",
+    :parameters    => params
+  )
+end
+```
 
 HydraulicBrake merges the hash you pass with these default options:
 
-    {
-      :api_key       => HydraulicBrake.api_key,
-      :error_message => 'Notification',
-      :backtrace     => caller,
-      :parameters    => {},
-      :session       => {}
-    }
+```ruby
+{
+  :api_key       => HydraulicBrake.api_key,
+  :error_message => 'Notification',
+  :backtrace     => caller,
+  :parameters    => {},
+  :session       => {}
+}
+```
 
-You can override any of those parameters.
+You can override any of those parameters and there are many other
+parameters you can add. See the inline documentation for
+HydraulicBrake#notify.
 
 Async Notifications
 -------------------
 
-HydraulicBrake doesn't provide anything for async notifications, and
-that's a good thing. Just wrap your calls to Airbrake#notify in the
-async library of your choice.
+HydraulicBrake doesn't provide anything special for async notifications.
+Just wrap your calls to Airbrake#notify in the async library of your
+choice if you want to.
 
 Proxy Support
 -------------
 
-The notifier supports using a proxy, if your server is not able to
-directly reach the Airbrake servers. To configure the proxy settings,
-added the following information to your HydraulicBrake configuration
-block.
-
-    HydraulicBrake.configure do |config|
-      config.proxy_host = proxy.host.com
-      config.proxy_port = 4038
-      config.proxy_user = foo # optional
-      config.proxy_pass = bar # optional
+The notifier supports using a proxy. To configure a proxy, add the
+configuration to HydraulicBrake#configure:
+
+```ruby
+HydraulicBrake.configure do |config|
+  config.proxy_host = proxy.host.com
+  config.proxy_port = 4038
+  config.proxy_user = foo # optional
+  config.proxy_pass = bar # optional
+end
+```
       
 Logging
 ------------
 
-HydraulicBrake uses STDOUT by default. If you don't like HydraulicBrake
-scribbling to your standard output, just pass another `Logger` instance
-inside your configuration:
+HydraulicBrake uses STDOUT by default. If you want to use a different
+logger, just pass another `Logger` instance inside your configuration:
+
+```ruby
+HydraulicBrake.configure do |config|
+  config.logger = Logger.new("path/to/your/log/file")
+end
+```
+
+Deploy Hook
+-----------
+
+HydraulicBrake can notify Airbrake whenever you deploy your app. Just
+call HydraulicBrake::Hook#deploy whenever you deploy:
 
-    HydraulicBrake.configure do |config|
-      ...
-      config.logger = Logger.new("path/to/your/log/file")
-    end
+```ruby
+HydraulicBrake::Hook.deploy({
+  :scm_revision => "cd6b969f66ad0794c7117d5030f926b49f82b038",
+  :scm_repository => "stevecrozz/hydraulic_brake",
+  :local_username => "stevecrozz",
+  :rails_env => "production", # everything is rails, right?
+  :message => "Another deployment hook brought to you by HydraulicBrake"
+})
+```
 
 Credits
 -------
 
-Thank you to all [the airbrake contributors](https://github.com/airbrake/airbrake/contributors)!
+Thank you to all [the airbrake
+contributors](https://github.com/airbrake/airbrake/contributors) for
+making HydraulicBrake possible.
 
 License
 -------
 
-Airbrake is Copyright © 2008-2012 Airbrake. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Airbrake is Copyright © 2008-2012 Airbrake.
+HydraulicBrake is CopyRight © 2013 Stephen Crosby. It is free software,
+and may be redistributed under the terms specified in the MIT-LICENSE
+file.

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/hydraulic_brake.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "hydraulic_brake"
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Crosby"]
-  s.date = "2013-07-14"
+  s.date = "2013-07-19"
   s.description = "Sends notifications to an Airbrake server"
   s.email = "stevecrozz@gmail.com"
   s.extra_rdoc_files = [
@@ -34,13 +34,16 @@ Gem::Specification.new do |s|
     "lib/hydraulic_brake.rb",
     "lib/hydraulic_brake/backtrace.rb",
     "lib/hydraulic_brake/configuration.rb",
+    "lib/hydraulic_brake/hook.rb",
     "lib/hydraulic_brake/notice.rb",
     "lib/hydraulic_brake/sender.rb",
+    "lib/hydraulic_brake/test_notification.rb",
     "lib/hydraulic_brake/version.rb",
     "lib/hydraulic_brake_tasks.rb",
     "resources/README.md",
     "resources/ca-bundle.crt",
-    "script/integration_test.rb",
+    "script/deploy_integration_test.rb",
+    "script/notify_integration_test.rb",
     "test/airbrake_2_3.xsd",
     "test/backtrace_test.rb",
     "test/configuration_test.rb",

data/lib/hydraulic_brake.rb

@@ -1,11 +1,13 @@
 require 'net/http'
 require 'net/https'
 require 'rubygems'
-require 'hydraulic_brake/version'
+require 'hydraulic_brake/backtrace'
 require 'hydraulic_brake/configuration'
+require 'hydraulic_brake/hook'
 require 'hydraulic_brake/notice'
 require 'hydraulic_brake/sender'
-require 'hydraulic_brake/backtrace'
+require 'hydraulic_brake/test_notification'
+require 'hydraulic_brake/version'
 
 module HydraulicBrake
   API_VERSION = "2.3"

data/lib/hydraulic_brake/hook.rb

@@ -0,0 +1,53 @@
+require 'net/http'
+require 'uri'
+
+module HydraulicBrake
+  module Hook
+
+    # Alerts Airbrake of a deploy.
+    #
+    # @param [Hash] opts Data about the deploy that is set to Airbrake
+    #
+    # @option opts [String] :api_key Api key of you Airbrake application
+    # @option opts [String] :scm_revision The given revision/sha that is being deployed
+    # @option opts [String] :scm_repository Address of your repository to help with code lookups
+    # @option opts [String] :local_username Who is deploying
+    def self.deploy(opts = {})
+      api_key = opts.delete(:api_key) || HydraulicBrake.configuration.api_key
+      if api_key.empty?
+        puts "I don't seem to be configured with an API key.  Please check your configuration."
+        return false
+      end
+
+      params = {'api_key' => api_key}
+      opts.each {|k,v| params["deploy[#{k}]"] = v }
+
+      host = HydraulicBrake.configuration.host
+      port = HydraulicBrake.configuration.port
+
+      proxy = Net::HTTP.Proxy(HydraulicBrake.configuration.proxy_host,
+                              HydraulicBrake.configuration.proxy_port,
+                              HydraulicBrake.configuration.proxy_user,
+                              HydraulicBrake.configuration.proxy_pass)
+      http = proxy.new(host, port)
+
+      # Handle Security
+      if HydraulicBrake.configuration.secure?
+        http.use_ssl      = true
+        http.ca_file      = HydraulicBrake.configuration.ca_bundle_path
+        http.verify_mode  = OpenSSL::SSL::VERIFY_PEER
+      end
+
+      post = Net::HTTP::Post.new("/deploys.txt")
+      post.set_form_data(params)
+
+      response = http.request(post)
+
+      puts response.body
+      return Net::HTTPSuccess === response
+    end
+
+  end
+end
+
+

data/lib/hydraulic_brake/test_notification.rb

@@ -0,0 +1,19 @@
+module HydraulicBrake
+  module TestNotification
+
+    def self.send
+      begin
+        raise "Testing hydraulic brake notifier. If you can see this, it works."
+      rescue Exception => e
+        puts "Configuration:"
+        HydraulicBrake.configuration.to_hash.each do |key, value|
+          puts sprintf("%25s: %s", key.to_s, value.inspect.slice(0, 55))
+        end
+        print "Sending notification... "
+        HydraulicBrake.notify(e)
+        print "done\n"
+      end
+    end
+
+  end
+end

data/script/deploy_integration_test.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hydraulic_brake'
+
+fail "Please supply an API Key as the first argument" if ARGV.empty?
+
+host = ARGV[1]
+
+secure = (ARGV[2] == "secure")
+
+HydraulicBrake.configure do |config|
+  config.secure  = secure
+  config.host    = host
+  config.api_key = ARGV.first
+end
+
+HydraulicBrake::Hook.deploy({
+  :api_key => ARGV.first,
+  :scm_revision => "cd6b969f66ad0794c7117d5030f926b49f82b038",
+  :scm_repository => "stevecrozz/hydraulic_brake",
+  :local_username => "stevecrozz",
+  :rails_env => "production", # everything is rails, right?
+  :message => "Another deployment hook brought to you by HydraulicBrake"
+})

data/script/notify_integration_test.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hydraulic_brake'
+
+fail "Please supply an API Key as the first argument" if ARGV.empty?
+
+host = ARGV[1]
+
+secure = (ARGV[2] == "secure")
+
+HydraulicBrake.configure do |config|
+  config.secure  = secure
+  config.host    = host
+  config.api_key = ARGV.first
+end
+
+HydraulicBrake::TestNotification.send
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydraulic_brake
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-14 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -212,13 +212,16 @@ files:
 - lib/hydraulic_brake.rb
 - lib/hydraulic_brake/backtrace.rb
 - lib/hydraulic_brake/configuration.rb
+- lib/hydraulic_brake/hook.rb
 - lib/hydraulic_brake/notice.rb
 - lib/hydraulic_brake/sender.rb
+- lib/hydraulic_brake/test_notification.rb
 - lib/hydraulic_brake/version.rb
 - lib/hydraulic_brake_tasks.rb
 - resources/README.md
 - resources/ca-bundle.crt
-- script/integration_test.rb
+- script/deploy_integration_test.rb
+- script/notify_integration_test.rb
 - test/airbrake_2_3.xsd
 - test/backtrace_test.rb
 - test/configuration_test.rb
@@ -243,7 +246,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1855083520706619311
+      hash: -2276683694056635469
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/script/integration_test.rb

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'logger'
-require 'fileutils'
-
-RAILS_ENV = "production"
-RAILS_ROOT = FileUtils.pwd
-RAILS_DEFAULT_LOGGER = Logger.new(STDOUT)
-
-$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'hydraulic_brake'
-
-fail "Please supply an API Key as the first argument" if ARGV.empty?
-
-host = ARGV[1]
-
-secure = (ARGV[2] == "secure")
-
-exception = begin
-              raise "Testing hydraulic brake notifier with secure = #{secure}. If you can see this, it works."
-            rescue => foo
-              foo
-            end
-
-HydraulicBrake.configure do |config|
-  config.secure  = secure
-  config.host    = host
-  config.api_key = ARGV.first
-end
-puts "Configuration:"
-HydraulicBrake.configuration.to_hash.each do |key, value|
-  puts sprintf("%25s: %s", key.to_s, value.inspect.slice(0, 55))
-end
-puts "Sending #{secure ? "" : "in"}secure notification to project with key #{ARGV.first}"
-HydraulicBrake.notify(exception)
-