slack-ruby-client 0.14.6 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24883016f639f51e34aa4026ff203ef1cb6fa66abac9c0017d5653508f9169c7
-  data.tar.gz: 49bf4585f49dba526c764e018150ed9e884161c67529e442ef9e5df104d48345
+  metadata.gz: c889cedf29a72dd4c60c2d8c1338538c2f35ed7be9d42defa10f04866466997a
+  data.tar.gz: f23223bf65696509321856a536f60411db15c3fe34db3c42f2284672fbc99f47
 SHA512:
-  metadata.gz: db889eac4fbc7effec2f2f8bd319523f4e3c646ad0be8b52e2221a444d79cca38bae6fed8d0b6aac100c4869f862f6cfddb4644407d305977ad8b2a3fc1da670
-  data.tar.gz: 636f316d2e9efba1f663ccf0691fcf715b4f6a16d80bb98d8e5676d5479d6536beaa9a5c4de0452319a166ef50f9c7e6cddf451e6898600b3a57897b862472d2
+  metadata.gz: b1c55f1840dbb1604294e83e922188467aa63a8aa04c2d38c744e6e96287db2ba961b33f408ee83c68dae70f9554d362e1fb1278c36dc45b1e1a5190e6b3189f
+  data.tar.gz: 582c4f3d190b998521b5c7e358188c0662d1e3c2c43021cf9e93345e7ca162c027e0d170364c87367ba548132aeb4c0ab989d08c01bc4e5eec4f8312dbaf8ea6

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [dblock]

data/.rubocop.yml

