slack_error_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11890433ad0182185133f93ec7f7694572575088
+  data.tar.gz: 1e65700e8010ddc09cbd27e846e48c17d184239f
+SHA512:
+  metadata.gz: eb8e1c64d9d734c15363028141f75e580f5fa52886a1b35e404c86d877291b9823ef88d3d4092dc27d960e06ade208454addd7c0cf7f243d71befc97ea5ae95b
+  data.tar.gz: 05f6e1746f2e1580773b71eb88f423417ff8cd48b56267002de08e7a93df570fb551256eed5102e918bda4443e4371f980d5307017986f4f8c4821578662e684

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,55 @@
+# Slack Error Notifier
+
+Simple Slack exception notification for Ruby scripts. Just wrap your code in `SlackErrorNotifier.with_notifications {}` and off you go. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_error_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack_error_notifier
+
+## Usage
+
+### Configuration
+
+```ruby
+SlackErrorNotifier.configuration do |config|
+  config.app_name = <THE NAME OF YOUR APP OR SCRIPT>
+  config.access_token = <YOUR SLACK TOKEN>
+  config.target_channel = <THE CHANNEL OR USER TO POST MESSAGES TO> # include '@' or '#' as applicable
+  confg.send_as_user = <TRUE/FALSE> # whether you want to send as slackbot or the user whose token you're using.   
+end
+```
+
+Pro-tip: Add a bot to your Slack organization and then use its API Token. You can then configure the avatar and username you want messages to come from. 
+
+### Catching Exceptions in Your Code
+
+```ruby
+SlackErrorNotifier.with_notifications do 
+  # Commence dangerous operations here:
+  NuclearLaunchCode.run!
+end
+```
+
+Your target user or channel will then be notified of any unhandled exceptions that occur during the dangerous operation. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cgrdavies/slack_error_notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack_error_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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/slack_error_notifier.rb

@@ -0,0 +1,48 @@
+require 'slack-ruby-client'
+
+require "slack_error_notifier/version"
+require "slack_error_notifier/helpers/configuration"
+require "slack_error_notifier/slack_configuration"
+require "slack_error_notifier/slack_notification"
+
+
+module SlackErrorNotifier
+  extend Configuration
+
+  define_setting :access_token
+  define_setting :target_channel
+  define_setting :send_as_user
+  define_setting :app_name
+
+  def self.with_notifications
+    check_configuration(block_given?)
+    configure_slack_client
+    yield
+  rescue => error
+    puts "Encountered #{error}. Sending Notification to #{target_channel}."
+    send_notification(error)
+  end
+
+  def self.configure_slack_client
+    @slack_configuration = SlackConfiguration.new
+  end
+
+  def self.slack_client
+    @slack_configuration.slack_client
+  end
+
+  def self.send_notification(error)
+    SlackNotification.send(error)
+  end
+
+  def self.check_configuration(block_given)
+    raise ConfigurationError::NoBlockGivenError unless block_given
+    raise ConfigurationError::MissingConfiguration unless access_token && target_channel
+  end
+
+  module ConfigurationError
+    class NoBlockGivenError < StandardError; end
+    class MissingConfiguration < StandardError; end
+    class InvalidChannel < StandardError; end
+  end
+end

data/lib/slack_error_notifier/helpers/configuration.rb

@@ -0,0 +1,20 @@
+module Configuration
+  def configuration
+    yield self
+  end
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+  private
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end

data/lib/slack_error_notifier/slack_configuration.rb

@@ -0,0 +1,49 @@
+module SlackErrorNotifier
+  class SlackConfiguration
+    attr_reader :slack_token, :target_channel
+
+    def initialize
+      @slack_token = SlackErrorNotifier.access_token
+      @target_channel = SlackErrorNotifier.target_channel
+      configure_slack_client
+      check_authentication
+      check_target_channel_validity
+    end
+
+    def slack_client
+      @slack_client ||= Slack::Web::Client.new
+    end
+
+    private
+
+    def check_authentication
+      slack_client.auth_test
+    end
+
+    def check_target_channel_validity
+      valid_channel = channel_is_user? ? check_user_exists : check_channel_exists
+      raise ConfigurationError::InvalidChannel unless valid_channel
+    end
+
+    def channel_is_user?
+      target_channel.start_with?('@')
+    end
+
+    def check_user_exists
+      slack_client.users_info(user: target_channel)
+    rescue Slack::Web::Api::Error
+      return false
+    end
+
+    def check_channel_exists
+      channels = slack_client.channels_list.channels
+      matching_channel = channels.detect { |c| c.name == target_channel.gsub('#', '') }
+    end
+
+    def configure_slack_client
+      Slack.configure do |config|
+        config.token = slack_token
+      end
+    end
+  end
+end

data/lib/slack_error_notifier/slack_notification.rb

@@ -0,0 +1,58 @@
+module SlackErrorNotifier
+  class SlackNotification
+    def initialize(error)
+      @error = error
+    end
+
+    def self.send(error)
+      new(error).send
+    end
+
+    def send
+      slack_client.chat_postMessage(
+        channel: target_channel,
+        text: "",
+        attachments: attachments,
+        as_user: true
+      )
+    end
+
+    private
+
+    def slack_client
+      SlackErrorNotifier.slack_client
+    end
+
+    def target_channel
+      SlackErrorNotifier.target_channel
+    end
+
+    def send_as_user
+      SlackErrorNotifier.send_as_user
+    end
+
+    def attachments
+      [{
+        fallback: "Error in #{app_name}",
+        color: "danger",
+        title: "Error in #{app_name}!",
+        text: assemble_text_body,
+        mrkdwn_in: ['text'],
+        thumb_url: 'http://i.imgur.com/ILN6Klm.gif',
+        fields: [{
+             "title": "Project",
+             "value": "#{app_name}",
+             "short": true
+        }]
+      }]
+    end
+
+    def assemble_text_body
+      "#{Time.new.strftime("At %I:%M%p")}, an error occurred with the following stack trace: ```#{@error.backtrace.join("\n")}```"
+    end
+
+    def app_name
+      SlackErrorNotifier.app_name
+    end
+  end
+end

data/lib/slack_error_notifier/version.rb

@@ -0,0 +1,3 @@
+module SlackErrorNotifier
+  VERSION = "0.1.0"
+end

data/slack_error_notifier.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack_error_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack_error_notifier"
+  spec.version       = SlackErrorNotifier::VERSION
+  spec.authors       = ["Chris Davies"]
+  spec.email         = ["cgrdavies@gmail.com"]
+
+  spec.summary       = %q{Sends exceptions to a slack channel or user.}
+  spec.description   = %q{Wrap your code in our block and let us send error messages when you screw up. }
+  spec.homepage      = "https://github.com/cgrdavies/slack_error_notifier"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+
+  spec.add_runtime_dependency "slack-ruby-client"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: slack_error_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Davies
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: slack-ruby-client
+  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'
+description: 'Wrap your code in our block and let us send error messages when you
+  screw up. '
+email:
+- cgrdavies@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_error_notifier.rb
+- lib/slack_error_notifier/helpers/configuration.rb
+- lib/slack_error_notifier/slack_configuration.rb
+- lib/slack_error_notifier/slack_notification.rb
+- lib/slack_error_notifier/version.rb
+- slack_error_notifier.gemspec
+homepage: https://github.com/cgrdavies/slack_error_notifier
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Sends exceptions to a slack channel or user.
+test_files: []