Added samples for oauth_v2 and files_upload_v2.

Author: dblock

CHANGELOG.md

@@ -7,6 +7,7 @@
 * [#533](https://github.com/slack-ruby/slack-ruby-client/pull/533), [#536](https://github.com/slack-ruby/slack-ruby-client/pull/536): Added `files_upload_v2` - [@gregsaab](https://github.com/gregsaab).
 * [#538](https://github.com/slack-ruby/slack-ruby-client/pull/538): Translate channel names and support an array of channels in `files_upload_v2` - [@dblock](https://github.com/dblock).
 * [#540](https://github.com/slack-ruby/slack-ruby-client/pull/540): Added support for `channel` and `channel_id`, do not require channel in `files_upload_v2` - [@dblock](https://github.com/dblock).
+* [#541](https://github.com/slack-ruby/slack-ruby-client/pull/541): Added samples for `oauth_v2` and `files_upload_v2` - [@dblock](https://github.com/dblock).
 * [#524](https://github.com/slack-ruby-client/pulls/524): Update API from [slack-api-ref@3ec3c10](https://github.com/slack-ruby/slack-api-ref/commit/3ec3c10) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
 * Your contribution here.
 

examples/files_upload_v2/.env.example

@@ -0,0 +1 @@
+SLACK_API_TOKEN=

examples/files_upload_v2/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'http://rubygems.org'
+
+gem 'dotenv'
+gem 'slack-ruby-client', path: '../..'

examples/files_upload_v2/README.md

@@ -0,0 +1,13 @@
+Samples for using `files_upload_v2`.
+
+## Usage
+
+Create a Slack app and obtain a User OAuth Token [here](https://api.slack.com/tutorials/tracks/getting-a-token) or use the [oauth_v2](../oauth_v2) example to obtain a User OAuth Token.
+Make sure to select `files:write` and `files:read` scopes under "User Token Scopes".
+
+Create `.env` file with `SLACK_API_TOKEN` or set the `SLACK_API_TOKEN` environment variable.
+
+```
+bundle install
+bundle exec dotenv ruby files_upload_v2.rb
+```

examples/files_upload_v2/files_upload_v2.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'slack-ruby-client'
+require 'securerandom'
+
+Slack.configure do |config|
+  config.token = ENV['SLACK_API_TOKEN']
+  raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+end
+
+client = Slack::Web::Client.new
+
+auth = client.auth_test
+puts "Connected to team #{auth.team} (#{auth.team_id}) as #{auth.user}."
+
+puts client.files_upload_v2(
+  filename: 'files_upload_v2.txt',
+  content: SecureRandom.hex
+).files.first.permalink_public
+
+puts client.files_upload_v2(
+  filename: 'files_upload_v2_to_general_channel.txt',
+  content: SecureRandom.hex,
+  channel: '#general'
+).files.first.permalink_public
+
+puts client.files_upload_v2(
+  filename: 'files_upload_v2_to_general_and_random_channels.txt',
+  content: SecureRandom.hex,
+  channels: ['#general', '#random']
+).files.first.permalink_public
+
+channel_id = client.conversations_id(channel: '#general')['channel']['id']
+puts client.files_upload_v2(
+  filename: 'files_upload_v2_to_general_by_id.txt',
+  content: SecureRandom.hex,
+  channel_id: channel_id
+).files.first.permalink_public

examples/oauth_v2/.env.example

@@ -0,0 +1,4 @@
+SLACK_CLIENT_ID=
+SLACK_CLIENT_SECRET=
+REDIRECT_URI=https://...ngrok-free.app
+SCOPE=files:read,files:write,files:write:user

examples/oauth_v2/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source 'http://rubygems.org'
+
+gem 'activesupport'
+gem 'dotenv'
+gem 'slack-ruby-client', path: '../..'
+gem 'webrick'

examples/oauth_v2/README.md

@@ -0,0 +1,33 @@
+Obtain a user OAuth token from Slack.
+
+Create a Slack app [here](https://api.slack.com/tutorials/tracks/getting-a-token). 
+
+The new app has a pre-configured User OAuth Token which you can use for most of the examples.
+However you may want to obtain a token for a different user, which can be accomplished as follows.
+
+To test locally use [ngrok](https://ngrok.com/) to expose your local server to the internet. 
+
+```sh
+ngrok http 4242
+```
+
+Add the ngrok URL to the app's "Redirect URLs" under "OAuth & Permissions" in the app's settings.
+
+Create a `.env` file with the following:
+
+```
+SLACK_CLIENT_ID=[App Client ID]
+SLACK_CLIENT_SECRET=[App Client Secret]
+REDIRECT_URI=[Your ngrok URL, e.g. https://...ngrok-free.app]
+SCOPE=[Bot User OAuth Scopes Requested]
+USER_SCOPE=[User OAuth Token Scopes Requested]
+```
+
+Run the example.
+
+```sh
+bundle install
+bundle exec dotenv ruby oauth_v2.rb 
+```
+
+A browser window will open to complete the OAuth flow.

examples/oauth_v2/oauth_v2.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'webrick'
+require 'slack-ruby-client'
+require 'active_support'
+require 'active_support/core_ext/object/to_query'
+
+server = WEBrick::HTTPServer.new(Port: ENV['PORT'] || 4242)
+
+trap 'INT' do
+  server.shutdown
+end
+
+server.mount_proc '/' do |req, res|
+  client = Slack::Web::Client.new
+
+  response = client.oauth_v2_access(
+    req.query.merge(
+      client_id: ENV['SLACK_CLIENT_ID'],
+      client_secret: ENV['SLACK_CLIENT_SECRET'],
+      grant_type: 'authorization_code'
+    )
+  )
+
+  pp response
+
+  res.body = %(
+<html>
+  <body>
+    <ul>
+      <li>bot access_token: #{response.access_token}</li>
+      <li>token_type: #{response.token_type}</li>
+      <li>app_id: #{response.app_id}</li>
+      <li>scope: #{response.scope}</li>
+      <li>user: #{response.authed_user.id}</li>
+      <li>user access token: #{response.authed_user.access_token}</li>
+    </ul>
+  <body>
+</html>
+  )
+
+  pp Slack::Web::Client.new(token: response.authed_user.access_token || response.access_token).auth_test
+
+  server.shutdown
+end
+
+query = {
+  client_id: ENV['SLACK_CLIENT_ID'],
+  redirect_uri: ENV['REDIRECT_URI'],
+  scope: ENV['SCOPE'],
+  user_scope: ENV['USER_SCOPE']
+}
+
+url = "https://slack.com/oauth/v2/authorize?#{query.to_query}"
+puts "Opening browser at #{url}."
+system 'open', url
+
+server.start