censor_bear 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 718c2ec6b519d6148ea047125d8a756b3cdc982aba68b4c7ca6d62e73b71a606
-  data.tar.gz: af687db6053250f6da78e3eea1192c648725039158a236472f7e5bcc539226ba
+  metadata.gz: 633c87ffb32b8d53093ad231c1225f96dbd6d5f5bbae634e86c376adc4d0a658
+  data.tar.gz: 1e31ef8885563166f1aa1413fbf427e64dcec9f4ef6ade7bdfcf832bdee79043
 SHA512:
-  metadata.gz: 6f83eae4f76dca1658c2d585f36a2a5419dc49c4e3f3beaeec17fd856a7464035def3b347ecd6ae59b6e4fe31f9ce6d3bae52a9659bc0bbab7cff66219f4d5c6
-  data.tar.gz: 07b471f86713559334a67950d35483f22007005caad6c0aecc93b7cbaa01ecc5cfda3aac7d5d95f6cec37abf38218d67aa18f01965a82c5d9e39a3b6bedccbdb
+  metadata.gz: bab4233caa6eeb78dcee9718d7c794fad31332d0d5b4fea6e3e631d76aabc8a06b4f22d1dc3f0f315bde3ec39f987f025d91f2bdf7cf84dbe4d468f36944835d
+  data.tar.gz: 300054b0879cb6d27a98f9ce7497cd28f9d23cd803b8f2a494a36a49800d98b43525d9f63f277541f7956a262bf0a0ee745b21e63a5499720047dccef3ba8745

data/README.md

@@ -25,13 +25,9 @@ Then execute to copy migrations:
 rails censor_bear:install:migrations
 ```
 
-## 初始化配置
-详细配置项可在`lib/censor_bear/configuration.rb`中查看。
+config in `config/initializers/censor_bear.rb`，configuration items can be found in the `lib/censor_bear/configuration.rb`
 
-### 待办
-- [ ] 用户详情跳转路由 
-
-```ruby
+```rb
 CensorBear.configure do |config|
   config.user_class = 'User'
   config.user_name_method = 'nickname'
@@ -41,7 +37,7 @@ CensorBear.configure do |config|
   config.aliyun_green_enable_internal = false
 
   config.main_app_root_path_method = 'root_path'
-  config.main_app_user_path_method = 'admins_user_path'
+  config.main_app_user_path_method = 'edit_user_password_path'
 end
 ```
 
@@ -95,6 +91,12 @@ censor_undo_approve # 撤销通过审核
 censor_ban_user # 封禁用户
 ```
 
+## origin 工作原理
+
+### 文字
+
+在标记的时候， 首先
+
 ## 用法
 ```ruby
 
@@ -146,7 +148,153 @@ Be sure to render or redirect for unauthorized users.
 
 
 ## Contributing
+
+## 关于 engine 的前端开发
+
+1. 使用了 tailwindcss  简化， 需要在开发的时候运行 yarn watch_tailwind
+
+
 Contribution directions go here.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 2022年07月20日开发要求
