line-bot-api 1.19.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8864bff59b1e7a50a3f63bd2aef939319c9731b9facbb4116d0aa4bb7894101
-  data.tar.gz: df898ac583f61824837b3e92f98867be4aafb74fbdc5b89ad094edf164e098ee
+  metadata.gz: 17ed6a316ad332e424e59aa498c8e9ee3bc7062204f191ea3b78e44f74a623b0
+  data.tar.gz: 3a9cc6bbf3cbf658685873f4ea92c501cda4d73d6b6f969ec1620af4d34322ba
 SHA512:
-  metadata.gz: 921d2f1896c8c60759eeccbd3ca40a57bd2d401558a1d5d5bedceb967f00d1be6d56b1d886987e7883cd9b2b43541b555ec895759607235265accd787aed6653
-  data.tar.gz: 3a50ac3a250aa087eb7285a7a1144e4f64c15443acaca6d28e747f979198902ef887bc589fad8e31aa74fb526820ebc3eff1e4413f83460b227caa327021e172
+  metadata.gz: 264355c41cc59a4063284d83902639df915df5dfa82b9787d1a4a973dfe4af2d729c171428c12b013e9f87ca6b667e1f8f0c41de5b93843a37040cafb1ea7f54
+  data.tar.gz: '08ef6e828069cf6a8d971450f054fc8c4a662b6244da697138cb33305b38e0a6711e0e75d82fccb9574f88b86e9f7bb8cf7cd13e247bab53c612c989572efc55'

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

@@ -15,7 +15,7 @@
 module Line
   module Bot
     module API
-      VERSION = "1.19.0"
+      VERSION = "1.23.0"
     end
   end
 end

data/lib/line/bot/api.rb

@@ -17,6 +17,7 @@ require 'line/bot/api/version'
 module Line
   module Bot
     module API
+      DEFAULT_OAUTH_ENDPOINT = "https://api.line.me"
       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"

data/lib/line/bot/client.rb

@@ -55,6 +55,10 @@ module Line
         @endpoint ||= API::DEFAULT_ENDPOINT
       end
 
+      def oauth_endpoint
+        @oauth_endpoint ||= API::DEFAULT_OAUTH_ENDPOINT
+      end
+
       def blob_endpoint
         return @blob_endpoint if @blob_endpoint
 
@@ -106,19 +110,71 @@ module Line
         post(endpoint, endpoint_path, payload, headers)
       end
 
+      # Issue channel access token v2.1
+      #
+      # @param jwt [String]
+      #
+      # @return [Net::HTTPResponse]
+      def issue_channel_access_token_jwt(jwt)
+        endpoint_path = '/oauth2/v2.1/token'
+        payload = URI.encode_www_form(
+          grant_type: 'client_credentials',
+          client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
+          client_assertion: jwt
+        )
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        post(oauth_endpoint, endpoint_path, payload, headers)
+      end
+
+      # Revoke channel access token v2.1
+      #
+      # @param access_token [String]
+      #
+      # @return [Net::HTTPResponse]
+      def revoke_channel_access_token_jwt(access_token)
+        channel_id_required
+        channel_secret_required
+
+        endpoint_path = '/oauth2/v2.1/revoke'
+        payload = URI.encode_www_form(
+          client_id: channel_id,
+          client_secret: channel_secret,
+          access_token: access_token
+        )
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        post(oauth_endpoint, endpoint_path, payload, headers)
+      end
+
+      # Get all valid channel access token key IDs v2.1
+      #
+      # @param jwt [String]
+      #
+      # @return [Net::HTTPResponse]
+      def get_channel_access_token_key_ids_jwt(jwt)
+        payload = URI.encode_www_form(
+          client_assertion_type: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer',
+          client_assertion: jwt
+        )
+        endpoint_path = "/oauth2/v2.1/tokens/kid?#{payload}"
+
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        get(oauth_endpoint, endpoint_path, headers)
+      end
+
       # 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
