slack-ruby-client 0.11.1 → 0.12.0

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

@@ -9,6 +9,8 @@ module Slack
           # Starts a Real Time Messaging session.
           #
           # @option options [Object] :batch_presence_aware
+          #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
+          # @option options [Object] :presence_sub
           #   Only deliver presence events when requested by subscription. See presence subscriptions.
           # @see https://api.slack.com/methods/rtm.connect
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/rtm/rtm.connect.json
@@ -20,7 +22,7 @@ module Slack
           # Starts a Real Time Messaging session.
           #
           # @option options [Object] :batch_presence_aware
-          #   Only deliver presence events when requested by subscription. See presence subscriptions.
+          #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
           # @option options [Object] :include_locale
           #   Set this to true to receive the locale for users and channels. Defaults to false.
           # @option options [Object] :mpim_aware
@@ -29,6 +31,8 @@ module Slack
           #   Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.
           # @option options [Object] :no_unreads
           #   Skip unread counts for each channel (improves performance).
+          # @option options [Object] :presence_sub
+          #   Only deliver presence events when requested by subscription. See presence subscriptions.
           # @option options [Object] :simple_latest
           #   Return timestamp only for latest message object of each channel (improves performance).
           # @see https://api.slack.com/methods/rtm.start

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

@@ -27,7 +27,7 @@ module Slack
           # Searches for files matching a query.
           #
           # @option options [Object] :query
-          #   Search query. May contain booleans, etc.
+          #   Search query.
           # @option options [Object] :highlight
           #   Pass a value of true to enable query highlight markers (see below).
           # @option options [Object] :sort
@@ -45,7 +45,7 @@ module Slack
           # Searches for messages matching a query.
           #
           # @option options [Object] :query
-          #   Search query. May contains booleans, etc.
+          #   Search query.
           # @option options [Object] :highlight
           #   Pass a value of true to enable query highlight markers (see below).
           # @option options [Object] :sort

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

@@ -26,10 +26,20 @@ module Slack
           #
           # Lists stars for a user.
           #
+          # @option options [Object] :cursor
+          #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
+          # @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.
           # @see https://api.slack.com/methods/stars.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/stars/stars.list.json
           def stars_list(options = {})
-            post('stars.list', options)
+            if block_given?
+              Pagination::Cursor.new(self, :stars_list, options).each do |page|
+                yield page
+              end
+            else
+              post('stars.list', options)
+            end
           end
 
           #

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

@@ -5,6 +5,32 @@ module Slack
     module Api
       module Endpoints
         module Users
+          #
+          # List conversations the calling user may access.
+          #
+          # @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.
+          # @option options [user] :user
+          #   Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
+          # @see https://api.slack.com/methods/users.conversations
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.conversations.json
+          def users_conversations(options = {})
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            if block_given?
+              Pagination::Cursor.new(self, :users_conversations, options).each do |page|
+                yield page
+              end
+            else
+              post('users.conversations', options)
+            end
+          end
+
           #
           # Delete the user profile photo
           #
@@ -61,7 +87,7 @@ module Slack
           # @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 [Object] :presence
-          #   Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance, especially with large teams.
+          #   Deprecated. Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance, especially with large teams.
           # @see https://api.slack.com/methods/users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.list.json
           def users_list(options = {})
@@ -87,7 +113,7 @@ module Slack
           end
 
           #
-          # Marks a user as active.
+          # Marked a user as active. Deprecated and non-functional.
           #
           # @see https://api.slack.com/methods/users.setActive
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setActive.json

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

@@ -25,7 +25,7 @@ module Slack
           # @option options [Object] :name
           #   Name of a single key to set. Usable only if profile is not passed.
           # @option options [Object] :profile
-          #   Collection of key:value pairs presented as a URL-encoded JSON hash.
+          #   Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.
           # @option options [user] :user
           #   ID of user to change. This argument may only be specified by team admins on paid teams.
           # @option options [Object] :value

data/lib/slack/web/api/patches/chat.5.postEphemeral-text-or-attachments.patch

@@ -0,0 +1,13 @@
+diff --git a/slack-ruby-client/lib/slack/web/api/endpoints/chat.rb b/slack-ruby-client-original/lib/slack/web/api/endpoints/chat.rb
+index 194419e..2ef5c65 100644
+--- a/lib/slack/web/api/endpoints/chat.rb
++++ b/lib/slack/web/api/endpoints/chat.rb
+@@ -93,7 +93,7 @@ module Slack
+           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/chat/chat.postEphemeral.json
+           def chat_postEphemeral(options = {})
+             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+-            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
++            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
+             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+             # attachments must be passed as an encoded JSON string

data/slack-ruby-client.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'json-schema'
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '0.51.0'
+  s.add_development_dependency 'rubocop', '0.58.2'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
 end

data/spec/slack/messages/formatting_spec.rb

@@ -1,4 +1,3 @@
-
 require 'spec_helper'
 
 describe Slack::Messages::Formatting do

data/spec/slack/real_time/concurrency/celluloid_spec.rb

@@ -4,59 +4,103 @@ require_relative './it_behaves_like_a_realtime_socket'
 begin
   RSpec.describe Slack::RealTime::Concurrency::Celluloid::Socket do
     it_behaves_like 'a realtime socket'
-    context 'with url' do
-      let(:url) { 'wss://echo.websocket.org/websocket/xyz' }
-      let(:logger) { ::Logger.new(STDOUT) }
-
-      [EOFError, Errno::EPIPE].each do |err|
-        context "finishing run_loop with #{err}" do
-          let(:test_socket) do
-            Class.new(described_class) do
-              def read
-                raise options[:err]
-              end
+
+    let(:url) { 'wss://echo.websocket.org/websocket/xyz' }
+    let(:logger) { ::Logger.new(STDOUT) }
+
+    let(:driver) { WebSocket::Driver::Client }
+    let(:ws) { double(driver) }
+    subject { socket }
+
+    ['', nil].each do |data|
+      context "finishing run_loop with #{data ? 'empty' : 'nil'} read" do
+        let(:ssl_socket) do
+          Class.new(Celluloid::IO::SSLSocket) do
+            def initialize(data)
+              @data = data
+            end
+
+            def connect; end
+
+            def readpartial(_size)
+              @data
             end
           end
+        end
 
-          let(:socket) do
-            test_socket.new(url, ping: 42, logger: logger, err: err)
+        let(:test_socket) do
+          Class.new(described_class) do
+            def build_socket
+              options[:ssl_socket].new(options[:data])
+            end
           end
+        end
 
-          let(:driver) { WebSocket::Driver::Client }
-          let(:ws) { double(driver) }
-          subject { socket }
+        let(:socket) do
+          test_socket.new(url, logger: logger, data: data, ssl_socket: ssl_socket)
+        end
 
-          describe '#connect!' do
-            pending 'connects'
-            pending 'pings every 30s'
+        context 'with a driver' do
+          before do
+            socket.instance_variable_set('@driver', ws)
           end
 
-          context 'with a driver' do
-            before do
-              socket.instance_variable_set('@driver', ws)
+          context 'consumes data' do
+            it 'runs' do
+              expect(ws).to receive(:emit)
+              expect(ws).to receive(:start)
+              expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
+              socket.run_loop
             end
+          end
+        end
+      end
+    end
 
-            describe '#disconnect!' do
-              it 'closes and nils the websocket' do
-                expect(ws).to receive(:close)
-                socket.disconnect!
-              end
+    [EOFError, Errno::ECONNRESET, Errno::EPIPE].each do |err|
+      context "finishing run_loop with #{err}" do
+        let(:test_socket) do
+          Class.new(described_class) do
+            def read
+              raise options[:err]
             end
+          end
+        end
+
+        let(:socket) do
+          test_socket.new(url, logger: logger, err: err)
+        end
+
+        context 'with a driver' do
+          before do
+            socket.instance_variable_set('@driver', ws)
+          end
 
-            context 'consumes data' do
-              it 'runs' do
-                expect(ws).to receive(:emit)
-                expect(ws).to receive(:start)
-                expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
-                socket.run_loop
-              end
+          describe '#disconnect!' do
+            it 'closes and nils the websocket' do
+              expect(ws).to receive(:close)
+              socket.disconnect!
             end
           end
 
-          pending 'send_data'
+          context 'consumes data' do
+            it 'runs' do
+              expect(ws).to receive(:emit)
+              expect(ws).to receive(:start)
+              expect(logger).to receive(:debug).with("#{test_socket}#run_loop")
+              socket.run_loop
+            end
+          end
         end
       end
     end
+
+    describe '#connect!' do
+      pending 'connects'
+      pending 'pings every 30s'
+    end
+
+    pending 'send_data'
   end
 rescue LoadError
 end

data/spec/slack/slack_spec.rb

@@ -17,8 +17,8 @@ describe Slack do
   context 'globals' do
     it 'enables request and response logging with -d' do
       output = `"#{slack}" --vcr-cassette-name=web/auth_test_success --slack-api-token=token -d auth test 2>&1`
-      expect(output).to include 'post https://slack.com/api/auth.test'
-      expect(output).to include 'Status: 200'
+      expect(output).to include 'POST https://slack.com/api/auth.test'
+      expect(output).to include 'Status 200'
     end
     it 'requires --slack-api-token' do
       err = `"#{slack}" auth test 2>&1`

data/spec/slack/web/api/endpoints/apps_permissions_resources_spec.rb

@@ -0,0 +1,7 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::AppsPermissionsResources do
+  let(:client) { Slack::Web::Client.new }
+end

data/spec/slack/web/api/endpoints/apps_permissions_scopes_spec.rb

@@ -0,0 +1,7 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::AppsPermissionsScopes do
+  let(:client) { Slack::Web::Client.new }
+end

data/spec/slack/web/api/endpoints/apps_permissions_users_spec.rb

@@ -0,0 +1,18 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Endpoints::AppsPermissionsUsers do
+  let(:client) { Slack::Web::Client.new }
+  context 'apps.permissions.users_request' do
+    it 'requires scopes' do
+      expect { client.apps_permissions_users_request(trigger_id: ' ', user: ' ') }.to raise_error ArgumentError, /Required arguments :scopes missing/
+    end
+    it 'requires trigger_id' do
+      expect { client.apps_permissions_users_request(scopes: ' ', user: ' ') }.to raise_error ArgumentError, /Required arguments :trigger_id missing/
+    end
+    it 'requires user' do
+      expect { client.apps_permissions_users_request(scopes: ' ', trigger_id: ' ') }.to raise_error ArgumentError, /Required arguments :user missing/
+    end
+  end
+end

data/spec/slack/web/api/endpoints/custom_specs/chat_spec.rb

@@ -19,8 +19,8 @@ RSpec.describe Slack::Web::Api::Endpoints::Chat do
       client.chat_postEphemeral(channel: 'channel', text: 'text', user: '123', attachments: [])
     end
     context 'text and user arguments' do
-      it 'requires text' do
-        expect { client.chat_postEphemeral(channel: 'channel') }.to raise_error ArgumentError, /Required arguments :text missing/
+      it 'requires text or attachments' do
+        expect { client.chat_postEphemeral(channel: 'channel') }.to raise_error ArgumentError, /Required arguments :text or :attachments missing/
       end
       it 'requires user' do
         expect { client.chat_postEphemeral(channel: 'channel', text: 'text') }.to raise_error ArgumentError, /Required arguments :user missing/
@@ -35,6 +35,10 @@ RSpec.describe Slack::Web::Api::Endpoints::Chat do
         expect(client).to receive(:post).with('chat.postEphemeral', hash_including(attachments: '[]'))
         expect { client.chat_postEphemeral(channel: 'channel', text: 'text', user: '123', attachments: []) }.to_not raise_error
       end
+      it 'attachments without text' do
+        expect(client).to receive(:post).with('chat.postEphemeral', hash_including(attachments: '[]'))
+        expect { client.chat_postEphemeral(channel: 'channel', attachments: [], user: '123') }.to_not raise_error
+      end
     end
   end
 

data/spec/slack/web/api/mixins/channels_spec.rb

@@ -10,12 +10,14 @@ RSpec.describe Slack::Web::Api::Mixins::Channels do
     klass.new
   end
   before do
-    allow(subject).to receive(:channels_list).and_return(Slack::Messages::Message.new(
-                                                           'channels' => [{
-                                                             'id' => 'CDEADBEEF',
-                                                             'name' => 'general'
-                                                           }]
-    ))
+    allow(subject).to receive(:channels_list).and_return(
+      Slack::Messages::Message.new(
+        'channels' => [{
+          'id' => 'CDEADBEEF',
+          'name' => 'general'
+        }]
+      )
+    )
   end
   context '#channels_id' do
     it 'leaves channels specified by ID alone' do

data/spec/slack/web/api/mixins/groups_spec.rb

@@ -10,12 +10,14 @@ RSpec.describe Slack::Web::Api::Mixins::Groups do
     klass.new
   end
   before do
-    allow(subject).to receive(:groups_list).and_return(Slack::Messages::Message.new(
-                                                         'groups' => [{
-                                                           'id' => 'CDEADBEEF',
-                                                           'name' => 'general'
-                                                         }]
-    ))
+    allow(subject).to receive(:groups_list).and_return(
+      Slack::Messages::Message.new(
+        'groups' => [{
+          'id' => 'CDEADBEEF',
+          'name' => 'general'
+        }]
+      )
+    )
   end
   context '#groups_id' do
     it 'leaves groups specified by ID alone' do

data/spec/slack/web/api/mixins/users_spec.rb

@@ -10,13 +10,15 @@ RSpec.describe Slack::Web::Api::Mixins::Users do
     klass.new
   end
   before do
-    allow(subject).to receive(:users_list).and_return(Slack::Messages::Message.new(
-                                                        'members' => [{
-                                                          'id' => 'UDEADBEEF',
-                                                          'name' => 'aws',
-                                                          'profile' => {}
-                                                        }]
-    ))
+    allow(subject).to receive(:users_list).and_return(
+      Slack::Messages::Message.new(
+        'members' => [{
+          'id' => 'UDEADBEEF',
+          'name' => 'aws',
+          'profile' => {}
+        }]
+      )
+    )
   end
   context '#users_id' do
     it 'leaves users specified by ID alone' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.58.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.58.2
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +217,9 @@ files:
 - bin/commands.rb
 - bin/commands/api.rb
 - bin/commands/apps_permissions.rb
+- bin/commands/apps_permissions_resources.rb
+- bin/commands/apps_permissions_scopes.rb
+- bin/commands/apps_permissions_users.rb
 - bin/commands/auth.rb
 - bin/commands/bots.rb
 - bin/commands/channels.rb
@@ -298,6 +301,9 @@ files:
 - lib/slack/web/api/endpoints.rb
 - lib/slack/web/api/endpoints/api.rb
 - lib/slack/web/api/endpoints/apps_permissions.rb
+- lib/slack/web/api/endpoints/apps_permissions_resources.rb
+- lib/slack/web/api/endpoints/apps_permissions_scopes.rb
+- lib/slack/web/api/endpoints/apps_permissions_users.rb
 - lib/slack/web/api/endpoints/auth.rb
 - lib/slack/web/api/endpoints/bots.rb
 - lib/slack/web/api/endpoints/channels.rb
@@ -345,6 +351,7 @@ files:
 - lib/slack/web/api/patches/chat.2.attachments-json.patch
 - lib/slack/web/api/patches/chat.3.update-attachments-support.patch
 - lib/slack/web/api/patches/chat.4.postEphemeral-attachments-support.patch
+- lib/slack/web/api/patches/chat.5.postEphemeral-text-or-attachments.patch
 - lib/slack/web/api/patches/dialog.1.open-json-support.patch
 - lib/slack/web/api/schema/group.json
 - lib/slack/web/api/schema/method.json
@@ -401,7 +408,10 @@ files:
 - spec/slack/slack_spec.rb
 - spec/slack/version_spec.rb
 - spec/slack/web/api/endpoints/api_spec.rb
+- spec/slack/web/api/endpoints/apps_permissions_resources_spec.rb
+- spec/slack/web/api/endpoints/apps_permissions_scopes_spec.rb
 - spec/slack/web/api/endpoints/apps_permissions_spec.rb
+- spec/slack/web/api/endpoints/apps_permissions_users_spec.rb
 - spec/slack/web/api/endpoints/bots_spec.rb
 - spec/slack/web/api/endpoints/conversations_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/auth_spec.rb
@@ -467,7 +477,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Slack Web and RealTime API client.
@@ -506,7 +516,10 @@ test_files:
 - spec/slack/slack_spec.rb
 - spec/slack/version_spec.rb
 - spec/slack/web/api/endpoints/api_spec.rb
+- spec/slack/web/api/endpoints/apps_permissions_resources_spec.rb
+- spec/slack/web/api/endpoints/apps_permissions_scopes_spec.rb
 - spec/slack/web/api/endpoints/apps_permissions_spec.rb
+- spec/slack/web/api/endpoints/apps_permissions_users_spec.rb
 - spec/slack/web/api/endpoints/bots_spec.rb
 - spec/slack/web/api/endpoints/conversations_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/auth_spec.rb