aliyun-sms-ruby-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4163c9ecf859f0c8881982bea685033e94b282e7
+  data.tar.gz: 21ba7bbd57bdc265195261659dbbbd3e3ca4d74f
+SHA512:
+  metadata.gz: c7e960cc5f7b523989e51d29e1a5074f6802b76be4a2027d0786bfbc48bb2c8607bae4dfbac72dceb7f8245ac4beb6583ada761b5e5cf9f5111ea84cade2fa82
+  data.tar.gz: bfdaed03b3b26466bf9833c280431515ed293a6b0cbe7827a5666a9dc7da9604fe448a1c9641adf0e96789e294a1d75b04eb7b9dbb9e9901f7237ca92ec165cd

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

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 tianlu1677@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-sms-ruby-sdk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 tianlu1677
+
+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,82 @@
+# 阿里云短信服务
+这里借鉴了 [aliyun-sms](https://github.com/VICTOR-LUO-F/aliyun-sms) 主要的签名算法。
+[官网短信发送说明](https://help.aliyun.com/document_detail/44362.html?spm=5176.doc44364.2.1.A5oJFn)
+这里没有依赖第三方 Gem,适合低版本的ruby使用。
+
+## 安装
+在应用的 Gemfile 文件中添加 Ruby Gems 安装源:
+
+```ruby
+gem 'aliyun-sms-ruby-sdk'
+```
+
+应用的根目录下运行:
+
+    $ bundle
+
+或者直接在ruby下安装
+
+    $ gem install aliyun-sms-ruby-sdk
+
+## 具体使用
+### 1. 创建配置文件 
+
+`config/initializers/aliyun-sms-ruby-sdk.rb`
+
+```ruby
+Aliyun::Sms::PhoneCode.configure do |config|
+  config.access_key_secret = ACCESS_KEY_SECRET # 阿里云接入密钥，在阿里云控制台申请
+  config.access_key_id = ACCESS_KEY_ID         # 阿里云接入 ID, 
+  config.sign_name = SIGN_NAME                 # 短信签名，在阿里云申请开通短信服务时申请获取在阿里云控制台申请
+  
+  #config.action = 'SingleSendSms'              # 默认设置，如果没有特殊需要，可以不改
+  #config.format = 'JSON'                       # 短信推送返回信息格式，可以填写 'JSON'或者'XML'
+  #config.region_id = 'cn-hangzhou'             # 默认设置，如果没有特殊需要，可以不改      
+  
+  #config.signature_method = 'HMAC-SHA1'        # 加密算法，默认设置，不用修改
+  #config.signature_version = '1.0'             # 签名版本，默认设置，不用修改
+  #config.sms_version = '2016-09-27'            # 服务版本，默认设置，不用修改
+  end
+```
+
+### 2. 调用方法发送短信
+
+```ruby
+ Aliyun::Sms::PhoneCode.send(template_code, phone_number, param_string)
+```
+
+参数说明：
+- 1. phone_number: 接收短信的手机号，必须为字符型，例如 '1234567890'；
+- 2. template_code: 短信模版代码，必须为字符型，申请开通短信服务后，由阿里云提供，例如 'SMS_12345678'；
+- 3. para_string: 请求字符串，向短信模版提供参数，必须为字符型的json格式，例如 '{"customer": "username"}'。
+
+在程序中可以先用 HASH 组织 param_string 内容，再使用 to_json 方法转换为 json 格式字符串，例如：
+
+```ruby
+phone_number = '1234567890'
+template_code = 'SMS_12345678'
+param_string = {'customer' => 'username'}.to_json
+Aliyun::Sms::PhoneCode.send(template_code, phone_number, param_string)
+```
+
+## 修改测试
+在根目录下
+
+```ruby
+ ruby -Ilib:test test/aliyun/sms/test_phone_code.rb
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aliyun-sms-ruby-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/aliyun-sms-ruby-sdk.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aliyun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aliyun-sms-ruby-sdk"
+  spec.version       = Aliyun::VERSION
+  spec.authors       = ["tianlu1677"]
+  spec.email         = ["tianlu1677@gmail.com"]
+
+  spec.summary       = %q{Use aliyun-sms to send phone code or email.}
+  spec.description   = %q{Aliyun can support stable service on phone code and email, it is a good choise.}
+  spec.homepage      = "http://github.com/tianlu1677."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

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

@@ -0,0 +1 @@
+require "aliyun/sms/phone_code"

data/lib/aliyun/sms/phone_code.rb

@@ -0,0 +1,110 @@
+require 'aliyun/version'
+require 'net/http'
+require 'openssl'
+require 'base64'
+require 'uri'
+require 'erb'
+include ERB::Util
+
+module Aliyun
+	module Sms
+		class PhoneCode
+			attr_accessor :access_key_secret, 
+										:access_key_id, 
+										:action,
+										:format,
+										:region_id,
+										:sign_name, 
+										:signature_method, 
+										:signature_version, 
+										:sms_version
+			def initialize
+				@access_key_secret = ''
+        @access_key_id = ''
+        @sign_name = ''
+        @action ||= 'SingleSendSms'
+        @format ||= 'JSON' 
+        @region_id ||= 'cn-hangzhou' 
+        @signature_method ||= 'HMAC-SHA1'
+        @signature_version ||= '1.0'
+        @sms_version ||= '2016-09-27' 
+			end
+
+			class << self
+				attr_writer :configuration
+
+				def configuration
+					@configuration ||= PhoneCode.new
+				end
+
+				def configure
+					yield(configuration)
+				end
+
+				def create_params(template_code, phone_number, content)
+					sms_params ={
+	          'AccessKeyId' 			=> configuration.access_key_id,
+	          'Action' 						=> configuration.action,
+	          'Format' 						=> configuration.format,
+	          'ParamString' 			=> message_param,
+	          'RecNum' 						=> phone_number,
+	          'RegionId' 					=> configuration.region_id,
+	          'SignName' 					=> configuration.sign_name,
+	          'SignatureMethod' 	=> configuration.signature_method,
+	          'SignatureNonce' 		=> seed_signature_nonce,
+	          'SignatureVersion' 	=> configuration.signature_version,
+	          'TemplateCode' 			=> template_code,
+	          'Timestamp' 				=> seed_timestamp,
+	          'Version' 					=> configuration.sms_version,
+        	}
+				end
+
+				# TODO: 错误处理
+				def send(template_code, phone_number, params)
+					Net::HTTP.post( 
+							URI("https://sms.aliyuncs.com"), 
+							headers: {"Content-Type": "application/x-www-form-urlencoded"},
+							body: sign_result(configuration.access_key_secret, params)
+						)
+				end
+
+				def sign_result(key_secret, params)
+					body_data = "Signature=" + sign(key_secret, params) + '&' + query_string(params)
+				end
+
+				def sign(key_secret, params)
+					signature = 'POST' + '&' + encode('/') + '&' + encode(URI.encode_www_form(params))
+					sign = Base64.encode64(OpenSSL::HMAC.digest('sha1', "#{key_secret}&", signature))
+					encode(sign.chomp)
+				end
+
+				private
+				def encode(input)
+					ERB::Util.url_encode(input)
+				end
+
+	      # 原生参数拼接成请求字符串
+	      def query_string(params)
+	        qstring = ''
+	        params.each do |key, value|
+	          if qstring.empty?
+	            qstring += "#{key}=#{value}"
+	          else
+	            qstring += "&#{key}=#{value}"
+	          end
+	        end
+	        return qstring
+	      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
+
+			end
+		end
+	end
+end

data/lib/aliyun/version.rb

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

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: aliyun-sms-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tianlu1677
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Aliyun can support stable service on phone code and email, it is a good
+  choise.
+email:
+- tianlu1677@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aliyun-sms-ruby-sdk.gemspec
+- bin/console
+- bin/setup
+- lib/aliyun/sms.rb
+- lib/aliyun/sms/phone_code.rb
+- lib/aliyun/version.rb
+homepage: http://github.com/tianlu1677.
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4
+signing_key: 
+specification_version: 4
+summary: Use aliyun-sms to send phone code or email.
+test_files: []