alidayu-sms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 036c0a3bcf59057018aab95aeee0eb309b36c690
+  data.tar.gz: 5958f8e2aece43c3c89bdf7743e358b1c43c62b6
+SHA512:
+  metadata.gz: 115438d024fea75816aaa2273dc905b40260d5cedad826cddfa111c0d3c0c55e75c77d319ff5c936c22c01635be590c22176b5f8802a31ee85336ed1cff35367
+  data.tar.gz: '03914b905d94c5ae519bcf546d5dafc9949e61817bd82bfc0537a2fc33d36f92320684ae5db98ac6becee855b4e6223e0bae73bee4c406acb9c2a5501fed4cac'

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.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 alidayu-sms.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Charles
+
+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,58 @@
+## Alidayu-sms ##
+
+ Alidayu sms sdk ruby version of Aliyun(阿里云阿里大于短信SDK).
+
+
+### Installation ###
+    # Manually from RubyGems.org
+    $ gem install alidayu-sms
+
+    # Or Gemfile if you are using Bundler
+    $ gem alidayu-sms
+
+### Usage ###
+```ruby
+alisms = Alidayu::Sms.new(sms_template: YOUR_SMS_TEMPLATE, sms_sign: YOUR_SMS_SIGN)
+alisms.send_to(138xxxxxxxx, {code: 1234})
+# true or false
+
+# or use send! if you wanna raise error
+alisms.send_to!(138xxxxxxxx, {code: 1234})
+# true or raise Alidayu::RequestError
+```
+You can also use `send_sms` to send Alidayu sms, it's an alias of `send_to`.
+
+### Configration ###
+Before you sending any sms message, a valid configration is necessary.
+Alidayu-sms supports you use it under Rails or in pure Ruby environment.
+
+#### Rails ####
+The Alidayu-sms configuration file is a YAML file, by default located at `config/alidayu.yml`.
+You need to set your Alidayu access_key which you can get from Aliyun.
+Here is an example configuration file:
+
+```yaml
+# config/alidayu.yml
+development: &defaults
+  access_key_id: YOUR_ACCESS_KEY_ID
+  access_key_secret: YOUR_ACCESS_KEY_SECRET
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+```
+
+#### Non-rails ####
+If you are using Sinatra or anything pure Ruby, use `Alidayu::Sms.configration` to configrate Alidayu-sms.
+
+```ruby
+Alidayu::Sms.configration do |config|
+  config.access_key_id = YOUR_ACCESS_KEY_ID
+  config.access_key_secret = YOUR_ACCESS_KEY_SECRET
+end
+```
+
+### License ###
+Released under the [MIT](http://opensource.org/licenses/MIT) license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alidayu-sms.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "alidayu/sms/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "alidayu-sms"
+  spec.version       = Alidayu::Sms::VERSION
+  spec.authors       = ["cenxky"]
+  spec.email         = ["cenxky@gmail.com"]
+
+  spec.summary       = "Alidayu sms sdk ruby version of Aliyun."
+  spec.description   = "Alidayu sms sdk ruby version of Aliyun."
+  spec.homepage      = "https://github.com/cenxky/alidayu-sms"
+  spec.license       = "MIT"
+
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

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

@@ -0,0 +1,5 @@
+module Alidayu
+  class Sms
+    VERSION = "0.1.0"
+  end
+end

data/lib/alidayu/sms.rb

@@ -0,0 +1,116 @@
+require_relative 'sms/version'
+%w(securerandom net/http ostruct openssl base64 yaml json cgi uri).each{|_| require _}
+
+module Alidayu
+  class SettingError < StandardError; end
+  class RequestError < StandardError; end
+
+  class Sms
+    SMS_ENDPOINT = 'http://dysmsapi.aliyuncs.com'
+    attr :signature, :template
+
+    class << self
+      def configuration
+        @setting = OpenStruct.new
+        yield @setting
+      end
+
+      def setting
+        return @setting if @setting && !@setting.to_h.nil?
+        if defined?(Rails)
+          config = YAML.load_file("#{Rails.root}/config/alidayu.yml")[Rails.env]
+          if !config.nil? then @setting = OpenStruct.new config else
+            raise SettingError, setting_error_message(:rails)
+          end
+        else
+          raise SettingError, setting_error_message
+        end
+      end
+
+      private
+
+      def setting_error_message(reason = :configuration)
+        base_message = 'You have not set access_key_id and access_key_secret '
+        case reason
+          when :configuration
+            base_message << 'by Alidayu::Sms.configuration'
+          when :rails
+            base_message << "in config/alidayu.yml for #{env} environment"
+        end
+      end
+    end
+
+    def initialize(options)
+      @template  = options[:sms_template]
+      @signature = options[:sms_sign]
+
+      endpoint = URI setting.endpoint || SMS_ENDPOINT
+      @conn = Net::HTTP.new(endpoint.host, endpoint.port).tap do |http|
+        http.open_timeout = 3
+        http.read_timeout = 3
+      end
+    end
+
+    def send_to!(reciever, params = {})
+      reciever   = Array(reciever).join(',')
+      sms_params = default_params(reciever, params)
+      sig_params = params_with_sign(setting.access_key_secret, sms_params)
+      response   = @conn.request_post '/', params_string(sig_params)
+      result     = JSON.parse response.body
+      if result['Code'] != 'OK'
+        raise RequestError, "#{result['Code']} #{result['Message']}"
+      end
+      true
+    end
+
+    def send_to(*args)
+      send!(*args) rescue false
+    end
+
+    alias send_sms send_to
+    alias send_sms! send_to!
+
+    private
+
+    def default_params(reciever, params)
+      {
+        'AccessKeyId'      => setting.access_key_id,
+        'Action'           => 'SendSms',
+        'Format'           => 'JSON',
+        'RegionId'         => 'cn-hangzhou',
+        'SignName'         => signature,
+        'PhoneNumbers'     => reciever,
+        'TemplateParam'    => params.to_json,
+        'SignatureMethod'  => 'HMAC-SHA1',
+        'SignatureNonce'   => SecureRandom.uuid,
+        'SignatureVersion' => '1.0',
+        'TemplateCode'     => template,
+        'Timestamp'        => Time.now.utc.strftime('%FT%TZ'),
+        'Version'          => '2017-05-25'
+      }
+    end
+
+    def setting
+      self.class.setting
+    end
+
+    def params_with_sign(key_secret, params)
+      params.merge 'Signature' => sign(key_secret, params)
+    end
+
+    def xencode(str)
+      CGI.escape(str).gsub('+', '%20').gsub('*', '%2A').gsub('%7E', '~')
+    end
+
+    def sign(key_secret, params)
+      key = key_secret + '&'
+      str = 'POST&%2F&' + xencode(params_string params)
+      Base64.strict_encode64 OpenSSL::HMAC.digest('sha1', key, str)
+    end
+
+    def params_string(params)
+      params.sort.map{|arr| arr.map{|e| xencode e}.join('=')}.join('&')
+    end
+
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: alidayu-sms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cenxky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: Alidayu sms sdk ruby version of Aliyun.
+email:
+- cenxky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alidayu-sms.gemspec
+- bin/console
+- bin/setup
+- lib/alidayu/sms.rb
+- lib/alidayu/sms/version.rb
+homepage: https://github.com/cenxky/alidayu-sms
+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.11
+signing_key: 
+specification_version: 4
+summary: Alidayu sms sdk ruby version of Aliyun.
+test_files: []