slack-ruby-client 1.1.0 → 2.0.0

data/lib/slack/web/api/patches/{dialog.1.open-json-support.patch → dialog.encoded-json.patch}

@@ -1,11 +1,11 @@
 diff --git a/lib/slack/web/api/endpoints/dialog.rb b/lib/slack/web/api/endpoints/dialog.rb
-index 01f9dfd..d017adf 100644
+index 05475c8..a4ff4ff 100644
 --- a/lib/slack/web/api/endpoints/dialog.rb
 +++ b/lib/slack/web/api/endpoints/dialog.rb
-@@ -17,6 +17,12 @@ module Slack
+@@ -18,6 +18,12 @@ module Slack
            def dialog_open(options = {})
-             throw ArgumentError.new('Required arguments :dialog missing') if options[:dialog].nil?
-             throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+             raise ArgumentError, 'Required arguments :dialog missing' if options[:dialog].nil?
+             raise ArgumentError, 'Required arguments :trigger_id missing' if options[:trigger_id].nil?
 +            # dialog must be passed as an encoded JSON string
 +            if options.key?(:dialog)
 +              dialog = options[:dialog]

data/lib/slack/web/api/patches/views.view-json.patch

@@ -0,0 +1,55 @@
+diff --git a/lib/slack/web/api/endpoints/views.rb b/lib/slack/web/api/endpoints/views.rb
+index cfa83a5..038c5f0 100644
+--- a/lib/slack/web/api/endpoints/views.rb
++++ b/lib/slack/web/api/endpoints/views.rb
+@@ -19,6 +19,12 @@ module Slack
+           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.open.json
+           def views_open(options = {})
+             raise ArgumentError, 'Required arguments :view missing' if options[:view].nil?
++            raise ArgumentError, 'One of :trigger_id, :interactivity_pointer is required' unless options[:trigger_id].nil? ^ options[:interactivity_pointer].nil?
++            if options.key?(:view)
++              view = options[:view]
++              view = JSON.dump(view) unless view.is_a?(String)
++              options = options.merge(view: view)
++            end
+             post('views.open', options)
+           end
+ 
+@@ -36,6 +42,11 @@ module Slack
+           def views_publish(options = {})
+             raise ArgumentError, 'Required arguments :user_id missing' if options[:user_id].nil?
+             raise ArgumentError, 'Required arguments :view missing' if options[:view].nil?
++            if options.key?(:view)
++              view = options[:view]
++              view = JSON.dump(view) unless view.is_a?(String)
++              options = options.merge(view: view)
++            end
+             post('views.publish', options)
+           end
+ 
+@@ -52,6 +63,12 @@ module Slack
+           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.push.json
+           def views_push(options = {})
+             raise ArgumentError, 'Required arguments :view missing' if options[:view].nil?
++            raise ArgumentError, 'One of :trigger_id, :interactivity_pointer is required' unless options[:trigger_id].nil? ^ options[:interactivity_pointer].nil?
++            if options.key?(:view)
++              view = options[:view]
++              view = JSON.dump(view) unless view.is_a?(String)
++              options = options.merge(view: view)
++            end
+             post('views.push', options)
+           end
+ 
+@@ -70,6 +87,12 @@ module Slack
+           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/views/views.update.json
+           def views_update(options = {})
+             raise ArgumentError, 'Required arguments :view missing' if options[:view].nil?
++            raise ArgumentError, 'One of :external_id, :view_id is required' unless options[:external_id].nil? ^ options[:view_id].nil?
++            if options.key?(:view)
++              view = options[:view]
++              view = JSON.dump(view) unless view.is_a?(String)
++              options = options.merge(view: view)
++            end
+             post('views.update', options)
+           end
+         end

data/lib/slack/web/api/templates/method.erb

@@ -35,7 +35,7 @@ module Slack
 <% end %>
           def <%= group.gsub(".", "_") %>_<%= name %>(options = {})
 <% data['args'].select{ |k, v| v['required'] }.each do |arg_name, arg_v| %>
-            throw ArgumentError.new('Required arguments :<%= arg_name %> missing') if options[:<%= arg_name %>].nil?
+            raise ArgumentError, 'Required arguments :<%= arg_name %> missing' if options[:<%= arg_name %>].nil?
 <% end %>
 <% if data['group'] == 'groups' && data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
             options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]

data/lib/slack/web/config.rb

@@ -24,8 +24,8 @@ module Slack
       def reset
         self.endpoint = 'https://slack.com/api/'
         self.user_agent = "Slack Ruby Client/#{Slack::VERSION}"
-        self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
-        self.ca_file = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_FILE : nil
+        self.ca_path = nil
+        self.ca_file = nil
         self.token = nil
         self.proxy = nil
         self.logger = nil

data/lib/tasks/real_time.rake

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
-# largely from https://github.com/aki017/slack-ruby-gem
+
 require 'json-schema'
 require 'erubis'
 
+# largely from https://github.com/aki017/slack-ruby-gem
 namespace :slack do
   namespace :real_time do
     namespace :api do
@@ -16,39 +17,60 @@ namespace :slack do
           name = File.basename(path, '.json')
           parsed = JSON.parse(File.read(path))
           JSON::Validator.validate(event_schema, parsed, insert_defaults: true)
-          next if %w[message hello].include?(name)
+          next if name == 'message'
 
           result[name] = parsed
         end
 
-        event_handler_template =
-          Erubis::Eruby.new(File.read('lib/slack/real_time/api/templates/event_handler.erb'))
+        hook_template = Erubis::Eruby.new(File.read('lib/slack/real_time/api/templates/event_handler.erb'))
         Dir.glob('lib/slack/real_time/stores/**/*.rb').each do |store_file|
           next if File.basename(store_file) == 'base.rb'
 
-          STDOUT.write "#{File.basename(store_file)}:"
+          STDOUT.write "#{File.basename(store_file)}: "
 
           store_file_contents = File.read(store_file)
 
-          events.each_pair do |event_name, event_data|
-            if store_file_contents.include?("on :#{event_name} do")
-              STDOUT.write('.')
-            else
-              STDOUT.write('x')
-              rendered_event_handler = event_handler_template.result(
-                name: event_data['name'],
-                desc: event_data['desc']
-              )
-
-              store_file_contents.gsub!(
-                REAL_TIME_EVENTS_MARKER,
-                REAL_TIME_EVENTS_MARKER +
-                  "\n\n" +
-                  rendered_event_handler.rstrip
-              )
-            end
+          unless store_file_contents.include?(REAL_TIME_EVENTS_MARKER)
+            puts "missing '#{REAL_TIME_EVENTS_MARKER}' line; skipping."
+            next
+          end
+
+          # Extract current hook implementations from the store class
+          hooks = {}
+          hook_matcher = /
+            (?:^[[:blank:]]*\R)+                                                     # At least one blank line
+            (?:^[[:blank:]]*\#.*\R)*                                                 # Optional preceding comments
+            (?<hook>                                                                 # on :event do |data|
+              ^(?<padding>[[:blank:]]+)\#\ *on\ :(?<event>\w+)\ do\ \|[\w, ]+\|\ *\R # Commented hook
+              (?>^\k<padding>\#.*\R)*                                                # Extra comments
+              |
+              ^(?<padding>[[:blank:]]+)on\ :(?<event>\w+)\ do\ \|[\w, ]+\|\ *\R      # Active hook
+              [\s\S]*?                                                               # Inside block
+              (?>^\k<padding>end[[:blank:]]*\R)                                      # End of block
+            )
+          /x
+          store_file_contents.gsub!(hook_matcher) do
+            hook, event = Regexp.last_match.values_at(:hook, :event)
+            hooks[event] = hook
+            nil
+          end
+
+          # Render latest event documentation with current hook implementations
+          rendered_hooks = events.sort.map do |event_name, event_data|
+            STDOUT.write(hooks.key?(event_name) ? '.' : 'x')
+
+            hook_template.result(
+              name: event_data['name'],
+              desc: event_data['desc'],
+              hook: hooks[event_name]
+            ).rstrip
           end
 
+          # Insert updated event hooks under RealTime Events marker
+          store_file_contents.gsub!(
+            REAL_TIME_EVENTS_MARKER,
+            [REAL_TIME_EVENTS_MARKER, *rendered_hooks].join("\n\n")
+          )
           File.write(store_file, store_file_contents)
 
           puts ' done.'

data/lib/tasks/web.rake

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
-# largely from https://github.com/aki017/slack-ruby-gem
+
 require 'json-schema'
 require 'erubis'
 require 'active_support'
 require 'active_support/core_ext'
 
+# largely from https://github.com/aki017/slack-ruby-gem
 namespace :slack do
   namespace :web do
     namespace :api do
@@ -39,11 +40,17 @@ namespace :slack do
           result[prefix][name] = parsed
         end
 
+        # Start with a fresh slate
+        Dir.glob('lib/slack/web/api/endpoints/*.rb').each { |file| File.delete(file) }
+        Dir.glob('spec/slack/web/api/endpoints/*_spec.rb').each { |file| File.delete(file) }
+        Dir.glob('bin/commands/*.rb').each { |file| File.delete(file) }
+
         method_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/method.erb'))
         method_spec_template =
           Erubis::Eruby.new(File.read('lib/slack/web/api/templates/method_spec.erb'))
         command_template = Erubis::Eruby.new(File.read('lib/slack/web/api/templates/command.erb'))
-        data.each_with_index do |(group, names), index|
+
+        data.each.with_index(1) do |(group, names), index|
           printf "%2d/%2d %10s %s\n", index, data.size, group, names.keys
           # method
           snaked_group = group.tr('.', '_')

data/spec/fixtures/slack/web/rtm_connect.yml

@@ -304,4 +304,88 @@ http_interactions:
       encoding: UTF-8
       string: '{"ok":false,"error":"invalid_array_arg"}'
   recorded_at: Sat, 19 Jan 2019 21:25:48 GMT
-recorded_with: VCR 6.0.0
+- request:
+    method: post
+    uri: https://slack.com/api/rtm.connect
+    body:
+      encoding: UTF-8
+      string: presence_sub=true
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Client/2.0.0
+      Authorization:
+      - Bearer <SLACK_API_TOKEN>
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 25 Sep 2022 22:32:50 GMT
+      Server:
+      - Apache
+      X-Powered-By:
+      - HHVM/4.153.1
+      Access-Control-Allow-Origin:
+      - "*"
+      Referrer-Policy:
+      - no-referrer
+      X-Slack-Backend:
+      - r
+      X-Slack-Unique-Id:
+      - YzDXEnlUBjX0uWkT8kmCzwAAABM
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Access-Control-Allow-Headers:
+      - slack-route, x-slack-version-ts, x-b3-traceid, x-b3-spanid, x-b3-parentspanid,
+        x-b3-sampled, x-b3-flags
+      Access-Control-Expose-Headers:
+      - x-slack-req-id, retry-after
+      X-Oauth-Scopes:
+      - identify,bot:basic
+      X-Accepted-Oauth-Scopes:
+      - rtm:stream,client
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
+      X-Xss-Protection:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Slack-Req-Id:
+      - 20417f9da55172a329704fca8e35f683
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '275'
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Envoy-Upstream-Service-Time:
+      - '116'
+      X-Backend:
+      - main_normal main_bedrock_normal_with_overflow main_canary_with_overflow main_bedrock_canary_with_overflow
+        main_control_with_overflow main_bedrock_control_with_overflow
+      X-Server:
+      - slack-www-hhvm-main-iad-fbwt
+      X-Slack-Shared-Secret-Outcome:
+      - no-match
+      Via:
+      - envoy-www-iad-twh3, envoy-edge-pdx-hvfy
+      X-Edge-Backend:
+      - envoy-www
+      X-Slack-Edge-Shared-Secret-Outcome:
+      - no-match
+    body:
+      encoding: UTF-8
+      string: '{"ok":true,"url":"wss:\/\/wss-primary.slack.com\/websocket\/IDugmjBU5vPyDN1rGavpMHB1CdAznuJDyHl3pqAHz_DSflTYmCyuPIxH1vwqvz3aIXhyarUZMxyWiJD7zako2Wqc_poO8uiP3i6teabXYTA4vx4Hu2pa9k9PACV1apgYJFRU_iw4g2c5qeo=\/2","team":{"id":"T04KB5WQH","name":"dblock","domain":"dblockdotorg"},"self":{"id":"U0J1GAHN1","name":"travis-ci"}}'
+  recorded_at: Sun, 25 Sep 2022 22:32:50 GMT
+recorded_with: VCR 6.1.0

data/spec/slack/events/config_spec.rb

@@ -14,9 +14,11 @@ RSpec.describe Slack::Events::Config do
   it 'defaults signing secret to ENV[SLACK_SIGNING_SECRET]' do
     expect(Slack::Events.config.signing_secret).to eq 'secret'
   end
+
   it 'defaults signature expiration to 5 minutes' do
     expect(Slack::Events.config.signature_expires_in).to eq 5 * 60
   end
+
   context 'configured' do
     before do
       Slack::Events.configure do |config|

data/spec/slack/events/request_spec.rb

@@ -101,6 +101,7 @@ RSpec.describe Slack::Events::Request do
         expect(request).to be_valid
         expect(request).not_to be_expired
       end
+
       it 'does not raise an error and returns true' do
         expect(request.verify!).to be true
       end
@@ -115,6 +116,7 @@ RSpec.describe Slack::Events::Request do
         expect(request).to be_valid
         expect(request).to be_expired
       end
+
       it 'raises an error on verify!' do
         expect { request.verify! }.to raise_error Slack::Events::Request::TimestampExpired
       end
@@ -129,6 +131,7 @@ RSpec.describe Slack::Events::Request do
         expect(request).to be_valid
         expect(request).not_to be_expired
       end
+
       it 'does not raise an error on verify!' do
         expect(request.verify!).to be true
       end
@@ -143,6 +146,7 @@ RSpec.describe Slack::Events::Request do
         expect(request).to be_valid
         expect(request).to be_expired
       end
+
       it 'raises an error on verify!' do
         expect { request.verify! }.to raise_error Slack::Events::Request::TimestampExpired
       end

data/spec/slack/messages/formatting_spec.rb

@@ -10,30 +10,37 @@ describe Slack::Messages::Formatting do
     it 'plain text' do
       expect(formatting.unescape('plain text')).to eq 'plain text'
     end
+
     it 'decodes an HTML-encoded message' do
       expect(formatting.unescape('Hello &amp; &lt;world&gt;')).to eq 'Hello & <world>'
     end
+
     it 'unescapes a user reference' do
       expect(formatting.unescape('Hey <@U024BE7LH|bob>, did you see my file?')).to(
         eq('Hey @bob, did you see my file?')
       )
     end
+
     it 'unescapes a user reference without a name' do
       expect(formatting.unescape('<@U02BEFY4U> ^^^')).to eq '@U02BEFY4U ^^^'
     end
+
     it 'unescapes a URL without text' do
       expect(formatting.unescape('This message contains a URL <http://foo.com/>')).to(
         eq('This message contains a URL http://foo.com/')
       )
     end
+
     it 'unescapes a URL with text' do
       expect(formatting.unescape('So does this one: <http://www.foo.com|www.foo.com>')).to(
         eq('So does this one: www.foo.com')
       )
     end
+
     it 'removes mailto' do
       expect(formatting.unescape('<mailto:bob@example.com|Bob>')).to eq 'Bob'
     end
+
     it 'unlinkifies references' do
       expect(
         formatting.unescape('Hello <@U123|bob>, say hi to <!everyone> in <#C1234|general>')
@@ -41,12 +48,15 @@ describe Slack::Messages::Formatting do
         eq('Hello @bob, say hi to @everyone in #general')
       )
     end
+
     it 'can handle a lone &gt;' do
       expect(formatting.unescape('Hello <@U123|bob> &gt; file.txt')).to eq 'Hello @bob > file.txt'
     end
+
     it 'unescapes a double smart quote' do
       expect(formatting.unescape('“hello”')).to eq '"hello"'
     end
+
     it 'unescapes a single smart quote' do
       expect(formatting.unescape('‘hello’')).to eq "'hello'"
     end

data/spec/slack/real_time/api/message_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_connect' } do
   include_context 'connected client'
 
   describe '#message' do

data/spec/slack/real_time/api/ping_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_connect' } do
   include_context 'connected client'
 
   describe '#ping' do

data/spec/slack/real_time/api/typing_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_connect' } do
   include_context 'connected client'
 
   describe '#typing' do