detailed_slack_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7726f6b48a30d4ced7cbd86acad394abc09ca8a4
+  data.tar.gz: 9b440a8413244e9a8108088acb8c67dd4ddb387a
+SHA512:
+  metadata.gz: 223489f4b9538b7e60a127efa2baa447d13303113d17d9474e0c9d2dfb5ac49d3dfad6b5702cd6ab543a2628b234fd7f76c3fb73571ea7eb7bf9dcd99739e006
+  data.tar.gz: 3a25d2c71d6df5738ea55fccc1f3edd638ab7c76821d550c8b5d783c2a6e39f3b252a8e52e99aa797e4ddf097a6dd23d71a4b77829d4f8f983d31c6084839f89

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ramongtx@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in detailed_slack_notifier.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ramon Carvalho Maciel
+
+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,72 @@
+# DetailedSlackNotifier
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/detailed_slack_notifier`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'detailed_slack_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install detailed_slack_notifier
+
+## Usage
+
+Use it as a [exception_notifier](https://github.com/smartinez87/exception_notification) plugin
+
+```ruby
+config.add_notifier :detailed_slack,
+  webhook_url: your_slack_webhook
+```
+
+```ruby
+config.add_notifier :detailed_slack,
+  webhook_url: your_slack_webhook,
+  username: desired_bot_username,
+  channel: desired_destination_channel
+```
+
+#### Options
+
+##### webhook_url
+
+*String, required*
+
+The Incoming WebHook URL on slack.
+
+##### channel
+
+*String, optional*
+
+Message will appear in this channel. Defaults to the channel you set as such on slack.
+
+##### username
+
+*String, optional*
+
+Username of the bot. Defaults to the name you set as such on slack
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/coffeebeantech/detailed_slack_notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'detailed_slack_notifier'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/detailed_slack_notifier.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'detailed_slack_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'detailed_slack_notifier'
+  spec.version       = DetailedSlackNotifier::VERSION
+  spec.authors       = ['Ramon Carvalho Maciel']
+  spec.email         = ['ramongtx@gmail.com']
+
+  spec.summary       = 'A plugin for exception_notification that sends slack notifications with detailed data'
+  spec.description   = 'A plugin for exception_notification that sends slack notifications with detailed data'
+  spec.homepage      = 'http://github.com/coffeebeantech/detailed_slack_notifier'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'rails', '>= 3.0.4'
+  spec.add_dependency 'slack-notifier', '~> 1.5'
+end

data/lib/detailed_slack_notifier.rb

@@ -0,0 +1,2 @@
+require 'detailed_slack_notifier/version'
+require 'exception_notifier/detailed_slack_notifier'

data/lib/detailed_slack_notifier/version.rb

@@ -0,0 +1,3 @@
+module DetailedSlackNotifier
+  VERSION = '0.1.0'.freeze
+end

data/lib/exception_notifier/detailed_slack_notifier.rb

@@ -0,0 +1,131 @@
+require 'slack-notifier'
+require 'action_dispatch/http/request'
+
+module ExceptionNotifier
+  # notifier plugin for Slack, implementing both initialize and call
+  class DetailedSlackNotifier
+    def initialize(options = {})
+      @webhook_url = options[:webhook_url]
+      @notifier_options = options.select { |key, _value| %i(username channel).include?(key) }
+    end
+
+    def call(exception, options = {})
+      notification = DetailedSlackNotification.new(exception, options)
+      slack_notifier.ping notification.message, attachments: notification.attachments
+    end
+
+    private
+
+    attr_reader :webhook_url, :username, :notifier_options
+
+    def slack_notifier
+      @slack_notifier ||= Slack::Notifier.new webhook_url, notifier_options
+    end
+
+    # this class builds Slack exception notifications
+    class DetailedSlackNotification
+      def initialize(exception, options = {})
+        @exception = exception
+        @env = options[:env]
+        @data = ((env && env['exception_notifier.exception_data']) || {}).merge(options[:data] || {})
+        @timestamp = Time.zone.now
+      end
+
+      def message
+        msg = "#{exception.class.to_s =~ /^[aeiou]/i ? 'An' : 'A'} #{exception.class} occurred"
+        msg << "#{background_exception? ? ' in background' : ''} at #{timestamp} :\n"
+        msg << "#{exception.message}\n"
+        msg
+      end
+
+      def attachments
+        array = []
+
+        unless background_exception?
+          array << session_attachment
+          array << request_attachment
+        end
+
+        array << backtrace_attachment
+        array << data_attachment
+      end
+
+      private
+
+      attr_reader :exception, :env, :data, :timestamp
+
+      def request
+        @request ||= ActionDispatch::Request.new(env)
+      end
+
+      def session_id
+        id = '[FILTERED]'
+        if request.ssl?
+          id = request.session['session_id']
+          id ||= (request.env['rack.session.options'] && request.env['rack.session.options'][:id]).inspect
+        end
+        id
+      end
+
+      def session_attachment
+        {
+          fallback: 'Session',
+          title: 'Session',
+          text: text_from_hash(
+            'Session ID' => session_id,
+            'Data' => JSON.pretty_generate(request.session.to_hash)
+          ),
+          color: '#444444'
+        }
+      end
+
+      def request_attachment
+        {
+          fallback: 'Request',
+          title: 'Request',
+          text: text_from_hash(request_description),
+          color: '#ff3399'
+        }
+      end
+
+      def request_description
+        {
+          'URL' => request.url,
+          'HTTP Method' => request.request_method,
+          'IP address' => request.remote_ip,
+          'Parameters' => request.filtered_parameters.inspect,
+          'Timestamp' => timestamp.getutc,
+          'Server' => Socket.gethostname,
+          'Rails root' => Rails.root,
+          'Process' => $PROCESS_ID
+        }
+      end
+
+      def backtrace_attachment
+        {
+          fallback: 'Backtrace',
+          title: 'Backtrace',
+          text: (exception.backtrace || []).join("\n"),
+          color: '#3399ff'
+        }
+      end
+
+      def data_attachment
+        {
+          fallback: 'Data',
+          title: 'Data',
+          text: JSON.pretty_generate(data),
+          color: '#33aa55'
+        }
+      end
+
+      def text_from_hash(hash)
+        hash.map { |k, v| "#{k}: #{v}" }.join("\n")
+      end
+
+      def background_exception?
+        env.nil?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: detailed_slack_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ramon Carvalho Maciel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: A plugin for exception_notification that sends slack notifications with
+  detailed data
+email:
+- ramongtx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- detailed_slack_notifier.gemspec
+- lib/detailed_slack_notifier.rb
+- lib/detailed_slack_notifier/version.rb
+- lib/exception_notifier/detailed_slack_notifier.rb
+homepage: http://github.com/coffeebeantech/detailed_slack_notifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.4.3
+signing_key: 
+specification_version: 4
+summary: A plugin for exception_notification that sends slack notifications with detailed
+  data
+test_files: []