alidayu_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cab21f1519c50334d49a4995425f90cc127cfc48
+  data.tar.gz: d37fb855fd7ff8317679c407620c285ce0489a70
+SHA512:
+  metadata.gz: 1c34f525fe9966fce35b2ceb7047bc69619ef017c862ad1ab3bde7271fb2215fddd209cafd81d7ca5cbf291d95f0a000665c3ce5ec55ecdb575ea45dbfdbc102
+  data.tar.gz: 27b4aad7118c9ccfb846d9c5b9e6ccf040775ea64f9f30bf1c86698fd54377f03c26e02e568dcf3f3bf306b4e79a526beaf7c02336c32a31b8f7b027f4a24e2f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://ruby.taobao.org'
+
+# Specify your gem's dependencies in alidayu_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 402399938
+
+MIT License
+
+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,120 @@
+# AlidayuApi
+
+alidayu api for ruby
+
+阿里大鱼相关API调用，可调用
+
+1. 短信发送 `alibaba.aliqin.fc.sms.num.send`  
+2. 短信发送记录查询 `alibaba.aliqin.fc.sms.num.query`
+3. 文本转语音通知 `alibaba.aliqin.fc.tts.num.singlecall`
+4. 语音通知 `alibaba.aliqin.fc.voice.num.singlecall`
+5. 语音双呼 `alibaba.aliqin.fc.voice.num.doublecall`
+
+## 安装
+
+添加下面的代码到Gemfile中:
+
+```ruby
+gem 'alidayu_api'
+```
+
+然后执行:
+
+    $ bundle install
+
+或者执行下面的代码:
+
+    $ gem install alidayu_api
+
+## 使用
+### 配置
+创建脚本`config/initializers/alidayu.rb`填入以下代码
+
+```ruby
+Alidayu.setup do |config|
+  config.server     = 'http://gw.api.taobao.com/router/rest'
+  config.app_key    = ''
+  config.app_secret = ''
+  config.sign_name  = '注册验证'
+end
+```
+
+短信发送模板请自行根据需求定义
+	
+### 短信发送
+
+```ruby
+options = {
+  mobiles: '13681695220',
+  template_code: 'SMS_5410467',
+  params: {
+   code: '45678',
+   product: '就诊通'
+  }
+}
+# params为模板内容的变量集合，根据模板中定义变量的不同而不同，若模板中未定义变量可不传
+
+Alidayu::Sms.send(options)
+```
+
+### 短信发送记录查询
+
+```ruby
+options = {
+  mobile: '13681695220',
+  query_date: 'yyyyMMdd',
+  current_page: 1, # 页码
+  page_size: 10 # 每页数量，最大50
+}
+
+Alidayu::Sms.query(options)
+
+```
+
+### 文本转语音通知
+
+```ruby
+options = {
+  called_num: '',
+  called_show_num: '',
+  template_code: '', # 文本转语音（TTS）模板ID
+  params: {  } # TTS模板变量，同短信发送的params
+}
+
+Alidayu::Tts.single_call(options)
+```
+
+### 语音通知
+
+```ruby
+options = {
+  called_num: '',
+  called_show_num: '',
+  voice_code: '' # 语音文件ID
+}
+
+Alidayu::Voice.single_call(options)
+```
+
+### 语音双呼
+
+```ruby
+options = {
+  caller_num: '',
+  caller_show_num: '',
+  called_num: '',
+  called_show_num: '',
+  time_out: '' # 通话超时时长，如接通后到达120秒时，通话会因为超时自动挂断。若无需设置超时时长，可不传
+}
+
+Alidayu::Voice.double_call(options)
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/alidayu_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/alidayu_api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alidayu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alidayu_api"
+  spec.version       = Alidayu::VERSION
+  spec.authors       = ["wangrui"]
+  spec.email         = ["to_wangrui@163.com"]
+  spec.summary       = %q{阿里大鱼API}
+  spec.description   = %q{阿里大鱼短信发送，语音双呼，文本转语音通知等API的调用}
+  spec.homepage      = "https://github.com/wangrui438/alidayu_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.4"
+end

data/lib/alidayu.rb

@@ -0,0 +1,27 @@
+require "alidayu/version"
+require "alidayu/configuration"
+require 'net/http'
+require "json"
+require "alidayu/helper"
+require "alidayu/sms"
+require "alidayu/tts"
+require "alidayu/voice"
+require "logger"
+
+
+module Alidayu
+  
+  class << self
+    def setup
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end

data/lib/alidayu/configuration.rb

@@ -0,0 +1,40 @@
+module Alidayu
+  class Configuration
+    # API请求地址分为正式（http/https）和沙箱（http/https）共四个地址
+    # 正式-http: http://gw.api.taobao.com/router/rest  
+    # 正式-https: https://eco.taobao.com/router/rest
+    # 沙箱-http: http://gw.api.tbsandbox.com/router/rest
+    # 沙箱-https: https://gw.api.tbsandbox.com/router/rest
+    def server
+      @server ||= 'https://eco.taobao.com/router/rest'
+    end
+
+    def server=(server)
+      @server = server
+    end
+
+    def app_key
+      @app_key ||= 'your_app_key'
+    end
+
+    def app_key=(app_key)
+      @app_key = app_key
+    end
+
+    def app_secret
+      @app_secret ||= 'your_app_secret'
+    end
+
+    def app_secret=(app_secret)
+      @app_secret = app_secret
+    end
+
+    def sign_name
+      @sign_name ||= 'sign_name'
+    end
+
+    def sign_name=(sign_name)
+      @sign_name = sign_name
+    end
+  end
+end

data/lib/alidayu/helper.rb

@@ -0,0 +1,46 @@
+module Alidayu
+  module Helper
+    # 获得响应结果
+    def get_response(params)
+      uri = URI(Alidayu.config.server)
+      http = Net::HTTP.new(uri.host, uri.port)
+      if uri.scheme == "https"
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      request = Net::HTTP::Post.new(uri.path)
+      request_params = build_params(params)
+      request.add_field('Content-Type', 'application/json')
+      request.set_form_data(request_params)
+      response = http.request(request)
+      Alidayu.logger.info response.body
+      return JSON.parse(response.body)
+    end
+
+    private
+    # 构建请求参数
+    def build_params(params)
+      params[:app_key] = params[:app_key] || Alidayu.config.app_key
+      params[:timestamp] = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+      params[:format] = 'json'
+      params[:v] = '2.0'
+      params[:sign_method] = 'hmac'
+
+      signature = generate_signature(params)
+
+      params[:sign] = signature
+      return params
+    end
+
+    # 生成签名 hmac
+    def generate_signature(params)
+      params.delete(:sign)
+      data = params.sort.compact.join
+      digest = OpenSSL::Digest.new('md5')
+      secret = params[:app_secret] || Alidayu.config.app_secret
+      hmac_sign = OpenSSL::HMAC.hexdigest(digest, secret, data).upcase
+      return hmac_sign
+    end
+
+  end
+end

data/lib/alidayu/sms.rb

@@ -0,0 +1,39 @@
+module Alidayu
+  module Sms
+    class << self
+      include Alidayu::Helper
+
+      METHOD_HASH = {
+        sms_send: "alibaba.aliqin.fc.sms.num.send",
+        sms_query: "alibaba.aliqin.fc.sms.num.query"
+      }
+
+      # 短信发送
+      # { mobiles: '', template_code: '', params: { code: '', product: '' } }
+      def send(params)
+        params[:method] = METHOD_HASH[:sms_send]
+        params[:sms_type] = 'normal'
+        params[:sms_free_sign_name] = params.delete(:sign_name) || Alidayu.config.sign_name
+        if params[:params].is_a? Hash
+          sms_param = params[:params].to_json
+          params.delete(:params)
+          params[:sms_param] = sms_param
+        end
+        params[:rec_num] = params.delete(:mobiles)
+        params[:sms_template_code] = params.delete(:template_code)
+
+        response = get_response(params)
+      end
+
+      # 短信发送记录查询
+      # {  mobile: '', query_date: 'yyyyMMdd', current_page: 1, page_size: 20 }
+      def query(params)
+        params[:method] = METHOD_HASH[:sms_query]
+        params[:rec_num] = params.delete(:mobile)
+
+        response = get_response(params)
+      end
+
+    end
+  end
+end

data/lib/alidayu/tts.rb

@@ -0,0 +1,20 @@
+module Alidayu
+  module Tts
+    class << self
+      include Alidayu::Helper
+
+      # 文本转语音通知
+      # { called_num: '', called_show_num: '', template_code: '', params: {  } }
+      def single_call(params)
+        params[:method] = 'alibaba.aliqin.fc.tts.num.singlecall'
+        params[:tts_code] = params.delete(:template_code)
+        if params[:params].is_a? Hash
+          tts_param = params[:params].to_json
+          params.delete(:params)
+          params[:tts_param] = tts_param
+        end
+        response = get_response(params)
+      end
+    end
+  end
+end

data/lib/alidayu/version.rb

@@ -0,0 +1,3 @@
+module Alidayu
+  VERSION = "0.0.1"
+end

data/lib/alidayu/voice.rb

@@ -0,0 +1,30 @@
+module Alidayu
+  module Voice
+    class << self
+      include Alidayu::Helper
+
+      METHOD_HASH = {
+        voice_double_call: "alibaba.aliqin.fc.voice.num.doublecall",
+        voice_single_call: "alibaba.aliqin.fc.voice.num.singlecall"
+      }
+
+      # 语音双呼
+      # { caller_num: '', caller_show_num: '', called_num: '', called_show_num: '' }
+      def double_call(params)
+        params[:method] = METHOD_HASH[:voice_double_call]
+        params[:session_time_out] = params.delete(:time_out)
+
+        response = get_response(params)
+      end
+
+      # 语音通知
+      #  { called_num: '', called_show_num: '', voice_code: '' }
+      def single_call(params)
+        params[:method] = METHOD_HASH[:voice_single_call]
+
+        response = get_response(params)
+      end
+
+    end
+  end
+end

data/spec/sms_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "test sms api" do
+  it "should send message success" do
+    options = { mobiles: '13681695220', template_code: 'SMS_5410467', params: { code: '1234567', product: '就诊通' } }
+
+    data = Alidayu::Sms.send(options)
+
+    expect(data["alibaba_aliqin_fc_sms_num_send_response"]["result"]["success"]).to eq(true)
+  end
+
+  it "should send message fail" do
+    options = { mobiles: '13681695220', template_code: 'SMS_5410467', params: { code: '123567' } }
+
+    data = Alidayu::Sms.send(options)
+
+    expect(data["error_response"]).to be_an_instance_of(Hash)
+  end
+
+  it "should query message record" do
+    options = { mobile: '13681695220', query_date: '20160304', current_page: 1, page_size: 10 }
+
+    data = Alidayu::Sms.query(options)
+
+    expect(data["alibaba_aliqin_fc_sms_num_query_response"]).to be_an_instance_of(Hash)
+  end
+
+ end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'alidayu'
+
+Bundler.setup
+
+Alidayu.setup do |config|
+  # config.server     = 'http://gw.api.taobao.com/router/rest'
+  config.server     = 'https://eco.taobao.com/router/rest'
+  config.app_key    = '12345'
+  config.app_secret = '6789012345'
+  config.sign_name  = '注册验证'
+end

data/spec/tts_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "test tts api" do
+  it "should send tts success" do
+    options = { called_num: '13681695220', called_show_num: '10086', template_code: 'TTS_5410474', params: { product: '就诊通', code: '1234567' } }
+    
+    data = Alidayu::Tts.single_call(options)
+
+    expect(data["alibaba_aliqin_fc_sms_num_send_response"]["result"]["success"]).to eq(true)
+  end
+
+  it "should send tts fail" do
+    options = { called_num: '13681695220', called_show_num: '10086', template_code: 'TTS_5410474', params: { product: '就诊通' } }
+
+    data = Alidayu::Tts.single_call(options)
+
+    expect(data["error_response"]).to be_an_instance_of(Hash)
+  end
+
+ end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: alidayu_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- wangrui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: "阿里大鱼短信发送，语音双呼，文本转语音通知等API的调用"
+email:
+- to_wangrui@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alidayu_api.gemspec
+- lib/alidayu.rb
+- lib/alidayu/configuration.rb
+- lib/alidayu/helper.rb
+- lib/alidayu/sms.rb
+- lib/alidayu/tts.rb
+- lib/alidayu/version.rb
+- lib/alidayu/voice.rb
+- spec/sms_spec.rb
+- spec/spec_helper.rb
+- spec/tts_spec.rb
+- spec/voice_spec.rb
+homepage: https://github.com/wangrui438/alidayu_api
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: "阿里大鱼API"
+test_files:
+- spec/sms_spec.rb
+- spec/spec_helper.rb
+- spec/tts_spec.rb
+- spec/voice_spec.rb
+has_rdoc: