captivus 0.0.3 → 0.0.5

data/.gitignore

@@ -10,6 +10,7 @@ coverage
 doc/
 lib/bundler/man
 pkg
+/rails-3.*-app/**/*.log
 rdoc
 spec/reports
 test/tmp

data/Gemfile

@@ -7,4 +7,5 @@ gem "rspec", "~> 2.11"
 gem "sham_rack", "~> 1.3"
 gem "rack-test", "~> 0.6"
 gem "timecop", '~> 0.5'
-gem "delorean", "~> 2.0.0"
+gem "delorean", "~> 2.0.0"
+gem "rails", "~> 3.2.8"

data/README.md

@@ -27,3 +27,12 @@ TODO: Write usage instructions here
 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
+
+# Rails testing setup
+* rails _3.1.8_ new rails-3.1-app -G -d postgresql -T --old-style-hash
+* setup error controller
+* setup database.yml
+* setup captivus config
+* add specs
+* setup Gemfile
+* setup routes

data/captivus.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "faraday", '~> 0.8.4'
-  gem.add_dependency "multi_json", "~> 1.3.6"
+  gem.add_dependency "multi_json", "~> 1.2.0"
   gem.add_dependency "captivus-auth_hmac", "0.0.2"
+  gem.add_dependency "json-schema", "~> 1.0.10"
 end

data/lib/captivus/backtrace/line.rb

@@ -1,21 +1,27 @@
 module Captivus
   class Backtrace
     class Line
-      PATTERN = /^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$/
+      PATTERN = /^(.+?):(\d+)(?::in `([^']+)')?$/
 
       def initialize(raw_line)
         if match_data = PATTERN.match(raw_line)
-          @as_json = {
-            :file => match_data[1],
-            :number => match_data[2].to_i,
-            :method => match_data[3]
-          }
+          @file = match_data[1]
+          @number = match_data[2].to_i
+          @method = match_data[3]
         else
-          raise ArgumentError, "Unrecognized format"
+          raise ArgumentError, "Unrecognized format: #{raw_line.inspect}"
         end
       end
 
-      attr_reader :as_json
+      def as_json(*)
+        hash = {'file' => file, 'number' => number}
+        hash['method'] = method if method
+        hash
+      end
+
+      private
+
+      attr_reader :file, :number, :method
     end
   end
 end

data/lib/captivus/backtrace.rb

@@ -6,9 +6,15 @@ module Captivus
       unless exception.respond_to?(:backtrace)
         raise ArgumentError, "#{exception} must respond to `backtrace`"
       end
-      @as_json = Array(exception.backtrace).map { |line| Line.new(line).as_json }
+      @exception = exception
     end
 
-    attr_reader :as_json
+    def as_json(*)
+      Array(exception.backtrace).map { |line| Line.new(line).as_json }
+    end
+
+    private
+
+    attr_reader :exception
   end
 end

data/lib/captivus/configuration.rb

@@ -3,12 +3,14 @@ module Captivus
     def initialize(attrs = {}, &block)
       defaults = {
         :scheme => 'http',
-        :host => 'api.captiv.us'
+        :host => 'api.captiv.us',
+        :environment => 'production',
+        :development_environments => %w[development test]
       }
       configure defaults.merge(attrs), &block
     end
 
-    attr_accessor :host, :scheme, :api_key, :api_secret_key
+    attr_accessor :host, :scheme, :api_key, :api_secret_key, :environment, :development_environments
 
     def configure(attrs = {})
       attrs.each { |attr, value| send "#{attr}=", value }

data/lib/captivus/notifier.rb

@@ -0,0 +1,34 @@
+require 'captivus/util'
+require 'faraday'
+require 'faraday/request/hmac_authentication'
+
+module Captivus
+  class Notifier
+    def initialize(config)
+      @config = config
+    end
+
+    def notify(payload)
+      return if config.development_environments.include?(config.environment)
+
+      connection = Faraday.new(:url => "#{config.scheme}://#{config.host}") do |faraday|
+        faraday.request :hmac_authentication, config.api_key, config.api_secret_key, {:service_id => 'Captivus'}
+        faraday.adapter :net_http
+      end
+
+      connection.post do |request|
+        request.headers['Content-Type'] = 'application/json; charset=UTF-8'
+        request.url '/events'
+        request.body = Captivus::Util.hash_to_json(payload)
+      end
+    end
+
+    def ==(other)
+      other.is_a?(Notifier) && config == other.config
+    end
+
+    protected
+
+    attr_reader :config
+  end
+end

data/lib/captivus/payload.rb

@@ -1,22 +1,78 @@
-require 'captivus/backtrace'
+require 'captivus/util'
+require 'json-schema'
 
 module Captivus
   class Payload
-    def initialize(exception)
-      if exception.respond_to?(:class) && exception.class.respond_to?(:name) && exception.respond_to?(:message)
-        @as_json = {
-          'event' => {
-            'type' => exception.class.name,
-            'message' => exception.message,
-            'timestamp' => Time.now.utc.to_s
-          },
-          'backtrace' => Backtrace.new(exception).as_json
+    SCHEMA = {
+      'type' => 'object',
+      'properties' => {
+        'notifier' => {
+          'type' => 'object',
+          'required' => true,
+          'properties' => {
+            'name' => {'type' => 'string', 'required' => true},
+            'version' => {'type' => 'string', 'required' => true},
+            'language' => {'type' => 'string', 'required' => true}
+          }
+        },
+        'event' => {
+          'type' => 'object',
+          'required' => true,
+          'properties' => {
+            'type' => {'type' => 'string', 'required' => true},
+            'message' => {'type' => 'string', 'required' => true},
+            'timestamp' => {'type' => 'string', 'required' => true, 'format' => 'date-time'}
+          }
+        },
+        'backtrace' => {
+          'type' => 'array',
+          'required' => true,
+          'items' => {
+            'type' => 'object',
+            'properties' => {
+              'file' => {'type' => 'string', 'required' => true},
+              'number' => { 'type' => 'integer', 'required' => true},
+              'method' => {'type' => 'string'}
+            }
+          }
+        },
+        'context' => {
+          'type' => 'object',
+          'properties' => {
+            'controller' => {'type' => 'string'},
+            'action' => {'type' => 'string'},
+            'params' => {'type' => 'object'}
+          }
+        },
+        'environment' => {
+          'type' => 'object',
+          'required' => true,
+          'properties' => {
+            'name' => {'type' => 'string', 'required' => true}
+          }
         }
-      else
-        raise ArgumentError, "Unexpected exception: #{exception.inspect}"
-      end
+      }
+    }
+
+    def initialize(json)
+      JSON::Validator.validate! SCHEMA, json
+      @json = json
+    end
+
+    def as_json(*)
+      Captivus::Util.json_to_hash json
+    end
+
+    def to_json(*)
+      json.dup
+    end
+
+    def ==(other)
+      other.is_a?(Payload) && json == other.json
     end
 
-    attr_reader :as_json
+    protected
+
+    attr_reader :json
   end
 end

data/lib/captivus/rack_capturer.rb

@@ -1,6 +1,4 @@
 require 'captivus'
-require 'faraday'
-require 'multi_json'
 
 module Captivus
   class RackCapturer
@@ -9,12 +7,10 @@ module Captivus
     end
 
     def call(env)
-      begin
-        @app.call env
-      rescue => exception
-        Captivus.notify exception
-        raise
-      end
+      @app.call env
+    rescue Exception => exception
+      Captivus.notify exception, :context => {:params => Rack::Request.new(env).params}
+      raise
     end
 
     private

data/lib/captivus/rails_capturer.rb

@@ -0,0 +1,21 @@
+require 'captivus'
+require 'captivus/rack_capturer'
+
+module Captivus
+  class RailsCapturer < RackCapturer
+    def call(env)
+      @app.call env
+    rescue Exception => exception
+      controller = env['action_controller.instance']
+      params = controller.request.filtered_parameters
+      params.delete 'controller'
+      params.delete 'action'
+      Captivus.notify exception, 'context' => {
+        'controller' => controller.controller_name,
+        'action' => controller.action_name,
+        'params' => params
+      }
+      raise
+    end
+  end
+end

data/lib/captivus/railtie.rb

@@ -0,0 +1,35 @@
+require 'rails'
+require 'captivus/rails_capturer'
+
+module Captivus
+  class Railtie < Rails::Railtie
+    rake_tasks { load "captivus/tasks/captivus.rake" }
+
+    config.before_initialize do
+      Captivus.configure do |config|
+        config.environment = Rails.env
+      end
+      # announce here?
+    end
+
+    initializer "captivus.use_rack_middleware" do |app|
+      app.config.middleware.use "Captivus::RailsCapturer"
+    end
+
+    # config.after_initialize do
+    #   ::ActionController::Base.send :include, RailsControllerMethods
+
+    #   if defined?(::ActionDispatch::DebugExceptions)
+    #     # We should catch the exceptions in ActionDispatch::DebugExceptions in Rails 3.2.x.
+    #     require 'crash_log/rails/middleware/debug_exception_catcher'
+    #     ::ActionDispatch::DebugExceptions.__send__(:include, CrashLog::Rails::Middleware::DebugExceptionCatcher)
+    #   elsif defined?(::ActionDispatch::ShowExceptions)
+
+    #     # ActionDispatch::DebugExceptions is not defined in Rails 3.0.x and 3.1.x so
+    #     # catch the exceptions in ShowExceptions.
+    #     require 'crash_log/rails/middleware/debug_exception_catcher'
+    #     ::ActionDispatch::ShowExceptions.send(:include, CrashLog::Rails::Middleware::DebugExceptionCatcher)
+    #   end
+    # end
+  end
+end

data/lib/captivus/tasks/captivus.rake

@@ -0,0 +1,12 @@
+namespace :captivus do
+  desc "Send a test exception to Captivus"
+  task :test => :environment do
+    class Captivus::TestException < Exception; end
+
+    begin
+      raise Captivus::TestException, "This is a test exception"
+    rescue Captivus::TestException => exception
+      Captivus.notify exception
+    end
+  end
+end

data/lib/captivus/util.rb

@@ -0,0 +1,24 @@
+require 'multi_json'
+
+# TODO: test
+module Captivus
+  module Util
+    extend self
+
+    def hash_to_json(hash)
+      if MultiJson.respond_to?(:adapter)
+        MultiJson.dump hash
+      else
+        MultiJson.encode hash
+      end
+    end
+
+    def json_to_hash(json)
+      if MultiJson.respond_to?(:adapter)
+        MultiJson.load json
+      else
+        MultiJson.decode json
+      end
+    end
+  end
+end

data/lib/captivus/version.rb

@@ -1,3 +1,3 @@
 module Captivus
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/captivus.rb

@@ -1,6 +1,9 @@
+require 'captivus/util'
 require "captivus/version"
 require 'captivus/configuration'
-require 'faraday/request/hmac_authentication'
+require 'captivus/notifier'
+require 'captivus/backtrace'
+require 'captivus/payload'
 
 module Captivus
   class << self
@@ -12,22 +15,35 @@ module Captivus
       config.configure *args, &block
     end
 
-    def notify(exception)
-      connection = Faraday.new(:url => "#{config.scheme}://#{config.host}") do |faraday|
-        faraday.request :hmac_authentication, config.api_key, config.api_secret_key, {:service_id => 'Captivus'}
-        faraday.adapter :net_http
-      end
+    def notifier
+      @notifier ||= Notifier.new config
+    end
+
+    def notify(exception, data = {})
+      notifier.notify build_payload(exception, data)
+    end
+
+    private
 
-      connection.post do |request|
-        request.headers['Content-Type'] = 'application/json; charset=UTF-8'
-        request.url '/events'
-        request.body = MultiJson.dump(Payload.new(exception).as_json)
+    def build_payload(exception, data = {})
+      if exception.respond_to?(:class) && exception.class.respond_to?(:name) && exception.respond_to?(:message)
+        event_json = {
+          'type' => exception.class.name,
+          'message' => exception.message,
+          'timestamp' => Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+        }
+      else
+        raise ArgumentError, "Unexpected exception: #{exception.inspect}"
       end
+
+      Payload.new(Captivus::Util.hash_to_json({
+        'notifier' => {'name' => 'captivus', 'version' => Captivus::VERSION, 'language' => 'Ruby'},
+        'event' => event_json,
+        'backtrace' => Backtrace.new(exception).as_json,
+        'environment' => {'name' => config.environment}
+      }.merge(data)))
     end
   end
 end
 
-require 'captivus/auth_hmac'
-require 'captivus/backtrace'
-require 'captivus/payload'
-require 'captivus/rack_capturer'
+require 'captivus/railtie' if defined?(Rails::Railtie)

data/rails-3.0-app/.rspec

@@ -0,0 +1 @@
+--color

data/rails-3.0-app/Gemfile

@@ -0,0 +1,40 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.17'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'pg'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end
+
+gem 'captivus', :path => '..'
+
+group :test do
+  gem "rspec-rails", "~> 2.11.4"
+  gem "capybara", "~> 1.1.2"
+  gem "sham_rack", "~> 1.3"
+  gem "timecop", '~> 0.5'
+end