dingxin-vms 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cfc805fd7104411f36286c55f57a45a4156c2c93f3471e3a0cb8ad9aea7b6a4e
+  data.tar.gz: 40a84bd73e6d89e383db4e7fca4064ab607ed5080aa860238f57d110d2994e30
+SHA512:
+  metadata.gz: 5be8de0a11990147bc1eb356bb1aab97179a68e5c4902c865746583b5cf524b5fb5c914c897dfa9994f4389d9c615bfa95cbe31f7529e516969490279f79cce1
+  data.tar.gz: bd19d79a22c95c5eb9e9da8f9caf425c2c22d7b0ca8d4c1a65ca542b38503c52d62b01c059d658cae508df80b647e758ecc1fbb62e049c5bd3b9d94af439065f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.DS_Store
+Gemfile.lock
+.travis.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dingxin-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,145 @@
+# Dingxin::Vms
+### 鼎信科技-语音通知服务 Ruby Gem dingxin-vms
+
+## 使用前提
+
+使用 dingxin-vms 前，您必须已经是阿里云注册用户，申请开通了“鼎信科技_语音通知API服务
+”，并且获得了以下关键参数: 
+
+AppCode: 阿里云应用密钥。
+
+## Installation 安装
+
+### Ruby 通用安装方法
+在命令行中输入命令（电脑已经安装 gems 命令行工具）
+
+```ruby
+gem install dingxin-vms
+```
+
+### Rails 应用安装方法
+
+在应用的 Gemfile 文件中添加 Ruby Gems 安装源:
+
+```ruby
+gem 'dingxin-vms'   # Ruby Gems 安装源
+```
+
+应用的根目录下运行:
+
+```ruby
+bundle
+```
+
+### 下载后安装
+
+使用 Git 将代码克隆到本地后使用 Rake 命令安装
+
+```bash
+git clone https://github.com/kejincan0527/dingxin-vms.git
+
+cd dingxin-vms
+
+rake build
+
+rake install
+```
+
+### 安装可能遇到的问题及其解决方式  
+
+安装后，如果在 irb 命令行输入命令
+
+```ruby
+require 'dingxin/vms'
+```
+
+后，无法正确获取 Gem 引用，或者在 Rails 启动时报错提示如下: 
+
+> ./config/initializers/dingxin-vms.rb:1:in `<top (required)>': uninitialized constant Dingxin::Vms (NameError)
+
+可以改为 Github 安装源，例如 Rails Gemfile 文件引用可以改为下面格式，即可正确安装。
+
+```ruby
+gem 'dingxin-vms', '0.0.1', git: 'https://github.com/kejincan0527/dingxin-vms.git'
+```
+
+## Usage 使用
+
+### Ruby 程序通用方法（irb命令行示例）
+
+#### 第一步: 
+
+```bash
+$ require 'dingxin/vms'
+```
+
+```bash
+=> true
+```
+
+#### 第二步: 
+
+参数设置: 
+
+```ruby
+> Dingxin::Vms.configure do |config|
+    config.app_code = APP_CODE    # 阿里云应用密钥，在阿里云控制台获取
+  end
+
+```
+返回
+
+```ruby
+  => "67hbft5iouyhnjkio975rfh"
+```
+
+#### 第三步: 
+
+发送语音: 
+
+    $ Dingxin::Vms.send(phone, tpl_id, param)
+
+参数说明: 
+
+1. phone:    接收语音的手机号，必须为字符型，例如 '057112345678'；
+2. tpl\_id:  语音模板id，必须为字符型，联系客服人员申请；
+3. param:    请求字符串，向语音模版提供参数，例如 'asin:B01E7LLKT2'；
+
+### Rails 应用使用方法
+
+#### 第一步: 
+
+在 Rails 应用目录 config/initializers/ 下创建脚本文件 dingxin-vms.rb，在文件中加入以下内容: 
+
+config/initializers/dingxin-vms.rb
+
+```ruby
+Dingxin::Vms.configure do |config|
+  config.app_code = APP_CODE    # 阿里云应用密钥，在阿里云控制台获取
+end
+```
+之后，重新启动 Rails，加载配置。
+
+#### 第二步: 
+
+在 Rails 应用中调用语音发送代码: 
+
+```ruby
+...
+phone = '15912345678'
+tpl_id = 'TP18031516'
+param = 'asin:B01E7LLKT2'
+Dingxin::Vms.send(phone, tpl_id, param)
+...
+```
+
+## Development 开发
+
+按照阿里云市场[鼎信科技官方接口文档](https://market.aliyun.com/products/56928004/cmapi026600.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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dingxin/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/dingxin-vms.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dingxin/vms/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dingxin-vms"
+  spec.version       = Dingxin::Vms::VERSION
+  spec.authors       = ["Wells Muker"]
+  spec.email         = ["wellsmuker@gmail.com"]
+
+  spec.summary       = %q{A Ruby Gem for using dingxin vms service.}
+  spec.description   = %q{适用于鼎信科技提供的语音通知API服务。}
+  spec.homepage      = "https://github.com/kejincan0527/dingxin-vms"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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/lib/dingxin/vms.rb

@@ -0,0 +1,64 @@
+require "dingxin/vms/version"
+require "openssl"
+require "typhoeus"
+require "erb"
+
+include ERB::Util
+
+module Dingxin
+  module Vms
+    class Configuration
+      attr_accessor :app_code
+
+      def initialize
+        @app_code = ''
+      end
+    end # class Configuration
+
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+
+      def send(phone, tpl_id, param)
+        Typhoeus.post(get_url({
+          'phone' => phone,
+          'tpl_id' => tpl_id,
+          'param' => param
+          }),
+          headers: { "Authorization" => "APPCODE #{configuration.app_code}" })
+      end
+
+      def get_url(params)
+        coded_params = canonicalized_query_string(params)
+        url = 'http://yuyin2.market.alicloudapi.com/dx/voice_notice?' + coded_params
+      end
+
+      # 对字符串进行 PERCENT 编码
+      # https://apidock.com/ruby/ERB/Util/url_encode
+      def encode(input)
+        output = url_encode(input)
+      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
+
+    end # class << self
+  end # module Vms
+end # module Dingxin

data/lib/dingxin/vms/version.rb

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

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: dingxin-vms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wells Muker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-22 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: 适用于鼎信科技提供的语音通知API服务。
+email:
+- wellsmuker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dingxin-vms.gemspec
+- lib/dingxin/vms.rb
+- lib/dingxin/vms/version.rb
+homepage: https://github.com/kejincan0527/dingxin-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 dingxin vms service.
+test_files: []