line-bot-api 1.30.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af4ad962794c7d219f9acb71cbc6e4af3c0b9749087daba28d73d54d2075e0d5
-  data.tar.gz: c219bdefdc560590bddc4f5887e1f219f498867efd0adbcf0e7f051d5dec35ef
+  metadata.gz: b046b49fcf0cca9aa1a7d59650aaf5265e71ddd27099bc876b64d4e73cd812b3
+  data.tar.gz: 81fb1a37c8946e4e015abcf1daa255ef5459100f939179dc0f9c418e4371a637
 SHA512:
-  metadata.gz: de3b983cab0150be06eb0470679f9a737d039fca49c29c1b7984a0a1648b3576c839835fa2b085cb75b3cbe966ab8c2acf93048519a51b4cac16e82856e9cc2b
-  data.tar.gz: e47210b21072b98f04ba084c90ac80eb66e32b8193ffa64abd85014718c29f2fdaf014de07146ca89a2fd8614be547b28f7a00cb45fc743a16e5e6cc64d1672a
+  metadata.gz: 6855934b0a92dbe458414a7ebc3ad894b79f2288e17a2e13105fc5505764008823d04bc9606f53c2f69f5fec09d0b84ad3bf2b83f906a3b6f32640f45b414d78
+  data.tar.gz: 7fbfaf4bbd423ed0beb872b97797886827a0c5a629f2dabf7f410f01883d8f06288be9236736ba7cf7d2f0c30484fda340701f1ce118172eabe373fef5f98c42

data/README.md

@@ -41,45 +41,72 @@ gem install line-bot-api
 ```
 
 ## Synopsis
+### RBS
+This library provides [RBS](https://github.com/ruby/rbs) files for type checking.\
+You can code with type support in the corresponding IDE or editor.
 
-Usage:
+### Basic Usage
 
 ```ruby
 # app.rb
 require 'sinatra'
-require 'line/bot'
+require 'line-bot-api'
+
+set :environment, :production
 
 def client
-  @client ||= Line::Bot::Client.new { |config|
-    config.channel_id = ENV["LINE_CHANNEL_ID"]
-    config.channel_secret = ENV["LINE_CHANNEL_SECRET"]
-    config.channel_token = ENV["LINE_CHANNEL_TOKEN"]
-  }
+  @client ||= Line::Bot::V2::MessagingApi::ApiClient.new(
+    channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN")
+  )
+end
+
+def blob_client
+  @blob_client ||= Line::Bot::V2::MessagingApi::ApiBlobClient.new(
+    channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN")
+  )
+end
+
+def parser
+  @parser ||= Line::Bot::V2::WebhookParser.new(channel_secret: ENV.fetch("LINE_CHANNEL_SECRET"))
 end
 
 post '/callback' do
   body = request.body.read
-
   signature = request.env['HTTP_X_LINE_SIGNATURE']
-  unless client.validate_signature(body, signature)
-    error 400 do 'Bad Request' end
+
+  begin
+    events = parser.parse(body: body, signature: signature)
+  rescue Line::Bot::V2::WebhookParser::InvalidSignatureError
+    halt 400, { 'Content-Type' => 'text/plain' }, 'Bad Request'
   end
 
-  events = client.parse_events_from(body)
   events.each do |event|
     case event
-    when Line::Bot::Event::Message
-      case event.type
-      when Line::Bot::Event::MessageType::Text
-        message = {
-          type: 'text',
-          text: event.message['text']
-        }
-        client.reply_message(event['replyToken'], message)
-      when Line::Bot::Event::MessageType::Image, Line::Bot::Event::MessageType::Video
-        response = client.get_message_content(event.message['id'])
+    when Line::Bot::V2::Webhook::MessageEvent
+      case event.message
+      when Line::Bot::V2::Webhook::TextMessageContent
+        case event.message.text
+        when 'profile'
+          if event.source.type == 'user'
+            profile_response = client.get_profile(user_id: event.source.user_id)
+            reply_text(event, "Display name: #{profile_response.display_name}\nStatus message: #{profile_response.status_message}")
+          else
+            reply_text(event, "Bot can't use profile API without user ID")
+          end
+        else
+          request = Line::Bot::V2::MessagingApi::ReplyMessageRequest.new(
+            reply_token: event.reply_token,
+            messages: [
+              Line::Bot::V2::MessagingApi::TextMessage.new(text: "[ECHO] #{event.message.text}")
+            ]
+          )
+          client.reply_message(reply_message_request: request)
+        end
+        
+      when Line::Bot::V2::Webhook::ImageMessageContent, Line::Bot::V2::Webhook::VideoMessageContent
+        response = blob_client.get_message_content(message_id: event.message.message_id)
         tf = Tempfile.open("content")
-        tf.write(response.body)
+        tf.write(response)
       end
     end
   end
@@ -89,9 +116,176 @@ post '/callback' do
 end
 ```
 
-## Help and media
-FAQ: https://developers.line.biz/en/faq/
+### Use HTTP Information
+You may need to store the ```x-line-request-id``` header obtained as a response from several APIs.\
+In this case, please use ```*_with_http_info``` methods. You can get headers and status codes.\
+The `x-line-accepted-request-id` or `content-type` header can also be obtained in the same way. Note header name must be lowercase.
+
+```ruby
+push_request = Line::Bot::V2::MessagingApi::PushMessageRequest.new(
+  to: event.source.user_id,
+  messages: [
+    Line::Bot::V2::MessagingApi::TextMessage.new(text: "[^Request ID] #{headers['x-line-request-id']}")
+  ]
+)
+_body, _status_code, headers = client.push_message_with_http_info(push_message_request: push_request)
+
+puts headers['x-line-request-id']
+puts headers['x-line-accepted-request-id']
+puts headers['content-type']
+```
+
+### Error handling
+If an API call fails, the SDK does not generate an Error in Ruby; use the status code for proper error handling.
+Error details are stored in body.
+
+```ruby
+require 'json'
+require 'line-bot-api'
+
+def client
+  @client ||= Line::Bot::V2::MessagingApi::ApiClient.new(
+    channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN"),
+  )
+end
+
+def main
+  dummy_message = Line::Bot::V2::MessagingApi::TextMessage.new(
+    text: "Hello, world!",
+  )
+
+  valid_request = Line::Bot::V2::MessagingApi::ValidateMessageRequest.new(
+    messages: [dummy_message, dummy_message, dummy_message, dummy_message, dummy_message],
+  )
+  body, status_code, _headers = client.validate_push_with_http_info(validate_message_request: valid_request)
+  handle_response(body, status_code)
+
+  invalid_request = Line::Bot::V2::MessagingApi::ValidateMessageRequest.new(
+    messages: [dummy_message, dummy_message, dummy_message, dummy_message, dummy_message, dummy_message],
+  )
+  body, status_code, _headers = client.validate_push_with_http_info(validate_message_request: invalid_request)
+  handle_response(body, status_code)
+end
+
+def handle_response(body, status_code)
+  case status_code
+  when 200
+    puts "Valid"
+  when 400..499
+    puts "Invalid: #{JSON.parse(body)}"
+  else
+    puts "Other Status: #{status_code}"
+  end
+end
 
+main
+```
+
+### Use with Hash / JSON
+You can use Hash instead of the SDK classes.
+So you can also use Hash parsed from JSON as a parameter.
+
+This is useful, for example, in migrating from v1 or building Flex Message.
+
+**But this is not recommended because you lose type checking by RBS.**
+
+```ruby
+client = Line::Bot::V2::MessagingApi::ApiClient.new(
+  channel_access_token: ENV.fetch("LINE_CHANNEL_ACCESS_TOKEN"),
+)
+
+request =  {
+  to: "U4af4980629...",
+  messages: [
+    {
+      type: "flex",
+      alt_text: "This is a Flex Message",
+      contents: {
+        type: "bubble",
+        body: {
+          type: "box",
+          layout: "horizontal",
+          contents: [
+            {
+              type: "text",
+              text: "Hello"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+client.push_message(push_message_request: request)
+
+# or
+
+request = JSON.parse(
+  <<~JSON
+    {
+      "to": "U4af4980629...",
+      "messages": [
+        {
+          "type": "flex",
+          "alt_text": "This is a Flex Message",
+          "contents": {
+            "type": "bubble",
+            "body": {
+              "type": "box",
+              "layout": "horizontal",
+              "contents": [
+                {
+                  "type": "text",
+                  "text": "Hello"
+                }
+              ]
+            }
+          }
+        }
+      ]
+    }
+  JSON
+)
+client.push_message(push_message_request: request)
+```
+
+#### Convert to SDK classes
+You can convert Hash / JSON to SDK classes using `#create` method.
+
+```ruby
+json = <<~JSON
+  {
+    "to": "U4af4980629...",
+    "messages": [
+      {
+        "type": "flex",
+        "alt_text": "This is a Flex Message",
+        "contents": {
+          "type": "bubble",
+          "body": {
+            "type": "box",
+            "layout": "horizontal",
+            "contents": [
+              {
+                "type": "text",
+                "text": "Hello"
+              }
+            ]
+          }
+        }
+      }
+    ]
+  }
+JSON
+request = Line::Bot::V2::MessagingApi::PushMessageRequest.create(
+  JSON.parse(json)
+)
+```
+
+### More examples
+See the [examples](examples/v2) directory for more examples.
+
+## Media
 News: https://developers.line.biz/en/news/
 
 ## Versioning
@@ -99,6 +293,18 @@ This project respects semantic versioning.
 
 See https://semver.org/
 
+### v1 and v2
+v1 and v2 are completely different implementations, v1 is all deprecated and will be removed in the future.
+Migration to v2 is strongly recommended.
+
+Migration guide: https://github.com/line/line-bot-sdk-ruby/releases/tag/v1.30.0
+
+
+#### Deprecation warnings
+When calling the API endpoint with v1, a deprecation warning will occur.\
+If you want to suppress this, please set any value to the environment variable `SUPRESS_V1_DEPRECATION_WARNINGS`.
+
+
 ## Contributing
 Please check [CONTRIBUTING](CONTRIBUTING.md) before making a contribution.
 

data/lib/line/bot/version.rb

@@ -2,6 +2,6 @@ module Line
   module Bot
     # This version is updated before releasing a new version in the release process.
     # You don't have to update this version manually.
-    VERSION = "1.30.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/line/bot.rb

@@ -12,15 +12,6 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-# V1
-require 'line/bot/v1/util'
-require 'line/bot/v1/client'
-require 'line/bot/v1/event'
-require 'line/bot/v1/api/errors'
-require 'line/bot/v1/api'
-require 'line/bot/v1/httpclient'
-require 'line/bot/v1/api/version'
-
 # V2
 require 'line/bot/v2/webhook_parser'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: line-bot-api
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 2.0.0
 platform: ruby
 authors:
 - LINE Corporation
@@ -49,27 +49,6 @@ files:
 - README.md
 - lib/line-bot-api.rb
 - lib/line/bot.rb
-- lib/line/bot/v1/api.rb
-- lib/line/bot/v1/api/errors.rb
-- lib/line/bot/v1/api/version.rb
-- lib/line/bot/v1/client.rb
-- lib/line/bot/v1/event.rb
-- lib/line/bot/v1/event/account_link.rb
-- lib/line/bot/v1/event/base.rb
-- lib/line/bot/v1/event/beacon.rb
-- lib/line/bot/v1/event/follow.rb
-- lib/line/bot/v1/event/join.rb
-- lib/line/bot/v1/event/leave.rb
-- lib/line/bot/v1/event/member_joined.rb
-- lib/line/bot/v1/event/member_left.rb
-- lib/line/bot/v1/event/message.rb
-- lib/line/bot/v1/event/postback.rb
-- lib/line/bot/v1/event/things.rb
-- lib/line/bot/v1/event/unfollow.rb
-- lib/line/bot/v1/event/unsend.rb
-- lib/line/bot/v1/event/video_play_complete.rb
-- lib/line/bot/v1/httpclient.rb
-- lib/line/bot/v1/util.rb
 - lib/line/bot/v2/channel_access_token/api/channel_access_token_client.rb
 - lib/line/bot/v2/channel_access_token/core.rb
 - lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb
@@ -700,7 +679,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/line/line-bot-sdk-ruby/issues
   changelog_uri: https://github.com/line/line-bot-sdk-ruby/releases
-  documentation_uri: https://rubydoc.info/gems/line-bot-api/1.30.0
+  documentation_uri: https://rubydoc.info/gems/line-bot-api/2.0.0
   homepage_uri: https://github.com/line/line-bot-sdk-ruby
   source_code_uri: https://github.com/line/line-bot-sdk-ruby
 post_install_message:

data/lib/line/bot/v1/api/errors.rb

@@ -1,23 +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.
-
-module Line
-  module Bot
-    module API
-      # @deprecated
-      # This is obsolete. (and there is no caller...)
-      class Error < StandardError; end
-    end
-  end
-end

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

@@ -1,23 +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.
-
-module Line
-  module Bot
-    module API
-      # @deprecated
-      # Use {Line::Bot::VERSION} instead.
-      VERSION = "1.30.0-deprecated"
-    end
-  end
-end

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

@@ -1,33 +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/v1/api/version'
-
-module Line
-  module Bot
-    # @deprecated
-    # This is obsolete.
-    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"
-
-      DEFAULT_HEADERS = {
-        'Content-Type' => 'application/json; charset=UTF-8',
-        'User-Agent'   => "LINE-BotSDK-Ruby/#{VERSION}"
-      }.freeze
-    end
-  end
-end