+
+StopWord 规定的 type 有 %w[ugc username signature dialog nickname]
+
+### UGC
+censor type 为 ugc
+
+第一优先级为 StopWord, 当 StopWord 为 banned 的时候， 中断处理
+
+接下来是 aliyun 的检测 
+
+当阿里云为 banned 的时候， 中断处理
+
+**中断处理** 即为拒绝发布
+
+
+
+- 
+
+### 个人信息
+
+即 `username`、`signature`、`nickname` 
+
+分为两个部分：
+
+
+#  Text authen
+
+会对文字信息进行两重检测， 分别为 
+
+1. 本地的 stop_word 的检测
+在检测过程中， 如果命中检测， 则会生成对应的日志 censor_log。 命中检测后，结果可能为三种结果： 分别是  `banned`, `replace`, `mod`
+
+当检测结果为 banned 的时候, 会抛出异常 NotPassedException， 整个检测会直接退出
+当检测结果为 replace 的时候, 会更改文字的信息， 替换为安全文字
+
+在模型中  可以直接指定 
+
+`text_authen :对应字段, type: , options = {}`
+
+**options  可选参数**
+
+- callback_func_when_mod  方法名称， 即当检测为结果为 mod 的时候， 可以接的钩子方法
+- ignore_aliyun_check 是否忽略阿里云的检测
+- save_log 是否存日志
+
+## 示例
+
+```ruby
+class Post
+  text_authen :content, type: :ugc, callback_func_when_mod: :callback_func_when_mod
+
+  def callback_func_when_mod(result, options)
+    # options 即为检查时候的options   result 为  Censor 中的 Result
+  end
+end
+```
+
+即检测 模型的 `content` 字段
+
+
+# Image Authen
+
+会对图像进行审核 ， 注意，由于大部分图像都是需要进行一定的加密算法， 故图像不会像text_authen 一样直接指定对应的  attribute, 而是需要实现一个方法来进行生成图片的url
+
+每当对应模型 保存成功（after_save）后， 系统会调用模型的 `fetch_need_censor_image_urls` 方法 获取需要审核的图片 urls   而该方法会寻找 指定的`aliyun_image_authen` 的 options 参数 `fetch_urls_func` 的方法返回的urls. 我们可以在模型中复写 `censor_images_trigger_condition` 来指定检测的条件， 如果返回 true， 则会触发检测。
+
+## 调用方法
+
+分下列几部调用
+
+1. 在模型上使用 `aliyun_image_authen`
+
+```ruby
+aliyun_image_authen type: "对应 type", options 
+```
+
+
+**options 可选参数**
+- scenes  默认检测场景， 如不填写， 则默认 ["porn", "terrorism"] 
+- callback_url 阿里云检测后的回调的地址， 如果不填写， 则默认是 "#{CensorBear.config.aliyun_green_callback_domain}/censor_bear/aliyun_check/image_callback". 注意， 这里的默认地址已经包含了对阿里云的返回进行标准格式化， 并将结果传输至 model 的 `image_censor_answer_func(image_censor_answer_dict)`
+- fetch_urls_func 获得审核 urls 的方法, 因为大多数情况， 图片的地址是需要计算出授权地址的， 所以需要一个计算后， 才能拿到 url
+
+
+
+2. 根据情况 对模型复写以下方法`image_censor_answer_func(image_censor_answer_dict)`。
+该方法是 当阿里云发送回调， CensorBear 处理完其格式后， 对模型进行的一个调用。我们可以根据这个image_censor_answer_dict, 对业务场景进行编辑， 比如 直接删除， 或者替换 url（为何不自动化处理 替换 url? 因为 image_url 是算出来的具有时效性的，而不是直接存储在属性里的， 为保持灵活性， 所以没做自动化处理）
+
+
+# 直接调用方式
+
+直接调用方式则可以在 各种 rake 中直接进行检测
+
+## text authen
+
+```ruby
+CensorBear::Censor.new(content, type, options).check_text
+
+# 其中 options 需要指定 record， 如对 current_user 的自我介绍进行扫描
+# 则需要 options[:record] = current_user
+
+User.all.each do |user|
+  CensorBear::Censor.new(user.profile_content, "ugc", record: user).check_text
+  # 若想跨过阿里云检测， 只进行本地测试， 则可以
+  CensorBear::Censor.new(user.profile_content, "ugc", record: user, ignore_aliyun_check: true).check_text
+end
+
+```
+
+
+## image authen
+
+```ruby
+CensorBear::Censor.new(image_urls, type, options).check_image
+
+
+
+Post.all.each do |post|
+  CensorBear::Censor.new(post.image_urls, "ugc", record: post).check_image
+end
+
+```
+
+
+
+
+# 要求
+1. 针对 UGC 内容，通过 censor bear 在发布之前检测
+  1. 是否有踩红线的文本内容，有的话直接拒绝发布
+  2. 没有踩红线但是有模糊不好确定的（通过返回的检测结果类别断定），经过标记后人工复查
+  3. 判断配图是否合法，可以放到异步任务中触发，有问题在展示的时候直接阻断显示 放 内容违规 默认占位图，发送站内信
+  4. 定期通过rake任务，扫描已发布内容，标记出有问题的内容，人工处理
+2. 针对用户个人信息，创建 和 编辑用户个人资料时检测
+  1. 检测昵称、个人信息有违规 创建时直接重置为随机字串(不打断用户注册流程)，编辑时则报错拒绝保存
+  2. 头像、个人页背景图异步检测，也是在创建、编辑时触发，有问题则直接阻断重置头像、背景图为默认图片，发送站内信
+  3. 定期通过rake任务，扫描已注册用户信息，标记出有问题的内容，人工处理
+
+
+  

data/Rakefile

@@ -15,4 +15,8 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
+task :console do
+  exec "pry	-r censor_bear -I ./lib"
+end
+
 task default: :test