slackbotsy 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c40530baa2cbf344531ba32950fe1c2b1f3c1ed6
-  data.tar.gz: acc61a5f661831bb501d9fd33f303d9ae25b8ef8
+  metadata.gz: ce0da4a7d0888d5db3de53e15e4735fa5c4964bf
+  data.tar.gz: de9207d9d5a94e91d4efdb28c66a1d9164161dbd
 SHA512:
-  metadata.gz: 97e455f623816eb93d5cdb6435aea9817d07210ac9559b1f9ed8ea24d8275cb6556acd682f0de75d0d9338abe43ae03e558fd3c487282ef311a5f00d2b07ed04
-  data.tar.gz: 72ebca4cee87da780f60ac9d6389502824bab6e9692fb0561f0b7dbfed4c702aa6a411cbbf527b574dbd6c80bb63e54719e3412988f3877e2dfc4be72b769e86
+  metadata.gz: f6bd18dec8b80138b81ac4bab5386cead3eaf6df8c81b971777a68ab6fc7c4a607a3ac14351afa22d37ed8008c5b842dfcb7f87677443a976b05db4710ea8450
+  data.tar.gz: dcec448b9a05d8006071ba52656d75665fb24807ef093854c9f38e63fc294315bbabbcf724775915914a6117d2e84dcafcf5dd755b4278e92c27ef5b97950abb

data/README.md

@@ -1,6 +1,18 @@
 # Slackbotsy
 
-Ruby bot for Slack chat, inspired by http://github.com/seejohnrun/botsy.
+Ruby bot library for Slack chat, inspired by
+the Campfire bot http://github.com/seejohnrun/botsy.
+
+## Working example
+
+This repo and gem provide a library for implementing slack botsy using
+the web framework of your choice. For example, botsy could be embedded
+into an existing Rails app to provide access to a database from slack.
+
+For a fully-implemented and ready-to-deploy standalone bot, using
+slackbotsy and sinatra, please proceed over to
+https://github.com/rlister/slackbotsy_example. You will find full
+instructions to configure and deploy your own bot.
 
 ## Installation
 
