airbrake-sinatra 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@airbrake-sinatra

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in airbrake-sinatra.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sam Rose
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Airbrake::Sinatra
+
+The helper method provided with the official Airbrake gem is specific to Rails
+and requires a bit of hacking to get working in Sinatra. This gem exists to
+serve as a Sinatra helper method for the Airbrake Javascript.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'airbrake-sinatra'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install airbrake-sinatra
+
+## Usage
+
+There are two sample applications in the source code on Github. You will find
+them under the `examples/` directory. One of them shows how to use this gem with
+a standard Sinatra `server.rb` file. The other shows how to use this gem with
+your own class that extends `Sinatra::Base`. There is a subtle difference :)
+
+Essentially all it boils down to is using the `airbrake_javascript_sinatra`
+helper in your views. An example layout might look something like this:
+
+``` haml
+%head
+  = airbrake_javascript_sinatra
+%body
+  %p
+    The Airbrake javascript helper is outputting the following into the header:
+    %pre= h airbrake_javascript_sinatra
+```
+
+## Developing
+
+There are two Rake tasks that are there for development purposes:
+
+    $ rake example:one
+    $ rake example:two
+
+Both of these cd into the appropriate `example/` directory and execute the
+`shotgun` command.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'fileutils'
+
+include FileUtils
+
+namespace :example do
+  desc "Run the first sample Sinatra application."
+  task :one do
+    cd File.join(File.dirname(__FILE__), 'example', 'one')
+    exec "shotgun"
+  end
+
+  desc "Run the second sample Sinatra application."
+  task :two do
+    cd File.join(File.dirname(__FILE__), 'example', 'two')
+    exec "shotgun"
+  end
+end

data/airbrake-sinatra.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/airbrake-sinatra/version', __FILE__)
+
+module AirbrakeSinatra
+  # Hash of:
+  #
+  #   "gem-name" => "version"
+  #
+  # pairs. Set version to nil if you want the latest.
+  DEPENDENCIES ||= {
+    :app => {
+      "haml"    => nil,
+      "sinatra" => nil,
+      "airbrake" => nil,
+    },
+
+    :dev => {
+      "rake"    => nil,
+      "shotgun" => nil,
+    }
+  }
+end
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sam Rose"]
+  gem.email         = ["sam.rose@forward.co.uk"]
+  gem.description   = %q{A view helper for Airbrake desgined for Sinatra.}
+  gem.summary       = %q{The Airbrake view helper in the official "airbrake" gem is designed for Rails. This is a version that works out of the box with Sinatra.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "airbrake-sinatra"
+  gem.require_paths = ["lib"]
+  gem.version       = Airbrake::Sinatra::VERSION
+
+  AirbrakeSinatra::DEPENDENCIES[:app].each do |k, v|
+    gem.add_dependency(*([k, v].compact))
+  end
+
+  AirbrakeSinatra::DEPENDENCIES[:dev].each do |k, v|
+    gem.add_development_dependency(*([k, v].compact))
+  end
+end

data/example/one/config.ru

@@ -0,0 +1,4 @@
+require 'sinatra'
+require File.join(File.dirname(__FILE__), 'server.rb')
+
+run Sinatra::Application.new

data/example/one/server.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'airbrake-sinatra')
+
+require 'sinatra'
+require 'sinatra/airbrake-javascript'
+require 'erb'
+require 'haml'
+require 'airbrake'
+
+helpers do
+  include Rack::Utils
+  alias_method :h, :escape_html
+end
+
+configure do
+  set :logging, Logger::DEBUG
+
+  Airbrake.configure do |config|
+    config.api_key    = 'sample'
+    config.js_api_key = 'sample'
+    config.host       = 'example.com'
+    config.port       = 80
+    config.secure     = config.port == 443
+  end
+
+  use Airbrake::Rack
+  enable :raise_errors
+end
+
+get '/erb' do
+  erb :erb_index
+end
+
+get '/haml' do
+  haml :haml_index
+end

data/example/one/views/erb_index.erb

@@ -0,0 +1,11 @@
+<head>
+  <%= airbrake_javascript_sinatra %>
+</head>
+<body>
+  <p>
+    The Airbrake javascript helper is outputting the following into the header:
+    <pre>
+<%= h airbrake_javascript_sinatra %>
+    </pre>
+  </p>
+</body>

data/example/one/views/haml_index.haml

@@ -0,0 +1,6 @@
+%head
+  = airbrake_javascript_sinatra
+%body
+  %p
+    The Airbrake javascript helper is outputting the following into the header:
+    %pre= h airbrake_javascript_sinatra

data/example/two/config.ru

@@ -0,0 +1,4 @@
+require 'sinatra'
+require File.join(File.dirname(__FILE__), 'server.rb')
+
+run Server.new

data/example/two/server.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'airbrake-sinatra')
+
+require 'sinatra'
+require 'sinatra/airbrake-javascript'
+require 'erb'
+require 'haml'
+require 'airbrake'
+
+class Server < Sinatra::Base
+  helpers do
+    include Rack::Utils
+    include Sinatra::AirbrakeJavascript
+    alias_method :h, :escape_html
+  end
+
+  configure do
+    set :logging, Logger::DEBUG
+
+    Airbrake.configure do |config|
+      config.api_key    = 'sample'
+      config.js_api_key = 'sample'
+      config.host       = 'example.com'
+      config.port       = 80
+      config.secure     = config.port == 443
+    end
+
+    use Airbrake::Rack
+    enable :raise_errors
+  end
+
+  get '/erb' do
+    erb :erb_index
+  end
+
+  get '/haml' do
+    haml :haml_index
+  end
+end

data/example/two/views/erb_index.erb

@@ -0,0 +1,11 @@
+<head>
+  <%= airbrake_javascript_sinatra %>
+</head>
+<body>
+  <p>
+    The Airbrake javascript helper is outputting the following into the header:
+    <pre>
+<%= h airbrake_javascript_sinatra %>
+    </pre>
+  </p>
+</body>

data/example/two/views/haml_index.haml

@@ -0,0 +1,6 @@
+%head
+  = airbrake_javascript_sinatra
+%body
+  %p
+    The Airbrake javascript helper is outputting the following into the header:
+    %pre= h airbrake_javascript_sinatra

data/lib/airbrake-sinatra.rb

@@ -0,0 +1,4 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH << libdir unless $LOAD_PATH.include? libdir
+
+require 'airbrake-sinatra/version'

data/lib/airbrake-sinatra/version.rb

@@ -0,0 +1,5 @@
+module Airbrake
+  module Sinatra
+    VERSION = "0.0.1"
+  end
+end

data/lib/sinatra/airbrake-javascript.rb

@@ -0,0 +1,64 @@
+require 'sinatra/base'
+require 'logger'
+
+module Sinatra
+  module AirbrakeJavascript
+    def airbrake_javascript_sinatra options = {}
+      abconfig = Airbrake.configuration rescue nil
+
+      if abconfig.nil?
+        logger.debug "Could not load the Airbrake config. Is Airbrake loaded?"
+        return
+      end
+
+      return unless abconfig.public?
+
+      log   = options[:logger] || logger || Logger.new(STDOUT)
+      views = options [:views] || File.join(File.dirname(__FILE__), '..', 'templates')
+      host  = options[:host] || Airbrake.configuration.host.dup
+      port  = options[:port] || Airbrake.configuration.port
+      host << ":#{port}" unless [80, 443].include?(port)
+
+      js_api_key = (options[:js_api_key] || abconfig.js_api_key) rescue nil
+      api_key    = (options[:api_key] || abconfig.api_key)
+      url        = (options[:url] || request.url) rescue nil
+
+      if js_api_key.nil?
+        logger.debug "Could not find a js_api_key in options or the Airbrake config."
+      end
+
+      if api_key.nil?
+        logger.debug "Could not find an api_key in options or the Airbrake config."
+      end
+
+      unless respond_to? :request
+        logger.debug "No request object found in the current scope."
+      end
+
+      options = {
+        :views         => views,
+        :layout        => false,
+        :use_full_path => false,
+        :locals        => {
+          :host        => host,
+          :api_key     => api_key,
+          :js_api_key  => api_key,
+          :environment => options[:environment] || ENV['RACK_ENV'],
+          :url         => url
+        }
+      }
+
+      erb :airbrake_javascript_sinatra, options
+    end
+
+    def escape_javascript(html_content)
+      return '' unless html_content
+      javascript_mapping = { '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n' }
+      javascript_mapping.merge("\r" => '\n', '"' => '\\"', "'" => "\\'")
+      escaped_string = html_content.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { javascript_mapping[$1] }
+      "\"#{escaped_string}\""
+    end
+  end
+
+  helpers AirbrakeJavascript
+end

data/lib/templates/airbrake_javascript_sinatra.erb

@@ -0,0 +1,14 @@
+<script type="text/javascript">
+  (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"));
+  })();
+</script>
+
+<script type="text/javascript">
+  window.Airbrake = (typeof(Airbrake) == 'undefined' && typeof(Hoptoad) != 'undefined') ? Hoptoad : Airbrake
+  Airbrake.setKey('<%= js_api_key || api_key %>');
+  Airbrake.setHost('<%= host %>');
+  Airbrake.setEnvironment('<%= environment %>');
+  Airbrake.setErrorDefaults({ url: <%= escape_javascript url %> });
+</script>

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: airbrake-sinatra
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sam Rose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shotgun
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A view helper for Airbrake desgined for Sinatra.
+email:
+- sam.rose@forward.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- airbrake-sinatra.gemspec
+- example/one/config.ru
+- example/one/server.rb
+- example/one/views/erb_index.erb
+- example/one/views/haml_index.haml
+- example/two/config.ru
+- example/two/server.rb
+- example/two/views/erb_index.erb
+- example/two/views/haml_index.haml
+- lib/airbrake-sinatra.rb
+- lib/airbrake-sinatra/version.rb
+- lib/sinatra/airbrake-javascript.rb
+- lib/templates/airbrake_javascript_sinatra.erb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4025992488192137976
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4025992488192137976
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: The Airbrake view helper in the official "airbrake" gem is designed for Rails.
+  This is a version that works out of the box with Sinatra.
+test_files: []