RubyGems - projectlocker_errata - Versions diffs - 0.0.1 - Mend

projectlocker_errata 0.0.1

Files changed (82) hide show

data/CHANGELOG +908 -0
data/Gemfile +3 -0
data/Guardfile +6 -0
data/INSTALL +20 -0
data/MIT-LICENSE +23 -0
data/README.md +460 -0
data/README_FOR_HEROKU_ADDON.md +94 -0
data/Rakefile +223 -0
data/SUPPORTED_RAILS_VERSIONS +38 -0
data/TESTING.md +41 -0
data/features/metal.feature +18 -0
data/features/rack.feature +60 -0
data/features/rails.feature +272 -0
data/features/rails_with_js_notifier.feature +97 -0
data/features/rake.feature +27 -0
data/features/sinatra.feature +29 -0
data/features/step_definitions/file_steps.rb +10 -0
data/features/step_definitions/metal_steps.rb +23 -0
data/features/step_definitions/rack_steps.rb +23 -0
data/features/step_definitions/rails_application_steps.rb +478 -0
data/features/step_definitions/rake_steps.rb +17 -0
data/features/support/env.rb +18 -0
data/features/support/matchers.rb +35 -0
data/features/support/projectlocker_errata_shim.rb.template +16 -0
data/features/support/rails.rb +201 -0
data/features/support/rake/Rakefile +68 -0
data/features/support/terminal.rb +107 -0
data/features/user_informer.feature +63 -0
data/generators/projectlocker_errata/lib/insert_commands.rb +34 -0
data/generators/projectlocker_errata/lib/rake_commands.rb +24 -0
data/generators/projectlocker_errata/projectlocker_errata_generator.rb +94 -0
data/generators/projectlocker_errata/templates/capistrano_hook.rb +6 -0
data/generators/projectlocker_errata/templates/initializer.rb +6 -0
data/generators/projectlocker_errata/templates/projectlocker_errata_tasks.rake +25 -0
data/install.rb +1 -0
data/lib/projectlocker_errata/backtrace.rb +108 -0
data/lib/projectlocker_errata/capistrano.rb +43 -0
data/lib/projectlocker_errata/configuration.rb +305 -0
data/lib/projectlocker_errata/notice.rb +390 -0
data/lib/projectlocker_errata/rack.rb +54 -0
data/lib/projectlocker_errata/rails/action_controller_catcher.rb +30 -0
data/lib/projectlocker_errata/rails/controller_methods.rb +85 -0
data/lib/projectlocker_errata/rails/error_lookup.rb +33 -0
data/lib/projectlocker_errata/rails/javascript_notifier.rb +47 -0
data/lib/projectlocker_errata/rails/middleware/exceptions_catcher.rb +33 -0
data/lib/projectlocker_errata/rails.rb +40 -0
data/lib/projectlocker_errata/rails3_tasks.rb +98 -0
data/lib/projectlocker_errata/railtie.rb +48 -0
data/lib/projectlocker_errata/rake_handler.rb +65 -0
data/lib/projectlocker_errata/sender.rb +128 -0
data/lib/projectlocker_errata/shared_tasks.rb +47 -0
data/lib/projectlocker_errata/tasks.rb +83 -0
data/lib/projectlocker_errata/user_informer.rb +27 -0
data/lib/projectlocker_errata/utils/blank.rb +53 -0
data/lib/projectlocker_errata/version.rb +3 -0
data/lib/projectlocker_errata.rb +159 -0
data/lib/projectlocker_errata_tasks.rb +64 -0
data/lib/rails/generators/projectlocker_errata/projectlocker_errata_generator.rb +100 -0
data/lib/templates/javascript_notifier.erb +15 -0
data/lib/templates/rescue.erb +91 -0
data/projectlocker_errata.gemspec +39 -0
data/rails/init.rb +1 -0
data/resources/README.md +34 -0
data/resources/ca-bundle.crt +3376 -0
data/script/integration_test.rb +38 -0
data/test/airbrake_2_3.xsd +88 -0
data/test/backtrace_test.rb +162 -0
data/test/capistrano_test.rb +34 -0
data/test/catcher_test.rb +333 -0
data/test/configuration_test.rb +236 -0
data/test/helper.rb +263 -0
data/test/javascript_notifier_test.rb +51 -0
data/test/logger_test.rb +79 -0
data/test/notice_test.rb +490 -0
data/test/notifier_test.rb +276 -0
data/test/projectlocker_errata_tasks_test.rb +170 -0
data/test/rack_test.rb +58 -0
data/test/rails_initializer_test.rb +36 -0
data/test/recursion_test.rb +10 -0
data/test/sender_test.rb +288 -0
data/test/user_informer_test.rb +29 -0
metadata +440 -0

data/features/rails_with_js_notifier.feature ADDED Viewed

@@ -0,0 +1,97 @@
+Feature: Install the Gem in a Rails application and enable the JavaScript notifier
+  Background:
+    Given I have built and installed the "projectlocker_errata" gem
+  Scenario: Include the Javascript notifier when enabled
+    When I generate a new Rails application
+    And I configure the ProjectlockerErrata shim
+    And I configure my application to require the "projectlocker_errata" gem
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key     = "myapikey"
+      """
+    And I define a response for "TestController#index":
+      """
+        render :inline => '<html><head profile="http://example.com"><%= projectlocker_errata_javascript_notifier %></head><body></body></html>'
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should see the notifier JavaScript for the following:
+      | api_key  | environment | host           |
+      | myapikey | production  | api.projectlocker_errata.io |
+    And the notifier JavaScript should provide the following errorDefaults:
+      | url                           | component | action |
+      | http://example.com:123/test/index | test      | index  |
+  Scenario: Include the Javascript notifier when enabled using custom configuration settings
+    When I generate a new Rails application
+    And I configure the ProjectlockerErrata shim
+    And I configure my application to require the "projectlocker_errata" gem
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key     = "myapikey!"
+      config.host        = "myprojectlocker_errata.com"
+      config.port        = 3001
+      """
+    And I define a response for "TestController#index":
+      """
+        render :inline => '<html><head><%= projectlocker_errata_javascript_notifier %></head><body></body></html>'
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should see the notifier JavaScript for the following:
+      | api_key   | environment | host               |
+      | myapikey! | production  | myprojectlocker_errata.com:3001 |
+  Scenario: Don't include the Javascript notifier by default
+    When I generate a new Rails application
+    And I configure the ProjectlockerErrata shim
+    And I configure my application to require the "projectlocker_errata" gem
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key = "myapikey!"
+      """
+    And I define a response for "TestController#index":
+      """
+        render :inline => "<html><head></head><body></body></html>"
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should not see notifier JavaScript
+  Scenario: Don't include the Javascript notifier when enabled in non-public environments
+    When I generate a new Rails application
+    And I configure the ProjectlockerErrata shim
+    And I configure my application to require the "projectlocker_errata" gem
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key          = "myapikey!"
+      config.environment_name = 'test'
+      """
+    And I define a response for "TestController#index":
+      """
+        render :inline => '<html><head><%= projectlocker_errata_javascript_notifier %></head><body></body></html>'
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index" in the "test" environment
+    Then I should not see notifier JavaScript
+  Scenario: Include the Javascript notifier with a custom api key
+    When I generate a new Rails application
+    And I configure the ProjectlockerErrata shim
+    And I configure my application to require the "projectlocker_errata" gem
+    When I configure the notifier to use the following configuration lines:
+      """
+      config.api_key     = "myapikey!"
+      config.js_api_key     = "myjsapikey!"
+      """
+    And I define a response for "TestController#index":
+      """
+        render :inline => '<html><head><%= projectlocker_errata_javascript_notifier %></head><body></body></html>'
+      """
+    And I route "/test/index" to "test#index"
+    And I perform a request to "http://example.com:123/test/index"
+    Then I should see the notifier JavaScript for the following:
+      | api_key     | environment | host        |
+      | myjsapikey! | production  | api.projectlocker_errata.io |

data/features/rake.feature ADDED Viewed

@@ -0,0 +1,27 @@
+Feature: Use the Gem to catch errors in a Rake application
+  Background:
+    Given I have built and installed the "projectlocker_errata" gem
+  Scenario: Catching exceptions in Rake
+    When I run rake with projectlocker_errata
+    Then ProjectlockerErrata should catch the exception
+  Scenario: Falling back to default handler before ProjectlockerErrata is configured
+    When I run rake with projectlocker_errata not yet configured
+    Then ProjectlockerErrata should not catch the exception
+  Scenario: Disabling Rake exception catcher
+    When I run rake with projectlocker_errata disabled
+    Then ProjectlockerErrata should not catch the exception
+  Scenario: Autodetect, running from terminal
+    When I run rake with projectlocker_errata autodetect from terminal
+    Then ProjectlockerErrata should not catch the exception
+  Scenario: Autodetect, not running from terminal
+    When I run rake with projectlocker_errata autodetect not from terminal
+    Then ProjectlockerErrata should catch the exception
+  Scenario: Sending the correct component name
+    When I run rake with projectlocker_errata
+    Then ProjectlockerErrata should send the rake command line as the component name

data/features/sinatra.feature ADDED Viewed

@@ -0,0 +1,29 @@
+Feature: Use the notifier in a Sinatra app
+  Background:
+    Given I have built and installed the "projectlocker_errata" gem
+  Scenario: Rescue an exception in a Sinatra app
+    Given the following Rack app:
+      """
+      require 'sinatra/base'
+      require 'projectlocker_errata'
+      ProjectlockerErrata.configure do |config|
+        config.api_key = 'my_api_key'
+      end
+      class FontaneApp < Sinatra::Base
+        use ProjectlockerErrata::Rack
+        enable :raise_errors
+        get "/test/index" do
+          raise "Sinatra has left the building"
+        end
+      end
+      app = FontaneApp
+      """
+    When I perform a Rack request to "http://example.com:123/test/index?param=value"
+    Then I should receive a ProjectlockerErrata notification

data/features/step_definitions/file_steps.rb ADDED Viewed

@@ -0,0 +1,10 @@
+Then /^"([^\"]*)" should not contain text of "([^\"]*)"$/ do |target_file, contents_file|
+  notifier_root      = File.join(File.dirname(__FILE__), '..', '..')
+  full_path_contents = File.join(notifier_root, contents_file)
+  contents_text      = File.open(full_path_contents).read
+  full_path_target = File.join(rails_root, target_file)
+  target_text      = File.open(full_path_target).read
+  target_text.should_not include(contents_text)
+end

data/features/step_definitions/metal_steps.rb ADDED Viewed

@@ -0,0 +1,23 @@
+When /^I define a Metal endpoint called "([^\"]*)":$/ do |class_name, definition|
+  FileUtils.mkdir_p(File.join(rails_root, 'app', 'metal'))
+  file_name = File.join(rails_root, 'app', 'metal', "#{class_name.underscore}.rb")
+  File.open(file_name, "w") do |file|
+    file.puts "class #{class_name}"
+    file.puts definition
+    file.puts "end"
+  end
+  When %{the metal endpoint "#{class_name}" is mounted in the Rails 3 routes.rb} if rails3?
+end
+When /^the metal endpoint "([^\"]*)" is mounted in the Rails 3 routes.rb$/ do |class_name|
+  routesrb = File.join(rails_root, "config", "routes.rb")
+  routes = IO.readlines(routesrb)
+  rack_route = "match '/metal(/*other)' => #{class_name}"
+  routes = routes[0..-2] + [rack_route, routes[-1]]
+  File.open(routesrb, "w") do |f|
+    f.puts "require 'app/metal/#{class_name.underscore}'"
+    routes.each do |route_line|
+      f.puts route_line
+    end
+  end
+end

data/features/step_definitions/rack_steps.rb ADDED Viewed

@@ -0,0 +1,23 @@
+Given /^the following Rack app:$/ do |definition|
+  File.open(RACK_FILE, 'w') { |file| file.write(definition) }
+end
+When /^I perform a Rack request to "([^\"]*)"$/ do |url|
+  shim_file = File.join(PROJECT_ROOT, 'features', 'support', 'airbrake_shim.rb.template')
+  request_file = File.join(TEMP_DIR, 'rack_request.rb')
+  File.open(request_file, 'w') do |file|
+    file.puts "require 'rubygems'"
+    file.puts IO.read(shim_file)
+    file.puts IO.read(RACK_FILE)
+    file.puts "env = Rack::MockRequest.env_for(#{url.inspect})"
+    file.puts "status, headers, body = app.call(env)"
+    file.puts %{puts "HTTP \#{status}"}
+    file.puts %{headers.each { |key, value| puts "\#{key}: \#{value}"}}
+    file.puts "body.each { |part| print part }"
+  end
+  @terminal.run("ruby #{request_file}")
+end
+Then /^I should receive a Airbrake notification for rack$/ do
+  Then %{I should see "You have accessed a deleted account."}
+end