Merge pull request #189 from line/feature/retry_key

Support X-Line-Retry-Key

Author: kimoto

lib/line/bot/client.rb

@@ -106,15 +106,16 @@ def revoke_channel_token(access_token)
       #
       # @param user_id [String] User Id
       # @param messages [Hash or Array] Message Objects
+      # @param headers [Hash] HTTP Headers
       # @return [Net::HTTPResponse]
-      def push_message(user_id, messages)
+      def push_message(user_id, messages, headers: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/push'
         payload = { to: user_id, messages: messages }.to_json
-        post(endpoint, endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       # Reply messages to a user using replyToken.
@@ -151,30 +152,33 @@ def reply_message(token, messages)
       #
       # @param to [Array or String] Array of userIds
       # @param messages [Hash or Array] Message Objects
+      # @param headers [Hash] HTTP Headers
       # @return [Net::HTTPResponse]
-      def multicast(to, messages)
+      def multicast(to, messages, headers: {})
         channel_token_required
 
         to = [to] if to.is_a?(String)
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/multicast'
         payload = { to: to, messages: messages }.to_json
-        post(endpoint, endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       # Send messages to all friends.
       #
       # @param messages [Hash or Array] Message Objects
+      # @param headers [Hash] HTTP Headers
+      #
       # @return [Net::HTTPResponse]
-      def broadcast(messages)
+      def broadcast(messages, headers: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/broadcast'
         payload = { messages: messages }.to_json
-        post(endpoint, endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       # Narrowcast messages to users
@@ -186,9 +190,10 @@ def broadcast(messages)
       # @param recipient [Hash]
       # @param filter [Hash]
       # @param limit [Hash]
+      # @param headers [Hash] HTTP Headers
       #
       # @return [Net::HTTPResponse]
-      def narrowcast(messages, recipient: nil, filter: nil, limit: nil)
+      def narrowcast(messages, recipient: nil, filter: nil, limit: nil, headers: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
@@ -200,7 +205,7 @@ def narrowcast(messages, recipient: nil, filter: nil, limit: nil)
           filter: filter,
           limit: limit
         }.to_json
-        post(endpoint, endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       def leave_group(group_id)

spec/line/bot/client_spec.rb

@@ -126,4 +126,35 @@ def generate_client
     messages = body[:messages]
     expect(messages[0]).to eq message
   end
+
+  it 'set X-Line-Retry-Key' do
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = dummy_config[:channel_token]
+    end
+
+    available_endpoints = [
+      '/bot/message/push',
+      '/bot/message/multicast',
+      '/bot/message/narrowcast',
+      '/bot/message/broadcast'
+    ]
+
+    available_endpoints.each do |available_endpoint|
+      uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + available_endpoint
+      stub_request(:post, uri_template).with do |request|
+        expect(request.headers['X-Line-Retry-Key']).to eq '123e4567-e89b-12d3-a456-426614174000'
+      end.to_return(body: '{}', status: 200)
+    end
+
+    user_id = "user1"
+    message = {
+      type: "text",
+      text: "Hello, world"
+    }
+
+    client.push_message(user_id, message, headers: {'X-Line-Retry-Key' => '123e4567-e89b-12d3-a456-426614174000'})
+    client.multicast(user_id, message, headers: {'X-Line-Retry-Key' => '123e4567-e89b-12d3-a456-426614174000'})
+    client.narrowcast(message, headers: {'X-Line-Retry-Key' => '123e4567-e89b-12d3-a456-426614174000'})
+    client.broadcast(message, headers: {'X-Line-Retry-Key' => '123e4567-e89b-12d3-a456-426614174000'})
+  end
 end