slack-ruby-client 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b96448be8f1c835685f93f3393f8920cae201f40
-  data.tar.gz: 425cd9b3c64c3ece99de2ee2fd678b088cee8332
+  metadata.gz: b4523b02fb8e41e2a529f21283e9631aca6e04bb
+  data.tar.gz: 6324f7a54941b201b7aa729178418241accf836c
 SHA512:
-  metadata.gz: 1ef45ffaa491253809ea56bbcdff87ca957ac483da23a3233b8167452e7cdf36f071fa94fd1cb123f1dd6eb148d6b590c64fee78d1df0301689d6ca8964d9bc1
-  data.tar.gz: 38041c875f7b29eb12b0345bae2b04664dab1d31d1eda39c408feabff8f3f180112c28be13b4909737474f6c06c70ccb48c3faf1ad2b6acd9384ec4dd6bf97b4
+  metadata.gz: 958f43b8c6c3591d81761e60c310c6cf2638b26ab79b9bf56748768a2e8800fdad85733262c5a93d4272b3861f475b2cbb2f1eabb01fadb3a2848a09c82be3d7
+  data.tar.gz: 1787862cbf85c3cd762c8b044afd89d98c92ee0cd959aaf94da5b5d513cd3c24c3d8de005eece992a5f13ed76a8279231d40d8ade39dd32c4efe692c9118b79c

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 Gemfile.lock
 .DS_Store
 .bundle
+.idea

data/.rubocop.yml

@@ -3,4 +3,7 @@ AllCops:
     - vendor/**/*
     - lib/slack/web/api/slack-api-ref/**/*
 
+Naming/MethodName:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-09-19 15:04:24 -0400 using RuboCop version 0.35.0.
+# on 2017-11-25 11:28:32 -0500 using RuboCop version 0.51.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,34 +14,38 @@ Lint/HandleExceptions:
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoreEmptyBlocks.
-Lint/UnusedBlockArgument:
+Lint/RescueWithoutErrorClass:
   Exclude:
-    - 'lib/slack/messages/formatting.rb'
+    - 'lib/slack/real_time/concurrency/celluloid.rb'
 
 # Offense count: 18
 Metrics/AbcSize:
   Max: 44
 
+# Offense count: 81
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 421
+
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 165
+  Max: 166
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:
   Max: 9
 
-# Offense count: 734
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 741
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
 Metrics/LineLength:
   Max: 266
 
-# Offense count: 9
+# Offense count: 10
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 32
+  Max: 42
 
 # Offense count: 1
 # Configuration parameters: CountComments.
@@ -52,28 +56,32 @@ Metrics/ModuleLength:
 Metrics/PerceivedComplexity:
   Max: 11
 
-# Offense count: 64
-# Configuration parameters: Exclude.
-Style/Documentation:
-  Enabled: false
-
 # Offense count: 1
-# Configuration parameters: Exclude.
-Style/FileName:
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 136
+# Offense count: 63
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 137
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
 
-# Offense count: 24
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/MethodName:
-  Enabled: false
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/slack/real_time/stores/store.rb'
+    - 'lib/slack/web/faraday/response/raise_error.rb'
 
 # Offense count: 3
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: module_function, extend_self
 Style/ModuleFunction:
   Exclude:
     - 'lib/slack/config.rb'
@@ -84,15 +92,3 @@ Style/ModuleFunction:
 Style/MultilineTernaryOperator:
   Exclude:
     - 'spec/support/real_time/connected_client.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RescueModifier:
-  Exclude:
-    - 'lib/slack/real_time/concurrency/celluloid.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/SpecialGlobalVars:
-  Exclude:
-    - 'lib/slack/messages/formatting.rb'

data/.travis.yml

@@ -5,7 +5,6 @@ cache: bundler
 rvm:
   - 2.2
   - 2.1
