kamigo 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf3bc5b1dcc848ea459d76e5567f0297fceea777b2cf1f74a52ec2337cb35ad3
-  data.tar.gz: fc8306d1c5770378f38223c6726594f60919c1776aeedf08e802e87c5cb7c3b2
+  metadata.gz: bc2f8fe076b3e0e5411f48097035ba1e8ec4d498d5ce3e9a402142e0a78cdcc9
+  data.tar.gz: b74f073c1dd14bd3d6464fc926cc9499c1e6799fffef42109680a3238f1934d2
 SHA512:
-  metadata.gz: 71ff0323f7f2ae1f7da67d83bc9224be384c2e61b35c91a954f61e33fc46bb6de76310916a207caa4e67e3e63f191c679aa6ff6ca9702a764542a1ef95a9d578
-  data.tar.gz: 9162dd57581cde4a82059ee78251acf1ee54283b0eed23232c300bf0dd871d93c4c0cdd8d5cec160e8745ff6a69f04b1b6bf50f13501c3115bafc1022dd13ff4
+  metadata.gz: 3bff23552b3454a7e476a74c31eb640d5da4c5af45326c4c03990fc50679621083d153fcfa8169fbb47ae633d3aefb4f9697e24351ef63711ca529f1d989f56c
+  data.tar.gz: 995dc759b650a24d5b3f3ee5e26a538befab416ab625aab7f63d0176cba608aa4e321150c3b795111a08ab952359c79f24512a529a0a60a44d648650bb3121cd

data/README.md

@@ -1,28 +1,81 @@
-# Kamigo
-Short description and motivation.
+# Kamigo 簡介
 
-## Usage
-How to use my plugin.
+Kamigo 是一個基於 Rails 的 Chatbot MVC Framework。
 
-## Installation
-Add this line to your application's Gemfile:
+Kamigo 讓你開發 Chatbot 就跟開發網站一樣容易，甚至可以同時開發網站以及 Chatbot 介面，共用 Controller 和 Model，只需要針對 Chatbot 實作 View。
 
-```ruby
-gem 'kamigo'
-```
+Kamigo 提供了重要的 generator，讓你開發聊天機器人時可以快的跟飛一樣。
+
+以下將說明如何使用 Kamigo 來製作 Todo 的教學文件。
+
+# 建立新的 rails 專案
+以下指令直接複製全部，直接貼到 bash 執行即可。
 
-And then execute:
 ```bash
-$ bundle
+# 建立新專案
+rails new kamigo_demo
+# 進入專案
+cd kamigo_demo
+# 安裝套件
+bundle add kamigo
+bundle add dotenv-rails
+# 新增 resource controller
+rails g scaffold todo name desc
+rails db:create
+rails db:migrate
 ```
 
-Or install it yourself as:
-```bash
-$ gem install kamigo
+# 設定首頁
+在 config/routes.rb 當中加入首頁設定：
+
+```
+root to: "todos#index"
+```
+
+# 安裝 js 套件
+在 `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
+```
+
+你可以在你的 LINE 管理後台找到 LINE_CHANNEL_SECRET 和 LINE_CHANNEL_TOKEN。
+
+而 LIFF_COMPACT、LIFF_TALL 和 LIFF_FULL 你必須到 LINE 的後台中的 Liff 分頁去新增，詳細說明請參考 [kamiliff_demo](https://github.com/etrex/kamiliff_demo)。
+
+# 設定聊天機器人 webhook url
+
+請將以下網址填入 LINE Bot 的 webhook url 欄位中：
+
+```
+https://你的網域/line
+```
+
+至此串接完成。
+
+# 實際使用
+
+Kamigo 預設使用基本的語意理解模型，會將使用者輸入視為在瀏覽器網址上輸入文字，並且以 LINE Flex Message 來顯示對應的結果。
+
+只要和你的聊天機器人說 `/`，就能看見首頁的樣子。
+
 
-## Contributing
-Contribution directions go here.
+# 計畫
+- 提供多種語意理解模型串接
+- 網站使用者與聊天機器人使用者綁定
+- 支援 Telegram
+- 支援 Facebook Messenger
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/concerns/reverse_route.rb

@@ -1,5 +1,7 @@
 module ReverseRoute
   def reserve_route(path, http_method: "GET", request_params: nil, format: nil)
+    path = "/#{path}" unless path.start_with? "/"
+
     request.request_method = http_method
     request.path_info = path
     request.format = format if format.present?

data/lib/kamigo/version.rb

@@ -1,3 +1,3 @@
 module Kamigo
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamigo
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - etrex
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2019-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails