alexyoung-loom-exceptions-rails-plugin 2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,35 @@
+h2. Loom
+
+This plugin provides exception reporting for "Loom":http://loomapp.com.
+
+h2. Usage
+
+You must sign up to Loom to use this plugin.  Install as a gem or a plugin.
+
+h3. Installation
+
+As a gem:
+
+<code>gem install loom-exceptions-rails-plugin --source=http://gems.github.com/</code>
+
+As a plugin:
+
+<code>script/plugin install git://github.com/alexyoung/loom-exceptions-rails-plugin.git</code>
+
+Add this to <code>config/initializers/loom.rb</code>
+
+<pre><code>
+Helicoid::Loom.configure do |config|
+  config.api_key = 'xxx'
+  config.server = 'http://loomapp.com'
+end
+</code></pre>
+
+The <code>server</code> option can be used with the open source version of Loom.
+
+h2. Credits
+
+* Created by Alex Young for Helicoid Limited (helicoid.net)
+* Advice and additional development by Gabriel Gironda (annealer.org)
+
+Copyright (c) 2008-2009 Helicoid Limited, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the loom plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the loom plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Loom'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,4 @@
+require 'loom'
+require 'loom_exception'
+
+Helicoid::Loom.enable

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/loom.rb

@@ -0,0 +1,65 @@
+module Helicoid
+  module Loom
+    class << self
+      attr_accessor :api_key, :server, :before_action, :user_id
+
+      def enable
+        ActionController::Base.class_eval do
+          include Reporter
+        end
+      end
+
+      def configure
+        yield self
+
+        self.server ||= 'http://loomapp.com'
+
+        if defined?(ActionController::Base) && !ActionController::Base.include?(Helicoid::Loom::Reporter)
+          enable
+        end
+      end
+    end
+    
+    module Reporter
+      def self.included(base)
+        base.send(:alias_method, :original_rescue_action_in_public, :rescue_action_in_public)
+        base.send(:alias_method, :rescue_action_in_public, :send_to_loom)
+      end
+
+      def send_to_loom(exception)
+        raise if local_request?
+        
+        send(Helicoid::Loom.before_action) if Helicoid::Loom.before_action
+        
+        user_id = case Helicoid::Loom.user_id
+        when Proc
+          Helicoid::Loom.user_id.bind(self).call
+        when Symbol, String
+          send Helicoid::Loom.user_id
+        end
+        
+        LoomException.log Helicoid::Loom.server, Helicoid::Loom.api_key do |loom|
+          loom.session = session.data
+          loom.remote_ip = request.remote_ip
+          loom.exception = exception
+          loom.cookies = request.cookies
+          loom.request_parameters = request.parameters
+          loom.url = request.request_uri
+          loom.user_id = user_id
+        end
+
+        original_rescue_action_in_public exception
+      end
+    end
+    
+    module ClassMethods
+      def logger
+        ActiveRecord::Base.logger
+      end
+
+      def enable_loom(options = {})
+        logger.warn "enable_loom has been removed.  Please use config/initializers/loom.rb."
+      end
+    end
+  end
+end

data/lib/loom_exception.rb

@@ -0,0 +1,121 @@
+require 'pp'
+require 'net/http'
+
+class LoomException
+  attr_accessor :session, :cookies, :request_parameters, :url, :user_id, :exception, :remote_ip
+  
+  class LoomDown < Exception ; end
+  class LoomError < Exception ; end
+  
+  def initialize(url, api_key)
+    @loom_login = { :url => url, :api_key => api_key }
+  end
+  
+  def send_to_loom
+    response = post
+    
+    if response.code.match /^2/
+      true
+    else
+      puts response.message
+      puts response.body
+    end
+  end
+  
+  def self.log(url, api_key, &block)
+    loom = new url, api_key
+    yield loom
+    loom.send_to_loom
+  rescue LoomDown # TODO
+    # Timed out or Loom down.  Log the error and optionally email the administrator.
+  rescue LoomError # TODO
+    # We sent an invalid request.  Log the error and optionally email the administrator.
+  rescue Exception # TODO
+    # Something else happened, log it.  The user will be shown an error page so they
+    # can acknowledge the issue and continue using the application.
+  end
+  
+  private
+    def post
+      url = URI.parse "#{@loom_login[:url]}/report/#{@loom_login[:api_key]}"
+    
+      req = Net::HTTP::Post.new url.path
+      req.add_field 'Accept', 'application/xml'
+      req.add_field 'Content-Type', 'application/xml'
+      
+      connection = Net::HTTP.new(url.host, url.port)
+      connection.request req, loom_parameters_as_xml
+    end
+
+    def loom_parameters_as_xml
+      for_xml = loom_parameters.dup
+      for_xml[:details].each do |key, value|
+        # Convert parameters that can't be converted to XML
+        if value.kind_of? Hash
+          value.each do |value_key, value_value|
+            if incompatible_with_to_xml? value_value
+              for_xml[:details][key][value_key] = dump_to_string(value_value)
+            end
+          end
+        elsif incompatible_with_to_xml?(value)
+          for_xml[:details][key] = dump_to_string(value)
+        end
+      end
+      
+      for_xml = convert_all_keys_to_valid_xml_keys(for_xml)
+      for_xml.to_xml(:root => 'remote_exception')
+    end
+    
+    def incompatible_with_to_xml?(value)
+      if value.kind_of?(String) or value.kind_of?(Numeric)
+        return false
+      else
+        value.to_xml
+      end
+      
+      return false
+    rescue Exception
+      return true
+    end
+    
+    def dump_to_string(value)
+      PP.pp(value, "")
+    rescue Exception
+      "Loom error: Unable to parse value as XML"
+    end
+    
+    # Removes keys like -session_id which will break the API
+    def convert_all_keys_to_valid_xml_keys(values)
+      returning Hash.new do |converted_values|
+        values.each do |key, value|
+          if value.kind_of? Hash
+            converted_values[convert_key_to_xml_key(key)] = convert_all_keys_to_valid_xml_keys(value)
+          else
+            converted_values[convert_key_to_xml_key(key)] = value
+          end
+        end
+      end
+    end
+    
+    def convert_key_to_xml_key(key)
+      key.to_s.sub(/^[^[:alnum:]]/, '')
+    end
+
+    def loom_parameters
+      {
+        :title => "#{@exception.class}: #{@exception.to_s}",
+        :details => { :session_variables => @session.dup,
+                      :cookies => @cookies.dup,
+                      :request_parameters => @request_parameters.dup,
+                      :url => @url,
+                      :user_id => @user_id,
+                      :remote_ip => @remote_ip,
+                      :stack_trace => stack_trace }
+      }
+    end
+    
+    def stack_trace
+      return '' unless @exception.backtrace
+      @exception.backtrace.join("\n")
+    end
+end

