lita-dm-notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 768acdb224612db589b9821672e2b868c0bdf86c
+  data.tar.gz: 7b0346d0456859a9667f664b7d1e468d91c7625c
+SHA512:
+  metadata.gz: 21d2a74b24c2e2ba95137b54fadd801f5ef11bd900f0f313c1dfc49dcb3344bb6486f4a964b2e16895d75be54c9db215876e7f5a7018f384c87878535392dbc7
+  data.tar.gz: 94a786c4d125c5ac05a38ffe410f7dd57b148e0342c74a9175cc578e0b9a0c9993de6ba94d269da8dd3f53577c2f1eb6634e9d388251e0e6bc9edaef863cfb39

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2017, Mark Bainter
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,58 @@
+# lita-dm-notifier
+
+[![Gem Version](https://badge.fury.io/rb/lita-dm-notifier.svg)](https://badge.fury.io/rb/lita-dm-notifier)
+[![Build Status](https://travis-ci.org/mbainter/lita-dm-notifier.png?branch=master)](https://travis-ci.org/mbainter/lita-dm-notifier)
+[![Coverage Status](https://coveralls.io/repos/mbainter/lita-dm-notifier/badge.svg?branch=master&service=github)](https://coveralls.io/github/mbainter/lita-dm-notifier?branch=master)
+
+
+
+This is a simple handler to allow leveraging Lita to send direct messages to users via webhooks. Historically email is usually how we send out notifications from our systems, but with modern authentication systems and often dynamic ip addressing this can be a headache. With this handler you can instead send a simple post call to Lita and send rich messages to users for notifications instead.
+
+Note: At the moment this *only* works with the Slack adaptor. 
+
+## Installation
+
+Add lita-dm-notifier to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-dm-notifier"
+```
+
+## Configuration
+
+There is no configuration necessary for this plugin as of yet.
+
+## Usage
+
+Send a post call with a JSON blob to your Lita's HTTP endpoint, such as http://lita:8080/dm/notify/. At a minimum it needs the `text`, `fields`, `type` and `user` fields. Beyond that you can add any field from the [Slack attachment API](https://api.slack.com/docs/message-attachments) except color and it will honor it.
+
+If the `type` field is set to "info", "good", "warning", or "danger" it will set the color accordingly using slack's options, otherwise the color will be "black". The type will also be included as a field added to whatever fields are passed in. If no `fallback` field is included then fallback will be set to the same content as the `text` field.
+
+The `user` field should be the mention_name for the user in slack.
+
+So, with a message of:
+```json
+{
+    "fields": [],
+    "footer": "http cli test of lita-dm-notifier",
+    "text": "This is a test of lita-dm-notifier",
+    "title": "THIS IS A TEST. THIS IS ONLY A TEST",
+    "title_link": "http://github.com/mbainter/lita-dm-notifier",
+    "type": "info",
+    "user": "markb"
+}
+```
+
+```
+http --all --verbose POST http://localhost:8080/dm/notify @/tmp/dm-notifier-test.json
+POST /dm/notify HTTP/1.1
+...
+HTTP/1.1 200 OK
+Transfer-Encoding: chunked
+```
+
+![Example output in Slack](https://raw.github.com/mbainter/lita-dm-notifier/master/example.png)
+
+# License
+
+[Simplified BSD](https://opensource.org/licenses/BSD-2-Clause)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita/handlers/dm_notifier.rb

@@ -0,0 +1,54 @@
+module Lita
+  module Handlers
+    # DirectMessage Notification
+    class DmNotifier < Handler
+      # NOTE: Disabled as it breaks rspec for now
+      # feature :async_dispatch
+      http.post '/dm/notify', :send_notification
+
+      # FORMAT:
+      # {
+      #   "user": "required username (mention) to send the message to",
+      #   "author_name": "Optional author name"
+      #   "author_link": "Optional link for the author"
+      #   "author_icon": "Optional image for the author"
+      #   "title": "Required title for the attachment",
+      #   "title_link": "The link for the title on this attachment",
+      #   "image_url": "Optional image to include",
+      #   "thumb_url": "Optional Thumbnail to include",
+      #   "footer_icon": "Optional icon to include in the footer",
+      #   "footer": "Optional text for the footer",
+      #   "pretext": "Optional text above the attachment",
+      #   "text": "The message to send within the attachment, also fallback if not provided"
+      #   "fallback": "Optional fallback text if client doesn't support the attachment"
+      #   "fields": Array of json objects defining fields for slack
+      # }
+      def send_notification(request, _response)
+        data = MultiJson.load(request.body, symbolize_keys: true)
+        type = data.delete(:type)
+        text = data.delete(:text)
+        data[:fields] += [{ title: 'Type', value: type, short: true }]
+        data.merge(color: get_color(type))
+        log.debug("Received alert request for #{data[:user]}\n")
+        payload = Lita::Adapters::Slack::Attachment.new(text, data)
+        user = User.find_by_mention_name(data[:user])
+        robot.chat_service.send_attachment(user, payload)
+      end
+
+      private
+
+      def get_color(type)
+        custom_types = { info: '#439FE0' }
+        if %w(good warning danger).include?(type)
+          type
+        elsif custom_types.key?(type)
+          custom_types[type]
+        else
+          '#000000'
+        end
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita-dm-notifier.rb

@@ -0,0 +1,12 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/dm_notifier"
+
+Lita::Handlers::DmNotifier.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lita-dm-notifier.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-dm-notifier"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Mark Bainter"]
+  spec.email         = ["mbainter@gmail.com"]
+  spec.description   = "Allows for posting formatted notifications from to slack users via HTTP."
+  spec.summary       = "This plugin provides a HTTP endpoint to post formatted notifications privately to users in chat."
+  spec.homepage      = "https://github.com/mbainter/lita-dm-notifier"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency "lita", ">= 4.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      dm_notifier:

data/spec/lita/handlers/dm_notifier_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Lita::Handlers::DmNotifier, lita_handler: true do
+  it { is_expected.to route_http(:post, '/dm/notify').to(:send_notification) }
+  #
+  # describe "#send_notification" do
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter '/spec/' }
+
+require 'lita-dm-notifier'
+require 'lita/rspec'
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

data/templates/warning.slack.erb

@@ -0,0 +1 @@
+# TODO: Fill out the template

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: lita-dm-notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Bainter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: 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'
+description: Allows for posting formatted notifications from to slack users via HTTP.
+email:
+- mbainter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example.png
+- lib/lita-dm-notifier.rb
+- lib/lita/handlers/dm_notifier.rb
+- lita-dm-notifier.gemspec
+- locales/en.yml
+- spec/lita/handlers/dm_notifier_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+- templates/warning.slack.erb
+homepage: https://github.com/mbainter/lita-dm-notifier
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.5.2
+signing_key: 
+specification_version: 4
+summary: This plugin provides a HTTP endpoint to post formatted notifications privately
+  to users in chat.
+test_files:
+- spec/lita/handlers/dm_notifier_spec.rb
+- spec/spec_helper.rb