slack-ruby-client 0.14.4 → 0.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf802522f0f9aa42f83506227b02fcf37beb861429316f9ae2155d3eedde79d8
-  data.tar.gz: 5a81c7017616999820506cdff2af962ecbb601931f04da9598bdc9767307769b
+  metadata.gz: 96288d9306b0d60b597f038d66aa5ffcfd2b643c0c85d4f0d974138462a47698
+  data.tar.gz: b41ec139a4543ba972c845b373cf8b5a304f0ad1ed128d8a7d2057ef507721a8
 SHA512:
-  metadata.gz: e648e70aed991cba05dce9cc9907771d8b13c69ecab9386093460d8d3547e0fc825393d174dee7bddf1fcef15b8f85b496ae9a24cadacc4a7054db775508527a
-  data.tar.gz: e8397379744685f4880c20afdadaf9c19439ea9f4cb0c362e596849416f67f836686626f65af81e5ce933c2eeb9c33117fcb8f64bb6967be4963f6a477f61910
+  metadata.gz: f270c3ee301ecbfb6498b60b2e5d6d349f351cc0615156682a881e0b13b1a0a36dd574c45b37d69022da634865021cba4cb0f5dd0b2416c848e4ca9f1b5cb362
+  data.tar.gz: 418a7f3e2076d7bfd0dc275d08b4e1ed31cf673a1e82ba47a7f875404c3b9704181ae695ebe76b1ccb720ff0a1da9b7e9fd3d206d537730cf238ead2a55e513d

data/.rubocop.yml

@@ -1,21 +1,29 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
 AllCops:
+  DisplayCopNames: true
   Exclude:
+    - bin/**/*
     - vendor/**/*
     - lib/slack/web/api/slack-api-ref/**/*
-
-Metrics:
+    - lib/slack/web/api/endpoints/* # Auto-generated
+    - spec/slack/web/api/endpoints/* # Auto-generated
+Layout/EmptyLineAfterMagicComment:
   Enabled: false
-
+Metrics/BlockLength:
+  Max: 250
+Metrics/ClassLength:
+  Max: 250
 Metrics/LineLength:
-  Max: 512
-
+  Max: 100
 Style/Documentation:
   Enabled: false
-
-Naming/MethodName:
-  Enabled: false
-
 Style/ModuleFunction:
   Enabled: false
-
-inherit_from: .rubocop_todo.yml
+Naming/FileName:
+  Exclude:
+    - lib/slack-ruby-client.rb # Required to match gemspec name

data/.rubocop_todo.yml

@@ -1,75 +1,94 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-07-21 18:39:19 -0400 using RuboCop version 0.61.1.
+# on 2019-12-23 15:50:03 -0500 using RuboCop version 0.73.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: 2
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
-  Exclude:
-    - 'lib/slack/real_time/concurrency/async.rb'
-    - 'lib/slack/real_time/socket.rb'
-
-# Offense count: 5
+# Offense count: 3
+# Configuration parameters: AllowComments.
 Lint/HandleExceptions:
   Exclude:
-    - 'lib/slack-ruby-client.rb'
     - '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: 4
-# 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:
-    - 'bin/commands/chat_scheduledMessages.rb'
-    - 'lib/slack-ruby-client.rb'
-    - 'lib/slack/web/api/endpoints/chat_scheduledMessages.rb'
-    - 'spec/slack/web/api/endpoints/chat_scheduledMessages_spec.rb'
+# Offense count: 10
+Metrics/AbcSize:
+  Max: 39
 
 # Offense count: 1
-# Configuration parameters: EnforcedStyleForLeadingUnderscores.
-# SupportedStylesForLeadingUnderscores: disallowed, required, optional
-Naming/MemoizedInstanceVariableName:
-  Exclude:
-    - 'lib/slack/logger.rb'
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 14
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 32
 
 # Offense count: 1
-Security/Open:
-  Exclude:
-    - 'lib/slack/real_time/client.rb'
+Metrics/PerceivedComplexity:
+  Max: 9
 
-# Offense count: 2
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: inline, group
-Style/AccessModifierDeclarations:
+# Offense count: 1
+RSpec/AnyInstance:
   Exclude:
-    - 'lib/slack/real_time/concurrency/eventmachine.rb'
-    - 'lib/slack/real_time/socket.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
 
-# Offense count: 155
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
+# Offense count: 70
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 3
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
+# Offense count: 64
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Enabled: false
+
+# Offense count: 17
+# Configuration parameters: CustomTransform, IgnoreMethods.
+RSpec/FilePath:
+  Enabled: false
+
+# Offense count: 13
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
   Exclude:
-    - 'lib/slack/real_time/socket.rb'
-    - 'lib/slack/real_time/stores/store.rb'
-    - 'lib/slack/web/faraday/response/raise_error.rb'
+    - 'spec/integration/integration_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/slack_spec.rb'
 
-# Offense count: 1
-Style/MixinUsage:
+# Offense count: 75
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 93
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Offense count: 34
+RSpec/NestedGroups:
+  Max: 6
+
+# Offense count: 3
+RSpec/SubjectStub:
   Exclude:
-    - 'bin/slack'
+    - '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: 1
-Style/MultilineTernaryOperator:
+# Offense count: 16
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
   Exclude:
+    - 'spec/slack/events/request_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
+    - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
+    - 'spec/slack/web/faraday/response/raise_error_spec.rb'
     - 'spec/support/real_time/connected_client.rb'

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.14.5 (2019/12/23)
+
+* [#293](https://github.com/slack-ruby/slack-ruby-client/pull/293): Rubocop auto-correct and comprehensive todo - [@jcraigk](https://github.com/jcraigk).
+* [#297](https://github.com/slack-ruby/slack-ruby-client/pull/297): Various Rubocop fixes - [@jcraigk](https://github.com/jcraigk).
+* [#298](https://github.com/slack-ruby/slack-ruby-client/pull/298): Add `admin.apps`, `admin.app.requests` and `views` endpoints - [@jmanian](https://github.com/jmanian).
+* [#302](https://github.com/slack-ruby/slack-ruby-client/pull/302): Add `oauth.v2.access` and `views.published` endpoints - [@jwright](https://github.com/jwright).
+* [#309](https://github.com/slack-ruby/slack-ruby-client/pull/309): Stop ping on `inactive_account` and `invalid_auth` - [@dblock](https://github.com/dblock).
+
 ### 0.14.4 (2019/7/28)
 
 * [#289](https://github.com/slack-ruby/slack-ruby-client/pull/289): Fix reconnects when ping timers under/overshoot - [@georgyangelov](https://github.com/georgyangelov).

data/Dangerfile

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

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gemspec

data/README.md

@@ -16,7 +16,8 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 - [Installation](#installation)
 - [Usage](#usage)
   - [Create a New Bot Integration](#create-a-new-bot-integration)
-  - [Use the API Token](#use-the-api-token)
+  - [OAuth Code Grant](#oauth-code-grant)
+  - [Using the Legacy API Token](#using-the-legacy-api-token)
   - [Global Settings](#global-settings)
   - [Web Client](#web-client)
     - [Test Auth](#test-auth)
@@ -61,12 +62,12 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 
 * This library will let you send messages to Slack via the Web API, send and receive messages via the Real Time Messaging API and facilitate integration with the Events API.
 * To respond to slash commands, interactive components or events, implement a web application using your favorite web framework and use this library to call the Slack Web API and to verify that events are coming from Slack.
-* To build a bot using the Real Time Messaging API, use [slack-ruby-bot](https://github.com/dblock/slack-ruby-bot), which uses this library.
-* To roll out a complete service using the Real Time Messaging API with Slack button integration to multiple teams, check out [slack-ruby-bot-server](https://github.com/dblock/slack-ruby-bot-server), which is built on top of slack-ruby-bot, which uses this library.
+* To build a bot using the Real Time Messaging API, use [slack-ruby-bot](https://github.com/slack-ruby/slack-ruby-bot), which uses this library.
+* To roll out a complete service using the Real Time Messaging API with Slack button integration to multiple teams, check out [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server), which is built on top of slack-ruby-bot, which uses this library.
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.14.4. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.14.5. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -88,11 +89,17 @@ Run `bundle install`.
 
 ### Create a New Bot Integration
 
-This is something done in Slack, under [integrations](https://my.slack.com/services). Create a [new bot](https://my.slack.com/services/new/bot), and note its API token.
+To integrate your bot with Slack, you must first create a new [Slack App](https://api.slack.com/apps).
 
-![](screenshots/register-bot.png)
+![](screenshots/create-app.png)
 
-### Use the API Token
+### OAuth Code Grant
+
+Once created, go to the app's Basic Info tab and grab the Client ID and Client Secret.  You'll need these in order complete an [OAuth code grant flow](https://api.slack.com/docs/oauth#flow) as described at [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server).
+
+### Using the Legacy API Token
+
+Although OAuth is recommended, you can still [generate a legacy API token](https://api.slack.com/custom-integrations/legacy-tokens) for your app and use it for some interactions.
 
 ```ruby
 Slack.configure do |config|
@@ -440,7 +447,7 @@ Slack::RealTime.configure do |config|
 end
 ```
 
-Use `client.start_async` instead of `client.start!`. A good example of such application is [slack-bot-server](https://github.com/dblock/slack-bot-server).
+Use `client.start_async` instead of `client.start!`. A good example of such application is [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server).
 
 ```ruby
 client = Slack::RealTime::Client.new
@@ -515,7 +522,7 @@ Slack::Events::Request.new(http_request,
                            signature_expires_in: signature_expires_in)
 ```
 
-The `verify!` call may raise `Slack::Events::MissingSigningSecret`, `Slack::Events::InvalidSignature` or `Slack::Events::TimestampExpired` errors.
+The `verify!` call may raise `Slack::Events::Request::MissingSigningSecret`, `Slack::Events::Request::InvalidSignature` or `Slack::Events::Request::TimestampExpired` errors.
 
 ### Message Parsing
 

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'bundler'
 require 'bundler/gem_tasks'

data/bin/commands.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
+require 'commands/admin_apps'
+require 'commands/admin_apps_requests'
 require 'commands/admin_users_session'
 require 'commands/api'
 require 'commands/apps'
@@ -18,11 +21,13 @@ require 'commands/dnd'
 require 'commands/emoji'
 require 'commands/files'
 require 'commands/files_comments'
+require 'commands/files_remote'
 require 'commands/groups'
 require 'commands/im'
 require 'commands/migration'
 require 'commands/mpim'
 require 'commands/oauth'
+require 'commands/oauth_v2'
 require 'commands/pins'
 require 'commands/reactions'
 require 'commands/reminders'
@@ -37,3 +42,4 @@ require 'commands/users'
 require 'commands/users_admin'
 require 'commands/users_prefs'
 require 'commands/users_profile'
+require 'commands/views'

data/bin/commands/admin_apps.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminApps methods.'
+command 'admin_apps' do |g|
+  g.desc 'Approve an app for installation on a workspace.'
+  g.long_desc %( Approve an app for installation on a workspace. )
+  g.command 'approve' do |c|
+    c.flag 'app_id', desc: 'The id of the app to approve.'
+    c.flag 'request_id', desc: 'The id of the request to approve.'
+    c.flag 'team_id', desc: '.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_apps_approve(options))
+    end
+  end
+
+  g.desc 'Restrict an app for installation on a workspace.'
+  g.long_desc %( Restrict an app for installation on a workspace. )
+  g.command 'restrict' do |c|
+    c.flag 'app_id', desc: 'The id of the app to restrict.'
+    c.flag 'request_id', desc: 'The id of the request to restrict.'
+    c.flag 'team_id', desc: '.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_apps_restrict(options))
+    end
+  end
+end

data/bin/commands/admin_apps_requests.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'AdminAppsRequests methods.'
+command 'admin_apps_requests' do |g|
+  g.desc 'List app requests for a team/workspace.'
+  g.long_desc %( List app requests for a team/workspace. )
+  g.command 'list' do |c|
+    c.flag 'cursor', desc: 'Set cursor to next_cursor returned by the previous call to list items in the next page.'
+    c.flag 'limit', desc: 'The maximum number of items to return. Must be between 1 - 1000 both inclusive.'
+    c.flag 'team_id', desc: '.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.admin_apps_requests_list(options))
+    end
+  end
+end

data/bin/commands/admin_users_session.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'AdminUsersSession methods.'
 command 'admin_users_session' do |g|
-  g.desc "This method wipes a user session, leaving the user unauthenticated. The user's Slack client will reset its local cache."
-  g.long_desc %( This method wipes a user session, leaving the user unauthenticated. The user's Slack client will reset its local cache. )
+  g.desc 'Wipes all valid sessions on all devices for a given user'
+  g.long_desc %( Wipes all valid sessions on all devices for a given user )
   g.command 'reset' do |c|
     c.flag 'user_id', desc: 'The ID of the user to wipe sessions for.'
     c.flag 'mobile_only', desc: 'Only expire mobile sessions (default: false).'

data/bin/commands/api.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Api methods.'
 command 'api' do |g|
-  g.desc 'This method helps you test your calling code.'
-  g.long_desc %( This method helps you test your calling code. )
+  g.desc 'Checks API calling code.'
+  g.long_desc %( Checks API calling code. )
   g.command 'test' do |c|
     c.flag 'error', desc: 'Error response to return.'
     c.flag 'foo', desc: 'example property to return.'

data/bin/commands/apps.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Apps methods.'
 command 'apps' do |g|
-  g.desc 'This method uninstalls an app. Unlike auth.revoke, which revokes a single token, this method revokes all tokens associated with a single installation of an app.'
-  g.long_desc %( This method uninstalls an app. Unlike auth.revoke, which revokes a single token, this method revokes all tokens associated with a single installation of an app. )
+  g.desc 'Uninstalls your app from a workspace.'
+  g.long_desc %( Uninstalls your app from a workspace. )
   g.command 'uninstall' do |c|
     c.flag 'client_id', desc: 'Issued when you created your application.'
     c.flag 'client_secret', desc: 'Issued when you created your application.'

data/bin/commands/apps_permissions.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'AppsPermissions methods.'
 command 'apps_permissions' do |g|
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Returns list of permissions this app has on a team.'
+  g.long_desc %( Returns list of permissions this app has on a team. )
   g.command 'info' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.apps_permissions_info(options))
     end
   end
 
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Allows an app to request additional scopes'
+  g.long_desc %( Allows an app to request additional scopes )
   g.command 'request' do |c|
     c.flag 'scopes', desc: 'A comma separated list of scopes to request for.'
     c.flag 'trigger_id', desc: 'Token used to trigger the permissions API.'

data/bin/commands/apps_permissions_resources.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'AppsPermissionsResources methods.'
 command 'apps_permissions_resources' do |g|
-  g.desc 'This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months.'
-  g.long_desc %( This feature was exclusive to our workspace apps developer preview. The preview has now ended, but fan-favorite features such as token rotation and the Conversations API will become available to classic Slack apps over the coming months. )
+  g.desc 'Returns list of resource grants this app has on a team.'
+  g.long_desc %( Returns list of resource grants this app has on a team. )
   g.command 'list' do |c|
     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 'limit', desc: 'The maximum number of items to return.'