slack-ruby-client 0.9.0 → 0.9.1

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module UsergroupsUsers
           #
-          # This method returns a list of all users within a User Group.
+          # List all users in a User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.
@@ -20,7 +20,7 @@ module Slack
           end
 
           #
-          # 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.
+          # Update the list of users for a User Group
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Users
           #
-          # This method allows the user to delete their profile image. It will clear whatever image is currently set.
+          # Delete the user profile photo
           #
           # @see https://api.slack.com/methods/users.deletePhoto
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.deletePhoto.json
@@ -15,8 +15,7 @@ module Slack
           end
 
           #
-          # This method lets you find out information about a user's presence.
-          # Consult the presence documentation for more details.
+          # Gets user presence information.
           #
           # @option options [user] :user
           #   User to get presence info on. Defaults to the authed user.
@@ -29,7 +28,7 @@ module Slack
           end
 
           #
-          # After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity.
+          # Get a user's identity.
           #
           # @see https://api.slack.com/methods/users.identity
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.identity.json
@@ -38,7 +37,7 @@ module Slack
           end
 
           #
-          # This method returns information about a team member.
+          # Gets information about a user.
           #
           # @option options [user] :user
           #   User to get info on.
@@ -51,10 +50,14 @@ module Slack
           end
 
           #
-          # This method returns a list of all users in the team. This includes deleted/deactivated users.
+          # Lists all users 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] :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.
+          #   Whether to include presence data in the output. Setting this to false improves performance, especially with large teams.
           # @see https://api.slack.com/methods/users.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.list.json
           def users_list(options = {})
@@ -62,9 +65,7 @@ module Slack
           end
 
           #
-          # This method lets the slack messaging server know that the authenticated user
-          # is currently active. Consult the presence documentation for
-          # more details.
+          # Marks a user as active.
           #
           # @see https://api.slack.com/methods/users.setActive
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.setActive.json
@@ -73,16 +74,16 @@ module Slack
           end
 
           #
-          # This method allows the user to set their profile image. The caller can pass image data via image.
+          # Set the user profile photo
           #
           # @option options [Object] :image
           #   File contents via multipart/form-data.
+          # @option options [Object] :crop_w
+          #   Width/height of crop box (always square).
           # @option options [Object] :crop_x
           #   X coordinate of top-left corner of crop box.
           # @option options [Object] :crop_y
           #   Y coordinate of top-left corner of crop box.
-          # @option options [Object] :crop_w
-          #   Width/height of crop box (always square).
           # @see https://api.slack.com/methods/users.setPhoto
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.setPhoto.json
           def users_setPhoto(options = {})
@@ -91,8 +92,7 @@ module Slack
           end
 
           #
-          # This method lets you set the calling user's manual presence.
-          # Consult the presence documentation for more details.
+          # Manually sets user presence.
           #
           # @option options [Object] :presence
           #   Either auto or away.

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

@@ -6,12 +6,12 @@ module Slack
       module Endpoints
         module UsersProfile
           #
-          # Use this method to retrieve a user's profile information.
+          # Retrieves a user's profile information.
           #
-          # @option options [user] :user
-          #   User to retrieve profile info for.
           # @option options [Object] :include_labels
           #   Include labels for each ID in custom profile fields.
+          # @option options [user] :user
+          #   User to retrieve profile info for.
           # @see https://api.slack.com/methods/users.profile.get
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.profile/users.profile.get.json
           def users_profile_get(options = {})
@@ -20,14 +20,14 @@ module Slack
           end
 
           #
-          # Use this method to set a user's profile information, including name, email, current status, and other attributes.
+          # Set the profile information for a user.
           #
-          # @option options [user] :user
-          #   ID of user to change. This argument may only be specified by team admins on paid teams.
-          # @option options [Object] :profile
-          #   Collection of key:value pairs presented as a URL-encoded JSON hash.
           # @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.
+          # @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
           #   Value to set a single key to. Usable only if profile is not passed.
           # @see https://api.slack.com/methods/users.profile.set

data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch

@@ -1,13 +1,14 @@
 diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
