slack-ruby-client 0.9.1 → 0.10.0

data/lib/slack-ruby-client.rb

@@ -17,6 +17,11 @@ begin
 rescue LoadError
   # ignore, only used in users_search
 end
+begin
+  require 'openssl'
+rescue LoadError
+  # Used in slack/web/config
+end
 require_relative 'slack/web/config'
 require_relative 'slack/web/api/errors/slack_error'
 require_relative 'slack/web/api/errors/too_many_requests_error'
@@ -26,6 +31,7 @@ require_relative 'slack/web/faraday/connection'
 require_relative 'slack/web/faraday/request'
 require_relative 'slack/web/api/mixins'
 require_relative 'slack/web/api/endpoints'
+require_relative 'slack/web/pagination/cursor'
 require_relative 'slack/web/client'
 
 # RealTime API

data/lib/slack/real_time/client.rb

@@ -117,7 +117,7 @@ module Slack
       def rtm_start_method
         if start_method
           start_method
-        elsif @store_class == Slack::RealTime::Stores::Store
+        elsif @store_class && @store_class <= Slack::RealTime::Stores::Store
           :rtm_start
         else
           :rtm_connect

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

@@ -34,7 +34,7 @@ module Slack
             @connected = @socket.connect
             driver.start
             loop { read } if socket
-          rescue EOFError => e
+          rescue EOFError, Errno::EPIPE => e
             logger.debug("#{self.class}##{__method__}") { e }
             driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')) unless @closing
           ensure

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.9.1'.freeze
+  VERSION = '0.10.0'.freeze
 end

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

@@ -6,6 +6,7 @@ require_relative 'endpoints/auth'
 require_relative 'endpoints/bots'
 require_relative 'endpoints/channels'
 require_relative 'endpoints/chat'
+require_relative 'endpoints/conversations'
 require_relative 'endpoints/dnd'
 require_relative 'endpoints/emoji'
 require_relative 'endpoints/files_comments'
@@ -41,6 +42,7 @@ module Slack
         include Bots
         include Channels
         include Chat
+        include Conversations
         include Dnd
         include Emoji
         include FilesComments

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

@@ -58,6 +58,8 @@ module Slack
           #
           # @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/dblock/slack-api-ref/blob/master/methods/channels/channels.info.json
           def channels_info(options = {})
@@ -130,14 +132,24 @@ module Slack
           #
           # 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/dblock/slack-api-ref/blob/master/methods/channels/channels.list.json
           def channels_list(options = {})
-            post('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
 
           #

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

@@ -0,0 +1,301 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Conversations
+          #
+          # Archives a conversation.
+          #
+          # @option options [channel] :channel
+          #   ID of conversation to archive.
+          # @see https://api.slack.com/methods/conversations.archive
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.archive.json
+          def conversations_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('conversations.archive', options)
+          end
+
+          #
+          # Closes a direct message or multi-person direct message.
+          #
+          # @option options [channel] :channel
+          #   Conversation to close.
+          # @see https://api.slack.com/methods/conversations.close
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.close.json
+          def conversations_close(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('conversations.close', options)
+          end
+
+          #
+          # Initiates a public or private channel-based conversation
+          #
+          # @option options [Object] :name
+          #   Name of the public or private channel to create.
+          # @option options [Object] :is_private
+          #   Create a private channel instead of a public one.
+          # @see https://api.slack.com/methods/conversations.create
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.create.json
+          def conversations_create(options = {})
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            post('conversations.create', options)
+          end
+
+          #
+          # Fetches a conversation's history of messages and events.
+          #
+          # @option options [channel] :channel
+          #   Conversation ID to fetch history for.
+          # @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 [timestamp] :latest
+          #   End of time range of messages to include in results.
+          # @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.
+          # @option options [timestamp] :oldest
+          #   Start of time range of messages to include in results.
+          # @see https://api.slack.com/methods/conversations.history
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.history.json
+          def conversations_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]
+            if block_given?
+              Pagination::Cursor.new(self, :conversations_history, options).each do |page|
+                yield page
+              end
+            else
+              post('conversations.history', options)
+            end
+          end
+
+          #
+          # Retrieve information about a conversation.
+          #
+          # @option options [channel] :channel
+          #   Conversation ID to learn more about.
+          # @option options [Object] :include_locale
+          #   Set this to true to receive the locale for this conversation. Defaults to false.
+          # @see https://api.slack.com/methods/conversations.info
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.info.json
+          def conversations_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('conversations.info', options)
+          end
+
+          #
+          # Invites users to a channel.
+          #
+          # @option options [channel] :channel
+          #   The ID of the public or private channel to invite user(s) to.
+          # @option options [Object] :users
+          #   A comma separated list of user IDs. Up to 30 users may be listed.
+          # @see https://api.slack.com/methods/conversations.invite
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.invite.json
+          def conversations_invite(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            post('conversations.invite', options)
+          end
+
+          #
+          # Joins an existing conversation.
+          #
+          # @option options [channel] :channel
+          #   ID of conversation to join.
+          # @see https://api.slack.com/methods/conversations.join
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.join.json
+          def conversations_join(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('conversations.join', options)
+          end
+
+          #
+          # Removes a user from a conversation.
+          #
+          # @option options [channel] :channel
+          #   ID of conversation to remove user from.
+          # @option options [user] :user
+          #   User ID to be removed.
+          # @see https://api.slack.com/methods/conversations.kick
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.kick.json
+          def conversations_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('conversations.kick', options)
+          end
+
+          #
+          # Leaves a conversation.
+          #
+          # @option options [channel] :channel
+          #   Conversation to leave.
+          # @see https://api.slack.com/methods/conversations.leave
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.leave.json
+          def conversations_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('conversations.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
+          #   Set to true to exclude archived channels from the list.
+          # @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 list hasn't been reached. Must be an integer no larger than 1000.
+          # @option options [Object] :types
+          #   Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.
+          # @see https://api.slack.com/methods/conversations.list
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.list.json
+          def conversations_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :conversations_list, options).each do |page|
+                yield page
+              end
+            else
+              post('conversations.list', options)
+            end
+          end
+
+          #
+          # Retrieve members of a conversation.
+          #
+          # @option options [channel] :channel
+          #   ID of the conversation to retrieve members for.
+          # @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. 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/conversations.members
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.members.json
+          def conversations_members(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            if block_given?
+              Pagination::Cursor.new(self, :conversations_members, options).each do |page|
+                yield page
+              end
+            else
+              post('conversations.members', options)
+            end
+          end
+
+          #
+          # Opens or resumes a direct message or multi-person direct message.
+          #
+          # @option options [channel] :channel
+          #   Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
+          # @option options [Object] :return_im
+          #   Boolean, indicates you want the full IM channel definition in the response.
+          # @option options [Object] :users
+          #   Comma separated lists of users. If only one user is included, this creates a 1:1 DM.  The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.
+          # @see https://api.slack.com/methods/conversations.open
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.open.json
+          def conversations_open(options = {})
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            post('conversations.open', options)
+          end
+
+          #
+          # Renames a conversation.
+          #
+          # @option options [channel] :channel
+          #   ID of conversation to rename.
+          # @option options [Object] :name
+          #   New name for conversation.
+          # @see https://api.slack.com/methods/conversations.rename
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.rename.json
+          def conversations_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('conversations.rename', options)
+          end
+
+          #
+          # Retrieve a thread of messages posted to a conversation
+          #
+          # @option options [channel] :channel
+          #   Conversation ID to fetch thread from.
+          # @option options [timestamp] :ts
+          #   Unique identifier of a thread's parent message.
+          # @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. 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/conversations.replies
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.replies.json
+          def conversations_replies(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]
+            if block_given?
+              Pagination::Cursor.new(self, :conversations_replies, options).each do |page|
+                yield page
+              end
+            else
+              post('conversations.replies', options)
+            end
+          end
+
+          #
+          # Sets the purpose for a conversation.
+          #
+          # @option options [channel] :channel
+          #   Conversation to set the purpose of.
+          # @option options [Object] :purpose
+          #   A new, specialer purpose.
+          # @see https://api.slack.com/methods/conversations.setPurpose
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.setPurpose.json
+          def conversations_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('conversations.setPurpose', options)
+          end
+
+          #
+          # Sets the topic for a conversation.
+          #
+          # @option options [channel] :channel
+          #   Conversation to set the topic of.
+          # @option options [Object] :topic
+          #   The new topic string. Does not support formatting or linkification.
+          # @see https://api.slack.com/methods/conversations.setTopic
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.setTopic.json
+          def conversations_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('conversations.setTopic', options)
+          end
+
+          #
+          # Reverses conversation archival.
+          #
+          # @option options [channel] :channel
+          #   ID of conversation to unarchive.
+          # @see https://api.slack.com/methods/conversations.unarchive
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/conversations/conversations.unarchive.json
+          def conversations_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('conversations.unarchive', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,19 +18,6 @@ module Slack
             post('groups.archive', options)
           end
 
-          #
-          # Closes a private channel.
-          #
-          # @option options [group] :channel
-          #   Private channel to close.
-          # @see https://api.slack.com/methods/groups.close
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.close.json
-          def groups_close(options = {})
-            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
-            post('groups.close', options)
-          end
-
           #
           # Creates a private channel.
           #
@@ -84,6 +71,8 @@ module Slack
           #
           # @option options [group] :channel
           #   Private channel to get info on.
+          # @option options [Object] :include_locale
+          #   Set this to true to receive the locale for this group. Defaults to false.
           # @see https://api.slack.com/methods/groups.info
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.info.json
           def groups_info(options = {})

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

@@ -42,10 +42,20 @@ module Slack
           #
           # Lists direct message channels for the calling user.
           #
+          # @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. 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/im.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.list.json
           def im_list(options = {})
-            post('im.list', options)
+            if block_given?
+              Pagination::Cursor.new(self, :im_list, options).each do |page|
+                yield page
+              end
+            else
+              post('im.list', options)
+            end
           end
 
           #
@@ -69,6 +79,8 @@ module Slack
           #
           # @option options [user] :user
           #   User to open a direct message channel with.
+          # @option options [Object] :include_locale
+          #   Set this to true to receive the locale for this im. Defaults to false.
           # @option options [Object] :return_im
           #   Boolean, indicates you want the full IM channel definition in the response.
           # @see https://api.slack.com/methods/im.open