slack-ruby-client 0.13.1 → 2.0.0

data/CONTRIBUTING.md

@@ -29,13 +29,13 @@ bundle exec rake
 
 Sign up for Slack, create a private slack group for yourself.
 
-Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
+Create a new App under [https://api.slack.com/apps](https://api.slack.com/apps).
 
-![](screenshots/register-bot.png)
+![](screenshots/create-app.png)
 
 On the next screen, note the API token.
 
-To run [the example in examples/hi_real_time](examples/hi_real_time/hi.rb), open a terminal, cd into _examples/hi_real_time_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
+To run [the example in examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb), open a terminal, cd into _examples/hi_real_time_and_web_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
 
 ## Contribute Code
 
@@ -59,7 +59,7 @@ We definitely appreciate pull requests that highlight or reproduce a problem, ev
 
 Implement your feature or bug fix.
 
-Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ignored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
 
 Make sure that `bundle exec rake` completes without errors.
 
@@ -68,20 +68,32 @@ Make sure that `bundle exec rake` completes without errors.
 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
+bundle exec rake slack:api:update
 ```
 
 #### Patching Slack Web API
 
 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.added-support.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.
 
-```
-git diff --no-color HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
-```
+##### 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. Run `rake slack:api:update SKIP_PATCH=true` to create the raw auto-generated files. Commit the files that you are updating, so we can run `git diff` later.
+2. Go through the old patches for the files (e.g. in `lib/slack/web/api/patches/chat.added-support.patch`), copying code into the new files.
+    - Run `git apply --reject path/to/patch-file.patch` to see hunks that couldn't be applied.
+3. Continue with Step 2 [above](#patching-slack-web-api).
 
-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
 
@@ -146,7 +158,7 @@ git push origin my-feature-branch -f
 
 ### Check on Your Pull Request
 
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+Go back to your pull request after a few minutes and see whether it passed muster with CI. Everything should look green, otherwise fix issues and amend your commit as described above.
 
 ### Be Patient
 

data/Dangerfile

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

data/Gemfile

@@ -1,12 +1,29 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gemspec
 
-gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
-
-gem 'activesupport', '~> 4.0'
-gem 'picky' unless RUBY_PLATFORM == 'java'
+if ENV.key?('CONCURRENCY')
+  case ENV['CONCURRENCY']
+  when 'async-websocket'
+    gem 'async-websocket', '~> 0.8.0', require: false
+  else
+    gem ENV['CONCURRENCY'], require: false
+  end
+end
 
 group :test do
-  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+  gem 'activesupport'
+  gem 'erubis'
+  gem 'faraday-typhoeus'
+  gem 'json-schema'
+  gem 'rake', '~> 13'
+  gem 'rspec'
+  gem 'rubocop', '1.26.1' # Lock to specific version to avoid breaking cops/changes
+  gem 'rubocop-performance'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
+  gem 'timecop'
+  gem 'vcr'
+  gem 'webmock'
 end

data/Gemfile.danger

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'danger-toc', '~> 0.2.0', require: false
+  gem 'slack-ruby-danger', '~> 0.2.0', require: false
+end

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2016 Daniel Doubrovkine, Artsy and Contributors
+Copyright (c) 2015-2021 Daniel Doubrovkine, Artsy and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the