line-bot-api 1.12.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec352e50cd2b13df2d2c4d0f14ae9f6d3346c33358f343ae43448a1d489a3203
-  data.tar.gz: 26e0c32ab9671267628fe4749ae039558409a4087f991869e310e293276ff386
+  metadata.gz: a645b77594506a826cd1009e65bed3f4af60674579d3d23403ca32136cd697f7
+  data.tar.gz: cdeee7ee13ce1c099342573e4514b57e49cb08dd1f8835a609a22c9f8810a52d
 SHA512:
-  metadata.gz: 1b924857b1fa6732824b648aebc131885e1638aba7e4f28beb281e1c402b74260727c9a1700ed8174fc6f312bad38eeef6e5bcf4be6bdd908f6a2e0d04df8f26
-  data.tar.gz: e513999b3e4d52985efd98fcdcca98bbd45c48602f28911d49518a341b5ceeeee0ed8e1326d862f1ee51c1bfb93a51860b938cfec5b059277ca6a6da7e7d0a65
+  metadata.gz: f83a596fc0a844e0d4e237e197e00c8afba3c7cfc39f136897b78645cac659b87cd3103c701227ccaeffdac692af2f9a89e9250b3cc3d97c9c460078ae629c42
+  data.tar.gz: 26f4b4ba5a7b23afb4da95bdbf3a3d4b5dd5e31e7ebfe919046944fae1ceed5c3c66e011fe3609bce511ad2523bd2721a78f30afc1a9e3021ac710723b5426ae

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:

data/lib/line/bot/api.rb

@@ -18,10 +18,11 @@ 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/#{Line::Bot::API::VERSION}"
+        'User-Agent'   => "LINE-BotSDK-Ruby/#{VERSION}"
       }.freeze
     end
   end

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

@@ -15,7 +15,7 @@
 module Line
   module Bot
     module API
-      VERSION = "1.12.0"
+      VERSION = "1.16.0"
     end
   end
 end

data/lib/line/bot/client.rb

@@ -19,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
@@ -29,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|
@@ -42,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]
@@ -72,7 +89,7 @@ module Line
           client_secret: channel_secret
         )
         headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
-        post(endpoint_path, payload, headers)
+        post(endpoint, endpoint_path, payload, headers)
       end
 
       # Revoke channel access token
@@ -82,30 +99,44 @@ module Line
         endpoint_path = '/oauth/revoke'
         payload = URI.encode_www_form(access_token: access_token)
         headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
-        post(endpoint_path, payload, headers)
+        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)
 
         endpoint_path = '/bot/message/push'
         payload = { to: user_id, messages: messages }.to_json
-        post(endpoint_path, payload, credentials)
+        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
@@ -114,16 +145,16 @@ module Line
 
         endpoint_path = '/bot/message/reply'
         payload = { replyToken: token, messages: messages }.to_json
-        post(endpoint_path, payload, credentials)
+        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)
@@ -131,86 +162,112 @@ module Line
 
         endpoint_path = '/bot/message/multicast'
         payload = { to: to, messages: messages }.to_json
-        post(endpoint_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
-      # Broadcast messages to users
+      # Send messages to all friends.
       #
-      # @param messages [Hash or Array]
+      # @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_path, payload, credentials)
+        post(endpoint, endpoint_path, payload, credentials.merge(headers))
+      end
+
+      # 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 narrowcast(messages, recipient: nil, filter: nil, limit: nil, headers: {})
+        channel_token_required
+
+        messages = [messages] if messages.is_a?(Hash)
+
+        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
 
         endpoint_path = "/bot/group/#{group_id}/leave"
-        post(endpoint_path, nil, credentials)
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       def leave_room(room_id)
         channel_token_required
 
         endpoint_path = "/bot/room/#{room_id}/leave"
-        post(endpoint_path, nil, credentials)
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       # Get message content.
       #
       # @param identifier [String] Message's identifier
-      #
       # @return [Net::HTTPResponse]
       def get_message_content(identifier)
         channel_token_required
 
         endpoint_path = "/bot/message/#{identifier}/content"
-        get(endpoint_path, credentials)
+        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)
         channel_token_required
 
         endpoint_path = "/bot/profile/#{user_id}"
-        get(endpoint_path, credentials)
+        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, credentials)
+        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, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get user IDs of a group
@@ -225,12 +282,12 @@ module Line
 
         endpoint_path = "/bot/group/#{group_id}/members/ids"
         endpoint_path += "?start=#{continuation_token}" if continuation_token
-        get(endpoint_path, credentials)
+        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)
       #
@@ -240,7 +297,43 @@ module Line
 
         endpoint_path = "/bot/room/#{room_id}/members/ids"
         endpoint_path += "?start=#{continuation_token}" if continuation_token
-        get(endpoint_path, credentials)
+        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
@@ -250,7 +343,7 @@ module Line
         channel_token_required
 
         endpoint_path = '/bot/richmenu/list'
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get a rich menu via a rich menu ID
@@ -262,7 +355,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/richmenu/#{rich_menu_id}"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Gets the number of messages sent with the /bot/message/reply endpoint.
@@ -274,7 +367,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/message/delivery/reply?date=#{date}"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Gets the number of messages sent with the /bot/message/push endpoint.
@@ -286,7 +379,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/message/delivery/push?date=#{date}"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Gets the number of messages sent with the /bot/message/multicast endpoint.
@@ -298,7 +391,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/message/delivery/multicast?date=#{date}"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Gets the number of messages sent with the /bot/message/multicast endpoint.
@@ -310,7 +403,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/message/delivery/broadcast?date=#{date}"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Create a rich menu
@@ -322,7 +415,7 @@ module Line
         channel_token_required
 
         endpoint_path = '/bot/richmenu'
-        post(endpoint_path, rich_menu.to_json, credentials)
+        post(endpoint, endpoint_path, rich_menu.to_json, credentials)
       end
 
       # Delete a rich menu
@@ -334,7 +427,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/richmenu/#{rich_menu_id}"
-        delete(endpoint_path, credentials)
+        delete(endpoint, endpoint_path, credentials)
       end
 
       # Get the ID of the rich menu linked to a user
@@ -346,7 +439,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/user/#{user_id}/richmenu"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get default rich menu
@@ -356,7 +449,7 @@ module Line
         channel_token_required
 
         endpoint_path = '/bot/user/all/richmenu'
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Set default rich menu (Link a rich menu to all user)
@@ -368,7 +461,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/user/all/richmenu/#{rich_menu_id}"
-        post(endpoint_path, nil, credentials)
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       # Unset default rich menu (Unlink a rich menu from all user)
@@ -378,11 +471,14 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/user/all/richmenu"
-        delete(endpoint_path, credentials)
+        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
       #
@@ -391,7 +487,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/user/#{user_id}/richmenu/#{rich_menu_id}"
-        post(endpoint_path, nil, credentials)
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       # Unlink a rich menu from a user
@@ -403,7 +499,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/user/#{user_id}/richmenu"
-        delete(endpoint_path, credentials)
+        delete(endpoint, endpoint_path, credentials)
       end
 
       # To link a rich menu to multiple users at a time
@@ -416,7 +512,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/richmenu/bulk/link"
-        post(endpoint_path, { richMenuId: rich_menu_id, userIds: user_ids }.to_json, credentials)
+        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
@@ -428,7 +524,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/richmenu/bulk/unlink"
-        post(endpoint_path, { userIds: user_ids }.to_json, credentials)
+        post(endpoint, endpoint_path, { userIds: user_ids }.to_json, credentials)
       end
 
       # Download an image associated with a rich menu
@@ -440,7 +536,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/richmenu/#{rich_menu_id}/content"
-        get(endpoint_path, credentials)
+        get(blob_endpoint, endpoint_path, credentials)
       end
 
       # Upload and attaches an image to a rich menu
@@ -452,16 +548,9 @@ module Line
       def create_rich_menu_image(rich_menu_id, file)
         channel_token_required
 
-        content_type = 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
-
         endpoint_path = "/bot/richmenu/#{rich_menu_id}/content"
-        headers = credentials.merge('Content-Type' => content_type)
-        post(endpoint_path, file.rewind && file.read, headers)
+        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
@@ -473,7 +562,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/user/#{user_id}/linkToken"
-        post(endpoint_path, nil, credentials)
+        post(endpoint, endpoint_path, nil, credentials)
       end
 
       # Get the target limit for additional messages
@@ -483,7 +572,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/message/quota"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Get number of messages sent this month
@@ -493,7 +582,7 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/message/quota/consumption"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Returns the number of messages sent on a specified day
@@ -505,7 +594,19 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/insight/message/delivery?date=#{date}"
-        get(endpoint_path, credentials)
+        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
+
+        endpoint_path = "/bot/insight/message/event?requestId=#{request_id}"
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Returns the number of followers
@@ -517,51 +618,54 @@ module Line
         channel_token_required
 
         endpoint_path = "/bot/insight/followers?date=#{date}"
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
-      # Retrieves the demographic attributes for a bot's friends.
+      # Get the demographic attributes for a bot's friends.
       #
       # @return [Net::HTTPResponse]
       def get_friend_demographics
         channel_token_required
 
         endpoint_path = '/bot/insight/demographic'
-        get(endpoint_path, credentials)
+        get(endpoint, endpoint_path, credentials)
       end
 
       # Fetch data, get content of specified URL.
       #
+      # @param endpoint_base [String]
       # @param endpoint_path [String]
       # @param headers [Hash]
       #
       # @return [Net::HTTPResponse]
-      def get(endpoint_path, headers = {})
-        headers = Line::Bot::API::DEFAULT_HEADERS.merge(headers)
-        httpclient.get(endpoint + endpoint_path, headers)
+      def get(endpoint_base, endpoint_path, headers = {})
+        headers = API::DEFAULT_HEADERS.merge(headers)
+        httpclient.get(endpoint_base + endpoint_path, headers)
       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_path, payload = nil, headers = {})
-        headers = Line::Bot::API::DEFAULT_HEADERS.merge(headers)
-        httpclient.post(endpoint + endpoint_path, payload, headers)
+      def post(endpoint_base, endpoint_path, payload = nil, headers = {})
+        headers = API::DEFAULT_HEADERS.merge(headers)
+        httpclient.post(endpoint_base + endpoint_path, payload, headers)
       end
 
       # Delete content of specified URL.
       #
+      # @param endpoint_base [String]
       # @param endpoint_path [String]
       # @param headers [Hash]
       #
       # @return [Net::HTTPResponse]
-      def delete(endpoint_path, headers = {})
-        headers = Line::Bot::API::DEFAULT_HEADERS.merge(headers)
-        httpclient.delete(endpoint + endpoint_path, headers)
+      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
@@ -574,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
@@ -619,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.rb

@@ -21,6 +21,8 @@ require 'line/bot/event/leave'
 require 'line/bot/event/message'
 require 'line/bot/event/postback'
 require 'line/bot/event/unfollow'
+require 'line/bot/event/unsend'
 require 'line/bot/event/member_joined'
 require 'line/bot/event/member_left'
 require 'line/bot/event/things'
+require 'line/bot/event/video_play_complete'

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

@@ -22,11 +22,16 @@ module Line
         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/event/unsend.rb

@@ -0,0 +1,27 @@
+# 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.
+
+module Line
+  module Bot
+    module Event
+      # Event object for when the user unsends a message in a group or room.
+      #
+      # No replyToken is generated for this event.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#unsend-event
+      class Unsend < Base
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# 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.
+
+module Line
+  module Bot
+    module Event
+      # Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account.
+      #
+      # https://developers.line.biz/en/reference/messaging-api/#video-viewing-complete
+      class VideoPlayComplete < Base
+      end
+    end
+  end
+end

data/lib/line/bot/httpclient.rb

@@ -19,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.12.0
+  version: 1.16.0
 platform: ruby
 authors:
 - LINE Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2020-08-13 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
@@ -97,6 +97,8 @@ files:
 - lib/line/bot/event/postback.rb
 - lib/line/bot/event/things.rb
 - lib/line/bot/event/unfollow.rb
+- lib/line/bot/event/unsend.rb
+- lib/line/bot/event/video_play_complete.rb
 - lib/line/bot/httpclient.rb
 - lib/line/bot/util.rb
 - line-bot-api.gemspec
@@ -119,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: SDK of the LINE Messaging API