projectlocker_errata 0.0.1

data/lib/projectlocker_errata.rb

@@ -0,0 +1,159 @@
+require "girl_friday"
+require 'net/http'
+require 'net/https'
+require 'rubygems'
+require 'projectlocker_errata/utils/blank'
+require 'projectlocker_errata/version'
+require 'projectlocker_errata/configuration'
+require 'projectlocker_errata/notice'
+require 'projectlocker_errata/sender'
+require 'projectlocker_errata/backtrace'
+require 'projectlocker_errata/rack'
+require 'projectlocker_errata/user_informer'
+
+require 'projectlocker_errata/railtie' if defined?(Rails::Railtie)
+
+module ProjectlockerErrata
+  API_VERSION = "2.3"
+  LOG_PREFIX = "** [ProjectlockerErrata] "
+
+  HEADERS = {
+    'Content-type'             => 'text/xml',
+    'Accept'                   => 'text/xml, application/xml'
+  }
+
+  class << self
+    # The sender object is responsible for delivering formatted data to the ProjectlockerErrata server.
+    # Must respond to #send_to_projectlocker_errata. See ProjectlockerErrata::Sender.
+    attr_accessor :sender
+
+    # A ProjectlockerErrata configuration object. Must act like a hash and return sensible
+    # values for all ProjectlockerErrata configuration options. See ProjectlockerErrata::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 ProjectlockerErrata for debugging help
+    def report_response_body(response)
+      write_verbose_log("Response from ProjectlockerErrata: \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
+    #   ProjectlockerErrata.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 ProjectlockerErrata.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 ProjectlockerErrata about.
+    # @param [Hash] opts Data that will be sent to ProjectlockerErrata.
+    #
+    # @option opts [String] :api_key The API key for this project. The API key is a unique identifier that ProjectlockerErrata 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] :rack_env The Rack environment.
+    # @option opts [String] :session 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
+
+    # Sends the notice unless it is one of the default ignored exceptions
+    # @see ProjectlockerErrata.notify
+    def notify_or_ignore(exception, opts = {})
+      notice = build_notice_for(exception, opts)
+      send_notice(notice) unless notice.ignore?
+    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?
+        if configuration.async?
+          configuration.async.call(notice)
+        else
+          sender.send_to_projectlocker_errata(notice)
+        end
+      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/projectlocker_errata_tasks.rb

@@ -0,0 +1,64 @@
+require 'net/http'
+require 'uri'
+
+# Capistrano tasks for notifying ProjectlockerErrata of deploys
+module ProjectlockerErrataTasks
+
+  # Alerts ProjectlockerErrata of a deploy.
+  #
+  # @param [Hash] opts Data about the deploy that is set to ProjectlockerErrata
+  #
+  # @option opts [String] :api_key Api key of you ProjectlockerErrata application
+  # @option opts [String] :rails_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) || ProjectlockerErrata.configuration.api_key
+    if api_key.blank?
+      puts "I don't seem to be configured with an API key.  Please check your configuration."
+      return false
+    end
+
+    if opts[:rails_env].blank?
+      puts "I don't know to which Rails 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 = ProjectlockerErrata.configuration.host || 'errors.projectlocker.com'
+    port = ProjectlockerErrata.configuration.port
+
+    proxy = Net::HTTP.Proxy(ProjectlockerErrata.configuration.proxy_host,
+                            ProjectlockerErrata.configuration.proxy_port,
+                            ProjectlockerErrata.configuration.proxy_user,
+                            ProjectlockerErrata.configuration.proxy_pass)
+    http = proxy.new(host, port)
+
+
+
+    # Handle Security
+    if ProjectlockerErrata.configuration.secure?
+      http.use_ssl      = true
+      http.ca_file      = ProjectlockerErrata.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/lib/rails/generators/projectlocker_errata/projectlocker_errata_generator.rb

@@ -0,0 +1,100 @@
+require 'rails/generators'
+
+class ProjectlockerErrataGenerator < Rails::Generators::Base
+
+  class_option :api_key, :aliases => "-k", :type => :string, :desc => "Your ProjectlockerErrata API key"
+  class_option :heroku, :type => :boolean, :desc => "Use the Heroku addon to provide your ProjectlockerErrata API key"
+  class_option :app, :aliases => "-a", :type => :string, :desc => "Your Heroku app name (only required if deploying to >1 Heroku app)"
+
+  def self.source_root
+    @_projectlocker_errata_source_root ||= File.expand_path("../../../../../generators/projectlocker_errata/templates", __FILE__)
+  end
+
+  def install
+    ensure_api_key_was_configured
+    ensure_plugin_is_not_present
+    append_capistrano_hook
+    generate_initializer unless api_key_configured?
+    determine_api_key if heroku?
+    test_projectlocker_errata
+  end
+
+  private
+
+  def ensure_api_key_was_configured
+    if !options[:api_key] && !options[:heroku] && !api_key_configured?
+      puts "Must pass --api-key or --heroku or create config/initializers/projectlocker_errata.rb"
+      exit
+    end
+  end
+
+  def ensure_plugin_is_not_present
+    if plugin_is_present?
+      puts "You must first remove the projectlocker_errata plugin. Please run: script/plugin remove projectlocker_errata"
+      exit
+    end
+  end
+
+  def append_capistrano_hook
+    if File.exists?('config/deploy.rb') && File.exists?('Capfile')
+      append_file('config/deploy.rb', <<-HOOK)
+
+        require './config/boot'
+        require 'projectlocker_errata/capistrano'
+      HOOK
+    end
+  end
+
+  def api_key_expression
+    s = if options[:api_key]
+      "'#{options[:api_key]}'"
+    elsif options[:heroku]
+      "ENV['HOPTOAD_API_KEY']"
+    end
+  end
+
+  def generate_initializer
+    template 'initializer.rb', 'config/initializers/projectlocker_errata.rb'
+  end
+
+  def determine_api_key
+    puts "Attempting to determine your API Key from Heroku..."
+    ENV['HOPTOAD_API_KEY'] = heroku_api_key
+    if ENV['HOPTOAD_API_KEY'].blank?
+      puts "... Failed."
+      puts "WARNING: We were unable to detect the ProjectlockerErrata API Key from your Heroku environment."
+      puts "Your Heroku application environment may not be configured correctly."
+      exit 1
+    else
+      puts "... Done."
+      puts "Heroku's ProjectlockerErrata API Key is '#{ENV['HOPTOAD_API_KEY']}'"
+    end
+  end
+
+  def heroku_var(var,app_name = nil)
+    app = app_name ? "--app #{app_name}" : ''
+    `heroku config #{app} | grep -E "#{var.upcase}" | awk '{ print $3; }'`.strip
+  end
+
+  def heroku_api_key
+    heroku_var("(hoptoad|projectlocker_errata)_api_key",options[:app]).split.find {|x| x unless x.blank?}
+  end
+
+  def heroku?
+    options[:heroku] ||
+      system("grep HOPTOAD_API_KEY config/initializers/projectlocker_errata.rb") ||
+      system("grep HOPTOAD_API_KEY config/environment.rb")
+  end
+
+  def api_key_configured?
+    File.exists?('config/initializers/projectlocker_errata.rb')
+  end
+
+  def test_projectlocker_errata
+    puts run("rake projectlocker_errata:test --trace")
+  end
+
+  def plugin_is_present?
+    File.exists?('vendor/plugins/projectlocker_errata')
+  end
+end

data/lib/templates/javascript_notifier.erb

@@ -0,0 +1,15 @@
+<%= javascript_tag %Q{
+  (function(){
+    var notifierJsScheme = (("https:" == document.location.protocol) ? "https://" : "http://");
+    document.write(unescape("%3Cscript src='" + notifierJsScheme + "#{host}/javascripts/notifier.js' type='text/javascript'%3E%3C/script%3E"));
+  })();
+}%>
+
+<%= javascript_tag %Q{
+    window.Airbrake = (typeof(Airbrake) == 'undefined' && typeof(Hoptoad) != 'undefined') ? Hoptoad : Airbrake
+    Airbrake.setKey('#{api_key}');
+    Airbrake.setHost('#{host}');
+    Airbrake.setEnvironment('#{environment}');
+    Airbrake.setErrorDefaults({ url: "#{escape_javascript url}", component: "#{controller_name}", action: "#{action_name}" });
+  }
+%>

data/lib/templates/rescue.erb

@@ -0,0 +1,91 @@
+<script type="text/javascript">
+var ProjectlockerErrata = {
+  host    : <%= host.to_json %>,
+  api_key : <%= api_key.to_json %>,
+  notice  : <%= notice.to_json %>,
+  message : 'This error exists in production!',
+
+  initialize: function() {
+    if (this.initialized) {
+      return;
+    } else {
+      this.initialized = true;
+    }
+
+    var data = [];
+
+    for (var key in this.notice) {
+      data[data.length] = 'notice[' + key + ']=' + this.notice[key];
+    }
+
+    data[data.length] = 'notice[api_key]=' + this.api_key;
+    data[data.length] = 'callback=ProjectlockerErrata.onSuccess';
+    data[data.length] = '_=' + (new Date()).getTime();
+
+    var head = document.getElementsByTagName('head')[0];
+    var done = false;
+
+    var
+    script = document.createElement('script');
+    script.src  = 'http://' + this.host + '/notices_api/v1/notices/exist?' +
+                  data.join('&');
+    script.type = 'text/javascript';
+    script.onload = script.onreadystatechange = function(){
+      if (!done && (!this.readyState ||
+          this.readyState == 'loaded' || this.readyState == 'complete')) {
+
+        done = true;
+
+        // Handle memory leak in IE. (via jQuery)
+        script.onload = script.onreadystatechange = null;
+        head.removeChild(script);
+      }
+    };
+
+    head.appendChild(script);
+  },
+
+  onSuccess: function(error) {
+    var body    = document.getElementsByTagName('body')[0];
+    var text    = document.createTextNode(this.message);
+    var element = document.createElement('a');
+
+    element.id   = 'projectlocker_errata';
+    element.href = 'http://' + error.subdomain + '.' + this.host +
+                   '/projects/' + error.project_id + '/errors/' + error.id;
+    element.appendChild(text);
+
+    body.insertBefore(element, body.firstChild);
+
+    var h1      = document.getElementsByTagName('h1')[0];
+    var pre     = document.getElementsByTagName('pre')[0];
+    var wrapper = document.createElement('div');
+
+    wrapper.id = 'wrapper';
+    wrapper.appendChild(h1);
+    wrapper.appendChild(pre);
+
+    body.insertBefore(wrapper, body.children[1]);
+  }
+};
+
+window.onload = function() {
+  ProjectlockerErrata.initialize.apply(ProjectlockerErrata);
+};
+</script>
+
+<style type="text/css">
+#projectlocker_errata {
+  background: #FFF url(http://projectlocker_errata.io/images/fell-off-the-toad.gif) no-repeat top right;
+  color: #F00;
+  padding: 45px 101px 45px 12px;
+  font-size: 14px;
+  font-weight: bold;
+  display: block;
+  float: right;
+}
+
+#wrapper {
+  padding-right: 360px;
+}
+</style>