+      # @param payload [Hash] Additional request body
       # @return [Net::HTTPResponse]
-      def push_message(user_id, messages, headers: {})
+      def push_message(user_id, messages, headers: {}, payload: {})
         channel_token_required
 
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/push'
-        payload = { to: user_id, messages: messages }.to_json
+        payload = payload.merge({ to: user_id, messages: messages }).to_json
         post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
@@ -157,15 +213,16 @@ module Line
       # @param to [Array or String] Array of userIds
       # @param messages [Hash or Array] Message Objects
       # @param headers [Hash] HTTP Headers
+      # @param payload [Hash] Additional request body
       # @return [Net::HTTPResponse]
-      def multicast(to, messages, headers: {})
+      def multicast(to, messages, headers: {}, payload: {})
         channel_token_required
 
         to = [to] if to.is_a?(String)
         messages = [messages] if messages.is_a?(Hash)
 
         endpoint_path = '/bot/message/multicast'
-        payload = { to: to, messages: messages }.to_json
+        payload = payload.merge({ to: to, messages: messages }).to_json
         post(endpoint, endpoint_path, payload, credentials.merge(headers))
       end
 
@@ -276,15 +333,22 @@ module Line
 
       # Get user IDs of who added your LINE Official Account as a friend
       #
-      # @param continuation_token [String] Identifier to return next page
-      #                                   (next property to be included in the response)
+      # @param start [String] Identifier to return next page (next property to be included in the response)
+      # @param limit [Integer] The maximum number of user IDs to retrieve in a single request
       #
       # @return [Net::HTTPResponse]
-      def get_follower_ids(continuation_token = nil)
+      def get_follower_ids(deprecated_continuation_token = nil, start: nil, limit: nil)
         channel_token_required
 
+        if deprecated_continuation_token
+          warn "continuation_token as the first argument is deprecated. Please use :start instead."
+          start = deprecated_continuation_token
+        end
+
+        params = { start: start, limit: limit }.compact
+
         endpoint_path = "/bot/followers/ids"
-        endpoint_path += "?start=#{continuation_token}" if continuation_token
+        endpoint_path += "?" + URI.encode_www_form(params) unless params.empty?
         get(endpoint, endpoint_path, credentials)
       end
 
@@ -492,6 +556,66 @@ module Line
         delete(endpoint, endpoint_path, credentials)
       end
 
+      # Set rich menu alias
+      #
+      # @param rich_menu_id [String] ID of an uploaded rich menu
+      # @param rich_menu_alias_id [String] string of alias words rich menu
+      #
+      # @return [Net::HTTPResponse]
+      def set_rich_menus_alias(rich_menu_id, rich_menu_alias_id)
+        channel_token_required
+
+        endpoint_path = '/bot/richmenu/alias'
+        post(endpoint, endpoint_path, { richMenuId: rich_menu_id, richMenuAliasId: rich_menu_alias_id }.to_json, credentials)
+      end
+
+      # Unset rich menu alias
+      #
+      # @param rich_menu_alias_id [String] string of alias words rich menu
+      #
+      # @return [Net::HTTPResponse]
+      def unset_rich_menus_alias(rich_menu_alias_id)
+        channel_token_required
+
+        endpoint_path = "/bot/richmenu/alias/#{rich_menu_alias_id}"
+        delete(endpoint, endpoint_path, credentials)
+      end
+
+      # Update rich menu alias
+      #
+      # @param rich_menu_id [String] ID of an uploaded rich menu
+      # @param rich_menu_alias_id [String] string of alias words rich menu
+      #
+      # @return [Net::HTTPResponse]
+      def update_rich_menus_alias(rich_menu_id, rich_menu_alias_id)
+        channel_token_required
+
+        endpoint_path = "/bot/richmenu/alias/#{rich_menu_alias_id}"
+        post(endpoint, endpoint_path, { richMenuId: rich_menu_id }.to_json, credentials)
+      end
+
+      # Get a rich menu alias via a rich menu alias ID
+      #
+      # @param rich_menu_alias_id [String] string of alias words rich menu
+      #
+      # @return [Net::HTTPResponse]
+      def get_rich_menus_alias(rich_menu_alias_id)
+        channel_token_required
+
+        endpoint_path = "/bot/richmenu/alias/#{rich_menu_alias_id}"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get a list of all uploaded rich menus alias
+      #
+      # @return [Net::HTTPResponse]
+      def get_rich_menus_alias_list
+        channel_token_required
+
+        endpoint_path = "/bot/richmenu/alias/list"
+        get(endpoint, endpoint_path, credentials)
+      end
+
       # Link a rich menu to a user
       #
       # If you want to link a rich menu to multiple users,
@@ -875,6 +999,45 @@ module Line
         put(endpoint, endpoint_path, body.to_json, credentials)
       end
 
+      # Get the per-unit statistics of how users interact with push messages and multicast messages.
+      #
+      # @param unit [String] Case-sensitive name of aggregation unit specified when sending the message.
+      # @param from [String] Start date of aggregation period in UTC+9 with `yyyyMMdd` format
+      # @param to [String] End date of aggregation period in UTC+9 with `yyyyMMdd` format.
+      #
+      # @return [Net::HTTPResponse]
+      def get_statistics_per_unit(unit:, from:, to:)
+        channel_token_required
+
+        params = {customAggregationUnit: unit, from: from, to: to}
+        endpoint_path = "/bot/insight/message/event/aggregation?" + URI.encode_www_form(params)
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get the number of aggregation units used this month.
+      #
+      # @return [Net::HTTPResponse]
+      def get_aggregation_info
+        channel_token_required
+
+        endpoint_path = "/bot/message/aggregation/info"
+        get(endpoint, endpoint_path, credentials)
+      end
+
+      # Get the name list of units used this month for statistics aggregation.
+      #
+      # @param limit [Integer] Maximum number of aggregation units per request. Maximum: 100, Default: 100.
+      # @param start [String] Value of the continuation token found in the `next` property of the JSON object returned in the response.
+      #
+      # @return [Net::HTTPResponse]
+      def get_aggregation_list(limit: nil, start: nil)
+        channel_token_required
+
+        params = {limit: limit, start: start}.compact
+        endpoint_path = "/bot/message/aggregation/list?" + URI.encode_www_form(params)
+        get(endpoint, endpoint_path, credentials)
+      end
+
       # Fetch data, get content of specified URL.
       #
       # @param endpoint_base [String]
@@ -954,7 +1117,7 @@ module Line
       def validate_signature(content, channel_signature)
         return false if !channel_signature || !channel_secret
 
-        hash = OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, channel_secret, content)
+        hash = OpenSSL::HMAC.digest(OpenSSL::Digest.new('SHA256'), channel_secret, content)
         signature = Base64.strict_encode64(hash)
 
         variable_secure_compare(channel_signature, signature)
@@ -986,6 +1149,7 @@ module Line
         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

data/lib/line/bot/httpclient.rb

@@ -38,10 +38,8 @@ module Line
           http.use_ssl = true
         end
 
-        if http_options
-          http_options.each do |key, value|
-            http.send("#{key}=", value)
-          end
+        http_options&.each do |key, value|
+          http.send("#{key}=", value)
         end
 
         http

data/line-bot-api.gemspec

@@ -17,10 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version     = '>= 2.0.0'
+  spec.required_ruby_version     = '>= 2.4.0'
 
   spec.add_development_dependency "addressable", "~> 2.3"
-  spec.add_development_dependency "bundler", "~> 1.11" if RUBY_VERSION < "2.3"
   spec.add_development_dependency 'rake', "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 3.8"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.23.0
 platform: ruby
 authors:
 - LINE Corporation
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -114,15 +114,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: SDK of the LINE Messaging API