-  - 2.0
   - 2.3.4
   - ruby-head
   - jruby-head

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 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).
+* [#176](https://github.com/slack-ruby/slack-ruby-client/issues/176): Drop dependency on `json` gem - [@seuros](https://github.com/seuros).
+* [#177](https://github.com/slack-ruby/slack-ruby-client/pull/177): Fix api ref repo - [@manuelmeurer](https://github.com/manuelmeurer).
+* [#180](https://github.com/slack-ruby/slack-ruby-client/pull/180): Upgraded RuboCop 0.51.0 - [@dblock](https://github.com/dblock).
+* [#181](https://github.com/slack-ruby/slack-ruby-client/pull/181): Added `chat_getPermalink`, `migration_exchange` - [@dblock](https://github.com/dblock).
+* [#182](https://github.com/slack-ruby/slack-ruby-client/pull/182): Added undocumented methods support with `channels_delete`, `chat_command`, `files_edit`, `files_share`, `users_admin_invite`, `users_admin_setInactive` and `users_prefs_get` - [@dblock](https://github.com/dblock).
+
 ### 0.10.0 (9/19/2017)
 
 * [#169](https://github.com/slack-ruby/slack-ruby-client/pull/169): Added [Conversations API](https://api.slack.com/docs/conversations-api) - [@jmanian](https://github.com/jmanian).

data/CONTRIBUTING.md

@@ -65,7 +65,7 @@ Make sure that `bundle exec rake` completes without errors.
 
 ### Update Slack Web API
 
-Slack Web API is updated from https://github.com/dblock/slack-api-ref, a maintained, machine-readable version of Slack API Docs, generated by scraping [api.slack.com](https://api.slack.com). To update the Web API from the latest definition run the following Rake task.
+Slack Web API is updated from https://github.com/slack-ruby/slack-api-ref, a maintained, machine-readable version of Slack API Docs, generated by scraping [api.slack.com](https://api.slack.com). To update the Web API from the latest definition run the following Rake task.
 
 ```
 rake slack:api:update
@@ -78,7 +78,7 @@ Sometimes it's necessary to patch auto-generated Slack Web API methods. For exam
 Make a change to a generated file, for example `lib/slack/web/api/endpoints/chat.rb` and generate a patch.
 
 ```
-git diff HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
+git diff --no-color HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
 ```
 
 Run `rake slack:api:update` to ensure that the patch is cleanly applied. Implement a test for the added or modified functionality and commit the patch file.

data/Gemfile

@@ -3,8 +3,10 @@ source 'http://rubygems.org'
 gemspec
 
 gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
-gem 'picky' unless RUBY_PLATFORM == 'java'
+# rubocop:enable Bundler/OrderedGems
+
 gem 'activesupport', '~> 4.0'
+gem 'picky' unless RUBY_PLATFORM == 'java'
 
 group :test do
   gem 'slack-ruby-danger', '~> 0.1.0', require: false

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.10.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+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.
 
 ## Installation
 

data/Rakefile

@@ -14,7 +14,7 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]
 
 load 'tasks/git.rake'
 load 'tasks/web.rake'

data/bin/commands/channels.rb

@@ -21,6 +21,15 @@ command 'channels' do |g|
     end
   end
 
+  g.desc 'Delete a channel (undocumented)'
+  g.long_desc %( Delete a channel )
+  g.command 'delete' do |c|
+    c.flag 'channel', desc: 'Channel to delete.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_delete(options))
+    end
+  end
+
   g.desc 'Fetches history of messages and events from a channel.'
   g.long_desc %( Fetches history of messages and events from a channel. )
   g.command 'history' do |c|
@@ -34,6 +43,15 @@ command 'channels' do |g|
     end
   end
 
+  g.desc 'This method returns the ID of a team channel.'
+  g.long_desc %( This method returns the ID of a team channel. )
+  g.command 'id' do |c|
+    c.flag 'channel', desc: 'Channel to get ID for, prefixed with #.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_id(options))
+    end
+  end
+
   g.desc 'Gets information about a channel.'
   g.long_desc %( Gets information about a channel. )
   g.command 'info' do |c|
@@ -154,13 +172,4 @@ command 'channels' do |g|
       puts JSON.dump($client.channels_unarchive(options))
     end
   end
-
-  g.desc 'This method returns the ID of a team channel.'
-  g.long_desc %( This method returns the ID of a team channel. )
-  g.command 'id' do |c|
-    c.flag 'channel', desc: 'Channel to get ID for, prefixed with #.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.channels_id(options))
-    end
-  end
 end

data/bin/commands/chat.rb

@@ -2,17 +2,38 @@
 
 desc 'Post chat messages to Slack.'
 command 'chat' do |g|
+  g.desc 'Execute a slash command in a public channel (undocumented)'
+  g.long_desc %( Execute a slash command in a public channel )
+  g.command 'command' do |c|
+    c.flag 'channel', desc: 'Channel to execute the command in.'
+    c.flag 'command', desc: 'Slash command to be executed. Leading backslash is required.'
+    c.flag 'text', desc: 'Additional parameters provided to the slash command.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.chat_command(options))
+    end
+  end
+
   g.desc 'Deletes a message.'
   g.long_desc %( Deletes a message. )
   g.command 'delete' do |c|
     c.flag 'channel', desc: 'Channel containing the message to be deleted.'
     c.flag 'ts', desc: 'Timestamp of the message to be deleted.'
-    c.flag 'as_user', desc: 'Pass true to delete the message as the authed user. Bot users in this context are considered authed users.'
+    c.flag 'as_user', desc: 'Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.chat_delete(options))
     end
   end
 
+  g.desc 'Retrieve a permalink URL for a specific extant message'
+  g.long_desc %( Retrieve a permalink URL for a specific extant message )
+  g.command 'getPermalink' do |c|
+    c.flag 'channel', desc: 'The ID of the conversation or channel containing the message.'
+    c.flag 'message_ts', desc: "A message's ts value, uniquely identifying it within a channel."
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.chat_getPermalink(options))
+    end
+  end
+
   g.desc 'Share a me message into a channel.'
   g.long_desc %( Share a me message into a channel. )
   g.command 'meMessage' do |c|
@@ -77,10 +98,10 @@ command 'chat' do |g|
   g.long_desc %( Updates a message. )
   g.command 'update' do |c|
     c.flag 'channel', desc: 'Channel containing the message to be updated.'
-    c.flag 'text', desc: 'New text for the message, using the default formatting rules.'
+    c.flag 'text', desc: "New text for the message, using the default formatting rules. It's not required when presenting attachments."
     c.flag 'ts', desc: 'Timestamp of the message to be updated.'
     c.flag 'as_user', desc: 'Pass true to update the message as the authed user. Bot users in this context are considered authed users.'
-    c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string.'
+    c.flag 'attachments', desc: 'A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.'
     c.flag 'link_names', desc: 'Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.'
     c.flag 'parse', desc: 'Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.'
     c.action do |_global_options, options, _args|

data/bin/commands/dialog.rb

@@ -0,0 +1,14 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'Dialog methods.'
+command 'dialog' do |g|
+  g.desc 'Open a dialog with a user'
+  g.long_desc %( Open a dialog with a user )
+  g.command 'open' do |c|
+    c.flag 'dialog', desc: 'The dialog definition. This must be a JSON-encoded string.'
+    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.dialog_open(options))
+    end
+  end
+end

data/bin/commands/files.rb

@@ -11,6 +11,17 @@ command 'files' do |g|
     end
   end
 
+  g.desc 'Change the properties of a file (undocumented)'
+  g.long_desc %( Change the properties of a file )
+  g.command 'edit' do |c|
+    c.flag 'file', desc: 'ID of the file to be edited'
+    c.flag 'title', desc: 'New title of the file'
+    c.flag 'filetype', desc: 'New filetype of the file. See https://api.slack.com/types/file#file_types for a list of all supported types.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_edit(options))
+    end
+  end
+
   g.desc 'Gets information about a team file.'
   g.long_desc %( Gets information about a team file. )
   g.command 'info' do |c|
@@ -54,6 +65,16 @@ You can pass multiple values in the types argument, like types=spaces,snippets.T
     end
   end
 
+  g.desc 'Share an existing file in a channel (undocumented)'
+  g.long_desc %( Share an existing file in a channel )
+  g.command 'share' do |c|
+    c.flag 'file', desc: 'ID of the file to be shared'
+    c.flag 'channel', desc: 'Channel to share the file in. Works with both public (channel ID) and private channels (group ID).'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_share(options))
+    end
+  end
+
   g.desc 'Enables a file for public/external sharing.'
   g.long_desc %( Enables a file for public/external sharing. )
   g.command 'sharedPublicURL' do |c|

data/bin/commands/groups.rb

@@ -43,6 +43,15 @@ command 'groups' do |g|
     end
   end
 
+  g.desc 'This method returns the ID of a group.'
+  g.long_desc %( This method returns the ID of a group. )
+  g.command 'id' do |c|
+    c.flag 'channel', desc: 'Group channel to get ID for, prefixed with #.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.groups_id(options))
+    end
+  end
+
   g.desc 'Gets information about a private channel.'
   g.long_desc %( Gets information about a private channel. )
   g.command 'info' do |c|
@@ -86,7 +95,7 @@ command 'groups' do |g|
   g.long_desc %( Lists private channels that the calling user has access to. )
   g.command 'list' do |c|
     c.flag 'exclude_archived', desc: "Don't return archived private channels."
-    c.flag 'exclude_members', desc: 'Exlude the members from each group.'
+    c.flag 'exclude_members', desc: 'Exclude the members from each group.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.groups_list(options))
     end
@@ -160,13 +169,4 @@ command 'groups' do |g|
       puts JSON.dump($client.groups_unarchive(options))
     end
   end
-
-  g.desc 'This method returns the ID of a group.'
-  g.long_desc %( This method returns the ID of a group. )
-  g.command 'id' do |c|
-    c.flag 'channel', desc: 'Group channel to get ID for, prefixed with #.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.groups_id(options))
-    end
-  end
 end

data/bin/commands/migration.rb

@@ -0,0 +1,14 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'Migration methods.'
+command 'migration' do |g|
+  g.desc 'For Enterprise Grid workspaces, map local user IDs to global user IDs'
+  g.long_desc %( For Enterprise Grid workspaces, map local user IDs to global user IDs )
+  g.command 'exchange' do |c|
+    c.flag 'users', desc: 'A comma-separated list of user ids, up to 400 per request.'
+    c.flag 'to_old', desc: 'Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.migration_exchange(options))
+    end
+  end
+end

data/bin/commands/rtm.rb

@@ -5,8 +5,7 @@ command 'rtm' do |g|
   g.desc 'Starts a Real Time Messaging session.'
   g.long_desc %( Starts a Real Time Messaging session. )
   g.command 'connect' do |c|
-    c.flag 'batch_presence_aware', desc: 'Group presence change notices as presence_change_batch events when possible. See batching.'
-    c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
+    c.flag 'batch_presence_aware', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.rtm_connect(options))
     end
@@ -15,12 +14,11 @@ command 'rtm' do |g|
   g.desc 'Starts a Real Time Messaging session.'
   g.long_desc %( Starts a Real Time Messaging session. )
   g.command 'start' do |c|
-    c.flag 'batch_presence_aware', desc: 'Group presence change notices as presence_change_batch events when possible. See batching.'
+    c.flag 'batch_presence_aware', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for users and channels. Defaults to false.'
     c.flag 'mpim_aware', desc: 'Returns MPIMs to the client in the API response.'
     c.flag 'no_latest', desc: 'Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1.'
     c.flag 'no_unreads', desc: 'Skip unread counts for each channel (improves performance).'
-    c.flag 'presence_sub', desc: 'Only deliver presence events when requested by subscription. See presence subscriptions.'
     c.flag 'simple_latest', desc: 'Return timestamp only for latest message object of each channel (improves performance).'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.rtm_start(options))