lita-slack-handler 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5069dda33ad4e37ed62c5bb41f3b229a0e08d721
+  data.tar.gz: c2c56ed04d8fd09c0f6c1f7b2e92bcc1a2d91a0f
+SHA512:
+  metadata.gz: ceb51b4b012fe77cdb9e3d0f0f290305c9b505a4d3884c580ee37d83478a7de7911504a096fb4e49cc80a638fe377198b0eb66a3a9f9f964de0a55fce9374b9d
+  data.tar.gz: 39e649c5e54076d8bb8983c87eb59f5ef16705f1c5434c8bcd6d37891dd314ce65a585de4c8f0d7360cf304b869fc38ef7b52c4cea390c59365b1b0cd913b4b4

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 kenjij
+
+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,63 @@
+# lita-slack-handler
+
+**lita-hipchat-handler** is a handler for [Lita](https://github.com/jimmycuadra/lita) that allows you to use the robot with [Slack](https://slack.com/). This handler complements [lita-slack](https://github.com/kenjij/lita-slack) adapter gem.
+**lita-hipchat-handler** sets up an HTTP route to accept messages from Slack:Outgoing WebHooks integrations, then feeds it into Lita.
+This handler, otherwise, does nothing by itself; i.e., it does not produce any replies.
+
+## Installation
+
+Add **lita-slack-handler** to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-slack-handler"
+```
+
+But most likely, you'd be adding **lita-slack** gem as well:
+
+``` ruby
+gem "lita-slack"
+gem "lita-slack-handler"
+```
+
+## Configuration
+
+**First, you need to make sure your Slack team has [Outgoing WebHooks](https://my.slack.com/services/new/outgoing-webhook) integration setup with the correct Trigger Word(s) and URL:**
+
+```
+http://<Lita_server>:<Lita_port>/lita/slack-handler
+```
+
+Then, define the following attributes:
+
+### Required attributes
+
+* `webhook_token` (String) – Slack integration token.
+* `team_domain` (String) – Slack team domain; subdomain of slack.com.
+
+### Example lita_config.rb
+
+``` ruby
+Lita.configure do |config|
+  config.robot.name = "Lita"
+  # mention_name should match Slack integration Trigger Word
+  config.robot.mention_name = "@lita"
+  config.robot.alias = "lita"
+  # Most likely you'll be using with the Slack adapter
+  config.robot.adapter = :slack
+  # Lita's HTTP port is used for Slack integration
+  config.http.port = 8080
+  # lita-slack-handler config
+  config.handlers.slack_handler.webhook_token = "aN1NvAlIdDuMmYt0k3n"
+  config.handlers.slack_handler.team_domain = "example"
+  # Some more adapter and other config
+  # .....
+end
+```
+
+## Usage
+
+None. **lita-slack-handler** just takes messages from Slack and feeds it into Lita.
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

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/slack_handler.rb

@@ -0,0 +1,84 @@
+require "lita"
+
+module Lita
+	module Handlers
+		class SlackHandler < Handler
+			# Lita HTTPRoute for Slack: Outgoing WebHook integration
+			http.post '/lita/slack-handler', :receive
+
+			# Class method called by Lita for handler configuration
+			def self.default_config(default)
+				# Slack:Outgoing WebHook integration token
+				default.webhook_token = nil
+				default.team_domain = nil
+			end
+			
+			def receive(req, res)
+				# For security, do not run with missing config
+				if not config_valid?
+					res.status = 500
+					return
+				end
+				log.debug 'SlackHandler::receive started'
+				# Validate request
+				if not request_valid?(req)
+					res.status = 403
+					return
+				end
+				res.status = 200
+				log.debug "SlackHandler::receive webhook_token:#{req['token']} team_domain:#{req['team_domain']}"
+				log.debug "SlackHandler::receive user id:#{req['user_id']} name:#{req['user_name']}"
+				log.debug "SlackHandler::receive room id:#{req['channel_id']} name:#{req['channel_name']}"
+				log.debug "SlackHandler::receive message text size #{req['text'].size} byte(s)"
+				user = User.create(req['user_id'], name: req['user_name'], mention_name: req['user_name'])
+				# Register channel using Lita::User class
+				room = User.create(req['channel_id'], name: req['channel_name'])
+				source = Source.new(user: user, room: room.id)
+				message = Message.new(robot, req['text'], source)
+				# Route the message to the adapter
+				log.info 'SlackHandler::receive routing message to the adapter'
+				robot.receive message
+				log.debug 'SlackHandler::receive ending'
+			end
+
+			def config_valid?
+				valid = true
+				if config.webhook_token.nil?
+					log.error 'SlackHandler: refuse to run; missing config "webhook_token"'
+					valid = false
+				end
+				if config.team_domain.nil?
+					log.error 'SlackHandler: refuse to run; missing "team_domain"'
+					valid = false
+				end
+				return valid
+			end
+
+			def request_valid?(req)
+				valid = true
+				if req['token'] != config.webhook_token
+					log.warn "SlackHandler: ignoring request; token does not match (received:#{req['token']})"
+					valid = false
+				end
+				if req['team_domain'] != config.team_domain
+					log.warn "SlackHandler: ignoring request; team domain does not match (received:#{req['team_domain']})"
+					valid = false
+				end
+				return valid
+			end
+
+			#
+			# Accessor shortcuts
+			#
+			def log
+				Lita.logger
+			end
+			
+			def config
+				Lita.config.handlers.slack_handler
+			end
+		end
+	
+		Lita.register_handler(SlackHandler)
+	end
+end

data/lib/lita-slack-handler.rb

@@ -0,0 +1 @@
+require "lita/handlers/slack_handler"

data/lita-slack-handler.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-slack-handler"
+  spec.version       = "0.2.0"
+  spec.authors       = ["Ken J."]
+  spec.email         = ["kenjij@gmail.com"]
+  spec.description   = %q{Lita handler for Slack}
+  spec.summary       = %q{Lita handler for Slack; complement lita-slack adapter gem.}
+  spec.homepage      = "https://github.com/kenjij/lita-slack-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", "~> 2.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14"
+end

data/spec/lita/handlers/slack_handler_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Lita::Handlers::SlackHandler, lita_handler: true do
+	http_route_path = '/lita/slack-handler'
+	req = {}
+	
+	it "registers with Lita" do
+		expect(Lita.handlers).to include(described_class)
+	end
+
+	it "registers HTTP route POST #{http_route_path} to :receive" do
+		expect(described_class.http_routes[0].http_method).to eql('POST')
+		expect(described_class.http_routes[0].path).to eql(http_route_path)
+		expect(described_class.http_routes[0].method_name).to eql(:receive)
+	end
+
+	context "with valid config" do
+		before :each do
+		  Lita.config.handlers.slack_handler.webhook_token = "aN1NvAlIdDuMmYt0k3n"
+		  Lita.config.handlers.slack_handler.team_domain = "example"
+		end
+		
+		describe "#config_valid?" do
+			it 'returns true' do
+				expect(subject.config_valid?).to eql(true)
+			end
+		end
+		
+		describe "#request_valid?" do
+			it 'returns true with valid request' do
+				req['token'] = Lita.config.handlers.slack_handler.webhook_token
+				req['team_domain'] = Lita.config.handlers.slack_handler.team_domain
+				expect(subject.request_valid?(req)).to eql(true)
+			end
+		end
+
+		describe "#request_valid?" do
+			it 'returns false with invalid token request' do
+				req['token'] = 'fUnKyT0K3N'
+				req['team_domain'] = Lita.config.handlers.slack_handler.team_domain
+				expect(subject.request_valid?(req)).to eql(false)
+			end
+
+			it 'returns false with invalid team_domain request' do
+				req['token'] = Lita.config.handlers.slack_handler.webhook_token
+				req['team_domain'] = 'my'
+				expect(subject.request_valid?(req)).to eql(false)
+			end
+		end
+	end
+
+	context "without valid config" do
+		before :each do
+		  Lita.config.handlers.slack_handler.webhook_token = nil
+		  Lita.config.handlers.slack_handler.team_domain = nil
+		end
+		
+		describe "#config_valid?" do
+			it 'returns false' do
+				expect(subject.config_valid?).to eql(false)
+			end
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "lita-slack-handler"
+require "lita/rspec"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: lita-slack-handler
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ken J.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.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: 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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Lita handler for Slack
+email:
+- kenjij@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-slack-handler.rb
+- lib/lita/handlers/slack_handler.rb
+- lita-slack-handler.gemspec
+- spec/lita/handlers/slack_handler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kenjij/lita-slack-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.0.7
+signing_key: 
+specification_version: 4
+summary: Lita handler for Slack; complement lita-slack adapter gem.
+test_files:
+- spec/lita/handlers/slack_handler_spec.rb
+- spec/spec_helper.rb