squash_ruby 1.2.0 → 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87f4cbb3b66773b1ed436e622e14dde686c9ba6c
+  data.tar.gz: e779e8860e2449dd71239ce600b158b94320e5aa
+SHA512:
+  metadata.gz: 9d627d981014d0126e070170a407ce42af3cbd225f19ad14df3c56d4b3868568a67f5f087135cf7ae4ea20646e005635d623a529d957e4656bd6b49f1104f31e
+  data.tar.gz: 0fd69893426c96de1ac4941914b108108b9beea703cb4a1ba190b10f351b7ca83bd155037fa40a0f629720d80cc12448ff2b614c6daa3073c9bfac09540bf211

data/lib/squash/ruby/exception_additions.rb

@@ -1,4 +1,4 @@
-# Copyright 2012 Square Inc.
+# Copyright 2013 Square Inc.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.

data/lib/squash/ruby.rb

@@ -1,4 +1,4 @@
-# Copyright 2012 Square Inc.
+# Copyright 2013 Square Inc.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -63,29 +63,15 @@ module Squash
     #   {.configure}).
 
     def self.notify(exception, user_data={})
-      occurred = Time.now
-
-      return false if configuration(:disabled)
-      unless exception.respond_to?(:backtrace)
-        failsafe_log 'notify', "Tried to pass notify something other than an exception: #{exception.inspect}"
-        return false
-      end
-      unless exception.backtrace
-        failsafe_log 'notify', "Tried to pass notify an exception with no backtrace: #{exception}"
-        return false
-      end
-
       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)
 
       begin
-        exception, parents = unroll(exception)
-        return false if ignored?(exception, user_data)
-        check_user_data user_data
+        blob = self.generate_exception(exception, user_data)
+        return false if blob.nil?
 
-        hsh = exception_info_hash(exception, occurred, user_data, parents)
-        http_transmit configuration(:api_host) + configuration(:notify_path), {}, hsh.inject({}) { |h, (k, v)| h[k.to_s] = v; h }.to_json
+        self.transmit_exception(blob)
         return true
       rescue Object => nested_error
         raise if configuration(:disable_failsafe)
@@ -249,6 +235,49 @@ module Squash
 
     protected
 
+    # Generates an exception JSON blob for use with {.transmit_exception}. These
+    # methods are separated so that the JSON blobs can be generated separately
+    # from the actual transmission of exceptions, allowing each task to be
+    # optimized separately.
+    #
+    # @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 [String, nil] The JSON data to transmit to Squash.  If `nil`,
+    #   no request should be made to Squash.
+
+    def self.generate_exception(exception, user_data={})
+      occurred = Time.now
+
+      return nil if configuration(:disabled)
+      unless exception.respond_to?(:backtrace)
+        failsafe_log 'notify', "Tried to pass notify something other than an exception: #{exception.inspect}"
+        return nil
+      end
+      unless exception.backtrace
+        failsafe_log 'notify', "Tried to pass notify an exception with no backtrace: #{exception}"
+        return nil
+      end
+
+      exception, parents = unroll(exception)
+      return nil if ignored?(exception, user_data)
+      check_user_data user_data
+
+      hsh = exception_info_hash(exception, occurred, user_data, parents)
+      hsh.inject({}) { |h, (k, v)| h[k.to_s] = v; h }.to_json
+    end
+
+    # Transmits to Squash exception data generated by {.generate_exception}.
+    #
+    # @param [String] blob Exception data.
+    # @return [true, false] Whether or not the response was successful.
+    # @see .generate_exception
+
+    def self.transmit_exception(blob)
+      http_transmit configuration(:api_host) + configuration(:notify_path), {}, blob
+    end
+
     # Posts an exception or deploy notification to the API endpoint. Only POST
     # requests are supported. This method is used internally only. It is
     # documented so that, in the event you wish to use an alternative HTTP
@@ -258,6 +287,9 @@ module Squash
     # contain the given headers and body. It should not eat any exceptions
     # relating to HTTP connectivity issues.
     #
+    # There is support for the Linux idiom of configuring a proxy server by
+    # setting the environment variables `http_proxy` and `https_proxy`.
+    #
     # Your implementation should also respect the value of the
     # `transmit_timeout` configuration, which is accessible using
     # `configuration(:transmit_timeout)`.
@@ -269,11 +301,27 @@ module Squash
     # @return [true, false] Whether or not the response was successful.
 
     def self.http_transmit(url, headers, body)
-      uri  = URI.parse(url)
-      http = Net::HTTP.new(uri.host, uri.port)
+      uri = URI.parse(url)
+
+      no_proxy = if ENV['no_proxy']
+                   ENV['no_proxy'].split(',').any? { |ext| uri.host[-ext.length, ext.length] == ext }
+                 else
+                   false
+                 end
+
+      http = if uri.scheme == 'https' && ENV['https_proxy'] && !no_proxy
+               proxy = URI.parse("https://#{ENV['https_proxy']}")
+               Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).new(uri.host, uri.port)
+             elsif uri.scheme == 'http' && ENV['http_proxy'] && !no_proxy
+               proxy = URI.parse("http://#{ENV['http_proxy']}")
+               Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).new(uri.host, uri.port)
+             else
+               Net::HTTP.new(uri.host, uri.port)
+             end
+
       http_options(uri).each { |k, v| http.send :"#{k}=", v }
 
-      block = lambda do
+      block = proc do
         http.start do |http|
           request = Net::HTTP::Post.new(uri.request_uri)
           request.add_field 'Content-Type', 'application/json'
@@ -290,9 +338,9 @@ module Squash
       end
 
       if defined?(SystemTimer)
-        SystemTimer.timeout_after configuration(:open_timeout), &block
+        SystemTimer.timeout_after((configuration(:open_timeout) + configuration(:transmit_timeout)), &block)
       else
-        block.call
+        Timeout.timeout((configuration(:open_timeout) + configuration(:transmit_timeout)), &block)
       end
     end
 

metadata

@@ -1,152 +1,133 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: squash_ruby
-version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
+version: !ruby/object:Gem::Version
+  version: 1.2.1
 platform: ruby
-authors: 
+authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
-  prerelease: false
+date: 2013-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-- !ruby/object:Gem::Dependency 
-  type: :development
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id002
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: fakefs
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: yard
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id005
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: redcarpet
-- !ruby/object:Gem::Dependency 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id006
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.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
 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 
-  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"
+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: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Squash client for Ruby projects
 test_files: []
-