exception_notification_sns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cab2c46a81a544c5f04974a5b6dd9ef965058f9e
+  data.tar.gz: a9c7beea1c3aa16ea4794d129dba552c76b55039
+SHA512:
+  metadata.gz: 9e976e3ee6a743ef3fc702d09659c4ccdd9a236713c86cc5d8834955e01c6de239e726439d624f9953d45b8ee65481ebf027b3bf28b1f4b878d2e8b6893c0cff
+  data.tar.gz: eb61eaff462f908c3d3549cd741fec506801d55b1bed22328e81711b9bcc3363e5bbb1f0a2d7cbf132b6e72384959f82ffa32bd1d722ec0d93f93e0f97a480b2

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+*.iml
+*.gem

data/.ruby-gemset

@@ -0,0 +1 @@
+exception_notification_sns

data/.ruby-verson

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,159 @@
+PATH
+  remote: .
+  specs:
+    exception_notification_sns (0.1.0)
+      aws-sdk-v1 (>= 1, < 3)
+      exception_notification (= 4.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    aws-sdk-v1 (1.66.0)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+    builder (3.2.3)
+    concurrent-ruby (1.0.4)
+    coveralls (0.8.18)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    exception_notification (4.2.1)
+      actionmailer (>= 4.0, < 6)
+      activesupport (>= 4.0, < 6)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    metaclass (0.0.4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    rack (1.6.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.8)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    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.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.10)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.5)
+    tins (1.13.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (~> 0.8.2)
+  exception_notification_sns!
+  factory_girl (= 4.5)
+  mocha (~> 0.13.0)
+  rails (>= 4.0.0, < 6)
+  rspec (= 3.4.0)
+  sqlite3 (= 1.3.10)
+
+BUNDLED WITH
+   1.13.7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ingemark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Exception notification SNS
+
+Exception notification extension for Amazon SNS
+
+## Requirements
+
+* Ruby 2.2 or greater
+* Rails 4.0 or greater
+
+## Getting Started
+
+Add the following line to your application's Gemfile:
+
+```ruby
+gem 'exception_notification_sns'
+```
+
+### Rails
+
+ExceptionNotificationSNS adds sns notifier for exception_notification gem. It is used as a rack middleware, or in the environment you want it to run. In most cases you would want ExceptionNotificationSNS to run on production. Thus, you can make it work by putting the following lines in your `config/environments/production.rb`:
+
+```ruby
+Rails.application.config.middleware.use ExceptionNotification::Rack,
+  sns: {
+    access_key_id: 'AWS_ACCESS_KEY_ID',
+    secret_access_key: 'AWS_SECRET_ACCESS_KEY',
+    region: 'AWS_REGION',
+    topic_arn: 'AWS_SNS_TOPIC_ARN'
+  }
+```
+
+#### Options
+
+##### access_key_id 
+
+*String, required*
+
+AWS access key ID
+
+##### secret_access_key 
+
+*String, required*
+
+AWS secret access key
+
+##### region
+
+*String, required*
+
+AWS region
+
+##### topic_arn
+
+*String, required*
+
+AWS SNS topic arn
+
+## Extras 
+
+For more information about exception_notification gem on which this gem was built, visit [exception_notification](https://github.com/smartinez87/exception_notification).
+
+## License
+
+Copyright (c) 2017 Matej Minažek, released under the [MIT license](http://www.opensource.org/licenses/MIT).
+
+
+
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+require 'appraisal'
+
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/exception_notification_sns.gemspec

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'exception_notification_sns'
+  s.version     = '0.1.0'
+  s.summary     = 'exception_notification extension for aws sns v1'
+  s.description = 'exception_notification_sns gem is used for sending application extensions to aws sns. It extends exception_notification gem, uses aws-sdk-v1 gem to push exception notificatons to amazon sns'
+  s.required_ruby_version = '>= 2.2.0'
+
+  s.author    = 'Matej Minažek'
+  s.email     = 'matej.minazek@ingemark.com'
+  s.homepage  = 'http://www.ingemark.com'
+  s.license   = 'MIT'
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+
+  s.add_runtime_dependency 'exception_notification', '4.2.1'
+  s.add_runtime_dependency 'aws-sdk-v1', '>= 1', '< 3'
+
+  s.add_development_dependency 'rails', '>= 4.0.0', '< 6'
+  s.add_development_dependency 'factory_girl', '4.5'
+  s.add_development_dependency 'rspec', '3.4.0'
+  s.add_development_dependency 'mocha', '~> 0.13.0'
+  s.add_development_dependency 'sqlite3', '1.3.10'
+  s.add_development_dependency 'coveralls', '~> 0.8.2'
+
+end

data/lib/exception_notification_sns.rb

@@ -0,0 +1,4 @@
+require 'exception_notification'
+require 'aws-sdk-v1'
+
+require 'exception_notifier/sns_notifier'

data/lib/exception_notifier/sns_notifier.rb

@@ -0,0 +1,65 @@
+require 'action_dispatch'
+
+module ExceptionNotifier
+  class SnsNotifier < BaseNotifier
+    include ExceptionNotifier::BacktraceCleaner
+
+    def initialize(options)
+      super
+      access_key_id = options.delete(:access_key_id)
+      secret_access_key = options.delete(:secret_access_key)
+      region = options.delete(:region)
+
+      @sns_client = AWS::SNS::Client.new(access_key_id: access_key_id, secret_access_key: secret_access_key, region: region)
+      @topic_arn = options.delete(:topic_arn)
+    end
+
+    def call(exception, options={})
+      return if !active?
+
+
+
+      env = options[:env] || {}
+      puts env.inspect
+      @options = options
+      @exception = exception
+      @backtrace = exception.backtrace ? clean_backtrace(exception) : []
+      @kontroller = env['action_controller.instance']
+      @request = ::ActionDispatch::Request.new(env) if @kontroller
+
+      @sns_client.publish({
+          subject: compose_subject,
+          topic_arn: @topic_arn,
+          message: compose_message.to_json
+      })
+    end
+
+    def active?
+      !@sns_client.nil? && !@topic_arn.nil?
+    end
+
+    def compose_subject
+      subject = @kontroller ? "#{@kontroller.controller_name}##{@kontroller.action_name}" : ''
+      subject << " (#{@exception.class})"
+      subject << " #{@exception.message.inspect}"
+    end
+
+    def compose_message
+      message = {
+          backtrace: @backtrace.to_s,
+          default: compose_subject
+      }
+
+      message[:request] = {
+          url:  @request.url,
+          method:  @request.request_method,
+          remote_ip: @request.remote_ip,
+          parameters: @request.filtered_parameters.inspect
+      } if @request
+
+      message
+    end
+  end
+end
+
+

data/spec/exception_notifer/sns_notifer_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'exception_notifier/sns_notifier'
+
+describe 'SNS Notifer' do
+
+  before(:each) do
+    options = {
+        access_key_id: 'acces_key',
+        secret_access_key: 'secret_access_key',
+        topic_arn: 'topic_arn',
+        region: 'region'
+    }
+
+    @sns = ExceptionNotifier::SnsNotifier.new(options)
+  end
+
+  it 'should send exception notification to sns if properly configured' do
+    @sns.call(fake_exception)
+  end
+
+  it 'should compose correct message and subject' do
+    @sns.call(fake_exception)
+
+    composed_subject = @sns.compose_subject
+    expect(composed_subject).to eq fake_subject
+
+    composed_message = @sns.compose_message
+    expect(composed_message[:backtrace]).not_to be_nil
+    expect(composed_message[:default]).not_to be_nil
+  end
+
+  private
+
+  def fake_message
+    {
+        backtrace: fake_exception.backtrace.to_s,
+        default: fake_subject
+    }
+  end
+
+  def fake_subject
+    subject = " (#{fake_exception.class})"
+    subject << " #{fake_exception.message.inspect}"
+  end
+
+
+  def fake_exception
+    begin
+      5/0
+    rescue Exception => e
+      e
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# load lib in LOAD_PATH
+$:<< File.join(File.dirname(__FILE__), '../lib')
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require 'rspec'
+
+require 'mocha/api'
+require 'aws/sns'
+require 'exception_notifier'
+
+ExceptionNotifier.testing_mode!
+AWS.stub!
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: exception_notification_sns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matej Minažek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: exception_notification_sns gem is used for sending application extensions
+  to aws sns. It extends exception_notification gem, uses aws-sdk-v1 gem to push exception
+  notificatons to amazon sns
+email: matej.minazek@ingemark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-verson"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- exception_notification_sns.gemspec
+- lib/exception_notification_sns.rb
+- lib/exception_notifier/sns_notifier.rb
+- spec/exception_notifer/sns_notifer_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.ingemark.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: exception_notification extension for aws sns v1
+test_files: []