grape-slack-bot 1.6.12 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e747b1927fe6e5c4daefb40830a338271b003a964dc857e4e85c0f06c0e72723
-  data.tar.gz: 1d06b0374106aa8dad4c9a9f46e5173a0c3bfe6785ba80f5d7da2429a6057f91
+  metadata.gz: bf068ba32d5e7319a9e8d96710dfa364fcccedf1e0755b32305409455293b7cc
+  data.tar.gz: 2c7bba45e4a549dcc1ac64b707349244b19dcbc6ef0a069504e192a350c4f10e
 SHA512:
-  metadata.gz: 0c852fd5c5cb8bf2692b774d42c0fe2e7e074eb138df04ed9b44e34fcaf90d8db281a2cbe17e6fe80dc49c937984f70e36fad8e70b962be1c5eb6c99859e4e4c
-  data.tar.gz: 3fb00ab57011e5b5573970e4e36907482ca0020ec0a2186b6c9db6662097b41614e8d091b493ea843263b8af61fecd5ff6664473b2391619576b1e471bc60818
+  metadata.gz: b362b4a0a379c2ff986fe11d554e1aaef10b3581190c7487833c2c69b503cc2f57d1e6b393e4afb19442176079bdc472a2717e57c8921d6dc0f51a92d64f0e9e
+  data.tar.gz: f150f3b05dda3a59d8b818bd574dfd5fcb08f688ad2eb6d263bba31bc821351f858a5bb1e05a3ee17199fe1d7dd0c4bab628127251314cbb6d1d7a809bc46bff

data/README.md

@@ -524,7 +524,7 @@ Contribution policy:
 Prefer using script `usr/bin/release.sh`, it will ensure that repository is synced and after publishing gem will create a tag.
 
 ```sh
-GEM_VERSION=$(grep -Eo "VERSION\s*=\s*'.+'" lib/slack_bot.rb  | grep -Eo "[0-9.]{5,}")
+GEM_VERSION=$(grep -Eo "VERSION\s*=\s*\".+\"" lib/slack_bot.rb  | grep -Eo "[0-9.]{5,}")
 rm grape-slack-bot-*.gem
 gem build grape-slack-bot.gemspec
 gem push grape-slack-bot-$GEM_VERSION.gem

data/grape-slack-bot.gemspec

@@ -1,11 +1,9 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |gem|
   gem.name = "grape-slack-bot"
-  gem.version = File.read(File.expand_path('../lib/slack_bot.rb', __FILE__)).match(/VERSION\s*=\s*'(.*?)'/)[1]
+  gem.version = File.read(File.expand_path("../lib/slack_bot.rb", __FILE__)).match(/VERSION\s*=\s*"(.*?)"/)[1]
 
   repository_url = "https://github.com/amkisko/grape-slack-bot.rb"
-  root_files = %w(CHANGELOG.md LICENSE.md README.md)
+  root_files = %w[CHANGELOG.md LICENSE.md README.md]
   root_files << "#{gem.name}.gemspec"
 
   gem.license = "MIT"
@@ -15,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.authors = ["Andrei Makarov"]
   gem.email = ["andrei@kiskolabs.com"]
   gem.homepage = repository_url
-  gem.summary = %q{Slack bot implementation for ruby-grape}
+  gem.summary = "Slack bot implementation for ruby-grape"
   gem.description = gem.summary
   gem.metadata = {
     "homepage" => repository_url,
@@ -25,22 +23,24 @@ Gem::Specification.new do |gem|
     "rubygems_mfa_required" => "true"
   }
 
-  gem.executables = Dir.glob("bin/*").map{ |f| File.basename(f) }
+  gem.executables = Dir.glob("bin/*").map { |f| File.basename(f) }
   gem.files = Dir.glob("lib/**/*.rb") + Dir.glob("bin/**/*") + root_files
-  gem.test_files = Dir.glob("spec/**/*_spec.rb")
 
-  gem.required_ruby_version = ">= 2.5.0"
+  gem.required_ruby_version = ">= 3"
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'rack', '> 2'
-  gem.add_runtime_dependency 'grape', '> 1'
-  gem.add_runtime_dependency 'faraday', '> 1'
-  gem.add_runtime_dependency 'activesupport', '> 5'
-
-  gem.add_development_dependency 'bundler', '~> 2'
-  gem.add_development_dependency 'pry', '~> 0.14'
-  gem.add_development_dependency 'rspec', '~> 3'
-  gem.add_development_dependency 'webmock', '~> 3'
-  gem.add_development_dependency 'simplecov', '~> 0.21'
-  gem.add_development_dependency 'simplecov-cobertura', '~> 2'
+  gem.add_runtime_dependency "rack", "> 2"
+  gem.add_runtime_dependency "grape", "> 1"
+  gem.add_runtime_dependency "faraday", "> 1"
+  gem.add_runtime_dependency "activesupport", "> 5"
+
+  gem.add_development_dependency "bundler", "~> 2"
+  gem.add_development_dependency "pry", "~> 0.14"
+  gem.add_development_dependency "rspec", "~> 3"
+  gem.add_development_dependency "webmock", "~> 3"
+  gem.add_development_dependency "simplecov", "~> 0.21"
+  gem.add_development_dependency "simplecov-cobertura", "~> 2"
+  gem.add_development_dependency "standard", "~> 1"
+  gem.add_development_dependency "standard-performance", "~> 1"
+  gem.add_development_dependency "standard-rspec", "~> 0.2"
 end

data/lib/slack_bot/api_client.rb

@@ -1,4 +1,4 @@
-require 'faraday'
+require "faraday"
 
 module SlackBot
   class ApiResponse
@@ -20,6 +20,7 @@ module SlackBot
       JSON.parse(response.body)
     end
   end
+
   class ApiClient
     attr_reader :client
     def initialize(authorization_token: ENV["SLACK_BOT_API_TOKEN"])
@@ -37,27 +38,53 @@ module SlackBot
     end
 
     def views_open(trigger_id:, view:)
-      ApiResponse.new { client.post("views.open", { trigger_id: trigger_id, view: view }.to_json) }
+      ApiResponse.new { client.post("views.open", {trigger_id: trigger_id, view: view}.to_json) }
     end
 
     def views_update(view_id:, view:)
-      ApiResponse.new { client.post("views.update", { view_id: view_id, view: view }.to_json) }
+      ApiResponse.new { client.post("views.update", {view_id: view_id, view: view}.to_json) }
     end
 
     def chat_post_message(channel:, text:, blocks:)
-      ApiResponse.new { client.post("chat.postMessage", { channel: channel, text: text, blocks: blocks }.to_json) }
+      ApiResponse.new { client.post("chat.postMessage", {channel: channel, text: text, blocks: blocks}.to_json) }
     end
 
     def chat_update(channel:, ts:, text:, blocks:)
-      ApiResponse.new { client.post("chat.update", { channel: channel, ts: ts, text: text, blocks: blocks }.to_json) }
+      ApiResponse.new { client.post("chat.update", {channel: channel, ts: ts, text: text, blocks: blocks}.to_json) }
     end
 
     def users_info(user_id:)
-      ApiResponse.new { client.post("users.info", { user: user_id }.to_json) }
+      ApiResponse.new { client.post("users.info", {user: user_id}.to_json) }
     end
 
     def views_publish(user_id:, view:)
-      ApiResponse.new { client.post("views.publish", { user_id: user_id, view: view }.to_json) }
+      ApiResponse.new { client.post("views.publish", {user_id: user_id, view: view}.to_json) }
+    end
+
+    def users_list(cursor: nil, limit: 200, include_locale: nil, team_id: nil)
+      args = {}
+      args[:cursor] = cursor if cursor
+      args[:limit] = limit if limit
+      args[:include_locale] = include_locale if include_locale
+      args[:team_id] = team_id if team_id
+      ApiResponse.new { client.post("users.list", args.to_json) }
+    end
+
+    def chat_post_ephemeral(channel:, user:, text:, as_user: nil, attachments: nil, blocks: nil, icon_emoji: nil, icon_url: nil, link_names: nil, parse: nil, thread_ts: nil, username: nil)
+      args = {}
+      args[:channel] = channel
+      args[:user] = user
+      args[:text] = text if text
+      args[:as_user] = as_user if as_user
+      args[:attachments] = attachments if attachments
+      args[:blocks] = blocks if blocks
+      args[:icon_emoji] = icon_emoji if icon_emoji
+      args[:icon_url] = icon_url if icon_url
+      args[:link_names] = link_names if link_names
+      args[:parse] = parse if parse
+      args[:thread_ts] = thread_ts if thread_ts
+      args[:username] = username if username
+      ApiResponse.new { client.post("chat.postEphemeral", args.to_json) }
     end
   end
 end

data/lib/slack_bot/args.rb

@@ -1,24 +1,28 @@
-require 'rack/utils'
-require 'active_support'
-require 'active_support/core_ext/hash/indifferent_access'
+require "rack/utils"
+require "active_support"
+require "active_support/core_ext/hash/indifferent_access"
 
 module SlackBot
   class ArgsParser
     def initialize(args)
       @args = args
     end
+
     def call
       Rack::Utils.parse_query(@args)
     end
   end
+
   class ArgsBuilder
     def initialize(args)
       @args = args
     end
+
     def call
       Rack::Utils.build_query(@args)
     end
   end
+
   class Args
     attr_accessor :args
     def initialize(builder: ArgsBuilder, parser: ArgsParser)

data/lib/slack_bot/callback.rb

@@ -1,5 +1,5 @@
-require 'active_support/core_ext/object'
-require 'active_support/core_ext/numeric/time'
+require "active_support/core_ext/object"
+require "active_support/core_ext/numeric/time"
 
 module SlackBot
   class Callback
@@ -23,7 +23,7 @@ module SlackBot
       find(callback_id, user: user, config: config)
     end
 
-    def self.create(id: nil, class_name:, user:, channel_id: nil, config: nil, payload: nil, expires_in: nil, user_scope: nil)
+    def self.create(class_name:, user:, id: nil, channel_id: nil, config: nil, payload: nil, expires_in: nil, user_scope: nil)
       callback =
         new(id: id, class_name: class_name, user: user, channel_id: channel_id, payload: payload, config: config, expires_in: expires_in, user_scope: user_scope)
       callback.save
@@ -75,10 +75,10 @@ module SlackBot
       return if id.blank?
       return if data.blank?
 
-      if @data[:payload].is_a?(Hash)
-        @data[:payload] = @data[:payload].merge(payload)
+      @data[:payload] = if @data[:payload].is_a?(Hash)
+        @data[:payload].merge(payload)
       else
-        @data[:payload] = payload
+        payload
       end
 
       save

data/lib/slack_bot/command.rb

@@ -1,5 +1,5 @@
-require 'slack_bot/concerns/interaction_klass'
-require 'slack_bot/concerns/view_klass'
+require "slack_bot/concerns/interaction_klass"
+require "slack_bot/concerns/view_klass"
 
 module SlackBot
   class Command

data/lib/slack_bot/config.rb

@@ -1,15 +1,15 @@
-require 'active_support'
-require 'active_support/core_ext/object'
+require "active_support"
+require "active_support/core_ext/object"
 
 module SlackBot
   class Config
     def self.current_instance
       @@current_instances ||= {}
-      @@current_instances[self.name] ||= self.new
+      @@current_instances[name] ||= new
     end
 
-    def self.configure(&block)
-      current_instance.instance_eval(&block)
+    def self.configure(&)
+      current_instance.instance_eval(&)
     end
 
     attr_reader :callback_storage_instance
@@ -41,7 +41,7 @@ module SlackBot
       event_handlers[event_type.to_sym]
     end
 
-    def slash_command_endpoint(url_token, command_klass = nil, handler_name: nil, &block)
+    def slash_command_endpoint(url_token, command_klass = nil, handler_name: nil, &)
       @slash_command_endpoints ||= {}
       @slash_command_endpoints[url_token.to_sym] ||=
         begin
@@ -52,7 +52,7 @@ module SlackBot
               config: self,
               handler_name: handler_name
             )
-          endpoint.instance_eval(&block) if block_given?
+          endpoint.instance_eval(&) if block
           endpoint
         end
     end
@@ -105,7 +105,7 @@ module SlackBot
       end
     end
 
-    def command(command_token, command_klass, handler_name: nil, &block)
+    def command(command_token, command_klass, handler_name: nil, &)
       @command_configs ||= {}
       @command_configs[command_token.to_sym] ||=
         begin
@@ -116,7 +116,7 @@ module SlackBot
               endpoint: self,
               handler_name: handler_name
             )
-          command.instance_eval(&block) if block_given?
+          command.instance_eval(&) if block
           command
         end
     end
@@ -155,7 +155,7 @@ module SlackBot
       endpoint.config.handler_class(handler_name, command_klass)
     end
 
-    def argument_command(argument_token, klass = nil, &block)
+    def argument_command(argument_token, klass = nil, &)
       @argument_command_configs ||= {}
       @argument_command_configs[argument_token.to_sym] ||=
         SlashCommandConfig.new(
@@ -166,7 +166,7 @@ module SlackBot
         )
 
       command_config = @argument_command_configs[argument_token.to_sym]
-      command_config.instance_eval(&block) if block_given?
+      command_config.instance_eval(&) if block
 
       command_config
     end

data/lib/slack_bot/dev_console.rb

@@ -19,22 +19,22 @@ module SlackBot
     def self.log(message = nil, &block)
       return unless enabled?
 
-      message = yield if block_given?
+      message = yield if block
       logger.info(message)
     end
 
     def self.log_input(message = nil, &block)
-      message = yield if block_given?
+      message = yield if block
       log(">>> #{message}")
     end
 
     def self.log_output(message = nil, &block)
-      message = yield if block_given?
+      message = yield if block
       log("<<< #{message}")
     end
 
     def self.log_check(message = nil, &block)
-      message = yield if block_given?
+      message = yield if block
       log("!!! #{message}")
     end
   end

data/lib/slack_bot/event.rb

@@ -1,5 +1,5 @@
-require 'slack_bot/concerns/interaction_klass'
-require 'slack_bot/concerns/view_klass'
+require "slack_bot/concerns/interaction_klass"
+require "slack_bot/concerns/view_klass"
 
 module SlackBot
   class Event
@@ -20,13 +20,9 @@ module SlackBot
 
     private
 
-    def callback=(callback)
-      @callback = callback
-    end
+    attr_writer :callback
 
-    def metadata=(metadata)
-      @metadata = metadata
-    end
+    attr_writer :metadata
 
     def event_type
       params["event"]["type"]

data/lib/slack_bot/grape_extension.rb

@@ -1,105 +1,107 @@
-require 'active_support'
-require 'active_support/core_ext/object'
+require "active_support"
+require "active_support/core_ext/object"
 
 module SlackBot
-  module GrapeExtension
-    def self.included(base)
-      base.format :json
-      base.content_type :json, "application/json"
-      base.use ActionDispatch::RemoteIp
-      base.helpers do
-        def fetch_team_id
-          params.dig("team_id") || params.dig("team", "id")
-        end
+  module GrapeHelpers
+    def fetch_team_id
+      params.dig("team_id") || params.dig("team", "id")
+    end
 
-        def fetch_user_id
-          params.dig("user_id") || params.dig("user", "id") || params.dig("event", "user")
-        end
+    def fetch_user_id
+      params.dig("user_id") || params.dig("user", "id") || params.dig("event", "user")
+    end
 
-        def verify_slack_signature!
-          slack_signing_secret = ENV.fetch("SLACK_SIGNING_SECRET")
-          timestamp = request.headers["X-Slack-Request-Timestamp"]
-          request_body = request.body.read
-          sig_basestring = "v0:#{timestamp}:#{request_body}"
-          my_signature =
-            "v0=" +
-              OpenSSL::HMAC.hexdigest(
-                OpenSSL::Digest.new("sha256"),
-                slack_signing_secret,
-                sig_basestring
-              )
-          slack_signature = request.headers["X-Slack-Signature"]
-          if ActiveSupport::SecurityUtils.secure_compare(
-               my_signature,
-               slack_signature
-             )
-            true
-          else
-            raise SlackBot::Errors::SignatureAuthenticationError.new("Signature mismatch")
-          end
-        end
+    def verify_slack_signature!
+      slack_signing_secret = ENV.fetch("SLACK_SIGNING_SECRET")
+      timestamp = request.headers.fetch("x-slack-request-timestamp")
+      request_body = request.body.read
+      sig_basestring = "v0:#{timestamp}:#{request_body}"
+      my_signature =
+        "v0=" +
+        OpenSSL::HMAC.hexdigest(
+          OpenSSL::Digest.new("sha256"),
+          slack_signing_secret,
+          sig_basestring
+        )
+      slack_signature = request.headers.fetch("x-slack-signature")
+      if ActiveSupport::SecurityUtils.secure_compare(
+        my_signature,
+        slack_signature
+      )
+        true
+      else
+        raise SlackBot::Errors::SignatureAuthenticationError.new("Signature mismatch")
+      end
+    end
 
-        def verify_slack_team!
-          slack_team_id = ENV.fetch("SLACK_TEAM_ID")
-          if slack_team_id == fetch_team_id
-            true
-          else
-            raise SlackBot::Errors::TeamAuthenticationError.new("Team is not authorized")
-          end
-        end
+    def verify_slack_team!
+      slack_team_id = ENV.fetch("SLACK_TEAM_ID")
+      if slack_team_id == fetch_team_id
+        true
+      else
+        raise SlackBot::Errors::TeamAuthenticationError.new("Team is not authorized")
+      end
+    end
 
-        def verify_direct_message_channel!
-          if params[:channel_name] == "directmessage"
-            true
-          else
-            raise SlackBot::Errors::ChannelAuthenticationError.new(
-                    "This command is only available in direct messages"
-                  )
-          end
-        end
+    def verify_direct_message_channel!
+      if params[:channel_name] == "directmessage"
+        true
+      else
+        raise SlackBot::Errors::ChannelAuthenticationError.new(
+          "This command is only available in direct messages"
+        )
+      end
+    end
 
-        def verify_current_user!
-          if current_user
-            true
-          else
-            raise SlackBot::Errors::UserAuthenticationError.new("User is not authorized")
-          end
-        end
+    def verify_current_user!
+      if current_user
+        true
+      else
+        raise SlackBot::Errors::UserAuthenticationError.new("User is not authorized")
+      end
+    end
 
-        def events_callback(params)
-          verify_slack_team!
+    def events_callback(params)
+      verify_slack_team!
 
-          SlackBot::DevConsole.log_input "SlackApi::Events#events_callback: #{params.inspect}"
-          handler = config.find_event_handler(params[:event][:type].to_sym)
-          return if handler.blank?
+      SlackBot::DevConsole.log_input "SlackApi::Events#events_callback: #{params.inspect}"
+      handler = config.find_event_handler(params[:event][:type].to_sym)
+      return if handler.blank?
 
-          event = handler.new(params: params, current_user: current_user)
-          event.call
-        end
+      event = handler.new(params: params, current_user: current_user)
+      event.call
+    end
 
-        def url_verification(params)
-          SlackBot::DevConsole.log_input "SlackApi::Events#url_verification: #{params.inspect}"
-          { challenge: params[:challenge] }
-        end
+    def url_verification(params)
+      SlackBot::DevConsole.log_input "SlackApi::Events#url_verification: #{params.inspect}"
+      {challenge: params[:challenge]}
+    end
 
-        def handle_block_actions_view(view:, user:, params:)
-          callback_id = view&.dig("callback_id")
+    def handle_block_actions_view(view:, user:, params:)
+      callback_id = view&.dig("callback_id")
 
-          callback = SlackBot::Callback.find(callback_id, user: user, config: config)
-          raise SlackBot::Errors::CallbackNotFound.new if callback.blank?
+      callback = SlackBot::Callback.find(callback_id, user: user, config: config)
+      raise SlackBot::Errors::CallbackNotFound.new if callback.blank?
 
-          SlackBot::DevConsole.log_check "SlackApi::Interactions##{__method__}: #{callback.id} #{callback.payload} #{callback.user_id} #{user&.id}"
+      SlackBot::DevConsole.log_check "SlackApi::Interactions##{__method__}: #{callback.id} #{callback.payload} #{callback.user_id} #{user&.id}"
 
-          if callback.user_id != user.id
-            raise "Callback user is not equal to action user"
-          end
+      if callback.user_id != user.id
+        raise "Callback user is not equal to action user"
+      end
 
-          interaction_klass = callback.handler_class&.interaction_klass
-          return if interaction_klass.blank?
+      interaction_klass = callback.handler_class&.interaction_klass
+      return if interaction_klass.blank?
 
-          interaction_klass.new(current_user: user, params: params, callback: callback, config: config).call
-        end
-      end
+      interaction_klass.new(current_user: user, params: params, callback: callback, config: config).call
+    end
+  end
+
+  module GrapeExtension
+    def self.included(base)
+      base.format :json
+      base.content_type :json, "application/json"
+      base.use ActionDispatch::RemoteIp
+      base.helpers SlackBot::GrapeHelpers
 
       base.before do
         verify_slack_signature!

data/lib/slack_bot/interaction.rb

@@ -1,7 +1,7 @@
-require 'active_support'
-require 'active_support/core_ext/object'
+require "active_support"
+require "active_support/core_ext/object"
 
-require 'slack_bot/concerns/view_klass'
+require "slack_bot/concerns/view_klass"
 
 module SlackBot
   class Interaction
@@ -10,7 +10,7 @@ module SlackBot
     include SlackBot::Concerns::ViewKlass
 
     def self.open_modal(callback:, trigger_id:, view:)
-      view = view.merge({ type: "modal", callback_id: callback&.id })
+      view = view.merge({type: "modal", callback_id: callback&.id})
       response =
         SlackBot::ApiClient.new.views_open(trigger_id: trigger_id, view: view)
 
@@ -27,7 +27,7 @@ module SlackBot
     end
 
     def self.update_modal(callback:, view_id:, view:)
-      view = view.merge({ type: "modal", callback_id: callback&.id })
+      view = view.merge({type: "modal", callback_id: callback&.id})
       response =
         SlackBot::ApiClient.new.views_update(view_id: view_id, view: view)
 
@@ -43,7 +43,7 @@ module SlackBot
       SlackViewsReply.new(callback&.id, view_id)
     end
 
-    def self.publish_view(callback: nil, metadata: nil, user_id:, view:)
+    def self.publish_view(user_id:, view:, callback: nil, metadata: nil)
       view = view.merge(callback_id: callback.id) if callback.present?
       view = view.merge(private_metadata: metadata) if metadata.present?
       response =
@@ -139,7 +139,7 @@ module SlackBot
       return if callback.blank?
       return if actions.blank?
 
-      if block_given?
+      if block
         actions.each { |action| instance_exec(action, &block) }
       else
         callback.args.raw_args = actions.first["value"]

data/lib/slack_bot/view.rb

@@ -1,6 +1,6 @@
-require 'active_support'
-require 'active_support/core_ext/hash/indifferent_access'
-require 'slack_bot/concerns/pager_klass'
+require "active_support"
+require "active_support/core_ext/hash/indifferent_access"
+require "slack_bot/concerns/pager_klass"
 
 module SlackBot
   class View
@@ -29,7 +29,7 @@ module SlackBot
           text: context[:title]
         },
         blocks: [
-          { type: "section", text: { type: "mrkdwn", text: context[:text] } }
+          {type: "section", text: {type: "mrkdwn", text: context[:text]}}
         ]
       }
     end
@@ -37,7 +37,7 @@ module SlackBot
     private
 
     def divider_block
-      { type: "divider" }
+      {type: "divider"}
     end
 
     def current_date