yuntongxun_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7e8859ef4c24e7fa089d55b4f548fe75803878c
+  data.tar.gz: d27bccf99d5f5717f8014eaa0ba9482769bcce01
+SHA512:
+  metadata.gz: 3251269785a67ab38019572526636d242a0a870d9b4abe5bc76547e2721f5a7fb6af91405fede94bf3c090d627fda7ba34e5663528b6d92f95f37f9a84702346
+  data.tar.gz: d32e21a10967e17f8287f27eacf59d0fcaca04a967e7256824c6c30d66891e5e096d6030da82a944751f921c7003b2db1c6a8387bc2161e7d1693c6c7e5aa605

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 skji
+
+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,112 @@
+# YunTongXun Api
+
+容联·云通讯SDK for Ruby
+
+DONE: 短信
+DONE: 语音验证码
+DONE: 电话回拨
+DONE: 外呼通知
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yuntongxun_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yuntongxun_api
+
+## Usage
+
+### Setting
+
+Create `config\initializers\yuntongxun.rb`
+
+```ruby
+YunTongXun.setup do |config|
+  config.server = 'https://app.cloopen.com:8883'
+  config.account_sid = ''
+  config.auth_token = ''
+  config.version = '2013-12-26'
+end
+```
+
+### SMS
+
+```ruby
+params = {
+  to: '',
+  appId: '',
+  templateId: '',
+  datas: '',
+}
+
+YunTongXun::Sms.send(params)
+```
+
+### 语音验证
+
+```ruby
+params = {
+  to: '',
+  appId: '',
+  verifyCode: '',
+}
+
+YunTongXun::Voice.voice_verify(params)
+```
+
+### 电话回拨
+
+```ruby
+params = {
+  from: '',
+  to: ''
+}
+
+YunTongXun::Voice.double_call(params)
+```
+
+### 取消回拨
+
+```ruby
+params = {
+  appId: '',
+  callSid: '',
+  type: '',
+}
+
+YunTongXun::Voice.cancel_call(params)
+```
+
+### 取消回拨
+
+```ruby
+params = {
+  appId: '',
+  to: '',
+}
+
+YunTongXun::Voice.landing_call(params)
+```
+
+
+## Contributing
+
+1. [Fork it](https://github.com/skji/yuntongxun_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
+
+## License
+
+The gem is available as open source under the terms of the [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 "yuntongxun_api"
+
+# 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

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/yuntongxun_api/configuration.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+module YunTongXun
+  class Configuration
+    # API请求地址分为正式（http/https）和沙箱（http/https）共四个地址
+    # 正式-http: http://app.cloopen.com:8883
+    # 正式-https: https://app.cloopen.com:8883
+    # 沙箱-http: http://sandboxapp.cloopen.com:8883
+    # 沙箱-https: https://sandboxapp.cloopen.com:8883
+    def server
+      @server ||= 'https://app.cloopen.com:8883'
+    end
+
+    def server=(server)
+      @server = server
+    end
+
+    def account_sid
+      @account_sid ||= 'your_account_sid'
+    end
+
+    def account_sid=(account_sid)
+      @account_sid = account_sid
+    end
+
+    def auth_token
+      @auth_token ||= 'your_auth_token'
+    end
+
+    def auth_token=(auth_token)
+      @auth_token = auth_token
+    end
+
+    def version
+      @version ||= 'version'
+    end
+
+    def version=(version)
+      @version = version
+    end
+  end
+end

data/lib/yuntongxun_api/helper.rb

@@ -0,0 +1,56 @@
+# coding: utf-8
+require "json"
+require 'digest'
+require 'base64'
+require 'net/http'
+require 'net/https'
+
+module YunTongXun
+  module Helper
+    # 获得响应结果
+    def get_response(params)
+      uri = URI.parse(url)
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      request = Net::HTTP::Post.new(url, headers)
+      request.body = params.to_json
+      response = https.request(request)
+
+      YunTongXun.logger.info response.body
+      return JSON.parse(response.body)
+    end
+
+    private
+    def url
+      "#{YunTongXun.config.server}/#{YunTongXun.config.version}/#{@accounts}/#{YunTongXun.config.account_sid}/#{@method}?sig=#{sign}"
+    end
+
+    def sign
+      # REST API 验证参数，生成规则如下
+      # 1.使用MD5加密（账户Id + 账户授权令牌 + 时间戳）。其中账户Id和账户授权令牌根据url的验证级别对应主账户。
+      # 时间戳是当前系统时间，格式"yyyyMMddHHmmss"。时间戳有效时间为24小时，如：20140416142030
+      # 2.SigParameter参数需要大写，如不能写成sig=abcdefg而应该写成sig=ABCDEFG
+      Digest::MD5.hexdigest(YunTongXun.config.account_sid + YunTongXun.config.auth_token + timestamp).upcase
+    end
+
+    def headers
+      # Accept String必选客户端响应接收数据格式：application/xml、application/json
+      # Content-Type String必选类型：application/xml;charset=utf-8、application/json;charset=utf-8
+      # Content-Length String必选Content-Length
+      # Authorization String 必选 验证信息，生成规则详见下方说明
+      # 1.使用Base64编码（账户Id + 冒号 + 时间戳）其中账户Id根据url的验证级别对应主账户
+      # 2.冒号为英文冒号
+      # 3.时间戳是当前系统时间，格式"yyyyMMddHHmmss"，需与SigParameter中时间戳相同。
+      {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json;charset=utf-8',
+        'Authorization' => Base64.strict_encode64(YunTongXun.config.account_sid + ':' + timestamp)
+      }
+    end
+
+    def timestamp
+      Time.now.strftime("%Y%m%d%H%M%S")
+    end
+
+  end
+end

data/lib/yuntongxun_api/sms.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+module YunTongXun
+  module Sms
+    class << self
+      include YunTongXun::Helper
+
+      @accounts = 'Accounts'
+
+      # 短信发送
+      def send(params)
+        @method = 'SMS/TemplateSMS'
+        response = get_response(params)
+      end
+
+    end
+  end
+end

data/lib/yuntongxun_api/version.rb

@@ -0,0 +1,3 @@
+module YunTongXun
+  VERSION = "0.1.0"
+end

data/lib/yuntongxun_api/voice.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+module YunTongXun
+  module Voice
+    class << self
+      include YunTongXun::Helper
+
+      # 语音验证
+      def voice_verify(params)
+        @accounts = 'Accounts'
+        @method   = 'Calls/VoiceVerify'
+
+        response = get_response(params)
+      end
+
+      # 电话回拨
+      def double_call(params)
+        @accounts = 'SubAccounts'
+        @method   = 'Calls/Callback'
+
+        response = get_response(params)
+      end
+
+      # 取消回拨
+      def cancel_call(params)
+        @accounts = 'Accounts'
+        @method   = 'Calls/CallCancel'
+
+        response = get_response(params)
+      end
+
+      # 外呼通知
+      def landing_call(params)
+        @accounts = 'Accounts'
+        @method   = 'Calls/LandingCalls'
+
+        response = get_response(params)
+      end
+
+    end
+  end
+end

data/lib/yuntongxun_api.rb

@@ -0,0 +1,22 @@
+require "yuntongxun_api/version"
+require "yuntongxun_api/configuration"
+require "yuntongxun_api/helper"
+require "yuntongxun_api/sms"
+require "yuntongxun_api/voice"
+require "logger"
+
+module YunTongXun
+  class << self
+    def setup
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end

data/yuntongxun_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 'yuntongxun_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yuntongxun_api"
+  spec.version       = YunTongXun::VERSION
+  spec.authors       = ["skji"]
+  spec.email         = ["jishankai@qq.com"]
+
+  spec.summary       = %q{容联·云通讯SDK Ruby版}
+  spec.description   = %q{容联·云通讯SDK Ruby版 提供短信，语音验证码，电话回拨和外呼通知等功能}
+  spec.homepage      = "https://github.com/skji/yuntongxun_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: yuntongxun_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- skji
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: "容联·云通讯SDK Ruby版 提供短信，语音验证码，电话回拨和外呼通知等功能"
+email:
+- jishankai@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yuntongxun_api.rb
+- lib/yuntongxun_api/configuration.rb
+- lib/yuntongxun_api/helper.rb
+- lib/yuntongxun_api/sms.rb
+- lib/yuntongxun_api/version.rb
+- lib/yuntongxun_api/voice.rb
+- yuntongxun_api.gemspec
+homepage: https://github.com/skji/yuntongxun_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.6.3
+signing_key: 
+specification_version: 4
+summary: "容联·云通讯SDK Ruby版"
+test_files: []