-index 0db7e67..1c3b2ee 100644
+index 5186416..490bc91 100644
 --- a/lib/slack/web/api/endpoints/chat.rb
 +++ b/lib/slack/web/api/endpoints/chat.rb
-@@ -82,8 +82,14 @@ module Slack
+@@ -154,9 +154,15 @@ module Slack
+           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat/chat.update.json
            def chat_update(options = {})
-             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
              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 :ts missing') if options[:ts].nil?
              options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
 +            # attachments must be passed as an encoded JSON string
 +            if options.key?(:attachments)

data/lib/slack/web/api/patches/chat.4.postEphemeral-attachments-support.patch

@@ -0,0 +1,17 @@
+diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
+index 846126e..0c254c6 100644
+--- a/lib/slack/web/api/endpoints/chat.rb
++++ b/lib/slack/web/api/endpoints/chat.rb
+@@ -62,6 +62,12 @@ module Slack
+             throw ArgumentError.new('Required arguments :text missing') if options[:text].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
++            if options.key?(:attachments)
++              attachments = options[:attachments]
++              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
++              options = options.merge(attachments: attachments)
++            end
+             post('chat.postEphemeral', options)
+           end
+ 

data/spec/integration/integration_spec.rb

@@ -51,7 +51,7 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
   end
 
   def start_server
-    dt = rand(5) + 1
+    dt = rand(5) + 2
     logger.debug "#start_server, waiting #{dt} second(s)"
     sleep dt # prevent Slack 429 rate limit errors
     # start server and wait for on :open

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

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

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

@@ -2,6 +2,42 @@ require 'spec_helper'
 
 RSpec.describe Slack::Web::Api::Endpoints::Chat do
   let(:client) { Slack::Web::Client.new }
