cheaptoad 0.0.4 → 0.0.6

data/README.rdoc

@@ -7,55 +7,72 @@
 CheapToad is a simple server plugin for the HopToad notifier.  Make your
 app a HopToad server in just a couple of lines!
 
-== FEATURES/PROBLEMS:
+== FEATURES:
 
 * Very simple installation
 * Very simple configuration
 * Keeps your exceptions around to browse later
+* Free for any number of projects!  That's cheaper than HopToad
+* Maintains records of old errors forever, unlike HopToad
+* RSS feed of errors for each project
+
+== PROBLEMS:
+
+* Very simple
+* Not very configurable
+* 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
 
 == SYNOPSIS:
 
-Make a Rails app, or choose an existing one.  In config/environment.rb,
-add the line 'config.gem "cheaptoad"'.  Now, that app can receive
-HopToad errors!  If you want it to give you an RSS feed of errors (who
-wouldn't?), you'll also need to go into config/routes.rb and add the
-line "resources :notices".
+Make a new Rails app, or choose an existing one.  In
+config/environment.rb, add the line 'config.gem "cheaptoad"'.  You'll
+also need to go into config/routes.rb and add the line "resources
+:notices".  Now that app can receive HopToad errors!
 
 In any and all apps that you want to send errors to your app, create a
 file called config/initializers/hoptoad.rb, as you always would when
-using HopToad.  Install the HopToad notifier also, of course.  The config
-file will look a bit like this:
+using HopToad.  Install the HopToad (or CheapToad) notifier also, of
+course.  The config file will look a bit like this:
 
 HoptoadNotifier.configure do |config|
   config.api_key = 'My Project Name'
-  config.host = 'mycheaptoadapp.host.com'
-  config.port = 3000
+  config.host = 'my-cheaptoad-catcher.heroku.com'
+  config.port = 80  # or whatever port number
 
+  # All standard Hoptoad filters are supported
   config.environment_filters << "MY_SECRET_KEY"
 
 end
 
-Note that the host and port are for the app that will *receive* HopToad
-errors, the app you added the 'config.gem "cheaptoad"' to.
+Note that the host and port are for the app that will *receive*
+HopToad errors.  That's the app you added the '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 (by default
-"/notices") will be used for CheapToad stuff.
+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
-your local copy of the CheapToad gem to do it -- they're really quite
-simple.  Then, add your own new HTML, CSS and whatnot to pretty it up.
+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!
 
 == INSTALL:
 

data/TODO

@@ -1,2 +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

@@ -1,6 +1,6 @@
 class NoticesController < ApplicationController
   def create
-    notice = Notice.create_from_yaml(request.raw_post)
+    notice = Notice.notice_from_yaml(request.raw_post)
     notice.save!
 
     render :text => "Successfully received error from hoptoad_notifier!"
@@ -9,7 +9,8 @@ class NoticesController < ApplicationController
   def index
     if params[:api_key]
       @api_key = params[:api_key]
-      @notices = Notice.find_all_by_api_key(@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

data/app/models/notice.rb

@@ -1,17 +1,27 @@
 class Notice < ActiveRecord::Base
   [:session, :request, :environment, :backtrace].each {|a| serialize a}
 
-  def self.create_from_yaml(str)
+  def self.notice_from_yaml(str)
     full_yaml = YAML.load(str) if str.kind_of? String
     full_yaml = full_yaml['notice'] if full_yaml['notice']
 
-    notice = Notice.create(full_yaml)
-    if(notice.backtrace.kind_of? String)
-      backtraces = notice.backtrace
+    if(full_yaml['backtrace'].kind_of? String)
+      backtraces = full_yaml['backtrace']
     else
-      backtraces = notice.backtrace.join('\n')
+      backtraces = full_yaml['backtrace'].join('\n')
+    end
+    digest = Digest::SHA1.hexdigest(backtraces)
+
+    notices = Notice.find_all_by_backtrace_digest(digest)
+    notices = notices.reject! { |i| i.backtrace != full_yaml['backtrace'] }
+    if notices and notices.length > 0
+      notices[0].count += 1
+      return notices[0]
     end
-    notice.backtrace_digest = Digest::SHA1.hexdigest(backtraces)
+
+    notice = Notice.create(full_yaml)
+    notice.backtrace_digest = digest
+    notice.count = 1
 
     notice
   end

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

@@ -1,6 +1,6 @@
-atom_feed do |feed|
-  feed.title(@feedtitle || "Error Feed from CheapToad")
-  feed.updated(@notices.first.created_at)
+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|
@@ -10,6 +10,10 @@ atom_feed do |feed|
 
 <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')

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

@@ -2,8 +2,14 @@
 
 <h2> Your errors: </h2>
 
-<ul>
+<table>
+  <th> <td> Error message </td> <td> Count </td>
+  </th>
+
   <% (@notices || []).each do |n| %>
-    <li> <%= link_to(n.error_message, :action => 'show', :id => n.id) %> </li>
+    <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

@@ -1,6 +1,12 @@
 <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>

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

@@ -5,6 +5,7 @@ class CtMigrate < ActiveRecord::Migration
       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
@@ -14,10 +15,12 @@ class CtMigrate < ActiveRecord::Migration
     end
 
     add_index("notices", "backtrace_digest")
+    add_index("notices", "updated_at")
   end
 
   def self.down
-    drop_table "notices"
     remove_index("notices", "backtrace_digest")
+    remove_index("notices", "updated_at")
+    drop_table "notices"
   end
 end

data/lib/cheaptoad.rb

@@ -2,5 +2,5 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module Cheaptoad
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cheaptoad
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors: 
 - Noah Gibbs
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 -07:00
+date: 2009-11-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency