cheaptoad-silas 0.0.6

data/History.txt

@@ -0,0 +1,14 @@
+=== 0.0.6 2010-07-20
+* HopToad protocol v2 support
+* Removed requirement on hoe and newgem
+
+=== 0.0.3 2009-09-16
+* Added basic RSS support
+
+=== 0.0.2 2009-09-16
+* Added support for viewing notices
+
+=== 0.0.1 2009-09-15
+
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Noah Gibbs
+
+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/Manifest.txt

@@ -0,0 +1,26 @@
+app/controllers/notices_controller.rb
+app/models/notice.rb
+app/views/layouts/with_feed.html.erb
+app/views/notices/index.html.erb
+app/views/notices/list_by_api_key.html.erb
+app/views/notices/list_notices.atom.builder
+app/views/notices/list_notices.html.erb
+app/views/notices/show.html.erb
+generators/cheaptoad_migration/cheaptoad_migration_generator.rb
+generators/cheaptoad_migration/templates/20090914074933_ct_migrate.rb
+generators/cheaptoad_migration/USAGE
+History.txt
+init.rb
+install.rb
+lib/cheaptoad.rb
+lib/tasks/cheaptoad.rake
+MIT-LICENSE
+Manifest.txt
+PostInstall.txt
+rails/init.rb
+Rakefile
+README.rdoc
+test/test_cheaptoad.rb
+test/test_helper.rb
+TODO
+uninstall.rb

data/PostInstall.txt

@@ -0,0 +1 @@
+For more information on cheaptoad, see http://github.com/noahgibbs/cheaptoad

data/README.rdoc

@@ -0,0 +1,165 @@
+= CHEAPTOAD
+
+* http://noahgibbs.github.com/cheaptoad
+
+== INSTALL:
+
+sudo gem install cheaptoad
+
+== USE:
+
+In the app you want to catch hoptoad notices:
+
+* Add "config.gem 'cheaptoad'" to environment.rb.
+* Run "./script generate cheaptoad_migration" in your app
+* Run "rake db:migrate" to create the notices table
+* Start your app, and you're catching notices!
+
+In the app you want to send hoptoad notices:
+
+* Install and configure hoptoad like usual (see hoptoad_notifier)
+* In initializers/hoptoad.rb, add:
+  config.host = 'my-app-hostname.mydomain.com'
+  config.port = 4321   # Whatever your app port is
+* Start your app, and errors will now go to your cheaptoad-ified app
+
+== DESCRIPTION:
+
+CheapToad is a simple server plugin for the Hoptoad notifier.  Make an
+app receive and store errors from any app in just a couple of lines!
+
+Hoptoad (hoptoadapp.com) is a commercial application and hosting
+service, run by thoughtbot.  For larger or more important apps, you'll
+want your error logging handled by a reliable, professional service,
+such as thoughtbot and Hoptoad.  For small, simple and experimental
+apps, why pay money?
+
+== WHY CHEAPTOAD?
+
+With CheapToad and Heroku, you can get mostly-reliable remote error
+logging for nothing.  When and if your app grows larger, you can
+change two lines in config/initializers/hoptoad.rb and switch to
+Hoptoad for extra reliability.
+
+Hoptoad has a far better interface, and is free for the first project
+and first two users (up to a given rate of errors received).  But CheapToad
+could still be the right choice if you:
+
+* have a lot of projects and don't want to spend money
+* don't want to let anybody else store your error data
+* have a lot of people to collaborate with, but not that many errors yet
+* feel bad about making a new Hoptoad account for each of your projects
+  just to scam service for free (this is me)
+* need a lot of control over your old error notices -- if cleaning them up
+  after a while is Not Okay for some reason, for instance
+* don't mind hosting for yourself and/or have a hosting solution you like
+* just like running your own stuff, and like to get your hands dirty (also me)
+
+By the way, I'm not affiliated with thoughtbot.  This is all reverse
+engineered from the Hoptoad notifier and somebody's RedMine plugin for
+Hoptoad.  Thoughtbot is aware of CheapToad's existence, but I'm not an
+employee or anything.
+
+Also, if you like CheapToad for your experimental projects, consider
+upgrading a project or two to Hoptoad, or getting your employer to do
+the same.  I don't get a cut, but if I/we are costing them money
+overall then they have less incentive to keep giving us code to use.
+If we act like the farm team for their stuff and occasionally upgrade,
+they have more incentive to keep writing things like the
+hoptoad_notifier for us to bend to our own purposes.
+
+== FEATURES:
+
+* Very simple installation
+* Very simple configuration
+* Keeps your error notices around to browse later
+* 100% free for any number of projects
+* Maintains records of old error notices forever
+* RSS feed of error notices for each project
+
+== PROBLEMS:
+
+* Very simple
+* Not very configurable
+* You have to run your own server, or use something like Heroku
+* 100% Unsecured -- like Hoptoad, we rely on API key uniqueness for security.
+  Unlike Hoptoad, we suggest using fairly guessable API keys.
+* All of these problems can be summed up as "not industrial strength"
+
+== SYNOPSIS:
+
+Make a new Rails app, or choose an existing one.  Install the cheaptoad
+plugin, and configure as mentioned above.  Now that app can receive
+Hoptoad errors!
+
+In any and all apps that you want to send errors to your app, you'll
+need to create a file called config/initializers/hoptoad.rb, just as
+you always would when using Hoptoad.  Here's an example config file:
+
+HoptoadNotifier.configure do |config|
+  config.api_key = 'My Project Name'
+  config.host = 'my-cheaptoad-catcher.heroku.com'
+  config.port = 80  # or whatever port number
+
+  # All standard Hoptoad filters are supported
+  config.filter_parameters << "MY_SECRET_KEY"
+
+end
+
+Note that the host and port are for the app that will *receive*
+Hoptoad errors.  That's the app you added 'config.gem "cheaptoad"'
+to.
+
+== REQUIREMENTS:
+
+You'll need a Rails app, which will be your CheapToad server.  It can
+do whatever else you like, but its notices controller will be used for
+CheapToad stuff.
+
+You will *not* need a Hoptoad API key.  That's kind of the point of this
+project.  Instead of using a big hexadecimal string as your API key, I
+recommend you use a simple string like "My Blog" or "Secret Project X".
+That API key will be used by CheapToad as your project name.
+
+== RESKINNING:
+
+By default, CheapToad has a built-in set of HTML and RSS files to give
+a very simple list of your errors.  If you'd rather use your own, it's
+probably easiest to just build your own notices_controller.rb file and
+appropriate view files to go with it.  You can look at the ones in the
+CheapToad gem to do it -- they're very simple.  Then, add your own new
+HTML, CSS and whatnot to pretty it up.
+
+We're considering adding the ability to put in your own CSS file
+without changing the HTML, just to make the output less stark.  If you
+care about this feature and would use it, contact me and let me know!
+
+== COMPATIBILITY:
+
+CheapToad is compatible with the HopToad protocol v1.  v2 compatibility
+is in the works, and may work as you read this.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Noah Gibbs
+
+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,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the cheaptoad plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the cheaptoad plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cheaptoad'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,9 @@
+Add "legal projects list" to make it annoying for attackers to send unlimited
+false notices
+
+Add CSS to views for easy stylesheetification, and way to supply a CSS file
+from app.  In general, add some kind of simple configuration block to allow
+easier customization than "write all your own views."
+
+Add ability to mark errors handled, so that they go into a different category
+until/unless they show up again.

data/app/controllers/notices_controller.rb

@@ -0,0 +1,27 @@
+class NoticesController < ApplicationController
+  def create
+    notice = Notice.from_v1_yaml(request.raw_post)
+    notice.save!
+
+    render :text => "Successfully received error from hoptoad_notifier!"
+  end
+
+  def index
+    if params[:api_key]
+      @api_key = params[:api_key]
+      @notices = Notice.find_all_by_api_key(@api_key,
+                                            :order => "updated_at DESC")
+      render :layout => "with_feed", :action => "list_notices"
+    else
+      # List API keys
+      res = Notice.connection.execute("SELECT DISTINCT api_key FROM notices")
+      @keys = res.map {|i| i["api_key"]}
+      render :action => "list_by_api_key"
+    end
+  end
+
+  def show
+    @notice = Notice.find(params[:id])
+  end
+
+end

data/app/models/notice.rb

@@ -0,0 +1,40 @@
+class Notice < ActiveRecord::Base
+  [:session, :request, :environment, :backtrace].each {|a| serialize a}
+
+  # Accepts a string or parsed XML
+  def self.from_v2_xml(str)
+    full_xml = Hash.from_xml(str) if str.kind_of? String
+    self.from_hash(full_xml)
+  end
+
+  def self.from_v1_yaml(str)
+    full_yaml = YAML.load(str) if str.kind_of? String
+    self.from_hash(full_yaml)
+  end
+
+  # Accepts a string or parsed YAML
+  def self.from_hash(full_hash)
+    full_hash = full_hash['notice'] if full_hash['notice']
+
+    if(full_hash['backtrace'].kind_of? String)
+      backtraces = full_hash['backtrace']
+    else
+      backtraces = full_hash['backtrace'].join('\n')
+    end
+    digest = Digest::SHA1.hexdigest(backtraces)
+
+    notices = Notice.find_all_by_backtrace_digest(digest)
+    notices = notices.reject! { |i| i.backtrace != full_hash['backtrace'] }
+    if notices and notices.length > 0
+      notices[0].count += 1
+      return notices[0]
+    end
+
+    notice = Notice.create(full_hash)
+    notice.backtrace_digest = digest
+    notice.count = 1
+
+    notice
+  end
+
+end

data/app/views/layouts/with_feed.html.erb

@@ -0,0 +1,5 @@
+<head>
+  <%= auto_discovery_link_tag :atom, notices_url(:format => :atom, :api_key => @api_key) %>
+<body>
+  <%= yield %>
+</body>

data/app/views/notices/index.html.erb

@@ -0,0 +1,4 @@
+<p>
+  You shouldn't see this page unless you manually go to index.html here.
+  Maybe you want <a href="list_notices.html">this page</a>?
+</p>

data/app/views/notices/list_by_api_key.html.erb

@@ -0,0 +1,7 @@
+<h1> CheapToad Projects (API Keys) </h1>
+
+<ul>
+  <% @keys.each do |k| %>
+    <li> <%= link_to(k, :action => 'index', :api_key => k) -%> </li>
+  <% end %>
+</ul>

data/app/views/notices/list_notices.atom.builder

@@ -0,0 +1,22 @@
+atom_feed(:root_url => request.url) do |feed|
+  feed.title(@feedtitle || "Error Feed for #{@api_key} from CheapToad")
+  feed.updated(@notices.first.updated_at)
+
+  @notices.each do |notice|
+    feed.entry(notice) do |entry|
+      entry.title(notice.error_message)
+      entry.content(<<END ,
+<b>Project/APIkey:</b> #{notice.api_key} <br/>
+
+<b>Error location:</b> #{notice.backtrace[0]} <br/>
+
+<b>Error class:</b> #{notice.error_class}<br/>
+
+This error has occurred #{notice.count} times<br/>
+
+<b>Request:</b> #{simple_format notice.request.to_yaml}
+END
+                    :type => 'html')
+    end
+  end
+end

data/app/views/notices/list_notices.html.erb

@@ -0,0 +1,15 @@
+<h1> CheapToad Notices (errors) for Project <%= @api_key %> </h1>
+
+<h2> Your errors: </h2>
+
+<table>
+  <th> <td> Error message </td> <td> Count </td>
+  </th>
+
+  <% (@notices || []).each do |n| %>
+    <tr>
+      <td><%= link_to(n.error_message, :action => 'show', :id => n.id) %></td>
+      <td><%= n.count %></td>
+    </tr>
+  <% end %>
+</ul>

