lita-mailgun 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 837eed2e55191540ef1dae2727f12a5cbb9c12c4
+  data.tar.gz: 80708d792fcd7dd1a2b471f0a78d606e82c123ec
+SHA512:
+  metadata.gz: 6fecb1ebd3d401561b1f568df8bfbafb36917d617fc5f28de3af25620fe1d8b3a6da7e6e65b4e9e75f416694c691de599de7e94cec1eab97f41d94eb17d2b1f8
+  data.tar.gz: e7e54c9cfa8cef4690f87dac22617f484dc214612ede1741aa47c94023cff38965132ea87c4a512800b2a19edeb50488288eaf63ac698d2c21a49d0714e58663

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 James Healy
+
+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,37 @@
+# lita-mailgun
+
+A lita plugin for interacting with mailgun.com.
+
+## Installation
+
+Add this gem to your lita installation by including the following line in your Gemfile:
+
+    gem "lita-mailgun"
+
+## Externally triggered events
+
+This handler can accept mailgun events and trigger a variety of activities as appropriate. To
+get started, use the mailgun web interface to configure a webhook that POSTs events to:
+
+    http://your-lita-bot.com/mailgun
+
+### Dropped Email Reports
+
+To print a warning when a high number of recent emails to a domain were
+dropped, edit your lita\_config.rb to include the following line.
+
+    config.handlers.mailgun_droppped_rate.channel_name = "channel-name"
+
+The warnings will look something like this:
+
+    [mailgun] [bigpond.net.au] 8/10 (80.0%) recent emails dropped
+
+## Chat commands
+
+This handler provides no additional chat commands. Yet.
+
+## TODO
+
+Possible ideas for new features, either via chat commands or externally triggered events:
+
+* maybe set a maximum period of time to store the event data?

data/lib/lita-mailgun.rb

@@ -0,0 +1,4 @@
+require "lita/mailgun"
+require "lita/mailgun_event"
+require "lita/mailgun_dropped_rate"
+require "lita/mailgun_dropped_rate_repository"

data/lib/lita/mailgun.rb

@@ -0,0 +1,21 @@
+require "lita"
+require "lita/mailgun_event"
+
+module Lita
+  module Handlers
+    # Receives buildkite webhooks and emits them onto the lita event bus
+    # so other handlers can do their thing
+    class Mailgun < Handler
+
+      http.post "/mailgun", :mailgun_event
+
+      def mailgun_event(request, response)
+        event = MailgunEvent.new(request.params)
+        robot.trigger(:mailgun_event, event: event)
+      end
+
+    end
+
+    Lita.register_handler(Mailgun)
+  end
+end

data/lib/lita/mailgun_dropped_rate.rb

@@ -0,0 +1,51 @@
+require "lita"
+require 'lita/mailgun_event'
+require 'lita-timing'
+
+module Lita
+  module Handlers
+    # Watch mailgun webhooks for successful and dropped deliveries, and report any domains
+    # with a high dropped rate
+    class MailgunDroppedRate < Handler
+      ONE_HOUR = 60 * 60
+      REPORTING_THRESHOLD = 50 # percent
+
+      config :channel_name
+
+      on :mailgun_event, :monitor_event
+
+      def monitor_event(payload)
+        event = payload[:event]
+
+        repository.record(event.recipient_domain, event.name.to_sym)
+
+        result = repository.dropped_rate(event.recipient_domain)
+        if result.dropped_rate > REPORTING_THRESHOLD
+          persistent_every(event.recipient_domain, ONE_HOUR) do
+            robot.send_message(target, result_to_message(result))
+          end
+        end
+      end
+
+      private
+
+      def result_to_message(result)
+        "[mailgun] [#{result.domain}] #{result.dropped}/#{result.total} (#{result.dropped_rate.to_s("F")}%) recent emails dropped"
+      end
+
+      def repository
+        @repository ||= MailgunDroppedRateRepository.new(redis)
+      end
+
+      def target
+        Source.new(room: Lita::Room.find_by_name(config.channel_name) || "general")
+      end
+
+      def persistent_every(name, seconds, &block)
+        Lita::Timing::RateLimit.new(name, redis).once_every(seconds, &block)
+      end
+    end
+
+    Lita.register_handler(MailgunDroppedRate)
+  end
+end

data/lib/lita/mailgun_dropped_rate_repository.rb

@@ -0,0 +1,59 @@
+require "ostruct"
+require "bigdecimal"
+
+module Lita
+  class MailgunDroppedRateRepository
+    VALID_EVENTS = [:delivered, :dropped]
+
+    class DroppedResult
+      attr_reader :domain, :dropped, :total
+
+      def initialize(domain, dropped, total)
+        @domain, @dropped, @total = domain, dropped.to_i, total.to_i
+      end
+
+      def dropped_rate
+        (BigDecimal.new(dropped) / BigDecimal.new(total) * 100).round(3)
+      end
+    end
+
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def record(domain, event_name)
+      return false unless valid_event?(event_name)
+
+      key = "events-#{domain}"
+      @redis.rpush(key, event_name.to_s)
+      @redis.ltrim(key, -20, -1)
+      true
+    end
+
+    def dropped_rate(domain)
+      DroppedResult.new( domain, dropped_count(domain), total_count(domain) )
+    end
+
+    private
+
+    def dropped_count(domain)
+      fetch_events(domain).select { |item|
+        item == "dropped".freeze
+      }.size
+    end
+
+    def total_count(domain)
+      fetch_events(domain).size
+    end
+
+    def fetch_events(domain)
+      key = "events-#{domain}"
+
+      list = @redis.lrange(key, 0, 19)
+    end
+
+    def valid_event?(event_name)
+      VALID_EVENTS.include?(event_name)
+    end
+  end
+end

data/lib/lita/mailgun_event.rb

@@ -0,0 +1,22 @@
+module Lita
+  class MailgunEvent
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def name
+      @data.fetch("event")
+    end
+
+    def recipient
+      @data.fetch("recipient")
+    end
+
+    def recipient_domain
+      recipient.split("@").last
+    end
+
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: lita-mailgun
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-14 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rdoc
+  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: lita
+  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: lita-timing
+  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: Lita handler for interacting with mailgun.com
+email:
+- james.healy@theconversation.edu.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.md
+- lib/lita-mailgun.rb
+- lib/lita/mailgun.rb
+- lib/lita/mailgun_dropped_rate.rb
+- lib/lita/mailgun_dropped_rate_repository.rb
+- lib/lita/mailgun_event.rb
+homepage: http://github.com/conversation/lita-mailgun
+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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Lita handler for interacting with mailgun.com
+test_files: []