slack-mail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7aa57e35fa555bfcce6b558798bc55dc36a7cf9
+  data.tar.gz: aa57d82dde8bc458eb2491100189f3594f673cf4
+SHA512:
+  metadata.gz: 94e576453a1e7c721ebb690f0a7f94f513dc0cae66e5cd0ffcec872567b7c5c2e4c67bfc6b8dd7911e5904c4cef2bdc11ee02f32292079175093174f26b51975
+  data.tar.gz: 1b61377adfe1cce4c5986c2a30d323ee5f324343e8186210ea9c26b77e11e62d81ca00d7199567586101c71300709372280a173c9bfc1c62352d96a6b3e8c7f6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 James Dabbs
+
+MIT License
+
+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,66 @@
+# Slack::Mail
+
+`ActionMailer` inspired [Slack](slack.com) message objects.
+
+
+## Usage
+
+Add `gem 'slack-mail'` to your `Gemfile` and install it.
+
+```ruby
+# Basic usage.
+Slack::Mail.new(text: "...").deliver_now
+
+# Using `ActiveJob` to send async (if configured)
+Slack::Mail.new(text: "...").deliver_later
+
+# Monitor your Rails app
+class ApplicationController
+  rescue_from StandardError do |e|
+    Slack::Mail.new(channel: "bots").attach_error(e).deliver_later
+  end
+end
+```
+
+Valid [mail attributes](https://github.com/jamesdabbs/slack-mail/blob/master/lib/slack/mail.rb#L14) are
+
+* channel
+* text
+* username
+* as_user
+* parse
+* link_names
+* attachments
+* unfurl_links
+* unfurl_media
+* icon_url
+* icon_emoji
+
+all as per the [Slack API](https://api.slack.com/methods/chat.postMessage) (or `ls Slack::Mail.new` if you've got [pry](http://pryrepl.org/))
+
+### Configuring Send Strategies
+
+By default, messages are "delivered" into an array at `Slack::Mail.deliveries`
+
+To actually send them, you'll need to [configure an incoming webhook](https://api.slack.com/incoming-webhooks) and tell `Slack::Mail` about it
+
+```ruby
+Rails.application.configure do
+  config.slack_mail.deliver_with :perform, webhook_url: ...
+```
+
+You can also opt-in to storing messages (e.g. in `config/environments/test.rb`)
+
+```ruby
+Rails.application.configure do
+  config.slack_mail.deliver_with :store
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/slack-mail/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/slack/mail.rb

@@ -0,0 +1,49 @@
+require "slack-notifier"
+
+require "slack/mail/config"
+require "slack/mail/delivery"
+require "slack/mail/job"
+require "slack/mail/railtie"
+require "slack/mail/version"
+
+module Slack
+  class Mail
+
+    include Virtus.model
+
+    attribute :channel, String, default: '#general'
+    attribute :text
+    attribute :username
+    attribute :as_user
+    attribute :parse
+    attribute :link_names
+    attribute :attachments
+    attribute :unfurl_links
+    attribute :unfurl_media
+    attribute :icon_url
+    attribute :icon_emoji
+
+    def deliver_now
+      Mail.config.deliverer.deliver self
+    end
+
+    def deliver_later
+      Slack::Mail::Job.perform_later to_h
+    end
+
+    def attach_error error
+      self.text        ||= error.to_s
+      self.attachments ||= []
+
+      trace = error.backtrace.join "\n"
+      attachments.push \
+        fallback:  trace,
+        text:      "```#{trace}```",
+        color:     "danger",
+        mrkdwn_in: ["text"]
+
+      self
+    end
+
+  end
+end

data/lib/slack/mail/config.rb

@@ -0,0 +1,27 @@
+module Slack
+  class Mail
+    def self.deliverers
+      {
+        perform: Perform,
+        store:   Store
+      }
+    end
+
+    def self.config
+      @config ||= Slack::Mail::Configurator.new
+    end
+
+
+    class Configurator
+      attr_reader :deliverer
+
+      def initialize
+        @deliverer = Slack::Mail::Store.new
+      end
+
+      def deliver_with name, *args
+        @deliverer = Slack::Mail.deliverers.fetch(name).new *args
+      end
+    end
+  end
+end

data/lib/slack/mail/delivery.rb

@@ -0,0 +1,33 @@
+module Slack
+  class Mail
+    DeliveryFailure = Class.new(StandardError)
+
+    def self.deliveries
+      @_deliveries ||= []
+    end
+
+    class Perform
+      def initialize webhook_url:
+        @notifier = Slack::Notifier.new webhook_url
+      end
+
+      def deliver message
+        opts = message.to_h.reject { |_,v| v.nil? }
+        text = opts.delete(:text) || " "
+
+        response = @notifier.ping text, opts
+        unless response.code == "200"
+          raise DeliveryFailure, "Failed to reach #{@notifier.endpoint} (#{response.code})"
+        end
+        true
+      end
+    end
+
+    class Store
+      def deliver message
+        Slack::Mail.deliveries.push message
+      end
+    end
+
+  end
+end

data/lib/slack/mail/job.rb

@@ -0,0 +1,11 @@
+module Slack
+  class Mail
+    class Job < ActiveJob::Base
+      queue_as :default
+
+      def perform attrs
+        Slack::Mail.new(attrs).deliver_now
+      end
+    end
+  end
+end

data/lib/slack/mail/railtie.rb

@@ -0,0 +1,7 @@
+module Slack
+  class Mail
+    class Railtie < Rails::Railtie
+      config.slack_mail = Slack::Mail.config
+    end
+  end
+end

data/lib/slack/mail/version.rb

@@ -0,0 +1,5 @@
+module Slack
+  class Mail
+    VERSION = "0.0.1"
+  end
+end

data/slack-mail.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack/mail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack-mail"
+  spec.version       = Slack::Mail::VERSION
+  spec.authors       = ["James Dabbs"]
+  spec.email         = ["jamesdabbs@gmail.com"]
+  spec.summary       = %q{ActionMailer inspired Slack message objects.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "slack-notifier"
+  spec.add_dependency "rails", "~> 4.2" # For ActiveJob
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: slack-mail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Dabbs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: slack-notifier
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: ActionMailer inspired Slack message objects.
+email:
+- jamesdabbs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slack/mail.rb
+- lib/slack/mail/config.rb
+- lib/slack/mail/delivery.rb
+- lib/slack/mail/job.rb
+- lib/slack/mail/railtie.rb
+- lib/slack/mail/version.rb
+- slack-mail.gemspec
+homepage: ''
+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.5
+signing_key: 
+specification_version: 4
+summary: ActionMailer inspired Slack message objects.
+test_files: []