data/projectlocker_errata.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "projectlocker_errata/version"
+
+Gem::Specification.new do |s|
+  s.name        = %q{projectlocker_errata}
+  s.version     = ProjectlockerErrata::VERSION.dup
+  s.summary     = %q{Exception reporting service for ProjectLocker}
+
+  s.require_paths = ["lib"]
+  s.files         = Dir["{generators/**/*,lib/**/*,rails/**/*,resources/*,script/*}"]  +
+    %w(projectlocker_errata.gemspec CHANGELOG Gemfile Guardfile INSTALL MIT-LICENSE Rakefile README_FOR_HEROKU_ADDON.md README.md TESTING.md SUPPORTED_RAILS_VERSIONS install.rb)
+  s.test_files    = Dir.glob("{test,spec,features}/**/*")
+
+  s.add_runtime_dependency("builder")
+  s.add_runtime_dependency("girl_friday")
+
+  s.add_development_dependency("actionpack",    "~> 2.3.8")
+  s.add_development_dependency("activerecord",  "~> 2.3.8")
+  s.add_development_dependency("activesupport", "~> 2.3.8")
+  s.add_development_dependency("mocha",           "0.10.5")
+  s.add_development_dependency("bourne",          ">= 1.0")
+  s.add_development_dependency("cucumber",     "~> 0.10.6")
+  s.add_development_dependency("fakeweb",       "~> 1.3.0")
+  s.add_development_dependency("nokogiri",    "~> 1.4.3.1")
+  s.add_development_dependency("rspec",         "~> 2.6.0")
+  s.add_development_dependency("sham_rack",     "~> 1.3.0")
+  s.add_development_dependency("shoulda",      "~> 2.11.3")
+  s.add_development_dependency("capistrano",    "~> 2.8.0")
+  s.add_development_dependency("guard"                    )
+  s.add_development_dependency("guard-test"               )
+  s.add_development_dependency("simplecov"                )
+
+  s.authors = ["Airbrake", "C. G. Brown"]
+  s.email   = %q{support@projectlocker.com}
+  s.homepage = "http://www.projectlocker.com"
+
+  s.platform = Gem::Platform::RUBY
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'projectlocker_errata/rails'

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!