projectlocker_pulse 0.2.1

data/Rakefile

@@ -0,0 +1,223 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubygems/package_task'
+begin
+  require 'cucumber/rake/task'
+rescue LoadError
+  $stderr.puts "Please install cucumber: `gem install cucumber`"
+  exit 1
+end
+require './lib/pulse/version'
+
+FEATURES = ["sinatra","rack","metal","user_informer"]
+
+desc 'Default: run unit tests.'
+task :default => [:test, "cucumber:rails:all"] + FEATURES
+
+desc "Clean out the tmp directory"
+task :clean do
+  exec "rm -rf tmp"
+end
+
+desc 'Test the projectlocker-pulse gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+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 Pulse::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", "pulse", "version.rb"), "w") do |f|
+      f.write <<EOF
+module Pulse
+  VERSION = "#{version}".freeze
+end
+EOF
+    end
+  end
+
+  desc "Writes out the new CHANGELOG and prepares the release"
+  task :change do
+    load 'lib/pulse/version.rb'
+    file    = "CHANGELOG"
+    old     = File.read(file)
+    version = Pulse::VERSION
+    message = "Bumping to version #{version}"
+    editor = ENV["EDITOR"] || "vim" # prefer vim if no env variable for editor is set
+
+    File.open(file, "w") do |f|
+      f.write <<EOF
+Version #{version} - #{Time.now}
+===============================================================================
+
+#{`git log $(git tag | grep -v rc | tail -1)..HEAD | git shortlog`}
+#{old}
+EOF
+    end
+
+    exec ["#{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 | grep -v rc | 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
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+
+LOCAL_GEM_ROOT = File.join(GEM_ROOT, 'tmp', 'local_gems').freeze
+RAILS_VERSIONS = IO.read('SUPPORTED_RAILS_VERSIONS').strip.split("\n")
+LOCAL_GEMS =
+  [
+    ["rack","1.3.2"],
+  ] +
+  RAILS_VERSIONS.collect { |version| ['rails', version] } +
+  [
+    ['sham_rack', nil],
+    ['capistrano', nil],
+    ['sqlite3-ruby', nil],
+    ["therubyracer",nil],
+    ["sinatra",nil]
+  ]
+
+
+desc "Vendor test gems: Run this once to prepare your test environment"
+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
+    if existing
+      puts "\nskipping #{gem_name} since it's already vendored," +
+      "remove it from the tmp directory first."
+      next
+    end
+
+    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
+
+  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 => [:vendor_test_gems]
+
+
+def run_rails_cucumber_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
+  cmd   = "cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} #{additional_cucumber_args} features/rails.feature features/rails_with_js_notifier.feature"
+  puts "Running command: #{cmd}"
+  system(cmd)
+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 => [:vendor_test_gems] do
+        exit 1 unless run_rails_cucumber_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_cucumber_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
+
+  rule /#{"(" + FEATURES.join("|") + ")"}/ do |t|
+    framework = t.name
+    desc "Test integration of the gem with #{framework}"
+    task framework.to_sym do
+      puts "Testing #{framework.split(":").last}..."
+      cmd = "cucumber --format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features/#{framework.split(":").last}.feature"
+      puts "Running command: #{cmd}"
+      system(cmd)
+    end
+  end
+
+end

data/SUPPORTED_RAILS_VERSIONS

@@ -0,0 +1,38 @@
+2.3.14
+3.0.0
+3.0.1
+3.0.2
+3.0.3
+3.0.4
+3.0.5
+3.0.6
+3.0.7
+3.0.8
+3.0.9
+3.0.10
+3.0.11
+3.0.12
+3.0.13
+3.0.14
+3.0.15
+3.0.16
+3.0.17
+3.1.0
+3.1.1
+3.1.2
+3.1.3
+3.1.4
+3.1.5
+3.1.6
+3.1.7
+3.1.8
+3.1.4
+3.2.0
+3.2.1
+3.2.2
+3.2.3
+3.2.4
+3.2.5
+3.2.6
+3.2.7
+3.2.8

data/TESTING.md

@@ -0,0 +1,41 @@
+Running the suite
+=================
+
+Since the notifier must run on many versions of Rails, running its test suite is slightly different than you may be used to.
+
+You should start by trusting the .rvmrc file. We come in peace.
+
+Then execute the following command:
+
+    rake vendor_test_gems
+    # NOT: bundle exec rake vendor_test_gems
+
+This command will download the various versions of Rails and other gems that the notifier must be tested against.
+
+Then, to start the suite, run
+
+    rake
+    # NOT: bundle exec rake
+
+Finally, this test suite runs against many rails versions. If you
+prefer to run it against specific version hit
+
+    rake cucumber:rails:<VERSION>
+
+You can also specify to test only against the certain frameworks we
+support (rack, rake and sinatra) by executing
+
+    rake cucumber:<FRAMEWORK>
+
+This tasks are not printed out with `rake -T` since they're added
+dynamically in the Rakefile.
+
+
+For Maintainers
+================
+
+When developing the Pulse gem, 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/features/metal.feature

@@ -0,0 +1,18 @@
+Feature: Rescue errors in Rails middleware
+
+  Background:
+    Given I have built and installed the "projectlocker-pulse" gem
+    And I generate a new Rails application
+    And I configure the Pulse shim
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run the pulse generator with "-k myapikey"
+
+  Scenario: Rescue an exception in the dispatcher
+    When I define a Metal endpoint called "Exploder":
+      """
+      def self.call(env)
+        raise "Explode"
+      end
+      """
+    When I perform a request to "http://example.com:123/metal/index?param=value"
+    Then I should receive a Pulse notification

data/features/rack.feature

@@ -0,0 +1,60 @@
+Feature: Use the notifier in a plain Rack app
+
+  Background:
+    Given I have built and installed the "projectlocker-pulse" gem
+
+  Scenario: Rescue and exception in a Rack app
+    Given the following Rack app:
+      """
+      require 'logger'
+      require 'rack'
+      require 'projectlocker_pulse'
+
+      Pulse.configure do |config|
+        config.api_key = 'my_api_key'
+        config.logger = Logger.new STDOUT
+      end
+
+      app = Rack::Builder.app do
+        use Pulse::Rack
+        run lambda { |env| raise "Rack down" }
+      end
+      """
+    When I perform a Rack request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Pulse notification
+
+  Scenario: Ignore user agents
+    Given the following Rack app:
+      """
+      require 'logger'
+      require 'rack'
+      require 'projectlocker_pulse'
+
+      Pulse.configure do |config|
+        config.api_key = 'my_api_key'
+        config.ignore_user_agent << /ignore/
+        config.logger = Logger.new STDOUT
+      end
+
+      class Mock
+        class AppendUserAgent
+          def initialize(app)
+            @app = app
+          end
+
+          def call(env)
+            env["HTTP_USER_AGENT"] = "ignore"
+            @app.call(env)
+          end
+        end
+      end
+
+      app = Rack::Builder.app do
+        use Pulse::Rack
+        use Mock::AppendUserAgent
+        run lambda { |env| raise "Rack down" }
+      end
+      """
+    When I perform a Rack request to "http://example.com:123/test/index?param=value"
+    Then I should not see "** [Pulse] Response from Pulse:"
+

data/features/rails.feature

@@ -0,0 +1,272 @@
+Feature: Install the Gem in a Rails application
+
+  Background:
+    Given I have built and installed the "projectlocker-pulse" gem
+    And I generate a new Rails application
+
+  Scenario: Use the gem without vendoring the gem in a Rails application
+    When I configure the Pulse shim
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run the pulse generator with "-k myapikey"
+    Then the command should have run successfully
+    And I should receive a Pulse notification
+    And I should see the Rails version
+
+  Scenario: vendor the gem and uninstall
+    When I configure the Pulse shim
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I unpack the "projectlocker-pulse" gem
+    And I run the pulse generator with "-k myapikey"
+    Then the command should have run successfully
+    When I uninstall the "projectlocker-pulse" gem
+    And I install cached gems
+    And I run "rake pulse:test"
+    Then I should see "** [Pulse] Response from Pulse:"
+    And I should receive two Pulse notifications
+
+  Scenario: Configure the notifier by hand
+    When I configure the Pulse shim
+    And I configure the notifier to use "myapikey" as an API key
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run the pulse generator with ""
+    Then I should receive a Pulse notification
+
+  Scenario: Configuration within initializer isn't overridden by Railtie
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    Then the command should have run successfully
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key = "myapikey"
+      config.project_root = "argle/bargle"
+      """
+    And I define a response for "TestController#index":
+      """
+      session[:value] = "test"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Pulse notification
+
+  Scenario: Try to install without an api key
+    When I configure my application to require the "projectlocker-pulse" gem
+    And I run the projectlocker-pulse generator with ""
+    Then I should see "Must pass --api-key or --heroku or create config/initializers/pulse.rb"
+
+  Scenario: Configure and deploy using only installed gem
+    When I run "capify ."
+    And I configure the Pulse shim
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run the pulse generator with "-k myapikey"
+    And I configure my application to require the "capistrano" gem if necessary
+    And I run "cap -T"
+    Then I should see "pulse:deploy"
+
+  Scenario: Configure and deploy using only vendored gem
+    When I run "capify ."
+    And I configure the Pulse shim
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I unpack the "projectlocker-pulse" gem
+    And I run the pulse generator with "-k myapikey"
+    And I uninstall the "projectlocker-pulse" gem
+    And I install cached gems
+    And I configure my application to require the "capistrano" gem if necessary
+    And I run "cap -T"
+    Then I should see "pulse:deploy"
+
+  Scenario: Try to install when the pulse plugin still exists
+    When I install the "pulse" plugin
+    And I configure the Pulse shim
+    And I configure the notifier to use "myapikey" as an API key
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run the pulse generator with ""
+    Then I should see "You must first remove the pulse plugin. Please run: script/plugin remove pulse"
+
+  Scenario: Rescue an exception in a controller
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    And I define a response for "TestController#index":
+      """
+      session[:value] = "test"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Pulse notification
+    Then I should see "test"
+
+  Scenario: The gem should not be considered a framework gem
+    When I configure the Pulse shim
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run the pulse generator with "-k myapikey"
+    And I run "rake gems"
+    Then I should see that "projectlocker-pulse" is not considered a framework gem
+
+  Scenario: The app uses Vlad instead of Capistrano
+    When I configure the Pulse shim
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run "touch config/deploy.rb"
+    And I run "rm Capfile"
+    And I run the pulse generator with "-k myapikey"
+    Then "config/deploy.rb" should not contain "capistrano"
+
+  Scenario: Support the Heroku addon in the generator
+    When I configure the Pulse shim
+    And I configure the Heroku rake shim
+    And I configure the Heroku gem shim with "myapikey"
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run the pulse generator with "--heroku"
+    Then the command should have run successfully
+    And I should receive a Pulse notification
+    And I should see the Rails version
+    And my Pulse configuration should contain the following line:
+      """
+      config.api_key = ENV['PULSE_API_KEY']
+      """
+
+  Scenario: Support the --app option for the Heroku addon in the generator
+    When I configure the Pulse shim
+    And I configure the Heroku rake shim
+    And I configure the Heroku gem shim with "myapikey" and multiple app support
+    And I configure my application to require the "projectlocker-pulse" gem
+    And I run the pulse generator with "--heroku -a myapp"
+    Then the command should have run successfully
+    And I should receive a Pulse notification
+    And I should see the Rails version
+    And my Pulse configuration should contain the following line:
+      """
+      config.api_key = ENV['PULSE_API_KEY']
+      """
+
+  Scenario: Filtering parameters in a controller
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key = "myapikey"
+      config.params_filters << "credit_card_number"
+      """
+    And I define a response for "TestController#index":
+      """
+      params[:credit_card_number] = "red23"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Pulse notification
+    Then I should not see "red23"
+    And I should see "FILTERED"
+
+  Scenario: Filtering session in a controller
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key = "myapikey"
+      config.params_filters << "secret"
+      """
+    And I define a response for "TestController#index":
+      """
+      session["secret"] = "blue42"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Pulse notification
+    Then I should not see "blue42"
+    And I should see "FILTERED"
+
+  Scenario: Filtering session and params based on Rails parameter filters
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    And I configure the application to filter parameter "secret"
+    And I define a response for "TestController#index":
+      """
+      params["secret"] = "red23"
+      session["secret"] = "blue42"
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Pulse notification
+    And I should not see "red23"
+    And I should not see "blue42"
+    And I should see "FILTERED"
+
+  Scenario: Notify projectlocker-pulse within the controller
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    And I define a response for "TestController#index":
+      """
+      session[:value] = "test"
+      notify_projectlocker_pulse(RuntimeError.new("some message"))
+      render :nothing => true
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should receive a Pulse notification
+    And I should see "test"
+
+  Scenario: Reporting 404s should be disabled by default
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    And I perform a request to "http://example.com:123/this/route/does/not/exist"
+    Then I should see "The page you were looking for doesn't exist."
+    And I should not receive a Pulse notification
+
+  Scenario: Reporting 404s should work when configured properly
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.ignore_only = []
+      """
+    And I perform a request to "http://example.com:123/this/route/does/not/exist"
+    Then I should see "The page you were looking for doesn't exist."
+    And I should receive a Pulse notification
+
+  Scenario: reporting over SSL with utf8 check should work
+    Given PENDING I fix this one
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.secure = true
+      """
+    And I define a response for "TestController#index":
+      """
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?utf8=✓"
+    Then I should receive a Pulse notification
+
+  Scenario: It should also send the user details
+    When I configure the Pulse shim
+    And I configure usage of Pulse
+    And I define a response for "TestController#index":
+      """
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I have set up authentication system in my app that uses "current_user"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should receive a Pulse notification
+    And the Pulse notification should contain user details
+    When I have set up authentication system in my app that uses "current_member"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should receive a Pulse notification
+    And the Pulse notification should contain user details
+
+  Scenario: It should log the notice when failure happens
+    When Pulse server is not responding
+    And I configure usage of Pulse
+    And I define a response for "TestController#index":
+      """
+      raise RuntimeError, "some message"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index?param=value"
+    Then I should see "Notice details:"
+    And I should see "some message"