data/loom-exceptions-rails-plugin.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{loom-exceptions-rails-plugin}
+  s.version = "2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex R. Young"]
+  s.date = %q{2009-07-18}
+  s.description = %q{Loom is a helpdesk web app which supports exception handling and notifications.}
+  s.email = %q{tom@mojombo.com}
+  s.files = ["init.rb", "install.rb", "lib", "lib/loom.rb", "lib/loom_exception.rb", "loom-exceptions-rails-plugin.gemspec", "MIT-LICENSE", "Rakefile", "README.textile", "tasks", "tasks/loom_tasks.rake", "test", "test/exception_test.rb", "test/loom_test.rb", "uninstall.rb"]
+  s.has_rdoc = false
+  s.homepage = %q{http://loomapp.com}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.0}
+  s.summary = %q{This gem provides exception notification handling for your Rails applications.}
+end
+

data/tasks/loom_tasks.rake

@@ -0,0 +1,31 @@
+# desc "Explaining what the task does"
+# task :loom do
+#   # Task goes here
+# end
+
+namespace :loom do
+  desc "Sends a test exception so you can test your settings"
+  task :test do
+    require 'action_controller/test_process'
+    require 'app/controllers/application_controller'
+
+    class ApplicationController
+      def test
+       puts "Connecting to server: #{Helicoid::Loom.server} with API key: #{Helicoid::Loom.api_key}"
+       raise "This is a test error notification"
+      end
+
+      def rescue_action(exception)
+        rescue_action_in_public exception
+      end
+    end
+
+    request = ActionController::TestRequest.new
+    response = ActionController::TestResponse.new
+
+    request.action = 'test'
+    request.request_uri = '/test'
+
+    ApplicationController.process request, response
+  end
+end

data/test/loom_test.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'active_support'
+require 'ostruct'
+require 'test/unit'
+require 'mocha'
+require File.dirname(__FILE__) + '/../lib/loom'
+require File.dirname(__FILE__) + '/../lib/loom_exception'
+
+class LoomTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+
+  def setup
+    stub_loom_api
+  end
+  
+  def test_catches_exception
+  end
+
+  def test_posts_to_loom
+    exception = mock_loom_exception :exception => mock_exception
+    assert exception.send_to_loom
+  end
+
+  def test_posts_to_loom_with_nil_backtrace
+    exception = mock_loom_exception
+    assert exception.send_to_loom
+  end
+
+  def test_configure
+    Helicoid::Loom.configure do |config|
+      config.api_key = 'xxx'
+    end
+
+    assert_equal 'xxx', Helicoid::Loom.api_key
+    assert_equal 'http://loomapp.com', Helicoid::Loom.server
+  end
+
+  private
+
+    def mocked_response(options = {})
+      OpenStruct.new :code => '200'
+    end
+
+    def stub_loom_api
+      Net::HTTP.any_instance.stubs(:request).returns mocked_response
+    end
+
+    def mock_exception
+      exception = nil
+      begin
+        1 / 0
+      rescue Exception => e
+        exception = e
+      end
+      exception
+    end
+
+    def mock_loom_exception(options = {})
+      exception = LoomException.new 'helicoid', 'xxx'
+      exception.session = OpenStruct.new :user_id => '1'
+      exception.cookies = []
+      exception.request_parameters = []
+      exception.url = 'http://example.com'
+      exception.user_id = '1'
+      exception.exception = options[:exception] || ZeroDivisionError.new
+      exception.remote_ip = '127.0.0.1'
+      exception
+    end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: alexyoung-loom-exceptions-rails-plugin
+version: !ruby/object:Gem::Version 
+  version: "2.0"
+platform: ruby
+authors: 
+- Alex R. Young
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-18 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Loom is a helpdesk web app which supports exception handling and notifications.
+email: tom@mojombo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- install.rb
+- lib
+- lib/loom.rb
+- lib/loom_exception.rb
+- loom-exceptions-rails-plugin.gemspec
+- MIT-LICENSE
+- Rakefile
+- README.textile
+- tasks
+- tasks/loom_tasks.rake
+- test
+- test/exception_test.rb
+- test/loom_test.rb
+- uninstall.rb
+has_rdoc: false
+homepage: http://loomapp.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: This gem provides exception notification handling for your Rails applications.
+test_files: []
+