customer_service_im 0.10.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2dd05d754f2c0fdef94d03909c647a3526c88b2f9ff0bf27d9f0c460129e191
-  data.tar.gz: e5ff5baf24b770f783d4b3ff4864f6cab892eb645994ac8ccb055e8582a24c2f
+  metadata.gz: 3fabb9e1f4f4302eb3d1a50a44be2fb9aef4eff4d8ddc3868e7599d3d57192d4
+  data.tar.gz: cc468ad78fb41e22a185372ea22c88d1193c96dabde202b6e1613c0b7708910f
 SHA512:
-  metadata.gz: 94689790e700a4ef5ef4a6b89433e7901e16f3321a65f4641d9e1be8cec6b2fe4f44a807fe433483d09852826985a95f47dba379cba36a4df8744843f348983f
-  data.tar.gz: 60ad6be2532af183377e57d85e7edb20700ae85a4d5d1e087a73a8a7f2f57478695172556651fa4bbb7993fcd5313a015586438bf9365d026635e40ecb339980
+  metadata.gz: ab10c8a0820d38e14a8b6a0fd543bcbca431cb2a44b6bcc54a12debb13cc9e95d1f9fb688ed867672804deae6a927b6af322bdf7ae45331320e048e989c2871c
+  data.tar.gz: 4ee88b2022a1216cca8a3280cd0e5b82530ab4d262f85014a16792e8d465f07d019c9959112f39a4461a4ae72f69143a30a3ab66cc56160bcc0978ea2d8e7169

data/README.md

@@ -1,24 +1,72 @@
 # CustomerServiceIm
-Short description and motivation.
+客服 Engine
 
 ## Usage
 How to use my plugin.
 
 ## Installation
-Add this line to your application's Gemfile:
 
+1. 在`Gemfile`里边添加如下代码
 ```ruby
 gem 'customer_service_im'
 ```
 
-And then execute:
+2. 安装 gem 
 ```bash
-$ bundle
+$ bundle i
 ```
 
-Or install it yourself as:
+3. 执行 Engine 安装的命令
 ```bash
-$ gem install customer_service_im
+rails g customer_service_im:install
+```
+
+4. 修改`config/initializers/customer_service_im.rb`里边的配置信息，小程序配置和腾讯语音识别配置
+
+5. 安装 Engine 迁移
+```bash
+ rails customer_service_im:install:migrations
+```
+
+6. 安装 `ActiveStorage` ，如果宿主应用已安装则可跳过，操作冪等，可重复执行
+```bash
+rails active_storage:install
+```
+
+7. 执行迁移文件
+```bash
+rails db:migrate
+```
+
+8. 删除宿主应用的`app/channels`，目前没有好的解决方案，暂时先这样
+
+9. 配置对应环境`websocket`域名白名单，如`config/initializers/development.rb`
+```ruby
+Rails.application.configure do
+  # ...
+  # config.action_cable.allowed_request_origins = [/http:\/\/*/, /https:\/\/*/]
+  config.action_cable.allowed_request_origins = [/http:\/\/example\.com/, /https:\/\/example\.com/]
+  # ...
+end
+```
+
+10. 挂载 engine ，在`config/routes.rb`中添加
+```ruby
+mount CustomerServiceIm::Engine => "/customer_service"
+```
+
+11. 设置对应环境（如：`config/initializers/development.rb`）的默认 host 地址，用于拼接语音识别文件的 url 地址，必须外网能够访问
+```ruby
+Rails.application.configure do
+  # ...
+  Rails.application.routes.default_url_options[:host] = ENV.fetch("DEFAULT_HOST", "https://demo.mini-geek.com")
+  # ...
+end
+```
+
+12. 启用服务
+```bash
+$ rails s -b 0.0.0.0
 ```
 
 ## Contributing

data/app/models/customer_service_im/concerns/customer.rb

@@ -77,7 +77,6 @@ module CustomerServiceIm::Concerns::Customer
 
       User.create_with(
         email: "#{SecureRandom.uuid}@mp.com",
-        password: Digest::MD5.hexdigest(open_id)
       ).find_or_create_by(open_id: open_id)
     end
   end

data/app/models/customer_service_im/message.rb

@@ -82,7 +82,7 @@ module CustomerServiceIm
       else
         logger = Logger.new Rails.root.join("log/speech_recognition.log")
         logger.error result.errors
-        raise TsrRecognizeError.new(result.errors)
+        raise CustomerServiceIm::AsrRecognizeError.new(result.errors)
       end
     end
 

data/config/initializers/tx_asr.rb

@@ -1,12 +1,6 @@
 
 TxAsr.setup do |config|
 
-  # TODO 需要将 secret_key 和 secret_id 改为你实际项目中的配置
-  config.secret_key = "JL6amhMkqfDVWGjuoRp1DI8j48wTnunQ"
-  config.secret_id = "AKIDta1B5i49yXpqb5HCqELBk35qJWS7VcS1"
-  config.region = "ap-guangzhou"
-
-
   # 声音格式： 支持 mp3 和 wav
   config.voice_format = "mp3"
 

data/lib/customer_service_im/asr_recognize_error.rb

@@ -0,0 +1,4 @@
+
+module CustomerServiceIm
+  class AsrRecognizeError < StandardError; end
+end

data/lib/customer_service_im/version.rb

@@ -1,3 +1,3 @@
 module CustomerServiceIm
-  VERSION = '0.10.0'
+  VERSION = '0.14.0'
 end

data/lib/customer_service_im.rb

@@ -1,6 +1,7 @@
 require "customer_service_im/version"
 require "customer_service_im/engine"
 require "customer_service_im/core_ext"
+require "customer_service_im/asr_recognize_error"
 # require 'shoulda'
 require "jwt"
 require 'jbuilder'
@@ -10,11 +11,14 @@ require 'mini_program'
 
 module CustomerServiceIm
   # Your code goes here...
-  mattr_accessor :appid, :app_secret, :jwt_secret
+  mattr_accessor :appid, :app_secret, :jwt_secret, :asr_config
 
   def self.setup
     if block_given?
       yield self
+      TxAsr.secret_key = asr_config&.fetch(:secret_key, :blank_asr_secret_key)
+      TxAsr.secret_id = asr_config&.fetch(:secret_id, :blank_asr_secret_id)
+      TxAsr.region = asr_config&.fetch(:region, :blank_asr_region)
     end
   end
 end

data/lib/generators/customer_service_im/install/install_generator.rb

@@ -3,6 +3,6 @@ class CustomerServiceIm::InstallGenerator < Rails::Generators::Base
 
   def copy_initializer
     copy_file "initializer.rb", "config/initializers/customer_service_im.rb"
-    rake "g mini_program:install"
+    generate "mini_program:install"
   end
 end

data/lib/generators/customer_service_im/install/templates/initializer.rb

@@ -3,4 +3,11 @@ CustomerServiceIm.setup do |config|
   config.jwt_secret = Rails.application.secret_key_base
   config.appid = "xxx"
   config.app_secret = "x1x"
+
+  # tencent asr config
+  config.asr_config = {
+    secret_key: "tencent asr secret key",
+    secret_id: "tencent asr secret id",
+    region: "tencent asr "
+  }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: customer_service_im
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.14.0
 platform: ruby
 authors:
 - ian
@@ -189,6 +189,7 @@ files:
 - db/migrate/20211026062727_add_password_digest_to_customer_service_im_staffs.rb
 - db/migrate/20211026062951_add_email_to_customer_service_im_staffs.rb
 - lib/customer_service_im.rb
+- lib/customer_service_im/asr_recognize_error.rb
 - lib/customer_service_im/core_ext.rb
 - lib/customer_service_im/engine.rb
 - lib/customer_service_im/version.rb
@@ -196,7 +197,6 @@ files:
 - lib/generators/customer_service_im/install/install_generator.rb
 - lib/generators/customer_service_im/install/templates/initializer.rb
 - lib/tasks/customer_service_im_tasks.rake
-- lib/tsr_recognize_error.rb
 homepage: https://github.com/bkyz/customer_service_im
 licenses:
 - MIT

data/lib/tsr_recognize_error.rb

@@ -1,2 +0,0 @@
-
-class TsrRecognizeError < StandardError; end