lita-slack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 756bfd5bc0c402ad707500b2d06fe4131ae61414
+  data.tar.gz: ba2490c9f35bfbe7dda51dffb5d18da5c18b5bba
+SHA512:
+  metadata.gz: 99dd9b57499029f4feb8bd8624ed6c6f710c100f0b11cdcbb52ed9752516d6652a7e3b92e3ce3278299c604fb74b6a672bede4ea81b036af18605411dc3b58b6
+  data.tar.gz: bc4639ebffb94030a59873e206a7708945a5b4b304a6d2d53be946233f0c3254eb2c1d6937b7a2f777ae88ece3af6b7aab7a0b10492f44b60eebcaf414d77e96

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,50 @@
+# lita-slack
+
+**lita-slack** is an adapter for [Lita](https://github.com/jimmycuadra/lita) that allows you to use the robot with [Slack](https://slack.com/). As **lita-slack** is one way, robot messages to Slack, it depends on [lita-slack-handler](https://github.com/kenjij/lita-slack-handler) gem to receive messages from Slack.
+
+## Installation
+
+Add **lita-slack** and **lita-slack-handler** to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-slack"
+gem "lita-slack-handler"
+```
+
+## Configuration
+
+**First, you need to make sure your Slack team has [Incoming WebHooks](https://my.slack.com/services/new/incoming-webhook) integration setup. For configuration regarding lita-slack-handler, see its [README](https://github.com/kenjij/lita-slack-handler).**
+
+Then, define the following attributes:
+
+### Required attributes
+
+* `incoming_token` (String) – Slack integration token.
+* `team_domain` (String) – Slack team domain; subdomain of slack.com.
+
+### Optional attributes
+
+* `incoming_url` (String) – Default: https://<team_domain>.slack.com/services/hooks/incoming-webhook
+* `username` (String) – Display name of the robot; default: whatever is set in Slack integration
+* `add_mention` (Bool) – Always prefix message with mention of the user which it's directed to; this triggers a notification.
+
+### Example lita_config.rb
+
+``` ruby
+Lita.configure do |config|
+  config.robot.name = "Lita"
+  config.robot.mention_name = "@lita"
+  # Select the Slack adapter
+  config.robot.adapter = :slack
+  # lita-slack adapter config
+  config.adapter.incoming_token = "aN1NvAlIdDuMmYt0k3n"
+  config.adapter.team_domain = "example"
+  config.adapter.username = "lita"
+  # Some more handlers and other config
+  # .....
+end
+```
+
+## 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-slack.rb

@@ -0,0 +1 @@
+require "lita/adapters/slack"

data/lib/lita/adapters/slack.rb

@@ -0,0 +1,86 @@
+require 'lita'
+require 'faraday'
+require 'json'
+
+module Lita
+	module Adapters
+		class Slack < Adapter
+			# Required Lita config keys (via lita_config.rb)
+			require_configs :incoming_token, :team_domain
+
+			def initialize(robot)
+				log.debug 'Slack::initialize started'
+				super
+				# Set config default values
+				config.incoming_url ||= "https://#{config.team_domain}.slack.com/services/hooks/incoming-webhook"
+				config.username ||= nil
+				config.add_mention ||= false
+				log.debug 'Slack::initialize ending'
+			end
+
+			# Adapter main run loop
+			def run
+				log.debug 'Slack::run started'
+				sleep
+				rescue Interrupt
+				shut_down
+			end
+			
+			def send_messages(target, strings)
+				log.debug 'Slack::send_messages started'
+				status = http_post prepare_payload(target, strings)
+				log.error "Slack::send_messages failed to send (#{status})" if status != 200
+				log.debug 'Slack::send_messages ending'
+			end
+			
+			def set_topic(target, topic)
+				# Slack currently provides no method
+				log.info 'Slack::set_topic no implementation'
+			end
+			
+			def shut_down
+			end
+			
+			def prepare_payload(target, strings)
+				if not defined?(target.room)
+					channel_id = nil
+					log.warn "Slack::prepare_payload proceeding without channel designation"
+				else
+					channel_id = target.room
+				end
+				payload = {'channel' => channel_id, 'username' => config.username}
+				payload['text'] = strings.join('\n')
+				if config.add_mention and defined?(target.user.id)
+					payload['text'] = payload['text'].prepend("<@#{target.user.id}> ")
+				end
+				return payload
+			end
+			
+			def http_post(payload)
+				res = Faraday.post do |req|
+					log.debug "Slack::http_post sending payload to #{config.incoming_url}; length: #{payload.to_json.size}"
+					req.url config.incoming_url, :token => config.incoming_token
+					req.headers['Content-Type'] = 'application/json'
+					req.body = payload.to_json
+				end
+				log.info "Slack::http_post sent payload with response status #{res.status}"
+				log.debug "Slack::http_post response body: #{res.body}"
+				return res.status
+			end
+
+			#
+			# Accessor shortcuts
+			#
+			def config
+				Lita.config.adapter
+			end
+			
+			def log
+				Lita.logger
+			end
+		end
+		
+		# Register Slack adapter to Lita
+		Lita.register_adapter(:slack, Slack)
+	end
+end

data/lita-slack.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-slack"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Ken J."]
+  spec.email         = ["kenjij@gmail.com"]
+  spec.description   = %q{Lita adapter for Slack}
+  spec.summary       = %q{Lita adapter for Slack using Sinatra. Requires lita-slack-handler gem.}
+  spec.homepage      = "https://github.com/kenjij/lita-slack"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "adapter" }
+
+  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_runtime_dependency "lita-slack-handler", "~> 0.2"
+  spec.add_runtime_dependency "faraday", ">= 0.8.7"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.14"
+end

data/spec/lita/adapters/slack_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Lita::Adapters::Slack do
+	before do
+		Lita.configure do |config|
+			config.adapter.incoming_token = 'aN1NvAlIdDuMmYt0k3n'
+			config.adapter.team_domain = 'example'
+			config.adapter.username = 'lita'
+			config.adapter.add_mention = true
+		end
+	end
+
+	subject { described_class.new(robot) }
+	let(:robot) { double("Lita::Robot") }
+
+	it "registers with Lita" do
+		expect(Lita.adapters[:slack]).to eql(described_class)
+	end
+	
+	it "fails without valid config: incoming_token and team_domain" do
+		Lita.clear_config
+		expect(Lita.logger).to receive(:fatal).with(/incoming_token, team_domain/)
+		expect { subject }.to raise_error(SystemExit)
+	end
+	
+	describe "#send_messages" do
+		it "sends JSON payload via HTTP POST to Slack channel" do
+			target = double("Lita::Source", room: "CR00M1D")
+			payload = {'channel' => target.room, 'username' => Lita.config.adapter.username, 'text' => 'Hello!'}
+			expect(subject).to receive(:http_post).with(payload)
+			subject.send_messages(target, ["Hello!"])
+		end
+
+		it "sends message with mention if user info is provided" do
+			user = double("Lita::User", id: "UM3NT10N")
+			target = double("Lita::Source", room: "CR00M1D", user: user)
+			text = "<@#{user.id}> Hello!"
+			payload = {'channel' => target.room, 'username' => Lita.config.adapter.username, 'text' => text}
+			expect(subject).to receive(:http_post).with(payload)
+			subject.send_messages(target, ["Hello!"])
+		end
+
+		it "proceeds but logs WARN when directed to an user without channel(room) info" do
+			user = double("Lita::User", id: "UM3NT10N")
+			target = double("Lita::Source", user: user)
+			text = "<@#{user.id}> Hello!"
+			payload = {'channel' => nil, 'username' => Lita.config.adapter.username, 'text' => text}
+			expect(subject).to receive(:http_post).with(payload)
+			expect(Lita.logger).to receive(:warn).with(/without channel/)
+			subject.send_messages(target, ["Hello!"])
+		end
+	end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: lita-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ken J.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 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: lita-slack-handler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.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 adapter for Slack
+email:
+- kenjij@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-slack.rb
+- lib/lita/adapters/slack.rb
+- lita-slack.gemspec
+- spec/lita/adapters/slack_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kenjij/lita-slack
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: adapter
+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 adapter for Slack using Sinatra. Requires lita-slack-handler gem.
+test_files:
+- spec/lita/adapters/slack_spec.rb
+- spec/spec_helper.rb