cheaptoad 0.0.1 → 0.0.3

data/History.txt

@@ -1,4 +1,10 @@
-=== 0.0.1 2009-09-10
+=== 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/Manifest.txt

@@ -5,6 +5,13 @@ PostInstall.txt
 README.rdoc
 Rakefile
 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/USAGE
 generators/cheaptoad_migration/cheaptoad_migration_generator.rb
 generators/cheaptoad_migration/templates/20090914074933_ct_migrate.rb

data/README.rdoc

@@ -16,25 +16,47 @@ app a HopToad server in just a couple of lines!
 == SYNOPSIS:
 
 Make a Rails app, or choose an existing one.  In config/environment.rb,
-add the line "config.cheaptoad".
+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".
 
-Then, create a file called config/initializers/hoptoad.rb:
+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:
 
 HoptoadNotifier.configure do |config|
   config.api_key = 'My Project Name'
-  config.host = 'myapp.host.com'
+  config.host = 'mycheaptoadapp.host.com'
   config.port = 3000
 
   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.
+
 == 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 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".
+
+== 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.
+
 == INSTALL:
 
 sudo gem install cheaptoad

data/app/controllers/notices_controller.rb

@@ -1,15 +1,24 @@
 class NoticesController < ApplicationController
   def index
-    notice = YAML.load(request.raw_post)['notice']
-    logger.info "Received post: #{request.raw_post}"
-    logger.info "Received notice: #{notice.inspect}"
-    #error_class = notice['error_class']
-    #error_message = notice['error_message']
-    #backtrace = notice['back'].blank? : notice['backtrace'] : notice['back']
-    #sess = notice['session']
-    #envir = notice['environment']
+    if request.put? or request.post?
+      notice = Notice.create_from_yaml(request.raw_post)
+      notice.save!
 
-    render :nothing => true
+      render :text => "Successfully received error from hoptoad_notifier!"
+    elsif params[:api_key]
+      @api_key = params[:api_key]
+      @notices = Notice.find_all_by_api_key(@api_key)
+      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,14 @@
+class Notice < ActiveRecord::Base
+  [:session, :request, :environment, :backtrace].each {|a| serialize a}
+
+  def self.create_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)
+    notice.backtrace_digest = Digest::SHA1.hexdigest(notice.backtrace)
+
+    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,18 @@
+atom_feed do |feed|
+  feed.title(@feedtitle || "Error Feed from CheapToad")
+  feed.updated(@notices.first.created_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>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,9 @@
+<h1> CheapToad Notices (errors) for Project <%= @api_key %> </h1>
+
+<h2> Your errors: </h2>
+
+<ul>
+  <% (@notices || []).each do |n| %>
+    <li> <%= link_to(n.error_message, :action => 'show', :id => n.id) %> </li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,20 @@
+<h1> Notice: <%= @notice.error_message %> </h1>
+<h3> Project (API_key): <%= @notice.api_key %> </h3>
+
+<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/templates/20090914074933_ct_migrate.rb

@@ -1,45 +1,23 @@
-class AddBasicRoom < ActiveRecord::Migration
+class CtMigrate < ActiveRecord::Migration
   def self.up
-    create_table "basic_objects", :force => true do |t|
-      t.string :name, :limit => 80
-      t.string :type, :limit => 80
+    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.text :session
+      t.text :request
+      t.text :environment
+      t.text :backtrace
 
-      t.string :base_description, :limit => 240
-
-      # These are used for serialized fields
-      t.text :tags
-      t.text :descriptions
-
-      t.timestamps
-    end
-
-    create_table "basic_exits", :force => true do |t|
-      t.integer :basic_object_id, :null => false
-      t.integer :destination_id, :null => false
-      t.string :type, :limit => 80
-      t.string :name, :limit => 80
-      t.string :description, :limit => 240
-      t.text :tags
       t.timestamps
     end
 
-    create_table "basic_mobiles", :force => true do |t|
-      t.integer :current_room_id
-      t.integer :current_body_id
-      t.string :name, :limit => 80
-      t.string :type, :limit => 80
-
-      # Serialized fields
-      t.text :tags
-      t.text :descriptions
-
-      t.timestamps
-    end
+    add_index("notices", "backtrace_digest")
   end
 
   def self.down
-    drop_table "basic_objects"
-    drop_table "basic_exits"
-    drop_table "basic_mobiles"
+    drop_table "notices"
+    remove_index("notices", "backtrace_digest")
   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.1'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cheaptoad
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors: 
 - Noah Gibbs
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 -07:00
+date: 2009-10-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,13 @@ files:
 - README.rdoc
 - Rakefile
 - 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/USAGE
 - generators/cheaptoad_migration/cheaptoad_migration_generator.rb
 - generators/cheaptoad_migration/templates/20090914074933_ct_migrate.rb