slack-ruby-client 3.1.0 → 3.2.0

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

@@ -40,8 +40,10 @@ module Slack
 <% data['arg_groups']&.each do |arg_group| %>
   <% next if arg_group['args'].size <= 1 %>
 <% arg_string = arg_group['args'].map { |arg_name| ":#{arg_name}" }.join(', ') %>
-<% if arg_group['mutually_exclusive'] %>
+<% if arg_group['mutually_exclusive'] && arg_group['required'] != false %>
             raise ArgumentError, 'Exactly one of <%= arg_string %> is required' unless <%= arg_group['args'].map { |arg_name| "options[:#{arg_name}].nil?" }.join(' ^ ') %>
+<% elsif arg_group['mutually_exclusive'] %>
+            raise ArgumentError, '<%= arg_string %> are mutually exclusive' if <%= arg_group['args'].map { |arg_name| "!options[:#{arg_name}].nil?" }.join(' && ') %>
 <% else %>
             raise ArgumentError, 'At least one of <%= arg_string %> is required' if <%= arg_group['args'].map { |arg_name| "options[:#{arg_name}].nil?"}.join(' && ') %>
 <% end %>

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

@@ -5,6 +5,21 @@ require 'spec_helper'
 
 RSpec.describe Slack::Web::Api::Endpoints::<%= group.gsub(".", "_").camelize %> do
   let(:client) { Slack::Web::Client.new }
+<%
+  # Renders a Ruby literal as source code deterministically, regardless of the
+  # Ruby version used to run the generator (Hash#inspect's format for symbol
+  # keys changed in Ruby 3.4, which would otherwise cause spurious diffs).
+  ruby_literal = lambda do |val|
+    case val
+    when Hash
+      "{#{val.map { |k, v| "#{k}: #{ruby_literal.call(v)}" }.join(', ')}}"
+    when Array
+      "[#{val.map { |v| ruby_literal.call(v) }.join(', ')}]"
+    else
+      val.inspect
+    end
+  end
+%>
 <% names.sort.each_with_index do |(name, data), index| %>
 <% next if data['mixin'] %>
 <% group_required_params = data['arg_groups']&.map { |grp| grp['args'].first if grp['args'].size > 1 } || [] %>
@@ -21,23 +36,37 @@ RSpec.describe Slack::Web::Api::Endpoints::<%= group.gsub(".", "_").camelize %>
       expect { client.<%= method_name %><%= params_except_required.empty? ? '' : "(#{params_except_required})" %> }.to raise_error ArgumentError, /Required arguments :<%= arg_name %> missing/
     end
 <% end %>
+<% at_most_one_groups = data['arg_groups']&.select { |g| g['mutually_exclusive'] && g['required'] == false } || [] %>
 <% data['arg_groups']&.each do |arg_group| %>
     <% next if arg_group['args'].size <= 1 %>
+<% at_most_one = arg_group['mutually_exclusive'] && arg_group['required'] == false %>
+<% if at_most_one %>
+    it 'does not allow both <%= arg_group['args'].join(' and ') %>' do
+<% else %>
     it 'requires one of <%= arg_group['args'].join(', ') %>' do
+<% end %>
 <% params_except_required = example_params.reject { |name, _| arg_group['args'].include?(name)  }.map { |name, val| "#{name}: %q[#{val}]" }.join(', ') %>
+<% if at_most_one %>
+<% error_message = 'mutually exclusive' %>
+<% else %>
 <% error_message = arg_group['mutually_exclusive'] ? 'Exactly' : 'At least' %>
       expect { client.<%= method_name %><%= params_except_required.empty? ? '' : "(#{params_except_required})" %> }.to raise_error ArgumentError, /<%= error_message %> one of/
+<% end %>
 <% (1..arg_group['args'].length).each do |n| %>
 <% arg_group['args'].combination(n) do |names| %>
 <% params = names.map { |name| "#{name}: %q[#{data['args'][name]['example']}]" }.join(', ') %>
 <% params = "#{params}, #{params_except_required}" unless params_except_required.empty? %>
-<% if n == 1 || !arg_group['mutually_exclusive'] %>
+<% violates_at_most_one = at_most_one_groups.any? { |g| (names & g['args']).length > 1 } %>
+<% if violates_at_most_one %>
+
+      expect { client.<%= method_name %><%= "(#{params})" %> }.to raise_error ArgumentError, /mutually exclusive/
+<% elsif n == 1 || !arg_group['mutually_exclusive'] %>
 
       expect(client).to receive(:post).with('<%= group %>.<%= name %>', {<%= params %>})
       client.<%= method_name %><%= "(#{params})" %>
 <% else %>
 
-      expect { client.<%= method_name %><%= "(#{params})" %> }.to raise_error ArgumentError, /<%= error_message %> one of/
+      expect { client.<%= method_name %><%= "(#{params})" %> }.to raise_error ArgumentError, /<%= at_most_one ? error_message : "#{error_message} one of" %>/
 <% end %>
 <% end %>
 <% end %>
@@ -45,7 +74,7 @@ RSpec.describe Slack::Web::Api::Endpoints::<%= group.gsub(".", "_").camelize %>
 <% end %>
 <% if json_params.any? %>
 <% example_json_params = json_params.to_h { |name| [name, {data: ['data']}] } %>
-<% params = example_params.merge(example_json_params).map { |name, val| val = val.is_a?(String) ? "%q[#{val}]" : val; "#{name}: #{val}" }.join(', ') %>
+<% params = example_params.merge(example_json_params).map { |name, val| val = val.is_a?(String) ? "%q[#{val}]" : ruby_literal.call(val); "#{name}: #{val}" }.join(', ') %>
 <% expected_params = example_params.merge(example_json_params.transform_values { |v| JSON.dump(v) }).map { |name, val| val = "%q[#{val}]"; "#{name}: #{val}" }.join(', ') %>
     it 'encodes <%= json_params.join(', ') %> as json' do
       expect(client).to receive(:post).with('<%= group %>.<%= name %>', {<%= expected_params %>})

data/lib/tasks/web.rake

@@ -59,13 +59,16 @@ namespace :slack do
 
           unless ENV.key?('SKIP_PATCH')
             Dir.glob("lib/slack/web/api/patches/#{group}*.patch").sort.each do |patch|
-              puts "- patching #{patch}"
+              puts "#{' ' * 7}patching #{patch}"
               system("git apply #{patch}") || raise('failed to apply patch')
             end
           end
 
           # command
-          raise "Missing group #{group}" unless groups.key?(group)
+          unless groups.key?(group)
+            puts "#{' ' * 7}undocumented group #{group}"
+            groups[group] = { 'name' => group }
+          end
 
           rendered_command = command_template.result(group: groups[group], names: names)
           File.write "bin/commands/#{snaked_group}.rb", rendered_command

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
@@ -102,8 +102,9 @@ files:
 - ".coveralls.yml"
 - ".github/FUNDING.yml"
 - ".github/dependabot.yml"
+- ".github/workflows/danger-comment.yml"
+- ".github/workflows/danger.yml"
 - ".github/workflows/lint.yml"
-- ".github/workflows/pr_lint.yml"
 - ".github/workflows/test.yml"
 - ".github/workflows/update_api.yml"
 - ".gitignore"
@@ -116,7 +117,6 @@ files:
 - CONTRIBUTING.md
 - Dangerfile
 - Gemfile
-- Gemfile.danger
 - LICENSE.md
 - README.md
 - RELEASING.md
@@ -124,6 +124,7 @@ files:
 - SECURITY.md
 - UPGRADING.md
 - bin/commands/admin_analytics.rb
+- bin/commands/admin_analytics_messages.rb
 - bin/commands/admin_apps.rb
 - bin/commands/admin_apps_activities.rb
 - bin/commands/admin_apps_approved.rb
@@ -162,11 +163,14 @@ files:
 - bin/commands/apps_connections.rb
 - bin/commands/apps_datastore.rb
 - bin/commands/apps_event_authorizations.rb
+- bin/commands/apps_icon.rb
 - bin/commands/apps_manifest.rb
+- bin/commands/apps_user_connection.rb
 - bin/commands/assistant_search.rb
 - bin/commands/assistant_threads.rb
 - bin/commands/auth.rb
 - bin/commands/auth_teams.rb
+- bin/commands/blocks.rb
 - bin/commands/bookmarks.rb
 - bin/commands/bots.rb
 - bin/commands/calls.rb
@@ -194,6 +198,7 @@ files:
 - bin/commands/migration.rb
 - bin/commands/oauth.rb
 - bin/commands/oauth_v2.rb
+- bin/commands/oauth_v2_user.rb
 - bin/commands/openid_connect.rb
 - bin/commands/pins.rb
 - bin/commands/reactions.rb
@@ -247,6 +252,7 @@ files:
 - lib/slack/version.rb
 - lib/slack/web/api/endpoints.rb
 - lib/slack/web/api/endpoints/admin_analytics.rb
+- lib/slack/web/api/endpoints/admin_analytics_messages.rb
 - lib/slack/web/api/endpoints/admin_apps.rb
 - lib/slack/web/api/endpoints/admin_apps_activities.rb
 - lib/slack/web/api/endpoints/admin_apps_approved.rb
@@ -285,11 +291,14 @@ files:
 - lib/slack/web/api/endpoints/apps_connections.rb
 - lib/slack/web/api/endpoints/apps_datastore.rb
 - lib/slack/web/api/endpoints/apps_event_authorizations.rb
+- lib/slack/web/api/endpoints/apps_icon.rb
 - lib/slack/web/api/endpoints/apps_manifest.rb
+- lib/slack/web/api/endpoints/apps_user_connection.rb
 - lib/slack/web/api/endpoints/assistant_search.rb
 - lib/slack/web/api/endpoints/assistant_threads.rb
 - lib/slack/web/api/endpoints/auth.rb
 - lib/slack/web/api/endpoints/auth_teams.rb
+- lib/slack/web/api/endpoints/blocks.rb
 - lib/slack/web/api/endpoints/bookmarks.rb
 - lib/slack/web/api/endpoints/bots.rb
 - lib/slack/web/api/endpoints/calls.rb
@@ -317,6 +326,7 @@ files:
 - lib/slack/web/api/endpoints/migration.rb
 - lib/slack/web/api/endpoints/oauth.rb
 - lib/slack/web/api/endpoints/oauth_v2.rb
+- lib/slack/web/api/endpoints/oauth_v2_user.rb
 - lib/slack/web/api/endpoints/openid_connect.rb
 - lib/slack/web/api/endpoints/pins.rb
 - lib/slack/web/api/endpoints/reactions.rb

data/.github/workflows/pr_lint.yml

@@ -1,21 +0,0 @@
-name: PR Lint
-on: pull_request
-jobs:
-  danger:
-    name: Dangerfile
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_GEMFILE: ${{ github.workspace }}/Gemfile.danger
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v5
-        with:
-          fetch-depth: 0
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-      - run: |
-          # Personal access token for dangerpr-bot - public, but base64 encoded to avoid tripping up GitHub
-          TOKEN=$(echo -n Z2hwX0xNQ3VmanBFeTBvYkZVTWh6NVNqVFFBOEUxU25abzBqRUVuaAo= | base64 --decode)
-          DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose

data/Gemfile.danger

@@ -1,6 +0,0 @@
-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