slack-ruby-client 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4523b02fb8e41e2a529f21283e9631aca6e04bb
-  data.tar.gz: 6324f7a54941b201b7aa729178418241accf836c
+SHA256:
+  metadata.gz: 488002a6ea8cb58f2aeb4e21d5008c47fae73f4d6c6d8d9930a324f1b24492dd
+  data.tar.gz: b05b1307ff8f64000eccecf83b7cf818bcebcace33c1e3232691680c109a562d
 SHA512:
-  metadata.gz: 958f43b8c6c3591d81761e60c310c6cf2638b26ab79b9bf56748768a2e8800fdad85733262c5a93d4272b3861f475b2cbb2f1eabb01fadb3a2848a09c82be3d7
-  data.tar.gz: 1787862cbf85c3cd762c8b044afd89d98c92ee0cd959aaf94da5b5d513cd3c24c3d8de005eece992a5f13ed76a8279231d40d8ade39dd32c4efe692c9118b79c
+  metadata.gz: 4beafc46990017ebe15b2860f7f601968fc0df6cf195e3b5a79fa173e59b4d8f34dbc4fe29c969b3be545d7b1c15046589d4446560ce6d032aaaa6ecd6b0e3bc
+  data.tar.gz: e2acea4de6fe0d5517cc8294c6712f4bea8aa35aec9630b1a8c6f7c3144d78a36063a8ec59f91c0fbc73c0c7dd96be582a7ba656872298dc81ed1a03c1dc87fd

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.11.1 (1/23/2017)
+
+* [#187](https://github.com/slack-ruby/slack-ruby-client/pull/187): Concatenate error message when multiple errors present - [@chrislopresto](https://github.com/chrislopresto).
+* [#188](https://github.com/slack-ruby/slack-ruby-client/pull/188): Fixed `NoMethodError` when Slack is unavailable - [@sonicdoe](https://github.com/sonicdoe).
+* [#196](https://github.com/slack-ruby/slack-ruby-client/pull/196): Added `users_lookupByEmail` - [@manuelmeurer](https://github.com/manuelmeurer).
+* [#185](https://github.com/slack-ruby/slack-ruby-client/pull/185): Calling undocumented endpoints will now produce a warning - [@aviflombaum](https://github.com/aviflombaum).
+
 ### 0.11.0 (11/25/2017)
 
 * [#173](https://github.com/slack-ruby/slack-ruby-client/issues/173): Added dialog support - [@alexagranov](https://github.com/alexagranov).

data/README.md

@@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.11.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **next** release of slack-ruby-client. Please see the documentation for the [last stable release, v0.11.1](https://github.com/slack-ruby/slack-ruby-client/blob/v0.11.1/README.md) unless you're integrating with HEAD. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -184,6 +184,10 @@ You can also pass request options, including `timeout` and `open_timeout` into i
 client.channels_list(request: { timeout: 180 })
 ```
 
+You can also control what proxy options are used by modifying the `http_proxy` environment variable per [Net::HTTP's documentation](https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#class-Net::HTTP-label-Proxies).
+
+Note that Docker on OSX seems to incorrectly set the proxy, causing `Faraday::ConnectionFailed, ERROR -- : Failed to open TCP connection to : (getaddrinfo: Name or service not known)`. You might need to manually unset `http_proxy` in that case, eg. `http_proxy="" bundle exec ruby ./my_bot.rb`.
+
 #### Pagination Support
 
 The Web client natively supports [cursor pagination](https://api.slack.com/docs/pagination#cursors) for methods that allow it, such as `users_list`. Supply a block and the client will make repeated requests adjusting the value of `cursor` with every response. The default limit is set to 100 and can be adjusted via `Slack::Web::Client.config.default_page_size` or by passing it directly into the API call.
@@ -210,6 +214,14 @@ end
 all_members # many thousands of team members retrieved 10 at a time
 ```
 
+#### Error Handling
+
+If a request fails, a `Slack::Web::Api::Errors::SlackError` will be raised. The error message contains the error code. In case of multiple errors, the error codes are separated by commas. The original response is also accessible using the `response` attribute.
+
+If you exceed [Slack’s rate limits](https://api.slack.com/docs/rate-limits), a `Slack::Web::Api::Errors::TooManyRequestsError` will be raised instead.
+
+In any other case, a `Faraday::ClientError` will be raised. This may be the case if Slack is temporarily unavailable, for example.
+
 ### RealTime Client
 
 The Real Time Messaging API is a WebSocket-based API that allows you to receive events from Slack in real time and send messages as user.

data/bin/commands/conversations.rb

@@ -35,6 +35,7 @@ command 'conversations' do |g|
   g.command 'history' do |c|
     c.flag 'channel', desc: 'Conversation ID to fetch history for.'
     c.flag 'cursor', desc: "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."
+    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
     c.flag 'latest', desc: 'End of time range of messages to include in results.'
     c.flag 'limit', desc: "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."
     c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
@@ -141,7 +142,10 @@ command 'conversations' do |g|
     c.flag 'channel', desc: 'Conversation ID to fetch thread from.'
     c.flag 'ts', desc: "Unique identifier of a thread's parent message."
     c.flag 'cursor', desc: "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."
+    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results only when either timestamp is specified.'
+    c.flag 'latest', desc: 'End of time range of messages to include in results.'
     c.flag 'limit', desc: "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."
+    c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.conversations_replies(options))
     end

data/bin/commands/users.rb

@@ -52,12 +52,21 @@ command 'users' do |g|
     c.flag 'cursor', desc: "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."
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for users. Defaults to false.'
     c.flag 'limit', desc: "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."
-    c.flag 'presence', desc: 'Whether to include presence data in the output. Setting this to false improves performance, especially with large teams.'
+    c.flag 'presence', desc: 'Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance, especially with large teams.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_list(options))
     end
   end
 
+  g.desc 'Find a user with an email address.'
+  g.long_desc %( Find a user with an email address. )
+  g.command 'lookupByEmail' do |c|
+    c.flag 'email', desc: 'An email address belonging to a user in the workspace.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_lookupByEmail(options))
+    end
+  end
+
   g.desc 'This method searches for users.'
   g.long_desc %( This method searches for users. )
   g.command 'search' do |c|

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.11.1'.freeze
 end

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

@@ -41,6 +41,7 @@ module Slack
           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
 

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

@@ -19,6 +19,7 @@ module Slack
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :command missing') if options[:command].nil?
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            logger.warn('The chat.command method is undocumented.')
             post('chat.command', options)
           end
 

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

@@ -52,6 +52,8 @@ module Slack
           #   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 [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results only when either timestamp is specified.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
           # @option options [Object] :limit
@@ -233,8 +235,14 @@ module Slack
           #   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] :inclusive
+          #   Include messages with latest or oldest timestamp in results only when either timestamp is specified.
+          # @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.replies
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/conversations/conversations.replies.json
           def conversations_replies(options = {})

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

@@ -30,6 +30,7 @@ module Slack
           def files_edit(options = {})
             throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             throw ArgumentError.new('Required arguments :title missing') if options[:title].nil?
+            logger.warn('The files.edit method is undocumented.')
             post('files.edit', options)
           end
 
@@ -102,6 +103,7 @@ module Slack
             throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             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 files.share method is undocumented.')
             post('files.share', options)
           end
 

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

@@ -61,7 +61,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. Setting this to false improves performance, especially with large teams.
+          #   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 = {})
@@ -74,6 +74,18 @@ module Slack
             end
           end
 
+          #
+          # Find a user with an email address.
+          #
+          # @option options [Object] :email
+          #   An email address belonging to a user in the workspace.
+          # @see https://api.slack.com/methods/users.lookupByEmail
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.lookupByEmail.json
+          def users_lookupByEmail(options = {})
+            throw ArgumentError.new('Required arguments :email missing') if options[:email].nil?
+            post('users.lookupByEmail', options)
+          end
+
           #
           # Marks a user as active.
           #

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

@@ -25,6 +25,7 @@ module Slack
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/users.admin/users.admin.invite.json
           def users_admin_invite(options = {})
             throw ArgumentError.new('Required arguments :email missing') if options[:email].nil?
+            logger.warn('The users.admin.invite method is undocumented.')
             post('users.admin.invite', options)
           end
 
@@ -37,6 +38,7 @@ module Slack
           def users_admin_setInactive(options = {})
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            logger.warn('The users.admin.setInactive method is undocumented.')
             post('users.admin.setInactive', options)
           end
         end

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

@@ -10,6 +10,7 @@ module Slack
           #
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/undocumented/users.prefs/users.prefs.get.json
           def users_prefs_get(options = {})
+            logger.warn('The users.prefs.get method is undocumented.')
             post('users.prefs.get', options)
           end
         end

data/lib/slack/web/api/templates/method.erb

@@ -44,6 +44,9 @@ module Slack
 <% if data['args']['user'] %>
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
 <% end %>
+<% if data['undocumented'] %>
+            logger.warn('The <%= group %>.<%= name %> method is undocumented.')
+<% end %>
 <% if data['args'].keys.include?('cursor') %>
             if block_given?
               Pagination::Cursor.new(self, :<%= group.gsub(".", "_") %>_<%= name %>, options).each do |page|

data/lib/slack/web/faraday/response/raise_error.rb

@@ -6,10 +6,9 @@ module Slack
           def on_complete(env)
             if env.status == 429
               raise Slack::Web::Api::Errors::TooManyRequestsError, env.response
-            elsif (body = env.body) && body['ok']
-              nil
-            else
-              raise Slack::Web::Api::Errors::SlackError.new(body['error'], env.response)
+            elsif (body = env.body) && !body['ok']
+              error_message = body['error'] || body['errors'].map { |message| message['error'] }.join(',')
+              raise Slack::Web::Api::Errors::SlackError.new(error_message, env.response)
             end
           end
         end

data/spec/fixtures/slack/web/503_error.yml

@@ -0,0 +1,14 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://slack.com/api/auth.test
+  response:
+    status:
+      code: 503
+      message: Service Unavailable
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Thu, 30 Nov 2017 14:36:26 GMT

data/spec/slack/web/api/errors/service_unavailable_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Client do
+  let(:client) { Slack::Web::Client.new }
+  it 'raises a Faraday::ClientError when Slack is unavailable', vcr: { cassette_name: 'web/503_error' } do
+    begin
+      client.auth_test
+      raise 'Expected to receive Faraday::ClientError.'
+    rescue Faraday::ClientError => e
+      expect(e.response).to_not be_nil
+      expect(e.response[:status]).to eq 503
+    end
+  end
+end

data/spec/slack/web/client_spec.rb

@@ -170,5 +170,13 @@ RSpec.describe Slack::Web::Client do
         expect(request.options.timeout).to eq 3
       end
     end
+    context 'calling undocumented methods' do
+      let(:client) { Slack::Web::Client.new }
+      it 'produces a warning' do
+        expect(client.logger).to receive(:warn).with('The users.admin.setInactive method is undocumented.')
+        expect(client).to receive(:post)
+        client.users_admin_setInactive(user: 'U092BDCLV')
+      end
+    end
   end
 end

data/spec/slack/web/faraday/response/raise_error_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Faraday::Response::RaiseError do
+  describe '#on_complete' do
+    let(:subject) { described_class.new }
+    let(:status) { 200 }
+    let(:response) { nil }
+    let(:body) { {} }
+    let(:env) { double status: status, response: response, body: body }
+
+    context 'with status of 429' do
+      let(:status) { 429 }
+
+      it 'raises a TooManyRequestsError' do
+        expect { subject.on_complete(env) }.to raise_error(Slack::Web::Api::Errors::TooManyRequestsError)
+      end
+    end
+
+    context 'with an ok payload in the body' do
+      let(:body) { { 'ok' => 'true' } }
+
+      it 'is nil' do
+        expect(subject.on_complete(env)).to eq nil
+      end
+    end
+
+    context 'with a single error in the body' do
+      let(:body) { { 'error' => 'already_in_channel' } }
+
+      it 'raises a SlackError with the error message' do
+        expect { subject.on_complete(env) }.to raise_error(Slack::Web::Api::Errors::SlackError, 'already_in_channel')
+      end
+    end
+
+    context 'with multiple errors in the body' do
+      let(:body) do
+        {
+          'errors' => [
+            { 'error' => 'already_in_channel' },
+            { 'error' => 'something_else_terrible' }
+          ]
+        }
+      end
+
+      it 'raises a SlackError with the concatenated error messages' do
+        expect { subject.on_complete(env) }.to raise_error(Slack::Web::Api::Errors::SlackError, 'already_in_channel,something_else_terrible')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-25 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -368,6 +368,7 @@ files:
 - slack-ruby-client.gemspec
 - slack.png
 - spec/fixtures/slack/web/429_error.yml
+- spec/fixtures/slack/web/503_error.yml
 - spec/fixtures/slack/web/auth_test_error.yml
 - spec/fixtures/slack/web/auth_test_success.yml
 - spec/fixtures/slack/web/channels_info.yml
@@ -431,12 +432,14 @@ files:
 - spec/slack/web/api/endpoints/users_prefs_spec.rb
 - spec/slack/web/api/endpoints/users_profile_spec.rb
 - spec/slack/web/api/error_spec.rb
+- spec/slack/web/api/errors/service_unavailable_spec.rb
 - spec/slack/web/api/errors/slack_error_spec.rb
 - spec/slack/web/api/mixins/channels_spec.rb
 - spec/slack/web/api/mixins/groups_spec.rb
 - spec/slack/web/api/mixins/users_spec.rb
 - spec/slack/web/api/pagination/cursor_spec.rb
 - spec/slack/web/client_spec.rb
+- spec/slack/web/faraday/response/raise_error_spec.rb
 - spec/spec_helper.rb
 - spec/support/queue_with_timeout.rb
 - spec/support/real_time/concurrency/mock.rb
@@ -464,12 +467,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Slack Web and RealTime API client.
 test_files:
 - spec/fixtures/slack/web/429_error.yml
+- spec/fixtures/slack/web/503_error.yml
 - spec/fixtures/slack/web/auth_test_error.yml
 - spec/fixtures/slack/web/auth_test_success.yml
 - spec/fixtures/slack/web/channels_info.yml
@@ -533,12 +537,14 @@ test_files:
 - spec/slack/web/api/endpoints/users_prefs_spec.rb
 - spec/slack/web/api/endpoints/users_profile_spec.rb
 - spec/slack/web/api/error_spec.rb
+- spec/slack/web/api/errors/service_unavailable_spec.rb
 - spec/slack/web/api/errors/slack_error_spec.rb
 - spec/slack/web/api/mixins/channels_spec.rb
 - spec/slack/web/api/mixins/groups_spec.rb
 - spec/slack/web/api/mixins/users_spec.rb
 - spec/slack/web/api/pagination/cursor_spec.rb
 - spec/slack/web/client_spec.rb
+- spec/slack/web/faraday/response/raise_error_spec.rb
 - spec/spec_helper.rb
 - spec/support/queue_with_timeout.rb
 - spec/support/real_time/concurrency/mock.rb