data/app/views/notices/show.html.erb

@@ -0,0 +1,26 @@
+<h1> Notice: <%= @notice.error_message %> </h1>
+<h3> Project (API_key): <%= @notice.api_key %> </h3>
+
+<p>
+  first instance of this error: <%= @notice.created_at %> <br />
+  most recent instance of this error: <%= @notice.updated_at %> <br />
+  number of occurrences: <b><%= @notice.count %></b>
+</p>
+
+<hr />
+
+<h2> Request </h2>
+
+<%= simple_format @notice.request.to_yaml %>
+
+<h2> Backtrace </h2>
+
+<%= simple_format @notice.backtrace.to_yaml %>
+
+<h2> Session Info </h2>
+
+<%= simple_format @notice.session.to_yaml %>
+
+<h2> Environment Variables </h2>
+
+<%= simple_format @notice.environment.to_yaml %>

data/generators/cheaptoad_migration/USAGE

@@ -0,0 +1,5 @@
+Description:
+    This generator creates a migration for entries in the CheapToad database.
+
+Example:
+    ./script/generate cheaptoad_generator

data/generators/cheaptoad_migration/cheaptoad_migration_generator.rb

@@ -0,0 +1,11 @@
+class CheaptoadMigrationGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.directory "db/migrate"
+      m.template '20090914074933_ct_migrate.rb',
+      		  "db/migrate/20090914074933_ct_migrate.rb"
+    end
+  end
+
+end

data/generators/cheaptoad_migration/templates/20090914074933_ct_migrate.rb

@@ -0,0 +1,26 @@
+class CtMigrate < ActiveRecord::Migration
+  def self.up
+    create_table "notices", :force => true do |t|
+      t.string :api_key, :limit => 100
+      t.string :error_message, :limit => 200
+      t.string :error_class, :limit => 100
+      t.string :backtrace_digest, :limit => 256
+      t.integer :count
+      t.text :session
+      t.text :request
+      t.text :environment
+      t.text :backtrace
+
+      t.timestamps
+    end
+
+    add_index("notices", "backtrace_digest")
+    add_index("notices", "updated_at")
+  end
+
+  def self.down
+    remove_index("notices", "backtrace_digest")
+    remove_index("notices", "updated_at")
+    drop_table "notices"
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), "rails", "init.rb")

data/install.rb

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

data/lib/cheaptoad.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Cheaptoad
+  VERSION = '0.0.5'
+end

data/lib/tasks/cheaptoad.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cheaptoad do
+#   # Task goes here
+# end

data/rails/init.rb

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

data/test/test_cheaptoad.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestCheaptoad < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/cheaptoad'

data/uninstall.rb

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

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: cheaptoad-silas
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 6
+  version: 0.0.6
+platform: ruby
+authors: 
+- Noah Gibbs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id001
+description: Add just a couple of lines to your app, and have it receive exceptions from your other apps via the hoptoad_notifier.
+email: noah_nospam_gibbs@remove_nospam.yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/controllers/notices_controller.rb
+- app/models/notice.rb
+- app/views/layouts/with_feed.html.erb
+- app/views/notices/index.html.erb
+- app/views/notices/list_by_api_key.html.erb
+- app/views/notices/list_notices.atom.builder
+- app/views/notices/list_notices.html.erb
+- app/views/notices/show.html.erb
+- generators/cheaptoad_migration/cheaptoad_migration_generator.rb
+- generators/cheaptoad_migration/templates/20090914074933_ct_migrate.rb
+- generators/cheaptoad_migration/USAGE
+- History.txt
+- init.rb
+- install.rb
+- lib/cheaptoad.rb
+- lib/tasks/cheaptoad.rake
+- MIT-LICENSE
+- Manifest.txt
+- PostInstall.txt
+- rails/init.rb
+- Rakefile
+- README.rdoc
+- test/test_cheaptoad.rb
+- test/test_helper.rb
+- TODO
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/noahgibbs
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cheaptoad
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Catch hoptoad notices from your app.
+test_files: []
+