Merge pull request #245 from yskkin/additional_request_body

additional request body for push_message and multicast

Author: kimoto

lib/line/bot/client.rb

@@ -166,14 +166,15 @@ def get_channel_access_token_key_ids_jwt(jwt)
       # @param user_id [String] User Id
       # @param messages [Hash or Array] Message Objects
       # @param headers [Hash] HTTP Headers
+      # @param payload [Hash] Additional request body
       # @return [Net::HTTPResponse]
-      def push_message(user_id, messages, headers: {})
+      def push_message(user_id, messages, headers: {}, payload: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/push'
-        payload = { to: user_id, messages: messages }.to_json
+        payload = payload.merge({ to: user_id, messages: messages }).to_json
         post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
@@ -212,15 +213,16 @@ 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
+      # @param payload [Hash] Additional request body
       # @return [Net::HTTPResponse]
-      def multicast(to, messages, headers: {})
+      def multicast(to, messages, headers: {}, payload: {})
         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
+        payload = payload.merge({ to: to, messages: messages }).to_json
         post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 

spec/line/bot/send_message_01_text_spec.rb

@@ -27,6 +27,31 @@
     expect(response.body).to eq(expected)
   end
 
+  it 'push the text message with additional payload' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/push'
+    stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
+
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = 'channel_token'
+    end
+
+    user_id = 'user_id'
+    message = {
+      type: 'text',
+      text: 'Hello, world'
+    }
+    response = client.push_message(user_id, message, payload: {customAggregationUnits: ['test']})
+
+    expected = {
+      customAggregationUnits: ['test'],
+      to: user_id,
+      messages: [
+        message
+      ]
+    }.to_json
+    expect(response.body).to eq(expected)
+  end
+
   it 'replies the text message' do
     uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/reply'
     stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
@@ -75,6 +100,31 @@
     expect(response.body).to eq(expected)
   end
 
+  it 'multicasts the text message with additional payload' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/multicast'
+    stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
+
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = 'channel_token'
+    end
+
+    user_ids = ['user1', 'user2']
+    message = {
+      type: 'text',
+      text: 'Hello, world'
+    }
+    response = client.multicast(user_ids, message, payload: {customAggregationUnits: ['test']})
+
+    expected = {
+      customAggregationUnits: ['test'],
+      to: user_ids,
+      messages: [
+        message
+      ],
+    }.to_json
+    expect(response.body).to eq(expected)
+  end
+
   it 'broadcasts the text message' do
     uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/broadcast'
     stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }

spec/line/bot/send_message_02_image_spec.rb

@@ -28,6 +28,32 @@
     expect(response.body).to eq(expected)
   end
 
+  it 'pushes the image message with additional payload' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/push'
+    stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
+
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = 'channel_token'
+    end
+
+    user_id = 'user_id'
+    message = {
+      type: 'image',
+      originalContentUrl: 'https://example.com/image.jpg',
+      previewImageUrl: 'https://example.com/image_preview.jpg',
+    }
+    response = client.push_message(user_id, message, payload: {'customAggregationUnits' => ['test']})
+
+    expected = {
+      customAggregationUnits: ['test'],
+      to: user_id,
+      messages: [
+        message
+      ]
+    }.to_json
+    expect(response.body).to eq(expected)
+  end
+
   it 'replies the image message' do
     uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/reply'
     stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
@@ -77,4 +103,30 @@
     }.to_json
     expect(response.body).to eq(expected)
   end
+
+  it 'multicasts the image message with additional payload' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/multicast'
+    stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
+
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = 'channel_token'
+    end
+
+    user_ids = ['user1', 'user2']
+    message = {
+      type: 'image',
+      originalContentUrl: 'https://example.com/image.jpg',
+      previewImageUrl: 'https://example.com/image_preview.jpg',
+    }
+    response = client.multicast(user_ids, message, payload: {'customAggregationUnits' => ['test']})
+
+    expected = {
+      customAggregationUnits: ['test'],
+      to: user_ids,
+      messages: [
+        message
+      ]
+    }.to_json
+    expect(response.body).to eq(expected)
+  end
 end

spec/line/bot/send_message_03_video_spec.rb

@@ -28,6 +28,32 @@
     expect(response.body).to eq(expected)
   end
 
+  it 'pushes the video message with additional payload' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/push'
+    stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
+
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = 'channel_token'
+    end
+
+    user_id = 'user_id'
+    message = {
+      type: 'video',
+      originalContentUrl: 'https://example.com/video.mp4',
+      previewImageUrl: 'https://example.com/video_preview.jpg',
+    }
+    response = client.push_message(user_id, message, payload: {'customAggregationUnits' => ['test']})
+
+    expected = {
+      customAggregationUnits: ['test'],
+      to: user_id,
+      messages: [
+        message
+      ]
+    }.to_json
+    expect(response.body).to eq(expected)
+  end
+
   it 'replies the video message' do
     uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/reply'
     stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
@@ -77,4 +103,30 @@
     }.to_json
     expect(response.body).to eq(expected)
   end
+
+  it 'multicasts the video message' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/multicast'
+    stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
+
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = 'channel_token'
+    end
+
+    user_ids = ['user1', 'user2']
+    message = {
+      type: 'video',
+      originalContentUrl: 'https://example.com/video.mp4',
+      previewImageUrl: 'https://example.com/video_preview.jpg',
+    }
+    response = client.multicast(user_ids, message, payload: {'customAggregationUnits' => ['test']})
+
+    expected = {
+      customAggregationUnits: ['test'],
+      to: user_ids,
+      messages: [
+        message
+      ]
+    }.to_json
+    expect(response.body).to eq(expected)
+  end
 end

spec/line/bot/send_message_04_audio_spec.rb

@@ -28,6 +28,32 @@
     expect(response.body).to eq(expected)
   end
 
+  it 'pushes the audio message with additional payload' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/push'
+    stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
+
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = 'channel_token'
+    end
+
+    user_id = 'user_id'
+    message = {
+      type: 'audio',
+      originalContentUrl: 'https://example.com/audio.mp3',
+      duration: 120000
+    }
+    response = client.push_message(user_id, message, payload: {'customAggregationUnits' => ['test']})
+
+    expected = {
+      customAggregationUnits: ['test'],
+      to: user_id,
+      messages: [
+        message
+      ]
+    }.to_json
+    expect(response.body).to eq(expected)
+  end
+
   it 'replies the audio message' do
     uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/reply'
     stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
@@ -77,4 +103,30 @@
     }.to_json
     expect(response.body).to eq(expected)
   end
+
+  it 'multicasts the audio message with additional payload' do
+    uri_template = Addressable::Template.new Line::Bot::API::DEFAULT_ENDPOINT + '/bot/message/multicast'
+    stub_request(:post, uri_template).to_return { |request| {body: request.body, status: 200} }
+
+    client = Line::Bot::Client.new do |config|
+      config.channel_token = 'channel_token'
+    end
+
+    user_ids = ['user1', 'user2']
+    message = {
+      type: 'audio',
+      originalContentUrl: 'https://example.com/audio.mp3',
+      duration: 120000
+    }
+    response = client.multicast(user_ids, message, payload: {'customAggregationUnits' => ['test']})
+
+    expected = {
+      customAggregationUnits: ['test'],
+      to: user_ids,
+      messages: [
+        message
+      ]
+    }.to_json
+    expect(response.body).to eq(expected)
+  end
 end