slack-ruby-client 0.4.0 → 0.5.0

data/bin/commands/rtm.rb

@@ -0,0 +1,15 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Rtm methods.'
+command 'rtm' do |g|
+  g.desc 'This method starts a Real Time Messaging API session. Refer to the'
+  g.long_desc %( This method starts a Real Time Messaging API session. Refer to the RTM API documentation for full details on how to use the RTM API. )
+  g.command 'start' do |c|
+    c.flag 'simple_latest', desc: 'Return timestamp only for latest message object of each channel (improves performance).'
+    c.flag 'no_unreads', desc: 'Skip unread counts for each channel (improves performance).'
+    c.flag 'mpim_aware', desc: 'Returns MPIMs to the client in the API response.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.rtm_start(options))
+    end
+  end
+end

data/bin/commands/search.rb

@@ -0,0 +1,40 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc "Search your team's files and messages."
+command 'search' do |g|
+  g.desc 'This method allows to to search both messages and files in a single call.'
+  g.long_desc %( This method allows to to search both messages and files in a single call. )
+  g.command 'all' do |c|
+    c.flag 'query', desc: 'Search query. May contains booleans, etc.'
+    c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
+    c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
+    c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.search_all(options))
+    end
+  end
+
+  g.desc 'This method returns files matching a search query.'
+  g.long_desc %( This method returns files matching a search query. )
+  g.command 'files' do |c|
+    c.flag 'query', desc: 'Search query. May contain booleans, etc.'
+    c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
+    c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
+    c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.search_files(options))
+    end
+  end
+
+  g.desc 'This method returns messages matching a search query.'
+  g.long_desc %( This method returns messages matching a search query. )
+  g.command 'messages' do |c|
+    c.flag 'query', desc: 'Search query. May contains booleans, etc.'
+    c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
+    c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
+    c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.search_messages(options))
+    end
+  end
+end

data/bin/commands/stars.rb

@@ -0,0 +1,37 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Stars methods.'
+command 'stars' do |g|
+  g.desc 'This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.'
+  g.long_desc %( This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified. )
+  g.command 'add' do |c|
+    c.flag 'file', desc: 'File to add star to.'
+    c.flag 'file_comment', desc: 'File comment to add star to.'
+    c.flag 'channel', desc: 'Channel to add star to, or channel where the message to add star to was posted (used with timestamp).'
+    c.flag 'timestamp', desc: 'Timestamp of the message to add star to.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.stars_add(options))
+    end
+  end
+
+  g.desc 'This method lists the items starred by a user.'
+  g.long_desc %( This method lists the items starred by a user. )
+  g.command 'list' do |c|
+    c.flag 'user', desc: 'Show stars by this user. Defaults to the authed user.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.stars_list(options))
+    end
+  end
+
+  g.desc 'This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.'
+  g.long_desc %( This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user. One of file, file_comment, channel, or the combination of channel and timestamp must be specified. )
+  g.command 'remove' do |c|
+    c.flag 'file', desc: 'File to remove star from.'
+    c.flag 'file_comment', desc: 'File comment to remove star from.'
+    c.flag 'channel', desc: 'Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).'
+    c.flag 'timestamp', desc: 'Timestamp of the message to remove star from.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.stars_remove(options))
+    end
+  end
+end

data/bin/commands/team.rb

@@ -0,0 +1,32 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Team methods.'
+command 'team' do |g|
+  g.desc 'This method is used to get the access logs for users on a team.'
+  g.long_desc %( This method is used to get the access logs for users on a team. )
+  g.command 'accessLogs' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.team_accessLogs(options))
+    end
+  end
+
+  g.desc 'This method provides information about your team.'
+  g.long_desc %( This method provides information about your team. )
+  g.command 'info' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.team_info(options))
+    end
+  end
+
+  g.desc 'This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.'
+  g.long_desc %( This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins. )
+  g.command 'integrationLogs' do |c|
+    c.flag 'service_id', desc: 'Filter logs to this service. Defaults to all logs.'
+    c.flag 'app_id', desc: 'Filter logs to this API application. Defaults to all logs.'
+    c.flag 'user', desc: "Filter logs generated by this user's actions. Defaults to all logs."
+    c.flag 'change_type', desc: 'Filter logs with this change type. Defaults to all logs.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.team_integrationLogs(options))
+    end
+  end
+end

