kamigo 0.12.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb61fe8e780f6283e2c700425bb2c495733371bc19b5cb953dd6ff40f2e6e57a
-  data.tar.gz: '0786d298e6b0fd48bf9dfba777b7fe34391720ff77a87ff0b732bed77133384f'
+  metadata.gz: a50785d04788923d8d0f71ff0b398c522e53a3ee15ade195c4929c6907367d7f
+  data.tar.gz: c2f84fed4d5fafc66d91bec2e945b6597e393ccbb08df7f3392e551b7cb441ce
 SHA512:
-  metadata.gz: fc1024ca24a5052840a1cbf1e9e946ce98121257ced01f9be579f3cbdb05fdee5b42397c448bcb497148925add07487270a6a8ce365336c86fc227082d41b489
-  data.tar.gz: '02858891455879f0dc52e604bc80280a49f542cbae416dbc1c8700c74f80afae3fef649079ecc6b7b456e2fecbf105abead688c2403ebf5839a31e5f8187c297'
+  metadata.gz: 9848cf0afbda8e9f87f5c2e7d5f6adc5c479848e263234eda533388fb06272c8790076c678a73e06c43c55f24924e92c37331f61439c2b0e0efa2a7785e236fd
+  data.tar.gz: 71a3807a6df086c1c31dda0dc6bef39a4b9c8dc91c3d2cb0589c18f316aab924fba75ec62bfd87642185b6a633ff70955a51817e1b3ee33b71f39bc2cd05764a

data/README.md

@@ -32,13 +32,53 @@ root to: "todos#index"
 ```
 
 # 安裝 js 套件
-<!-- TODO: 待卡米修改完 Kamiliff 後，需新增不同使用方式的說明 -->
-在 `app/assets/javascripts/application.js` 當中加入一行程式碼：
+
+若使用 Asset Pipeline（Rails 5），請在 `app/assets/javascripts/application.js` 當中
+
+加入以下程式碼：
 
 ```
 //= require kamiliff
 ```
 
+或者加入以下程式碼：
+
+```
+/* kamiliff default behavior */
+window.addEventListener("liff_ready", function(event){
+  register_kamiliff_submit();
+});
+
+window.addEventListener("liff_submit", function(event){
+  var json = JSON.stringify(event.detail.data);
+  var url = event.detail.url;
+  var method = event.detail.method;
+  var request_text = method + " " + url + "\n" + json;
+  liff_send_text_message(request_text);
+});
+```
+
+若使用 Webpacker（Rails 6），請在 `app/javascript/packs/application.js` 當中
+
+加入以下程式碼：
+
+```
+/* kamiliff default behavior */
+window.addEventListener("liff_ready", function(event){
+  register_kamiliff_submit();
+});
+
+window.addEventListener("liff_submit", function(event){
+  var json = JSON.stringify(event.detail.data);
+  var url = event.detail.url;
+  var method = event.detail.method;
+  var request_text = method + " " + url + "\n" + json;
+  liff_send_text_message(request_text);
+});
+```
+
+這會影響 LINE Bot 在 LIFF 送出表單時的行為。
+
 # 設定聊天機器人 Webhook URL
 本文假設你已經有一個自己的聊天機器人，請將以下網址填入 LINE Bot 的 Webhook URL 欄位中：
 
@@ -68,6 +108,22 @@ Kamigo 預設的 LIFF Size 為 Compact，你也可以只新增 Compact LIFF URL
 
 至此串接完成。
 
+# Rails 6 注意事項
+
+若使用 ngrok 在本機開發時，需要在 `config/application.rb` 加入以下程式碼：
+
+```ruby
+...
+module KamigoDemo
+  class Application < Rails::Application
+    ...
+    config.hosts << "你的亂碼.ngrok.io"
+  end
+end
+```
+
+才能正常連線。
+
 # 實際使用
 Kamigo 預設使用基本的語意理解模型，會將使用者輸入視為在瀏覽器網址上輸入文字，並且以 LINE Flex Message 來顯示對應的結果。
 

data/app/controllers/line_controller.rb

@@ -23,7 +23,7 @@ class LineController < ApplicationController
     output = reserve_route(encoded_path, http_method: http_method, request_params: request_params, format: :line)
     responser = Kamigo::EventResponsers::LineEventResponser.new
     response =  responser.response_event(event, output)
-    puts response.body
+    puts response&.body
   rescue NoMethodError => e
     puts e.full_message
     responser = Kamigo::EventResponsers::LineEventResponser.new

data/lib/kamigo/event_parsers/line_event_parser.rb

@@ -13,9 +13,11 @@ module Kamigo
 
       def parse(event)
         payload = JSON.parse(event.to_json, symbolize_names: true)[:src]
+        response = client.get_profile(payload[:source][:userId])
         line_event = Kamigo::Events::LineEvent.new
         line_event.payload = payload
         line_event.reply_token = event['replyToken']
+        line_event.profile = JSON.parse(response.body)
         line_event.source_type = payload.dig(:source, :type)
         line_event.source_group_id = payload.dig(:source, :groupId) || payload.dig(:source, :roomId) || payload.dig(:source, :userId)
         line_event.source_user_id = payload.dig(:source, :userId) || payload.dig(:source, :groupId) || payload.dig(:source, :roomId)

data/lib/kamigo/event_responsers/line_event_responser.rb

@@ -4,7 +4,9 @@ module Kamigo
       include Kamigo::Clients::LineClient
 
       def response_event(event, message)
-        message = JSON.parse(message) if message.is_a? String
+        return nil if message.blank?
+        message = JSON.parse(message) if message.is_a?(String) && (message.start_with?("{") || message.start_with?("["))
+        return nil if message.blank?
         response = client.reply_message(event.reply_token, message)
         response
       end

data/lib/kamigo/events/basic_event.rb

@@ -7,6 +7,7 @@ module Kamigo
       attr_accessor :source_type
       attr_accessor :source_group_id
       attr_accessor :source_user_id
+      attr_accessor :profile
       attr_accessor :payload
 
       def platform_params
@@ -14,7 +15,8 @@ module Kamigo
           platform_type: platform_type,
           source_type: source_type,
           source_group_id: source_group_id,
-          source_user_id: source_user_id
+          source_user_id: source_user_id,
+          profile: profile
         }
       end
     end

data/lib/kamigo/version.rb

@@ -1,3 +1,3 @@
 module Kamigo
-  VERSION = '0.12.0'.freeze
+  VERSION = '0.17.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamigo
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.17.0
 platform: ruby
 authors:
 - etrex
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-22 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,20 +28,29 @@ dependencies:
   name: kamiliff
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.24.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.24.0
 - !ruby/object:Gem::Dependency
   name: kamiflex
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.0
@@ -49,6 +58,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.0
@@ -56,30 +68,30 @@ dependencies:
   name: line-bot-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: a chatbot framework based on rails
 email:
 - et284vu065k3@gmail.com