+  context 'chat_postEphemeral' do
+    let(:user) { OpenStruct.new(user: { id: '123' }) }
+    before(:each) do
+      allow(described_class).to receive(:users_id).and_return(user)
+    end
+
+    it 'automatically converts attachments into JSON' do
+      expect(client).to receive(:post).with(
+        'chat.postEphemeral',
+        channel: 'channel',
+        text: 'text',
+        user: '123',
+        attachments: '[]'
+      )
+      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/
+      end
+      it 'requires user' do
+        expect { client.chat_postEphemeral(channel: 'channel', text: 'text') }.to raise_error ArgumentError, /Required arguments :user missing/
+      end
+      it 'both text and user' do
+        expect(client).to receive(:post).with('chat.postEphemeral', hash_including(text: 'text', user: '123'))
+        expect { client.chat_postEphemeral(channel: 'channel', text: 'text', user: '123') }.to_not raise_error
+      end
+    end
+    context 'attachments argument' do
+      it 'optional attachments' 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
+    end
+  end
+
   context 'chat_postMessage' do
     it 'automatically converts attachments into JSON' do
       expect(client).to receive(:post).with(
@@ -45,7 +81,7 @@ RSpec.describe Slack::Web::Api::Endpoints::Chat do
     end
     context 'ts arguments' do
       it 'requires ts' do
-        expect { client.chat_update(channel: 'channel') }.to raise_error ArgumentError, /Required arguments :ts missing>/
+        expect { client.chat_update(channel: 'channel', text: 'text') }.to raise_error ArgumentError, /Required arguments :ts missing>/
       end
     end
     context 'text and attachment arguments' do

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

@@ -5,12 +5,12 @@ require 'spec_helper'
 RSpec.describe Slack::Web::Api::Endpoints::FilesComments do
   let(:client) { Slack::Web::Client.new }
   context 'files.comments_add' do
-    it 'requires file' do
-      expect { client.files_comments_add(comment: 'Everyone should take a moment to read this file.') }.to raise_error ArgumentError, /Required arguments :file missing/
-    end
     it 'requires comment' do
       expect { client.files_comments_add(file: 'F1234467890') }.to raise_error ArgumentError, /Required arguments :comment missing/
     end
+    it 'requires file' do
+      expect { client.files_comments_add(comment: 'Everyone should take a moment to read this file.') }.to raise_error ArgumentError, /Required arguments :file missing/
+    end
   end
   context 'files.comments_delete' do
     it 'requires file' do
@@ -21,14 +21,14 @@ RSpec.describe Slack::Web::Api::Endpoints::FilesComments do
     end
   end
   context 'files.comments_edit' do
+    it 'requires comment' do
+      expect { client.files_comments_edit(file: 'F1234567890', id: 'Fc1234567890') }.to raise_error ArgumentError, /Required arguments :comment missing/
+    end
     it 'requires file' do
-      expect { client.files_comments_edit(id: 'Fc1234567890', comment: 'Everyone should take a moment to read this file, seriously.') }.to raise_error ArgumentError, /Required arguments :file missing/
+      expect { client.files_comments_edit(comment: 'Everyone should take a moment to read this file, seriously.', id: 'Fc1234567890') }.to raise_error ArgumentError, /Required arguments :file missing/
     end
     it 'requires id' do
-      expect { client.files_comments_edit(file: 'F1234567890', comment: 'Everyone should take a moment to read this file, seriously.') }.to raise_error ArgumentError, /Required arguments :id missing/
-    end
-    it 'requires comment' do
-      expect { client.files_comments_edit(file: 'F1234567890', id: 'Fc1234567890') }.to raise_error ArgumentError, /Required arguments :comment missing/
+      expect { client.files_comments_edit(comment: 'Everyone should take a moment to read this file, seriously.', file: 'F1234567890') }.to raise_error ArgumentError, /Required arguments :id missing/
     end
   end
 end

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

@@ -24,9 +24,4 @@ RSpec.describe Slack::Web::Api::Endpoints::Files do
       expect { client.files_sharedPublicURL }.to raise_error ArgumentError, /Required arguments :file missing/
     end
   end
-  context 'files_upload' do
-    it 'requires filename' do
-      expect { client.files_upload }.to raise_error ArgumentError, /Required arguments :filename missing/
-    end
-  end
 end

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

@@ -15,4 +15,15 @@ RSpec.describe Slack::Web::Api::Endpoints::Oauth do
       expect { client.oauth_access(client_id: '4b39e9-752c4', client_secret: '33fea0113f5b1') }.to raise_error ArgumentError, /Required arguments :code missing/
     end
   end
+  context 'oauth_token' do
+    it 'requires client_id' do
+      expect { client.oauth_token(client_secret: '33fea0113f5b1', code: 'ccdaa72ad') }.to raise_error ArgumentError, /Required arguments :client_id missing/
+    end
+    it 'requires client_secret' do
+      expect { client.oauth_token(client_id: '4b39e9-752c4', code: 'ccdaa72ad') }.to raise_error ArgumentError, /Required arguments :client_secret missing/
+    end
+    it 'requires code' do
+      expect { client.oauth_token(client_id: '4b39e9-752c4', client_secret: '33fea0113f5b1') }.to raise_error ArgumentError, /Required arguments :code missing/
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-06 00:00:00.000000000 Z
+date: 2017-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -230,6 +230,7 @@ files:
 - UPGRADING.md
 - bin/commands.rb
 - bin/commands/api.rb
+- bin/commands/apps_permissions.rb
 - bin/commands/auth.rb
 - bin/commands/bots.rb
 - bin/commands/channels.rb
@@ -305,6 +306,7 @@ files:
 - lib/slack/version.rb
 - 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/auth.rb
 - lib/slack/web/api/endpoints/bots.rb
 - lib/slack/web/api/endpoints/channels.rb
@@ -346,6 +348,7 @@ files:
 - lib/slack/web/api/patches/chat.1.text-attachments-required.patch
 - 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/schema/group.json
 - lib/slack/web/api/schema/method.json
 - lib/slack/web/api/templates/command.erb
@@ -398,6 +401,7 @@ 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_spec.rb
 - spec/slack/web/api/endpoints/bots_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/auth_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/channels_spec.rb
@@ -492,6 +496,7 @@ 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_spec.rb
 - spec/slack/web/api/endpoints/bots_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/auth_spec.rb
 - spec/slack/web/api/endpoints/custom_specs/channels_spec.rb