slack-ruby-client 0.7.9 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad6bf56a73816447c713f921c5bee06d94bf7d95
-  data.tar.gz: aff21372999f08aafa6b544d9ae098b4ebebeb2e
+  metadata.gz: 0c6d144362dda5a6aeaa3beeb8ec0e1885061898
+  data.tar.gz: e6d9ec22b44554a6f5d89fdbcc794effcef152a1
 SHA512:
-  metadata.gz: c216963c1c8fcf6868d7270cde48e36d8cd197d2e9e416ab7817f34929561d5c1c615f9498f3732fb4aefab4dcf9c6d02fd3ba82a6dfe34cceeb315c6cb700a4
-  data.tar.gz: 8eb35d81456afb96689bc3ef28912a0cd1438c0782a275179959819fcbebc2ecdd6ccce6cb537e3ce90009802070127fb2cdc5a8e6d11524e7b5649d5a8919ac
+  metadata.gz: 0f5e30d233a1cd645a672715856bbf3300533e473c1c51f6b3181def7ee6614dfc3ea46f3dcf721614a78f1a6c4720c852f934a0ace4462f07dd20dae1ddebb8
+  data.tar.gz: bbf97b47897ba11828defcba59189fb84a9824b3f8e39556b42d0c6da9313c85f89dad822fc6fb329a4a59efe4ce850fe11f69b8a60ba5a00a180a8d7f770d59

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.8.0 (3/12/2017)
+
+* [#135](https://github.com/slack-ruby/slack-ruby-client/issues/135): Added `timeout` and `open_timeout` options to Web API - [@dblock](https://github.com/dblock).
+* [#134](https://github.com/slack-ruby/slack-ruby-client/issues/134): Set `start_options[:request][:timeout]`, used with `rtm.start` in `Slack::RealTime::Client`, to 180 seconds - [@dblock](https://github.com/dblock).
+* [#136](https://github.com/slack-ruby/slack-ruby-client/pull/136): Pass request options in web client calls - [@dblock](https://github.com/dblock).
+* [#121](https://github.com/slack-ruby/slack-ruby-client/pull/121): Fix: check that the current Celluloid actor is running before calling `terminate` - [@newdark](https://github.com/newdark).
+* [#138](https://github.com/slack-ruby/slack-ruby-client/pull/138): Added `validate` option to `channels_create`, `channels_join`, `channels_rename`, `groups_create` and `groups_rename` Web APIs - [@dblock](https://github.com/dblock).
+* [#138](https://github.com/slack-ruby/slack-ruby-client/pull/138): Removed `channel` option from `files_comments_add` Web API - [@dblock](https://github.com/dblock).
+
 ### 0.7.9 (2/9/2017)
 
 * [#132](https://github.com/slack-ruby/slack-ruby-client/issues/132): Fix: you are setting a key that conflicts with a built-in method Slack::Messages::Message#presence - [@dblock](https://github.com/dblock).

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.7.9. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.8.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -173,6 +173,14 @@ ca_path      | Optional SSL certificates path.
 ca_file      | Optional SSL certificates file.
 endpoint     | Slack endpoint, default is _https://slack.com/api_.
 logger       | Optional `Logger` instance that logs HTTP requests.
+timeout      | Optional open/read timeout in seconds.
+open_timeout | Optional connection open timeout in seconds.
+
+You can also pass request options, including `timeout` and `open_timeout` into individual calls.
+
+```ruby
+client.channels_list(request: { timeout: 180 })
+```
 
 ### RealTime Client
 
@@ -264,7 +272,7 @@ token           | Slack API token.
 websocket_ping  | The number of seconds that indicates how often the WebSocket should send ping frames, default is 30.
 websocket_proxy | Connect via proxy, include `:origin` and `:headers`.
 store_class     | Local store class name, default is an in-memory `Slack::RealTime::Stores::Store`.
-start_options   | Options to pass into `rtm.start`, default is `{}`.
+start_options   | Options to pass into `rtm.start`, default is `{ request: { timeout: 180 } }`.
 logger          | Optional `Logger` instance that logs RealTime requests and socket data.
 
 Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start). While `token` and `logger` options are passed down from the RealTime client, you may also configure Web client options via `Slack::Web::Client.configure` as described above.
@@ -292,10 +300,27 @@ end
 client.start!
 ```
 
-See a fullly working example in [examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb).
+See a fully working example in [examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb).
 
 ![](examples/hi_real_time_and_web/hi.gif)
 
+### Large Team Considerations
+
+The `rtm.start` call downloads a large amount of data. For large teams, consider reducing the amount of unnecessary data downloaded with `start_options`. You may also want to increase the default timeout of 180 seconds.
+
+```ruby
+Slack::RealTime::Client.config do |config|
+  # Return timestamp only for latest message object of each channel.
+  config.start_options[:simple_latest] = true
+  # Skip unread counts for each channel.
+  config.start_options[:no_unreads] = true
+  # Increase request timeout to 6 minutes.
+  config.start_options[:request][:timeout] = 360
+end
+```
+
+See [#134](https://github.com/slack-ruby/slack-ruby-client/issues/134) for a discussion on this topic.
+
 #### Concurrency
 
 `Slack::RealTime::Client` needs help from a concurrency library and supports [Faye::WebSocket](https://github.com/faye/faye-websocket-ruby) with [Eventmachine](https://github.com/eventmachine/eventmachine) and [Celluloid](https://github.com/celluloid/celluloid). It will auto-detect one or the other depending on the gems in your Gemfile, but you can also set concurrency explicitly.

data/UPGRADING.md

@@ -1,6 +1,28 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 0.8.0
+
+The default timeout for `rtm.start` has been increased from 60 to 180 seconds via `Slack::RealTime::Client.config.start_options[:request][:timeout]`. If you're explicitly setting `start_options` in your application, preserve the value by merging settings instead of replacing the entire `start_options` value.
+
+Before:
+
+```ruby
+Slack::RealTime::Client.config do |config|
+  config.start_options = { no_unreads: true }
+end
+```
+
+After:
+
+```ruby
+Slack::RealTime::Client.config do |config|
+  config.start_options[:no_unreads] = true # keeps config.start_options[:request] intact
+end
+```
+
+See [#136](https://github.com/slack-ruby/slack-ruby-client/pull/136) for more details.
+
 ### Upgrading to >= 0.6.0
 
 #### Changes to API Response Data

data/bin/commands/channels.rb

@@ -15,6 +15,7 @@ command 'channels' do |g|
   g.long_desc %( This method is used to create a channel. )
   g.command 'create' do |c|
     c.flag 'name', desc: 'Name of channel to create.'
+    c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.channels_create(options))
     end
@@ -56,6 +57,7 @@ command 'channels' do |g|
   g.long_desc %( This method is used to join a channel. If the channel does not exist, it is created. )
   g.command 'join' do |c|
     c.flag 'name', desc: 'Name of channel to join.'
+    c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.channels_join(options))
     end
@@ -104,6 +106,7 @@ command 'channels' do |g|
   g.command 'rename' do |c|
     c.flag 'channel', desc: 'Channel to rename.'
     c.flag 'name', desc: 'New name for channel.'
+    c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.channels_rename(options))
     end

data/bin/commands/files_comments.rb

@@ -7,7 +7,6 @@ command 'files_comments' do |g|
   g.command 'add' do |c|
     c.flag 'file', desc: 'File to add a comment to.'
     c.flag 'comment', desc: 'Text of the comment to add.'
-    c.flag 'channel', desc: 'Channel id (encoded) of which location to associate with the new comment.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_comments_add(options))
     end

data/bin/commands/groups.rb

@@ -24,6 +24,7 @@ command 'groups' do |g|
   g.long_desc %( This method creates a private channel. )
   g.command 'create' do |c|
     c.flag 'name', desc: 'Name of private channel to create.'
+    c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.groups_create(options))
     end
@@ -122,6 +123,7 @@ command 'groups' do |g|
   g.command 'rename' do |c|
     c.flag 'channel', desc: 'Private channel to rename.'
     c.flag 'name', desc: 'New name for private channel.'
+    c.flag 'validate', desc: 'Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.groups_rename(options))
     end

data/bin/commands/search.rb

@@ -8,7 +8,7 @@ command 'search' do |g|
     c.flag 'query', desc: 'Search query. May contains booleans, etc.'
     c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
     c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
-    c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
+    c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.search_all(options))
     end
@@ -20,7 +20,7 @@ command 'search' do |g|
     c.flag 'query', desc: 'Search query. May contain booleans, etc.'
     c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
     c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
-    c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
+    c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.search_files(options))
     end
@@ -32,7 +32,7 @@ command 'search' do |g|
     c.flag 'query', desc: 'Search query. May contains booleans, etc.'
     c.flag 'sort', desc: 'Return matches sorted by either score or timestamp.'
     c.flag 'sort_dir', desc: 'Change sort direction to ascending (asc) or descending (desc).'
-    c.flag 'highlight', desc: 'Pass a value of 1 to enable query highlight markers (see below).'
+    c.flag 'highlight', desc: 'Pass a value of true to enable query highlight markers (see below).'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.search_messages(options))
     end

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

@@ -38,7 +38,7 @@ module Slack
             logger.debug("#{self.class}##{__method__}") { e }
             driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')) unless @closing
           ensure
-            current_actor.terminate if current_actor.alive?
+            current_actor.terminate if current_actor.alive? && current_actor.running?
           end
 
           def close

data/lib/slack/real_time/config.rb

@@ -22,7 +22,7 @@ module Slack
         self.websocket_proxy = nil
         self.token = nil
         self.concurrency = method(:detect_concurrency)
-        self.start_options = {}
+        self.start_options = { request: { timeout: 180 } }
         self.store_class = Slack::RealTime::Store
         self.logger = nil
       end

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.7.9'.freeze
+  VERSION = '0.8.0'.freeze
 end

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

@@ -23,6 +23,8 @@ module Slack
           #
           # @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/dblock/slack-api-ref/blob/master/methods/channels/channels.create.json
           def channels_create(options = {})
@@ -87,6 +89,8 @@ module Slack
           #
           # @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/dblock/slack-api-ref/blob/master/methods/channels/channels.join.json
           def channels_join(options = {})
@@ -158,6 +162,8 @@ module Slack
           #   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/dblock/slack-api-ref/blob/master/methods/channels/channels.rename.json
           def channels_rename(options = {})

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

@@ -12,14 +12,11 @@ module Slack
           #   File to add a comment to.
           # @option options [Object] :comment
           #   Text of the comment to add.
-          # @option options [channel] :channel
-          #   Channel id (encoded) of which location to associate with the new comment.
           # @see https://api.slack.com/methods/files.comments.add
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.comments/files.comments.add.json
           def files_comments_add(options = {})
             throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
-            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('files.comments.add', options)
           end
 

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

@@ -36,6 +36,8 @@ module Slack
           #
           # @option options [Object] :name
           #   Name of private 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/groups.create
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.create.json
           def groups_create(options = {})
@@ -187,6 +189,8 @@ module Slack
           #   Private channel to rename.
           # @option options [Object] :name
           #   New name for private 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/groups.rename
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.rename.json
           def groups_rename(options = {})

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

@@ -15,7 +15,7 @@ module Slack
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
           # @option options [Object] :highlight
-          #   Pass a value of 1 to enable query highlight markers (see below).
+          #   Pass a value of true to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.all
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.all.json
           def search_all(options = {})
@@ -33,7 +33,7 @@ module Slack
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
           # @option options [Object] :highlight
-          #   Pass a value of 1 to enable query highlight markers (see below).
+          #   Pass a value of true to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.files
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.files.json
           def search_files(options = {})
@@ -51,7 +51,7 @@ module Slack
           # @option options [Object] :sort_dir
           #   Change sort direction to ascending (asc) or descending (desc).
           # @option options [Object] :highlight
-          #   Pass a value of 1 to enable query highlight markers (see below).
+          #   Pass a value of true to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.messages
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search/search.messages.json
           def search_messages(options = {})

data/lib/slack/web/config.rb

@@ -10,7 +10,9 @@ module Slack
         :ca_file,
         :logger,
         :endpoint,
-        :token
+        :token,
+        :timeout,
+        :open_timeout
       ].freeze
 
       attr_accessor(*Config::ATTRIBUTES)
@@ -23,6 +25,8 @@ module Slack
         self.token = nil
         self.proxy = nil
         self.logger = nil
+        self.timeout = nil
+        self.open_timeout = nil
       end
     end
 

data/lib/slack/web/faraday/connection.rb

@@ -13,6 +13,11 @@ module Slack
           options[:proxy] = proxy if proxy
           options[:ssl] = { ca_path: ca_path, ca_file: ca_file }
 
+          request_options = {}
+          request_options[:timeout] = timeout if timeout
+          request_options[:open_timeout] = open_timeout if open_timeout
+          options[:request] = request_options if request_options.any?
+
           ::Faraday::Connection.new(endpoint, options) do |connection|
             connection.use ::Faraday::Request::Multipart
             connection.use ::Faraday::Request::UrlEncoded

data/lib/slack/web/faraday/request.rb

@@ -30,6 +30,7 @@ module Slack
               request.path = path
               request.body = options unless options.empty?
             end
+            request.options.merge!(options.delete(:request)) if options.key?(:request)
           end
           response.body
         end

data/spec/slack/real_time/client_spec.rb

@@ -206,7 +206,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
           client.start!
         end
         it 'sets start_options' do
-          expect(client.start_options).to eq({})
+          expect(client.start_options).to eq(request: { timeout: 180 })
         end
       end
     end

data/spec/slack/web/client_spec.rb

@@ -130,5 +130,45 @@ RSpec.describe Slack::Web::Client do
         end
       end
     end
+    context 'timeout options' do
+      before do
+        Slack::Web::Client.configure do |config|
+          config.timeout = 10
+          config.open_timeout = 15
+        end
+      end
+      describe '#initialize' do
+        it 'sets timeout and open_timeout' do
+          expect(client.timeout).to eq 10
+          expect(client.open_timeout).to eq 15
+        end
+        it 'creates a connection with timeout options' do
+          conn = client.send(:connection)
+          expect(conn.options.timeout).to eq 10
+          expect(conn.options.open_timeout).to eq 15
+        end
+      end
+    end
+    context 'per-request options' do
+      it 'applies timeout', vcr: { cassette_name: 'web/rtm_start', allow_playback_repeats: true } do
+        # reuse the same connection for the test, otherwise it creates a new one every time
+        conn = client.send(:connection)
+        expect(client).to receive(:connection).and_return(conn)
+
+        # get the yielded request to reuse in the next call to rtm_start so that we can examine request.options later
+        request = nil
+        response = conn.post do |r|
+          r.path = 'rtm.start'
+          r.body = { token: 'token' }
+          request = r
+        end
+
+        expect(conn).to receive(:post).and_yield(request).and_return(response)
+
+        client.rtm_start(request: { timeout: 3 })
+
+        expect(request.options.timeout).to eq 3
+      end
+    end
   end
 end

data/spec/support/vcr.rb

@@ -4,6 +4,6 @@ require 'webmock/rspec'
 VCR.configure do |config|
   config.cassette_library_dir = 'spec/fixtures/slack'
   config.hook_into :webmock
-  config.default_cassette_options = { record: :new_episodes }
+  # config.default_cassette_options = { record: :new_episodes }
   config.configure_rspec_metadata!
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.8.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport