hydraulic_brake 0.0.0

data/lib/hydraulic_brake.rb

@@ -0,0 +1,148 @@
+require 'net/http'
+require 'net/https'
+require 'rubygems'
+require 'hydraulic_brake/version'
+require 'hydraulic_brake/configuration'
+require 'hydraulic_brake/notice'
+require 'hydraulic_brake/sender'
+require 'hydraulic_brake/backtrace'
+
+module HydraulicBrake
+  API_VERSION = "2.3"
+  LOG_PREFIX = "** [HydraulicBrake] "
+
+  HEADERS = {
+    'Content-type'             => 'text/xml',
+    'Accept'                   => 'text/xml, application/xml'
+  }
+
+  class << self
+    # The sender object is responsible for delivering formatted data to the
+    # Airbrake server.  Must respond to #send_to_airbrake. See
+    # HydraulicBrake::Sender.
+    attr_accessor :sender
+
+    # A HydraulicBrake configuration object. Must act like a hash and return
+    # sensible values for all HydraulicBrake configuration options. See
+    # HydraulicBrake::Configuration.
+    attr_writer :configuration
+
+    # Tell the log that the Notifier is good to go
+    def report_ready
+      write_verbose_log("Notifier #{VERSION} ready to catch errors")
+    end
+
+    # Prints out the environment info to the log for debugging help
+    def report_environment_info
+      write_verbose_log("Environment Info: #{environment_info}")
+    end
+
+    # Prints out the response body from Airbrake for debugging help
+    def report_response_body(response)
+      write_verbose_log("Response from Airbrake: \n#{response}")
+    end
+
+    # Prints out the details about the notice that wasn't sent to server
+    def report_notice(notice)
+      write_verbose_log("Notice details: \n#{notice}")
+    end
+
+    # Returns the Ruby version, Rails version, and current Rails environment
+    def environment_info
+      info = "[Ruby: #{RUBY_VERSION}]"
+      info << " [#{configuration.framework}]" if configuration.framework
+      info << " [Env: #{configuration.environment_name}]" if configuration.environment_name
+    end
+
+    # Writes out the given message to the #logger
+    def write_verbose_log(message)
+      logger.debug LOG_PREFIX + message if logger
+    end
+
+    # Look for the Rails logger currently defined
+    def logger
+      self.configuration.logger
+    end
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   HydraulicBrake.configure do |config|
+    #     config.api_key = '1234567890abcdef'
+    #     config.secure  = false
+    #   end
+    def configure(silent = false)
+      yield(configuration)
+      self.sender = Sender.new(configuration)
+      report_ready unless silent
+      self.sender
+    end
+
+    # The configuration object.
+    # @see HydraulicBrake.configure
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Sends an exception manually using this method, even when you are not in a
+    # controller.
+    #
+    # @param [Exception] exception The exception you want to notify Airbrake
+    #   about
+    # @param [Hash] opts Data that will be sent to Airbrake
+    #
+    # @option opts [String] :api_key The API key for this project. The API key
+    #   is a unique identifier that Airbrake uses for identification
+    # @option opts [String] :error_message The error returned by the exception
+    #   (or the message you want to log)
+    # @option opts [String] :backtrace A backtrace, usually obtained with
+    #   +caller+
+    # @option opts [String] :session_data The contents of the user's session
+    # @option opts [String] :environment_name The application environment name
+    def notify(exception, opts = {})
+      send_notice(build_notice_for(exception, opts))
+    end
+
+    def build_lookup_hash_for(exception, options = {})
+      notice = build_notice_for(exception, options)
+
+      result = {}
+      result[:action]           = notice.action      rescue nil
+      result[:component]        = notice.component   rescue nil
+      result[:error_class]      = notice.error_class if notice.error_class
+      result[:environment_name] = 'production'
+
+      unless notice.backtrace.lines.empty?
+        result[:file]        = notice.backtrace.lines.first.file
+        result[:line_number] = notice.backtrace.lines.first.number
+      end
+
+      result
+    end
+
+    private
+
+    def send_notice(notice)
+      if configuration.public?
+        sender.send_to_airbrake(notice)
+      end
+    end
+
+    def build_notice_for(exception, opts = {})
+      exception = unwrap_exception(exception)
+      opts = opts.merge(:exception => exception) if exception.is_a?(Exception)
+      opts = opts.merge(exception.to_hash) if exception.respond_to?(:to_hash)
+      Notice.new(configuration.merge(opts))
+    end
+
+    def unwrap_exception(exception)
+      if exception.respond_to?(:original_exception)
+        exception.original_exception
+      elsif exception.respond_to?(:continued_exception)
+        exception.continued_exception
+      else
+        exception
+      end
+    end
+  end
+end

data/lib/hydraulic_brake_tasks.rb

@@ -0,0 +1,63 @@
+require 'net/http'
+require 'uri'
+
+module HydraulicBrakeTasks
+
+  # 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] :env Environment of the deploy (production, staging)
+  # @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
+
+    if opts[:env].empty?
+      puts "I don't know to which environment you are deploying (use the TO=production option)."
+      return false
+    end
+
+    dry_run = opts.delete(:dry_run)
+    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)
+
+    if dry_run
+      puts http.inspect, params.inspect
+      return true
+    else
+      response = http.request(post)
+
+      puts response.body
+      return Net::HTTPSuccess === response
+    end
+  end
+end
+

data/resources/README.md

@@ -0,0 +1,34 @@
+Airbrake Resources
+==================
+
+Airbrake has an SSL mode available to paying plans. SSL Certificate Authority (CA) certificates are not kept current by default on many environments. When CA certs are stale, Airbrake cannot verify Airbrake's production SSL cert and error reports fail. To avoid this, we now package local CA certs. The production of these certs is detailed here.
+
+Building ca-bundle.crt
+----------------------
+
+From https://gist.github.com/996292.
+
+If you want to use curl or net-http/open-uri to access https resources, you will often (always?) get an error, because they don't have the large number of root certificates installed that web browsers have.
+
+You can manually install the root certs, but first you have to get them from somewhere. [This article](http://notetoself.vrensk.com/2008/09/verified-https-in-ruby/) gives a nice description of how to do that. The [source of the cert files](http://curl.haxx.se/ca/cacert.pem) it points to is hosted by the curl project, who kindly provide it in the .pem format.
+
+**problem:** Sadly, ironically, and comically, it's not possible to access that file via https! Luckily, the awesome curl project does provide us with the script that they use to produce the file, so we can do it securely ourselves. Here's how.
+
+1. `git clone https://github.com/bagder/curl.git`
+2. `cd curl/lib`
+3. edit `mk-ca-bundle.pl` and change:
+
+    ```perl
+    my $url = 'http://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt?raw=1';
+    ```
+
+    to
+
+    ```perl
+    my $url = 'https://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt?raw=1';
+    ```
+
+    (change `http` to `https`)
+4. `./mk-ca-bundle.pl`
+
+Ta da!