kamigo 0.6.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21366e85d6e20718c8c7ebc6eac94740928de80dc1e0a5dd5acbd6b722a57087
-  data.tar.gz: 3cac9c2fec9298a9bf6cf697d319c62b7054c2303e3a0bf11c420aa0e2130b6c
+  metadata.gz: 6c37d93e670d52741747f5c8757b42d2945833b12c74366010ba4b70b665685f
+  data.tar.gz: 37c612b5bbe34236e3a3d583c6c212b4352be10cfcd5c9f5ef9a1ecfa203fbdc
 SHA512:
-  metadata.gz: 36dd211fd0a0ae7c33f614cd3b80142961e0b486578336efc895b5351465de133276335f0fc95eaee9490403ae492347e6af17ad26815d9ad95bb8350ba1cf72
-  data.tar.gz: af2d392ab4ba07e7562964b83d4fed92e5c4b08994125ab487e930d99637ee16358689e027598e915fc17d50e26aca0f68ac84c652ef5024d51b5a070d3c6783
+  metadata.gz: 4e94bee3022f707c23024408e1e77b543a06de37a72231efff58136f621bbe6f5ebcb81eb152134001b19215832e7629ad8ffd0cbf9760351a4a9b0be7aa920b
+  data.tar.gz: e62730e1fff290e8ffe94677d9a0a9fca5c2a126bf95430b5262dfd982435659cb5071453df7652bff710e5a3476cb0736317bdaa345bec45ec6ac478879ddff

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,53 @@ rails db:migrate
 ```
 
 # 設定首頁
-在 config/routes.rb 當中加入首頁設定：
+在 `config/routes.rb` 當中加入首頁設定：
 
 ```
 root to: "todos#index"
 ```
 
 # 安裝 js 套件
+<!-- TODO: 待卡米修改完 Kamiliff 後，需新增不同使用方式的說明 -->
 在 `app/assets/javascripts/application.js` 當中加入一行程式碼：
 
 ```
 //= require kamiliff
 ```
 
-# 設定聊天機器人環境變數
-本文假設你已經有一個自己的聊天機器人，請在專案根目錄下新增一個 `.env` 檔並且填入以下內容：
+# 設定聊天機器人 Webhook URL
+本文假設你已經有一個自己的聊天機器人，請將以下網址填入 LINE Bot 的 Webhook URL 欄位中：
 
 ```
-LINE_CHANNEL_SECRET=這裡填入你的 LINE_CHANNEL_SECRET
-LINE_CHANNEL_TOKEN=這裡填入你的 LINE_CHANNEL_TOKEN
-LIFF_COMPACT=這裡填入你的 LIFF_COMPACT
-LIFF_TALL=這裡填入你的 LIFF_TALL
-LIFF_FULL=這裡填入你的 LIFF_FULL
+https://你的網域/line
 ```
 
-你可以在你的 LINE 管理後台找到 LINE_CHANNEL_SECRET 和 LINE_CHANNEL_TOKEN。
+第一次開發 LINE Bot 的人可以服用此帖 [Webhook URL 設定 QA](/doc/06_setting.md#Webhook-URL-設定-QA)。
 
-而 LIFF_COMPACT、LIFF_TALL 和 LIFF_FULL 你必須到 LINE 的後台中的 Liff 分頁去新增，詳細說明請參考 [kamiliff_demo](https://github.com/etrex/kamiliff_demo)。
-
-# 設定聊天機器人 webhook url
-
-請將以下網址填入 LINE Bot 的 webhook url 欄位中：
+# 設定聊天機器人環境變數
+請在專案根目錄下新增一個 `.env` 檔並且填入以下內容：
 
 ```
-https://你的網域/line
+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)。
+
 至此串接完成。
 
 # 實際使用
-
 Kamigo 預設使用基本的語意理解模型，會將使用者輸入視為在瀏覽器網址上輸入文字，並且以 LINE Flex Message 來顯示對應的結果。
 
-只要和你的聊天機器人說 `/`，就能看見首頁的樣子。
+開啟 LINE 和聊天機器人說 `/`，就能看到首頁的樣子。
 
 # 使用 kamigo 製作的聊天機器人
 - [kamigo demo](https://github.com/etrex/kamigo_demo)
@@ -77,12 +80,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/kamigo_controller.rb

@@ -0,0 +1,34 @@
+require 'uri'
+
+class KamigoController < ApplicationController
+  def kamiform(http_method, path, resource)
+    error_message = "please generate model Kamiform by the following command:\n\nrails g model kamiform platform_type source_group_id http_method path params:jsonb field\nrails db:migrate\n\n"
+    begin
+      Kamiform
+    rescue StandardError
+      raise error_message
+    end
+
+    return nil if resource.errors.empty?
+
+    error = resource.errors.first
+    resource_name = resource.class.to_s.downcase
+    Kamiform.create(
+      platform_type: params[:platform_type],
+      source_group_id: params[:source_group_id],
+      http_method: http_method,
+      path: path,
+      params: params,
+      field: "#{resource_name}.#{error[0]}"
+    )
+
+    begin
+      render "#{resource_name.pluralize}/kamiform/#{error[0]}"
+    rescue StandardError
+      render json: {
+        type: 'text',
+        text: error[1]
+      }
+    end
+  end
+end

data/app/controllers/line_controller.rb

@@ -16,7 +16,8 @@ class LineController < ApplicationController
   private
 
   def process_event(event)
-    http_method, path, request_params = language_understanding(event.message)
+    http_method, path, request_params = slot_filling(event)
+    http_method, path, request_params = language_understanding(event.message) if http_method.nil?
     encoded_path = URI.encode(path)
     request_params = event.platform_params.merge(request_params)
     output = reserve_route(encoded_path, http_method: http_method, request_params: request_params, format: :line)
@@ -32,6 +33,34 @@ class LineController < ApplicationController
     })
   end
 
+  def slot_filling(event)
+    begin
+      Kamiform
+    rescue StandardError
+      return [nil, nil, nil]
+    end
+
+    form = Kamiform.find_by(
+      platform_type: event.platform_type,
+      source_group_id: event.source_group_id
+    )
+    return [nil, nil, nil] if form.nil?
+
+    http_method = form.http_method
+    path = form.path
+    request_params = form.params
+
+    # fill
+    if form.field['.'].nil?
+      request_params[form.field] = event.message
+    else
+      *head, tail = form.field.split('.')
+      request_params.dig(*head)[tail] = event.message
+    end
+    form.destroy
+    [http_method.upcase, path, request_params]
+  end
+
   def language_understanding(text)
     http_method = %w[GET POST PUT PATCH DELETE].find do |http_method|
       text.start_with? http_method

data/lib/kamigo/version.rb

@@ -1,3 +1,3 @@
 module Kamigo
-  VERSION = '0.6.0'
+  VERSION = '0.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamigo
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.10.0
 platform: ruby
 authors:
 - etrex
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2020-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: kamiflex
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,7 @@ files:
 - Rakefile
 - app/assets/config/kamigo_manifest.js
 - app/controllers/concerns/reverse_route.rb
+- app/controllers/kamigo_controller.rb
 - app/controllers/line_controller.rb
 - config/routes.rb
 - lib/generators/rails/kamigo/USAGE
@@ -115,7 +116,7 @@ homepage: https://github.com/etrex/kamigo
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -130,8 +131,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.4
+signing_key:
 specification_version: 4
 summary: a chatbot framework based on rails
 test_files: []