kamigo 0.15.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fafd4faec131e7521901c951025fff9e4aad7f6612ad53c0e84e0376b4b29138
-  data.tar.gz: a3488e005a42c3f635d1ec09b0ec648dbbdcc60b7846f55f14da5d7ef716ae9f
+  metadata.gz: 7378b8ac81d656a0279ae87d084410ff9ac89944054ad6f26a2571e94a3cf694
+  data.tar.gz: 3ca981698b7693e4ff20e3fd45bb38a47b60fa4b7fe20d57339997764609d286
 SHA512:
-  metadata.gz: a42acfa7783e9081d34a556fe2017b1d6bf4391bba2377c3101fa1972aceb9f2714ccee174d40dd27fc58d9999d485bb0b0b182f0ce73f7424d03307a8b5f1c8
-  data.tar.gz: 8b429eec098ada0cd1ad72e85b1034b51c58349a29dcf76bbc8e66dd904c51824d268e3bd76dcf63fad521a8ba52df6d511beaadbd8f47bd6f2dfeba388ad4a6
+  metadata.gz: 505d6d3f8d32b016d0dbd72b3d35af48a065631a500d34575eff79fc1916f203395f6b7d60439ed9633b1c973ce840d1d02b9da7778c46719232ac8bf9e40ab4
+  data.tar.gz: 414c7828e10aea9c7c74a62b4c2dab36ab8e798c56f61bf2696c6ce51750e1e8083dd3d7d268ea38e855513f535a57a43a2ad4549cfc65d6a89d534cac4de4fc

data/README.md

@@ -18,6 +18,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
@@ -147,9 +149,15 @@ Kamigo 預設使用基本的語意理解模型，會將使用者輸入視為在
 
 # 計畫
 - 提供多種語意理解模型串接
+  - 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/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,7 +12,8 @@ module Kamigo
       end
 
       def parse(event)
-        payload = JSON.parse(event.to_json, symbolize_names: true)[:src]
+        event_hash = JSON.parse(event.to_json, symbolize_names: true)
+        payload = event_hash[:src] || event_hash
         response = client.get_profile(payload[:source][:userId])
         line_event = Kamigo::Events::LineEvent.new
         line_event.payload = payload

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.15.0'.freeze
+  VERSION = '0.20.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamigo
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.20.0
 platform: ruby
 authors:
 - etrex
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-06 00:00:00.000000000 Z
+date: 2021-04-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.21'
+        version: '0.25'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.25'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.25.0
 - !ruby/object:Gem::Dependency
   name: kamiflex
   requirement: !ruby/object:Gem::Requirement
@@ -103,10 +103,10 @@ 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/templates/edit.liff.erb
@@ -115,14 +115,17 @@ files:
 - 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