squash_ruby 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,15 @@
---- 
-SHA1: 
-  data.tar.gz: 9195ad43d6d71778ced73b5e07ae5917ad22537d
-  metadata.gz: 69b5051d8f134aed6849bdc79fe7c0bbad75825d
-SHA512: 
-  data.tar.gz: d04d3988aae11bafc93b42c695fa7d6ad6368af21ed4439cb7cfead5ff1ef23f809e635b0e56b9c7e3308f7a83bd4fb2a4effd610d38f3cc9417eabbd3f5ddf0
-  metadata.gz: 968d1cdab38243ece16bf0ae2f35ff077403b2655256ceb9428e0446b21a4d69828bd7a869ddaf0f346ee6c4d0de71410520679165c97270b772479c4771c52d
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGRjNTdhNGQxYzI0YzYwNTFhMGRlMmRjOWIxN2FlMTViMjRlOWFkNw==
+  data.tar.gz: !binary |-
+    YzMwOTczZmM3ZWRlZDA0OWI1OTAyZWZkZDBmM2I4OGRlMzljYTI2Zg==
+SHA512:
+  metadata.gz: !binary |-
+    MWQwNjkxZDBiMzdhZWJjYzU3Nzk3NjQ2N2VlNGFlYWNmMjllNGZiZGVjMWFk
+    NTdmNmIyMTQ3Mzg5OTdjNTFiMjAyYmM4ZDk4NmE5MTZmMGYxZDg5OTZjYTgz
+    ZjRmMjEyMjE4ZmZlMTgxMWViYTRhNzQ2YjgzMjFjOTNkM2QyZGU=
+  data.tar.gz: !binary |-
+    ZDgyZWE0OGYyZWU3OGY3YTFiYjhjNzQyMDE4MmJjOWJlNTQ3YjViNzlmM2Iy
+    M2ViNmFiMTc4M2NhZjllYWY4MWU4MzZjZWQ2ZWI4NTFkYmJlZjhmMTllNGUx
+    YWExMzUyM2JhNWRmYTY2ZjY0MGZhOTYzNmE0MTBiMGI3NWQ5Zjk=

data/README.md

@@ -19,8 +19,7 @@ documentation at https://github.com/SquareSquash/web.
 Compatibility
 -------------
 
-This library is compatible with Ruby 1.8.6 and later, including Ruby Enterprise
-Edition.
+This library is compatible with Ruby 1.9.2 and later, including JRuby.
 
 Requirements
 ------------
@@ -38,9 +37,9 @@ Add the Squash client to your Gemfile with
 project you are recording exceptions for:
 
 ```` ruby
-Squash::Ruby.configure :api_key => 'YOUR_API_KEY',
-                       :api_host => 'https://your.squash.host',
-                       :environment => 'production'
+Squash::Ruby.configure api_key: 'YOUR_API_KEY',
+                       api_host: 'https://your.squash.host',
+                       environment: 'production'
 ````
 
 To use Squash to manage your exceptions, place a `begin::rescue` statement at
@@ -86,7 +85,7 @@ You can also add user data using the {Squash::Ruby.add_user_data} method:
 
 ```` ruby
 input = gets
-Squash::Ruby.add_user_data(:input => input) do
+Squash::Ruby.add_user_data(input: input) do
   process_input # may raise an exception
 end
 ````
@@ -98,7 +97,7 @@ data directly in the exception constructor:
 require 'squash/ruby/exception_additions'
 
 def process_value(value)
-  raise ArgumentError.new("value must be a number", :value => value) unless value.kind_of?(Fixnum)
+  raise ArgumentError.new("value must be a number", value: value) unless value.kind_of?(Fixnum)
   # [...]
 end
 ````
@@ -112,7 +111,7 @@ require 'squash/ruby/exception_additions'
 begin
   do_something_with_input(input)
 rescue ArgumentError => err
-  err.user_data :input => input
+  err.user_data input: input
   raise # assumed that Squash::Ruby.notify is called somewhere further up in the stack
 end
 ````
