roqua-support 0.1.20 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e8bd876218d378c21add709e9625782de687197
-  data.tar.gz: 8edb8923293e61035707854c43f3b04b937359ac
+  metadata.gz: af4e7902bfddd72164acc8f09dce2533316c9471
+  data.tar.gz: e3028ffe08f80d936cfc97d5f6fa901dda1fc5a6
 SHA512:
-  metadata.gz: f46cd09d06f2b1d094c4de58dba69d3e0d5bf632390b6190d0f7694ee975500c0bb70f7d420fddc7d295ac68d4a0dc032e45821a26490b0580be98cd8205f0ac
-  data.tar.gz: 3f1b4ddf2053b3d7fe7d7e7e92b21f3b7f52cd141e5c0b9a8250b15803a1e1ed6f1d88ab414746b614b1e7a1c5d673795535bc7114416c27d537c1d56d80f872
+  metadata.gz: 03cb1045caf436e5340bd9625a4b2dc9f3208f41c864031c5b0110fb455933d84fd26d5ec414c47137593b2bc82077adcc8456525cf1ca7f73f3fae669391615
+  data.tar.gz: 761670d36d6e992f063209e1f946065df4d2e1a792da65074645588fcb7de727d0f630308af60a693bed12731ffedbb4918999386999675706a8e95cfa39c98e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.21
+
+* Add Errors.add_parameters(add_to: 'error_report')
+
 ## 0.1.20
 
 * Add SubsetValidator

data/Gemfile

@@ -5,7 +5,6 @@ gemspec
 
 group :test do
   gem 'guard-rspec', '~> 4.2.6'
-  gem 'fuubar',      '~> 1.3.2'
   gem 'actionpack',       '~> 4.0'
   gem 'rspec-rails'
   gem 'combustion', '~> 0.5.2'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roqua-support (0.1.19)
+    roqua-support (0.1.21)
       activesupport (>= 3.2, < 5.0)
       naught (~> 1.0)
 
@@ -40,9 +40,6 @@ GEM
     erubis (2.7.0)
     ffi (1.9.6)
     formatador (0.2.5)
-    fuubar (1.3.3)
-      rspec (>= 2.14.0, < 3.1.0)
-      ruby-progressbar (~> 1.4)
     guard (2.7.0)
       formatador (>= 0.2.4)
       listen (~> 2.7)
@@ -53,59 +50,59 @@ GEM
       guard (~> 2.1)
       rspec (>= 2.14, < 4.0)
     hitimes (1.2.2)
-    i18n (0.6.11)
-    json (1.8.1)
+    i18n (0.7.0)
+    json (1.8.3)
     listen (2.7.11)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
     lumberjack (1.0.9)
     method_source (0.8.2)
-    minitest (5.4.2)
-    naught (1.0.0)
+    minitest (5.9.0)
+    naught (1.1.0)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rack (1.5.2)
-    rack-test (0.6.2)
+    rack (1.5.5)
+    rack-test (0.6.3)
       rack (>= 1.0)
     railties (4.1.6)
       actionpack (= 4.1.6)
       activesupport (= 4.1.6)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.3.2)
