cloopen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3d825e322649ecf2230a69f8e84bf87eeb1182b
+  data.tar.gz: c1ce494e43f85e2d67c92359ce90b761e5c2fc87
+SHA512:
+  metadata.gz: 7b6b89a11ac44e8fd280a18f8ba4d3596eb9a4caecbefd50260439f85b5abeeff4356632050b3c12abe92e639756f255f119999c57ffcdd9f2e8dc35c8a6c2b7
+  data.tar.gz: 285d758754ac8a568f66ea3332304cd0c6859f389e8d0282581abb70e76570f9715c84dcb22ac17296f963b061f53fa671eb854f53ca7cc8a40af7b66f46c99b

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 xiaoronglv
+
+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,71 @@
+# Cloopen
+
+云通讯发送短信的 Gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cloopen'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloopen
+
+## Usage
+
+### 申请云通讯的短信通道服务
+
+1. 注册 [云通讯](http://www.yuntongxun.com) ，申请企业认证（只有企业帐号才可以发短信）。
+
+2. 在 [这个页面](http://www.yuntongxun.com/member/main) 查看帐号的 account_sid, auth_token
+
+3. 在 [这个页面](http://www.yuntongxun.com/member/app/view) 创建 App，获得 app_id
+
+4. 在 [这里](http://www.yuntongxun.com/member/smsTemplate/view) 创建你的短信模板，比如：
+
+    `【薄荷网】您的的验证码是{1}`
+
+5. 等待云通讯的管理员审核，大概需要 2 个小时的时间。
+
+    * App 通过审核
+    * 短信模板通过审核
+
+### 生成配置文件
+
+1. 执行 `rails g cloopen` 生成配置文件 `config/initialiers/cloopen_setup.rb`
+
+2. 替换 sid、token、app_id、env
+
+```ruby
+# config/initialiers/cloopen_setup.rb
+Cloopen.account_sid = "Your Yuntongxun Account Sid"
+Cloopen.auth_token = "Your Yuntongxun Auth token"
+Cloopen.app_id = "Your Yuntongxun App id"
+Cloopen.env = "production" # 如果是测试环境，填写 "development"
+```
+
+
+### 发送短信
+
+```ruby
+  Cloopen::SMS.deliver(18668189883, 3127, ['a32d1k'])
+```
+* 第一个参数是手机号码
+
+* 第二个是模板id。只有模板通过审核后，才可以用这个模板发短信。
+
+* 第三个是模板中的变量的值。用于替换  `【薄荷网】您的的验证码是{1}` 中的变量。
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cloopen/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/cloopen.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloopen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloopen"
+  spec.version       = Cloopen::VERSION
+  spec.authors       = ["xiaoronglv"]
+  spec.email         = ["xiaoronglv@hotmail.com"]
+  spec.summary       = %q{ call yuntongxun Api to send short message. }
+  spec.description   = %q{ call yuntongxun Api to send short message. }
+  spec.homepage      = "https://github.com/xiaoronglv/cloopen"
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rest-client"
+end

data/lib/cloopen.rb

@@ -0,0 +1,9 @@
+require "cloopen/version"
+require "cloopen/sms"
+require "cloopen/sign"
+
+module Cloopen
+  class << self
+    attr_accessor :account_sid, :auth_token, :app_id, :env
+  end
+end

data/lib/cloopen/sign.rb

@@ -0,0 +1,18 @@
+require 'digest/md5'
+require 'base64'
+
+module Cloopen
+  class Sign
+    # 生成验证参数
+    # 1. SigParameter
+    # 2. Authorization
+    def self.generate_sig_and_auth
+      time = Time.now.strftime("%Y%m%d%H%M%S")
+      sig_parameter = Digest::MD5.hexdigest(Cloopen.account_sid + Cloopen.auth_token + time).upcase
+      authorization = Base64.strict_encode64("#{Cloopen.account_sid}:#{time}")
+      [sig_parameter, authorization]
+    end
+
+  end
+
+end

data/lib/cloopen/sms.rb

@@ -0,0 +1,50 @@
+require 'rest_client'
+require 'uri'
+require 'json'
+
+module Cloopen
+  class SMS
+    def initialize(cellphone, tmpl_id, contents)
+      @cellphone   = cellphone
+      @template_id = tmpl_id
+      @contents    = contents
+      @sig_parameter, @authorization = Sign.generate_sig_and_auth
+    end
+
+    def deliver
+      if Cloopen.env == "production"
+        base_uri = "https://app.cloopen.com:8883/2013-12-26/Accounts/"
+      else
+        base_uri = "https://sandboxapp.cloopen.com:8883/2013-12-26/Accounts/"
+      end
+
+      sms_url = "#{base_uri}#{Cloopen.account_sid}/SMS/TemplateSMS?sig=#{@sig_parameter}"
+
+      payload = {
+        to:         @cellphone,
+        appId:      Cloopen.app_id,
+        templateId: @template_id,
+        datas:      @contents
+      }.to_json
+
+      header = {
+        "Content-type"  => "application/json;charset=utf-8",
+        "Accept"        => "application/json",
+        "Authorization" => @authorization
+      }
+
+      res = JSON.parse(RestClient.post sms_url, payload, header)
+      [res["statusCode"], res["statusMsg"]]
+    end
+
+    # 发送短信
+    # Cloopen::SMS.deliver(18668189882, 3127, ["w1n2ty"])
+    # 手机号: 18668189882
+    # 模板 id: 3127
+    # 模板变量替换值: ["w1n2ty"]
+    def self.deliver(cellphone, tmpl_id, contents)
+      sms = new(cellphone, tmpl_id, contents)
+      sms.deliver
+    end
+  end
+end

data/lib/cloopen/version.rb

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

data/lib/generators/cloopen/cloopen_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+class CloopenGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def install
+    template "cloopen_setup.rb", "config/initializers/cloopen_setup.rb"
+  end
+
+end

data/lib/generators/cloopen/templates/cloopen_setup.rb

@@ -0,0 +1,8 @@
+##### 云通讯的配置文件 ####
+
+Cloopen.setup do |config|
+  config.account_sid = "YOUR_ACCOUNT_SID"
+  config.auth_token  = "YOUR_AUTH_TOKEN"
+  config.app_id = "YOUR_APP_ID"
+  config.env = "production"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: cloopen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- xiaoronglv
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rest-client
+  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'
+description: ' call yuntongxun Api to send short message. '
+email:
+- xiaoronglv@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cloopen.gemspec
+- lib/cloopen.rb
+- lib/cloopen/sign.rb
+- lib/cloopen/sms.rb
+- lib/cloopen/version.rb
+- lib/generators/cloopen/cloopen_generator.rb
+- lib/generators/cloopen/templates/cloopen_setup.rb
+homepage: https://github.com/xiaoronglv/cloopen
+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.2.2
+signing_key: 
+specification_version: 4
+summary: call yuntongxun Api to send short message.
+test_files: []