data/bin/commands/usergroups.rb

@@ -0,0 +1,73 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc "Get info on your team's user groups."
+command 'usergroups' do |g|
+  g.desc 'This method is used to create a user group.'
+  g.long_desc %( This method is used to create a user group. )
+  g.command 'create' do |c|
+    c.flag 'name', desc: 'A name for the user group. Must be unique among user groups.'
+    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and user groups.'
+    c.flag 'description', desc: 'A short description of the user group.'
+    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the user group uses as a default.'
+    c.flag 'include_count', desc: 'Include the number of users in each user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_create(options))
+    end
+  end
+
+  g.desc 'This method disables an existing user group.'
+  g.long_desc %( This method disables an existing user group. )
+  g.command 'disable' do |c|
+    c.flag 'usergroup', desc: 'The encoded ID of the user group to disable.'
+    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_disable(options))
+    end
+  end
+
+  g.desc 'This method enables a user group which was previously disabled.'
+  g.long_desc %( This method enables a user group which was previously disabled. )
+  g.command 'enable' do |c|
+    c.flag 'usergroup', desc: 'The encoded ID of the user group to enable.'
+    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_enable(options))
+    end
+  end
+
+  g.desc 'This method returns a list of all user groups in the team. This can optionally include disabled user groups.'
+  g.long_desc %( This method returns a list of all user groups in the team. This can optionally include disabled user groups. )
+  g.command 'list' do |c|
+    c.flag 'include_disabled', desc: 'Include disabled user groups.'
+    c.flag 'include_count', desc: 'Include the number of users in each user group.'
+    c.flag 'include_users', desc: 'Include the list of users for each user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_list(options))
+    end
+  end
+
+  g.desc 'This method updates the properties of an existing user group.'
+  g.long_desc %( This method updates the properties of an existing user group. )
+  g.command 'update' do |c|
+    c.flag 'usergroup', desc: 'The encoded ID of the user group to update.'
+    c.flag 'name', desc: 'A name for the user group. Must be unique among user groups.'
+    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and user groups.'
+    c.flag 'description', desc: 'A short description of the user group.'
+    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the user group uses as a default.'
+    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_update(options))
+    end
+  end
+
+  g.desc 'This method updates the list of users that belong to a user group. This method replaces all users in a user group with the list of users provided in the users parameter.'
+  g.long_desc %( This method updates the list of users that belong to a user group. This method replaces all users in a user group with the list of users provided in the users parameter. )
+  g.command 'users' do |c|
+    c.flag 'usergroup', desc: 'The encoded ID of the user group to update.'
+    c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the user group.'
+    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_users(options))
+    end
+  end
+end

data/bin/commands/users.rb

