kamigo 0.9.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea75257195f05dac8e8ae55e8db83a5cccc70cd5f15727b4c49f30ad56fd64e9
-  data.tar.gz: 50194c9ac4c2638f4fc588cefed7c8a3f99963a2ab3e02d93459346f89e29249
+  metadata.gz: fa6261bf0404dd6f3cdc88dce3f6ed5fd1b99240986f5523c980bf67be020a18
+  data.tar.gz: a7936a209e8e7b7b0496e13efd9aee3ad7dc95b86c834dd447a09fc5c3a88197
 SHA512:
-  metadata.gz: ca5e84e70baa122941f3a3ee4c80e4c7b9319944e0e8d9799ef7508b74799f4f436a0fe66aabb776ca740d62d8c0b69c8d5b64d76e4d6c740b10137065be2896
-  data.tar.gz: '0038ba142c479f197ab3e32b121dd8e7c1dc299083c1ef42f9453c51875600a55a82263611a63f966674e4d55f184dc1244bc69907654fafdb8919bb9d838d71'
+  metadata.gz: d172ea63954894592d0dbad7823e0c9a6c47aa96acbb40078cf522e0b4be31dd3f167f4347d57a644e09cfd215c767a7d93f4ebd0d8c5515603f2ae56408bd3c
+  data.tar.gz: df8dc0dc851a7ba5afa798b610c0574acf8602a16d4f81ebc7d97de82b37b42e83c8777207eb8eb0d554dcb11c93e5f3431b50b459eb631af45bcbeb2b5c157d

data/README.md

@@ -1,5 +1,4 @@
 # Kamigo 簡介
-
 Kamigo 是一個基於 Rails 的 Chatbot MVC Framework。
 
 Kamigo 讓你開發 Chatbot 就跟開發網站一樣容易，甚至可以同時開發網站以及 Chatbot 介面，共用 Controller 和 Model，只需要針對 Chatbot 實作 View。
@@ -9,7 +8,7 @@ Kamigo 提供了重要的 generator，讓你開發聊天機器人時可以快的
 以下將說明如何使用 Kamigo 來製作 Todo 的教學文件。
 
 # 建立新的 rails 專案
-以下指令直接複製全部，直接貼到 bash 執行即可。
+將以下指令全部複製，直接貼到 bash 執行即可。
 
 ```bash
 # 建立新專案
@@ -26,49 +25,109 @@ rails db:migrate
 ```
 
 # 設定首頁
-在 config/routes.rb 當中加入首頁設定：
+在 `config/routes.rb` 當中加入首頁設定：
 
 ```
 root to: "todos#index"
 ```
 
 # 安裝 js 套件
-在 `app/assets/javascripts/application.js` 當中加入一行程式碼：
+
+若使用 Asset Pipeline（Rails 5），請在 `app/assets/javascripts/application.js` 當中
+
+加入以下程式碼：
 
 ```
 //= require kamiliff
 ```
 
-# 設定聊天機器人環境變數
-本文假設你已經有一個自己的聊天機器人，請在專案根目錄下新增一個 `.env` 檔並且填入以下內容：
+或者加入以下程式碼：
 
 ```
-LINE_CHANNEL_SECRET=這裡填入你的 LINE_CHANNEL_SECRET
-LINE_CHANNEL_TOKEN=這裡填入你的 LINE_CHANNEL_TOKEN
-LIFF_COMPACT=這裡填入你的 LIFF_COMPACT
-LIFF_TALL=這裡填入你的 LIFF_TALL
-LIFF_FULL=這裡填入你的 LIFF_FULL
+/* 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 管理後台找到 LINE_CHANNEL_SECRET 和 LINE_CHANNEL_TOKEN。
+若使用 Webpacker（Rails 6），請在 `app/javascript/packs/application.js` 當中
+
+加入以下程式碼：
 
-而 LIFF_COMPACT、LIFF_TALL 和 LIFF_FULL 你必須到 LINE 的後台中的 Liff 分頁去新增，詳細說明請參考 [kamiliff_demo](https://github.com/etrex/kamiliff_demo)。
+```
+/* 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);
+});
+```
 
-# 設定聊天機器人 webhook url
+這會影響 LINE Bot 在 LIFF 送出表單時的行為。
 
-請將以下網址填入 LINE Bot 的 webhook url 欄位中：
+# 設定聊天機器人 Webhook URL
+本文假設你已經有一個自己的聊天機器人，請將以下網址填入 LINE Bot 的 Webhook URL 欄位中：
 
 ```
 https://你的網域/line
 ```
 
+第一次開發 LINE Bot 的人可以服用此帖 [Webhook URL 設定 QA](/doc/06_setting.md#Webhook-URL-設定-QA)。
+
+# 設定聊天機器人環境變數
+請在專案根目錄下新增一個 `.env` 檔並且填入以下內容：
+
+```
+LINE_CHANNEL_SECRET=這裡填入你的 LINE_CHANNEL_SECRET
+LINE_CHANNEL_TOKEN=這裡填入你的 LINE_CHANNEL_ACCESS_TOKEN
+LIFF_COMPACT=這裡填入你的 COMPACT_LIFF_URL
+LIFF_TALL=這裡填入你的 TALL_LIFF_URL
+LIFF_FULL=這裡填入你的 FULL_LIFF_URL
+```
+
+- `LINE_CHANNEL_SECRET` 可以在 Messaging API 後台的 Basic settings 分頁中找到。
+- `LINE_CHANNEL_ACCESS_TOKEN` 可以在 Messaging API 後台的 Messaging API 分頁中找到。
+- `COMPACT_LIFF_URL`、`TALL_LIFF_URL` 和 `FULL_LIFF_URL` 需要到 LINE 後台的 LIFF 分頁新增後，即可獲得一組 LIFF URL。
+
+Kamigo 預設的 LIFF Size 為 Compact，你也可以只新增 Compact LIFF URL。
+詳細的 LIFF 設定說明可以服用此帖 [LIFF 設定 QA](/doc/06_setting.md#LIFF-設定-QA)。
+
 至此串接完成。
 
-# 實際使用
+# Rails 6 注意事項
 
+若使用 ngrok 在本機開發時，需要在 `config/application.rb` 加入以下程式碼：
+
+```ruby
+...
+module KamigoDemo
+  class Application < Rails::Application
+    ...
+    config.hosts << "你的亂碼.ngrok.io"
+  end
+end
+```
+
+才能正常連線。
+
+# 實際使用
 Kamigo 預設使用基本的語意理解模型，會將使用者輸入視為在瀏覽器網址上輸入文字，並且以 LINE Flex Message 來顯示對應的結果。
 
-只要和你的聊天機器人說 `/`，就能看見首頁的樣子。
+開啟 LINE 和聊天機器人說 `/`，就能看到首頁的樣子。
 
 # 使用 kamigo 製作的聊天機器人
 - [kamigo demo](https://github.com/etrex/kamigo_demo)
@@ -77,12 +136,14 @@ Kamigo 預設使用基本的語意理解模型，會將使用者輸入視為在
   <p><img width="100" height="100" src="https://camo.githubusercontent.com/b8c51b15b20b159d356245277d079c04482acc01/68747470733a2f2f692e696d6775722e636f6d2f7534547675676e2e706e67"></p>
 - 守護寵物機器人
   <p><img width="100" height="100" src="/doc/images/pet_loved_qrcode.png"></p>
+
 # 詳細的說明文件
 - [Kamigo 架構概觀](/doc/01_intro.md)
 - [Route 的使用說明](/doc/02_route.md)
 - [Controller 的使用說明](/doc/03_controller.md)
 - [View 的使用說明](/doc/04_view.md)
 - [Form 的使用說明](/doc/05_form.md)
+- [Kamigo 相關設定與 QA](/doc/06_setting.md)
 
 # 計畫
 - 提供多種語意理解模型串接

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_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?("{")
+        return nil if message.blank?
         response = client.reply_message(event.reply_token, message)
         response
       end

data/lib/kamigo/version.rb

@@ -1,3 +1,3 @@
 module Kamigo
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.14.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamigo
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.14.0
 platform: ruby
 authors:
 - etrex
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-11-25 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.21'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.21.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
@@ -97,7 +109,6 @@ files:
 - config/routes.rb
 - lib/generators/rails/kamigo/USAGE
 - lib/generators/rails/kamigo/kamigo_generator.rb
-- lib/generators/rails/kamigo/state_generator.rb
 - lib/generators/rails/kamigo/templates/edit.liff.erb
 - lib/generators/rails/kamigo/templates/index.line.erb
 - lib/generators/rails/kamigo/templates/new.liff.erb
@@ -117,7 +128,7 @@ homepage: https://github.com/etrex/kamigo
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: a chatbot framework based on rails
 test_files: []

data/lib/generators/rails/kamigo/state_generator.rb

@@ -1,56 +0,0 @@
-require 'rails/generators/named_base'
-require 'rails/generators/resource_helpers'
-
-module Rails
-  module Generators
-    class CreateStateGenerator < NamedBase
-      include Rails::Generators::ResourceHelpers
-      namespace "devise"
-      argument :attributes, type: :string, default: 'kamigo_state'
-
-      class_option :timestamps, type: :boolean, default: true
-
-      def create_root_folder
-        path = File.join('app/views', controller_file_path)
-        empty_directory path unless File.directory?(path)
-      end
-
-      def copy_view_files
-        filenames.each do |filename|
-          template filename, File.join('app/views', controller_file_path, filename)
-        end
-      end
-
-      protected
-
-      def attributes_names
-        [:id] + super
-      end
-
-      def filenames
-        [
-          "index.line.erb",
-          "show.line.erb",
-          "edit.liff.erb",
-          "new.liff.erb",
-        ]
-      end
-
-      def full_attributes_list
-        if options[:timestamps]
-          attributes_list(attributes_names + %w(created_at updated_at))
-        else
-          attributes_list(attributes_names)
-        end
-      end
-
-      def attributes_list(attributes = attributes_names)
-        if self.attributes.any? {|attr| attr.name == 'password' && attr.type == :digest}
-          attributes = attributes.reject {|name| %w(password password_confirmation).include? name}
-        end
-
-        attributes.map { |a| ":#{a}"} * ', '
-      end
-    end
-  end
-end