line-bot-api 1.30.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af4ad962794c7d219f9acb71cbc6e4af3c0b9749087daba28d73d54d2075e0d5
-  data.tar.gz: c219bdefdc560590bddc4f5887e1f219f498867efd0adbcf0e7f051d5dec35ef
+  metadata.gz: 6d6263a9bbf4c4a5a3d6a18965c1d81b96b91aeb88bcfd7edf4a1dbdeed1d16e
+  data.tar.gz: ed03051dcdd9b5bdd24382113758ae84d12e7ce42b900f75ced07efae11358c1
 SHA512:
-  metadata.gz: de3b983cab0150be06eb0470679f9a737d039fca49c29c1b7984a0a1648b3576c839835fa2b085cb75b3cbe966ab8c2acf93048519a51b4cac16e82856e9cc2b
-  data.tar.gz: e47210b21072b98f04ba084c90ac80eb66e32b8193ffa64abd85014718c29f2fdaf014de07146ca89a2fd8614be547b28f7a00cb45fc743a16e5e6cc64d1672a
+  metadata.gz: b5eb071cae7e4db290c9a6e8248cd6e288ae9881fb08c2be18811aa083bab6b11636e6e57ec96b662baa0163e50da68274c6a173f1a88af27da82eb4aa660632
+  data.tar.gz: c7e60c5813c0201f172f373b85d937a93f134b80044710a8289886da635ee0b95fe0ac5b56ca5c6a06acec8697152415f54516ac474898687d3a675913e64094

data/CONTRIBUTING.md

