projectlocker_pulse 0.2.1

data/lib/rails/generators/pulse/pulse_generator.rb

@@ -0,0 +1,100 @@
+require 'rails/generators'
+
+class PulseGenerator < Rails::Generators::Base
+
+  class_option :api_key, :aliases => "-k", :type => :string, :desc => "Your Pulse API key"
+  class_option :heroku, :type => :boolean, :desc => "Use the Heroku addon to provide your Pulse 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
+    @_pulse_source_root ||= File.expand_path("../../../../../generators/pulse/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_pulse
+  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/pulse.rb"
+      exit
+    end
+  end
+
+  def ensure_plugin_is_not_present
+    if plugin_is_present?
+      puts "You must first remove the pulse plugin. Please run: script/plugin remove pulse"
+      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 'pulse/capistrano'
+      HOOK
+    end
+  end
+
+  def api_key_expression
+    s = if options[:api_key]
+      "'#{options[:api_key]}'"
+    elsif options[:heroku]
+      "ENV['PULSE_API_KEY']"
+    end
+  end
+
+  def generate_initializer
+    template 'initializer.rb', 'config/initializers/pulse.rb'
+  end
+
+  def determine_api_key
+    puts "Attempting to determine your API Key from Heroku..."
+    ENV['PULSE_API_KEY'] = heroku_api_key
+    if ENV['PULSE_API_KEY'].blank?
+      puts "... Failed."
+      puts "WARNING: We were unable to detect the Pulse API Key from your Heroku environment."
+      puts "Your Heroku application environment may not be configured correctly."
+      exit 1
+    else
+      puts "... Done."
+      puts "Heroku's Pulse API Key is '#{ENV['PULSE_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("pulse_api_key",options[:app]).split.find {|x| x unless x.blank?}
+  end
+
+  def heroku?
+    options[:heroku] ||
+      system("grep PULSE_API_KEY config/initializers/pulse.rb") ||
+      system("grep PULSE_API_KEY config/environment.rb")
+  end
+
+  def api_key_configured?
+    File.exists?('config/initializers/pulse.rb')
+  end
+
+  def test_pulse
+    puts run("rake pulse:test --trace")
+  end
+
+  def plugin_is_present?
+    File.exists?('vendor/plugins/pulse')
+  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.Pulse = Pulse
+    Pulse.setKey('#{api_key}');
+    Pulse.setHost('#{host}');
+    Pulse.setEnvironment('#{environment}');
+    Pulse.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 Pulse = {
+  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=Pulse.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   = 'pulse';
+    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() {
+  Pulse.initialize.apply(Pulse);
+};
+</script>
+
+<style type="text/css">
+#pulse {
+  background: #FFF url(http://www.projectlocker.com/images/projectlocker_logo_244x30.png) 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/pulse.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pulse/version"
+
+Gem::Specification.new do |s|
+  s.name        = %q{projectlocker_pulse}
+  s.version     = Pulse::VERSION.dup
+  s.summary     = %q{Exception reporting service for ProjectLocker}
+
+  s.require_paths = ["lib"]
+  s.files         = Dir["{generators/**/*,lib/**/*,rails/**/*,resources/*,script/*}"]  +
+    %w(pulse.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 'pulse/rails'

data/resources/README.md

@@ -0,0 +1,34 @@
+Pulse Resources
+==================
+
+Pulse can be run over SSL. SSL Certificate Authority (CA) certificates are not kept current by default on many environments. When CA certs are stale, Pulse cannot verify Pulse'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!