customer_service_im 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3331358c3827e2c1f00ce50f8ea26e1196f104f0237c3cf74c48bbd469c5c8f
-  data.tar.gz: e0372649abf50bbcf264a7966ff54cb2cddc4399833652693625bbf52e3f2260
+  metadata.gz: 3fabb9e1f4f4302eb3d1a50a44be2fb9aef4eff4d8ddc3868e7599d3d57192d4
+  data.tar.gz: cc468ad78fb41e22a185372ea22c88d1193c96dabde202b6e1613c0b7708910f
 SHA512:
-  metadata.gz: 199fb439a35875227e7aabaff3cfee31785dba41ab33709b4763fd443029f552e8c6fe84760172dda276aef9fd6f78a18ca6db8377b78c792b827103cd6ca10d
-  data.tar.gz: e5501c757b45ed71af55a5c16066223a186d88a0ae2e5a6196867b16476fd8f1588c4b23d6b5a566d72eb1e55a9509ca1915040808282fd87de2b947fcec1f19
+  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/lib/customer_service_im/version.rb

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

data/lib/customer_service_im.rb

@@ -16,8 +16,6 @@ module CustomerServiceIm
   def self.setup
     if block_given?
       yield self
-      MiniProgram.appid = appid
-      MiniProgram.app_secret = app_secret
       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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: customer_service_im
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - ian