squash_rails 1.0.0

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,106 @@
+Squash Client Library: Ruby on Rails
+====================================
+
+This client library reports exceptions to Squash, the Squarish exception
+reporting and management system. It's compatible with both pure-Ruby and Ruby on
+Rails projects.
+
+Documentation
+-------------
+
+Comprehensive documentation is written in YARD- and Markdown-formatted comments
+throughout the source. To view this documentation as an HTML site, run
+`rake doc`.
+
+For an overview of the various components of Squash, see the website
+documentation at https://github.com/SquareSquash/web.
+
+Compatibility
+-------------
+
+This library is compatible with Ruby 1.8.6 and later, including Ruby Enterprise
+Edition, and with Rails 2.0 and later.
+
+Requirements
+------------
+
+The only dependency is the `squash_ruby` gem and its dependencies. For more
+information, consult the `squash_ruby` gem documentation:
+https://github.com/SquareSquash/ruby
+
+Usage
+-----
+
+See the `squash_ruby` gem for installation and configuration instructions. Note
+that it is no longer necessary to set the `:environment` configuration option;
+the Rails client library automatically sets that to the Rails environment.
+
+You can use the usual `Squash::Ruby.notify` method in your Rails projects, but
+you will miss out on some Rails-specific information in your exception logs. You
+can automatically have the Squash client send along request and Rails
+information by using the client's `around_filter`:
+
+```` ruby
+class ApplicationController < ActionController::Base
+  include Squash::Ruby::ControllerMethods
+  enable_squash_client
+end
+````
+
+Now any exception raised in the course of processing a request will be annotated
+with Rails specific information. The exception is then re-raised for normal
+Rails exception handling.
+
+There may be situations where other parts of the code "eat up" an exception
+before it reaches this filter; the most common example would be exceptions that
+are handled by a `rescue_from` statement elsewhere in your controller.  You can
+use the {Squash::Ruby::ControllerMethods#notify_squash} method to still send
+these exceptions to Squash:
+
+```` ruby
+class ApplicationController < ActionController::Base
+  include Squash::Ruby::ControllerMethods
+  rescue_from(ActiveRecord::RecordInvalid) do |error|
+    notify_squash error
+    render :file => "public/422.html", :status => :unprocessable_entity
+  end
+end
+````
+
+**Important note:** Some versions of Rails (below 3.0) do not automatically run
+the `rails/init.rb` within the gem. You will need to call
+`require 'squash/rails/configure'` in a `config/initializers` file in order to
+apply the Rails configuration defaults. You'll also need to add
+`load 'squash/rails/tasks.rake'` to your Rakefile.
+
+There are many additional features you can take advantage of; see **Additional
+Features** in the `squash_ruby` documentation.
+
+#### Filtering Sensitive Information
+
+By default, `notify_squash` uses the filtered parameter list generated according
+to your `config.filter_parameters` setting. If you need to further filter your
+request parameters, or if you are storing sensitive information in your session,
+headers, or other fields transmitted to Squash, override the
+{Squash::Ruby::ControllerMethods#filter_for_squash} method in your controller.
+
+Deploys
+-------
+
+Squash works best when you notify it if your web app's deploys. If you're using
+Capistrano, this is easy: Just add `require 'squash/rails/capistrano'` to your
+`config/deploy.rb` file. Everything else should be taken care of.
+
+If you're not using Capistrano, you will need to configure your deploy script
+so that it runs the `squash:notify` Rake task on every deploy target. This Rake
+task requires two environment variables to be set: `REVISION` (the current
+revision of the source code) and `DEPLOY_ENV` (the environment this server is
+hosting).
+
+Additional Configuration Options
+--------------------------------
+
+The Squash Rails gem adds the following configuration options:
+
+* `deploy_path`: The path to post new deploys to. By default it's set to
+  `/api/1.0/deploy`.

data/lib/squash/rails.rb

@@ -0,0 +1,49 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'squash/ruby'
+if defined?(Rails)
+  require 'squash/ruby/controller_methods'
+  require 'squash/ruby/railtie'
+  Squash::Ruby::TOP_LEVEL_USER_DATA.concat %w( environment root xhr headers
+                                               request_method schema host port
+                                               path query controller action
+                                               params session flash cookies )
+end
+
+module Squash::Ruby
+  CONFIGURATION_DEFAULTS[:deploy_path] = "/api/1.0/deploy"
+
+  private
+
+  def self.client_name() 'rails' end
+
+  # Unwrap ActiveRecord::StatementInvalid, since it's "special"
+  def self.exception_info_hash_with_rails(exception, *other_args)
+    hsh = exception_info_hash_without_rails(exception, *other_args)
+
+    if defined?(ActiveRecord::StatementInvalid) && exception.kind_of?(ActiveRecord::StatementInvalid)
+      if hsh['message'] =~ /^([A-Za-z0-9:_]+?): /
+        hsh['message'].sub! /^([A-Za-z0-9:_]+?): /, ''
+        hsh['class_name'] = $1
+      end
+    end
+
+    hsh
+  end
+
+  class << self
+    alias_method_chain :exception_info_hash, :rails
+  end
+end

data/lib/squash/rails/capistrano.rb

@@ -0,0 +1,24 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# Capistrano tasks for Rails apps using Squash.
+
+desc "Notifies Squash of a new deploy."
+task 'squash:notify', :roles => :web, :only => {:primary => true}, :except => {:no_release => true} do
+  rails_env = fetch(:rails_env, 'production')
+  run "bundle exec rake squash:notify REVISION=#{real_revision} DEPLOY_ENV=#{rails_env}"
+end
+
+after 'deploy:restart', 'squash:notify'
+after 'deploy:start', 'squash:notify'

data/lib/squash/rails/configure.rb

@@ -0,0 +1,20 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# Apply Rails 2.x configuration defaults.
+
+Squash::Ruby.configure :environment     => RAILS_ENV,
+                       :project_root    => RAILS_ROOT,
+                       :repository_root => RAILS_ROOT,
+                       :failsafe_log    => File.join(RAILS_ROOT, 'log', 'squash.failsafe.log')

data/lib/squash/rails/tasks.rake

@@ -0,0 +1,25 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# Rake tasks for Rails apps using Squash.
+
+namespace :squash do
+  desc "Notifies Squash that this server has received a new deploy."
+  task :notify => :environment do
+    require 'socket'
+    Squash::Ruby.notify_deploy ENV['DEPLOY_ENV'] || Rails.env,
+                               ENV['REVISION']   || Squash::Ruby.current_revision,
+                               ENV['HOST']       || Socket.gethostname
+  end
+end

data/lib/squash/ruby/controller_methods.rb

@@ -0,0 +1,170 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# `ActionController::Base` mixin that provides Rails-specific Squash support.
+#
+# @example
+#   class MyController < ActionController::Base
+#     include Squash::Ruby::ControllerMethods
+#     enable_squash_client
+#   end
+
+module Squash::Ruby::ControllerMethods
+  # Request headers that typically contain sensitive information. As an
+  # alternative to appending to this constant, you can also override the
+  # {#filter_for_squash} method.
+  FILTERED_HEADERS = %w(HTTP_AUTHORIZATION RAW_POST_DATA)
+
+  # @private
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  protected
+
+  # Notifies Squash of an exception. Unlike `Squash::Ruby.notify`, this method
+  # annotates the exception with Rails-specific information (see
+  # {#squash_rails_data}).
+  #
+  # @param [Object] exception The exception. Must at least duck-type an
+  #   `Exception` subclass.
+  # @param [Hash] user_data Any additional context-specific information about
+  #   the exception.
+  # @return [true, false] Whether the exception was reported to Squash. (Some
+  #   exceptions are ignored and not reported to Squash.)
+
+  def notify_squash(exception, user_data={})
+    Squash::Ruby.notify exception, user_data.merge(squash_rails_data)
+  end
+
+  # Creates an exception, notifies Squash, then swallows the exception. Unlike
+  # `Squash::Ruby.record`, this method annotates the exception with
+  # Rails-specific information (see {#squash_rails_data}).
+  #
+  # @overload record_to_squash(exception_class, message, user_data={})
+  #   Specify both the exception class and the message.
+  #   @param [Class] exception_class The exception class to raise.
+  #   @param [String] message The exception message.
+  #   @param [Hash] user_data Additional information to give to {.notify}.
+  # @overload record_to_squash(message, user_data={})
+  #   Specify only the message. The exception class will be `StandardError`.
+  #   @param [String] message The exception message.
+  #   @param [Hash] user_data Additional information to give to {.notify}.
+
+  def record_to_squash(exception_class_or_message, message_or_options=nil, data=nil)
+    if message_or_options && data
+      exception_class = exception_class_or_message
+      message         = message_or_options
+      data            ||= {}
+    elsif message_or_options.kind_of?(String)
+      message         = message_or_options
+      exception_class = exception_class_or_message
+      data            ||= {}
+    elsif message_or_options.kind_of?(Hash)
+      data            = message_or_options
+      message         = exception_class_or_message
+      exception_class = StandardError
+    elsif message_or_options.nil?
+      message         = exception_class_or_message
+      exception_class = StandardError
+      data            ||= {}
+    else
+      raise ArgumentError
+    end
+
+    Squash::Ruby.record exception_class, message, data.merge(squash_rails_data)
+  end
+
+  # @return [Hash<Symbol, Object>] The additional information that
+  #   {#notify_squash} gives to `Squash::Ruby.notify`.
+
+  def squash_rails_data
+    flash_hash = flash.to_hash.stringify_keys
+    filtered_params = request.respond_to?(:filtered_parameters) ? request.filtered_parameters : filter_parameters(params)
+
+    {
+        :environment    => Rails.env.to_s,
+        :root           => Rails.root.to_s,
+
+        :headers        => filter_for_squash(_filter_for_squash(request.headers.to_hash, :headers), :headers),
+        :request_method => request.request_method.to_s.upcase,
+        :schema         => request.protocol.sub('://', ''),
+        :host           => request.host,
+        :port           => request.port,
+        :path           => request.path,
+        :query          => request.query_string,
+
+        :controller     => controller_name,
+        :action         => action_name,
+        :params         => filter_for_squash(filtered_params, :params),
+        :session        => filter_for_squash(session.to_hash, :session),
+        :flash          => filter_for_squash(flash_hash, :flash),
+        :cookies        => filter_for_squash(cookies.instance_variable_get(:@cookies) || {}, :cookies)
+    }
+  end
+
+  # @abstract
+  #
+  # Override this method to implement filtering of sensitive data in the
+  # `params`, `session`, `flash`, and `cookies` hashes before they are
+  # transmitted to Squash. The `params` hash is already filtered according to
+  # the project's `filter_parameters` configuration option; if you need any
+  # additional filtering, override this method.
+  #
+  # @param [Hash] data The hash of user data to be filtered.
+  # @param [Symbol] kind Either `:params`, `:session`, `:flash`, `:cookies`, or
+  #   `:headers`.
+  # @return [Hash] A copy of `data` with sensitive data removed or replaced.
+
+  def filter_for_squash(data, kind)
+    data
+  end
+
+  private
+
+  def _squash_around_filter
+    begin
+      yield
+    rescue Object => err
+      handler_err = err.respond_to?(:original_exception) ? err.original_exception : err
+      notify_squash(err) unless handler_for_rescue(handler_err)
+      raise
+    end
+  end
+
+  module ClassMethods
+    protected
+
+    # Prepends an `around_filter` that catches any exceptions and notifies
+    # Squash. Exceptions are then re-raised.
+    #
+    # @param [Hash] options Additional options to pass to
+    #   `prepend_around_filter`, such as `:only` or `:except`.
+
+    def enable_squash_client(options={})
+      prepend_around_filter :_squash_around_filter, options
+    end
+  end
+
+  private
+
+  def _filter_for_squash(data, kind)
+    case kind
+      when :headers
+        data.reject { |key, _| key !~ /^[A-Z0-9_]+$/  || FILTERED_HEADERS.include?(key) }
+      else
+        data
+    end
+  end
+end

data/lib/squash/ruby/railtie.rb

@@ -0,0 +1,28 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# Automatically configures the Squash environment to be equal to the Rails
+# environment. This code is executed for Rails 3.0 and newer; for older Rails
+# versions, see `rails/init.rb`.
+
+class Squash::Ruby::Railtie < Rails::Railtie
+  initializer "squash_client.configure_rails_initialization" do
+    Squash::Ruby.configure :environment     => Rails.env.to_s,
+                           :project_root    => Rails.root.to_s,
+                           :repository_root => Rails.root.to_s,
+                           :failsafe_log    => Rails.root.join('log', 'squash.failsafe.log').to_s
+  end
+
+  rake_tasks { load 'squash/rails/tasks.rake' }
+end if defined?(Rails::Railtie)

data/rails/init.rb

@@ -0,0 +1,17 @@
+# Copyright 2012 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+# See `lib/squash/ruby/railtie.rb` for the Rails 3.0 initialization code.
+
+require 'squash/rails/configure' if RAILS_VERSION < '3.0.0'

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: squash_rails
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: squash_ruby
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rails
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rspec
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: yard
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: redcarpet
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: jeweler
+  version_requirements: *id006
+description: This client library records Ruby on Rails exceptions to Squash.
+email: tim@squareup.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- LICENSE.txt
+- README.md
+- lib/squash/rails.rb
+- lib/squash/rails/capistrano.rb
+- lib/squash/rails/configure.rb
+- lib/squash/rails/tasks.rake
+- lib/squash/ruby/controller_methods.rb
+- lib/squash/ruby/railtie.rb
+- rails/init.rb
+homepage: http://github.com/SquareSquash/rails
+licenses: 
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Squash client for Ruby on Rails projects
+test_files: []
+