lolcommits-slack 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d77773938a5773f12564cc239a705d97986fafb66c4e503a27037360fb61e1b
-  data.tar.gz: b65fb0c9d387b57a722c3053c90f3c90f8de3ebbd2691285643bddfebc2399b2
+  metadata.gz: fdd2793a3a713d8bebcb1c64940469385c756802bd1ba4a77a0e206d53cd9958
+  data.tar.gz: ee6af55125e45994a7339f4d828d16290aa23b56c7f75af061c7f8a9471e285c
 SHA512:
-  metadata.gz: 6a52a5e59bc467f3dc89c268f05debbf1d046e937b794ad33ce439dac3750a4adf8aaae2d685568d26c5253786e22fa83de6a23d075a66182b70759225b2b1f4
-  data.tar.gz: 35d6f5d8febb3538d0a92c8c4fb629cdf4c76376f84d9ebe889d06c42b63ac654b81173449b2065ff18ec8126e0e696bbec0ac65d78ad7a9d280390da8693482
+  metadata.gz: d86dd41fc503ff860955697a563cedc1aebfda2547d5ce3b08ad40e64798e96b3569fe2fc4dda3b1430737004479126fa5818a54569fca9db119f46bb2b04556
+  data.tar.gz: acbdb890e1df388215c1fcfc5cd4627f7f720053a284c26d906f37ae261a340b62340f836d358027859520f8849cda5698ac28207c66789dadebdbe984d2df4f

data/.travis.yml

@@ -2,10 +2,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.8
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
   - ruby-head
 
 before_install:

data/CHANGELOG.md

@@ -9,6 +9,15 @@ project adheres to [Semantic Versioning][Semver].
 
 - Your contribution here!
 
+## [0.6.0] - 2025-12-09
+### Changed
+- Switch to multi-step file uploads (files.upload no longer supported)
+- Reword config instructions for Oauth app tokens
+
+## [0.5.0] - 2020-01-24
+### Removed
+- Support for Ruby < 2.4 (older rubies no longer supported)
+
 ## [0.4.0] - 2019-08-25
 ### Changed
 - Require an up-to-date `rest-client` (`>= 2.1.0`)
@@ -59,7 +68,9 @@ project adheres to [Semantic Versioning][Semver].
 ### Changed
 - Initial release
 
-[Unreleased]: https://github.com/lolcommits/lolcommits-slack/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/lolcommits/lolcommits-slack/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/lolcommits/lolcommits-slack/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/lolcommits/lolcommits-slack/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/lolcommits/lolcommits-slack/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/lolcommits/lolcommits-slack/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/lolcommits/lolcommits-slack/compare/v0.1.1...v0.2.0

data/README.md

@@ -11,11 +11,12 @@ webcam every time you git commit code, and archives a lolcat style image
 with it. Git blame has never been so much fun!
 
 This plugin automatically posts your lolcommits to one (or more)
-[Slack](https://slack.com) channels.
+[Slack](https://slack.com) channels using Slack's modern [file upload
+API](https://docs.slack.dev/messaging/working-with-files).
 
 The Slack post will contain the git commit message and repo name. The
-SHA is used as the uploaded file name. Posting will be retried (once)
-should any error occur.
+SHA is used as the uploaded file name. Each upload step will be retried
+(twice) should any error occur.
 
 ## Requirements
 
@@ -38,24 +39,29 @@ Next configure and enable with:
 
     $ lolcommits --config -p slack
     # set enabled to `true`
-    # enter your access token and Slack channel ID list (see below)
+    # enter your Oauth User token and Slack channel ID list (see below)
 
 That's it! Every lolcommit will now be posted to these Slack channels.
 To disable simply reconfigure with `enabled: false`.
 
-### Access Token
+### Authentication
 
-This plugin uses Slack [legacy
-tokens](https://api.slack.com/custom-integrations/legacy-tokens) for
-authentication. Create (or grab) them
-[here](https://api.slack.com/custom-integrations/legacy-tokens).
+**NOTE**: This plugin no longer supports Slack [legacy
+tokens](https://api.slack.com/custom-integrations/legacy-tokens), a Slack app
+with OAuth is now required.
+
+* Open [this URL](https://api.slack.com/apps?new_app=1") to create a new Slack app (or view existing)
+* Ensure OAuth User Token Scopes includes `files:write`
+* Install the app to your Slack workspace
+* Use the app's User OAuth Token (e.g. xxxx-xxxxxxxxx-xxxx) when configuring
+  with `lolcommits --config -p slack`
 
 ### Channel List
 
-You must supply one or more Slack channel *IDs*. You can use Slack's own
-[API testing tool](https://api.slack.com/methods/channels.list/test) to
-list all Slack channels in your account, and grab the IDs from the JSON
-response presented.
+You must supply one or more Slack channel *IDs*.
+
+Grab a channel ID: right-click channel in side bar, select `View Channel
+Details` and look for a Channel ID e.g. `C0FPKDOJJ`
 
 ## Development
 
@@ -86,7 +92,6 @@ moment to check it hasn't been raised in the past (and possibly closed).
 
 ## TODO
 
-- [ ] Use new Oauth / App (instead of legacy tokens)
 - [ ] Query for channel list and let user select
 
 ## Contributing

data/lib/lolcommits/plugin/slack.rb

@@ -2,12 +2,14 @@
 
 require 'lolcommits/plugin/base'
 require 'rest_client'
+require 'json'
 
 module Lolcommits
   module Plugin
     class Slack < Base
-      # Slack API File upload endpoint
-      ENDPOINT_URL = 'https://slack.com/api/files.upload'.freeze
+      # Slack API endpoints
+      GET_UPLOAD_URL_ENDPOINT = 'https://slack.com/api/files.getUploadURLExternal'.freeze
+      COMPLETE_UPLOAD_ENDPOINT = 'https://slack.com/api/files.completeUploadExternal'.freeze
 
       # Number of times to retry if RestClient.post fails
       RETRY_COUNT = 2
@@ -16,41 +18,25 @@ module Lolcommits
       # Capture ready hook, runs after lolcommits captures a snapshot.
       #
       # Uses `RestClient` to post the lolcommit to (one or more) Slack
-      # channels. Posting will be retried (`RETRY_COUNT`) times if any
-      # error occurs.
+      # channels using the new 3-step upload process. Each step will be
+      # retried (`RETRY_COUNT`) times if any error occurs.
       #
       # The post contains the git commit message, repo name and the SHA
-      # is used for the filename. The response from the POST
+      # is used for the filename. The response from the final POST
       # request is sent to the debug log.
       #
       def run_capture_ready
-        retries = RETRY_COUNT
-        begin
-          print "Posting to Slack ... "
-          response = RestClient.post(
-            ENDPOINT_URL,
-            file: File.new(runner.lolcommit_path),
-            token: configuration[:access_token],
-            filetype: 'jpg',
-            filename: runner.sha,
-            title: runner.message + "[#{runner.vcs_info.repo}]",
-            channels: configuration[:channels]
-          )
+        print "Posting to Slack ... "
 
-          debug response
-          print "done!\n"
-        rescue => e
-          retries -= 1
-          print "failed! #{e.message}"
-          if retries > 0
-            print " - retrying ...\n"
-            retry
-          else
-            print " - giving up ...\n"
-            puts 'Try running config again:'
-            puts "\tlolcommits --config -p slack"
-          end
-        end
+        upload_url, file_id = get_upload_url
+        upload_file(upload_url)
+        complete_upload(file_id)
+
+        print "done!\n"
+      rescue => e
+        print "failed! #{e.message}\n"
+        puts 'Try running config again:'
+        puts "\tlolcommits --config -p slack"
       end
 
       ##
@@ -65,13 +51,15 @@ module Lolcommits
         options = super
 
         if options[:enabled]
-          print "open the url below and issue a token for your user:\n"
-          print "https://api.slack.com/custom-integrations/legacy-tokens\n"
-          print "enter the generated token below, then press enter: (e.g. xxxx-xxxxxxxxx-xxxx) \n"
+          print "Open the URL below to create a new Slack app (or view existing):\n"
+          print "https://api.slack.com/apps?new_app=1\n"
+          print "Ensure OAuth User Token Scopes includes files:write\n"
+          print "Install the app to your Slack workspace\n"
+          print "Paste the app's User OAuth Token below: (e.g. xxxx-xxxxxxxxx-xxxx)\n"
           code = parse_user_input(gets.strip)
 
-          print "enter a comma-seperated list of channel ids to post lolcommits in, then press enter: (e.g. c1234567890,c1234567890)\n"
-          print "note: you must use channel ids (not channel names). grab them from here; https://api.slack.com/methods/channels.list/test\n"
+          print "Enter a comma-seperated list of channel IDs to post into: (e.g. C0FPKDOJJ,C0APK3PPK)\n"
+          print "Note: you must use channel IDs (not names). Right-click channel -> View Channel Details -> look for a Channel ID\n"
           channels = parse_user_input(gets.strip)
 
           options.merge!(
@@ -82,6 +70,110 @@ module Lolcommits
 
         options
       end
+
+      private
+
+      ##
+      # Step 1: Get upload URL from Slack
+      #
+      # @return [Array<String>] upload_url and file_id
+      #
+      def get_upload_url
+        retries = RETRY_COUNT
+        begin
+          response = RestClient.post(
+            GET_UPLOAD_URL_ENDPOINT,
+            {
+              filename: runner.sha,
+              length: File.size(runner.lolcommit_path)
+            },
+            {
+              Authorization: "Bearer #{configuration[:access_token]}"
+            }
+          )
+
+          result = JSON.parse(response.body)
+          debug "Step 1 response: #{result}"
+
+          unless result['ok']
+            raise "Slack API error: #{result['error']}"
+          end
+
+          [result['upload_url'], result['file_id']]
+        rescue => e
+          retries -= 1
+          if retries > 0
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
+      ##
+      # Step 2: Upload file binary to the upload URL
+      #
+      # @param upload_url [String] the upload URL from step 1
+      #
+      def upload_file(upload_url)
+        retries = RETRY_COUNT
+        begin
+          RestClient.post(
+            upload_url,
+            {
+              file: File.new(runner.lolcommit_path)
+            }
+          )
+
+          debug "Step 2: File uploaded successfully"
+        rescue => e
+          retries -= 1
+          if retries > 0
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
+      ##
+      # Step 3: Complete the upload and share to channels
+      #
+      # @param file_id [String] the file_id from step 1
+      #
+      def complete_upload(file_id)
+        retries = RETRY_COUNT
+        begin
+          title = runner.message + "[#{runner.vcs_info.repo}]"
+          files_json = JSON.generate([{ id: file_id, title: title }])
+
+          response = RestClient.post(
+            COMPLETE_UPLOAD_ENDPOINT,
+            {
+              files: files_json,
+              channels: configuration[:channels]
+            },
+            {
+              Authorization: "Bearer #{configuration[:access_token]}"
+            }
+          )
+
+          result = JSON.parse(response.body)
+          debug "Step 3 response: #{result}"
+
+          unless result['ok']
+            raise "Slack API error: #{result['error']}"
+          end
+        rescue => e
+          retries -= 1
+          if retries > 0
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
     end
   end
 end

data/lib/lolcommits/slack/version.rb

@@ -2,6 +2,6 @@
 
 module Lolcommits
   module Slack
-    VERSION = "0.4.0".freeze
+    VERSION = "0.6.0".freeze
   end
 end

data/lolcommits-slack.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.3"
+  spec.required_ruby_version = ">= 2.4"
 
   spec.add_runtime_dependency "rest-client", ">= 2.1.0"
   spec.add_runtime_dependency "lolcommits", ">= 0.14.2"

data/test/lolcommits/plugin/slack_test.rb

@@ -34,28 +34,133 @@ describe Lolcommits::Plugin::Slack do
       end
 
       it 'should post the message to slack' do
-        stub_request(:any, plugin.class::ENDPOINT_URL)
+        # Step 1: Stub getting upload URL
+        stub_request(:post, plugin.class::GET_UPLOAD_URL_ENDPOINT)
+          .to_return(
+            status: 200,
+            body: { ok: true, upload_url: "https://files.slack.com/upload/v1/ABC123", file_id: "F123ABC" }.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+
+        # Step 2: Stub file upload to Slack's upload URL
+        stub_request(:post, /files\.slack\.com/)
+          .to_return(status: 200, body: '')
+
+        # Step 3: Stub completing the upload
+        stub_request(:post, plugin.class::COMPLETE_UPLOAD_ENDPOINT)
+          .to_return(
+            status: 200,
+            body: { ok: true }.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+
         in_repo do
           plugin.configuration = valid_enabled_config
           output = fake_io_capture { plugin.run_capture_ready }
           assert_equal output, "Posting to Slack ... done!\n"
 
-          assert_requested :post, plugin.class::ENDPOINT_URL,
-            headers: { 'Content-Type' => /multipart\/form-data;/ },
+          # Verify Step 1: Get upload URL was called with Authorization header and correct parameters
+          assert_requested :post, plugin.class::GET_UPLOAD_URL_ENDPOINT,
+            headers: { 'Authorization' => 'Bearer acbd-1234-wxyz-5678' },
+            times: 1 do |req|
+              # Verify filename and length parameters are sent
+              req.body.include?('filename=') && req.body.include?('length=')
+            end
+
+          # Verify Step 2: File upload was called
+          assert_requested :post, /files\.slack\.com/,
             times: 1
+
+          # Verify Step 3: Complete upload was called with correct parameters
+          assert_requested :post, plugin.class::COMPLETE_UPLOAD_ENDPOINT,
+            headers: { 'Authorization' => 'Bearer acbd-1234-wxyz-5678' },
+            times: 1 do |req|
+              # Verify channels and files (as JSON) parameters are sent
+              req.body.include?('channels=c123%2Cc456') && req.body.include?('files=')
+            end
+        end
+      end
+
+      it 'should retry (and explain) if step 1 fails' do
+        in_repo do
+          # Stub step 1 to timeout
+          stub_request(:post, plugin.class::GET_UPLOAD_URL_ENDPOINT).to_timeout
+
+          plugin.configuration = valid_enabled_config
+
+          _(Proc.new { plugin.run_capture_ready }).
+            must_output("Posting to Slack ... failed! Timed out connecting to server\nTry running config again:\n\tlolcommits --config -p slack\n")
+
+          # Verify Step 1 was retried RETRY_COUNT times before giving up
+          assert_requested :post, plugin.class::GET_UPLOAD_URL_ENDPOINT,
+            headers: { 'Authorization' => 'Bearer acbd-1234-wxyz-5678' },
+            times: plugin.class::RETRY_COUNT
         end
       end
 
-      it 'should retry (and explain) if there is a failure (req timeout)' do
+      it 'should retry (and explain) if step 2 fails' do
         in_repo do
-          stub_request(:any, plugin.class::ENDPOINT_URL).to_timeout
+          # Step 1 succeeds
+          stub_request(:post, plugin.class::GET_UPLOAD_URL_ENDPOINT)
+            .to_return(
+              status: 200,
+              body: { ok: true, upload_url: "https://files.slack.com/upload/v1/ABC123", file_id: "F123ABC" }.to_json,
+              headers: { 'Content-Type' => 'application/json' }
+            )
+
+          # Step 2 times out
+          stub_request(:post, /files\.slack\.com/).to_timeout
+
           plugin.configuration = valid_enabled_config
 
-          Proc.new { plugin.run_capture_ready }.
-            must_output("Posting to Slack ... failed! Timed out connecting to server - retrying ...\nPosting to Slack ... failed! Timed out connecting to server - giving up ...\nTry running config again:\n\tlolcommits --config -p slack\n")
+          _(Proc.new { plugin.run_capture_ready }).
+            must_output("Posting to Slack ... failed! Timed out connecting to server\nTry running config again:\n\tlolcommits --config -p slack\n")
+
+          # Verify Step 1 was called once
+          assert_requested :post, plugin.class::GET_UPLOAD_URL_ENDPOINT,
+            headers: { 'Authorization' => 'Bearer acbd-1234-wxyz-5678' },
+            times: 1
+
+          # Verify Step 2 was retried RETRY_COUNT times
+          assert_requested :post, /files\.slack\.com/,
+            times: plugin.class::RETRY_COUNT
+        end
+      end
+
+      it 'should retry (and explain) if step 3 fails' do
+        in_repo do
+          # Step 1 succeeds
+          stub_request(:post, plugin.class::GET_UPLOAD_URL_ENDPOINT)
+            .to_return(
+              status: 200,
+              body: { ok: true, upload_url: "https://files.slack.com/upload/v1/ABC123", file_id: "F123ABC" }.to_json,
+              headers: { 'Content-Type' => 'application/json' }
+            )
+
+          # Step 2 succeeds
+          stub_request(:post, /files\.slack\.com/)
+            .to_return(status: 200, body: '')
+
+          # Step 3 times out
+          stub_request(:post, plugin.class::COMPLETE_UPLOAD_ENDPOINT).to_timeout
+
+          plugin.configuration = valid_enabled_config
+
+          _(Proc.new { plugin.run_capture_ready }).
+            must_output("Posting to Slack ... failed! Timed out connecting to server\nTry running config again:\n\tlolcommits --config -p slack\n")
+
+          # Verify Step 1 was called once
+          assert_requested :post, plugin.class::GET_UPLOAD_URL_ENDPOINT,
+            headers: { 'Authorization' => 'Bearer acbd-1234-wxyz-5678' },
+            times: 1
+
+          # Verify Step 2 was called once
+          assert_requested :post, /files\.slack\.com/,
+            times: 1
 
-          assert_requested :post, plugin.class::ENDPOINT_URL,
-            headers: { 'Content-Type' => /multipart\/form-data;/ },
+          # Verify Step 3 was retried RETRY_COUNT times
+          assert_requested :post, plugin.class::COMPLETE_UPLOAD_ENDPOINT,
+            headers: { 'Authorization' => 'Bearer acbd-1234-wxyz-5678' },
             times: plugin.class::RETRY_COUNT
         end
       end
@@ -65,12 +170,12 @@ describe Lolcommits::Plugin::Slack do
 
     describe '#enabled?' do
       it 'should be false by default' do
-        plugin.enabled?.must_equal false
+        _(plugin.enabled?).must_equal false
       end
 
       it 'should true when configured' do
         plugin.configuration = valid_enabled_config
-        plugin.enabled?.must_equal true
+        _(plugin.enabled?).must_equal true
       end
     end
 
@@ -78,11 +183,12 @@ describe Lolcommits::Plugin::Slack do
       it 'should allow plugin options to be configured' do
         configured_plugin_options = {}
 
-        fake_io_capture(inputs: %w(true abc-def c1,c3,c4)) do
-          configured_plugin_options = plugin.configure_options!
+        # Use .dup to create mutable strings (frozen_string_literal compatibility)
+        fake_io_capture(inputs: %w(true abc-def c1,c3,c4).map(&:dup)) do
+          configured_plugin_options = plugin.send(:configure_options!)
         end
 
-        configured_plugin_options.must_equal({
+        _(configured_plugin_options).must_equal({
           enabled: true,
           access_token: 'abc-def',
           channels: 'c1,c3,c4'
@@ -91,12 +197,12 @@ describe Lolcommits::Plugin::Slack do
 
       describe '#valid_configuration?' do
         it 'should be false without config set' do
-          plugin.valid_configuration?.must_equal(false)
+          _(plugin.valid_configuration?).must_equal(false)
         end
 
         it 'should be true for a valid configuration' do
           plugin.configuration = valid_enabled_config
-          plugin.valid_configuration?.must_equal true
+          _(plugin.valid_configuration?).must_equal true
         end
       end
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits-slack
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matthew Hutchinson
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -143,7 +142,6 @@ metadata:
   source_code_uri: https://github.com/lolcommits/lolcommits-slack
   bug_tracker_uri: https://github.com/lolcommits/lolcommits-slack/issues
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -151,15 +149,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Sends lolcommits to one (or more) Slack channels
 test_files: