kamigo 0.16.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a082803e8394a9239e446ce0e09ff99a09f160d11806d5c11b63f02ce563f0d
-  data.tar.gz: 396410d5226e1879b1007aea8454b86169dee9c6f14206d795f87fcf8c9af244
+  metadata.gz: 603369132a555eac9c1006ef6c72942613f949a7969062cbb6a1113082cdfa01
+  data.tar.gz: 1723ac2a6317728974b8f8605e244490277851e652732524637ac41ba208bc1a
 SHA512:
-  metadata.gz: fd383becc048eb21156fe66ffa59834b0f77b2e14403bbd972fa1fb9b62fd5be94d5a07b9adb5a9fad3c93f176bff12a0620006ea5c2ca845c6a81e5dcdf361e
-  data.tar.gz: 395a3807def72c42bb2d9f34f8ddb2298b0e22e93d61e4c66b1bd6c6bbcb0f7f5b227127ad27e3ea537bbe6a1b765fb722f4fb8bbed593628faddc23c7701e3a
+  metadata.gz: 12a69d80119b1b44d96c65aa917c4df52cf7103b6588938d1004bc7c110d022bd6d1dc749c88539d93fe734c2916cca73e53bc0d4966dc7997c79331f5778583
+  data.tar.gz: 51e23e962faafa4abd7a7fd153c3187147d1a9bb7f1905f32fda1efeb91ad63db00e1a26d70f41703317423fdf229f0e24f468eeceaeed734dac537c9e574645

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
@@ -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

@@ -1,83 +1,11 @@
 require 'uri'
 
 class LineController < ApplicationController
-  include ReverseRoute
   protect_from_forgery with: :null_session
 
   def entry
-    parser = Kamigo::EventParsers::LineEventParser.new
-    events = parser.parse_events(request)
-    events.each do |event|
-      process_event(event)
-    end
+    request_handler = Kamigo::RequestHandlers::LineRequestHandler.new(request, form_authenticity_token)
+    request_handler.handle
     head :ok
   end
-
-  private
-
-  def process_event(event)
-    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)
-    responser = Kamigo::EventResponsers::LineEventResponser.new
-    response =  responser.response_event(event, output)
-    puts response&.body
-  rescue NoMethodError => e
-    puts e.full_message
-    responser = Kamigo::EventResponsers::LineEventResponser.new
-    response =  responser.response_event(event, {
-      type: "text",
-      text: "404 not found"
-    })
-  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
-    end
-    text = text[http_method.size..-1] if http_method.present?
-    text = text.strip
-    lines = text.split("\n").compact
-    path = lines.shift
-    request_params = parse_json(lines.join(""))
-    request_params[:authenticity_token] = form_authenticity_token
-    http_method = request_params["_method"]&.upcase || http_method || "GET"
-    [http_method, path, request_params]
-  end
-
-  def parse_json(string)
-    return {} if string.strip.empty?
-    JSON.parse(string)
-  end
-
 end

data/lib/generators/kamigo/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Kamigo
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Kamigo initializer and copy locale files to your application."
+
+      def copy_initializer
+        template "kamigo.rb", "config/initializers/kamigo.rb"
+      end
+    end
+  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/generators/templates/kamigo.rb

@@ -0,0 +1,14 @@
+Kamigo.setup do |config|
+  # When user input doesn't match the route, Kamigo will pass the reuqest to default_path with default_http_method.
+  # config.default_path = "/"
+  # config.default_http_method = "GET"
+
+  # When Kamigo don't know what message to reply, then Kamigo reply the line_default_message.
+  # config.line_default_message = {
+  #   type: "text",
+  #   text: "Sorry, I don't understand your message."
+  # }
+
+  # When line_default_message is nil, then Kamigo don't reply message.
+  # config.line_default_message = nil
+end

data/lib/kamigo.rb

@@ -7,6 +7,26 @@ require "kamigo/events/basic_event"
 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
-  # Your code goes here...
+  mattr_accessor :line_default_message
+  @@line_default_message = {
+    type: "text",
+    text: "Sorry, I don't understand your message."
+  }
+
+  mattr_accessor :default_path
+  @@default_path = nil
+
+  mattr_accessor :default_http_method
+  @@default_http_method = "GET"
+
+  mattr_accessor :line_event_processors
+  @@line_event_processors = [EventProcessors::RailsRouterProcessor.new]
+
+  def self.setup
+    yield self
+  end
 end

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/event_processors/rails_router_processor.rb

@@ -0,0 +1,87 @@
+module Kamigo
+  module EventProcessors
+    class RailsRouterProcessor
+      attr_accessor :request
+      attr_accessor :form_authenticity_token
+
+      def initialize
+      end
+
+      def process(event)
+        http_method, path, request_params = kamiform_context(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)
+        return output if output.present?
+
+        return nil if Kamigo.default_path.nil?
+        reserve_route(URI.encode(Kamigo.default_path), http_method: Kamigo.default_http_method, request_params: request_params, format: :line)
+      end
+
+      private
+
+      def kamiform_context(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
+        end
+        text = text[http_method.size..-1] if http_method.present?
+        text = text.strip
+        lines = text.split("\n").compact
+        path = lines.shift
+        request_params = parse_json(lines.join(""))
+        request_params[:authenticity_token] = @form_authenticity_token
+        http_method = request_params["_method"]&.upcase || http_method || "GET"
+        [http_method, path, request_params]
+      end
+
+      def parse_json(string)
+        return {} if string.strip.empty?
+        JSON.parse(string)
+      end
+
+      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?
+        @request.request_parameters = request_params if request_params.present?
+
+        # req = Rack::Request.new
+        # env = {Rack::RACK_INPUT => StringIO.new}
+
+        res = Rails.application.routes.router.serve(@request)
+        res[2].body if res[2].respond_to?(:body)
+      end
+    end
+  end
+end

data/lib/kamigo/event_responsers/line_event_responser.rb

@@ -5,7 +5,7 @@ module Kamigo
 
       def response_event(event, message)
         return nil if message.blank?
-        message = JSON.parse(message) if message.is_a?(String) && message.start_with?("{")
+        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

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.16.0'.freeze
+  VERSION = '0.21.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamigo
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.21.0
 platform: ruby
 authors:
 - etrex
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.25'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.25'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0
 - !ruby/object:Gem::Dependency
   name: kamiflex
   requirement: !ruby/object:Gem::Requirement
@@ -103,26 +103,30 @@ files:
 - README.md
 - 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/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
 - lib/generators/rails/kamigo/templates/show.line.erb
 - lib/generators/rails/scaffold_controller_generator.rb
 - lib/generators/rails/templates/controller.rb
+- lib/generators/templates/kamigo.rb
 - lib/kamigo.rb
 - lib/kamigo/clients/line_client.rb
 - lib/kamigo/engine.rb
 - lib/kamigo/event_parsers/line_event_parser.rb
+- lib/kamigo/event_processors/rails_router_processor.rb
 - lib/kamigo/event_responsers/line_event_responser.rb
 - 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:

data/app/controllers/concerns/reverse_route.rb

@@ -1,16 +0,0 @@
-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?
-    request.request_parameters = request_params if request_params.present?
-
-    # req = Rack::Request.new
-    # env = {Rack::RACK_INPUT => StringIO.new}
-
-    res = Rails.application.routes.router.serve(request)
-    res[2].body
-  end
-end