line-bot-api 1.14.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc272a376d9eb4be79d9c92ee485737c6474f652c0873923010f5b25d1d78c1a
-  data.tar.gz: 4beb042559850867763cec2920ac0715877c2b2a7b5538c8a749bd226de2571e
+  metadata.gz: 23b8ceb7011bc2da255888239f7d9a26622ea7713f8fb6154c8aa4637c5c0be0
+  data.tar.gz: 885e68bbd4485d411f5e79e1bfc1aa2a29e9d6c07d64d91db22cd4387c0d334d
 SHA512:
-  metadata.gz: 6ca96d2225493a374bc23497b075a740ff95f469d4b2b832143083c96a1d4d319482ccb1c7b4a4f6bc0dbd93774bd49a6425c3dbc0a4d552b6afa6795125061e
-  data.tar.gz: 1809fa4bbadda5065d2f8ec1e8d4bc7fd266c1f0014623bd4606488ba6266cc8e4321fe498edf2aa63c8f6cab3bb397094d0c2aff12c37dad9c9bd5be5dfd439
+  metadata.gz: 1c0e0b1dec8a0a39167225065c44c58b19d662178cd68162c1f3c98cbf0350dfcec8dc73922506bb9a7251479380e21cbe62e3765f97fbf91200267f19aef340
+  data.tar.gz: 924774871d263700bc7e38dd0ab338e66009f573222e3bb49c7c97464d5da0017d7ec8a902f82c5713c1cfe9dedd9d8ba6e749e73ecdfc2282db833c41a66d5e

data/lib/line/bot/api.rb

@@ -19,10 +19,11 @@ module Line
     module API
       DEFAULT_ENDPOINT = "https://api.line.me/v2"
       DEFAULT_BLOB_ENDPOINT = "https://api-data.line.me/v2"
+      DEFAULT_LIFF_ENDPOINT = "https://api.line.me/liff/v1"
 
       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.14.0"
+      VERSION = "1.18.0"
     end
   end
 end

data/lib/line/bot/client.rb

@@ -48,24 +48,28 @@ 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 == Line::Bot::API::DEFAULT_ENDPOINT
-                           Line::Bot::API::DEFAULT_BLOB_ENDPOINT
+        @blob_endpoint = if endpoint == API::DEFAULT_ENDPOINT
+                           API::DEFAULT_BLOB_ENDPOINT
                          else
                            # for backward compatible
                            endpoint
                          end
       end
 
+      def liff_endpoint
+        @liff_endpoint ||= API::DEFAULT_LIFF_ENDPOINT
+      end
+
       # @return [Hash]
       def credentials
         {
@@ -106,15 +110,16 @@ module Line
       #
       # @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,8 +156,9 @@ module Line
       #
       # @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)
@@ -160,21 +166,23 @@ module Line
 
         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 +194,10 @@ module Line
       # @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 +209,7 @@ module Line
           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)
@@ -295,6 +304,42 @@ module Line
         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]
@@ -507,15 +552,8 @@ 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)
+        headers = credentials.merge('Content-Type' => content_type(file))
         post(blob_endpoint, endpoint_path, file.rewind && file.read, headers)
       end
 
@@ -597,6 +635,232 @@ module Line
         get(endpoint, endpoint_path, credentials)
       end
 
+      # Gets a bot's basic information.
+      #
+      # @return [Net::HTTPResponse]
+      def get_bot_info
+        channel_token_required
+
+        endpoint_path = '/bot/info'
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Gets information on a webhook endpoint.
+      #
+      # @return [Net::HTTPResponse]
+      def get_webhook_endpoint
+        channel_token_required
+
+        endpoint_path = '/bot/channel/webhook/endpoint'
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Sets the webhook endpoint URL.
+      #
+      # @param webhook_endpoint [String]
+      #
+      # @return [Net::HTTPResponse]
+      def set_webhook_endpoint(webhook_endpoint)
+        channel_token_required
+
+        endpoint_path = '/bot/channel/webhook/endpoint'
+        body = {endpoint: webhook_endpoint}
+        put(endpoint, endpoint_path, body.to_json, credentials)
+      end
+
+      # Checks if the configured webhook endpoint can receive a test webhook event.
+      #
+      # @param webhook_endpoint [String] options
+      #
+      # @return [Net::HTTPResponse]
+      def test_webhook_endpoint(webhook_endpoint = nil)
+        channel_token_required
+
+        endpoint_path = '/bot/channel/webhook/test'
+        body = if webhook_endpoint.nil?
+                 {}
+               else
+                 {endpoint: webhook_endpoint}
+               end
+        post(endpoint, endpoint_path, body.to_json, credentials)
+      end
+
+      def get_liff_apps
+        channel_token_required
+
+        endpoint_path = '/apps'
+        get(liff_endpoint, endpoint_path, credentials)
+      end
+
+      def create_liff_app(app)
+        channel_token_required
+
+        endpoint_path = '/apps'
+        post(liff_endpoint, endpoint_path, app.to_json, credentials)
+      end
+
+      def update_liff_app(liff_id, app)
+        channel_token_required
+
+        endpoint_path = "/apps/#{liff_id}"
+        put(liff_endpoint, endpoint_path, app.to_json, credentials)
+      end
+
+      def delete_liff_app(liff_id)
+        channel_token_required
+
+        endpoint_path = "/apps/#{liff_id}"
+        delete(liff_endpoint, endpoint_path, credentials)
+      end
+
+      # Create an audience group by uploading user_ids
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group
+      #
+      # @param params [Hash] options
+      #
+      # @return [Net::HTTPResponse] This response includes an audience_group_id.
+      def create_user_id_audience(params)
+        channel_token_required
+
+        endpoint_path = '/bot/audienceGroup/upload'
+        post(endpoint, endpoint_path, params.to_json, credentials)
+      end
+
+      # Update an audience group
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group
+      #
+      # @param params [Hash] options
+      #
+      # @return [Net::HTTPResponse] This response includes an audience_group_id.
+      def update_user_id_audience(params)
+        channel_token_required
+
+        endpoint_path = '/bot/audienceGroup/upload'
+        put(endpoint, endpoint_path, params.to_json, credentials)
+      end
+
+      # Create an audience group of users that clicked a URL in a message sent in the past
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group
+      #
+      # @param params [Hash] options
+      #
+      # @return [Net::HTTPResponse] This response includes an audience_group_id.
+      def create_click_audience(params)
+        channel_token_required
+
+        endpoint_path = '/bot/audienceGroup/click'
+        post(endpoint, endpoint_path, params.to_json, credentials)
+      end
+
+      # Create an audience group of users that opened a message sent in the past
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group
+      #
+      # @param params [Hash] options
+      #
+      # @return [Net::HTTPResponse] This response includes an audience_group_id.
+      def create_impression_audience(params)
+        channel_token_required
+
+        endpoint_path = '/bot/audienceGroup/imp'
+        post(endpoint, endpoint_path, params.to_json, credentials)
+      end
+
+      # Rename an existing audience group
+      #
+      # @param audience_group_id [Integer]
+      # @param description [String]
+      #
+      # @return [Net::HTTPResponse]
+      def rename_audience(audience_group_id, description)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/#{audience_group_id}/updateDescription"
+        body = {description: description}
+        put(endpoint, endpoint_path, body.to_json, credentials)
+      end
+
+      # Delete an existing audience group
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#delete-audience-group
+      #
+      # @param audience_group_id [Integer]
+      #
+      # @return [Net::HTTPResponse]
+      def delete_audience(audience_group_id)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/#{audience_group_id}"
+        delete(endpoint, endpoint_path, credentials)
+      end
+
+      # Get audience group data
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#get-audience-group
+      #
+      # @param audience_group_id [Integer]
+      #
+      # @return [Net::HTTPResponse]
+      def get_audience(audience_group_id)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/#{audience_group_id}"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get data for more than one audience group
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#get-audience-groups
+      #
+      # @param params [Hash] key name `page` is required
+      #
+      # @return [Net::HTTPResponse]
+      def get_audiences(params)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/list?" + URI.encode_www_form(params)
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get the authority level of the audience
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#get-authority-level
+      #
+      # @return [Net::HTTPResponse]
+      def get_audience_authority_level
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/authorityLevel"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Change the authority level of the audience
+      #
+      # Parameters are described here.
+      # https://developers.line.biz/en/reference/messaging-api/#change-authority-level
+      #
+      # @param authority_level [String] value must be `PUBLIC` or `PRIVATE`
+      #
+      # @return [Net::HTTPResponse]
+      def update_audience_authority_level(authority_level)
+        channel_token_required
+
+        endpoint_path = "/bot/audienceGroup/authorityLevel"
+        body = {authorityLevel: authority_level}
+        put(endpoint, endpoint_path, body.to_json, credentials)
+      end
+
       # Fetch data, get content of specified URL.
       #
       # @param endpoint_base [String]
@@ -605,7 +869,7 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def get(endpoint_base, endpoint_path, headers = {})
-        headers = Line::Bot::API::DEFAULT_HEADERS.merge(headers)
+        headers = API::DEFAULT_HEADERS.merge(headers)
         httpclient.get(endpoint_base + endpoint_path, headers)
       end
 
@@ -618,10 +882,23 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def post(endpoint_base, endpoint_path, payload = nil, headers = {})
-        headers = Line::Bot::API::DEFAULT_HEADERS.merge(headers)
+        headers = API::DEFAULT_HEADERS.merge(headers)
         httpclient.post(endpoint_base + endpoint_path, payload, headers)
       end
 
+      # Put 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 put(endpoint_base, endpoint_path, payload = nil, headers = {})
+        headers = API::DEFAULT_HEADERS.merge(headers)
+        httpclient.put(endpoint_base + endpoint_path, payload, headers)
+      end
+
       # Delete content of specified URL.
       #
       # @param endpoint_base [String]
@@ -630,7 +907,7 @@ module Line
       #
       # @return [Net::HTTPResponse]
       def delete(endpoint_base, endpoint_path, headers = {})
-        headers = Line::Bot::API::DEFAULT_HEADERS.merge(headers)
+        headers = API::DEFAULT_HEADERS.merge(headers)
         httpclient.delete(endpoint_base + endpoint_path, headers)
       end
 
@@ -644,10 +921,10 @@ 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
@@ -691,6 +968,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/message.rb

@@ -31,9 +31,9 @@ module Line
       # 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/things.rb

@@ -29,9 +29,9 @@ module Line
       # * 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/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

@@ -57,6 +57,11 @@ module Line
         http(uri).post(uri.request_uri, payload, header)
       end
 
+      def put(url, payload, header = {})
+        uri = URI(url)
+        http(uri).put(uri.request_uri, payload, header)
+      end
+
       def delete(url, header = {})
         uri = URI(url)
         http(uri).delete(uri.request_uri, header)

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.14.0
+  version: 1.18.0
 platform: ruby
 authors:
 - LINE Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2021-01-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,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: SDK of the LINE Messaging API