lita-visitor-notification-handler 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37ff9bc4df49f4ce7e318888008fc971f1dae65e
+  data.tar.gz: 90a875303a0214f9afdfe3429d1f6d483c372a4e
+SHA512:
+  metadata.gz: 8fe2f01c81df1fc4aaf808ede67372eed45675aeaafb3138aa8484f39a8bb0a9a2875d4b9480078d449b1ab64fb19eff6a38f7c00f928caae82f1b47d55328f0
+  data.tar.gz: 378bbcafefe056f3eb151d9e6bb26340f8e343687e84c7fbd45d6ac76fd3380f9ea0355db836177d5a9bb482a64660d21d9318d6a7a580da60db909eccd1a7e7

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,5 @@
+language: ruby
+services:
+  - redis-server
+rvm:
+  - 2.1.5

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Envoy
+
+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,48 @@
+# lita-visitor-notification-handler
+
+[![Build Status](https://travis-ci.org/envoy/lita-visitor-notification-handler.svg?branch=master)](https://travis-ci.org/envoy/lita-visitor-notification-handler)
+
+Lita handler for parsing Envoy visitor notification message
+
+## Installation
+
+Add lita-visitor-notification-handler to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-visitor-notification-handler"
+```
+
+## Configuration
+
+To make this handler send a post request to your webhook, you can specify `webhook_url`
+
+```ruby
+Lita.configure do |config|
+  config.handlers.visitor_notification_handler.webhook_url = 'http://my-webhook.com'
+end
+```
+
+If you need extra headers for the post request, you can also use `webhook_headers` to specify it.
+
+
+## Usage
+
+This handler monitors private messages to it, when it sees Envoy visitor notification message, it parses it and reply the extracted data
+
+```
+Envoy ッ:
+Hello! John Doe is here without a specified host at the Envoy front desk.
+
+Lita bot:
+{"guest_name":"John Doe","location_name":"Envoy"}
+```
+
+It also makes a post request callback to the webhook you provided, the body will be JSON in this format
+
+```JSON
+{
+    "host_name": "Host name",
+    "guest_name": "Visitor name",
+    "location_name": "Location name"
+}
+```

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-visitor-notification-handler.rb

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

data/lib/lita/handlers/visitor_notification_handler.rb

@@ -0,0 +1,43 @@
+require 'json'
+require 'httparty'
+
+module Lita
+  module Handlers
+    class VisitorNotificationHandler < Handler
+      # URL to webhook when we see a visitor noticiation
+      config :webhook_url
+      # header for webhook request
+      config :webhook_headers
+
+      route(/^(.+) is here to see you at (.+) - front desk\.$/, :notify_visitor)
+      route(/^(.+) is here at (.+) - front desk\.$/, :notify_visitor)
+
+      def notify_visitor(response)
+        groups = response.matches[0]
+        if groups.size == 2
+          notification = {
+            :guest_name => groups[0],
+            :location_name => groups[1],
+          }
+        else
+          notification = {
+            :host_name => groups[0],
+            :guest_name => groups[1],
+            :location_name => groups[2],
+          }
+        end
+        payload = notification.to_json
+        if config.webhook_url
+          resp = HTTParty.post(
+            config.webhook_url,
+            body: payload,
+            headers: config.webhook_headers,
+          )
+        end
+        response.reply(payload)
+      end
+    end
+
+    Lita.register_handler(VisitorNotificationHandler)
+  end
+end

data/lita-visitor-notification-handler.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-visitor-notification-handler"
+  spec.version       = "0.0.3"
+  spec.authors       = ["Victor Lin"]
+  spec.email         = ["victor@signwithenvoy.com"]
+  spec.summary       = "Lita handler for parsing Envoy visitor notification message"
+  spec.homepage      = "https://github.com/envoy/lita-visitor-notification-handler"
+  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.3"
+  spec.add_runtime_dependency "httparty"
+
+  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"
+end

data/locales/en.yml

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

data/spec/lita/handlers/visitor_notification_handler_spec.rb

@@ -0,0 +1,29 @@
+require 'json'
+require 'spec_helper'
+
+describe Lita::Handlers::VisitorNotificationHandler, lita_handler: true do
+  it { is_expected.not_to route('How are you doing') }
+  it { is_expected.not_to route('To code or not to code, that is a question') }
+  it { is_expected.not_to route('How do you turn this one?') }
+  it { is_expected.not_to route('YOLO') }
+  it { is_expected.not_to route('lol') }
+  it { is_expected.to route('foo bar is here to see you at Envoy - front desk.') }
+  it { is_expected.to route('af1c3a41-b65d-4ee5-8f07-4a76ffcd1528 is here to see you at Envoy - front desk.') }
+  it { is_expected.to route('0c984ee5-1e07-4344-b726-2a3e10284c32 is here at Envoy - front desk.') }
+  it { is_expected.to route('Foo bar is here at Envoy - front desk.') }
+
+  it 'consumes and replies message' do
+    send_message('foo bar is here to see you at Envoy - front desk.')
+    expect(JSON.parse(replies.last)).to eq({
+        'guest_name' => 'foo bar',
+        'location_name' => 'Envoy',
+    })
+  end
+  it 'consumes UUID guest name and replies message' do
+    send_message('af1c3a41-b65d-4ee5-8f07-4a76ffcd1528 is here to see you at Big Brother - front desk.')
+    expect(JSON.parse(replies.last)).to eq({
+        'guest_name' => 'af1c3a41-b65d-4ee5-8f07-4a76ffcd1528',
+        'location_name' => 'Big Brother',
+    })
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-visitor-notification-handler"
+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

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: lita-visitor-notification-handler
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Victor Lin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: 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
+description: 
+email:
+- victor@signwithenvoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-visitor-notification-handler.rb
+- lib/lita/handlers/visitor_notification_handler.rb
+- lita-visitor-notification-handler.gemspec
+- locales/en.yml
+- spec/lita/handlers/visitor_notification_handler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/envoy/lita-visitor-notification-handler
+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.1
+signing_key: 
+specification_version: 4
+summary: Lita handler for parsing Envoy visitor notification message
+test_files:
+- spec/lita/handlers/visitor_notification_handler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: