rusen 0.0.2 → 0.0.3

data/lib/rusen/settings.rb

@@ -4,19 +4,25 @@ module Rusen
 
     attr_writer :outputs
     attr_writer :email_prefix
+    attr_writer :email_via
     attr_writer :sender_address
     attr_writer :exception_recipients
     attr_writer :sections
     attr_writer :smtp_settings
     attr_writer :exclude_if
 
+    attr_writer :filter_parameters
+
+    attr_accessor :logger_name
+    attr_accessor :log4r_config_file
+
     # Returns the configured outputs.
     #
-    # Default: [:io, :email]
+    # Default: []
     #
     # @return [Array<Symbol>]
     def outputs
-      @outputs || [:io, :email]
+      @outputs || []
     end
 
     # Returns the notification email prefix.
@@ -28,6 +34,15 @@ module Rusen
       @email_prefix || '[Exception] '
     end
 
+    # Returns the email for email notifications.
+    #
+    # Default: :smtp
+    #
+    # @return [Symbol]
+    def email_via
+      @email_via || :smtp
+    end
+
     # Returns the notification email sender.
     #
     # Default: ''
@@ -73,6 +88,24 @@ module Rusen
       @exclude_if || lambda { |exception| false }
     end
 
+    # Returns the parameters we need to filter from being sent on
+    #   the notification, this will be used to not send sensitive
+    #   data to the developers credit card numbers for instance.
+    #
+    # @note
+    #   If this is used with a rails app we use the config filter
+    #   parameters from there if the filter parameters are not
+    #   defined.
+    #
+    # @return [Array]
+    def filter_parameters
+      if @filter_parameter
+        @filter_parameters || []
+      else
+        defined?(Rails) && Rails.application.config.filter_parameters
+      end
+    end
+
   end
 
 end

data/lib/rusen/sidekiq.rb

@@ -0,0 +1,19 @@
+require 'rusen'
+require 'sidekiq'
+
+Rusen.settings.outputs = [:mail]
+Rusen.settings.sections = [:backtrace]
+
+if Sidekiq::VERSION < '3'
+  require_relative 'middleware/rusen_sidekiq'
+
+  Sidekiq.configure_server do |config|
+    config.server_middleware do |chain|
+      chain.add Rusen::Middleware::RusenSidekiq
+    end
+  end
+else
+  Sidekiq.configure_server do |config|
+    config.error_handlers << Proc.new { |ex, context| Rusen.notify(ex) }
+  end
+end

data/lib/rusen/templates/email_template.html.erb

@@ -1,77 +1,31 @@
 <%= @notification.exception.class %>: <%= @notification.exception.message %>
 
-<% if @settings.sections.include?(:backtrace) %>
-<table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
-  <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
-  <tr>
-    <td><h4>Backtrace:</h4></td>
-    <td></td>
-  </tr>
-  </thead>
-  <tbody style="font-size: 11pt;">
-  <%  @notification.exception.backtrace.each do |backtrace_step| %>
-    <tr>
-      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= backtrace_step %></td>
-    </tr>
-  <% end %>
-  </tbody>
-</table>
-<% end %>
-
-<% if @settings.sections.include?(:request) %>
-<table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
-  <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
-  <tr>
-    <td><h4>Request:</h4></td>
-    <td></td>
-  </tr>
-  </thead>
-  <tbody style="font-size: 11pt;">
-  <% @notification.request.each do |k, v| %>
-    <tr>
-      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= k %></td>
-      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= v %></td>
-    </tr>
-  <% end %>
-  </tbody>
-</table>
-<% end %>
-
-<% if @settings.sections.include?(:session) %>
-<table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
-  <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
-  <tr>
-    <td><h4>Session:</h4></td>
-    <td></td>
-  </tr>
-  </thead>
-  <tbody style="font-size: 11pt;">
-  <% @notification.session.each do |k, v| %>
-    <tr>
-      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= k %></td>
-      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= v %></td>
-    </tr>
-  <% end %>
-  </tbody>
-</table>
-<% end %>
-
-
-<% if @settings.sections.include?(:environment) %>
-<table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
-  <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
-  <tr>
-    <td><h4>Environment:</h4></td>
-    <td></td>
-  </tr>
-  </thead>
-  <tbody style="font-size: 11pt;">
-  <% @notification.environment.each do |k, v| %>
-    <tr>
-      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= k %></td>
-      <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= v %></td>
-    </tr>
-  <% end %>
-  </tbody>
-</table>
+<% @sessions.each do |name, session| %>
+  <table style="border-collapse: collapse; border-spacing: 0; width: 100%; border: double; margin-bottom: 10px;">
+    <thead style="background-color: #EFEFEF; font-size: 10pt; font-weight: bold;">
+      <tr>
+        <td>
+          <h4><%= name %>:</h4>
+        </td>
+        <td></td>
+      </tr>
+    </thead>
+    <tbody style="font-size: 11pt;">
+      <% if session.is_a?(Hash) %>
+        <% session.each do |key, value| %>
+          <tr>
+            <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= key %></td>
+            <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= value %></td>
+          </tr>
+        <% end %>
+      <% else %>
+        <% session.each do |session_step| %>
+          <tr>
+            <td style="border: solid 1px #000000; margin: 0; padding: 4pt 6pt;"><%= session_step %></td>
+            <td></td>
+          </tr>
+        <% end %>
+      <% end %>
+    </tbody>
+  </table>
 <% end %>

