kamigo 0.19.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0286bef7f7c96549005475052dd8346f44fe4e010a917322a6cdd3cbf654bee
-  data.tar.gz: d7d456254873fa6e5ae5c15e8e27801068ee7cf96c7caa0cedf61f9f996e2ceb
+  metadata.gz: c2d0e706b01b63559ccbae86d9028eaabc046f21723f08efbfe4e576cd5b79b1
+  data.tar.gz: 3ef12c974773d236cdbded25773193f46037bb2f97c38db262c360e00567d7cf
 SHA512:
-  metadata.gz: a5aacaf96b30ea7c065c141fd279ace76d2e89ef087da6d609a95d8a24cf877fb40e25557e4903de0e2e37859f5a321a08c4a1dc3fab8bdb1e0f35fdbc20b6aa
-  data.tar.gz: d02be888e22755e6484caa313bda70384cf8bd7e2c503da4586aa0cb3394dfbbb293e9edf119f7c47f986d902958a742d12e6d81a74712b80c82e61527880372
+  metadata.gz: a3b4daa5ef98203bd375844b8d7fc702b4ba8d8116aed180d8c6b992e11958204f6ed8c056b59ee7483c1722113b4b783f0a0e97170c0ee0334fa8bd1702acda
+  data.tar.gz: e934e46ce558668684cbf09cb638ac59fd57ba07e297177d0e4dcf9332f42459ddecd27eecf6a2d96fe1d4558b7eb3244c1d9f3ce8eb1c982efdcbf3c346ece6

data/README.md

@@ -1,3 +1,7 @@
+# 詳細的說明文件
+
+[Kamigo 詳細說明](https://etrex.tw/kamigo/)
+
 # Kamigo 簡介
 Kamigo 是一個基於 Rails 的 Chatbot MVC Framework。
 
@@ -18,6 +22,8 @@ cd kamigo_demo
 # 安裝套件
 bundle add kamigo
 bundle add dotenv-rails
+# 建立設定檔
+rails g kamigo:install
 # 新增 resource controller
 rails g scaffold todo name desc
 rails db:create
@@ -86,7 +92,7 @@ window.addEventListener("liff_submit", function(event){
 https://你的網域/line
 ```
 
-第一次開發 LINE Bot 的人可以服用此帖 [Webhook URL 設定 QA](/doc/06_setting.md#Webhook-URL-設定-QA)。
+第一次開發 LINE Bot 的人可以服用此帖 [Webhook URL 設定 QA](/doc/07_setting.md#Webhook-URL-設定-QA)。
 
 # 設定聊天機器人環境變數
 請在專案根目錄下新增一個 `.env` 檔並且填入以下內容：
@@ -104,7 +110,7 @@ LIFF_FULL=這裡填入你的 FULL_LIFF_URL
 - `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)。
+詳細的 LIFF 設定說明可以服用此帖 [LIFF 設定 QA](/doc/07_setting.md#LIFF-設定-QA)。
 
 至此串接完成。
 
@@ -137,19 +143,17 @@ Kamigo 預設使用基本的語意理解模型，會將使用者輸入視為在
 - 守護寵物機器人
   <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)
-
 # 計畫
 - 提供多種語意理解模型串接
+  - DialogFlow
+  - LUIS
 - 網站使用者與聊天機器人使用者綁定
-- 支援 Telegram
-- 支援 Facebook Messenger
+  - Devise
+- Log / 錯誤追蹤
+- 支援其他平台
+  - Telegram
+  - Facebook Messenger
+  - Slack
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/line_controller.rb

@@ -4,25 +4,8 @@ class LineController < ApplicationController
   protect_from_forgery with: :null_session
 
   def entry
-    parser = Kamigo::EventParsers::LineEventParser.new
-    events = parser.parse_events(request)
-    events.each do |event|
-      output = process_event(event) || Kamigo.line_default_message
-      responser = Kamigo::EventResponsers::LineEventResponser.new
-      response = responser.response_event(event, output)
-    end
+    request_handler = Kamigo::RequestHandlers::LineRequestHandler.new(request, form_authenticity_token)
+    request_handler.handle
     head :ok
   end
-
-  private
-
-  def process_event(event)
-    Kamigo.line_event_processors.each do |processor|
-      processor.request = request
-      processor.form_authenticity_token = form_authenticity_token
-      output = processor.process(event)
-      return output if output.present?
-    end
-    nil
-  end
 end

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

@@ -0,0 +1,56 @@
+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

data/lib/kamigo.rb

@@ -8,6 +8,8 @@ require "kamigo/events/line_event"
 require "kamigo/event_parsers/line_event_parser"
 require "kamigo/event_responsers/line_event_responser"
 require "kamigo/event_processors/rails_router_processor"
+require "kamigo/request_handlers/line_request_handler"
+
 module Kamigo
   mattr_accessor :line_default_message
   @@line_default_message = {

data/lib/kamigo/event_parsers/line_event_parser.rb

@@ -12,19 +12,37 @@ module Kamigo
       end
 
       def parse(event)
-        payload = JSON.parse(event.to_json, symbolize_names: true)[:src]
-        response = client.get_profile(payload[:source][:userId])
+        event_hash = JSON.parse(event.to_json, symbolize_names: true)
+        payload = event_hash[:src] || event_hash
         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)
         line_event.message_type = payload.dig(:message, :type) || payload.dig(:type)
         line_event.message = payload.dig(:message, :text) || payload.dig(:postback, :data) || payload.dig(:message, :address) || line_event.message_type
+        line_event.profile = get_profile(line_event)
         line_event
       end
+
+      def get_profile(line_event)
+        case line_event.source_type
+        when 'group'
+          response = client.get_group_member_profile(
+            line_event.source_group_id,
+            line_event.source_user_id
+          )
+        when 'room'
+          response = client.get_room_member_profile(
+            line_event.source_group_id,
+            line_event.source_user_id
+          )
+        else
+          response = client.get_profile(line_event.source_user_id)
+        end
+        JSON.parse(response.body)
+      end
     end
   end
 end

data/lib/kamigo/events/basic_event.rb

@@ -13,10 +13,13 @@ module Kamigo
       def platform_params
         {
           platform_type: platform_type,
+          message: message,
+          message_type: message_type,
           source_type: source_type,
           source_group_id: source_group_id,
           source_user_id: source_user_id,
-          profile: profile
+          profile: profile,
+          payload: payload
         }
       end
     end

data/lib/kamigo/request_handlers/line_request_handler.rb

@@ -0,0 +1,32 @@
+module Kamigo
+  module RequestHandlers
+    class LineRequestHandler
+      def initialize(request, form_authenticity_token)
+        @request = request
+        @form_authenticity_token = form_authenticity_token
+      end
+
+      def handle
+        parser = EventParsers::LineEventParser.new
+        events = parser.parse_events(@request)
+        events.each do |event|
+          output = process_event(event) || Kamigo.line_default_message
+          responser = EventResponsers::LineEventResponser.new
+          response = responser.response_event(event, output)
+        end
+      end
+
+      private
+
+      def process_event(event)
+        Kamigo.line_event_processors.each do |processor|
+          processor.request = @request
+          processor.form_authenticity_token = @form_authenticity_token
+          output = processor.process(event)
+          return output if output.present?
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/kamigo/version.rb

@@ -1,3 +1,3 @@
 module Kamigo
-  VERSION = '0.19.0'.freeze
+  VERSION = '0.24.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamigo
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.24.0
 platform: ruby
 authors:
 - etrex
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,40 +30,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.25'
+        version: '0.28'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.28.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.25'
+        version: '0.28'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.28.0
 - !ruby/object:Gem::Dependency
   name: kamiflex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: line-bot-api
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,7 @@ files:
 - lib/generators/kamigo/install_generator.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
@@ -125,6 +126,7 @@ files:
 - lib/kamigo/events/basic_event.rb
 - lib/kamigo/events/line_event.rb
 - lib/kamigo/railtie.rb
+- lib/kamigo/request_handlers/line_request_handler.rb
 - lib/kamigo/version.rb
 homepage: https://github.com/etrex/kamigo
 licenses: