failurous-rails 0.1.7

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Mikko Nylén, Tero Parviainen & Antti Forsell
+
+ 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,106 @@
+# Failurous
+
+Failurous is an open source webapp for monitoring exceptions in your
+live applications.
+
+## Installation
+
+### Server
+
+### Clients
+
+#### Rails 3
+
+To use Failurous from Rails 3 application, add this to your Gemfile:
+
+    gem 'failurous-rails', :git => 'git://github.com/railsrumble/rr10-team-256.git'
+
+
+Next you need to add the following under config/initializer/failurous.rb:
+
+    require 'failurous'
+
+    Failurous::Config.server_address = '<FAILUROUS-INSTALLATION>'
+    Failurous::Config.api_key = '<API-KEY-FOR-PROJECT>'
+
+    Rails.application.config.middleware.use Failurous::FailMiddleware
+      
+The middleware will automatically catch any exceptions your app raises and
+deliver them to the Failurous service for later viewing.
+
+#### Java
+
+To integrate Failurous to a Java webapp, first add the Failurous Maven repository to your Maven POM:
+
+    <repository>
+      <id>failurous</id>
+      <url>http://failurous.r10.railsrumble.com/mvnrepo</url>
+      <snapshots>
+        <enabled>true</enabled>
+      </snapshots>
+      <releases>
+        <enabled>true</enabled>
+      </releases>
+    </repository>
+		
+Next, add a dependency to the Failurous Java client:
+
+    <dependency>
+      <groupId>failurous</groupId>
+      <artifactId>javaclient</artifactId>
+      <version>0.0.1-SNAPSHOT</version>
+    </dependency>
+		
+Finally, configure the Failurous Java client to intercept exceptions by adding it as a servlet filter to your web.xml:
+
+	<filter>
+		<filter-name>failurous</filter-name>
+		<filter-class>failurous.ClientFilter</filter-class>
+		<init-param>
+			<param-name>serverAddress</param-name>
+			<param-value><FAILUROUS-INSTALLATION></param-value>
+		</init-param>
+		<init-param>
+			<param-name>apiKey</param-name>
+			<param-value><API-KEY-FOR-PROJECT></param-value>
+		</init-param>
+	</filter>
+	
+	<filter-mapping>
+		<filter-name>failurous</filter-name>
+		<url-pattern>/*</url-pattern>
+	</filter-mapping>
+		
+The filter will automatically catch any exceptions your app threw and deliver them to the Failurous service for later viewing.
+
+Notice that the position of the filter-mapping element affects which exceptions Failurous will report. Any filter mappings appearing before the failurous filter mapping in web.xml will not be reported, since they are executed outside its scope.
+
+## Sending fails
+
+Often there's cases where it'd be desirable to be able to send debugging
+information or notifications of "failurous" behaviour in your application. For
+example, when someone tries to access protected content without proper access
+rights.
+
+Failurous comes in handy here, because it's not limited to only
+exceptions: you can actually send any data you like.
+
+### In Rails applications
+
+To send your custom fails to Failurous, you can use the
+`Failurous::FailNotification` to build your fail and send it. The syntax is
+as follows:
+
+    Failurous::FailNotification.set_title('Title for your fail').
+      add_field(:section_name, :field_name, {:use_in_checksum => true | false}).
+      add_field(:another, :field, {...}).
+      send
+
+
+## License
+
+Copyright (c) 2010 Mikko Nylén, Tero Parviainen & Antti Forsell
+
+See LICENSE
+
+

data/client/failurous.rb

@@ -0,0 +1,7 @@
+module Failurous
+  ROOT_PATH = File.dirname(__FILE__)
+  autoload :Config,            "#{ROOT_PATH}/failurous/config"
+  autoload :FailNotification,  "#{ROOT_PATH}/failurous/fail_notification"
+  autoload :FailNotifier,      "#{ROOT_PATH}/failurous/fail_notifier"
+  autoload :FailMiddleware,    "#{ROOT_PATH}/failurous/fail_middleware"
+end

data/client/failurous/config.rb

@@ -0,0 +1,24 @@
+module Failurous
+  class Config
+    @@server_address = ""
+    @@api_key = ""
+    
+    class << self
+      def server_address=(val)
+        @@server_address = val
+      end
+    
+      def server_address
+        @@server_address
+      end
+    
+      def api_key=(val)
+        @@api_key = val
+      end
+    
+      def api_key
+        @@api_key
+      end
+    end
+  end
+end

data/client/failurous/fail_middleware.rb

@@ -0,0 +1,60 @@
+# Based on exception_notification
+#    http://github.com/rails/exception_notification
+#    Copyright (c) 2005 Jamis Buck, released under the MIT license
+
+require 'action_dispatch'
+
+module Failurous
+  class FailMiddleware
+    def self.default_ignore_exceptions
+      [].tap do |exceptions|
+        exceptions << ::ActiveRecord::RecordNotFound if defined?(::ActiveRecord::RecordNotFound)
+        exceptions << ::AbstractController::ActionNotFound if defined?(::AbstractController::ActionNotFound)
+        exceptions << ::ActionController::RoutingError if defined?(::ActionController::RoutingError)      
+      end
+    end
+
+    def initialize(app, options = {})
+      @app, @options = app, options
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue Exception => exception
+      unless FailMiddleware.default_ignore_exceptions.include?(exception.class)
+        send_exception_notification(env, exception)
+      end
+
+      raise exception
+    end
+  
+    private
+  
+    def send_exception_notification(env, exception)
+      @env        = env
+      @exception  = exception
+      @controller = env['action_controller.instance'] || MissingController.new
+      @request    = ActionDispatch::Request.new(env)
+      @backtrace  = clean_backtrace(exception)
+    
+      notification = FailNotification.new.
+        from_exception(exception).
+        add_field(:request, :REQUEST_METHOD, @request.method, {:humanize_field_name => false}).
+        add_field(:request, :REQUEST_URI, @request.request_uri, {:humanize_field_name => false}).
+        add_field(:request, :REMOTE_ADDR, @request.remote_ip, {:humanize_field_name => false}).
+        add_field(:request, :HTTP_USER_AGENT, @request.headers["User-Agent"], {:humanize_field_name => false}).
+        add_field(:summary, :location, "#{@controller.controller_name}##{@controller.action_name}", {:use_in_checksum => true}).
+        add_field(:details, :params, @controller.params, {:use_in_checksum => false})
+      
+      
+      FailNotifier.send_fail(notification)
+    end  
+  
+    def clean_backtrace(exception)
+      Rails.respond_to?(:backtrace_cleaner) ?
+        Rails.backtrace_cleaner.send(:filter, exception.backtrace) :
+        exception.backtrace
+    end
+  
+  end
+end

data/client/failurous/fail_notification.rb

@@ -0,0 +1,62 @@
+require 'active_support'
+
+module Failurous
+  class FailNotification
+    attr_accessor :title
+    attr_accessor :data
+  
+    # Builds a Notification from the given exception:
+    #
+    # Title: #{type}: #{message}
+  
+    # Summary
+    #   - type
+    #   - message (not used when combining)
+    #   - topmost line in backtrace
+    # 
+    # Details:
+    #   - full backtrace
+    #
+    def from_exception(exception)
+      self.set_title("#{exception.class}: #{exception.message}").
+        add_field(:summary, :type, exception.class.to_s, {:use_in_checksum => true}).
+        add_field(:summary, :message, exception.message, {:use_in_checksum => false}).
+        add_field(:summary, :topmost_line_in_backtrace, exception.backtrace[0], {:use_in_checksum => true}).
+        add_field(:details, :full_backtrace, exception.backtrace.join('\n'), {:use_in_checksum => false})
+    end
+  
+    def set_title(title)
+      @title = title
+      self
+    end
+  
+    def add_field(section_name, field_name, field_value, field_options = {})
+      @data ||= []
+    
+      found = false
+      field   = [field_name, field_value, field_options]
+    
+      data.each do |existing_section|
+        if existing_section[0] == section_name
+          existing_section[1] << field
+          found = true
+          break
+        end
+      end
+    
+      unless found
+        data << [section_name, [field]]
+      end
+    
+      self
+    end
+  
+    def to_json
+      ActiveSupport::JSON.encode({:title => @title, :data => @data})
+    end
+    
+    def send
+      FailNotifier.send_fail(self)
+    end
+  end
+end

data/client/failurous/fail_notifier.rb

@@ -0,0 +1,13 @@
+require 'net/http'
+require 'uri'
+
+module Failurous
+  class FailNotifier
+    def self.send_fail(notification)
+      server_address, api_key = [Failurous::Config.server_address, Failurous::Config.api_key]
+      post_address = "#{server_address}/api/projects/#{api_key}/fails"
+      
+      p Net::HTTP.post_form URI.parse(post_address), {:data => notification.to_json}
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: failurous-rails
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 7
+  version: 0.1.7
+platform: ruby
+authors: 
+- "Mikko Nyl\xC3\xA9n"
+- Tero Parviainen
+- Antti Forsell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-17 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: actionpack
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  requirement: *id002
+description: Failurous is an open source webapp for monitoring exceptions in your live applications. failurous-rails is a Rails plugin that allows you to send easily notifications of new fails to your Failurous installation.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- client/failurous.rb
+- client/failurous/config.rb
+- client/failurous/fail_middleware.rb
+- client/failurous/fail_notification.rb
+- client/failurous/fail_notifier.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/railsrumble/rr10-team-256
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- client
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Notifier for sending fails to Failurous installation
+test_files: []
+