kamigo 0.32.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d15e3dc7411c04c32ef80effe128552d278a41abf7447f5f1e62c6c3244ec00
-  data.tar.gz: 6d3a3b34f99195d4e512d8b636f5f569887028cb79f0482c525608dae63b13df
+  metadata.gz: 99c87ea21c2cb09558c1df023ee44f556df03e7db35c26e1e6b7bea33b017d1f
+  data.tar.gz: deed64bef99684260407e97415f0e7804663de6c756d23fd8b2ef213933363ed
 SHA512:
-  metadata.gz: 1decc3bee52276e5ed150834654f6e6620cc299c6053e2360f979c67e70b258395aed6c948e069a10903f9066c40de3ab0ed6c1dd7c4875070bb081d90f965a8
-  data.tar.gz: bb2dd6bee47627e8bf1f556f2df6f917abb06e17fc4376380cf7396c8f3a776f075deae0c3063bd19b6b102553e10f7ebecc9db9df25fc6872d48fe4278d0940
+  metadata.gz: 98ffb73592c2f9e7626000ca92fcc34995861107f264309ee62d0a213aaa8045be2df837f48482bfb10525ce6a2b8af8f878357b14537f12b19140885dc2343e
+  data.tar.gz: c74d894eb19f681c87650b139bfcc42e438392b045cd0f83686bcd76d22acac645e101b5fce573fdfc35fabf4b9c2b7a35f22db59c561004c0da4c3ec16e5254

data/README.md

@@ -133,6 +133,91 @@ LIFF_FULL=這裡填入你的 FULL_LIFF_URL
 - `LINE_CHANNEL_ACCESS_TOKEN` 可以在 Messaging API 後台的 Messaging API 分頁中找到。
 - `COMPACT_LIFF_URL`、`TALL_LIFF_URL` 和 `FULL_LIFF_URL` 需要到 LINE 後台的 LIFF 分頁新增後，即可獲得一組 LIFF URL。
 
+# 進階設定
+
+在 `config/initializers/kamigo.rb` 中，你可以自訂各種設定：
+
+```ruby
+Kamigo.setup do |config|
+  # LINE Messaging API 設定
+  # 預設會從環境變數讀取，但你也可以直接在這裡設定
+  # config.line_messaging_api_channel_id = "your_channel_id"
+  # config.line_messaging_api_channel_secret = "your_channel_secret"
+  # config.line_messaging_api_channel_token = "your_channel_token"
+
+  # 當使用者輸入不符合路由時的預設路徑和 HTTP 方法
+  # config.default_path = "/"
+  # config.default_http_method = "GET"
+
+  # 當 Kamigo 不知道如何回應時，會回覆這個訊息
+  # config.line_default_message = {
+  #   type: "text",
+  #   text: "Sorry, I don't understand your message."
+  # }
+  # 設為 nil 則不回覆訊息
+
+  # 設定訊息處理器，可以自訂處理邏輯
+  # config.line_event_processors = [
+  #   EventProcessors::RailsRouterProcessor.new,
+  #   EventProcessors::DefaultPathProcessor.new,
+  #   EventProcessors::DefaultMessageProcessor.new
+  # ]
+end
+```
+
+# 自定義訊息處理器（Event Processor）
+
+Kamigo 允許你自定義訊息處理器來處理 LINE 的訊息。每個處理器都需要實作 `process` 方法，該方法接收一個 `event` 參數並回傳處理結果。
+
+以下是一個簡單的處理器範例：
+
+```ruby
+module Kamigo
+  module EventProcessors
+    class MyCustomProcessor
+      # 處理器可以存取 request 物件
+      attr_accessor :request
+      
+      def process(event)
+        # event 物件包含以下資訊：
+        # - event.platform_type    # 平台類型（例如：line）
+        # - event.message         # 使用者發送的訊息
+        # - event.platform_params # 平台相關的參數
+        # - event.source_group_id # 群組 ID（如果是群組訊息）
+        
+        # 在這裡實作你的處理邏輯
+        return nil if event.message != "hello"  # 返回 nil 表示不處理此訊息
+        
+        # 返回要回覆給使用者的訊息（支援 LINE Messaging API 的所有訊息格式）
+        {
+          type: "text",
+          text: "Hello! 你好！"
+        }
+      end
+    end
+  end
+end
+
+# 在 config/initializers/kamigo.rb 中註冊你的處理器
+Kamigo.setup do |config|
+  config.line_event_processors = [
+    # 你可以完全自定義處理器順序
+    EventProcessors::MyCustomProcessor.new,
+    EventProcessors::RailsRouterProcessor.new,
+    EventProcessors::DefaultPathProcessor.new,
+    EventProcessors::DefaultMessageProcessor.new
+  ]
+end
+```
+
+處理器會按照註冊順序依次處理訊息，直到某個處理器返回非 nil 的結果。這讓你可以：
+
+1. 建立特定關鍵字的回應
+2. 實作自定義的語意理解
+3. 整合第三方 NLP 服務
+4. 處理特殊類型的訊息（圖片、音訊等）
+5. 實作多輪對話
+
 Kamigo 預設的 LIFF Size 為 Compact，你也可以只新增 Compact LIFF URL。
 詳細的 LIFF 設定說明可以服用此帖 [LIFF 設定 QA](/doc/07_setting.md#LIFF-設定-QA)。
 

data/lib/generators/templates/kamigo.rb

@@ -13,5 +13,18 @@ Kamigo.setup do |config|
   # config.line_default_message = nil
 
   # When Kamigo receive a request, then Kamigo will process the request with the following processors.
-  # config.line_event_processors = [Kamigo::EventProcessors::RailsRouterProcessor.new]
+  # config.line_event_processors = [
+  #   EventProcessors::RailsRouterProcessor.new,
+  #   EventProcessors::DefaultPathProcessor.new,
+  #   EventProcessors::DefaultMessageProcessor.new
+  # ]
+
+  # LINE Messaging API configuration
+  # By default, these values are read from environment variables:
+  # LINE_CHANNEL_ID, LINE_CHANNEL_SECRET, and LINE_CHANNEL_TOKEN
+  # You can override them here if needed:
+  #
+  # config.line_messaging_api_channel_id = "your_channel_id"
+  # config.line_messaging_api_channel_secret = "your_channel_secret"
+  # config.line_messaging_api_channel_token = "your_channel_token"
 end

data/lib/kamigo/event_parsers/line_event_parser.rb

@@ -41,7 +41,6 @@ module Kamigo
         else
           response = client.get_profile(line_event.source_user_id)
         end
-        debugger
         JSON.parse(response.body)
       end
     end

data/lib/kamigo/version.rb

@@ -1,3 +1,3 @@
 module Kamigo
-  VERSION = '0.32.0'.freeze
+  VERSION = '0.34.0'.freeze
 end

data/lib/kamigo.rb

@@ -32,22 +32,15 @@ module Kamigo
     EventProcessors::DefaultMessageProcessor.new
   ]
 
-  # env
-  mattr_writer :line_messaging_api_channel_id
-  mattr_writer :line_messaging_api_channel_secret
-  mattr_writer :line_messaging_api_channel_token
+  # LINE Messaging API configuration
+  mattr_accessor :line_messaging_api_channel_id
+  @@line_messaging_api_channel_id = ENV["LINE_CHANNEL_ID"]
 
-  def self.line_messaging_api_channel_id
-    @@line_message_api_channel_id = ENV["LINE_CHANNEL_ID"]
-  end
-
-  def self.line_messaging_api_channel_secret
-    @@line_message_api_channel_secret = ENV["LINE_CHANNEL_SECRET"]
-  end
+  mattr_accessor :line_messaging_api_channel_secret
+  @@line_messaging_api_channel_secret = ENV["LINE_CHANNEL_SECRET"]
 
-  def self.line_messaging_api_channel_token
-    @@line_message_api_channel_token = ENV["LINE_CHANNEL_TOKEN"]
-  end
+  mattr_accessor :line_messaging_api_channel_token
+  @@line_messaging_api_channel_token = ENV["LINE_CHANNEL_TOKEN"]
 
   class << self
     delegate :line_login_channel_id, :line_login_channel_id=, to: :Kamiliff

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: kamigo
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.34.0
 platform: ruby
 authors:
 - etrex
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,16 +81,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description: a chatbot framework based on rails
 email:
 - et284vu065k3@gmail.com
@@ -134,7 +133,6 @@ homepage: https://github.com/etrex/kamigo
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: a chatbot framework based on rails
 test_files: []