customer_service_im 0.11.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2b3772c30a1022d27d4b3110b09e3a451d5899016fdf59a1d36293c5e6f3eb6
-  data.tar.gz: 19bf4342fa89caf4bf3e5e35ef9e0c11cbe270654d5c001ba98d6ba65f0decf4
+  metadata.gz: 361eef1d405d594d4623b8f5918e8832f5c08bae60a78b0383cdf1d066b02a21
+  data.tar.gz: 5622634866a2d0c12b12c710a37d88a4bf30a4e5660836d3d3baad341ef97f6e
 SHA512:
-  metadata.gz: 5c65da60c3ed1e4262599a5b26d5bd6ce9dfebb0961b188e35db97c244551e7280cbe2425b82b75ebd150dfda6d8a2e0251e232ce2e93c2a5410958f7e7fac1a
-  data.tar.gz: ca2c7cfe0de0a82658e928f69d11162454b3e05be82d29bb41bf328eed42bd71e29fa9fa8597e81a0f7a6ffe28e630eb0b264efda0e4d193558618d0c476fb77
+  metadata.gz: de3b926211144172238515e1d96775e4b75f6017e1ec02d91dca5c18d9c6ebb39a979c8935d13299396da4714cc30740461683f2d38e785579d03d01dfb11df6
+  data.tar.gz: 26dc6a611ade6678afcf6dbd536d4d0112a4dfc2b4d8661753260c59a9cdc3cb181248bd27ef1bbecdf7d1dfae874ef5a16f16485cc6b6994f2b635426a88d41

data/README.md

@@ -1,26 +1,89 @@
 # 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. 修改`config/cable.yml`中的配置，全部的 adapter 都改为 redis
+
+```yml
+development:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+
+```
+
+7. 安装 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
+```
+
+## 部署注意事项
+
+- 反向代理的配置
+- redis 的配置
+- `config/cable.yml`的配置
+
 ## Contributing
 Contribution directions go here.
 

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/conversation.rb

@@ -4,6 +4,8 @@ module CustomerServiceIm
     belongs_to :user, polymorphic: true
     belongs_to :staff, optional: true
 
+    after_create :broadcast_to_channel
+
     # validates_presence_of :title
 
     def last_message

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.11.0'
+  VERSION = '0.15.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/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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customer_service_im
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.15.0
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -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