cheaptoad 0.0.6 → 0.0.7

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.0.7 2010-09-17
+* Rails 3 support
+
+=== 0.0.6 2010-09-17
+* HopToad protocol v2 support (v1 deprecated)
+
+=== 0.0.5 2010-07-20
+* Removed requirement on hoe and newgem
+
 === 0.0.3 2009-09-16
 * Added basic RSS support
 

data/Manifest.txt

@@ -1,11 +1,5 @@
-History.txt
-MIT-LICENSE
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-TODO
 app/controllers/notices_controller.rb
+app/controllers/notifier_api_controller.rb
 app/models/notice.rb
 app/views/layouts/with_feed.html.erb
 app/views/notices/index.html.erb
@@ -13,16 +7,24 @@ 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
+generators/cheaptoad_migration/USAGE
+History.txt
 init.rb
 install.rb
 lib/cheaptoad.rb
+lib/generators/cheaptoad_migration/cheaptoad_migration_generator.rb
+lib/generators/cheaptoad_migration/templates/migration.rb
+lib/generators/cheaptoad_migration/USAGE
+lib/tasks/cheaptoad.rake
+MIT-LICENSE
+Manifest.txt
+PostInstall.txt
 rails/init.rb
-script/console
-script/destroy
-script/generate
+Rakefile
+README.rdoc
 test/test_cheaptoad.rb
 test/test_helper.rb
+TODO
 uninstall.rb

data/PostInstall.txt

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

data/README.rdoc

@@ -1,40 +1,102 @@
-= cheaptoad
+= CHEAPTOAD
 
-* http://cheaptoad.rubyforge.org
+* http://noahgibbs.github.com/cheaptoad
+
+== INSTALL:
+
+sudo gem install cheaptoad
+
+== USE:
+
+In the app you want to catch hoptoad notices:
+
+* Make your app use the gem:
+  * In Rails 2.3.X: Add "config.gem 'cheaptoad'" to environment.rb.
+  * In Rails 3: Add "gem 'cheaptoad'" to your Gemfile
+* 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 your
-app a HopToad server in just a couple of lines!
+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 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
+* 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
-* 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
+* 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.  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!
+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, create a
-file called config/initializers/hoptoad.rb, as you always would when
-using HopToad.  Install the HopToad (or CheapToad) notifier also, of
-course.  The config file will look a bit like this:
+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'
@@ -42,12 +104,12 @@ HoptoadNotifier.configure do |config|
   config.port = 80  # or whatever port number
 
   # All standard Hoptoad filters are supported
-  config.environment_filters << "MY_SECRET_KEY"
+  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 the 'config.gem "cheaptoad"'
+Hoptoad errors.  That's the app you added 'config.gem "cheaptoad"'
 to.
 
 == REQUIREMENTS:
@@ -56,7 +118,7 @@ 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
+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.
@@ -74,15 +136,20 @@ 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:
+== COMPATIBILITY:
 
-sudo gem install cheaptoad
+CheapToad is compatible with the HopToad protocol v1.  v2 compatibility
+is in the works, and may work as you read this.
+
+== CREDITS:
+
+Written by Noah Gibbs, with updates by Silas Baronda
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 Noah Gibbs
+Copyright (c) 2009-2010 Noah Gibbs
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,26 +1,23 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/cheaptoad'
-
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'cheaptoad' do
-  self.developer 'Noah Gibbs', 'noah_gibbs@yahoo.com'
-  self.post_install_message = 'PostInstall.txt'
-  self.rubyforge_name       = self.name # TODO this is default value
-  self.extra_deps         = [['rails','>= 2.3.4']]
-
-end
-
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]
+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/app/controllers/notices_controller.rb

@@ -1,11 +1,4 @@
 class NoticesController < ApplicationController
-  def create
-    notice = Notice.notice_from_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]

data/app/controllers/notifier_api_controller.rb

@@ -0,0 +1,10 @@
+class NotifierApiController < ApplicationController
+  # Under Rails 2.X, matches /notifier_api/v2/notices automatically
+  def v2
+    notice = Notice.from_v2_xml(request.raw_post)
+    notice.save!
+
+    render :text => "Successfully received error from hoptoad_notifier v2!"
+  end
+
+end

data/app/models/notice.rb

@@ -1,26 +1,52 @@
 class Notice < ActiveRecord::Base
   [:session, :request, :environment, :backtrace].each {|a| serialize a}
 
-  def self.notice_from_yaml(str)
+  # 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
-    full_yaml = full_yaml['notice'] if full_yaml['notice']
+    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_yaml['backtrace'].kind_of? String)
-      backtraces = full_yaml['backtrace']
+    if(full_hash['error']['backtrace'].kind_of? String)
+      backtraces = full_hash['error']['backtrace']
     else
-      backtraces = full_yaml['backtrace'].join('\n')
+      backtraces = full_hash['error']['backtrace']['line']
     end
-    digest = Digest::SHA1.hexdigest(backtraces)
+    digest = Digest::SHA1.hexdigest(backtraces.to_s)
 
     notices = Notice.find_all_by_backtrace_digest(digest)
-    notices = notices.reject! { |i| i.backtrace != full_yaml['backtrace'] }
+    notices = notices.reject! { |i|
+      i.backtrace != full_hash['error']['backtrace']['line']
+    }
     if notices and notices.length > 0
       notices[0].count += 1
       return notices[0]
     end
 
-    notice = Notice.create(full_yaml)
+    # Convert to old format - ugly, but it works and doesn't break
+    # all the views (yet)
+    notice = Notice.new
+
+    notice.api_key = full_hash['api_key']
+    notice.error_message = full_hash['error']['message']
+    notice.error_class = full_hash['error']['class']
+
     notice.backtrace_digest = digest
+
+    notice.session = nil
+    notice.environment = full_hash['server_environment']['environment_name']
+    notice.request = full_hash['request']
+    notice.backtrace = backtraces
+
     notice.count = 1
 
     notice

data/lib/cheaptoad.rb

@@ -1,6 +1,9 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-module Cheaptoad
-  VERSION = '0.0.6'
-end
+if Rails::VERSION::MAJOR > 2
+  module Cheaptoad
+    class Cheaptoad < Rails::Engine
+    end
+  end
+end

data/lib/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/lib/generators/cheaptoad_migration/cheaptoad_migration_generator.rb

@@ -0,0 +1,20 @@
+class CheaptoadMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  filename = File.expand_path("templates",
+                              File.dirname(__FILE__));
+  source_root filename
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template "migration.rb", "db/migrate/add_cheaptoad_table.rb"
+  end
+
+end

data/lib/generators/cheaptoad_migration/templates/migration.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/lib/tasks/cheaptoad.rake

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

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cheaptoad
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Noah Gibbs
@@ -9,51 +14,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-22 00:00:00 -08:00
+date: 2010-09-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.4
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
-description: |-
-  CheapToad is a simple server plugin for the HopToad notifier.  Make your
-  app a HopToad server in just a couple of lines!
-email: 
-- noah_gibbs@yahoo.com
+        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: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
+extra_rdoc_files: []
+
 files: 
-- History.txt
-- MIT-LICENSE
-- Manifest.txt
-- PostInstall.txt
-- README.rdoc
-- Rakefile
-- TODO
 - app/controllers/notices_controller.rb
+- app/controllers/notifier_api_controller.rb
 - app/models/notice.rb
 - app/views/layouts/with_feed.html.erb
 - app/views/notices/index.html.erb
@@ -61,48 +49,58 @@ files:
 - 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
+- generators/cheaptoad_migration/USAGE
+- History.txt
 - init.rb
 - install.rb
 - lib/cheaptoad.rb
+- lib/generators/cheaptoad_migration/cheaptoad_migration_generator.rb
+- lib/generators/cheaptoad_migration/templates/migration.rb
+- lib/generators/cheaptoad_migration/USAGE
+- lib/tasks/cheaptoad.rake
+- MIT-LICENSE
+- Manifest.txt
+- PostInstall.txt
 - rails/init.rb
-- script/console
-- script/destroy
-- script/generate
+- Rakefile
+- README.rdoc
 - test/test_cheaptoad.rb
 - test/test_helper.rb
+- TODO
 - uninstall.rb
 has_rdoc: true
-homepage: http://cheaptoad.rubyforge.org
+homepage: http://github.com/noahgibbs
 licenses: []
 
-post_install_message: PostInstall.txt
-rdoc_options: 
-- --main
-- README.rdoc
+post_install_message: 
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: cheaptoad
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: CheapToad is a simple server plugin for the HopToad notifier
-test_files: 
-- test/test_cheaptoad.rb
-- test/test_helper.rb
+summary: Catch hoptoad notices from your app.
+test_files: []
+

data/script/console

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# File: script/console
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs =  " -r irb/completion"
-# Perhaps use a console_lib to store any extra methods I may want available in the cosole
-# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/cheaptoad.rb'}"
-puts "Loading cheaptoad gem"
-exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/destroy'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/generate'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Generate.new.run(ARGV)