+    rake (11.2.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
+      rspec-support (~> 3.4.0)
     rspec-instrumentation-matcher (0.0.4)
       activesupport
       rspec-expectations
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-rails (3.0.2)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
-    ruby-progressbar (1.6.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     slop (3.6.0)
     thor (0.19.1)
-    thread_safe (0.3.4)
+    thread_safe (0.3.5)
     timers (4.0.1)
       hitimes
     tzinfo (1.2.2)
@@ -119,10 +116,12 @@ DEPENDENCIES
   active_interaction (~> 1.0)
   bundler (~> 1.0)
   combustion (~> 0.5.2)
-  fuubar (~> 1.3.2)
   guard-rspec (~> 4.2.6)
   rake
   roqua-support!
   rspec (>= 2.12.0, < 4.0)
   rspec-instrumentation-matcher
   rspec-rails
+
+BUNDLED WITH
+   1.12.5

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :rspec, cmd: 'bundle exec rspec --format Fuubar --colour' do
+guard :rspec, cmd: 'bundle exec rspec --colour' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -48,6 +48,27 @@ require 'roqua/support/request_logger'
 Roqua::Support::RequestLogger.attach_to :action_controller
 ```
 
+### Error reporting
+
+Log and error to Roqua.logger, appsignal and/or airbrake, depending on which is configured.
+
+```ruby
+Roqua::Support::Errors.report(exception, extra: 'params')
+```
+
+Add extra info to all reports (global setting, put in initializer)
+
+```
+Roqua::Support::Errors.extra_parameters = {root_path: Rails.root.to_s}
+```
+
+When you want to add more info, but want to catch the error higher up you can call Errors.add_parameters, which will save them on the current exception instance.
+
+```
+rescue
+  raise Roqua::Support::Errors::add_parameters(more: 'params')
+```
+
 ### Responders
 
 #### option 1

data/lib/roqua-support/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module Support
-    VERSION = '0.1.20'
+    VERSION = '0.1.21'
   end
 end

data/lib/roqua/support/errors.rb

@@ -1,107 +1,107 @@
 module Roqua
   module Support
     module Errors
+      # global extra parameters to be added to all reports.
       def self.extra_parameters
         @extra_parameters || {}
       end
 
       def self.extra_parameters=(hash)
+        fail 'not a hash' unless hash.is_a? Hash
         @extra_parameters = hash
       end
 
+      # adds instance variable roqua_extra_parameters to current exception.
+      def self.add_parameters(params)
+        return unless params.is_a?(Hash) && $!
+        $!.instance_eval do
+          (@roqua_extra_parameters ||= {}).merge! params
+        end
+      end
+
       def self.report(exception, context = {})
         return if const_defined?(:Rails) and Rails.env.test?
-        parameters, controller, skip_backtrace = merge_parameters(context)
-        notification_urls = []
-        # Notify Airbrake
-        notification_urls << notify_airbrake(exception, controller, parameters)
-        # Notify AppSignal
-        notification_urls << notify_appsignal(exception, parameters)
+        context = {} unless context.is_a? Hash
+
+        parameters, controller, skip_backtrace = merge_parameters(exception, context)
+
+        notification_urls = [notify_airbrake(exception, controller, parameters),
+                             notify_appsignal(exception, parameters)]
         # Notify Roqua logging
         log_exception(exception, parameters, notification_urls.compact, skip_backtrace)
       end
 
       private
 
-      def self.merge_parameters(context)
-        begin
-          if context.is_a?(Hash)
-            controller = context.delete :controller
-            skip_backtrace = context.delete :skip_backtrace
-            if extra_parameters.is_a?(Hash)
-              parameters = extra_parameters.merge(context)
-            else
-              parameters = context
-            end
-          elsif extra_parameters.is_a?(Hash)
-            parameters = extra_parameters
-          end
-          [parameters, controller, skip_backtrace]
-        rescue Exception
-        end
+      def self.merge_parameters(exception, context = {})
+        parameters = extra_parameters.dup
+        controller = context.delete :controller
+        skip_backtrace = context.delete :skip_backtrace
+        parameters.merge! context
+        parameters.merge! extra_parameters_from_exception(exception)
+        [parameters, controller, skip_backtrace]
+      rescue Exception
+      end
+
+      def self.extra_parameters_from_exception(exception)
+        exception.instance_variable_get(:@roqua_extra_parameters) || {}
       end
 
       def self.log_exception(exception, parameters = {}, notification_urls = [], skip_backtrace = false)
-        begin
-          if Roqua.respond_to?(:logger)
-            exception_info = {class_name: exception.class.to_s,
-                              message: exception.message,
-                              parameters: parameters}
-            exception_info[:notification_urls] = notification_urls if notification_urls.present?
-            exception_info[:backtrace] = exception.backtrace unless skip_backtrace
-            puts exception_info.inspect
-            Roqua.logger.error('roqua.exception', exception_info)
-          end
-        rescue Exception
+        if Roqua.respond_to?(:logger)
+          exception_info = {class_name: exception.class.to_s,
+                            message: exception.message,
+                            parameters: parameters}
+          exception_info[:notification_urls] = notification_urls if notification_urls.present?
+          exception_info[:backtrace] = exception.backtrace unless skip_backtrace
+          puts exception_info.inspect
+          Roqua.logger.error('roqua.exception', exception_info)
         end
+      rescue Exception
       end
 
       def self.notify_airbrake(exception, controller, parameters = {})
-        begin
-          if const_defined?(:Airbrake)
-            if controller && controller.respond_to?(:airbrake_request_data)
-              request_data = controller.airbrake_request_data
-              if request_data.is_a?(Hash)
-                request_data[:parameters] ||= {}
-                if request_data[:parameters].is_a?(Hash)
-                  request_data[:parameters] = parameters.merge request_data[:parameters]
-                end
-              else
-                request_data = nil
+        if const_defined?(:Airbrake)
+          if controller && controller.respond_to?(:airbrake_request_data)
+            request_data = controller.airbrake_request_data
+            if request_data.is_a?(Hash)
+              request_data[:parameters] ||= {}
+              if request_data[:parameters].is_a?(Hash)
+                request_data[:parameters] = parameters.merge request_data[:parameters]
               end
+            else
+              request_data = nil
             end
-            request_data ||= {parameters: parameters}
-            uuid = Airbrake.notify_or_ignore(exception, request_data)
-            "https://airbrake.io/locate/#{uuid}" if uuid
           end
-        rescue Exception
+          request_data ||= {parameters: parameters}
+          uuid = Airbrake.notify_or_ignore(exception, request_data)
+          "https://airbrake.io/locate/#{uuid}" if uuid
         end
+      rescue Exception
       end
 
       def self.notify_appsignal(exception, parameters = {})
-        begin
-          if const_defined?(:Appsignal) and
-             not Appsignal.is_ignored_exception?(exception)
-            # TODO: If and when https://github.com/appsignal/appsignal/pull/9 is merged,
-            # this functionality should be supported directly by Appsignal.send_exception.
-            # Appsignal.send_exception(exception, parameters: parameters)
+        if const_defined?(:Appsignal) and
+           not Appsignal.is_ignored_exception?(exception)
+          # TODO: If and when https://github.com/appsignal/appsignal/pull/9 is merged,
+          # this functionality should be supported directly by Appsignal.send_exception.
+          # Appsignal.send_exception(exception, parameters: parameters)
 
-            if Appsignal.active?
-              # Hackety hack around stateful mess of Appsignal gem
-              if Appsignal::Transaction.current
-                Appsignal::Transaction.current.set_tags(parameters)
-                Appsignal::Transaction.current.add_exception(exception)
-              else
-                transaction = Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
-                transaction.set_tags(parameters)
-                transaction.add_exception(exception)
-                transaction.complete!
-                Appsignal.agent.send_queue
-              end
+          if Appsignal.active?
+            # Hackety hack around stateful mess of Appsignal gem
+            if Appsignal::Transaction.current
+              Appsignal::Transaction.current.set_tags(parameters)
+              Appsignal::Transaction.current.add_exception(exception)
+            else
+              transaction = Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
+              transaction.set_tags(parameters)
+              transaction.add_exception(exception)
+              transaction.complete!
+              Appsignal.agent.send_queue
             end
           end
-        rescue Exception
         end
+      rescue Exception
       end
     end
   end

data/spec/roqua/support/errors_spec.rb

@@ -45,6 +45,48 @@ describe 'Error reporting' do
       Roqua::Support::Errors.report exception, skip_backtrace: true
     end
 
+    it 'can add extra parameters by calling add_parameters' do
+      Roqua.logger.should_receive(:error).with \
+        'roqua.exception', class_name: 'RuntimeError',
+                           message: 'exception_message',
+                           parameters: {more: 'params',
+                                        even_more: 'params'}
+      begin
+        begin
+          begin
+            fail 'exception_message'
+          rescue
+            Roqua::Support::Errors.add_parameters(more: 'params')
+            raise
+          end
+        rescue
+          Roqua::Support::Errors.add_parameters(even_more: 'params')
+          raise
+        end
+      rescue => e
+        Roqua::Support::Errors.report e, skip_backtrace: true
+      end
+    end
+
+    it 'will not fail when called outside of rescue or when passed the wrong format to add_parameters' do
+      Roqua.logger.should_receive(:error).with \
+        'roqua.exception', class_name: 'RuntimeError',
+                           message: 'exception_message',
+                           parameters: {}
+
+      begin
+        Roqua::Support::Errors.add_parameters('just a string')
+        begin
+          fail 'exception_message'
+        rescue
+          Roqua::Support::Errors.add_parameters('just a string')
+          raise
+        end
+      rescue => e
+        Roqua::Support::Errors.report e, skip_backtrace: true
+      end
+    end
+
     it 'logs notification_urls when present' do
       stub_const('Airbrake', double('Airbrake', notify_or_ignore: 'uuid'))
       Roqua.logger.should_receive(:error)
@@ -75,13 +117,6 @@ describe 'Error reporting' do
       Roqua::Support::Errors.report exception, controller: controller, some: 'context'
     end
 
-    it 'does not fail with extra parameters of incompatible type' do
-      Roqua::Support::Errors.extra_parameters = ['extra', 'param']
-      expect(Airbrake).to receive(:notify_or_ignore).with(exception, parameters: {})
-      Roqua::Support::Errors.report exception
-      Roqua::Support::Errors.extra_parameters = {}
-    end
-
     it 'does not fail with context of incompatible type' do
       expect(Airbrake).to receive(:notify_or_ignore).with(exception, parameters: {})
       Roqua::Support::Errors.report exception, ['controller', 'extra_param']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.21
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Helper objects and proxies used by a lot of RoQua applications
@@ -192,4 +192,3 @@ test_files:
 - spec/roqua/support_spec.rb
 - spec/roqua/validators/subset_validator_spec.rb
 - spec/spec_helper.rb
-has_rdoc: