aliyun_green 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f696160ff4a798786b7aeb95ab6f311408f6110a43eab6135be4cf049b998a
-  data.tar.gz: 9380d90805a1c12a820a238eb0fdd8c44015ecce3bac434f8b2a5e5b55926111
+  metadata.gz: fc37a068c947eb1e894dcaae9057e1ff450496d5ccb43791cbecd40c4a7e8bf5
+  data.tar.gz: 233a42a6e475f68000cf39ee12db7e4ba0c5d519e7b0f0cffb596d135be69072
 SHA512:
-  metadata.gz: b9b0b9297d363b52c750070ff99c43ed369685d9ee85c74b46f6c286fb9cbb8a0e5a8eb0e926d9cb1d5abc72d150a3fb1fb5afa63711f6a9a49f1415eb5cb243
-  data.tar.gz: 77ce87b6864fbdebc6f481657265919921d9267b14aa52c4714e0c05caf85f34809030eca00e7c8bcbb53f7a7b554de05dc42783d6ea96cdbf57d7c4a8908264
+  metadata.gz: 61eeb56ce1f7b582cc6b52ed02c64fd1e745676976acd9855f17e96ff8eedbf4c8ffbf6e3f67734ce170c0288e5aaf84cf63dc49a0908e21be3b28e6f84b3c6f
+  data.tar.gz: 0c98e28f2fe30c5ce639a842e242bde5a66d2cafc365ac99078c87a34388d65dc619ad5a95c7c8bfc3e370faeddc40ab12a0cc38763eb0030870b18bdcb9e1a1

data/Gemfile.lock

@@ -1,17 +1,18 @@
 PATH
   remote: .
   specs:
-    aliyun_green (0.1.1)
+    aliyun_green (0.1.4)
       httpx
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
     http-2-next (0.5.0)
-    httpx (0.18.1)
+    httpx (0.21.1)
       http-2-next (>= 0.4.1)
     method_source (1.0.0)
     parallel (1.21.0)
@@ -53,10 +54,12 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-21
 
 DEPENDENCIES
   aliyun_green!
   bundler