@@ -64,3 +76,35 @@ post '/' do
   bot.handle_item(params)
 end
 ```
+
+## Web API
+
+slackbotsy can now post to Slack using the
+[Slack Web API](https://api.slack.com/web). It may be used alongside
+the incoming webhooks to post.
+
+Create a Slack user in your team for your bot, then create an api
+token for that user at https://api.slack.com/web, and set the config
+variable `api_token` when you configure botsy. Then you may use the
+`post_message` or `upload` convenience methods to post simple messages
+or upload files/text-snippets.
+
+```ruby
+config = {
+  'channel'   => '#default',
+  'name'      => 'botsy',
+  'api_token' => 'xoxp-0123456789-0123456789-0123456789-d34db33f'
+}
+
+bot = Slackbotsy::Bot.new(config) do
+
+  hear /ping/ do
+    post_message 'this is a simple posted message', channel: '#general'
+  end
+
+  hear /upload/ do
+    upload(file: File.new('/tmp/kitten.jpg'), channel: '#general')
+  end
+
+end
+```

data/lib/slackbotsy/api.rb

@@ -0,0 +1,59 @@
+require 'httmultiparty'
+
+module Slackbotsy
+
+  class Api
+    include HTTMultiParty
+    base_uri 'https://slack.com/api'
+
+    def initialize(token)
+      @token = token
+    end
+
+    ## get a channel, group, im or user list
+    def get_objects(method, key)
+      self.class.get("/#{method}", query: { token: @token }).tap do |response|
+        raise "error retrieving #{key} from #{method}: #{response.fetch('error', 'unknown error')}" unless response['ok']
+      end.fetch(key)
+    end
+
+    def channels
+      @channels ||= get_objects('channels.list', 'channels')
+    end
+
+    def groups
+      @groups ||= get_objects('groups.list', 'groups')
+    end
+
+    def ims
+      @ims ||= get_objects('im.list', 'ims')
+    end
+
+    def users
+      @users ||= get_objects('users.list', 'members')
+    end
+
+    ## join a channel, needed to post to channel
+    def join(channel)
+      self.class.post('/channels.join', body: {name: channel, token: @token}).tap do |response|
+        raise "error posting message: #{response.fetch('error', 'unknown error')}" unless response['ok']
+      end
+    end
+
+    ## send message to one channel as a single post with params text, channel, as_user
+    def post_message(params)
+      self.class.post('/chat.postMessage', body: params.merge({token: @token})).tap do |response|
+        raise "error posting message: #{response.fetch('error', 'unknown error')}" unless response['ok']
+      end
+    end
+
+    ## upload a file or text snippet, with params file, filename, filetype, title, initial_comment, channels
+    def upload(params)
+      self.class.post('/files.upload', body: params.merge({token: @token})).tap do |response|
+        raise "error uploading file: #{response.fetch('error', 'unknown error')}" unless response['ok']
+      end
+    end
+
+  end
+
+end

data/lib/slackbotsy/bot.rb

@@ -7,14 +7,14 @@ require 'set'
 module Slackbotsy
 
   class Bot
-
-    attr_accessor :listeners, :last_description
+    attr_accessor :listeners, :last_description, :api
 
     def initialize(options, &block)
       @options = options
       @listeners = []
       @options['outgoing_token'] = parse_outgoing_tokens(@options['outgoing_token'])
       setup_incoming_webhook                # http connection for async replies
+      setup_web_api                         # setup slack Web API
       instance_eval(&block) if block_given? # run any hear statements in block
     end
 
@@ -33,7 +33,14 @@ module Slackbotsy
       @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
     end
 
-    ## raw post of hash to slack
+    ## use api_token to setup Web API authentication
+    def setup_web_api
+      if @options['api_token']
+        @api = Api.new(@options['api_token'])
+      end
+    end
+
+    ## raw post of hash to slack webhook
     def post(options)
       payload = {
         username: @options['name'],
@@ -57,6 +64,30 @@ module Slackbotsy
       post({ attachments: attachments }.merge(options))
     end
 
+    ## simple wrapper on api.post_message (which calls chat.postMessage)
+    def post_message(text, options = {})
+      payload = {
+        username: @options['name'],
+        channel:  @options['channel'],
+        text:     text,
+        as_user:  true
+      }.merge(options)
+      payload[:channel] = payload[:channel].gsub(/^#?/, '#') # chat.postMessage needs leading # on channel
+      @api.join(payload[:channel])
+      @api.post_message(payload)
+    end
+
+    ## simple wrapper on api.upload (which calls files.upload)
+    ## pass 'channel' as a csv list of channel names, otherwise same args as files.upload
+    def upload(options)
+      payload = options
+      channels = @api.channels # list of channel objects
+      payload[:channels] ||= (options.fetch(:channel, @options['channel'])).split(/[\s,]+/).map do |name|
+        channels.find { |c| name.match(/^#?#{c['name']}$/) }.fetch('id') # convert channel id to name
+      end.join(',')
+      @api.upload(payload)
+    end
+
     ## record a description of the next hear block, for use in help
     def desc(command, description = nil)
       @last_desc = [ command, description ]

data/lib/slackbotsy/version.rb

@@ -1,3 +1,3 @@
 module Slackbotsy
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/slackbotsy.rb

@@ -1,5 +1,6 @@
 require "slackbotsy/version"
 require "slackbotsy/bot"
+require "slackbotsy/api"
 require "slackbotsy/helper"
 require "slackbotsy/message"
 

data/slackbotsy.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'json'
   spec.add_dependency 'sinatra'
+  spec.add_dependency 'httmultiparty'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slackbotsy
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Richard Lister
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-08 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  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'
 description: Ruby bot for Slack chat.
 email:
 - rlister@gmail.com
@@ -79,6 +93,7 @@ files:
 - README.md
 - Rakefile
 - lib/slackbotsy.rb
+- lib/slackbotsy/api.rb
 - lib/slackbotsy/bot.rb
 - lib/slackbotsy/helper.rb
 - lib/slackbotsy/message.rb
@@ -104,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby bot for Slack chat.