@@ -9,6 +9,54 @@ It will be amazing if you could help us by doing any of the following:
 - Contribute your work by sending [a pull request](https://github.com/line/line-bot-sdk-ruby/pulls).
 
 ## Development
+### Install dependencies
+Run `bundle install` to install all dependencies for development.
+
+### Understand the project structure
+The project structure is as follows:
+- `lib`: The main library code.
+- `sig`: The RBS code.
+- `sig-vendor`: The RBS code outside this repository.
+- `spec`: The test code.
+- `examples`: Example projects that use the library.
+- `generator`: The code generator for the library.
+
+### Edit pebble template
+Almost all code are generated with [pebble template](https://pebbletemplates.io/), based on [line-openapi](https://github.com/line/line-openapi)'s yaml.
+Thus, you can't edit almost all code under `lib/line/bot/v2/<dir>.rb` and `sig/line/bot/v2/<dir>.rbs` directly.
+
+You need to edit the pebble template under [resources](generator/src/main/resources) instead.
+
+After editing the templates, run `generate-code.py` to generate the code, and then commit all affected files.
+If not, CI status will be red.
+
+When you update code, be sure to check consistencies between `lib/**.rb` and `sig/**.rbs`.
+
+### Add unit tests
+We use [RSpec](https://rspec.info/) for unit tests.
+Please add tests to the `spec` directory to verify your changes continuously.
+
+Especially for bug fixes, please follow this flow for testing and development:
+1. Write a test before making changes to the library and confirm that the test fails.
+2. Modify the code of the library.
+3. Run the test again and confirm that it passes thanks to (2).
+
+### Run your code in your local
+[Example projects](examples/v2) depend on this repository directly.
+You can use new or fixed gem in example projects before submitting a pull request.
+
+### Run all CI tasks in your local
+`Rakefile` defines almost all tasks.
+
+You can run all tasks in your local by running `bundle exec rake ci` command.
+
+### Upgrade dependencies
+The libraries that the library itself depends on are listed in the `line-bot-api.gemspec` file.
+Those needed only for development are written in the `Gemfile`.
+The versions in the gemspec file are set as low as possible, allowing users to specify higher versions in their application's Gemfile.
+
+For files related to RBS, refer to `rbs_collections.yaml` and the `Steepfile`.
+You can update by running `rbs collection update <LIB_NAME>`.
 
 ### YARD
 
@@ -41,5 +89,5 @@ For more details on how to write YARD doc comments, refer to YARD’s official [
 
 ### Contributor license agreement
 
-When you are sending a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign [the ICLA (individual contributor license agreement)](https://cla-assistant.io/line/line-bot-sdk-ruby).
+When you send a pull request and it's a non-trivial change beyond fixing typos, please make sure to sign [the ICLA (individual contributor license agreement)](https://cla-assistant.io/line/line-bot-sdk-ruby).
 Please [contact us](mailto:dl_oss_dev@linecorp.com) if you need the CCLA (corporate contributor license agreement).

data/README.md

@@ -15,7 +15,8 @@ See the official API documentation for more information
 
 Also, generated documentation by YARD is available.
 
-- https://rubydoc.info/gems/line-bot-api
+- https://line.github.io/line-bot-sdk-ruby/
+- https://line.github.io/line-bot-sdk-ruby/_index.html
 
 ## Requirements
 This library requires Ruby 3.2 or later.
@@ -40,46 +41,79 @@ Or install it yourself as:
 gem install line-bot-api
 ```
 
+## Example projects
+We provide examples to help you get started with the SDK.
+They work in your local environment if you have owned your bot account.
+
+Go the [examples](examples/v2) directory for more examples.
+
 ## 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,16 +123,206 @@ post '/callback' do
 end
 ```
 
-## Help and media
-FAQ: https://developers.line.biz/en/faq/
+### Main classes
+You may use this classes to use LINE Messaging API features.
 
-News: https://developers.line.biz/en/news/
+#### Webhook
+- [Line::Bot::V2::WebhookParser](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/WebhookParser.html)  ([LINE Developers](https://developers.line.biz/en/reference/messaging-api/#webhooks))
+- [Line::Bot::V2::Webhook::Event](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Webhook/Event.html) ([LINE Developers](https://developers.line.biz/en/reference/messaging-api/#webhook-event-objects))
+
+### Clients
+
+| Class(YARD documentation)                                                                                                              | API EndPoint                                      | LINE Developers                                                                                                    |
+|----------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
+| [Line::Bot::V2::ChannelAccessToken::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/ChannelAccessToken/ApiClient.html) | https://api.line.me/** (related to oauth)         | https://developers.line.biz/en/reference/messaging-api/#channel-access-token                                       |
+| [Line::Bot::V2::Insight::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Insight/ApiClient.html)                       | https://api.line.me/v2/bot/insight/**             | https://developers.line.biz/en/reference/messaging-api/#get-insight                                                |
+| [Line::Bot::V2::Liff::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Liff/ApiClient.html)                             | https://api.line.me/liff/**                       | https://developers.line.biz/en/reference/liff-server/#server-api                                                   |
+| [Line::Bot::V2::ManageAudience::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/ManageAudience/ApiClient.html)         | https://api.line.me/v2/bot/audienceGroup/**       | https://developers.line.biz/en/reference/messaging-api/#manage-audience-group                                      |
+| [Line::Bot::V2::ManageAudience::ApiBlobClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/ManageAudience/ApiBlobClient.html) | https://api-data.line.me/v2/bot/audienceGroup/**  | https://developers.line.biz/en/reference/messaging-api/#manage-audience-group                                      |
+| [Line::Bot::V2::MessagingApi::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/MessagingApi/ApiClient.html)             | https://api.line.me/v2/bot/**                     | https://developers.line.biz/en/reference/messaging-api/<br/>https://developers.line.biz/en/reference/partner-docs/ |
+| [Line::Bot::V2::MessagingApi::ApiBlobClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/MessagingApi/ApiBlobClient.html)     | https://api-data.line.me/v2/bot/**                | https://developers.line.biz/en/reference/messaging-api/                                                            |
+| [Line::Bot::V2::Module::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Module/ApiClient.html)                         | https://api.line.me/v2/bot/** (related to module) | https://developers.line.biz/en/reference/partner-docs/#module                                                      |
+| [Line::Bot::V2::ModuleAttach::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/ModuleAttach/ApiClient.html)             | https://manager.line.biz/module/auth/v1/token/**  | https://developers.line.biz/en/reference/partner-docs/#module                                                      |
+| [Line::Bot::V2::Shop::ApiClient](https://line.github.io/line-bot-sdk-ruby/Line/Bot/V2/Shop/ApiClient.html)                             | https://api.line.me/shop/**                       | https://developers.line.biz/en/reference/partner-docs/#mission-stickers                                            |
+
+### 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)
+)
+```
 
 ## Versioning
 This project respects semantic versioning.
 
 See https://semver.org/
 
+### v1 and v2
+v1 and v2 are completely different implementations. Migration to v2 is strongly recommended.
+Please refer to [Migration guide](migration_from_v1_to_v2_guide.md) for migration procedure.
+
+## Media
+News: https://developers.line.biz/en/news/
+
 ## Contributing
 Please check [CONTRIBUTING](CONTRIBUTING.md) before making a contribution.