gabrake 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9086971eceb0388ced5f4d94016d68fa6535cc7
+  data.tar.gz: b4e13cafcb4e01d162951d9373701fc70d7d2bce
+SHA512:
+  metadata.gz: 029078fd523169306bc11a9cc36a618e48a4925cacea1a60d28653f8903b98c7d507484210574de58afacd9dcdba8fefec875c2b6ba071d8750aafc5871f2304
+  data.tar.gz: 1637cd6656d513887115881849508ba53251dda569c5b48d968bdeaf5f9bdc8c2a6c51c15dabd9e1d4f7ed6a1988aa5dac107bc7682e56056fbf5d78df2119a7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Samuel Molnar
+
+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,96 @@
+# Gabrake — Realtime Error Tracking with Google Analytics
+
+Gabrake is a gem built on top of Google Analytics API and provides realtime server-side and client-side error tracking by using custom events. It uses a flexibility of Google Analytics API and handles server-side error server-side, without exposing any of your error messages or backtrace on client.
+
+Let's have a look.
+
+[Realtime Tracking by category](https://www.dropbox.com/s/k0bhpd1f90hhe6e/gabrake-realtime.png?dl=0)
+
+[Overview by error message and location](https://www.dropbox.com/s/hrmyy9cgo1jkclw/gabrake-overview.png?dl=0)
+
+[Overview by error message and browser](https://www.dropbox.com/s/q736nd92vzz5r4a/gabrake-overview-by-browser.png?dl=0)
+
+Inspired by [garelic](https://github.com/jsuchal/garelic) — gem that tracks app performace by Google Analytics User Timing variables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gabrake'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gabrake
+
+## Usage
+
+### 1. Set it up
+
+Create an initializer `config/initializers/gabrake.rb` and add
+
+```ruby
+Gabrake.tracking_id = 'YOUR GA TRACKING ID'
+```
+
+In your javascript do
+
+```coffeecript
+#= require gabrake/analytics # if you haven't required analytics tracking code somewhere else
+#= require gabrake
+```
+
+**Note**: *This library uses new analytics.js code – Universal Google Analytics. If you still have the old `_gaq` library and you use it (for tracking events and stuff), you have to [create a new property](http://stackoverflow.com/a/20690546/1691413) (get second tracking ID and use that one for Gabrake).*
+
+### 2. Track errors
+
+Go to Google Analytics page, hit **Real Time** > **Events** and track 'em.
+
+**Pro Tip:** *Gabrake errors have two categories – Gabrake (Rails) and Gabrake (JavaScript). Click on one of the category to filter out events and see error message (action) along with error backtrace location (label).*
+
+### 3. Analyze
+
+Wait couple minutes.
+
+1. Go to **Behaviour** > **Events** > **Overview**. 
+2. Click on one of the Gabrake categories. On top of table, choose primary dimension as **Event Action**. 
+3. Choose secondary dimension by your taste — *Event Label (backtrace location), Page, Browser,* …
+
+**Important**: *Make sure that the overview date includes TODAY! You'll save yourself a headache.*
+
+## Advanced
+
+### Tracking versions
+
+If you want to compare errors by app versions, you need create a custom dimension. 
+
+1. Go to **Admin** > Under **Property** tab (the big middle one) > hit **Custom Definitions** > **Custom Dimension** > create one.
+2. Write down the name and the index. 
+3. Set `Gabrake.custom_dimension_index = YOUR_INDEX`.
+3. Go to **Behaviour** > **Events** > **Overview**. Click category. Choose **Event Action**. Search for secondary dimension, by the name. Choose it.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+### This code is free to use under the terms of the MIT license.
+
+Copyright (c) 2015 Samuel Molnár
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gabrake'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gabrake.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gabrake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gabrake'
+  spec.version       = Gabrake::VERSION
+  spec.authors       = ['Samuel Molnar']
+  spec.email         = ['molnar.samuel@gmail.com']
+
+  spec.summary       = 'Simple Realtime Error Tracking and Statistics with Google Analytics'
+  spec.description   = 'Simple Realtime Error Tracking and Statistics with Google Analytics'
+  spec.homepage      = 'https://github.com/smolnar/gabrake'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'railties', '>= 3.2.0'
+  spec.add_dependency 'rails', '>= 3.2.0'
+  spec.add_dependency 'httparty', '~> 0.13.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/gabrake/collector.rb

@@ -0,0 +1,58 @@
+module Gabrake
+  class Collector
+    URL = 'http://www.google-analytics.com/collect'
+
+    def self.event_for(exception, context)
+      event = Event.new(exception)
+
+      unless Gabrake.tracking_id
+        raise ArgumentError.new('You need to specify Google Analytics Tracking ID in `Gabrake.tracking_id\'')
+      end
+
+      params = {
+        v:   context[:version],
+        dl:  CGI::escape(context[:url]),
+        cid: context[:client_id],
+        tid: Gabrake.tracking_id,
+        t:   :event,
+        ec:  event.category,
+        ea:  event.action,
+        el:  event.label
+      }
+
+      params[:"cd#{Gabrake.custom_dimension_index}"] = Gabrake.tracked_version if Gabrake.custom_dimension_index
+
+      "#{URL}?#{params.map { |key, value| "#{key}=#{value}" }.join('&') }"
+    end
+
+    class Event
+      def initialize(exception)
+        @exception = exception
+      end
+
+      def category
+        'Gabrake (Rails)'
+      end
+
+      def action
+        @message ||= "#{@exception.class}: #{@exception.message}"
+      end
+
+      def label
+        "#{location.gsub(/\A#{::Rails.root}\//, '')}" if location
+      end
+
+      private
+
+      def location
+        return @location if @location
+
+        backtrace = @exception.backtrace.try(:first)
+
+        return unless backtrace
+
+        _, @location, _ = *backtrace.match(/\A(.+?:\d+):in/)
+      end
+    end
+  end
+end

data/lib/gabrake/middleware.rb

@@ -0,0 +1,17 @@
+module Gabrake
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        @app.call(env)
+      rescue ::Exception => exception
+        Gabrake::Notifier.deliver(exception, env: env) unless exception.is_a?(ActionController::RoutingError)
+
+        raise exception
+      end
+    end
+  end
+end

data/lib/gabrake/notifier.rb

@@ -0,0 +1,24 @@
+module Gabrake
+  class Notifier
+    def self.deliver(exception, env:, **options)
+      context   = Env.extract_context(env)
+      event_url = Gabrake::Collector.event_for(exception, context)
+
+      HTTParty.get(URI.encode(event_url), headers: { 'User-Agent' => env['HTTP_USER_AGENT'] })
+    end
+
+    class Env
+      def self.extract_context(env)
+        cookies = env['action_dispatch.cookies']
+        default_client_id = "GA1.1.#{(rand() * 2147483647).to_i}.#{Time.now.to_i}"
+        _, version, client_id = *(cookies['_ga'] || default_client_id).match(/GA(\d+)\..+\.(\d+\.\d+)\z/)
+
+        {
+          version: version,
+          client_id: client_id,
+          url: env['REQUEST_URI']
+        }
+      end
+    end
+  end
+end

data/lib/gabrake/rails.rb

@@ -0,0 +1,7 @@
+module Gabrake
+  module Rails
+    class Engine < ::Rails::Engine
+      isolate_namespace Gabrake
+    end
+  end
+end

data/lib/gabrake/version.rb

@@ -0,0 +1,3 @@
+module Gabrake
+  VERSION = '0.1.0'
+end

data/lib/gabrake.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+require 'cgi'
+require 'gabrake/version'
+require 'gabrake/rails'
+require 'gabrake/collector'
+require 'gabrake/notifier'
+require 'gabrake/middleware'
+require 'net/http'
+
+module Gabrake
+  mattr_accessor :tracking_id, :tracked_version, :custom_dimension_index, instance_accessor: false
+
+  class Railtie < ::Rails::Railtie
+    initializer 'gabrake.boot_exception_catching' do |app|
+      app.middleware.use Gabrake::Middleware
+
+      Gabrake.tracked_version = version_from_git || version_from_revision_file
+    end
+
+    def version_from_git
+      `git log --pretty=format:"%cd %h" --date=iso -1 2>/dev/null`.strip.presence
+    end
+
+    def version_from_revision_file
+      `cat #{::Rails.root}/REVISION 2>/dev/null`.strip.presence
+    end
+  end
+end

data/vendor/assets/javascripts/gabrake/analytics.js.erb

@@ -0,0 +1,7 @@
+(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ga('create', '<%= Gabrake.tracking_id %>', 'auto');
+ga('send', 'pageview');

data/vendor/assets/javascripts/gabrake.js.coffee.erb

@@ -0,0 +1,19 @@
+class window.Gabrake
+  @trackedVersion: null
+  @customDimensionIndex: null
+
+  @report: (message, file, line, options) ->
+    options = {}
+
+    if Gabrake.customDimensionIndex
+      options["dimension#{Gabrake.customDimensionIndex}"] = Gabrake.trackedVersion
+
+    ga('send', 'event', 'Gabrake (JavaScript)', message, "#{file}:#{line}", options)
+
+  @inject: ->
+    window.onerror = Gabrake.report
+
+Gabrake.trackedVersion = <%= Gabrake.tracked_version ? "'#{Gabrake.tracked_version}'" : 'null' %>
+Gabrake.customDimensionIndex = <%= Gabrake.custom_dimension_index || 'null' %>
+
+Gabrake.inject()

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: gabrake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Molnar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Realtime Error Tracking and Statistics with Google Analytics
+email:
+- molnar.samuel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gabrake.gemspec
+- lib/gabrake.rb
+- lib/gabrake/collector.rb
+- lib/gabrake/middleware.rb
+- lib/gabrake/notifier.rb
+- lib/gabrake/rails.rb
+- lib/gabrake/version.rb
+- vendor/.gitkeep
+- vendor/assets/javascripts/gabrake.js.coffee.erb
+- vendor/assets/javascripts/gabrake/analytics.js.erb
+homepage: https://github.com/smolnar/gabrake
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple Realtime Error Tracking and Statistics with Google Analytics
+test_files: []