slack-bot-server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61c3888618c930da32157133af1fd57ac3a40123
+  data.tar.gz: 4f7c8adff1540e9162cef41f0ade4a2ee06aeb39
+SHA512:
+  metadata.gz: 051cc3a2f27714cf76559aab701dbdb2194eaba113376eb832d886b61116b3c5240c8bcf9beb3cac01c23ee7bc247c61838f234774f8ff9a64ac0c98fe76568f
+  data.tar.gz: 76c4c6ee283a948aa13330b0e237bbbbc1562013b0077903cb0d45fb44d5cb5c3c6219d1188361ef0104adc31a1613dfa9951b570cf2e3e52071fd6840e0e506

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slack_bot_server.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 James Adam
+
+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,41 @@
+# SlackBotServer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/slack_bot_server`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_bot_server'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack_bot_server
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec slack_bot_server` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slack_bot_server.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](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/slack_bot_server.rb

@@ -0,0 +1,11 @@
+require 'slack_bot_server/version'
+require 'slack_bot_server/server'
+require 'logger'
+
+module SlackBotServer
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end
+
+SlackBotServer.logger.level = Logger::INFO

data/lib/slack_bot_server/bot.rb

@@ -0,0 +1,189 @@
+require 'slack'
+require 'securerandom'
+
+class SlackBotServer::Bot
+  attr_reader :key
+
+  class InvalidToken < RuntimeError; end
+
+  def initialize(token:, key: SecureRandom.uuid)
+    @token = token
+    @key = key
+    @api = ::Slack::Client.new(token: @token)
+    @im_channel_ids = []
+
+    raise InvalidToken unless auth_test['ok']
+  end
+
+  def say(options)
+    @api.chat_postMessage(default_message_options.merge(options))
+  end
+
+  def reply(options)
+    channel = @last_received_data['channel']
+    @api.chat_postMessage(default_message_options.merge(options.merge(channel: channel)))
+  end
+
+  def say_to(user_id, options)
+    result = @api.im_open(user: user_id)
+    channel_id = result['channel']['id']
+    say(options.merge(channel: channel_id))
+  end
+
+  def call(method, args)
+    args.symbolize_keys!
+    @api.send(method, args)
+  end
+
+  def start
+    @ws = Faye::WebSocket::Client.new(websocket_url, nil, ping: 60)
+
+    @ws.on :open do |event|
+      log "connected to '#{team}'"
+      load_im_channels
+    end
+
+    @ws.on :message do |event|
+      begin
+        debug event
+        handle_message(event)
+      rescue => e
+        log error: e
+      end
+    end
+
+    @ws.on :close do |event|
+      log "disconnected"
+    end
+  end
+
+  def stop
+    log "closing connection"
+    @ws.close
+    log "closed"
+  end
+
+  class << self
+    def username(name)
+      default_message_options[:username] = name
+    end
+
+    def icon_url(url)
+      default_message_options[:icon_url] = url
+    end
+
+    def default_message_options
+      @default_message_options ||= {channel: '#general'}
+    end
+
+    def callbacks_for(type)
+      callbacks = @callbacks[type.to_sym] || []
+      if superclass.respond_to?(:callbacks_for)
+        callbacks += superclass.callbacks_for(type)
+      end
+      callbacks
+    end
+
+    def on(type, &block)
+      @callbacks ||= {}
+      @callbacks[type.to_sym] ||= []
+      @callbacks[type.to_sym] << block
+    end
+
+    def on_mention(&block)
+      on(:message) do |data|
+        if !bot_message?(data) &&
+           (data['text'] =~ /\A#{user}[\s\:](.*)/ ||
+            data['text'] =~ /\A<@#{user_id}>[\s\:](.*)/)
+          message = $1.strip
+          @last_received_data = data.merge('message' => message)
+          instance_exec(@last_received_data, &block)
+        end
+      end
+    end
+
+    def on_im(&block)
+      on(:message) do |data|
+        if is_im_channel?(data['channel']) && !bot_message?(data)
+          @last_received_data = data.merge('message' => data['text'])
+          instance_exec(@last_received_data, &block)
+        end
+      end
+    end
+  end
+
+  on :im_created do |data|
+    channel_id = data['channel']['id']
+    log "Adding new IM channel: #{channel_id}"
+    @im_channel_ids << channel_id
+  end
+
+  def to_s
+    "<#{self.class.name} key:#{key}>"
+  end
+
+  private
+
+  def handle_message(event)
+    data = MultiJson.load(event.data)
+    if data["type"]
+      relevant_callbacks = self.class.callbacks_for(data["type"])
+      if relevant_callbacks && relevant_callbacks.any?
+        relevant_callbacks.each do |c|
+          instance_exec(data, &c)
+        end
+      end
+    end
+  end
+
+  def log(message)
+    text = message.is_a?(String) ? message : message.inspect
+    text = "[BOT/#{user}] #{text}"
+    SlackBotServer.logger.info(message)
+  end
+
+  def debug(message)
+    text = message.is_a?(String) ? message : message.inspect
+    text = "[BOT/#{user}] #{text}"
+    SlackBotServer.logger.debug(message)
+  end
+
+  def user
+    auth_test['user']
+  end
+
+  def user_id
+    auth_test['user_id']
+  end
+
+  def team
+    auth_test['team']
+  end
+
+  def auth_test
+    @auth_test ||= @api.auth_test
+  end
+
+  def load_im_channels
+    log "Loading IM channels"
+    result = @api.im_list
+    @im_channel_ids = result['ims'].map { |d| d['id'] }
+    log im_channels: @im_channel_ids
+  end
+
+  def is_im_channel?(id)
+    @im_channel_ids.include?(id)
+  end
+
+  def bot_message?(data)
+    data['subtype'] == 'bot_message'
+  end
+
+  def websocket_url
+    @api.post('rtm.start')['url']
+  end
+
+  def default_message_options
+    self.class.default_message_options
+  end
+end

data/lib/slack_bot_server/local_queue.rb

@@ -0,0 +1,14 @@
+class SlackBotServer::LocalQueue
+  def initialize
+    @queue = Queue.new
+  end
+
+  def push(value)
+    @queue << value
+  end
+
+  def pop
+    value = @queue.pop(true) rescue ThreadError
+    value == ThreadError ? nil : value
+  end
+end

data/lib/slack_bot_server/redis_queue.rb

@@ -0,0 +1,22 @@
+require 'multi_json'
+
+class SlackBotServer::RedisQueue
+  def initialize(redis)
+    @key = 'slack_bot_server:queue'
+    @redis = redis
+  end
+
+  def push(value)
+    @redis.rpush @key, MultiJson.dump(value)
+  end
+
+  def pop
+    json_value = @redis.lpop @key
+    if json_value
+      MultiJson.load(json_value)
+    else
+      nil
+    end
+  end
+end
+

data/lib/slack_bot_server/remote_control.rb

@@ -0,0 +1,23 @@
+# Send commands to a running SlackBotServer::Server instance
+#
+# This should be initialized with a queue that is shared with the
+# targetted server (e.g. the same local queue instance, or a
+# redis queue instance that points at the same redis server).
+
+class SlackBotServer::RemoteControl
+  def initialize(queue)
+    @queue = queue
+  end
+
+  def add_token(token)
+    @queue.push([:add_token, token])
+  end
+
+  def remove_bot(key)
+    @queue.push([:remove_bot, key])
+  end
+
+  def call(key, method, args)
+    @queue.push([:call, [key, method, args]])
+  end
+end

data/lib/slack_bot_server/server.rb

@@ -0,0 +1,98 @@
+require 'slack_bot_server/bot'
+require 'slack_bot_server/simple_bot'
+require 'slack_bot_server/redis_queue'
+
+class SlackBotServer::Server
+  attr_reader :queue
+
+  def initialize(queue: SlackBotServer::LocalQueue.new)
+    @queue = queue
+    @bots = {}
+    @new_token_proc = -> (token) { SlackBotServer::SimpleBot.new(token: token) }
+    @running = false
+  end
+
+  def on_new_token(&block)
+    @new_token_proc = block
+  end
+
+  def start
+    EM.run do
+      @running = true
+      @bots.each { |key, bot| bot.start }
+      add_timers
+    end
+  end
+
+  def add_timers
+    EM.add_periodic_timer(1) do
+      begin
+        next_message = queue.pop
+        process_instruction(next_message) if next_message
+      rescue => e
+        log_error(e)
+      end
+    end
+  end
+
+  def start_in_background
+    Thread.start { start }
+  end
+
+  def bot(key)
+    @bots[key.to_sym]
+  end
+
+  def add_bot(bot)
+    log "adding bot #{bot}"
+    @bots[bot.key.to_sym] = bot
+    bot.start if @running
+  end
+
+  def add_token(token)
+    bot = @new_token_proc.call(token)
+    add_bot(bot) if bot
+  rescue => e
+    log_error(e)
+  end
+
+  def remove_bot(key)
+    if (bot = bot(key))
+      bot.stop
+      @bots.delete(key.to_sym)
+    end
+  rescue => e
+    log_error(e)
+  end
+
+  private
+
+  def process_instruction(instruction)
+    type, *args = instruction
+    case type.to_sym
+    when :add_token
+      token = args.first
+      log "got new token: '#{token}'"
+      add_token(token)
+    when :remove_bot
+      key = args.first
+      remove_bot(key)
+    when :call
+      key, method, method_args = args
+      bot = bot(key)
+      bot.call(method, method_args)
+    else
+      log unknown_command: instruction
+    end
+  end
+
+  def log(message)
+    text = message.is_a?(String) ? message : message.inspect
+    SlackBotServer.logger.info(text)
+  end
+
+  def log_error(e)
+    SlackBotServer.logger.warn("Error in server: #{e} - #{e.message}")
+    SlackBotServer.logger.warn(e.backtrace.join("\n"))
+  end
+end

data/lib/slack_bot_server/simple_bot.rb

@@ -0,0 +1,13 @@
+require 'slack_bot_server/bot'
+
+class SlackBotServer::SimpleBot < SlackBotServer::Bot
+  username 'SimpleBot'
+
+  on_mention do |data|
+    reply text: "You said '#{data['message']}', and I'm frankly fascinated."
+  end
+
+  on_im do
+    reply text: "Hmm, OK, let me get back to you about that."
+  end
+end

data/lib/slack_bot_server/version.rb

@@ -0,0 +1,3 @@
+module SlackBotServer
+  VERSION = "0.1.0"
+end

data/slack_bot_server.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack_bot_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack-bot-server"
+  spec.version       = SlackBotServer::VERSION
+  spec.authors       = ["James Adam"]
+  spec.email         = ["james@lazyatom.com"]
+
+  spec.summary       = %q{A server for hosting slack bots.}
+  spec.description   = %q{This software lets you write and host multiple slack bots, potentially for multiple different teams or even services.}
+  spec.homepage      = "https://github.com/lazyatom/slack-bot-server"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "slack-api", "~> 1.1"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-eventmachine"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: slack-bot-server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Adam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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-eventmachine
+  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: This software lets you write and host multiple slack bots, potentially
+  for multiple different teams or even services.
+email:
+- james@lazyatom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/slack_bot_server.rb
+- lib/slack_bot_server/bot.rb
+- lib/slack_bot_server/local_queue.rb
+- lib/slack_bot_server/redis_queue.rb
+- lib/slack_bot_server/remote_control.rb
+- lib/slack_bot_server/server.rb
+- lib/slack_bot_server/simple_bot.rb
+- lib/slack_bot_server/version.rb
+- slack_bot_server.gemspec
+homepage: https://github.com/lazyatom/slack-bot-server
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A server for hosting slack bots.
+test_files: []