zenbox 0.0.3 → 0.0.4

data/INSTALL

@@ -1,15 +1,15 @@
 === Configuration
 
-You should have something like this in config/initializers/contextify.rb.
+You should have something like this in config/initializers/zenbox.rb.
 
-  Contextify.configure do |config|
+  Zenbox.configure do |config|
     config.api_key = '1234567890abcdef'
   end
 
 
-You can test that Contextify is working in your production environment by using
+You can test that Zenbox is working in your production environment by using
 this rake task (from RAILS_ROOT):
 
-  rake contextify:test
+  rake zenbox:test
 
-If everything is configured properly, that task will send sample data to Contextify.
+If everything is configured properly, that task will send sample data to Zenbox.

data/README.md

@@ -1,68 +1,68 @@
-Contextify
+Zenbox
 ========
 
-This is the notifier gem for integrating apps with [Contextify](http://contextify.io).
+This is the notifier gem for integrating apps with [Zenbox](http://zenbox.io).
 
-When an uncaught exception occurs, Contextify will POST the relevant data
-to the Contextify server specified in your environment.
+When an uncaught exception occurs, Zenbox will POST the relevant data
+to the Zenbox server specified in your environment.
 
 Help
 ----
 
-For help with using Contextify and this notifier visit [our support site](http://help.contextify.io).
+For help with using Zenbox and this notifier visit [our support site](http://help.zenbox.io).
 
-For discussion of Contextify development check out the [mailing list](http://groups.google.com/group/hoptoad-notifier-dev).
+For discussion of Zenbox development check out the [mailing list](http://groups.google.com/group/hoptoad-notifier-dev).
 
-For SSL verification see the [Resources](https://github.com/contextify/contextify/blob/master/resources/README.md).
+For SSL verification see the [Resources](https://github.com/zenbox/zenbox/blob/master/resources/README.md).
 
 Rails Installation
 ------------------
 
 ### Rails 3.x
 
-Add the contextify gem to your Gemfile.  In Gemfile:
+Add the zenbox gem to your Gemfile.  In Gemfile:
 
-    gem "contextify"
+    gem "zenbox"
 
 Then from your project's RAILS_ROOT, and in your development environment, run:
 
     bundle install
-    rails generate contextify --api-key your_key_here
+    rails generate zenbox --api-key your_key_here
 
 That's it!
 
-The generator creates a file under `config/initializers/contextify.rb` configuring Contextify with your API key. This file should be checked into your version control system so that it is deployed to your staging and production environments.
+The generator creates a file under `config/initializers/zenbox.rb` configuring Zenbox with your API key. This file should be checked into your version control system so that it is deployed to your staging and production environments.
 
 ### Rails 2.x
 
-Add the contextify gem to your app. In config/environment.rb:
+Add the zenbox gem to your app. In config/environment.rb:
 
-    config.gem 'contextify'
+    config.gem 'zenbox'
     
 or if you are using bundler:
 
-    gem 'contextify', :require => 'contextify/rails'
+    gem 'zenbox', :require => 'zenbox/rails'
 
 Then from your project's RAILS_ROOT, and in your development environment, run:
 
     rake gems:install
-    rake gems:unpack GEM=contextify
-    script/generate contextify --api-key your_key_here
+    rake gems:unpack GEM=zenbox
+    script/generate zenbox --api-key your_key_here
 
-As always, if you choose not to vendor the contextify gem, make sure
+As always, if you choose not to vendor the zenbox gem, make sure
 every server you deploy to has the gem installed or your application won't start.
 
-The generator creates a file under `config/initializers/contextify.rb` configuring Contextify with your API key. This file should be checked into your version control system so that it is deployed to your staging and production environments.
+The generator creates a file under `config/initializers/zenbox.rb` configuring Zenbox with your API key. This file should be checked into your version control system so that it is deployed to your staging and production environments.
 
-### Upgrading From Earlier Versions of Contextify
+### Upgrading From Earlier Versions of Zenbox
 
 If you're currently using the plugin version (if you have a
 vendor/plugins/hoptoad_notifier directory, you are), you'll need to perform a
 few extra steps when upgrading to the gem version.
 
-Add the contextify gem to your app. In config/environment.rb:
+Add the zenbox gem to your app. In config/environment.rb:
 
-    config.gem 'contextify'
+    config.gem 'zenbox'
 
 Remove the plugin:
 
@@ -73,26 +73,26 @@ Make sure the following line DOES NOT appear in your ApplicationController file:
     include HoptoadNotifier::Catcher
 
 If it does, remove it.  The new catcher is automatically included by the gem
-version of Contextify.
+version of Zenbox.
 
-Before running the contextify generator, you need to find your project's API key.
-Log in to your account at contextify.io, and click on the "Projects" button.
+Before running the zenbox generator, you need to find your project's API key.
+Log in to your account at zenbox.io, and click on the "Projects" button.
 Then, find your project in the list, and click on its name. In the left-hand
 column, you'll see an "Edit this project" button. Click on that to get your
 project's API key. If you accidentally use your personal API api_key,
 you will get API key not found errors, and exceptions will not be stored
-by the Contextify service.
+by the Zenbox service.
 
 Then from your project's RAILS_ROOT, run:
 
     rake gems:install
-    script/generate contextify --api-key your_key_here
+    script/generate zenbox --api-key your_key_here
 
-Once installed, you should vendor the contextify gem.
+Once installed, you should vendor the zenbox gem.
 
-    rake gems:unpack GEM=contextify
+    rake gems:unpack GEM=zenbox
 
-As always, if you choose not to vendor the contextify gem, make sure
+As always, if you choose not to vendor the zenbox gem, make sure
 every server you deploy to has the gem installed or your application won't
 start.
 
@@ -115,12 +115,12 @@ framework).
 
 
 
-You can test that Contextify is working in your production environment by using
+You can test that Zenbox is working in your production environment by using
 this rake task (from RAILS_ROOT):
 
-    rake contextify:test
+    rake zenbox:test
 
-If everything is configured properly, that task will send a notice to Contextify
+If everything is configured properly, that task will send a notice to Zenbox
 which will be visible immediately.
 
 ### Removing hoptoad_notifier
@@ -143,24 +143,24 @@ Non-rails apps using Bundler
 ----------------------------
 There is an undocumented dependency in `activesupport` where the `i18n` gem is
 required only if the core classes extensions are used (`active_support/core_ext`). 
-This can lead to a confusing `LoadError` exception when using Contextify. Until 
+This can lead to a confusing `LoadError` exception when using Zenbox. Until 
 this is fixed in `activesupport` the workaround is to add `i18n` to the Gemfile 
 for your Sinatra/Rack/pure ruby application:
 
     gem 'i18n'
-    gem 'contextify'
+    gem 'zenbox'
 
 Rack
 ----
 
-In order to use contextify in a non-Rails rack app, just load
-contextify, configure your API key, and use the Contextify::Rack
+In order to use zenbox in a non-Rails rack app, just load
+zenbox, configure your API key, and use the Zenbox::Rack
 middleware:
 
     require 'rack'
-    require 'contextify'
+    require 'zenbox'
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       config.api_key = 'my_api_key'
     end
 
@@ -168,22 +168,22 @@ middleware:
       run lambda { |env| raise "Rack down" }
     end
     
-    use Contextify::Rack
+    use Zenbox::Rack
     run app
 
 Sinatra
 -------
 
-Using contextify in a Sinatra app is just like a Rack app:
+Using zenbox in a Sinatra app is just like a Rack app:
 
     require 'sinatra'
-    require 'contextify'
+    require 'zenbox'
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       config.api_key = 'my API key'
     end
 
-    use Contextify::Rack
+    use Zenbox::Rack
 
     get '/' do
       raise "Sinatra has left the building"
@@ -192,7 +192,7 @@ Using contextify in a Sinatra app is just like a Rack app:
 Usage
 -----
 
-For the most part, Contextify works for itself. 
+For the most part, Zenbox works for itself. 
 
 It intercepts the exception middleware calls, sends notifications and continues the middleware call chain.
 
@@ -201,68 +201,68 @@ controller, you can do something like this:
 
     ...
     rescue => ex
-      notify_contextify(ex)
+      notify_zenbox(ex)
       flash[:failure] = 'Encryptions could not be rerouted, try again.'
     end
     ...
 
-The `#notify_contextify` call will send the notice over to Contextify for later
-analysis. While in your controllers you use the `notify_contextify` method, anywhere
-else in your code, use `Contextify.notify`.
+The `#notify_zenbox` call will send the notice over to Zenbox for later
+analysis. While in your controllers you use the `notify_zenbox` method, anywhere
+else in your code, use `Zenbox.notify`.
 
-To perform custom error processing after Contextify has been notified, define the
-instance method `#rescue_action_in_public_without_contextify(exception)` in your
+To perform custom error processing after Zenbox has been notified, define the
+instance method `#rescue_action_in_public_without_zenbox(exception)` in your
 controller.
 
 Informing the User
 ------------------
 
-The contextify gem is capable of telling the user information about the error that just happened
+The zenbox gem is capable of telling the user information about the error that just happened
 via the user_information option. They can give this error number in bug reports, for example.
 By default, if your 500.html contains the text
 
     <!-- AIRBRAKE ERROR -->
 
-then that comment will be replaced with the text "Contextify Error [errnum]". You can modify the text
-of the informer by setting `config.user_information`. Contextify will replace "{{ error_id }}" with the
-ID of the error that is returned from Contextify.
+then that comment will be replaced with the text "Zenbox Error [errnum]". You can modify the text
+of the informer by setting `config.user_information`. Zenbox will replace "{{ error_id }}" with the
+ID of the error that is returned from Zenbox.
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
     ...
       config.user_information = "<p>Tell the devs that it was <strong>{{ error_id }}</strong>'s fault.</p>"
     end
 
 You can also turn the middleware that handles this completely off by setting `config.user_information` to false.
 
-Note that this feature is reading the error id from `env['contextify.error_id']`. When the exception is caught
-automatically in a controller, Contextify sets that value. If you're, however, calling the Contextify methods like
-`Contextify#notify` or `Contextify#notify_or_ignore`, please make sure you set that value. So the proper way of calling the 
-"manual" methods would be `env['contextify.error_id'] = Contextify.notify_or_ignore(...)`.
+Note that this feature is reading the error id from `env['zenbox.error_id']`. When the exception is caught
+automatically in a controller, Zenbox sets that value. If you're, however, calling the Zenbox methods like
+`Zenbox#notify` or `Zenbox#notify_or_ignore`, please make sure you set that value. So the proper way of calling the 
+"manual" methods would be `env['zenbox.error_id'] = Zenbox.notify_or_ignore(...)`.
 
-Tracking deployments in Contextify
+Tracking deployments in Zenbox
 --------------------------------
 
-Paying Contextify plans support the ability to track deployments of your application in Contextify.
-By notifying Contextify of your application deployments, all errors are resolved when a deploy occurs,
+Paying Zenbox plans support the ability to track deployments of your application in Zenbox.
+By notifying Zenbox of your application deployments, all errors are resolved when a deploy occurs,
 so that you'll be notified again about any errors that reoccur after a deployment.
 
-Additionally, it's possible to review the errors in Contextify that occurred before and after a deploy.
+Additionally, it's possible to review the errors in Zenbox that occurred before and after a deploy.
 
-When Contextify is installed as a gem, you need to add
+When Zenbox is installed as a gem, you need to add
 
-    require 'contextify/capistrano'
+    require 'zenbox/capistrano'
 
 to your deploy.rb
 
 If you don't use Capistrano, then you can use the following rake task from your
-deployment process to notify Contextify:
+deployment process to notify Zenbox:
 
-    rake contextify:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}
+    rake zenbox:deploy TO=#{rails_env} REVISION=#{current_revision} REPO=#{repository} USER=#{local_user}
 
 Going beyond exceptions
 -----------------------
 
-You can also pass a hash to `Contextify.notify` method and store whatever you want,
+You can also pass a hash to `Zenbox.notify` method and store whatever you want,
 not just an exception. And you can also use it anywhere, not just in
 controllers:
 
@@ -272,25 +272,25 @@ controllers:
       }
       my_unpredicable_method(params)
     rescue => e
-      Contextify.notify(
+      Zenbox.notify(
         :error_class   => "Special Error",
         :error_message => "Special Error: #{e.message}",
         :parameters    => params
       )
     end
 
-While in your controllers you use the `notify_contextify` method, anywhere else in
-your code, use `Contextify.notify`. Contextify will get all the information
+While in your controllers you use the `notify_zenbox` method, anywhere else in
+your code, use `Zenbox.notify`. Zenbox will get all the information
 about the error itself. As for a hash, these are the keys you should pass:
 
-* `:error_class` - Use this to group similar errors together. When Contextify catches an exception it sends the class name of that exception object.
+* `:error_class` - Use this to group similar errors together. When Zenbox catches an exception it sends the class name of that exception object.
 * `:error_message` - This is the title of the error you see in the errors list. For exceptions it is "#{exception.class.name}: #{exception.message}"
-* `:parameters` - While there are several ways to send additional data to Contextify, passing a Hash as :parameters as in the example above is the most common use case. When Contextify catches an exception in a controller, the actual HTTP client request parameters are sent using this key.
+* `:parameters` - While there are several ways to send additional data to Zenbox, passing a Hash as :parameters as in the example above is the most common use case. When Zenbox catches an exception in a controller, the actual HTTP client request parameters are sent using this key.
 
-Contextify merges the hash you pass with these default options:
+Zenbox merges the hash you pass with these default options:
 
     {
-      :api_key       => Contextify.api_key,
+      :api_key       => Zenbox.api_key,
       :error_message => 'Notification',
       :backtrace     => caller,
       :parameters    => {},
@@ -305,20 +305,20 @@ One common request we see is to send shell environment variables along with
 manual exception notification.  We recommend sending them along with CGI data
 or Rack environment (:cgi_data or :rack_env keys, respectively.)
 
-See Contextify::Notice#initialize in lib/contextify/notice.rb for
+See Zenbox::Notice#initialize in lib/zenbox/notice.rb for
 more details.
 
 Filtering
 ---------
 
-You can specify a whitelist of errors that Contextify will not report on. Use
+You can specify a whitelist of errors that Zenbox will not report on. Use
 this feature when you are so apathetic to certain errors that you don't want
 them even logged.
 
 This filter will only be applied to automatic notifications, not manual
 notifications (when #notify is called directly).
 
-Contextify ignores the following exceptions by default:
+Zenbox ignores the following exceptions by default:
 
     ActiveRecord::RecordNotFound
     ActionController::RoutingError
@@ -329,17 +329,17 @@ Contextify ignores the following exceptions by default:
     Mongoid::Errors::DocumentNotFound
 
 
-To ignore errors in addition to those, specify their names in your Contextify
+To ignore errors in addition to those, specify their names in your Zenbox
 configuration block.
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       config.api_key      = '1234567890abcdef'
       config.ignore       << "ActiveRecord::IgnoreThisError"
     end
 
 To ignore *only* certain errors (and override the defaults), use the #ignore_only attribute.
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       config.api_key      = '1234567890abcdef'
       config.ignore_only  = ["ActiveRecord::IgnoreThisError"] # or [] to ignore no exceptions.
     end
@@ -347,7 +347,7 @@ To ignore *only* certain errors (and override the defaults), use the #ignore_onl
 To ignore certain user agents, add in the #ignore_user_agent attribute as a
 string or regexp:
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       config.api_key      = '1234567890abcdef'
       config.ignore_user_agent  << /Ignored/
       config.ignore_user_agent << 'IgnoredUserAgent'
@@ -355,32 +355,32 @@ string or regexp:
 
 To ignore exceptions based on other conditions, use #ignore_by_filter:
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       config.api_key      = '1234567890abcdef'
       config.ignore_by_filter do |exception_data|
         true if exception_data[:error_class] == "RuntimeError"
       end
     end
 
-To replace sensitive information sent to the Contextify service with [FILTERED] use #params_filters:
+To replace sensitive information sent to the Zenbox service with [FILTERED] use #params_filters:
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       config.api_key      = '1234567890abcdef'
       config.params_filters << "credit_card_number"
     end
 
 Note that, when rescuing exceptions within an ActionController method,
-contextify will reuse filters specified by #filter_parameter_logging.
+zenbox will reuse filters specified by #filter_parameter_logging.
 
 Testing
 -------
 
-When you run your tests, you might notice that the Contextify service is recording
+When you run your tests, you might notice that the Zenbox service is recording
 notices generated using #notify when you don't expect it to. You can
 use code like this in your test_helper.rb or spec_helper.rb files to redefine
 that method so those errors are not reported while running tests.
 
-    module Contextify
+    module Zenbox
       def self.notify(exception, opts = {})
         # do nothing.
       end
@@ -389,9 +389,9 @@ that method so those errors are not reported while running tests.
 Proxy Support
 -------------
 
-The notifier supports using a proxy, if your server is not able to directly reach the Contextify servers. To configure the proxy settings, added the following information to your Contextify configuration block.
+The notifier supports using a proxy, if your server is not able to directly reach the Zenbox servers. To configure the proxy settings, added the following information to your Zenbox configuration block.
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       config.proxy_host = proxy.host.com
       config.proxy_port = 4038
       config.proxy_user = foo # optional
@@ -403,7 +403,7 @@ Supported Rails versions
 See SUPPORTED_RAILS_VERSIONS for a list of official supported versions of
 Rails.
 
-Please open up a support ticket ( http://help.contextify.io ) or submit a new github issue
+Please open up a support ticket ( http://help.zenbox.io ) or submit a new github issue
 if you're using a version of Rails that is listed above and the notifier is
 not working properly.
 
@@ -412,7 +412,7 @@ Javascript Notifer
 
 To automatically include the Javascript node on every page, use this helper method from your layouts:
 
-    <%= contextify_javascript_notifier %>
+    <%= zenbox_javascript_notifier %>
 
 It's important to insert this very high in the markup, above all other javascript.  Example:
 
@@ -420,7 +420,7 @@ It's important to insert this very high in the markup, above all other javascrip
     <html>
       <head>
         <meta charset="utf8">
-        <%= contextify_javascript_notifier %>
+        <%= zenbox_javascript_notifier %>
         <!-- more javascript -->
       </head>
       <body>
@@ -431,14 +431,14 @@ It's important to insert this very high in the markup, above all other javascrip
 This helper will automatically use the API key, host, and port specified in the configuration.
 
 The Javascript notifier tends to send much more notifications than the base Rails project.
-If you want to receive them into a separate Contextify project, specify its
+If you want to receive them into a separate Zenbox project, specify its
 API key in the `js_api_key` option.
 
     config.js_api_key = 'another-projects-api-key'
 
 To test the Javascript notifier in development environment, overwrite (temporarily) the development_environments option:
 
-    Contextify.configure do |config|
+    Zenbox.configure do |config|
       # ...
       config.development_environments = []
     end
@@ -453,13 +453,13 @@ Credits
 
 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
 
-Contextify is maintained and funded by [contextify.io](http://contextify.io)
+Zenbox is maintained and funded by [zenbox.io](http://zenbox.io)
 
-Thank you to all [the contributors](https://github.com/contextify/contextify/contributors)!
+Thank you to all [the contributors](https://github.com/zenbox/zenbox/contributors)!
 
-The names and logos for Contextify, thoughtbot are trademarks of their respective holders.
+The names and logos for Zenbox, thoughtbot are trademarks of their respective holders.
 
 License
 -------
 
-Contextify is Copyright © 2008-2012 Contextify. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Zenbox is Copyright © 2008-2012 Zenbox. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.