@@ -156,6 +155,11 @@ keys:
   stripped from backtrace lines. By default it's set to the working directory.
 * `mirrored_repository`: Set this option to be true if your repository root is a
   mirrored Git repository.
+* `exception_behavior_when_disabled`: Set this option to customize Squash's
+  behavior when an exception is raised in an environment where Squash is
+  disabled (typically development and test). Values are `ignore` (default):
+  exception is ignored; `raise`: exception is raised; and `log`: exception is
+  logged at the error level to the failsafe log.
 
 ### Revision Information
 
@@ -182,6 +186,10 @@ options override `repository_root`.
 * `max_variable_size`: The maximum size (in bytes) of a serialized
   representation of a value that will be transmitted over the network. Values
   that serialize to larger than this size will be replaced with a placeholder.
+* `timeout_protection`: a `proc { |timeout, &block| ... }` that runs the given
+  block, and times out after `timeout` seconds.  By default this will use
+  `SystemTimer` if present, or else the built in `Timeout` class, but can be
+  overridden to provide more fine grain logic around timeouts.
 
 ### Ignored Exceptions
 
@@ -197,7 +205,7 @@ options override `repository_root`.
   client libraries (e.g., Squash Rails client); an example:
 
 ```` ruby
-Squash::Ruby.configure :ignored_exception_procs => lambda do |exception, user_data|
+Squash::Ruby.configure ignored_exception_procs: lambda do |exception, user_data|
   exception.kind_of?(ActiveRecord::RecordNotFound) && user_data[:headers]['X-Testing'].blank?
 end
 ````

data/lib/squash/ruby.rb

@@ -31,16 +31,19 @@ module Squash
     EXCEPTION_RESERVED_IVARS = %W( mesg bt )
     # Default values for different configuration variables.
     CONFIGURATION_DEFAULTS   = {
-        :notify_path                => "/api/1.0/notify",
-        :deploy_path                => "/api/1.0/deploy",
-        :open_timeout               => 15,
-        :transmit_timeout           => 15,
-        :ignored_exception_classes  => [],
-        :ignored_exception_messages => {},
-        :ignored_exception_procs    => [],
-        :failsafe_log               => "squash.failsafe.log",
-        :repository_root            => Dir.getwd,
-        :project_root               => Dir.getwd
+        notify_path:                "/api/1.0/notify",
+        deploy_path:                "/api/1.0/deploy",
+        open_timeout:               15,
+        transmit_timeout:           15,
+        ignored_exception_classes:  [],
+        ignored_exception_messages: {},
+        ignored_exception_procs:    [],
+        failsafe_log:               "squash.failsafe.log",
+        repository_root:            Dir.getwd,
+        project_root:               Dir.getwd,
+        timeout_protection:         proc { |timeout, &block|
+                                         timeout_protection(timeout, &block)
+                                       },
     }
     # Types that are serialized directly to JSON, rather than to a hash of
     # object information. Subclasses are not considered members of this array.
@@ -51,7 +54,9 @@ module Squash
     # constant to include Rails-specific fields, for example.
     TOP_LEVEL_USER_DATA      = []
 
-    # Notifies Squash of an exception.
+    # Notifies Squash of an exception. The behavior of this method when Squash
+    # is disabled is dependent on the `exception_behavior_when_disabled`
+    # configuration option.
     #
     # @param [Object] exception The exception. Must at least duck-type an
     #   `Exception` subclass.
@@ -63,7 +68,18 @@ module Squash
     #   {.configure}).
 
     def self.notify(exception, user_data={})
-      unless configuration(:disabled)
+      if configuration(:disabled)
+        case configuration(:exception_behavior_when_disabled)
+          when 'log', :log
+            failsafe_log '[Squash::Ruby.notify]', "Exception raised: #{exception.to_s}\n" +
+                                                    exception.backtrace.map { |l| "  #{l}" }.join("\n")
+          when 'raise', :raise
+            raise exception
+          else
+            # ignore
+        end
+        return false
+      else
         raise "The :api_key configuration is required" unless configuration(:api_key)
         raise "The :api_host configuration is required" unless configuration(:api_host)
         raise "The :environment configuration is required" unless configuration(:environment)
