line-bot-api 1.11.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 191b846d917a61448e7e38976390aeb56846229ccdc2a69c404d0ca04a3bcb89
-  data.tar.gz: 595b93123023a3c9060190969657ca06d2bc7472281bcfe43ee1ef7b4c95324a
+  metadata.gz: a1352650b47d2d00a2d08061982b02c3489594f710c064bc06aebea8fc1bc4da
+  data.tar.gz: 3f74b50c38d6765d66800cfcf4558146bbb0dbce9225b4ecf5c4a81a686bd6d3
 SHA512:
-  metadata.gz: '094bbf24cc58e2b444a410b02052d15bcd545ad77e62a4cf8765d5a6d8e5e4011ff735196bffd3d95d2ab77e6cdb70a17240dfe524f71380d2633b5efea5455b'
-  data.tar.gz: f54a7e01bd1b28f28eac6e299e739a8d59d390056acac28fb7d5a957f56e2f28fa71a26a3e07a7bed212c605af735486e2213465aa417025e18aafe6d95c05d7
+  metadata.gz: 3de07c49edb984b2d362369c2e900b2c9d4dfd5b6399e9367cf6e14d46b4b343f07ef775aa785cc71d57db4af26eb22b27fcb0fe43c1ad160384011a9cd12c37
+  data.tar.gz: 31f1423914851cfbb501d24bb9f2ae6d6112880f1de5106649dc5eb1a6591a178afbc88a7c6a2cb5639594e2e954bad1a798fbb3fb957144e5fa6272a18d912a

data/README.md

@@ -13,6 +13,10 @@ See the official API documentation for more information
 - English: https://developers.line.biz/en/docs/messaging-api/overview/
 - Japanese: https://developers.line.biz/ja/docs/messaging-api/overview/
 
+Also, generated documentation by YARD is available.
+
+- https://rubydoc.info/gems/line-bot-api
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -77,6 +81,7 @@ post '/callback' do
     end
   end
 
+  # Don't forget to return a successful response
   "OK"
 end
 ```
@@ -96,7 +101,7 @@ This project respects semantic versioning.
 See https://semver.org/
 
 ## Contributing
-Please check [CONTRIBUTING](contributing.md) before making a contribution.
+Please check [CONTRIBUTING](CONTRIBUTING.md) before making a contribution.
 
 ## License
 ```

data/lib/line/bot.rb

@@ -17,6 +17,5 @@ require 'line/bot/client'
 require 'line/bot/event'
 require 'line/bot/api/errors'
 require 'line/bot/api'
-require 'line/bot/request'
 require 'line/bot/httpclient'
 require 'line/bot/api/version'

data/lib/line/bot/api.rb

@@ -12,10 +12,18 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+require 'line/bot/api/version'
+
 module Line
   module Bot
     module API
       DEFAULT_ENDPOINT = "https://api.line.me/v2"
+      DEFAULT_BLOB_ENDPOINT = "https://api-data.line.me/v2"
+
+      DEFAULT_HEADERS = {
+        'Content-Type' => 'application/json; charset=UTF-8',
+        'User-Agent'   => "LINE-BotSDK-Ruby/#{VERSION}"
+      }.freeze
     end
   end
 end

data/lib/line/bot/api/version.rb

@@ -15,7 +15,7 @@
 module Line
   module Bot
     module API
-      VERSION = "1.11.0"
+      VERSION = "1.15.0"
     end
   end
 end

data/lib/line/bot/client.rb

@@ -12,7 +12,6 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-require 'line/bot/request'
 require 'base64'
 require 'net/http'
 require 'openssl'
@@ -20,9 +19,16 @@ require 'uri'
 
 module Line
   module Bot
+    # API Client of LINE Bot SDK Ruby
+    #
+    #   @client ||= Line::Bot::Client.new do |config|
+    #     config.channel_id = ENV["LINE_CHANNEL_ID"]
+    #     config.channel_secret = ENV["LINE_CHANNEL_SECRET"]
+    #     config.channel_token = ENV["LINE_CHANNEL_TOKEN"]
+    #   end
     class Client
       #  @return [String]
-      attr_accessor :channel_token, :channel_id, :channel_secret, :endpoint
+      attr_accessor :channel_token, :channel_id, :channel_secret, :endpoint, :blob_endpoint
 
       # @return [Object]
       attr_accessor :httpclient
@@ -30,10 +36,9 @@ module Line
       # @return [Hash]
       attr_accessor :http_options
 
-      # Initialize a new Bot Client.
+      # Initialize a new client.
       #
       # @param options [Hash]
-      #
       # @return [Line::Bot::Client]
       def initialize(options = {})
         options.each do |key, value|
@@ -43,11 +48,22 @@ module Line
       end
 
       def httpclient
-        @httpclient ||= Line::Bot::HTTPClient.new(http_options)
+        @httpclient ||= HTTPClient.new(http_options)
       end
 
       def endpoint
-        @endpoint ||= Line::Bot::API::DEFAULT_ENDPOINT
+        @endpoint ||= API::DEFAULT_ENDPOINT
+      end
+
+      def blob_endpoint
+        return @blob_endpoint if @blob_endpoint
+
+        @blob_endpoint = if endpoint == API::DEFAULT_ENDPOINT
+                           API::DEFAULT_BLOB_ENDPOINT
+                         else
+                           # for backward compatible
+                           endpoint
+                         end
       end
 
       # @return [Hash]
@@ -66,197 +82,192 @@ module Line
         channel_id_required
         channel_secret_required
 
+        endpoint_path = '/oauth/accessToken'
         payload = URI.encode_www_form(
           grant_type:    grant_type,
           client_id:     channel_id,
           client_secret: channel_secret
         )
-
-        request = Request.new do |config|
-          config.httpclient    = httpclient
-          config.endpoint      = endpoint
-          config.endpoint_path = '/oauth/accessToken'
-          config.content_type  = 'application/x-www-form-urlencoded'
-          config.payload       = payload
-        end
-
-        request.post
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        post(endpoint, endpoint_path, payload, headers)
       end
 
       # Revoke channel access token
       #
       # @return [Net::HTTPResponse]
       def revoke_channel_token(access_token)
+        endpoint_path = '/oauth/revoke'
         payload = URI.encode_www_form(access_token: access_token)
-
-        request = Request.new do |config|
-          config.httpclient    = httpclient
-          config.endpoint      = endpoint
-          config.endpoint_path = '/oauth/revoke'
-          config.content_type  = 'application/x-www-form-urlencoded'
-          config.payload       = payload
-        end
-
-        request.post
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        post(endpoint, endpoint_path, payload, headers)
       end
 
-      # Push messages to line server and to user.
-      #
-      # @param user_id [String] User's identifiers
-      # @param messages [Hash or Array]
+      # Push messages to a user using user_id.
       #
+      # @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)
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = '/bot/message/push'
-          config.credentials    = credentials
-          config.to             = user_id
-          config.messages       = messages
-        end
-
-        request.post
+        endpoint_path = '/bot/message/push'
+        payload = { to: user_id, messages: messages }.to_json
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
-      # Reply messages to line server and to users.
+      # Reply messages to a user using replyToken.
       #
-      # @param token [String]
-      # @param messages [Hash or Array]
+      # @example Send a balloon to a user.
+      #   message = {
+      #     type: 'text',
+      #     text: 'Hello, World!'
+      #   }
+      #   client.reply_message(event['replyToken'], message)
       #
+      # @example Send multiple balloons to a user.
+      #
+      #   messages = [
+      #    {type: 'text', text: 'Message1'},
+      #    {type: 'text', text: 'Message2'}
+      #   ]
+      #   client.reply_message(event['replyToken'], messages)
+      #
+      # @param token [String] Reply Token
+      # @param messages [Hash or Array] Message Objects
       # @return [Net::HTTPResponse]
       def reply_message(token, messages)
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = '/bot/message/reply'
-          config.credentials    = credentials
-          config.reply_token    = token
-          config.messages       = messages
-        end
-
-        request.post
+        endpoint_path = '/bot/message/reply'
+        payload = { replyToken: token, messages: messages }.to_json
+        post(endpoint, endpoint_path, payload, credentials)
       end
 
-      # Multicast messages to line server and to users.
-      #
-      # @param to [Array or String]
-      # @param messages [Hash or Array]
+      # Send messages to multiple users using userIds.
       #
+      # @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)
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = '/bot/message/multicast'
-          config.credentials    = credentials
-          config.to             = to
-          config.messages       = messages
-        end
+        endpoint_path = '/bot/message/multicast'
+        payload = { to: to, messages: messages }.to_json
+        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, headers: {})
+        channel_token_required
+
+        messages = [messages] if messages.is_a?(Hash)
 
-        request.post
+        endpoint_path = '/bot/message/broadcast'
+        payload = { messages: messages }.to_json
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
-      # Broadcast messages to users
+      # Narrowcast messages to users
+      #
+      # API Documentation is here.
+      # https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message
       #
       # @param messages [Hash or Array]
+      # @param recipient [Hash]
+      # @param filter [Hash]
+      # @param limit [Hash]
+      # @param headers [Hash] HTTP Headers
       #
       # @return [Net::HTTPResponse]
-      def broadcast(messages)
+      def narrowcast(messages, recipient: nil, filter: nil, limit: nil, headers: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = '/bot/message/broadcast'
-          config.credentials    = credentials
-          config.messages       = messages
-        end
-
-        request.post
+        endpoint_path = '/bot/message/narrowcast'
+        payload = {
+          messages: messages,
+          recipient: recipient,
+          filter: filter,
+          limit: limit
+        }.to_json
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
       def leave_group(group_id)
         channel_token_required
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = "/bot/group/#{group_id}/leave"
-          config.credentials    = credentials
-        end
-
-        request.post
+        endpoint_path = "/bot/group/#{group_id}/leave"
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       def leave_room(room_id)
         channel_token_required
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = "/bot/room/#{room_id}/leave"
-          config.credentials    = credentials
-        end
-
-        request.post
+        endpoint_path = "/bot/room/#{room_id}/leave"
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       # Get message content.
       #
       # @param identifier [String] Message's identifier
-      #
       # @return [Net::HTTPResponse]
       def get_message_content(identifier)
-        endpoint_path  = "/bot/message/#{identifier}/content"
-        get(endpoint_path)
+        channel_token_required
+
+        endpoint_path = "/bot/message/#{identifier}/content"
+        get(blob_endpoint, endpoint_path, credentials)
       end
 
       # Get an user's profile.
       #
-      # @param user_id [String] User's identifier
-      #
+      # @param user_id [String] User Id user_id
       # @return [Net::HTTPResponse]
       def get_profile(user_id)
-        endpoint_path  = "/bot/profile/#{user_id}"
-        get(endpoint_path)
+        channel_token_required
+
+        endpoint_path = "/bot/profile/#{user_id}"
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get an user's profile of a group.
       #
       # @param group_id [String] Group's identifier
-      # @param user_id [String] User's identifier
+      # @param user_id [String] User Id user_id
       #
       # @return [Net::HTTPResponse]
       def get_group_member_profile(group_id, user_id)
+        channel_token_required
+
         endpoint_path = "/bot/group/#{group_id}/member/#{user_id}"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get an user's profile of a room.
       #
       # @param room_id [String] Room's identifier
-      # @param user_id [String] User's identifier
+      # @param user_id [String] User Id user_id
       #
       # @return [Net::HTTPResponse]
       def get_room_member_profile(room_id, user_id)
+        channel_token_required
+
         endpoint_path = "/bot/room/#{room_id}/member/#{user_id}"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get user IDs of a group
@@ -267,30 +278,72 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get_group_member_ids(group_id, continuation_token = nil)
-        endpoint_path  = "/bot/group/#{group_id}/members/ids"
+        channel_token_required
+
+        endpoint_path = "/bot/group/#{group_id}/members/ids"
         endpoint_path += "?start=#{continuation_token}" if continuation_token
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get user IDs of a room
       #
-      # @param group_id [String] Room's identifier
+      # @param room_id [String] Room's identifier
       # @param continuation_token [String] Identifier to return next page
       #                                   (next property to be included in the response)
       #
       # @return [Net::HTTPResponse]
       def get_room_member_ids(room_id, continuation_token = nil)
-        endpoint_path  = "/bot/room/#{room_id}/members/ids"
+        channel_token_required
+
+        endpoint_path = "/bot/room/#{room_id}/members/ids"
         endpoint_path += "?start=#{continuation_token}" if continuation_token
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Gets the group ID, group name, and group icon URL of a group where the LINE Official Account is a member.
+      #
+      # @param group_id [String] Group's identifier
+      #
+      # @return [Net::HTTPResponse]
+      def get_group_summary(group_id)
+        channel_token_required
+
+        endpoint_path = "/bot/group/#{group_id}/summary"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Gets the user IDs of the members of a group that the bot is in.
+      #
+      # @param group_id [String] Group's identifier
+      #
+      # @return [Net::HTTPResponse]
+      def get_group_members_count(group_id)
+        channel_token_required
+
+        endpoint_path = "/bot/group/#{group_id}/members/count"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Gets the count of members in a room.
+      #
+      # @param room_id [String] Room's identifier
+      #
+      # @return [Net::HTTPResponse]
+      def get_room_members_count(room_id)
+        channel_token_required
+
+        endpoint_path = "/bot/room/#{room_id}/members/count"
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get a list of all uploaded rich menus
       #
       # @return [Net::HTTPResponse]
       def get_rich_menus
+        channel_token_required
+
         endpoint_path = '/bot/richmenu/list'
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get a rich menu via a rich menu ID
@@ -299,8 +352,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get_rich_menu(rich_menu_id)
+        channel_token_required
+
         endpoint_path = "/bot/richmenu/#{rich_menu_id}"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Gets the number of messages sent with the /bot/message/reply endpoint.
@@ -309,8 +364,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get_message_delivery_reply(date)
+        channel_token_required
+
         endpoint_path = "/bot/message/delivery/reply?date=#{date}"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Gets the number of messages sent with the /bot/message/push endpoint.
@@ -319,8 +376,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get_message_delivery_push(date)
+        channel_token_required
+
         endpoint_path = "/bot/message/delivery/push?date=#{date}"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Gets the number of messages sent with the /bot/message/multicast endpoint.
@@ -329,8 +388,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get_message_delivery_multicast(date)
+        channel_token_required
+
         endpoint_path = "/bot/message/delivery/multicast?date=#{date}"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Gets the number of messages sent with the /bot/message/multicast endpoint.
@@ -339,8 +400,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get_message_delivery_broadcast(date)
+        channel_token_required
+
         endpoint_path = "/bot/message/delivery/broadcast?date=#{date}"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Create a rich menu
@@ -349,15 +412,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def create_rich_menu(rich_menu)
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = '/bot/richmenu'
-          config.credentials    = credentials
-          config.payload        = rich_menu.to_json
-        end
+        channel_token_required
 
-        request.post
+        endpoint_path = '/bot/richmenu'
+        post(endpoint, endpoint_path, rich_menu.to_json, credentials)
       end
 
       # Delete a rich menu
@@ -366,8 +424,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def delete_rich_menu(rich_menu_id)
+        channel_token_required
+
         endpoint_path = "/bot/richmenu/#{rich_menu_id}"
-        delete(endpoint_path)
+        delete(endpoint, endpoint_path, credentials)
       end
 
       # Get the ID of the rich menu linked to a user
@@ -376,16 +436,20 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get_user_rich_menu(user_id)
+        channel_token_required
+
         endpoint_path = "/bot/user/#{user_id}/richmenu"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get default rich menu
       #
       # @return [Net::HTTPResponse]
       def get_default_rich_menu
+        channel_token_required
+
         endpoint_path = '/bot/user/all/richmenu'
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Set default rich menu (Link a rich menu to all user)
@@ -394,33 +458,36 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def set_default_rich_menu(rich_menu_id)
+        channel_token_required
+
         endpoint_path = "/bot/user/all/richmenu/#{rich_menu_id}"
-        post(endpoint_path)
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       # Unset default rich menu (Unlink a rich menu from all user)
       #
       # @return [Net::HTTPResponse]
       def unset_default_rich_menu
+        channel_token_required
+
         endpoint_path = "/bot/user/all/richmenu"
-        delete(endpoint_path)
+        delete(endpoint, endpoint_path, credentials)
       end
 
       # Link a rich menu to a user
       #
+      # If you want to link a rich menu to multiple users,
+      # please consider to use bulk_link_rich_menus.
+      #
       # @param user_id [String] ID of the user
       # @param rich_menu_id [String] ID of an uploaded rich menu
       #
       # @return [Net::HTTPResponse]
       def link_user_rich_menu(user_id, rich_menu_id)
-        request = Request.new do |config|
-          config.httpclient = httpclient
-          config.endpoint = endpoint
-          config.endpoint_path = "/bot/user/#{user_id}/richmenu/#{rich_menu_id}"
-          config.credentials = credentials
-        end
+        channel_token_required
 
-        request.post
+        endpoint_path = "/bot/user/#{user_id}/richmenu/#{rich_menu_id}"
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       # Unlink a rich menu from a user
@@ -429,8 +496,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def unlink_user_rich_menu(user_id)
-        endpoint_path  = "/bot/user/#{user_id}/richmenu"
-        delete(endpoint_path)
+        channel_token_required
+
+        endpoint_path = "/bot/user/#{user_id}/richmenu"
+        delete(endpoint, endpoint_path, credentials)
       end
 
       # To link a rich menu to multiple users at a time
@@ -440,7 +509,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def bulk_link_rich_menus(user_ids, rich_menu_id)
-        post("/bot/richmenu/bulk/link", {richMenuId: rich_menu_id, userIds: user_ids}.to_json)
+        channel_token_required
+
+        endpoint_path = "/bot/richmenu/bulk/link"
+        post(endpoint, endpoint_path, { richMenuId: rich_menu_id, userIds: user_ids }.to_json, credentials)
       end
 
       # To unlink a rich menu from multiple users at a time
@@ -449,7 +521,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def bulk_unlink_rich_menus(user_ids)
-        post("/bot/richmenu/bulk/unlink", {userIds: user_ids}.to_json)
+        channel_token_required
+
+        endpoint_path = "/bot/richmenu/bulk/unlink"
+        post(endpoint, endpoint_path, { userIds: user_ids }.to_json, credentials)
       end
 
       # Download an image associated with a rich menu
@@ -458,8 +533,10 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get_rich_menu_image(rich_menu_id)
+        channel_token_required
+
         endpoint_path = "/bot/richmenu/#{rich_menu_id}/content"
-        get(endpoint_path)
+        get(blob_endpoint, endpoint_path, credentials)
       end
 
       # Upload and attaches an image to a rich menu
@@ -469,15 +546,11 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def create_rich_menu_image(rich_menu_id, file)
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = "/bot/richmenu/#{rich_menu_id}/content"
-          config.credentials = credentials
-          config.file = file
-        end
+        channel_token_required
 
-        request.post
+        endpoint_path = "/bot/richmenu/#{rich_menu_id}/content"
+        headers = credentials.merge('Content-Type' => content_type(file))
+        post(blob_endpoint, endpoint_path, file.rewind && file.read, headers)
       end
 
       # Issue a link token to a user
@@ -486,79 +559,113 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def create_link_token(user_id)
+        channel_token_required
+
         endpoint_path = "/bot/user/#{user_id}/linkToken"
-        post(endpoint_path)
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       # Get the target limit for additional messages
       #
       # @return [Net::HTTPResponse]
       def get_quota
+        channel_token_required
+
         endpoint_path = "/bot/message/quota"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get number of messages sent this month
       #
       # @return [Net::HTTPResponse]
       def get_quota_consumption
+        channel_token_required
+
         endpoint_path = "/bot/message/quota/consumption"
-        get(endpoint_path)
+        get(endpoint, endpoint_path, credentials)
       end
 
-      # Fetch data, get content of specified URL.
+      # Returns the number of messages sent on a specified day
       #
-      # @param endpoint_path [String]
+      # @param [String] date (Format:yyyyMMdd, Example:20191231)
       #
       # @return [Net::HTTPResponse]
-      def get(endpoint_path)
+      def get_number_of_message_deliveries(date)
         channel_token_required
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = endpoint_path
-          config.credentials    = credentials
-        end
+        endpoint_path = "/bot/insight/message/delivery?date=#{date}"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
+      #
+      # @param [String] request_id
+      #
+      # @return [Net::HTTPResponse]
+      def get_user_interaction_statistics(request_id)
+        channel_token_required
 
-        request.get
+        endpoint_path = "/bot/insight/message/event?requestId=#{request_id}"
+        get(endpoint, endpoint_path, credentials)
       end
 
-      # Post data, get content of specified URL.
+      # Returns the number of followers
       #
-      # @param endpoint_path [String]
+      # @param [String] date (Format:yyyyMMdd, Example:20191231)
       #
       # @return [Net::HTTPResponse]
-      def post(endpoint_path, payload = nil)
+      def get_number_of_followers(date)
         channel_token_required
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = endpoint_path
-          config.credentials    = credentials
-          config.payload        = payload if payload
-        end
+        endpoint_path = "/bot/insight/followers?date=#{date}"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get the demographic attributes for a bot's friends.
+      #
+      # @return [Net::HTTPResponse]
+      def get_friend_demographics
+        channel_token_required
 
-        request.post
+        endpoint_path = '/bot/insight/demographic'
+        get(endpoint, endpoint_path, credentials)
       end
 
-      # Delete content of specified URL.
+      # Fetch data, get content of specified URL.
       #
+      # @param endpoint_base [String]
       # @param endpoint_path [String]
+      # @param headers [Hash]
       #
       # @return [Net::HTTPResponse]
-      def delete(endpoint_path)
-        channel_token_required
+      def get(endpoint_base, endpoint_path, headers = {})
+        headers = API::DEFAULT_HEADERS.merge(headers)
+        httpclient.get(endpoint_base + endpoint_path, headers)
+      end
 
-        request = Request.new do |config|
-          config.httpclient     = httpclient
-          config.endpoint       = endpoint
-          config.endpoint_path  = endpoint_path
-          config.credentials    = credentials
-        end
+      # Post data, get content of specified URL.
+      #
+      # @param endpoint_base [String]
+      # @param endpoint_path [String]
+      # @param payload [String or NilClass]
+      # @param headers [Hash]
+      #
+      # @return [Net::HTTPResponse]
+      def post(endpoint_base, endpoint_path, payload = nil, headers = {})
+        headers = API::DEFAULT_HEADERS.merge(headers)
+        httpclient.post(endpoint_base + endpoint_path, payload, headers)
+      end
 
-        request.delete
+      # Delete content of specified URL.
+      #
+      # @param endpoint_base [String]
+      # @param endpoint_path [String]
+      # @param headers [Hash]
+      #
+      # @return [Net::HTTPResponse]
+      def delete(endpoint_base, endpoint_path, headers = {})
+        headers = API::DEFAULT_HEADERS.merge(headers)
+        httpclient.delete(endpoint_base + endpoint_path, headers)
       end
 
       # Parse events from request.body
@@ -571,15 +678,17 @@ module Line
 
         json['events'].map do |item|
           begin
-            klass = Line::Bot::Event.const_get(Line::Bot::Util.camelize(item['type']))
+            klass = Event.const_get(Util.camelize(item['type']))
             klass.new(item)
           rescue NameError
-            Line::Bot::Event::Base.new(item)
+            Event::Base.new(item)
           end
         end
       end
 
-      # Validate signature
+      # Validate signature of a webhook event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#signature-validation
       #
       # @param content [String] Request's body
       # @param channel_signature [String] Request'header 'X-LINE-Signature' # HTTP_X_LINE_SIGNATURE
@@ -616,6 +725,21 @@ module Line
         res == 0
       end
 
+      def content_type(file)
+        if file.respond_to?(:content_type)
+          content_type = file.content_type
+          raise ArgumentError, "invalid content type: #{content_type}" unless ['image/jpeg', 'image/png'].include?(content_type)
+          content_type
+        else
+          case file.path
+          when /\.jpe?g\z/i then 'image/jpeg'
+          when /\.png\z/i   then 'image/png'
+          else
+            raise ArgumentError, "invalid file extension: #{file.path}"
+          end
+        end
+      end
+
       def channel_token_required
         raise ArgumentError, '`channel_token` is not configured' unless channel_token
       end

data/lib/line/bot/event/account_link.rb

@@ -15,11 +15,16 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user has linked his/her LINE account with a provider's service account.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#account-link-event
       class AccountLink < Base
+        # @return [String]
         def result
           @src['link']['result']
         end
 
+        # @return [String]
         def nonce
           @src['link']['nonce']
         end

data/lib/line/bot/event/beacon.rb

@@ -15,15 +15,21 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user enters the range of a LINE Beacon.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#beacon-event
       class Beacon < Base
+        # @return [String]
         def type
           @src['beacon']['type']
         end
 
+        # @return [String]
         def hwid
           @src['beacon']['hwid']
         end
 
+        # @return [String]
         def deviceMessage
           [@src['beacon']['dm']].pack('H*')
         end

data/lib/line/bot/event/follow.rb

@@ -15,6 +15,10 @@
 module Line
   module Bot
     module Event
+      # Event object for when your LINE official account is added as a friend (or unblocked).
+      # You can reply to follow events.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#follow-event
       class Follow < Base
       end
     end

data/lib/line/bot/event/join.rb

@@ -15,6 +15,9 @@
 module Line
   module Bot
     module Event
+      # Event object for when your LINE official account joins a group or room.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#join-event
       class Join < Base
       end
     end

data/lib/line/bot/event/leave.rb

@@ -15,6 +15,11 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user removes your LINE official account from a group or when your LINE official account leaves a group or room.
+      #
+      # No replyToken is generated for this event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#leave-event
       class Leave < Base
       end
     end

data/lib/line/bot/event/member_joined.rb

@@ -15,6 +15,9 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user joins a group or room that the LINE official account is in.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#member-joined-event
       class MemberJoined < Base
       end
     end

data/lib/line/bot/event/member_left.rb

@@ -15,6 +15,11 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user leaves a group or room that the LINE official account is in.
+      #
+      # No replyToken is generated for this event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#member-left-event
       class MemberLeft < Base
       end
     end

data/lib/line/bot/event/message.rb

@@ -26,11 +26,14 @@ module Line
         Unsupport = 'unsupport'
       end
 
+      # Webhook event object which contains the sent message.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#message-event
       class Message < Base
         def type
-          Line::Bot::Event::MessageType.const_get(@src['message']['type'].capitalize)
+          MessageType.const_get(@src['message']['type'].capitalize)
         rescue NameError => e
-          Line::Bot::Event::MessageType::Unsupport
+          MessageType::Unsupport
         end
 
         def message

data/lib/line/bot/event/postback.rb

@@ -15,6 +15,9 @@
 module Line
   module Bot
     module Event
+      # Event object for when a user performs a postback action which initiates a postback.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#postback-event
       class Postback < Base
       end
     end

data/lib/line/bot/event/things.rb

@@ -18,14 +18,20 @@ module Line
       module ThingsType
         Link = 'link'
         Unlink = 'unlink'
+        ScenarioResult = 'scenarioResult'
         Unsupport = 'unsupport'
       end
 
+      # LINE Things API related events.
+      #
+      # * https://developers.line.biz/en/reference/messaging-api/#device-link-event
+      # * https://developers.line.biz/en/reference/messaging-api/#device-unlink-event
+      # * https://developers.line.biz/en/reference/messaging-api/#scenario-result-event
       class Things < Base
         def type
-          Line::Bot::Event::ThingsType.const_get(Line::Bot::Util.camelize(@src['things']['type']))
+          ThingsType.const_get(Util.camelize(@src['things']['type']))
         rescue NameError
-          Line::Bot::Event::ThingsType::Unsupport
+          ThingsType::Unsupport
         end
 
         def device_id

data/lib/line/bot/event/unfollow.rb

@@ -15,6 +15,11 @@
 module Line
   module Bot
     module Event
+      # Event object for when your LINE official account is blocked.
+      #
+      # No replyToken is generated for this event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#unfollow-event
       class Unfollow < Base
       end
     end

data/lib/line/bot/httpclient.rb

@@ -12,7 +12,6 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-require 'line/bot/api/version'
 require 'json'
 require 'net/http'
 require 'uri'
@@ -20,7 +19,7 @@ require 'uri'
 module Line
   module Bot
     class HTTPClient
-      #  @return [Hash]
+      # @return [Hash]
       attr_accessor :http_options
 
       # Initialize a new HTTPClient

data/line-bot-api.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "addressable", "~> 2.3"
   spec.add_development_dependency "bundler", "~> 1.11" if RUBY_VERSION < "2.3"
-  spec.add_development_dependency 'rake', "~> 10.4"
+  spec.add_development_dependency 'rake', "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 1.24"
+  spec.add_development_dependency "webmock", "~> 3.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.15.0
 platform: ruby
 authors:
 - LINE Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '3.8'
 description: Line::Bot::API - SDK of the LINE Messaging API for Ruby
 email:
 - kimoto@linecorp.com
@@ -98,7 +98,6 @@ files:
 - lib/line/bot/event/things.rb
 - lib/line/bot/event/unfollow.rb
 - lib/line/bot/httpclient.rb
-- lib/line/bot/request.rb
 - lib/line/bot/util.rb
 - line-bot-api.gemspec
 homepage: https://github.com/line/line-bot-sdk-ruby
@@ -120,7 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SDK of the LINE Messaging API

data/lib/line/bot/request.rb

@@ -1,117 +0,0 @@
-# Copyright 2016 LINE
-#
-# LINE Corporation licenses this file to you under the Apache License,
-# version 2.0 (the "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at:
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
-
-require 'line/bot/api/version'
-require 'json'
-require 'net/http'
-require 'uri'
-
-module Line
-  module Bot
-    class Request
-      attr_accessor :endpoint, :endpoint_path, :credentials, :to, :reply_token, :messages, :httpclient, :payload, :file
-
-      attr_writer :content_type
-
-      # Initializes a new Request
-      #
-      # @return [Line::Bot::Request]
-      def initialize
-        yield(self) if block_given?
-      end
-
-      # @return [String]
-      def payload
-        return file.seek(0) && file.read if file.is_a? File
-        return @payload if @payload.is_a? String
-        payload = {
-          to: to,
-          replyToken: reply_token,
-          messages: messages
-        }
-
-        payload.delete_if { |k, v| v.nil? }.to_json
-      end
-
-      # @return [Hash]
-      def header
-        header = {
-          'Content-Type' => content_type,
-          'User-Agent' => "LINE-BotSDK-Ruby/#{Line::Bot::API::VERSION}",
-        }
-        hash = (credentials || {}).inject({}) { |h, (k, v)| h[k] = v.to_s; h }
-
-        header.merge(hash)
-      end
-
-      # @return [String]
-      def content_type
-        return @content_type if @content_type
-
-        guess_content_type
-      end
-
-      # Get content of specified URL.
-      #
-      # @return [Net::HTTPResponse]
-      def get
-        assert_for_getting_message
-        httpclient.get(endpoint + endpoint_path, header)
-      end
-
-      # Post content of specified URL.
-      #
-      # @raise [ArgumentError]
-      #
-      # @return [Net::HTTPResponse]
-      def post
-        assert_for_posting_message
-        httpclient.post(endpoint + endpoint_path, payload, header)
-      end
-
-      def delete
-        assert_for_deleting_message
-        httpclient.delete(endpoint + endpoint_path, header)
-      end
-
-      def assert_for_getting_message
-        raise ArgumentError, 'Wrong argument type `endpoint_path`' unless endpoint_path.is_a?(String)
-      end
-
-      def assert_for_posting_message
-        raise ArgumentError, 'Wrong argument type `endpoint_path`' unless endpoint_path.is_a?(String)
-      end
-
-      def assert_for_deleting_message
-        raise ArgumentError, 'Wrong argument type `endpoint_path`' unless endpoint_path.is_a?(String)
-      end
-
-      private
-
-      # @return [String]
-      def guess_content_type
-        if file.is_a? File
-          case file.path
-          when /\.png\z/i then 'image/png'
-          when /\.jpe?g\z/i then 'image/jpeg'
-          else
-            raise ArgumentError.new("invalid file extension: #{file.path}")
-          end
-        else
-          'application/json; charset=UTF-8'
-        end
-      end
-    end
-  end
-end