aliyun-push 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb9b4e910bb1cbba8681733abfac3ed114e03a2d
+  data.tar.gz: 290214566529d65ad671037901eb90096861ae20
+SHA512:
+  metadata.gz: 250140b99498221f3e2139c6a5fa8cf06af690c5e7881dc8615795e5707f2786d7f3d5b00739f50821fd0ccab5db3c45e1446e186c01f020e2035f0b21ffd813
+  data.tar.gz: d7027ba3a95ad47d8baace0a083ea6aa3ec2026de5d3af5bc1a15ebd11568d7123c6cbbd85ad665e36cb6c6983272261f5e826fbb7064ccc13fdfb3b9dbe0a25

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Eric Zhang
+
+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,56 @@
+# aliyun-push-ruby-sdk
+
+Ruby wrapper of Aliyun push service.
+I'm using it in production, and it works well.
+
+## Installation
+
+Add `gem 'aliyun-push'` to your application's Gemfile:
+
+    gem 'aliyun-push'
+    
+And then run:
+
+    $ bundle install
+    
+Or install it with gem command:
+
+    $ gem install aliyun-push
+    
+## Usage
+
+Example:
+
+```ruby
+require 'aliyun-push'
+
+client = AliyunPush::Client.new('your_access_key_id', 'your_access_key_secret')
+puts client.send_request(Action: 'Push',
+  AppKey: 'your app key',
+  Body: 'test',
+  Summary: 'test2',
+  DeviceType: '3',
+  Target: 'account',
+  TargetValue: '16',
+  ApnsEnv: 'PRODUCT',
+  StoreOffline: false,
+  Type: '1',
+  Title: 'test1',
+  Remind: false)
+
+# documentation for the parameterss: https://help.aliyun.com/document_detail/30074.html
+```
+
+You can create/fetch `access key` and `secret` at [https://i.aliyun.com/access_key](https://i.aliyun.com/access_key)
+
+## Contributing
+
+1. Fork it ( https://github.com/qinix/aliyun-push-ruby-sdk/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
+
+## Author
+
+* [Eric Zhang](https://github.com/qinix)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/aliyun-push.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "aliyun-push"
+  gem.version       = "0.1.0"
+  gem.authors       = ["Eric Zhang"]
+  gem.email         = ["i@qinix.com"]
+  gem.description   = %q{Ruby SDK for Aliyun push service}
+  gem.summary       = %q{Ruby SDK for Aliyun push service}
+  gem.homepage      = "https://github.com/qinix/aliyun-push-ruby-sdk"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'httparty', '~> 0.13.7'
+
+end

data/lib/aliyun-push.rb

@@ -0,0 +1,2 @@
+require 'aliyun-push/parameter_set'
+require 'aliyun-push/client'

data/lib/aliyun-push/client.rb

@@ -0,0 +1,39 @@
+require 'securerandom'
+require 'aliyun-push/parameter_set'
+require 'httparty'
+
+module AliyunPush
+  class Client
+    def initialize(access_key_id, access_key_secret, region = 'cn-hangzhou')
+      @base_url = "https://cloudpush.aliyuncs.com/"
+      @region = region
+      @access_key_id = access_key_id
+      @access_key_secret = access_key_secret
+    end
+
+    def send_request(params)
+      default_params = {
+        Format: 'JSON',
+        RegionId: @region,
+        Version: '2015-08-27',
+        AccessKeyId: @access_key_id,
+        SignatureMethod: 'HMAC-SHA1',
+        Timestamp: Time.now.utc.iso8601,
+        SignatureVersion: '1.0',
+        SignatureNonce: SecureRandom.uuid
+      }
+
+      params.each do |key, val|
+        default_params[key.to_sym] = val
+      end
+
+      ps = ParameterSet.new
+      default_params.each do |key, val| 
+        ps.add key.to_s, val.to_s
+      end
+      ps.add 'Signature', ps.sign(@access_key_secret)
+      request_url = "#{@base_url}?#{ps.concatenate}"
+      HTTParty.get request_url
+    end
+  end
+end

data/lib/aliyun-push/parameter_set.rb

@@ -0,0 +1,36 @@
+require 'cgi'
+require 'openssl'
+require 'base64'
+require 'time'
+
+module AliyunPush
+  class AliyunPush::ParameterSet
+    def initialize
+      @params = {}
+    end
+
+    def add(key, value)
+      @params[key] = value
+    end
+
+    def concatenate
+      @params.sort_by{ |key, value| key }.to_h.map do |key, value|
+        "#{custom_url_encode(key)}=#{custom_url_encode(value)}"
+      end.join '&'
+    end
+
+    def string_to_sign
+      "GET&%2F&#{CGI.escape(concatenate)}"
+    end
+
+    def sign(access_key_secret)
+      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), access_key_secret + '&', string_to_sign)).strip
+    end
+
+    private
+
+    def custom_url_encode(str)
+      CGI.escape(str).sub('+', '%20').sub('*', '%2A').sub('%7E', '~')
+    end
+  end
+end

data/test/test_parameters.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require 'aliyun-push'
+
+class ParametersTest < Minitest::Test
+  def test_parameters
+    ps = AliyunPush::ParameterSet.new
+    ps.add 'Format', 'XML'
+    ps.add 'AccessKeyId', 'testid'
+    ps.add 'Action', 'GetDeviceInfos'
+    ps.add 'SignatureMethod', 'HMAC-SHA1'
+    ps.add 'RegionId', 'cn-hangzhou'
+    ps.add 'Devices', 'e2ba19de97604f55b165576736477b74,92a1da34bdfd4c9692714917ce22d53d'
+    ps.add 'SignatureNonce', 'c4f5f0de-b3ff-4528-8a89-fa478bda8d80'
+    ps.add 'SignatureVersion', '1.0'
+    ps.add 'Version', '2015-08-27'
+    ps.add 'AppKey', '23267207'
+    ps.add 'Timestamp', '2016-03-29T03:59:24Z'
+
+    assert_equal 'GET&%2F&AccessKeyId%3Dtestid%26Action%3DGetDeviceInfos%26AppKey%3D23267207%26Devices%3De2ba19de97604f55b165576736477b74%252C92a1da34bdfd4c9692714917ce22d53d%26Format%3DXML%26RegionId%3Dcn-hangzhou%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3Dc4f5f0de-b3ff-4528-8a89-fa478bda8d80%26SignatureVersion%3D1.0%26Timestamp%3D2016-03-29T03%253A59%253A24Z%26Version%3D2015-08-27',
+      ps.string_to_sign
+
+    assert_equal 'Q4jj5vC+NRtz294V+oIW7gfaJ6U=',
+      ps.sign('testsecret')
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: aliyun-push
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: Ruby SDK for Aliyun push service
+email:
+- i@qinix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- aliyun-push.gemspec
+- lib/aliyun-push.rb
+- lib/aliyun-push/client.rb
+- lib/aliyun-push/parameter_set.rb
+- test/test_parameters.rb
+homepage: https://github.com/qinix/aliyun-push-ruby-sdk
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Aliyun push service
+test_files:
+- test/test_parameters.rb