aliyun-vms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c619251fb57eaa1dd5a74a6aa273aad53d4333a36333aa5115e87e492afd358a
+  data.tar.gz: e096dcbc4dcc3c18f18656f00514d16e65b4b4435bd937b9655d9099304dbd98
+SHA512:
+  metadata.gz: e3dfcb9fd7df3210e922ca26e1a1ea40513faff8820b3c8468b8246c74aaf35cde70deba8d0829f79d6ec8f4fdd293d689462fe0cae6bbee2e199294fa8161f3
+  data.tar.gz: 5f8f9e8e6d14d957a593ea9dd122dff069d3e4c59d8b31c8c83ab2e8cc3249d5775f967a6c85bada127757557636d2da146142bc7335b57c0cc70eea27e257e6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wellsmuker@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aliyun-vms.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Wells Muker
+
+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,192 @@
+# Aliyun::Vms 阿里云语音服务 Ruby Gem aliyun-vms
+
+**适用于阿里云语音服务最新的 *2017-05-25* 版接口**
+
+## 特别说明
+
+目前阿里云通信语音服务提供4个产品，分别是: 
+
+1. 语音验证码
+2. 语音通知
+3. 语音IVR
+4. 智能外呼
+
+**这个 gem 目前只调通的是前面所述的第 2 个语音产品，即“语音通知”。请您在使用 aliyun-vms 前，请参考官方说明文档[阿里云语音业务说明](https://help.aliyun.com/product/54853.html)。**
+
+## 使用前提
+
+使用 aliyun-vms 前，您必须已经是阿里云注册用户，申请开通了“阿里云语音服务”，并且获得了以下几个关键参数: 
+
+1. ACCESS\_KEY\_SECRET: 阿里云用户密钥，在阿里云控制台申请获取。
+2. ACCESS\_KEY\_ID:     阿里云用户 ID， 在阿里云控制台申请获取。
+3. Tts\_CODE:           语音模版代码，在阿里云申请开通语音服务时申请获取。
+
+## Installation 安装
+
+### Ruby 通用安装方法
+在命令行中输入命令（电脑已经安装 gems 命令行工具）
+
+```ruby
+gem install aliyun-vms
+```
+
+### Rails 应用安装方法
+
+在应用的 Gemfile 文件中添加 Ruby Gems 安装源:
+
+```ruby
+gem 'aliyun-vms'   # Ruby Gems 安装源
+```
+
+应用的根目录下运行:
+
+```ruby
+bundle
+```
+
+### 下载后安装
+
+使用 Git 将代码克隆到本地后使用 Rake 命令安装
+
+```bash
+git clone https://github.com/kejincan0527/aliyun-vms.git
+
+cd aliyun-vms
+
+rake build
+
+rake install
+```
+
+### 安装可能遇到的问题及其解决方式  
+
+安装后，如果在 irb 命令行输入命令
+
+```ruby
+require 'aliyun/vms'
+```
+
+后，无法正确获取 Gem 引用，或者在 Rails 启动时报错提示如下: 
+
+> ./config/initializers/aliyun-vms.rb:1:in `<top (required)>': uninitialized constant Aliyun::Vms (NameError)
+
+可以改为 Github 安装源，例如 Rails Gemfile 文件引用可以改为下面格式，即可正确安装。
+
+```ruby
+gem 'aliyun-vms', '0.0.1', git: 'https://github.com/kejincan0527/aliyun-vms.git'
+```
+
+## Usage 使用
+
+### Ruby 程序通用方法（irb命令行示例）
+
+#### 第一步: 
+
+```bash
+$ require 'aliyun/vms'
+```
+
+```bash
+=> true
+```
+
+#### 第二步: 
+
+参数设置: 
+
+```ruby
+$ Aliyun::Vms.configure do |config|
+    config.access_key_secret = ACCESS_KEY_SECRET    # 阿里云接入密钥，在阿里云控制台申请
+    config.access_key_id = ACCESS_KEY_ID            # 阿里云接入 ID, 在阿里云控制台申请
+    config.action = 'SingleCallByTts'               # 默认设置
+    config.format = 'XML'                           # 语音推送返回信息格式，可以填写 'JSON'或者'XML'
+    config.region_id = 'cn-hangzhou'                # 默认设置，如果没有特殊需要，可以不改      
+    config.signature_method = 'HMAC-SHA1'           # 加密算法，默认设置
+    config.signature_version = '1.0'                # 签名版本，默认设置，不用修改
+    config.version = '2017-05-25'                   # 服务版本，默认设置，不用修改
+  end
+
+```
+返回
+
+```ruby
+  => "2017-05-25"
+```
+
+#### 第三步: 
+
+发送语音: 
+
+    $ Aliyun::Vms.send(called_show_number, called_number, tts_code, tts_param, out_id)
+
+参数说明: 
+
+1. called_show_number: 被叫显示号码，必须为字符型，例如 '057112345678'；
+2. called_number: 接收语音的手机号，必须为字符型，例如 '1234567890'；
+3. tts\_code:  语音模版代码，必须为字符型，申请开通语音服务后，由阿里云提供，例如 'TTS_12345678'；
+4. tts\_param: 请求字符串，向语音模版提供参数，必须是转为字符串的json格式对象，例如 '{"code":"666666", "product":"测试网站" }'；
+5. out_id: 外部流水扩展字段，必须为字符型，可以为空。
+
+
+### Rails 应用使用方法
+
+#### 第一步: 
+
+在 Rails 应用目录 config/initializers/ 下创建脚本文件 aliyun-vms.rb，在文件中加入以下内容: 
+
+config/initializers/aliyun-vms.rb
+
+```ruby
+Aliyun::Vms.configure do |config|
+  config.access_key_secret = ACCESS_KEY_SECRET    # 阿里云接入密钥，在阿里云控制台申请
+  config.access_key_id = ACCESS_KEY_ID            # 阿里云接入 ID, 在阿里云控制台申请
+  config.action = 'SingleCallByTts'               # 默认设置
+  config.format = 'XML'                           # 语音推送返回信息格式，可以填写 'JSON'或者'XML'
+  config.region_id = 'cn-hangzhou'                # 默认设置，如果没有特殊需要，可以不改      
+  config.signature_method = 'HMAC-SHA1'           # 加密算法，默认设置
+  config.signature_version = '1.0'                # 签名版本，默认设置，不用修改
+  config.version = '2017-05-25'                   # 服务版本，默认设置，不用修改
+end
+```
+之后，重新启动 Rails，加载配置。
+
+#### 第二步: 
+
+在 Rails 应用中调用语音发送代码: 
+
+```ruby
+Aliyun::Vms.send(called_show_number, called_number, tts_code, tts_param, out_id)
+```    
+
+参数说明: 
+
+1. called_show_number: 被叫显示号码，必须为字符型，例如 '057112345678'；
+2. called_number: 接收语音的手机号，必须为字符型，例如 '1234567890'；
+3. tts\_code:  语音模版代码，必须为字符型，申请开通语音服务后，由阿里云提供，例如 'TTS_12345678'；
+4. tts\_param: 请求字符串，向语音模版提供参数，必须是转为字符串的json格式对象，例如 '{"code":"666666", "product":"测试网站" }'；
+5. out_id: 外部流水扩展字段，必须为字符型，可以为空。
+
+特别说明: 
+
+在程序中可以先用 HASH 组织 tts\_param 内容，再使用 to_json 方法转换为 json 格式字符串，例如: 
+
+```ruby
+...
+called_show_number = '057112345678'
+called_number = '1234567890'
+tts_code = 'TTS_12345678'
+tts_param = {"code"=>"666666", "product"=>"测试网站" }.to_json
+Aliyun::Vms.send(called_show_number, called_number, tts_code, tts_param)
+...
+```    
+
+## Development 开发
+
+按照阿里云[官方接口文档](https://help.aliyun.com/document_detail/56190.html)提供的 VMS 样例做了 spect 测试，可以 clone 项目后，在根目录下用命令行运行以下命令测试: 
+
+    $ bundle exec rspec spec
+
+
+## License 许可
+
+MIT 协议下的开源项目。 [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/aliyun-vms.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aliyun/vms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aliyun-vms"
+  spec.version       = Aliyun::Vms::VERSION
+  spec.authors       = ["Wells Muker"]
+  spec.email         = ["wellsmuker@gmail.com"]
+
+  spec.summary       = %q{A Ruby Gem for using aliyun vms service, in accordance with aliyun vms 2017-05-25 version api. 适用于阿里云语音服务最新的 2017-05-25 版接口.}
+  spec.description   = %q{A Ruby Gem for using aliyun vms service, in accordance with aliyun vms 2017-05-25 version api. 适用于阿里云语音服务最新的 2017-05-25 版接口.}
+  spec.homepage      = "https://github.com/kejincan0527/aliyun-vms"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "typhoeus"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aliyun/vms"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aliyun/vms.rb

@@ -0,0 +1,123 @@
+require "aliyun/vms/version"
+require "openssl"
+require "base64"
+require 'typhoeus'
+require "erb"
+include ERB::Util
+
+module Aliyun
+  module Vms
+    class Configuration
+      attr_accessor :access_key_secret, :access_key_id, :action, :format, :region_id,
+                    :signature_method, :signature_version, :version
+
+      def initialize
+        @access_key_secret = ''
+        @access_key_id = ''
+        @action = ''
+        @format = ''
+        @region_id = ''
+        @signature_method = ''
+        @signature_version = ''
+        @version = ''
+      end
+    end
+
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+
+      def send(called_show_number, called_number, tts_code, tts_param, out_id = '')
+        Typhoeus.get(get_url({
+          'CalledShowNumber' => called_show_number,
+          'CalledNumber' => called_number,
+          'TtsCode' => tts_code,
+          'TtsParam' => tts_param,
+          'OutId'	=> out_id,
+          'SignatureNonce' => seed_signature_nonce,
+          'Timestamp' => seed_timestamp
+          }))
+      end
+
+      def get_url(user_params)
+        params = get_params(user_params)
+        coded_params = canonicalized_query_string(params)
+        key_secret = configuration.access_key_secret
+        url = 'http://dyvmsapi.aliyuncs.com/?' + 'Signature=' + sign(key_secret, coded_params) + '&' + coded_params
+      end
+
+      def get_params(user_params)
+        params = config_params.merge(user_params)
+      end
+
+      def config_params()
+        params ={
+          'AccessKeyId' => configuration.access_key_id,
+          'Action' => configuration.action,
+          'Format' => configuration.format,
+          'RegionId' => configuration.region_id,
+          'SignatureMethod' => configuration.signature_method,
+          'SignatureVersion' => configuration.signature_version,
+          'Version' => configuration.version
+        }
+      end
+
+      def canonicalized_query_string(params)
+        cqstring = ''
+        params.sort_by{|key, val| key}.each do |key, value|
+          if cqstring.empty?
+            cqstring += "#{encode(key)}=#{encode(value)}"
+          else
+            cqstring += "&#{encode(key)}=#{encode(value)}"
+          end
+        end
+        cqstring
+      end
+
+      # 生成数字签名
+      def sign(key_secret, coded_params)
+        key = key_secret + '&'
+        signature = 'GET' + '&' + encode('/') + '&' +  encode(coded_params)
+        sign = Base64.encode64("#{OpenSSL::HMAC.digest('sha1',key, signature)}")
+        encode(sign.chomp)  # 通过chomp去掉最后的换行符 LF
+      end
+
+      # 对字符串进行 PERCENT 编码
+      def encode(input)
+        output = url_encode(input)
+      end
+
+      # 生成语音时间戳
+      def seed_timestamp
+        Time.now.utc.strftime("%FT%TZ")
+      end
+
+      # 生成语音唯一标识码，采用到微秒的时间戳
+      def seed_signature_nonce
+        Time.now.utc.strftime("%Y%m%d%H%M%S%L")
+      end
+
+      # 测试参数未编码时生成的字符串是否正确（多一道保险）
+      def test_query_string(params)
+        qstring = ''
+        params.sort_by{|key, val| key}.each do |key, value|
+          if qstring.empty?
+            qstring += "#{key}=#{value}"
+          else
+            qstring += "&#{key}=#{value}"
+          end
+        end
+        qstring
+      end
+
+    end
+
+  end
+end

data/lib/aliyun/vms/version.rb

@@ -0,0 +1,5 @@
+module Aliyun
+  module Vms
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: aliyun-vms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wells Muker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby Gem for using aliyun vms service, in accordance with aliyun vms
+  2017-05-25 version api. 适用于阿里云语音服务最新的 2017-05-25 版接口.
+email:
+- wellsmuker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aliyun-vms.gemspec
+- bin/console
+- bin/setup
+- lib/aliyun/vms.rb
+- lib/aliyun/vms/version.rb
+homepage: https://github.com/kejincan0527/aliyun-vms
+licenses:
+- MIT
+metadata: {}
+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.0.1
+signing_key: 
+specification_version: 4
+summary: A Ruby Gem for using aliyun vms service, in accordance with aliyun vms 2017-05-25
+  version api. 适用于阿里云语音服务最新的 2017-05-25 版接口.
+test_files: []