data/lib/rusen/templates/io_template.txt.erb

@@ -0,0 +1,19 @@
+*******************************************************************************
+<%= @notification.exception.class %>: <%= @notification.exception.message -%>
+<% @sessions.each do |name, session| -%>
+<%= "\n" %>
+-------------------------------
+<%= name %>:
+-------------------------------
+  <% if session.is_a?(Hash) -%>
+    <% session.each do |key, value| -%>
+<%= "\n#{key.to_s}:\t\t\t#{value.to_s}" -%>
+    <% end -%>
+  <% else -%>
+    <% session.each do |session_step| -%>
+<%= "\n#{session_step}" -%>
+    <% end -%>
+  <% end -%>
+<% end -%>
+
+*******************************************************************************

data/lib/rusen/templates/log4r_template.txt.erb

@@ -0,0 +1,19 @@
+*******************************************************************************
+<%= @notification.exception.class %>: <%= @notification.exception.message %>
+
+<% @sessions.each do |name, session| %>
+-------------------------------
+<%= name %>:
+-------------------------------
+  <% if session.is_a?(Hash) -%>
+    <% session.each do |key, value| -%>
+<%= key.to_s + ":\t\t\t" + value.to_s -%>
+    <% end -%>
+  <% else -%>
+    <% session.each do |session_step| -%>
+<%= "\t" + session_step %>
+    <% end -%>
+  <% end -%>
+<% end -%>
+
+*******************************************************************************

data/lib/rusen/utils/parameter_filter.rb

@@ -0,0 +1,68 @@
+class ParameterFilter
+  FILTERED = '[FILTERED]'.freeze # :nodoc:
+
+  def initialize(filters = [])
+    @filters = filters
+  end
+
+  def filter(params)
+    compiled_filter.call(params)
+  end
+
+  private
+
+  def compiled_filter
+    @compiled_filter ||= CompiledFilter.compile(@filters)
+  end
+
+  class CompiledFilter # :nodoc:
+    def self.compile(filters)
+      return lambda { |params| params.dup } if filters.nil? || filters.empty?
+
+      strings, regexps, blocks = [], [], []
+
+      filters.each do |item|
+        case item
+          when Proc
+            blocks << item
+          when Regexp
+            regexps << item
+          else
+            strings << item.to_s
+        end
+      end
+
+      regexps << Regexp.new(strings.join('|'), true) unless strings.empty?
+      new regexps, blocks
+    end
+
+    attr_reader :regexps, :blocks
+
+    def initialize(regexps, blocks)
+      @regexps = regexps
+      @blocks  = blocks
+    end
+
+    def call(original_params)
+      filtered_params = {}
+
+      original_params.each do |key, value|
+        if regexps.any? { |r| key =~ r }
+          value = FILTERED
+        elsif value.is_a?(Hash)
+          value = call(value)
+        elsif value.is_a?(Array)
+          value = value.map { |v| v.is_a?(Hash) ? call(v) : v }
+        elsif blocks.any?
+          key = key.dup
+          value = value.dup if value.duplicable?
+          blocks.each { |b| b.call(key, value) }
+        end
+
+        filtered_params[key] = value
+      end
+
+      filtered_params
+    end
+  end
+end

data/lib/rusen/version.rb

@@ -0,0 +1,3 @@
+module Rusen
+  VERSION='0.0.3'
+end

metadata

@@ -1,101 +1,226 @@
 --- !ruby/object:Gem::Specification
 name: rusen
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Adrian Gomez
+- Pablo Ifran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-25 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  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: pony
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "RUby Simple Exception Notification (a.k.a. rusen) as it names indicates
-  is a\n                       simple exception notification for ruby."
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: roodi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: |-
+  RUby Simple Exception Notification (a.k.a. rusen) as it names indicates is a
+                         simple exception notification for ruby.
 email: adri4n.gomez@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
 - lib/rusen.rb
-- lib/rusen/templates/email_template.html.erb
+- lib/rusen/middleware/rusen_rack.rb
+- lib/rusen/middleware/rusen_sidekiq.rb
+- lib/rusen/notification.rb
 - lib/rusen/notifier.rb
-- lib/rusen/settings.rb
+- lib/rusen/notifiers.rb
+- lib/rusen/notifiers/base_notifier.rb
 - lib/rusen/notifiers/io_notifier.rb
-- lib/rusen/notifiers/email_notifier.rb
-- lib/rusen/notification.rb
-- lib/rusen/middleware/rusen_rack.rb
+- lib/rusen/notifiers/log4r_notifier.rb
+- lib/rusen/notifiers/mail_notifier.rb
+- lib/rusen/notifiers/pony_notifier.rb
+- lib/rusen/settings.rb
+- lib/rusen/sidekiq.rb
+- lib/rusen/templates/email_template.html.erb
+- lib/rusen/templates/io_template.txt.erb
+- lib/rusen/templates/log4r_template.txt.erb
+- lib/rusen/utils/parameter_filter.rb
+- lib/rusen/version.rb
 homepage: https://github.com/Moove-it/rusen
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RUby Simple Exception Notification
 test_files: []