+  byebug
   pry (~> 0.14.1)
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -1,8 +1,13 @@
 # AliyunGreen
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aliyun_green`. To experiment with that code, run `bin/console` for an interactive prompt.
+基于 阿里云的 内容审核
+
+具体参见 [阿里云内容审核](https://help.aliyun.com/document_detail/84456.html?spm=a2c4g.11186623.0.0.7662754aWakeeW)
+
+记得在使用前， 请在阿里云的“内容安全” => “设置” => "机器审核" 的 default 场景中， 点击编辑
+之后在图片和文字选项卡里， 开启各种识别类型， 并保存
+
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +27,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+具体可参见 spec/aliyun_green_spec.rb 的测试用例
 
 ## Development
 

data/Rakefile

@@ -10,3 +10,7 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+task :console do
+  exec "pry	-r aliyun_green -I ./lib"
+end

data/aliyun_green.gemspec

@@ -3,15 +3,15 @@
 require_relative "lib/aliyun_green/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "aliyun_green"
-  spec.version       = AliyunGreen::VERSION
-  spec.authors       = ["42up"]
-  spec.email         = ["foobar@v2up.com"]
+  spec.name = "aliyun_green"
+  spec.version = AliyunGreen::VERSION
+  spec.authors = ["42up"]
+  spec.email = ["foobar@v2up.com"]
 
-  spec.summary       = "Write a short summary, because RubyGems requires one."
-  spec.description   = "Write a longer description or delete this line."
-  spec.homepage      = "https://github.com/42up/aliyun_green"
-  spec.license       = "MIT"
+  spec.summary = "Write a short summary, because RubyGems requires one."
+  spec.description = "Write a longer description or delete this line."
+  spec.homepage = "https://github.com/42up/aliyun_green"
+  spec.license = "MIT"
   spec.required_ruby_version = ">= 2.4.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
@@ -27,9 +27,10 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'httpx'
-end
+  spec.add_dependency "httpx"
+  spec.add_development_dependency "byebug"
+end

data/lib/aliyun_green/client.rb

@@ -6,39 +6,33 @@ require "time"
 
 module AliyunGreen
   class Client
-    attr_accessor :endpoint, :api_version, :access_key_id,:access_key_secret, :enable_internal
+    attr_accessor :endpoint, :api_version, :access_key_id, :access_key_secret, :enable_internal
 
     def initialize(config)
-      self.endpoint          = config[:endpoint]
-      self.api_version       = config[:api_version]
-      self.access_key_id     = config[:access_key_id]
+      self.endpoint = config[:endpoint]
+      self.api_version = config[:api_version]
+      self.access_key_id = config[:access_key_id]
       self.access_key_secret = config[:access_key_secret]
-      self.enable_internal   = config[:enable_internal]
+      self.enable_internal = config[:enable_internal]
     end
 
-    def post(uri , tasks, params = {})
-      payload = {
-        bizType: 'default',
-        scenes: ["antispam"],
-        tasks: tasks
-      }
-
+    def post(uri, payload, params = {})
       url = "https://#{get_host(self.endpoint)}#{uri}"
 
       mix_headers = default_headers
       request_body = payload.to_json
 
-      mix_headers['content-md5']    = Digest::MD5.base64digest request_body
-      mix_headers['content-length'] = request_body.length.to_s
+      mix_headers["content-md5"] = Digest::MD5.base64digest request_body
+      mix_headers["content-length"] = request_body.length.to_s
 
-      string2sign = string_to_sign('/green/text/scan', mix_headers, params)
+      string2sign = string_to_sign(uri, mix_headers, params)
       mix_headers.merge!(authorization: authorization(string2sign))
 
       response = HTTPX.with(headers: mix_headers).post(url, body: payload.to_json)
 
-      r =  JSON.parse(response)
+      r = JSON.parse(response)
 
-      raise AliyunGreen::Error::SignatureDoesNotMatchError if r["Code"] == 'SignatureDoesNotMatch'
+      raise AliyunGreen::Error::SignatureDoesNotMatchError if r["Code"] == "SignatureDoesNotMatch"
       raise AliyunGreen::Error::ClientError.new(r["msg"], r["code"]) if r["code"] != 200
 
       r
@@ -46,22 +40,22 @@ module AliyunGreen
 
     def string_to_sign(uri, headers, query = {})
       header_string = [
-        'POST',
-        headers['accept'],
-        headers['content-md5'] || '',
-        headers['content-type'] || '',
-        headers['date'],
+        "POST",
+        headers["accept"],
+        headers["content-md5"] || "",
+        headers["content-type"] || "",
+        headers["date"],
       ].join("\n")
       "#{header_string}\n#{canonicalized_headers(headers)}#{canonicalized_resource(uri, query)}"
     end
 
     def canonicalized_headers(headers)
-      headers.keys.select { |key| key.to_s.start_with? 'x-acs-' }
+      headers.keys.select { |key| key.to_s.start_with? "x-acs-" }
         .sort.map { |key| "#{key}:#{headers[key].strip}\n" }.join
     end
 
     def canonicalized_resource(uri, query_hash = {})
-      query_string = query_hash.sort.map { |key, value| "#{key}=#{value}" }.join('&')
+      query_string = query_hash.sort.map { |key, value| "#{key}=#{value}" }.join("&")
       query_string.empty? ? uri : "#{uri}?#{query_string}"
     end
 
@@ -70,35 +64,35 @@ module AliyunGreen
     end
 
     def signature(string_to_sign)
-      Base64.encode64(OpenSSL::HMAC.digest('sha1', self.access_key_secret, string_to_sign)).strip
+      Base64.encode64(OpenSSL::HMAC.digest("sha1", self.access_key_secret, string_to_sign)).strip
     end
 
     def default_headers
       default_headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json',
-        'date' => Time.now.httpdate,
-        'host' => get_host(self.endpoint),
-        'x-acs-version' => self.api_version,
-        'x-acs-signature-nonce' => SecureRandom.hex(16),
-        'x-acs-signature-version' => '1.0',
-        'x-acs-signature-method' => 'HMAC-SHA1',
+        "accept" => "application/json",
+        "content-type" => "application/json",
+        "date" => Time.now.httpdate,
+        "host" => get_host(self.endpoint),
+        "x-acs-version" => self.api_version,
+        "x-acs-signature-nonce" => SecureRandom.hex(16),
+        "x-acs-signature-version" => "1.0",
+        "x-acs-signature-method" => "HMAC-SHA1",
       }
       default_headers
     end
 
     def get_host(endpoint)
       externals = {
-        'cn-shanghai' => 'green.cn-shanghai.aliyuncs.com',
-        'cn-beijing' => 'green.cn-beijing.aliyuncs.com',
-        'cn-shenzhen' => 'green.cn-shenzhen.aliyuncs.com',
-        'ap-southeast-1' => 'green.ap-southeast-1.aliyuncs.com'
+        "cn-shanghai" => "green.cn-shanghai.aliyuncs.com",
+        "cn-beijing" => "green.cn-beijing.aliyuncs.com",
+        "cn-shenzhen" => "green.cn-shenzhen.aliyuncs.com",
+        "ap-southeast-1" => "green.ap-southeast-1.aliyuncs.com",
       }
       internals = {
-        'cn-shanghai' => 'green-vpc.cn-shanghai.aliyuncs.com',
-        'cn-beijing' => 'green-vpc.cn-beijing.aliyuncs.com',
-        'cn-shenzhen' => 'green-vpc.cn-shenzhen.aliyuncs.com',
-        'ap-southeast-1' => 'green-vpc.ap-southeast-1.aliyuncs.com'
+        "cn-shanghai" => "green-vpc.cn-shanghai.aliyuncs.com",
+        "cn-beijing" => "green-vpc.cn-beijing.aliyuncs.com",
+        "cn-shenzhen" => "green-vpc.cn-shenzhen.aliyuncs.com",
+        "ap-southeast-1" => "green-vpc.ap-southeast-1.aliyuncs.com",
       }
       if self.enable_internal
         internals[endpoint]
@@ -107,4 +101,4 @@ module AliyunGreen
       end
     end
   end
-end
+end

data/lib/aliyun_green/image.rb

@@ -0,0 +1,130 @@
+module AliyunGreen
+  module Image
+    class << self
+      def scan(tasks, **options)
+        check_tasks(tasks)
+        response = AliyunGreen.client.post("/green/image/scan", build_payload(tasks, options))
+        response
+      end
+
+      def scan_async(tasks, **options)
+        check_tasks(tasks)
+        callback_url = options[:callback_url]
+        payload = build_payload(tasks, options)
+        if callback_url
+          payload[:callback] = callback_url
+          payload[:seed] = SecureRandom.uuid
+        end
+        answer = AliyunGreen.client.post("/green/image/asyncscan", payload)
+        answer["seed"] = payload[:seed] if callback_url
+
+        answer
+      end
+
+      def check_task_answer(task_ids)
+        response = AliyunGreen.client.post("/green/image/results", task_ids)
+      end
+
+      def feedback
+      end
+
+      def scene_dict
+        {
+          porn: "图片智能鉴黄",
+          terrorism: "图片暴恐涉政",
+          ad: "图文违规",
+          qrcode: "图片二维码",
+          live: "图片不良场景",
+          logo: "图片logo",
+        }
+      end
+
+      def scene_response_dict
+        {
+          porn: {
+            normal: "正常",
+            sexy: "性感",
+            porn: "色情",
+          },
+          terrorism: {
+            normal: "正常",
+            bloody: "血腥",
+            explosion: "爆炸烟光",
+            outfit: "特殊装束",
+            logo: "特殊标识",
+            weapon: "武器",
+            politics: "涉政",
+            violence: "打斗",
+            crowd: "聚众",
+            parade: "游行",
+            carcrash: "车祸现场",
+            flag: "旗帜",
+            location: "地标",
+            drug: "涉毒",
+            gamble: "赌博",
+            others: "其他",
+          },
+          ad: {
+            normal: "正常",
+            ad: "其他广告",
+            politics: "文字含涉政内容",
+            porn: "文字含涉黄内容",
+            abuse: "文字含辱骂内容",
+            terrorism: "文字含暴恐内容",
+            contraband: "文字含违禁内容",
+            spam: "文字含其他垃圾内容",
+            npx: "牛皮癣广告",
+            qrcode: "含二维码",
+            programCode: "含小程序码",
+          },
+          qrcode: {
+            normal: "正常",
+            qrcode: "含二维码",
+            programCode: "含小程序码",
+          },
+          live: {
+            normal: "正常",
+            meaningless: "图片中无内容（例如黑屏、白屏）",
+            PIP: "画中画",
+            smoking: "吸烟",
+            drivelive: "车内直播",
+            drug: "涉毒",
+            gamble: "赌博",
+          },
+          logo: {
+            normal: "正常",
+            TV: "含受管控的logo",
+            trademark: "含商标",
+          },
+
+        }
+      end
+
+      private
+
+      def check_tasks(tasks)
+        raise ArgumentError, "tasks must be an Array" unless tasks.is_a?(Array)
+        raise ArgumentError, "tasks size must no more than 100" unless tasks.size <= 100
+        raise ArgumentError, "tasks must be an Array of Hash with necessary key url" unless tasks.all? { |task| task.is_a?(Hash) || task.keys.include?(:url) }
+      end
+
+      def calc_valid_scenes(options)
+        scenes = options[:secnes] || options["secnes"] || []
+
+        valid_scenes = scenes.select { |x| scene_dict.keys.map(&:to_s).include? x.to_s }
+        valid_scenes = ["porn", "terrorism"] if valid_scenes.size == 0
+      end
+
+      # 需要先在内容安全/设置/机器审核/业务场景: default 中进行初始配置是
+      def build_payload(tasks, options)
+        scenes = calc_valid_scenes(options)
+        payload = {
+          bizType: "default",
+          scenes: scenes,
+          tasks: tasks,
+        }
+        payload
+      end
+    end
+  end
+end

data/lib/aliyun_green/text.rb

@@ -1,24 +1,37 @@
 module AliyunGreen
   module Text
-    def self.scan(content, data_id = nil)
-      tasks = [
-        {
-          dataId: data_id,
-          content: content
-        }
-      ]
+    class << self
+      def scan(content, data_id = nil)
+        tasks = [
+          {
+            dataId: data_id,
+            content: content,
+          },
+        ]
 
-      response = AliyunGreen.client.post('/green/text/scan', tasks)
+        response = AliyunGreen.client.post("/green/text/scan", build_payload(tasks))
 
-      response
-    end
+        response
+      end
 
-    def self.bulk_scan
-      # TODO
-    end
-    
-    def self.feedback
-      # TODO
+      def bulk_scan
+        # TODO
+      end
+
+      def feedback
+        # TODO
+      end
+
+      private
+
+      def build_payload(tasks)
+        payload = {
+          bizType: "default",
+          scenes: ["antispam"],
+          tasks: tasks,
+        }
+        payload
+      end
     end
   end
-end
+end

data/lib/aliyun_green/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AliyunGreen
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

data/lib/aliyun_green.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require_relative "aliyun_green/version"
 require_relative "aliyun_green/text"
+require_relative "aliyun_green/image"
 require_relative "aliyun_green/error"
 require_relative "aliyun_green/client"
 require_relative "aliyun_green/configuration"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyun_green
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - 42up
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Write a longer description or delete this line.
 email:
 - foobar@v2up.com
@@ -46,6 +60,7 @@ files:
 - lib/aliyun_green/client.rb
 - lib/aliyun_green/configuration.rb
 - lib/aliyun_green/error.rb
+- lib/aliyun_green/image.rb
 - lib/aliyun_green/text.rb
 - lib/aliyun_green/version.rb
 homepage: https://github.com/42up/aliyun_green