slack-bot-server 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08f9edd260732b19478908af280a1d3acf318190
-  data.tar.gz: 1a82cf329ca85099d093e6fb78090adebc44393f
+  metadata.gz: 8b273bf7f49d2acf1743f6ef74ac8e4ca3fc336d
+  data.tar.gz: a4b089d850c7a0cceef7fe9d1643ce4843831b5d
 SHA512:
-  metadata.gz: a4da0c83a05616f950969841c32b029ca7d60ffc79056fee1178011c31b5e748adf0f7e470772628524aa7e92db62a1521fe17bf30337d136f332558f833ec65
-  data.tar.gz: 951b05156d6d4365c4d0ef64b6ea8f460efc4b612dab3e9f39c58bfcd5479a49126aa08d41cd400845b174748d53583efe95ca88a4f2688a43367bf0b771b6f4
+  metadata.gz: 324c943e0ee722c366a08f5fb14e168b3f4145baf951c127bb9f82a5797236410552edbb6bb342da66b2abb41d79692066cab53ae86c4db5cb1335bbc1cfc06f
+  data.tar.gz: 1bfb87e6b026251971e0dd9a35b2601c37845c075910df809112a0c443bdeeafcb4be4cb4c9d5bc0f83daaeafe9defbeef8f6e89e9eea088d3a88396b1be5b36

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.3.0
+
+Changes:
+
+  - The `SlackBotServer::Server#on_new_proc` has been renamed to `Server#on_add`
+  - The `add` and `add_bot` methods on `SlackBotServer::Server` and `SlackBotServer::RemoteControl` control have been merged as `add_bot`
+  - Multiple arguments may be passed via the `add_bot` method to the block given to `SlackBotServer::on_add`

data/README.md

@@ -42,7 +42,7 @@ server = SlackBotServer::Server.new(queue: queue)
 
 # How your application-specific should be created when the server
 # is told about a new slack api token to connect with
-server.on_new_token do |token|
+server.on_add do |token|
   # Return a new bot instance to the server. `SimpleBot` is a provided
   # example bot with some very simple behaviour.
   SlackBotServer::SimpleBot.new(token: token)
@@ -100,10 +100,17 @@ queue = SlackBotServer::RedisQueue.new(Resque.redis)
 
 server = SlackBotServer::Server.new(queue: queue)
 
-server.on_new_token do |token|
+# The `on_add` block can take any number arguments - basically whatever
+# is passed to the `add_bot` method (see below). Since the bot will almost
+# certainly need to use a Slack API token to actually connect to Slack,
+# this should either be one of the arguments, or be retrievable using one
+# of the arguments.
+# It should return a bot (something that responds to `start`); if anything
+# else is returned, it will be ignored.
+server.on_add do |token, team_id|
   # Our bots need to know some data about the team they are connecting
   # to, like specifics of their account and their tasks
-  team_data = Harmonia.find_team_data_by_slack_api_token(token)
+  team_data = Harmonia.find_team_data(team_id)
 
   # Our bot instance stores that data in an instance variable internally
   # and then refers to it when it receives messages
@@ -112,8 +119,10 @@ end
 
 # When the server starts we need to find all the teams which have already
 # set up integrations and ensure their bots are launched immediately
-Harmonia.all_existing_slack_api_tokens.each do |token|
-  server.add_token(token)
+Harmonia.teams.each do |team|
+  # Any arguments can be passed to the `add_bot` method; they are passed
+  # on to the proc supplied to `on_add` for the server.
+  server.add_bot(team.slack_token, team.id)
 end
 
 # Actually start the server. The pre-loaded bots will connect immediately,
@@ -132,10 +141,10 @@ control to add the token to the server.
 # Somewhere within your application
 queue = SlackBotServer::RedisQueue.new(Redis.new)
 slack_remote = SlackBotServer::RemoteControl.new(queue: queue)
-slack_remote.add_token('user-accounts-slack-api-token')
+slack_remote.add_bot('user-accounts-slack-api-token')
 ```
 
-This will queue the token to be added by the server, using the `on_new_token` block provided in the server script.
+This will queue a bot be added by the server, using the `on_add` block provided in the server script.
 
 When a bot is created and added within the server, it is stored using a key, which the bot class itself can define, but defaults to the slack api token used to instantiate the bot.
 

data/lib/slack_bot_server/remote_control.rb

@@ -9,8 +9,8 @@ class SlackBotServer::RemoteControl
     @queue = queue
   end
 
-  def add_token(token)
-    @queue.push([:add_token, token])
+  def add_bot(*args)
+    @queue.push([:add_bot, *args])
   end
 
   def remove_bot(key)

data/lib/slack_bot_server/server.rb

@@ -8,12 +8,16 @@ class SlackBotServer::Server
   def initialize(queue: SlackBotServer::LocalQueue.new)
     @queue = queue
     @bots = {}
-    @new_token_proc = -> (token) { SlackBotServer::SimpleBot.new(token: token) }
+    @add_proc = -> (token) { SlackBotServer::SimpleBot.new(token: token) }
     @running = false
   end
 
-  def on_new_token(&block)
-    @new_token_proc = block
+  # Define the block which should be called when the `add_bot` method is
+  # called, or the `add_bot` message is sent via a queue. This block
+  # should return a bot (which responds to start), in which case it will
+  # be added and started. If anything else is returned, it will be ignored.
+  def on_add(&block)
+    @add_proc = block
   end
 
   def start
@@ -43,15 +47,13 @@ class SlackBotServer::Server
     @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
+  def add_bot(*args)
+    bot = @add_proc.call(*args)
+    if bot.respond_to?(:start)
+      log "adding bot #{bot}"
+      @bots[bot.key.to_sym] = bot
+      bot.start if @running
+    end
   rescue => e
     log_error(e)
   end
@@ -70,26 +72,25 @@ class SlackBotServer::Server
   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 :add_bot
+      log "adding bot: #{args.inspect}"
+      add_bot(*args)
     when :remove_bot
       key = args.first
       remove_bot(key)
     when :broadcast
       key, message_data = args
-      log "[#{key}] #{message_data}"
+      log "[#{key}] broadcast: #{message_data}"
       bot = bot(key)
       bot.broadcast(message_data)
     when :say
       key, message_data = args
-      log "[#{key}] #{message_data}"
+      log "[#{key}] say: #{message_data}"
       bot = bot(key)
       bot.say(message_data)
     when :say_to
       key, user_id, message_data = args
-      log "[#{key}] (#{user_id}) #{message_data}"
+      log "[#{key}] say_to: (#{user_id}) #{message_data}"
       bot = bot(key)
       bot.say_to(user_id, message_data)
     when :call

data/lib/slack_bot_server/version.rb

@@ -1,3 +1,3 @@
 module SlackBotServer
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-bot-server
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - James Adam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-api
@@ -119,6 +119,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A server for hosting slack bots.