Align webhook parser with Steep suggestions (#481)

Passing the webhook parser to Steep revealed several suggestions for
improvement. While some of them are strict, following them has no
significant downside. This PR applies changes to eliminate those errors.

Author: Yang-33

Gemfile.lock

@@ -43,15 +43,15 @@ GEM
     json (2.10.2)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    logger (1.7.0)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
     minitest (5.25.5)
     multipart-post (2.4.1)
+    mutex_m (0.3.0)
     net-http (0.6.0)
       uri
-    mutex_m (0.3.0)
     parallel (1.26.3)
     parser (3.3.7.4)
       ast (~> 2.4.1)

README_v2.md

@@ -72,7 +72,7 @@ post '/callback' do
   signature = request.env['HTTP_X_LINE_SIGNATURE']
 
   begin
-    events = parser.parse(body, signature)
+    events = parser.parse(body: body, signatuer: signature)
   rescue Line::Bot::V2::WebhookParser::InvalidSignatureError
     halt 400, { 'Content-Type' => 'text/plain' }, 'Bad Request'
   end
@@ -122,7 +122,7 @@ The `x-line-accepted-request-id` or `content-type` header can also be obtained i
 push_request = Line::Bot::V2::MessagingApi::PushMessageRequest.new(
   to: event.source.user_id,
   messages: [
-    Line::Bot::V2::MessagingApi::TextMessage.new(type: 'text', text: "[^Request ID] #{headers['x-line-request-id']}")
+    Line::Bot::V2::MessagingApi::TextMessage.new(text: "[^Request ID] #{headers['x-line-request-id']}")
   ]
 )
 _body, _status_code, headers = client.push_message_with_http_info(push_message_request: push_request)

examples/v2/echobot/app.rb

@@ -18,7 +18,7 @@ def parser
   signature = request.env['HTTP_X_LINE_SIGNATURE']
 
   begin
-    events = parser.parse(body, signature)
+    events = parser.parse(body: body, signature: signature)
   rescue Line::Bot::V2::WebhookParser::InvalidSignatureError
     halt 400, { 'Content-Type' => 'text/plain' }, 'Bad Request'
   end

examples/v2/kitchensink/app.rb

@@ -44,7 +44,7 @@ def parser
   signature = request.env['HTTP_X_LINE_SIGNATURE']
 
   begin
-    events = parser.parse(body, signature)
+    events = parser.parse(body: body, signature: signature)
   rescue Line::Bot::V2::WebhookParser::InvalidSignatureError
     halt 400, { 'Content-Type' => 'text/plain' }, 'Bad Request'
   end

lib/line/bot/v2/webhook_parser.rb

@@ -1,8 +1,8 @@
+require 'base64'
 require 'json'
 require 'openssl'
 
-require 'line/bot/v2/reserved_words'
-require 'line/bot/v2/messaging_api/core'
+require 'line/bot/v2/utils'
 require 'line/bot/v2/webhook/core'
 
 module Line
@@ -39,7 +39,7 @@ def initialize(channel_secret:)
         #     signature = request.env['HTTP_X_LINE_SIGNATURE']
         #
         #     begin
-        #       events = parser.parse(body, signature)
+        #       events = parser.parse(body: body, signature: signature)
         #     rescue Line::Bot::V2::WebhookParser::InvalidSignatureError
         #       halt 400, { 'Content-Type' => 'text/plain' }, 'Bad Request'
         #     end
@@ -53,7 +53,7 @@ def initialize(channel_secret:)
         #     end
         #     "OK"
         #   end
-        def parse(body, signature)
+        def parse(body:, signature:)
           raise InvalidSignatureError.new("Invalid signature: #{signature}") unless verify_signature(body: body, signature: signature)
 
           data = JSON.parse(body.chomp, symbolize_names: true)
@@ -62,7 +62,7 @@ def parse(body, signature)
           data = Line::Bot::V2::Utils.deep_symbolize(data)
 
           data[:events].map do |event|
-            Line::Bot::V2::Webhook::Event.create(**event)
+            Line::Bot::V2::Webhook::Event.create(**event) # steep:ignore
           end
         end
 
@@ -85,7 +85,7 @@ def secure_compare(a, b)
           l = a.unpack("C#{a.bytesize}")
 
           res = 0
-          b.each_byte { |byte| res |= byte ^ l.shift }
+          b.each_byte { |byte| res |= byte ^ l.shift } # steep:ignore ArgumentTypeMismatch
           res == 0
         end
       end

sig/line/bot/v2/webhook_parser.rbs

@@ -14,11 +14,11 @@ module Line
 
         private
 
-        def variable_secure_compare: (a: String, b: String) -> bool
+        def verify_signature: (body: String, signature: String) -> bool
 
-        def secure_compare: (a: String, b: String) -> bool
+        def variable_secure_compare: (String, String) -> bool
 
-        def verify_signature: (body: String, signature: String) -> bool
+        def secure_compare: (String, String) -> bool
       end
     end
   end