custos_notifier 0.1

data/lib/custos_notifier.rb

@@ -0,0 +1,175 @@
+require 'rubygems'
+require 'rack'
+require 'rest-client'
+
+require 'custos_notifier/configuration'
+require 'custos_notifier/rack'
+
+require "custos_notifier/railtie" if defined?(Rails::Railtie)
+
+module CustosNotifier
+
+  class << self
+
+    attr_accessor :configuration
+
+    # Notify Custos service about raised exceptions. Exception will be ignored if notifier is
+    # configured with "development" stage. Raised exception is passed to this method, additional
+    # request attributes can be passed.
+    # Very simple example you can find in <tt>CustosNotifier::Rack</tt> middleware.
+    # Example:
+    #   begin
+    #     raise "My example exception"
+    #   rescue => ex
+    #     CustosNotifier.notify ex, :rack_env => env
+    #   end
+    #
+    # exception:: Exception ancestors
+    # options:: Hash, default empty hash.
+    def notify(exception, options = {})
+      return if ["development", "test"].include? configuration.stage.downcase
+
+      options[:exception] = exception
+      notice = Notice.new(options)
+
+      url = URI.parse("#{ configuration.url }/errors")
+      RestClient.post(url.to_s, notice.to_param)
+    end
+
+
+    # Configure Custos notifier. Sets configuration options based on passed block.
+    # Example:
+    #   CustosNotifier.configure do |config|
+    #     config.url = "blah.foo.bar'
+    #     config.project = 'awsome'
+    #     config.stage = 'production'
+    #     config.api_key = 'secret'
+    #   end
+    #
+    # returns:: Configuration
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+      self.configuration.stage ||= detect_stage
+      configuration
+    end
+
+
+    protected
+
+
+    # Try to auto-detect stage. If detection is impossible method returns <tt>nil</tt>.
+    def detect_stage
+      ENV['RACK_ENV'] || ENV['RAILS_ENV'] || Rails.env
+    rescue NameError
+      nil
+    end
+
+  end
+
+
+  # Mainly goal of this class is evaulate HTTP request attributes and build a hash object containing
+  # all parameters needed to post error to Custos Service.
+  class Notice
+
+    attr_reader :args
+    attr_reader :parameters
+
+    def initialize(args)
+      @args = args
+      @exception = args[:exception]
+
+      @exception_class = @exception.class.to_s
+      @message = @exception.message
+      @backtrace = @exception.backtrace.join("\n")
+      @server = `hostname -s`.chomp
+      @source = ""
+      @process_id = $$
+      @parameters = rack_env(:params).inspect || {}.inspect
+      @request_uri  = rack_env(:url) || ""
+      @document_root = rack_env(:env) { |env| env["DOCUMENT_ROOT"] } || ""
+      @content_length = rack_env(:env) { |env| env["DOCUMENT_ROOT"] } || ""
+      @http_accept = rack_env(:env) { |env| env["HTTP_ACCEPT"] } || ""
+      @http_method = rack_env(:request_method)
+      @http_cookie = rack_env(:env) { |env| env["HTTP_COOKIE"] } || ""
+      @http_host = rack_env(:host) || ""
+      @http_referer = rack_env(:referer) || ""
+      @user_agent = rack_env(:user_agent) || ""
+      @path_info = rack_env(:path_info) || ""
+      @query_string = rack_env(:query_string) || ""
+      @connection = rack_env(:env) { |env| env["HTTP_CONNECTION"] } || ""
+      @server_name = rack_env(:env) { |env| env["SERVER_NAME"] } || ""
+    end
+
+
+    # Method builds (based on parameters passed to constructor) a parameter hash which i posted
+    # to Custos service.
+    #
+    # returns:: Hash
+    def to_param
+      {
+        :project => CustosNotifier.configuration.project,
+        :api_key => CustosNotifier.configuration.api_key,
+        :error => {
+          :exception_class => @exception_class,
+          :message => @message,
+          :stage => CustosNotifier.configuration.stage,
+          :backtrace => @backtrace,
+          :server => @server,
+          :source => @source,
+          :process_id => @process_id,
+          :request => {
+            :uri => @request_uri,
+            :parameters => @parameters,
+            :document_root => @document_root,
+            :content_length => @content_length,
+            :http_accept => @http_accept,
+            :http_cookie => @http_cookie,
+            :http_host => @http_host,
+            :http_referer => @http_referer,
+            :user_agent => @user_agent,
+            :path_info => @path_info,
+            :query_string => @query_string,
+            :connection => @connection,
+            :server_name => @server_name,
+            :http_method => @http_method
+          }
+        }
+      }
+    end
+
+
+    protected
+
+
+    def request
+      @args[:request] || rack_request
+    end
+
+
+    # Get a value from <tt>Rack</tt> request object. Block can be passed to method and it will be
+    # evaluated on <tt>method's</tt> return.
+    def rack_env(method)
+      return unless request
+      value = request.send(method)
+      if block_given?
+        yield(value) if block_given?
+      else
+        value
+      end
+    end
+
+
+    # Method returns <tt>Rack</tt> request object based on <tt>self.args[:rack_env]</tt> values.
+    # If there aren't values <tt>nil</tt> will be returned.
+    #
+    # returns:: Rack::Request || NilClass
+    def rack_request
+      @rack_request ||= if args[:rack_env]
+        ::Rack::Request.new(args[:rack_env])
+      end
+    end
+
+  end
+
+end

data/lib/custos_notifier/configuration.rb

@@ -0,0 +1,11 @@
+module CustosNotifier
+
+  # Class holds configuration (url, api_key, project, stage) access for Custos notifier.
+  class Configuration
+    attr_accessor :url
+    attr_accessor :api_key
+    attr_accessor :project
+    attr_accessor :stage
+  end
+
+end

data/lib/custos_notifier/rack.rb

@@ -0,0 +1,38 @@
+module CustosNotifier
+
+  # Simple middleware for handling raised exceptions in Rack applications
+  # Example:
+  #   class MyApp
+  #     def call(env)
+  #       raise "my exception"
+  #     end
+  #   end
+  #
+  #   CustosNotifier.configure do |config|
+  #     config.url      = "foo.blah.bar"
+  #     config.project  = "awsomeSite"
+  #     config.stage    = "production"
+  #     config.api_key  = "secret"
+  #   end
+  #
+  #   use CustosNotifier::Rack
+  #   run MyApp
+  class Rack
+
+    def initialize(app)
+      @app = app  
+    end
+
+
+    def call(env)
+      begin
+        @app.call(env)
+      rescue Exception => raised
+        CustosNotifier.notify(raised, :rack_env => env)
+        [500, {"Content-Type" => "text/html"},"Something went wrong"]
+      end
+    end
+
+  end
+
+end

data/lib/custos_notifier/rails.rb

@@ -0,0 +1,6 @@
+require 'custos_notifier'
+require 'custos_notifier/rails/action_controller_catcher'
+
+if defined?(ActionController::Base)
+  ActionController::Base.send(:include, CustosNotifier::Rails::ActionControllerCatcher)
+end

data/lib/custos_notifier/rails/action_controller_catcher.rb

@@ -0,0 +1,16 @@
+module CustosNotifier
+  module Rails
+    module ActionControllerCatcher
+
+      private
+
+
+      # Override standard exception handling behaviour.
+      def rescue_action_in_public(exception)
+        CustosNotifier.notify(exception, :request => request)
+        super
+      end
+
+    end
+  end
+end

data/lib/custos_notifier/railtie.rb

@@ -0,0 +1,11 @@
+module CustosNotifier
+
+  class Railtie < Rails::Railtie
+
+    # Use CustosNotifier::Rack as one of used middlewares.
+    initializer "custos_notifier.user_middleware" do |app|
+      app.config.middleware.use CustosNotifier::Rack
+    end
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: custos_notifier
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Sebastian Nowak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :runtime
+  version_requirements: *id001
+description: With this gem you can submit error messages to Custos service.
+email: sebastian.nowak@implix.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/custos_notifier/configuration.rb
+- lib/custos_notifier/rack.rb
+- lib/custos_notifier/rails/action_controller_catcher.rb
+- lib/custos_notifier/rails.rb
+- lib/custos_notifier/railtie.rb
+- lib/custos_notifier.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Notifier for Custos service.
+test_files: []
+