Module: SlackBot::GrapeHelpers

Includes:
Dispatch, Interactions
Defined in:
lib/slack_bot/grape_extension.rb,
lib/slack_bot/grape_helpers/dispatch.rb,
lib/slack_bot/grape_helpers/interactions.rb,
sig/slack_bot.rbs

Defined Under Namespace

Modules: Dispatch, Interactions

Constant Summary collapse

TIMESTAMP_TOLERANCE_SECONDS =

Slack recommends rejecting requests older than 5 minutes

300
MIN_SIGNING_SECRET_LENGTH =

Minimum length for Slack signing secret (Slack's requirement)

32

Instance Method Summary collapse

Methods included from Interactions

#validate_callback_user!

Instance Method Details

#dispatch_event ⇒ Boolean

Parameters:

  • handler: (Class)
  • params: (Hash[String, untyped])
  • current_user: (Object)

Returns:

  • (Boolean) 


336
 
# File 'sig/slack_bot.rbs', line 336

def dispatch_event: (handler: Class, params: Hash[String, untyped], current_user: untyped) -> bool

#events_callback ⇒ Object

Parameters:

  • params (Hash[String, untyped])

Returns:

  • (Object) 


332
 
# File 'sig/slack_bot.rbs', line 332

def events_callback: (Hash[String, untyped] params) -> untyped

#fetch_team_id ⇒ String?

Returns:

  • (String, nil) 


18
19
20
 
# File 'lib/slack_bot/grape_extension.rb', line 18

def fetch_team_id
  params.dig("team_id") || params.dig("team", "id")
end

#fetch_user_id ⇒ String?

Returns:

  • (String, nil) 


22
23
24
 
# File 'lib/slack_bot/grape_extension.rb', line 22

def fetch_user_id
  params.dig("user_id") || params.dig("user", "id") || params.dig("event", "user")
end

#handle_block_actions_message ⇒ Object

Parameters:

  • payload: (Hash[String, untyped])
  • user: (Object)
  • params: (Hash[String, untyped])

Returns:

  • (Object) 


335
 
# File 'sig/slack_bot.rbs', line 335

def handle_block_actions_message: (payload: Hash[String, untyped], user: untyped, params: Hash[String, untyped]) -> untyped

#handle_block_actions_view ⇒ Object

Parameters:

  • view: (Hash[String, untyped], nil)
  • user: (Object)
  • params: (Hash[String, untyped])

Returns:

  • (Object) 


334
 
# File 'sig/slack_bot.rbs', line 334

def handle_block_actions_view: (view: Hash[String, untyped]?, user: untyped, params: Hash[String, untyped]) -> untyped

#interaction_team_id(payload) ⇒ String?

Parameters:

  • payload (Hash[String, untyped])

Returns:

  • (String, nil) 


46
47
48
 
# File 'lib/slack_bot/grape_extension.rb', line 46

def interaction_team_id(payload)
  payload.dig("team", "id") || payload["team_id"] || payload.dig("user", "team_id")
end

#resolve_event_user ⇒ Object?

Parameters:

  • params (Hash[String, untyped])

Returns:

  • (Object, nil) 


331
 
# File 'sig/slack_bot.rbs', line 331

def resolve_event_user: (Hash[String, untyped] params) -> untyped?

#resolve_user_session ⇒ Object?

Parameters:

  • team_id (String, nil)
  • user_id (String, nil)

Returns:

  • (Object, nil) 


330
 
# File 'sig/slack_bot.rbs', line 330

def resolve_user_session: (String? team_id, String? user_id) -> untyped?

#route_interaction ⇒ Object

Parameters:

  • payload: (Hash[String, untyped])
  • user: (Object)
  • params: (Hash[String, untyped])

Returns:

  • (Object) 


337
 
# File 'sig/slack_bot.rbs', line 337

def route_interaction: (payload: Hash[String, untyped], user: untyped, params: Hash[String, untyped]) -> untyped

#slack_request_retry? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/slack_bot/grape_extension.rb', line 66

def slack_request_retry?
  slack_request_header("x-slack-retry-num", "X-Slack-Retry-Num").present?
end

#url_verification(params) ⇒ Hash[String, String]

Parameters:

  • params (Hash[String, untyped])

Returns:

  • (Hash[String, String]) 


70
71
72
73
 
# File 'lib/slack_bot/grape_extension.rb', line 70

def url_verification(params)
  SlackBot::DevConsole.log_input "SlackApi::Events#url_verification: #{params.inspect}"
  {challenge: params[:challenge]}
end

#verify_current_user! ⇒ Boolean

Returns:

  • (Boolean)

Raises:



60
61
62
63
64
 
# File 'lib/slack_bot/grape_extension.rb', line 60

def verify_current_user!
  return true if current_user

  raise SlackBot::Errors::UserAuthenticationError.new("User is not authorized")
end

#verify_direct_message_channel! ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
53
54
55
56
57
58
 
# File 'lib/slack_bot/grape_extension.rb', line 50

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

#verify_slack_signature! ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
29
30
31
32
33
34
 
# File 'lib/slack_bot/grape_extension.rb', line 26

def verify_slack_signature!
  slack_signing_secret = ENV["SLACK_SIGNING_SECRET"]
  timestamp = slack_request_header("x-slack-request-timestamp", "X-Slack-Request-Timestamp")
  slack_signature = slack_request_header("x-slack-signature", "X-Slack-Signature")

  validate_signature_headers!(slack_signing_secret, timestamp, slack_signature)
  validate_request_timestamp!(timestamp)
  verify_signature_match!(slack_signing_secret, timestamp, slack_signature)
end

#verify_slack_team!(team_id = nil) ⇒ Boolean

Parameters:

  • team_id (String, nil) (defaults to: nil)

Returns:

  • (Boolean) 


36
37
38
39
40
41
42
43
44
 
# File 'lib/slack_bot/grape_extension.rb', line 36

def verify_slack_team!(team_id = nil)
  slack_team_id = ENV["SLACK_TEAM_ID"]
  requested_team_id = team_id || fetch_team_id
  if slack_team_id.present? && slack_team_id == requested_team_id
    true
  else
    raise SlackBot::Errors::TeamAuthenticationError.new("Team is not authorized")
  end
end