square-hoptoad_notifier 2.4.8

data/README_FOR_HEROKU_ADDON.md

@@ -0,0 +1,93 @@
+Hoptoad
+===========
+Send your application errors to our hosted service and reclaim your inbox.
+
+1. Installing the Heroku add-on
+----------------------------
+To use Hoptoad on Heroku, install the Hoptoad add-on:
+
+    $ heroku addons:add hoptoad:basic # This adds the the basic plan.
+                                      # If you'd like another plan, specify that instead.
+
+2. Including the Hoptoad notifier in your application
+--------------------------------------------------
+After adding the Hoptoad add-on, you will need to install and configure the Hoptoad notifier.
+
+Your application connects to Hoptoad with an API key. On Heroku, this is automatically provided to your
+application in `ENV['HOPTOAD_API_KEY']`, so installation should be a snap!
+
+### Rails 3.x
+
+Add the hoptoad_notifier and heroku gems to your Gemfile.  In Gemfile:
+
+    gem 'hoptoad_notifier'
+    gem 'heroku'
+
+Then from your project's RAILS_ROOT, run:
+
+    $ bundle install
+    $ script/rails generate hoptoad --heroku
+
+### Rails 2.x
+
+Install the heroku gem if you haven't already:
+
+    gem install heroku
+
+Add the hoptoad_notifier gem to your app. In config/environment.rb:
+
+    config.gem 'hoptoad_notifier'
+
+Then from your project's RAILS_ROOT, run:
+
+    $ rake gems:install
+    $ rake gems:unpack GEM=hoptoad_notifier
+    $ script/generate hoptoad --heroku
+
+As always, if you choose not to vendor the hoptoad_notifier gem, make sure
+every server you deploy to has the gem installed or your application won't start.
+
+### Rack applications
+
+In order to use hoptoad_notifier in a non-Rails rack app, just load the hoptoad_notifier, configure your API key, and use the HoptoadNotifier::Rack middleware:
+
+    require 'rubygems'
+    require 'rack'
+    require 'hoptoad_notifier'
+
+    HoptoadNotifier.configure do |config|
+      config.api_key = `ENV['HOPTOAD_API_KEY']`
+    end
+
+    app = Rack::Builder.app do
+      use HoptoadNotifier::Rack
+      run lambda { |env| raise "Rack down" }
+    end
+
+### Rails 1.x
+
+For Rails 1.x, visit the [Hoptoad notifier's README on GitHub](http://github.com/thoughtbot/hoptoad_notifier),
+and be sure to use `ENV['HOPTOAD_API_KEY']` where your API key is required in configuration code.
+
+3. Configure your notification settings (important!)
+---------------------------------------------------
+
+Once you have included and configured the notifier in your application,
+you will want to configure your notification settings.
+
+This is important - without setting your email address, you won't receive notification emails.
+
+Hoptoad can deliver exception notifications to your email inbox.  To configure these delivery settings:
+
+1. Visit your application's Hoptoad Add-on page, like [ http://api.heroku.com/myapps/my-great-app/addons/hoptoad:basic ](http://api.heroku.com/myapps/my-great-app/addons/hoptoad:basic) 
+2. Click "Go to Hoptoad admin" to configure the Hoptoad Add-on on the Hoptoadapp.com website
+3. Click the "Profile" button in the header to edit your email address and notification settings.
+
+4. Optionally: Set up deploy notification
+-----------------------------------------
+
+If your Hoptoad plan supports deploy notification, set it up for your Heroku application like this:
+
+    rake hoptoad:heroku:add_deploy_notification
+
+This will install a Heroku [HTTP Deploy Hook](http://docs.heroku.com/deploy-hooks) to notify Hoptoad of the deploy.

data/Rakefile

@@ -0,0 +1,227 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'cucumber/rake/task'
+
+desc 'Default: run unit tests.'
+task :default => [:test, "cucumber:rails:all"]
+
+desc 'Test the hoptoad_notifier gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Run ginger tests'
+task :ginger do
+  $LOAD_PATH << File.join(*%w[vendor ginger lib])
+  ARGV.clear
+  ARGV << 'test'
+  load File.join(*%w[vendor ginger bin ginger])
+end
+
+namespace :changeling do
+  desc "Bumps the version by a minor or patch version, depending on what was passed in."
+  task :bump, :part do |t, args|
+    # Thanks, Jeweler!
+    if HoptoadNotifier::VERSION  =~ /^(\d+)\.(\d+)\.(\d+)(?:\.(.*?))?$/
+      major = $1.to_i
+      minor = $2.to_i
+      patch = $3.to_i
+      build = $4
+    else
+      abort
+    end
+
+    case args[:part]
+    when /minor/
+      minor += 1
+      patch = 0
+    when /patch/
+      patch += 1
+    else
+      abort
+    end
+
+    version = [major, minor, patch, build].compact.join('.')
+
+    File.open(File.join("lib", "hoptoad_notifier", "version.rb"), "w") do |f|
+      f.write <<EOF
+module HoptoadNotifier
+  VERSION = "#{version}".freeze
+end
+EOF
+    end
+  end
+
+  desc "Writes out the new CHANGELOG and prepares the release"
+  task :change do
+    load 'lib/hoptoad_notifier/version.rb'
+    file    = "CHANGELOG"
+    old     = File.read(file)
+    version = HoptoadNotifier::VERSION
+    message = "Bumping to version #{version}"
+
+    File.open(file, "w") do |f|
+      f.write <<EOF
+Version #{version} - #{Time.now}
+===============================================================================
+
+#{`git log $(git tag | tail -1)..HEAD | git shortlog`}
+#{old}
+EOF
+    end
+
+    exec ["#{ENV["EDITOR"]} #{file}",
+          "git commit -aqm '#{message}'",
+          "git tag -a -m '#{message}' v#{version}",
+          "echo '\n\n\033[32mMarked v#{version} /' `git show-ref -s refs/heads/master` 'for release. Run: rake changeling:push\033[0m\n\n'"].join(' && ')
+  end
+
+  desc "Bump by a minor version (1.2.3 => 1.3.0)"
+  task :minor do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
+  desc "Bump by a patch version, (1.2.3 => 1.2.4)"
+  task :patch do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
+  desc "Push the latest version and tags"
+  task :push do |t|
+    system("git push origin master")
+    system("git push origin $(git tag | tail -1)")
+  end
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb', 'TESTING.rdoc']
+  end
+rescue LoadError
+end
+
+GEM_ROOT     = File.dirname(__FILE__).freeze
+VERSION_FILE = File.join(GEM_ROOT, 'lib', 'hoptoad_notifier', 'version')
+
+require VERSION_FILE
+
+gemspec = Gem::Specification.new do |s|
+  s.name        = %q{hoptoad_notifier}
+  s.version     = HoptoadNotifier::VERSION
+  s.summary     = %q{Send your application errors to our hosted service and reclaim your inbox.}
+
+  s.files        = FileList['[A-Z]*', 'generators/**/*.*', 'lib/**/*.rb',
+                            'test/**/*.rb', 'rails/**/*.rb', 'script/*',
+                            'lib/templates/*.erb']
+  s.require_path = 'lib'
+  s.test_files   = Dir[*['test/**/*_test.rb']]
+
+  s.add_runtime_dependency("builder")
+  s.add_runtime_dependency("activesupport")
+  s.add_development_dependency("activerecord")
+  s.add_development_dependency("actionpack")
+  s.add_development_dependency("bourne")
+  s.add_development_dependency("nokogiri")
+  s.add_development_dependency("shoulda")
+
+  s.authors = ["thoughtbot, inc"]
+  s.email   = %q{support@hoptoadapp.com}
+  s.homepage = "http://www.hoptoadapp.com"
+
+  s.platform = Gem::Platform::RUBY
+end
+
+Rake::GemPackageTask.new gemspec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{gemspec.name}.gemspec", 'w') do |f|
+    f.write gemspec.to_ruby
+  end
+end
+
+LOCAL_GEM_ROOT = File.join(GEM_ROOT, 'tmp', 'local_gems').freeze
+RAILS_VERSIONS = IO.read('SUPPORTED_RAILS_VERSIONS').strip.split("\n")
+LOCAL_GEMS = [['sham_rack', nil], ['capistrano', nil], ['sqlite3-ruby', nil], ['sinatra', nil]] +
+  RAILS_VERSIONS.collect { |version| ['rails', version] }
+
+task :vendor_test_gems do
+  old_gem_path = ENV['GEM_PATH']
+  old_gem_home = ENV['GEM_HOME']
+  ENV['GEM_PATH'] = LOCAL_GEM_ROOT
+  ENV['GEM_HOME'] = LOCAL_GEM_ROOT
+  LOCAL_GEMS.each do |gem_name, version|
+    gem_file_pattern = [gem_name, version || '*'].compact.join('-')
+    version_option = version ? "-v #{version}" : ''
+    pattern = File.join(LOCAL_GEM_ROOT, 'gems', "#{gem_file_pattern}")
+    existing = Dir.glob(pattern).first
+    unless existing
+      command = "gem install -i #{LOCAL_GEM_ROOT} --no-ri --no-rdoc --backtrace #{version_option} #{gem_name}"
+      puts "Vendoring #{gem_file_pattern}..."
+      unless system("#{command} 2>&1")
+        puts "Command failed: #{command}"
+        exit(1)
+      end
+    end
+  end
+  ENV['GEM_PATH'] = old_gem_path
+  ENV['GEM_HOME'] = old_gem_home
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end
+
+task :cucumber => [:gemspec, :vendor_test_gems]
+
+def run_rails_cucumbr_task(version, additional_cucumber_args)
+  puts "Testing Rails #{version}"
+  if version.empty?
+    raise "No Rails version specified - make sure ENV['RAILS_VERSION'] is set, e.g. with `rake cucumber:rails:all`"
+  end
+  ENV['RAILS_VERSION'] = version
+  system("cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} #{additional_cucumber_args} features/rails.feature features/rails_with_js_notifier.feature")
+end
+
+def define_rails_cucumber_tasks(additional_cucumber_args = '')
+  namespace :rails do
+    RAILS_VERSIONS.each do |version|
+      desc "Test integration of the gem with Rails #{version}"
+      task version => [:gemspec, :vendor_test_gems] do
+        exit 1 unless run_rails_cucumbr_task(version, additional_cucumber_args)
+      end
+    end
+
+    desc "Test integration of the gem with all Rails versions"
+    task :all do
+      results = RAILS_VERSIONS.map do |version|
+        run_rails_cucumbr_task(version, additional_cucumber_args)
+      end
+
+      exit 1 unless results.all?
+    end
+  end
+end
+
+namespace :cucumber do
+  namespace :wip do
+    define_rails_cucumber_tasks('--tags @wip')
+  end
+
+  define_rails_cucumber_tasks
+end
+

data/SUPPORTED_RAILS_VERSIONS

@@ -0,0 +1,10 @@
+2.3.2
+2.3.4
+2.3.5
+2.3.8
+2.3.9
+2.3.10
+3.0.0
+3.0.1
+3.0.2
+3.0.3

data/TESTING.rdoc

@@ -0,0 +1,8 @@
+= For Maintainers:
+
+When developing the Hoptoad Notifier, be sure to use the integration test
+against an existing project on staging before pushing to master.
+
++./script/integration_test.rb <test project's api key> <staging server hostname>+
+
++./script/integration_test.rb <test project's api key> <staging server hostname> secure+

data/generators/hoptoad/hoptoad_generator.rb

@@ -0,0 +1,88 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
+
+class HoptoadGenerator < Rails::Generator::Base
+  def add_options!(opt)
+    opt.on('-k', '--api-key=key', String, "Your Hoptoad API key")                                 {|v| options[:api_key] = v}
+    opt.on('-h', '--heroku',              "Use the Heroku addon to provide your Hoptoad API key") {|v| options[:heroku]  = v}
+  end
+
+  def manifest
+    if !api_key_configured? && !options[:api_key] && !options[:heroku]
+      puts "Must pass --api-key or --heroku or create config/initializers/hoptoad.rb"
+      exit
+    end
+    if plugin_is_present?
+      puts "You must first remove the hoptoad_notifier plugin. Please run: script/plugin remove hoptoad_notifier"
+      exit
+    end
+    record do |m|
+      m.directory 'lib/tasks'
+      m.file 'hoptoad_notifier_tasks.rake', 'lib/tasks/hoptoad_notifier_tasks.rake'
+      if ['config/deploy.rb', 'Capfile'].all? { |file| File.exists?(file) }
+        m.append_to 'config/deploy.rb', capistrano_hook
+      end
+      if api_key_expression
+        if use_initializer?
+          m.template 'initializer.rb', 'config/initializers/hoptoad.rb',
+            :assigns => {:api_key => api_key_expression}
+        else
+          m.template 'initializer.rb', 'config/hoptoad.rb',
+            :assigns => {:api_key => api_key_expression}
+          m.append_to 'config/environment.rb', "require 'config/hoptoad'"
+        end
+      end
+      determine_api_key if heroku?
+      m.rake "hoptoad:test --trace", :generate_only => true
+    end
+  end
+
+  def api_key_expression
+    s = if options[:api_key]
+      "'#{options[:api_key]}'"
+    elsif options[:heroku]
+      "ENV['HOPTOAD_API_KEY']"
+    end
+  end
+
+  def determine_api_key
+    puts "Attempting to determine your API Key from Heroku..."
+    ENV['HOPTOAD_API_KEY'] = heroku_api_key
+    if ENV['HOPTOAD_API_KEY'].blank?
+      puts "... Failed."
+      puts "WARNING: We were unable to detect the Hoptoad API Key from your Heroku environment."
+      puts "Your Heroku application environment may not be configured correctly."
+      exit 1
+    else
+      puts "... Done."
+      puts "Heroku's Hoptoad API Key is '#{ENV['HOPTOAD_API_KEY']}'"
+    end
+  end
+
+  def heroku_api_key
+    `heroku console 'puts ENV[%{HOPTOAD_API_KEY}]'`.split("\n").first
+  end
+
+  def heroku?
+    options[:heroku] ||
+      system("grep HOPTOAD_API_KEY config/initializers/hoptoad.rb") ||
+      system("grep HOPTOAD_API_KEY config/environment.rb")
+  end
+
+  def use_initializer?
+    Rails::VERSION::MAJOR > 1
+  end
+
+  def api_key_configured?
+    File.exists?('config/initializers/hoptoad.rb') ||
+      system("grep HoptoadNotifier config/environment.rb")
+  end
+
+  def capistrano_hook
+    IO.read(source_path('capistrano_hook.rb'))
+  end
+
+  def plugin_is_present?
+    File.exists?('vendor/plugins/hoptoad_notifier')
+  end
+end

data/generators/hoptoad/lib/insert_commands.rb

@@ -0,0 +1,34 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+  def append_to(file, line)
+    logger.insert "#{line} appended to #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      File.open(file, "a") do |file|
+        file.puts
+        file.puts line
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def append_to(file, line)
+    logger.remove "#{line} removed from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n#{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def append_to(file, line)
+    logger.insert "#{line} appended to #{file}"
+  end
+end