slack-ruby-client 0.13.1 → 2.0.0

data/examples/hi_real_time_async_celluloid/hi.rb

@@ -1,35 +0,0 @@
-require 'slack-ruby-client'
-
-raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
-
-$stdout.sync = true
-logger = Logger.new($stdout)
-logger.level = Logger::DEBUG
-threads = []
-
-ENV['SLACK_API_TOKENS'].split.each do |token|
-  logger.info "Starting #{token[0..12]} ..."
-
-  client = Slack::RealTime::Client.new(token: token)
-
-  client.on :hello do
-    logger.info "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|
-    logger.info 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
-
-  threads << client.start_async
-end
-
-threads.each(&:join)

data/examples/hi_real_time_async_eventmachine/Gemfile

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

data/examples/hi_real_time_async_eventmachine/Procfile

@@ -1,2 +0,0 @@
-console: bundle exec ruby hi.rb
-

data/examples/hi_real_time_async_eventmachine/hi.rb

@@ -1,35 +0,0 @@
-require 'slack-ruby-client'
-
-raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
-
-$stdout.sync = true
-logger = Logger.new($stdout)
-logger.level = Logger::DEBUG
-threads = []
-
-ENV['SLACK_API_TOKENS'].split.each do |token|
-  logger.info "Starting #{token[0..12]} ..."
-
-  client = Slack::RealTime::Client.new(token: token)
-
-  client.on :hello do
-    logger.info "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|
-    logger.info 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
-
-  threads << client.start_async
-end
-
-threads.each(&:join)

data/lib/slack/real_time/concurrency/celluloid.rb

@@ -1,118 +0,0 @@
-require 'websocket/driver'
-require 'socket'
-require 'forwardable'
-require 'celluloid/current'
-require 'celluloid/io'
-
-module Slack
-  module RealTime
-    module Concurrency
-      module Celluloid
-        class Socket < Slack::RealTime::Socket
-          include ::Celluloid::IO
-          include ::Celluloid::Internals::Logger
-
-          BLOCK_SIZE = 4096
-
-          extend ::Forwardable
-          def_delegators :driver, :text, :binary
-
-          attr_reader :socket
-
-          def initialize(*args)
-            super
-          end
-
-          def connect!
-            super
-            run_loop
-          end
-
-          def run_loop
-            @closing = false
-            @socket = build_socket
-            @connected = @socket.connect
-            driver.start
-            loop { read } if socket
-          rescue EOFError, Errno::ECONNRESET, Errno::EPIPE => e
-            logger.debug("#{self.class}##{__method__}") { e }
-            driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')) unless @closing
-          ensure
-            begin
-              current_actor.terminate if current_actor.alive?
-            rescue StandardError
-              nil
-            end
-          end
-
-          def close
-            @closing = true
-            driver.close
-            super
-          end
-
-          def read
-            buffer = socket.readpartial(BLOCK_SIZE)
-            raise EOFError unless buffer && !buffer.empty?
-            async.handle_read(buffer)
-          end
-
-          def handle_read(buffer)
-            logger.debug("#{self.class}##{__method__}") { buffer }
-            driver.parse buffer
-          end
-
-          def write(data)
-            logger.debug("#{self.class}##{__method__}") { data }
-            socket.write(data)
-          end
-
-          def start_async(client)
-            @client = client
-            Actor.new(future.run_client_loop)
-          end
-
-          def run_client_loop
-            @client.run_loop
-          end
-
-          def connected?
-            !@connected.nil?
-          end
-
-          protected
-
-          class Actor
-            attr_reader :future
-
-            def initialize(future)
-              @future = future
-            end
-
-            def join
-              @future.value
-            end
-          end
-
-          def build_socket
-            socket = ::Celluloid::IO::TCPSocket.new(addr, port)
-            socket = ::Celluloid::IO::SSLSocket.new(socket, build_ssl_context) if secure?
-            socket
-          end
-
-          def build_ssl_context
-            OpenSSL::SSL::SSLContext.new(:TLSv1_2_client)
-          end
-
-          def build_driver
-            ::WebSocket::Driver.client(self)
-          end
-
-          def connect
-            @driver = build_driver
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/real_time/concurrency/eventmachine.rb

@@ -1,66 +0,0 @@
-require 'faye/websocket'
-require 'eventmachine'
-
-module Slack
-  module RealTime
-    module Concurrency
-      module Eventmachine
-        class Client < Faye::WebSocket::Client
-          attr_reader :logger
-          protected :logger
-
-          def initialize(url, protocols = nil, options = {})
-            @logger = options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
-            super
-          end
-
-          def parse(data)
-            logger.debug("#{self.class}##{__method__}") { data }
-            super data
-          end
-
-          def write(data)
-            logger.debug("#{self.class}##{__method__}") { data }
-            super data
-          end
-        end
-
-        class Socket < Slack::RealTime::Socket
-          def start_async(client)
-            @thread = ensure_reactor_running
-
-            client.run_loop
-
-            @thread
-          end
-
-          def close
-            super
-            EventMachine.stop if @thread
-            @thread = nil
-          end
-
-          def send_data(message)
-            logger.debug("#{self.class}##{__method__}") { message }
-            driver.send(message)
-          end
-
-          protected
-
-          # @return [Thread]
-          def ensure_reactor_running
-            return if EventMachine.reactor_running?
-
-            reactor = Thread.new { EventMachine.run }
-            Thread.pass until EventMachine.reactor_running?
-            reactor
-          end
-
-          def connect
-            @driver = Client.new(url, nil, options.merge(logger: logger))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/endpoints/apps_permissions.rb

@@ -1,35 +0,0 @@
-# This file was auto-generated by lib/tasks/web.rake
-
-module Slack
-  module Web
-    module Api
-      module Endpoints
-        module AppsPermissions
-          #
-          # Returns list of permissions this app has on a team.
-          #
-          # @see https://api.slack.com/methods/apps.permissions.info
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions/apps.permissions.info.json
-          def apps_permissions_info(options = {})
-            post('apps.permissions.info', options)
-          end
-
-          #
-          # Allows an app to request additional scopes
-          #
-          # @option options [Object] :scopes
-          #   A comma separated list of scopes to request for.
-          # @option options [Object] :trigger_id
-          #   Token used to trigger the permissions API.
-          # @see https://api.slack.com/methods/apps.permissions.request
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions/apps.permissions.request.json
-          def apps_permissions_request(options = {})
-            throw ArgumentError.new('Required arguments :scopes missing') if options[:scopes].nil?
-            throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
-            post('apps.permissions.request', options)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/endpoints/apps_permissions_resources.rb

@@ -1,30 +0,0 @@
-# This file was auto-generated by lib/tasks/web.rake
-
-module Slack
-  module Web
-    module Api
-      module Endpoints
-        module AppsPermissionsResources
-          #
-          # Returns list of resource grants this app has on a team.
-          #
-          # @option options [Object] :cursor
-          #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
-          # @option options [Object] :limit
-          #   The maximum number of items to return.
-          # @see https://api.slack.com/methods/apps.permissions.resources.list
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.resources/apps.permissions.resources.list.json
-          def apps_permissions_resources_list(options = {})
-            if block_given?
-              Pagination::Cursor.new(self, :apps_permissions_resources_list, options).each do |page|
-                yield page
-              end
-            else
-              post('apps.permissions.resources.list', options)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/endpoints/apps_permissions_scopes.rb

@@ -1,20 +0,0 @@
-# This file was auto-generated by lib/tasks/web.rake
-
-module Slack
-  module Web
-    module Api
-      module Endpoints
-        module AppsPermissionsScopes
-          #
-          # Returns list of scopes this app has on a team.
-          #
-          # @see https://api.slack.com/methods/apps.permissions.scopes.list
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.scopes/apps.permissions.scopes.list.json
-          def apps_permissions_scopes_list(options = {})
-            post('apps.permissions.scopes.list', options)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/endpoints/apps_permissions_users.rb

@@ -1,49 +0,0 @@
-# This file was auto-generated by lib/tasks/web.rake
-
-module Slack
-  module Web
-    module Api
-      module Endpoints
-        module AppsPermissionsUsers
-          #
-          # Returns list of user grants and corresponding scopes this app has on a team.
-          #
-          # @option options [Object] :cursor
-          #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
-          # @option options [Object] :limit
-          #   The maximum number of items to return.
-          # @see https://api.slack.com/methods/apps.permissions.users.list
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.users/apps.permissions.users.list.json
-          def apps_permissions_users_list(options = {})
-            if block_given?
-              Pagination::Cursor.new(self, :apps_permissions_users_list, options).each do |page|
-                yield page
-              end
-            else
-              post('apps.permissions.users.list', options)
-            end
-          end
-
-          #
-          # Enables an app to trigger a permissions modal to grant an app access to a user access scope.
-          #
-          # @option options [Object] :scopes
-          #   A comma separated list of user scopes to request for.
-          # @option options [Object] :trigger_id
-          #   Token used to trigger the request.
-          # @option options [user] :user
-          #   The user this scope is being requested for.
-          # @see https://api.slack.com/methods/apps.permissions.users.request
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/apps.permissions.users/apps.permissions.users.request.json
-          def apps_permissions_users_request(options = {})
-            throw ArgumentError.new('Required arguments :scopes missing') if options[:scopes].nil?
-            throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
-            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
-            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-            post('apps.permissions.users.request', options)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/slack/web/api/endpoints/channels.rb

@@ -1,266 +0,0 @@
-# This file was auto-generated by lib/tasks/web.rake
-
-module Slack
-  module Web
-    module Api
-      module Endpoints
-        module Channels
-          #
-          # Archives a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to archive.
-          # @see https://api.slack.com/methods/channels.archive
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.archive.json
-          def channels_archive(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.archive', options)
-          end
-
-          #
-          # Creates a channel.
-          #
-          # @option options [Object] :name
-          #   Name of channel to create.
-          # @option options [Object] :validate
-          #   Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
-          # @see https://api.slack.com/methods/channels.create
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.create.json
-          def channels_create(options = {})
-            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
-            post('channels.create', options)
-          end
-
-          #
-          # Delete a channel (undocumented)
-          #
-          # @option options [channel] :channel
-          #   Channel to delete.
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/channels/channels.delete.json
-          def channels_delete(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            logger.warn('The channels.delete method is undocumented.')
-            post('channels.delete', options)
-          end
-
-          #
-          # Fetches history of messages and events from a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to fetch history for.
-          # @option options [Object] :inclusive
-          #   Include messages with latest or oldest timestamp in results.
-          # @option options [timestamp] :latest
-          #   End of time range of messages to include in results.
-          # @option options [timestamp] :oldest
-          #   Start of time range of messages to include in results.
-          # @option options [Object] :unreads
-          #   Include unread_count_display in the output?.
-          # @see https://api.slack.com/methods/channels.history
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.history.json
-          def channels_history(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.history', options)
-          end
-
-          #
-          # Gets information about a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to get info on.
-          # @option options [Object] :include_locale
-          #   Set this to true to receive the locale for this channel. Defaults to false.
-          # @see https://api.slack.com/methods/channels.info
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.info.json
-          def channels_info(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.info', options)
-          end
-
-          #
-          # Invites a user to a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to invite user to.
-          # @option options [user] :user
-          #   User to invite to channel.
-          # @see https://api.slack.com/methods/channels.invite
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.invite.json
-          def channels_invite(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-            post('channels.invite', options)
-          end
-
-          #
-          # Joins a channel, creating it if needed.
-          #
-          # @option options [Object] :name
-          #   Name of channel to join.
-          # @option options [Object] :validate
-          #   Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
-          # @see https://api.slack.com/methods/channels.join
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.join.json
-          def channels_join(options = {})
-            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
-            post('channels.join', options)
-          end
-
-          #
-          # Removes a user from a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to remove user from.
-          # @option options [user] :user
-          #   User to remove from channel.
-          # @see https://api.slack.com/methods/channels.kick
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.kick.json
-          def channels_kick(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
-            post('channels.kick', options)
-          end
-
-          #
-          # Leaves a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to leave.
-          # @see https://api.slack.com/methods/channels.leave
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.leave.json
-          def channels_leave(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.leave', options)
-          end
-
-          #
-          # Lists all channels in a Slack team.
-          #
-          # @option options [Object] :cursor
-          #   Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
-          # @option options [Object] :exclude_archived
-          #   Exclude archived channels from the list.
-          # @option options [Object] :exclude_members
-          #   Exclude the members collection from each channel.
-          # @option options [Object] :limit
-          #   The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
-          # @see https://api.slack.com/methods/channels.list
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.list.json
-          def channels_list(options = {})
-            if block_given?
-              Pagination::Cursor.new(self, :channels_list, options).each do |page|
-                yield page
-              end
-            else
-              post('channels.list', options)
-            end
-          end
-
-          #
-          # Sets the read cursor in a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to set reading cursor in.
-          # @option options [timestamp] :ts
-          #   Timestamp of the most recently seen message.
-          # @see https://api.slack.com/methods/channels.mark
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.mark.json
-          def channels_mark(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.mark', options)
-          end
-
-          #
-          # Renames a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to rename.
-          # @option options [Object] :name
-          #   New name for channel.
-          # @option options [Object] :validate
-          #   Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.
-          # @see https://api.slack.com/methods/channels.rename
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.rename.json
-          def channels_rename(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.rename', options)
-          end
-
-          #
-          # Retrieve a thread of messages posted to a channel
-          #
-          # @option options [channel] :channel
-          #   Channel to fetch thread from.
-          # @option options [Object] :thread_ts
-          #   Unique identifier of a thread's parent message.
-          # @see https://api.slack.com/methods/channels.replies
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.replies.json
-          def channels_replies(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :thread_ts missing') if options[:thread_ts].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.replies', options)
-          end
-
-          #
-          # Sets the purpose for a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to set the purpose of.
-          # @option options [Object] :purpose
-          #   The new purpose.
-          # @see https://api.slack.com/methods/channels.setPurpose
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.setPurpose.json
-          def channels_setPurpose(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.setPurpose', options)
-          end
-
-          #
-          # Sets the topic for a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to set the topic of.
-          # @option options [Object] :topic
-          #   The new topic.
-          # @see https://api.slack.com/methods/channels.setTopic
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.setTopic.json
-          def channels_setTopic(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.setTopic', options)
-          end
-
-          #
-          # Unarchives a channel.
-          #
-          # @option options [channel] :channel
-          #   Channel to unarchive.
-          # @see https://api.slack.com/methods/channels.unarchive
-          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/channels/channels.unarchive.json
-          def channels_unarchive(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
-            post('channels.unarchive', options)
-          end
-        end
-      end
-    end
-  end
-end