@@ -13,18 +13,25 @@ AllCops:
     - lib/slack/web/api/endpoints/* # Auto-generated
     - lib/slack/web/api/errors.rb # Auto-generated
     - spec/slack/web/api/endpoints/* # Auto-generated
+
 Layout/EmptyLineAfterMagicComment:
   Enabled: false
+
 Metrics/BlockLength:
   Max: 250
+
 Metrics/ClassLength:
   Max: 250
-Metrics/LineLength:
-  Max: 100
+
+Layout/LineLength:
+  Max: 128
+
 Style/Documentation:
   Enabled: false
+
 Style/ModuleFunction:
   Enabled: false
+
 Naming/FileName:
   Exclude:
     - lib/slack-ruby-client.rb # Required to match gemspec name

data/.rubocop_todo.yml

@@ -1,24 +1,37 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-12-23 15:50:03 -0500 using RuboCop version 0.73.0.
+# on 2020-06-29 08:44:31 -0400 using RuboCop version 0.82.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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'lib/slack-ruby-client.rb'
+
+# Offense count: 2
 # Configuration parameters: AllowComments.
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Exclude:
-    - 'lib/slack/real_time/concurrency/async.rb'
     - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
 
-# Offense count: 10
+# Offense count: 11
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
   Max: 39
 
-# Offense count: 1
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 9
 
@@ -28,21 +41,43 @@ Metrics/MethodLength:
   Max: 32
 
 # Offense count: 1
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
   Max: 9
 
+# Offense count: 2
+# Cop supports --auto-correct.
+Performance/RegexpMatch:
+  Exclude:
+    - 'lib/tasks/web.rake'
+
 # Offense count: 1
 RSpec/AnyInstance:
   Exclude:
     - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
 
-# Offense count: 70
+# Offense count: 5
+# Cop supports --auto-correct.
+RSpec/ContextMethod:
+  Exclude:
+    - 'spec/slack/messages/formatting_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'
+
+# Offense count: 71
 # Configuration parameters: Prefixes.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 64
+# Offense count: 129
+# Cop supports --auto-correct.
+# Configuration parameters: AllowConsecutiveOneLiners.
+RSpec/EmptyLineAfterExample:
+  Enabled: false
+
+# Offense count: 66
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Enabled: false
@@ -60,18 +95,17 @@ RSpec/InstanceVariable:
     - 'spec/slack/real_time/client_spec.rb'
     - 'spec/slack/slack_spec.rb'
 
-# Offense count: 75
+# Offense count: 77
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 93
-# Configuration parameters: AggregateFailuresByDefault.
+# Offense count: 95
 RSpec/MultipleExpectations:
   Max: 5
 
-# Offense count: 34
+# Offense count: 35
 RSpec/NestedGroups:
   Max: 6
 
@@ -92,3 +126,9 @@ RSpec/VerifiedDoubles:
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
     - 'spec/slack/web/faraday/response/raise_error_spec.rb'
     - 'spec/support/real_time/connected_client.rb'
+
+# Offense count: 4
+# Configuration parameters: .
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated

data/.travis.yml

@@ -3,7 +3,6 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.3.8
   - 2.5.3
   - 2.6.0
   - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 0.15.0 (2020/7/26)
+
+* [#322](https://github.com/slack-ruby/slack-ruby-client/pull/322): Cache `Faraday::Connection` for persistent adapters - [@drbrain](https://github.com/drbrain).
+* [#324](https://github.com/slack-ruby/slack-ruby-client/pull/324): Require Faraday >= 1.0 - [@dblock](https://github.com/dblock).
+* [#324](https://github.com/slack-ruby/slack-ruby-client/pull/324): Upgrade slack-ruby-danger, rubocop, rubocop-rspec and rubocop-performance - [@dblock](https://github.com/dblock).
+* [#327](https://github.com/slack-ruby/slack-ruby-client/pull/327), [#326](https://github.com/slack-ruby/slack-ruby-client/pull/326): Added `admin_conversations_whitelist`, `admin_usergroups`, `calls` and `calls_participants` endpoints  - [@wasabigeek](https://github.com/wasabigeek).
+* [#329](https://github.com/slack-ruby/slack-ruby-client/pull/329): Log when methods are deprecated - [@wasabigeek](https://github.com/wasabigeek).
+* [#325](https://github.com/slack-ruby/slack-ruby-client/pull/325): Remove activesupport dependency - [@ianks](https://github.com/ianks).
+* [#331](https://github.com/slack-ruby/slack-ruby-client/pull/331): Use `conversations_list` instead of deprecated `channels_list`. Added `admin_conversations_restrictAccess_addGroup`, `admin_conversations_restrictAccess_listGroups` and `admin_conversations_restrictAccess_removeGroup` endpoints - [@wasabigeek](https://github.com/wasabigeek).
+
 ### 0.14.6 (2020/3/28)
 
 * [#305](https://github.com/slack-ruby/slack-ruby-client/pull/305): Added `admin_inviteRequests_approve`, `admin_inviteRequests_deny`, `admin_inviteRequests_list`, `admin_inviteRequests_approved_list`, `admin_inviteRequests_denied_list`, `admin_teams_create`, `admin_teams_list`, `admin_teams_admins_list`, `admin_teams_owners_list`, `admin_teams_settings`, `admin_teams_settings_setIcon`, `admin_teams_settings_setName`, `admin_teams_settings_setDescription`, `admin_users_assign`, `admin_users_invite`, `admin_users_remove`, `admin_users_setAdmin`, `admin_users_setOwner` and `admin_users_setRegular` endpoints - [@manuelmeurer](https://github.com/manuelmeurer).

data/CONTRIBUTING.md

@@ -75,13 +75,31 @@ rake slack:api:update
 
 Sometimes it's necessary to patch auto-generated Slack Web API methods. For example, we want to help clients with calling `to_json` on the `attachments` parameter sent to `chat_postMessage`. See [#20](https://github.com/slack-ruby/slack-ruby-client/issues/20).
 
-Make a change to a generated file, for example `lib/slack/web/api/endpoints/chat.rb` and generate a patch.
+The broad steps are:
+1. Run `rake slack:api:update` to check that existing patches are still valid.
+    - If you run into a `failed to apply patch` error, the auto-generated methods likely drifted from the last patch. Follow the steps [below](#resolving-patch-errors).
+    - This may add new methods if the API has updated, please split them up into multiple PRs if so.
+2. Make a change to a generated file, for example `lib/slack/web/api/endpoints/chat.rb`.
+3. Generate a patch:
+    ```
+    git diff --no-color HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
+    ```
+4. 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.
+
+##### Resolving Patch Errors
+
+The auto-generated method files may drift overtime e.g. new arguments may be added or descriptions changed. Since previous patches were based on the older auto-generated files, git may be unable to apply them to the new files. Resolving them requires some good ol' splicing:
+1. Comment out the patching code in `lib/tasks/web.rake`:
+    ```ruby
+    # Dir.glob("lib/slack/web/api/patches/#{group}*.patch").sort.each do |patch|
+    #   puts "- patching #{patch}"
+    #   system("git apply #{patch}") || raise('failed to apply patch')
+    # end
+    ```
+2. Run `rake slack:api:update` to create the raw auto-generated files. Commit the files that you are updating, so we can run `git diff` later.
+3. Go through the old patches for the files (e.g. in `lib/slack/web/api/patches/chat.1.patch`), copying code into the new files.
+4. Continue with Step 2 [above](#patching-slack-web-api).
 
-```
-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.
 
 ### Write Documentation
 

data/Dangerfile

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'slack-ruby-danger')
-toc.check

data/Gemfile

@@ -13,6 +13,5 @@ if ENV.key?('CONCURRENCY')
 end
 
 group :test do
-  gem 'danger-toc', '~> 0.1.3', require: false
-  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+  gem 'slack-ruby-danger', '~> 0.2.0', require: false
 end

data/README.md

@@ -31,6 +31,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
       - [Other](#other)
     - [Web Client Options](#web-client-options)
     - [Pagination Support](#pagination-support)
+    - [Character Encoding](#character-encoding)
     - [Error Handling](#error-handling)
       - [Slack Errors](#slack-errors)
       - [Rate Limiting](#rate-limiting)
@@ -71,7 +72,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.14.6. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stale** release of slack-ruby-client, v0.15.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -276,6 +277,24 @@ end
 all_members # many thousands of team members retrieved 10 at a time
 ```
 
+#### Character Encoding
+
+Note that Slack expects `text` to be UTF-8 encoded. If your messages appear with text such as `BAD+11` in Slack, check `text.encoding` and `.encode(Encoding::UTF_8)` your messages before sending them to Slack.
+
+```ruby
+text = 'characters such as "Ñ", "Á", "É"'
+text.encoding
+=> #<Encoding:UTF-8>
+client.chat_postMessage(channel: '#general', text: text, as_user: true)
+# renders 'characters such as "Ñ", "Á", "É"' in Slack
+
+text = text.encode(Encoding::ISO_8859_1)
+text.encoding
+# => #<Encoding:ISO-8859-1>
+client.chat_postMessage(channel: '#general', text: text, as_user: true)
+# renders 'characters such as "BAD+11", "", "BAD+9"' in Slack
+```
+
 #### Error Handling
 
 ##### Slack Errors

data/UPGRADING.md

@@ -1,6 +1,12 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 0.15.0
+
+As of 0.15.0, `activesupport` is no longer required. Add `gem 'activesupport'` to your Gemfile if you required ActiveSupport via this library.
+
+See [#325](https://github.com/slack-ruby/slack-ruby-client/pull/325) for more information.
+
 ### Upgrading to >= 0.14.0
 
 If you are using async-websocket, lock down its version to 0.8.0 as newer versions are currently incompatible.

data/bin/commands.rb

@@ -6,6 +6,8 @@ require 'commands/admin_apps_approved'
 require 'commands/admin_apps_requests'
 require 'commands/admin_apps_restricted'
 require 'commands/admin_conversations'
+require 'commands/admin_conversations_restrictAccess'
+require 'commands/admin_conversations_whitelist'
 require 'commands/admin_emoji'
 require 'commands/admin_inviteRequests'
 require 'commands/admin_inviteRequests_approved'
@@ -14,6 +16,7 @@ require 'commands/admin_teams'
 require 'commands/admin_teams_admins'
 require 'commands/admin_teams_owners'
 require 'commands/admin_teams_settings'
+require 'commands/admin_usergroups'
 require 'commands/admin_users'
 require 'commands/admin_users_session'
 require 'commands/api'
@@ -24,6 +27,8 @@ require 'commands/apps_permissions_scopes'
 require 'commands/apps_permissions_users'
 require 'commands/auth'
 require 'commands/bots'
+require 'commands/calls'
+require 'commands/calls_participants'
 require 'commands/channels'
 require 'commands/chat'
 require 'commands/chat_scheduledMessages'

data/bin/commands/admin_conversations.rb

@@ -8,7 +8,7 @@ command 'admin_conversations' do |g|
   g.command 'setTeams' do |c|
     c.flag 'channel_id', desc: 'The encoded channel_id to add or remove to workspaces.'
     c.flag 'org_channel', desc: 'True if channel has to be converted to an org channel.'
-    c.flag 'target_team_ids', desc: "The list of workspaces to which the channel should be shared. Not required if the channel is being shared orgwide. Example: ['T1234', 'T5678']."
+    c.flag 'target_team_ids', desc: 'A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.'
     c.flag 'team_id', desc: 'The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.admin_conversations_setTeams(options))

data/bin/commands/admin_conversations_restrictAccess.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminConversationsRestrictaccess methods.'
+command 'admin_conversations_restrictAccess' do |g|
+  g.desc 'Add an allowlist of IDP groups for accessing a channel'
+  g.long_desc %( Add an allowlist of IDP groups for accessing a channel )
+  g.command 'addGroup' do |c|
+    c.flag 'channel_id', desc: 'The channel to link this group to.'
+    c.flag 'group_id', desc: 'The IDP Group ID to be an allowlist for the private channel.'
+    c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_restrictAccess_addGroup(options))
+    end
+  end
+
+  g.desc 'List all IDP Groups linked to a channel'
+  g.long_desc %( List all IDP Groups linked to a channel )
+  g.command 'listGroups' do |c|
+    c.flag 'channel_id', desc: '.'
+    c.flag 'team_id', desc: 'The workspace where the channele exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_restrictAccess_listGroups(options))
+    end
+  end
+
+  g.desc 'Remove a linked IDP group linked from a private channel'
+  g.long_desc %( Remove a linked IDP group linked from a private channel )
+  g.command 'removeGroup' do |c|
+    c.flag 'channel_id', desc: 'The channel to remove the linked group from.'
+    c.flag 'group_id', desc: 'The IDP Group ID to remove from the private channel.'
+    c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_restrictAccess_removeGroup(options))
+    end
+  end
+end

data/bin/commands/admin_conversations_whitelist.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminConversationsWhitelist methods.'
+command 'admin_conversations_whitelist' do |g|
+  g.desc 'Add an allowlist of IDP groups for accessing a channel'
+  g.long_desc %( Add an allowlist of IDP groups for accessing a channel )
+  g.command 'add' do |c|
+    c.flag 'channel_id', desc: 'The channel to whitelist a group for.'
+    c.flag 'group_id', desc: 'The IDP Group ID to whitelist for the private channel.'
+    c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_whitelist_add(options))
+    end
+  end
+
+  g.desc 'List all IDP Groups linked to a channel'
+  g.long_desc %( List all IDP Groups linked to a channel )
+  g.command 'listGroupsLinkedToChannel' do |c|
+    c.flag 'channel_id', desc: '.'
+    c.flag 'team_id', desc: 'The workspace where the channele exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_whitelist_listGroupsLinkedToChannel(options))
+    end
+  end
+
+  g.desc 'Remove an allowlisted IDP group linked to a private channel'
+  g.long_desc %( Remove an allowlisted IDP group linked to a private channel )
+  g.command 'remove' do |c|
+    c.flag 'channel_id', desc: 'The channel to remove a whitelisted group for.'
+    c.flag 'group_id', desc: 'The IDP Group ID to remove from the private channel whitelist.'
+    c.flag 'team_id', desc: 'The workspace where the IDP Group and channel exist.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_conversations_whitelist_remove(options))
+    end
+  end
+end

data/bin/commands/admin_usergroups.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminUsergroups methods.'
+command 'admin_usergroups' do |g|
+  g.desc 'Add one or more default channels to an IDP group.'
+  g.long_desc %( Add one or more default channels to an IDP group. )
+  g.command 'addChannels' do |c|
+    c.flag 'channel_ids', desc: 'Comma separated string of channel IDs.'
+    c.flag 'usergroup_id', desc: 'ID of the IDP group to add default channels for.'
+    c.flag 'team_id', desc: 'The workspace to add default channels in.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_usergroups_addChannels(options))
+    end
+  end
+
+  g.desc 'Associate one or more default workspaces with an organization-wide IDP group.'
+  g.long_desc %( Associate one or more default workspaces with an organization-wide IDP group. )
+  g.command 'addTeams' do |c|
+    c.flag 'team_ids', desc: 'A comma separated list of encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.'
+    c.flag 'usergroup_id', desc: 'An encoded usergroup (IDP Group) ID.'
+    c.flag 'auto_provision', desc: 'When true, this method automatically creates new workspace accounts for the IDP group members.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_usergroups_addTeams(options))
+    end
+  end
+
+  g.desc 'List the channels linked to an org-level IDP group (user group).'
+  g.long_desc %( List the channels linked to an org-level IDP group (user group). )
+  g.command 'listChannels' do |c|
+    c.flag 'usergroup_id', desc: 'ID of the IDP group to list default channels for.'
+    c.flag 'include_num_members', desc: 'Flag to include or exclude the count of members per channel.'
+    c.flag 'team_id', desc: 'ID of the the workspace.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_usergroups_listChannels(options))
+    end
+  end
+
+  g.desc 'Remove one or more default channels from an org-level IDP group (user group).'
+  g.long_desc %( Remove one or more default channels from an org-level IDP group (user group). )
+  g.command 'removeChannels' do |c|
+    c.flag 'channel_ids', desc: 'Comma-separated string of channel IDs.'
+    c.flag 'usergroup_id', desc: 'ID of the IDP Group.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_usergroups_removeChannels(options))
+    end
+  end
+end