@@ -179,6 +195,10 @@ module Squash
     #   Squash. This allows you to ensure that a non-critical block of code
     #   does not halt your application while still receiving exception
     #   notifications in Squash.
+    #
+    #   The behavior of this method when Squash is disabled is dependent on the
+    #   `exception_behavior_when_disabled` configuration option.
+    #
     #   @param [Array<Class>] exception_classes A list of exception classes to
     #     report silently. Exceptions _not_ of these classes (or their
     #     subclasses) will raise (and presumably be handled by Squash elsewhere
@@ -323,7 +343,8 @@ module Squash
 
       http_options(uri).each { |k, v| http.send :"#{k}=", v }
 
-      block = proc do
+      timeout = configuration(:open_timeout) + configuration(:transmit_timeout)
+      configuration(:timeout_protection).call(timeout) do
         http.start do |http|
           request = Net::HTTP::Post.new(uri.request_uri)
           request.add_field 'Content-Type', 'application/json'
@@ -338,12 +359,6 @@ module Squash
           end
         end
       end
-
-      if defined?(SystemTimer)
-        SystemTimer.timeout_after((configuration(:open_timeout) + configuration(:transmit_timeout)), &block)
-      else
-        Timeout.timeout((configuration(:open_timeout) + configuration(:transmit_timeout)), &block)
-      end
     end
 
     # Notifies Squash of a new deploy. Squash will then determine which bug
@@ -400,9 +415,9 @@ module Squash
     private
 
     def self.http_options(uri)
-      options = {:use_ssl      => uri.scheme == 'https',
-                 :open_timeout => configuration(:transmit_timeout),
-                 :read_timeout => configuration(:transmit_timeout)}
+      options = {use_ssl:      uri.scheme == 'https',
+                 open_timeout: configuration(:transmit_timeout),
+                 read_timeout: configuration(:transmit_timeout)}
       options[:verify_mode] = OpenSSL::SSL::VERIFY_NONE if configuration(:skip_ssl_verification)
       options
     end
@@ -721,5 +736,15 @@ module Squash
 
     # @private
     def self.client_name() 'ruby' end
+
+    # @private
+    def self.timeout_protection(timeout, &block)
+      if defined?(SystemTimer)
+        SystemTimer.timeout_after(timeout, &block)
+      else
+        Timeout.timeout(timeout, &block)
+      end
+    end
+
   end
 end

data/lib/squash/ruby/exception_additions.rb

@@ -16,7 +16,7 @@
 # to an exception at the time of the raise.
 #
 # @example
-#   raise ArgumentError.new("value must be a number", :value => value) unless value.kind_of?(Fixnum)
+#   raise ArgumentError.new("value must be a number", value: value) unless value.kind_of?(Fixnum)
 
 class Exception
 

metadata

@@ -1,106 +1,135 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: squash_ruby
-version: !ruby/object:Gem::Version 
-  version: 1.4.0
+version: !ruby/object:Gem::Version
+  version: !binary |-
+    Mi4wLjA=
 platform: ruby
-authors: 
+authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-01-09 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id002 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  version_requirements: *id001
-  prerelease: false
-  type: :runtime
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
-  version_requirements: *id003
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
-  version_requirements: *id004
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: fakefs
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
-  version_requirements: *id005
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: yard
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - <
-      - !ruby/object:Gem::Version 
-        version: "3.0"
-  version_requirements: *id006
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: redcarpet
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
-  version_requirements: *id007
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This client library records Ruby exceptions to Squash.
 email: tim@squareup.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
+files:
 - LICENSE.txt
 - README.md
 - lib/squash/ruby.rb
 - lib/squash/ruby/exception_additions.rb
 - lib/squash_ruby.rb
 homepage: http://github.com/SquareSquash/ruby
-licenses: 
+licenses:
 - Apache 2.0
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Squash client for Ruby projects
 test_files: []
-