@@ -0,0 +1,48 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Get info on members of your Slack team.'
+command 'users' do |g|
+  g.desc "This method lets you find out information about a user's presence."
+  g.long_desc %( This method lets you find out information about a user's presence. Consult the presence documentation for more details. )
+  g.command 'getPresence' do |c|
+    c.flag 'user', desc: 'User to get presence info on. Defaults to the authed user.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_getPresence(options))
+    end
+  end
+
+  g.desc 'This method returns information about a team member.'
+  g.long_desc %( This method returns information about a team member. )
+  g.command 'info' do |c|
+    c.flag 'user', desc: 'User to get info on.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_info(options))
+    end
+  end
+
+  g.desc 'This method returns a list of all users in the team. This includes deleted/deactivated users.'
+  g.long_desc %( This method returns a list of all users in the team. This includes deleted/deactivated users. )
+  g.command 'list' do |c|
+    c.flag 'presence', desc: 'Whether to include presence data in the output.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_list(options))
+    end
+  end
+
+  g.desc 'This method lets the slack messaging server know that the authenticated user'
+  g.long_desc %( This method lets the slack messaging server know that the authenticated user is currently active. Consult the presence documentation for more details. )
+  g.command 'setActive' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_setActive(options))
+    end
+  end
+
+  g.desc "This method lets you set the calling user's manual presence."
+  g.long_desc %( This method lets you set the calling user's manual presence. Consult the presence documentation for more details. )
+  g.command 'setPresence' do |c|
+    c.flag 'presence', desc: 'Either auto or away.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_setPresence(options))
+    end
+  end
+end

data/bin/slack

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'slack-ruby-client'
+
+include GLI::App
+
+program_desc 'Slack client.'
+
+default_command :help
+
+switch [:d, :debug], desc: 'Enable debug-level logging.', default_value: false
+flag [:t, 'slack-api-token'], desc: 'Slack API token.', default_value: ENV['SLACK_API_TOKEN']
+flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
+
+pre do |global_options, _command, options, _args|
+  # global Slack configuration
+  Slack.config.token = global_options['slack-api-token']
+  help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && Slack.config.token.length > 0
+
+  if global_options['debug']
+    require 'logger'
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::DEBUG
+    Slack::Web::Client.config.logger = logger
+  end
+
+  $client = Slack::Web::Client.new
+
+  # Offline VCR cassette
+  if global_options['vcr-cassette-name']
+    require 'vcr'
+    VCR.configure do |config|
+      config.cassette_library_dir = 'spec/fixtures/slack'
+      config.hook_into :webmock
+      config.default_cassette_options = { record: :new_episodes }
+    end
+    VCR.insert_cassette global_options['vcr-cassette-name']
+  end
+
+  # remove any nil values from options
+  options.select! { |_k, v| v }
+
+  true
+end
+
+$LOAD_PATH.push File.expand_path('..', __FILE__)
+require 'commands'
+
+exit run(ARGV)

data/examples/hi_real_time/Gemfile

@@ -1,3 +1,5 @@
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'
+
+gem 'celluloid-io'

data/examples/hi_real_time_and_web/Gemfile

@@ -1,3 +1,5 @@
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'
+
+gem 'faye-websocket'

data/examples/hi_real_time_async/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-client', path: '../..'
+
+gem 'faye-websocket'

data/examples/hi_real_time_async/hi.rb

@@ -0,0 +1,29 @@
+require 'slack-ruby-client'
+
+Slack.configure do |config|
+  config.token = ENV['SLACK_API_TOKEN']
+  fail 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+end
+
+client = Slack::RealTime::Client.new
+
+client.on :hello do
+  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+end
+
+client.on :message do |data|
+  puts data
+
+  client.typing channel: data['channel']
+
+  case data['text']
+  when 'bot hi' then
+    client.message channel: data['channel'], text: "Hi <@#{data['user']}>!"
+  when /^bot/ then
+    client.message channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+  end
+end
+
+EM.run do
+  client.start_async
+end

data/lib/slack-ruby-client.rb

@@ -5,6 +5,7 @@ require 'slack/config'
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
+require 'logger'
 require 'slack/web/config'
 require 'slack/web/api/error'
 require 'slack/web/faraday/response/raise_error'
@@ -14,8 +15,7 @@ require 'slack/web/api/endpoints'
 require 'slack/web/client'
 
 # RealTime API
-require 'faye/websocket'
-require 'eventmachine'
+require 'slack/real_time/concurrency'
 require 'slack/real_time/socket'
 require 'slack/real_time/api/message_id'
 require 'slack/real_time/api/ping'

data/lib/slack/real_time/client.rb

@@ -13,7 +13,7 @@ module Slack
       attr_accessor(*Config::ATTRIBUTES)
 
       def initialize(options = {})
-        @callbacks = {}
+        @callbacks = Hash.new { |h, k| h[k] = [] }
         Slack::RealTime::Config::ATTRIBUTES.each do |key|
           send("#{key}=", options[key] || Slack::RealTime.config.send(key))
         end
@@ -29,34 +29,22 @@ module Slack
 
       def on(type, &block)
         type = type.to_s
-        @callbacks[type] ||= []
-        @callbacks[type] << block
+        callbacks[type] << block
       end
 
-      def start!
-        fail ClientAlreadyStartedError if started?
-        EM.run do
-          @options = web_client.rtm_start
-
-          socket_options = {}
-          socket_options[:ping] = websocket_ping if websocket_ping
-          socket_options[:proxy] = websocket_proxy if websocket_proxy
-          @socket = Slack::RealTime::Socket.new(@options['url'], socket_options)
-
-          @socket.connect! do |ws|
-            ws.on :open do |event|
-              open(event)
-            end
-
-            ws.on :message do |event|
-              dispatch(event)
-            end
-
-            ws.on :close do |event|
-              close(event)
-            end
-          end
-        end
+      # Start RealTime client and block until it disconnects.
+      # @yieldparam [Websocket::Driver] driver
+      def start!(&block)
+        socket = build_socket
+        socket.start_sync { run_loop(socket, &block) }
+      end
+
+      # Start RealTime client and return immediately.
+      # The RealTime::Client will run in the background.
+      # @yieldparam [Websocket::Driver] driver
+      def start_async(&block)
+        socket = build_socket
+        socket.start_async { run_loop(socket, &block) }
       end
 
       def stop!
@@ -70,7 +58,7 @@ module Slack
 
       class << self
         def configure
-          block_given? ? yield(Config) : Config
+          block_given? ? yield(config) : config
         end
 
         def config
@@ -80,6 +68,48 @@ module Slack
 
       protected
 
+      # @return [Slack::RealTime::Socket]
+      def build_socket
+        fail ClientAlreadyStartedError if started?
+        @options = web_client.rtm_start
+
+        socket_class.new(@options.fetch('url'), socket_options)
+      end
+
+      def socket_options
+        socket_options = {}
+        socket_options[:ping] = websocket_ping if websocket_ping
+        socket_options[:proxy] = websocket_proxy if websocket_proxy
+        socket_options
+      end
+
+      def run_loop(socket)
+        @socket = socket
+
+        @socket.connect! do |driver|
+          yield driver if block_given?
+
+          driver.on :open do |event|
+            open(event)
+            callback(event, :open)
+          end
+
+          driver.on :message do |event|
+            dispatch(event)
+          end
+
+          driver.on :close do |event|
+            callback(event, :close)
+            close(event)
+          end
+        end
+      end
+
+      attr_reader :callbacks
+      def socket_class
+        concurrency::Socket
+      end
+
       def send_json(data)
         fail ClientNotStartedError unless started?
         @socket.send_data(data.to_json)
@@ -89,8 +119,20 @@ module Slack
       end
 
       def close(_event)
+        socket = @socket
         @socket = nil
-        EM.stop
+
+        [socket, socket_class].each do |s|
+          s.close if s.respond_to?(:close)
+        end
+      end
+
+      def callback(event, type)
+        callbacks = self.callbacks[type.to_s]
+        return false unless callbacks
+        callbacks.each do |c|
+          c.call(event)
+        end
       end
 
       def dispatch(event)
@@ -98,7 +140,7 @@ module Slack
         data = JSON.parse(event.data)
         type = data['type']
         return false unless type
-        callbacks = @callbacks[type.to_s]
+        callbacks = self.callbacks[type.to_s]
         return false unless callbacks
         callbacks.each do |c|
           c.call(data)