tx_asr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86d453ba155a1fc1936f8899d3f29f9a7e7fc42b5bfcaf52069274d0e17313c5
+  data.tar.gz: 2dbbba1c8682554f4657767fb754c2e3f5f05c71f97c61458f0c5f1c57dfc504
+SHA512:
+  metadata.gz: 965433e364a45ed2124f39d6213223fefb56b68e3c5113b17cf594a880b2d6a9f5eeac944e94ba69c43c3e60a6475b23d71e135e97d2bdbdb622504905ee9839
+  data.tar.gz: abbde1b3bdc48c18e1b047370d83ba2fcd1d6c5fdd17bf32e75e4fb4589dc65c34d9ffdadae876c1a6fcc3f17dc3baaf5f31233b920fec9f07bc37df1314b187

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 ian
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# TxAsr
+Short description and motivation.
+
+## Usage
+```ruby
+
+# sentence recognition
+result = TxAsr::SentenceRecognition.from(audio_url)
+
+if result.success?
+  p result.data
+end
+```
+
+## Installation
+1. 在 Gemfile 里边添加如下代码
+
+```ruby
+gem 'tx_asr'
+```
+
+2. 执行 bundle
+
+```bash
+$ bundle
+```
+
+3. 执行安装命令
+```bash
+$ rails g tx_asr:install
+```
+
+4. 修改 `config/initializers/tx_asr.rb` 中 `secret_id` 和 `secret_key` 为实际的值
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/tx_asr/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate install Thing
+
+    This will create:
+        what/will/it/create

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

@@ -0,0 +1,7 @@
+class TxAsr::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def install
+    copy_file "initializer.rb", "config/initializers/tx_asr.rb"
+  end
+end

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

@@ -0,0 +1,28 @@
+
+TxAsr.setup do |config|
+
+  # TODO 需要将 secret_key 和 secret_id 改为你实际项目中的配置
+  config.secret_key = "your_secret_key"
+  config.secret_id = "your_secret_id"
+  config.region = "ap-guangzhou"
+
+
+  # 声音格式： 支持 mp3 和 wav
+  config.voice_format = "mp3"
+
+  # 可在腾讯云后台查看。如果没有新建项目，那就是使用的默认项目，默认项目 id 为 0
+  config.project_id = 0
+
+  # API 版本号，截止 gem 发布前，下面的值为文档给出的值
+  config.version = "2019-06-14"
+
+  # source type —— 语音来源： 可选 0: url, 1: post body
+  config.source_type = 0
+
+  # 过滤语气词： 0 不过滤，1 部分过滤，2 严格过滤
+  config.filter_model = 1
+
+  # 默认声道数： 1 为单声道，2 为双声道，默认为单声道
+  # config.channel_num = 1
+
+end

data/lib/tasks/tx_asr_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tx_asr do
+#   # Task goes here
+# end

data/lib/tx_asr/railtie.rb

@@ -0,0 +1,4 @@
+module TxAsr
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/tx_asr/request.rb

@@ -0,0 +1,83 @@
+
+module TxAsr
+  class Request
+    def initialize(payload)
+      @payload = default_payload.merge(payload)
+    end
+
+    def call(action)
+      result = request(action)
+
+      if result["Response"]["Error"].present?
+        # {
+        #   "Response":
+        #     {
+        #       "Error": {
+        #           "Code": "AuthFailure.SignatureFailure",
+        #           "Message": "The provided credentials could not be validated. Please check your signature is correct."
+        #         },
+        #       "RequestId":"ff48f384-6da7-4797-874a-b88e5e186136"
+        #     }
+        # }
+        ServiceResult.new(errors: result["Response"]["Error"], message: result["Response"]["Error"].fetch("Message"))
+      else
+        # {
+        #   "Response":
+        #     {
+        #       "RequestId": "6f24aeab-9929-4aec-81de-e3eff87639f6",
+        #       "Data": {
+        #         "TaskId":
+        #           1357048750
+        #       }
+        #     }
+        # }
+        ServiceResult.new(success: true, data: result["Response"])
+      end
+    end
+
+    private
+
+
+    def default_payload
+      {
+        SourceType: TxAsr.source_type || TxAsr::SOURCE_TYPE_URL,
+      }
+    end
+
+    def request(action)
+      authorization = Sign.new(@payload).authorization
+      uri = URI(TxAsr::ENDPOINT)
+      req = Net::HTTP::Post.new(uri)
+      req["Authorization"] = authorization
+      req["Content-Type"] = "application/json; charset=utf-8"
+      req["Host"] = TxAsr::API_HOST
+      req["X-TC-Action"] = action
+      req["X-TC-Timestamp"] = timestamp
+      req["X-TC-Version"] = TxAsr.version
+      req["X-TC-Region"] = TxAsr.region
+
+      resp = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request(req, @payload.to_json)
+      end
+
+      if resp.is_a? Net::HTTPSuccess
+        JSON.parse(resp.body).with_indifferent_access
+      else
+        logger.error <<-ERROR
+#{resp.message}
+uri: #{resp.uri}
+code: #{resp.code}
+#{req.each_header.inject(""){|headers, header| headers + header.join(": ") + "\n"}.rstrip}
+body:
+#{resp.body}
+        ERROR
+
+        raise Errors::RequestError.new(req, resp)
+      end
+    end
+
+    def timestamp
+      @timestamp ||= Time.current.to_i
+    end
+  end
+end

data/lib/tx_asr/sentence_recognition.rb

@@ -0,0 +1,31 @@
+module TxAsr
+  class SentenceRecognition
+    # 2 为 一句话识别
+    SUB_SERVICE_TYPE = 2
+
+    ACTION = "SentenceRecognition"
+
+    ENG_SERVICE_TYPE_8K_ZH = "8k_zh"
+    ENG_SERVICE_TYPE_16K_ZH = "16k_zh"
+
+    def self.from(url)
+      payload = common_payload.merge({ Url: url })
+
+      Request.new(payload).call(ACTION)
+    end
+
+    def self.common_payload
+      {
+        ProjectId: TxAsr.project_id || TxAsr::PROJECT_ID_DEFAULT,
+        SubServiceType: SUB_SERVICE_TYPE,
+        EngSerViceType: ENG_SERVICE_TYPE_8K_ZH, # 这里的键名是照着文档的，是正确的
+        VoiceFormat: TxAsr.voice_format,
+        UsrAudioKey: voice_id
+      }
+    end
+
+    def self.voice_id
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/tx_asr/service_result.rb

@@ -0,0 +1,46 @@
+module TxAsr
+  class ServiceResult
+    attr_accessor :success,
+                  :errors,
+                  :data,
+                  :message,
+                  :message_type
+
+    def initialize(success: false,
+                   errors: nil,
+                   message: nil,
+                   message_type: nil,
+                   data: nil)
+      self.success = success
+      self.data = data
+      self.errors = errors.is_a?(Array) ? errors : [errors]
+      self.message = message
+      self.message_type = message_type
+    end
+
+    alias success? :success
+
+    def failure?
+      !success?
+    end
+
+    def on_success
+      yield(self) if success?
+    end
+
+    def on_failure
+      yield(self) if failure?
+    end
+
+    def get_message_type
+      if message_type.present?
+        message_type.to_sym
+      elsif success?
+        :notice
+      else
+        :error
+      end
+    end
+  end
+
+end

data/lib/tx_asr/sign.rb

@@ -0,0 +1,119 @@
+
+require 'digest'
+require 'json'
+require 'net/http'
+require 'time'
+require 'openssl'
+
+module TxAsr
+  class Sign
+    attr_accessor :file_url
+
+    SERVICE = 'asr'
+
+    HOST = "asr.tencentcloudapi.com"
+
+    # 加密算法
+    ALGORITHM = 'TC3-HMAC-SHA256'
+
+    # 场景模型
+    ENGINE_MODEL = "16k_zh_video"
+
+    # 声道数
+    CHANNEL_NUM = 1
+
+    # 结果回调地址
+    CALLBACK_URL = "https://demo.mini-geek.com/speech_to_text/callback"
+
+    # 声音文件来源: url
+    AUDIO_SOURCE_FROM_URL = 0
+
+    # 声音文件来源: 请求体
+    AUDIO_SOURCE_FROM_BODY = 1
+
+    # 过滤语气词: 部分
+    FILTER_INTERJECTION_PART = 1
+
+    # 过滤语气词: 所有
+    FILTER_INTERJECTION_ALL = 2
+
+    # 翻译的结果具体到单词时间，并返回语速
+    RESULT_FORMAT_WORDS_WITH_PUNC = 2
+
+    # def initialize(file_url)
+    #   @file_url = file_url
+    # end
+
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def authorization
+      signature = sign(@payload)
+
+      date = Time.at(timestamp).utc.strftime('%Y-%m-%d')
+
+      credential_scope = date + '/' + SERVICE + "/tc3_request"
+      signed_headers = 'content-type;host'
+      "#{ALGORITHM} Credential=#{TxAsr.secret_id}/#{credential_scope}, SignedHeaders=#{signed_headers}, Signature=#{signature}"
+    end
+
+    private
+
+    def logger
+      @logger ||= Logger.new Rails.root.join("log/speech_to_text.log")
+    end
+
+    def payload
+      {
+        EngineModelType: ENGINE_MODEL,
+        ChannelNum: CHANNEL_NUM,
+        ResTextFormat: RESULT_FORMAT_WORDS_WITH_PUNC,
+        SourceType: AUDIO_SOURCE_FROM_URL,
+        CallbackUrl: CALLBACK_URL,
+        Url: file_url
+      }
+    end
+
+    def sign(payload)
+      http_request_method = 'POST'
+      canonical_uri = '/'
+      canonical_querystring = ''
+      canonical_headers = "content-type:application/json; charset=utf-8\nhost:#{HOST}\n"
+      signed_headers = 'content-type;host'
+
+      hashed_request_payload = Digest::SHA256.hexdigest(payload.to_json)
+      canonical_request = [
+        http_request_method,
+        canonical_uri,
+        canonical_querystring,
+        canonical_headers,
+        signed_headers,
+        hashed_request_payload,
+      ].join("\n")
+
+      date = Time.at(timestamp).utc.strftime('%Y-%m-%d')
+
+      credential_scope = date + '/' + SERVICE + '/tc3_request'
+      hashed_request_payload = Digest::SHA256.hexdigest(canonical_request)
+      string_to_sign = [
+        ALGORITHM,
+        timestamp.to_s,
+        credential_scope,
+        hashed_request_payload,
+      ].join("\n")
+
+      digest = OpenSSL::Digest.new('sha256')
+      secret_date = OpenSSL::HMAC.digest(digest, 'TC3' + TxAsr.secret_key, date)
+      secret_service = OpenSSL::HMAC.digest(digest, secret_date, SERVICE)
+      secret_signing = OpenSSL::HMAC.digest(digest, secret_service, 'tc3_request')
+      OpenSSL::HMAC.hexdigest(digest, secret_signing, string_to_sign)
+    end
+
+    private
+
+    def timestamp
+      @timestamp ||= Time.current.to_i
+    end
+  end
+end

data/lib/tx_asr/version.rb

@@ -0,0 +1,3 @@
+module TxAsr
+  VERSION = '0.1.0'
+end

data/lib/tx_asr.rb

@@ -0,0 +1,45 @@
+require "tx_asr/version"
+require "tx_asr/railtie"
+require "tx_asr/service_result"
+require "tx_asr/request"
+require "tx_asr/sign"
+require "tx_asr/sentence_recognition"
+
+module TxAsr
+  # 声道
+  SINGLE_CHANNEL = 1
+  DOUBLE_CHANNEL = 2
+
+  # 语音来源
+  SOURCE_TYPE_URL = 0
+  SOURCE_TYPE_BODY = 1
+
+  ENDPOINT = "https://asr.tencentcloudapi.com"
+  API_HOST = "asr.tencentcloudapi.com"
+
+  # api 版本
+  API_VERSION = "2019-06-14"
+
+  # 音频格式
+  VOICE_FORMAT_MP3 = "mp3"
+  VOICE_FORMAT_WAV = "wav"
+
+  PROJECT_ID_DEFAULT = 0
+
+
+  # Your code goes here...
+  mattr_accessor :secret_id,
+                 :secret_key,
+                 :voice_format,
+                 :project_id,
+                 :version,
+                 :source_type,
+                 :api_host,
+                 :channel_num,
+                 :region,
+                 :filter_model
+
+  def self.setup
+    yield self if block_given?
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: tx_asr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ian
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+description: for development app with tencent cloud ASR(Automatic Speech Recognition)
+email:
+- ianlynxk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/tx_asr/install/USAGE
+- lib/generators/tx_asr/install/install_generator.rb
+- lib/generators/tx_asr/install/templates/initializer.rb
+- lib/tasks/tx_asr_tasks.rake
+- lib/tx_asr.rb
+- lib/tx_asr/railtie.rb
+- lib/tx_asr/request.rb
+- lib/tx_asr/sentence_recognition.rb
+- lib/tx_asr/service_result.rb
+- lib/tx_asr/sign.rb
+- lib/tx_asr/version.rb
+homepage: https://github.com/bkyz/tx_asr
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bkyz/tx_asr
+  source_code_uri: https://github.com/bkyz/tx_asr
+  changelog_uri: https://github.com/bkyz/tx_asr/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: for development app with tencent cloud ASR(Automatic Speech Recognition)
+test_files: []