aliyun-mqs 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abd6a6844d4985d359ec5a61d4623b989523ca02
+  data.tar.gz: 0d659d51d20a37c68faa71aa32e1e32f87590e52
+SHA512:
+  metadata.gz: 8f973502a48e1a9937dff5abd27e99b917d2e04eb14a5ffe729b7f5eed90841af9a84f6a8153559a8f8babb5c6c01c90f159808f8f5e04751e2cb787e42d00cd
+  data.tar.gz: ed4cdf563e6e182b52c63bf13cf42551df76d90d9771e2576a5b9b84e67866773e892a3da5a66fb2708c8bf2845dc3e55543e0d3e02d4b4c643728f0fe7c2972

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 MgaMPKAy
+
+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,131 @@
+# aliyun-mqs
+
+Talk to the mighty Aliyun MQS with charming ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aliyun-mqs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aliyun-mqs
+
+## Usage
+
+### Require
+
+```ruby
+require 'aliyun/mqs'
+```
+
+###
+
+### Configure
+
+```ruby
+Aliyun::Mqs.configure do |config|
+  config.access_key_id     = '0123456789ABCDEF'
+  config.access_key_secret = '*********************'
+  config.access_region     = 'cn-hangzhou'
+  config.access_owner_id   = 'cirno'
+end
+```
+
+### Response
+
+Most API returns a `Response` object, which contains status and all leaf element in the XML response.
+Eg: Every leaf element of
+
+```xml
+<?xml version="1.0"?>
+<Message xmlns="http://mqs.aliyuncs.com/doc/v1">
+  <MessageBodyMD5>654E27D8879283831B664BD8B7F0AD4</MessageBodyMD5>
+  <MessageId>6003A74BEB1D5460-1-147DF4497D4-200000024</MessageId>
+</Message>
+```
+can be accessed as:
+
+```ruby
+Aliyun::Response::message_body_md5
+Aliyun::Response::message_id
+```
+
+To determine wheater a request call is succeed, use `Response::success?`. `Response` is an imutable object, all instance method with side-effects will return a new instance of `Response`. So, instead of
+
+```ruby
+message = queue.receive         # message is an Response
+message.visibility = 1.minute
+message.visibility = 8.minute   # wrong, reuse receipt handle
+```
+
+you shoud pass the return value (agian, an `Response`) around:
+
+```ruby
+resp = queue.receive
+resp = resp.visibility = 1.minute
+resp = resp.visibility = 8.minute
+```
+
+### Get an existing queue
+
+```ruby
+queue = Aliyun::Mqs.get 'queue-name'
+queue = Aliyun::Mqs.get 'queue-name', :access_owner_id: 'your_id'
+```
+
+### Delete a queue
+
+```ruby
+queue.destroy
+```
+
+### Send messages
+
+```ruby
+resp = queue.send "Hello, World!"
+resp = queue.send "Hello, Cirno!", delay_seconds: 9, priority: 9
+```
+
+### Recveive messages
+
+```ruby
+message = queue.receive
+message = queue.receive waitseconds: 10, peekonly: true
+message = queue.peek
+```
+
+### Delete messages
+
+```ruby
+message.delete
+queue.delete message
+queue.delete "#{you_message_recipet_handlerer}"
+```
+
+### Change message visibility (not implemented yet)
+
+```ruby
+resp = message.visibility = Time.now + 1.hour
+resp = message.visibility = Time.now.to_f * 1000 + 10
+resp = message.visibility += 1.hour
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/mgampkay/aliyun-mqs/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
+
+## References
+
++ xiaohuilam's [aliyun-mqs-php-library](https://github.com/xiaohuilam/aliyun-mqs-php-library)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/aliyun-mqs.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aliyun/mqs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aliyun-mqs'
+  spec.version       = Aliyun::Mqs::VERSION
+  spec.authors       = ["mgampkay"]
+  spec.email         = ["mgampkay@gmail.com"]
+  spec.summary       = 'Ruby SDK for Aliyun MQS (non-official)'
+  spec.description   = 'Non-official SDK for Aliyun MQS'
+  spec.homepage      = 'https://github.com/mgampkay/aliyun-mqs'
+  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_dependency 'nokogiri', '>= 1.6'
+  spec.add_dependency 'activesupport', '>= 4.1'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/aliyun/mqs.rb

@@ -0,0 +1,27 @@
+require 'aliyun/mqs/version'
+require 'aliyun/mqs/queue'
+require 'aliyun/mqs/response'
+require 'aliyun/mqs/configuration'
+require 'aliyun/mqs/http'
+
+module Aliyun
+  module Mqs
+
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.get(name,  access_owner_id: nil)
+      Aliyun::Mqs::Queue.new(name, access_owner_id: access_owner_id)
+    end
+
+  end
+end

data/lib/aliyun/mqs/configuration.rb

@@ -0,0 +1,8 @@
+module Aliyun
+  module Mqs
+    class Configuration
+      attr_accessor :access_key_id, :access_key_secret, :access_region
+      attr_accessor :access_owner_id
+    end
+  end
+end

data/lib/aliyun/mqs/http.rb

@@ -0,0 +1,58 @@
+require 'base64'
+require 'date'
+require 'digest'
+require 'net/http'
+require 'uri'
+
+module Aliyun
+  module Mqs
+    module Http
+      Version     = '2014-07-08'
+      ContentType = 'text/xml;utf-8'
+
+      def send_request(verb, request_uri, body = '')
+        uri = URI.parse(request_uri)
+        content_md5 = Base64::encode64(Digest::MD5.hexdigest body).chop
+        gmt_date = DateTime.now.httpdate
+        mqs_headers = {'x-mqs-version' => Version}
+        headers = {'Host' => uri.host,
+                   'Date' => gmt_date,
+                   'Content-Type' => ContentType,
+                   'Content-MD5' => content_md5
+                  }
+        headers.merge! mqs_headers
+        resource = uri.path + (uri.query != nil ? '?' + uri.query : '')
+        headers['Authorization'] = sign_header(verb, content_md5, gmt_date, mqs_headers, resource)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+
+        case verb.downcase
+        when 'get'
+          request = Net::HTTP::Get.new(uri.request_uri)
+        when 'post'
+          request = Net::HTTP::Post.new(uri.request_uri)
+          request.body = body
+        when 'delete'
+          request = Net::HTTP::Delete.new(uri.request_uri)
+        when 'put'
+          request = Net::HTTP::Put.new(uri.request_uri)
+          request.body = body
+        end
+        request.initialize_http_header(headers)
+        response = http.request(request)
+        Response.new(self, response)
+      end
+
+      def sign_header(verb, content_md5, gmt_date, mqs_headers = {}, resources = '/')
+        header = ''
+        mqs_headers.sort.each do |k,v|
+          header << k.downcase + ':'+  v + "\n"
+        end
+        sign = sprintf "%s\n%s\n%s\n%s\n%s%s", verb, content_md5, ContentType, gmt_date, header, resources
+        sign = Base64::encode64(Digest::HMAC.digest(sign, Mqs.configuration.access_key_secret, Digest::SHA1)).chop
+        "MQS #{Mqs.configuration.access_key_id}:#{sign}"
+      end
+
+    end
+  end
+end

data/lib/aliyun/mqs/queue.rb

@@ -0,0 +1,78 @@
+require 'active_support/core_ext/hash'
+require 'builder'
+require 'aliyun/mqs/http'
+
+module Aliyun
+  module Mqs
+
+    class Queue
+      include Mqs::Http
+
+      def initialize(name, access_owner_id: nil)
+        @access_key_id     = Mqs.configuration.access_key_id
+        @access_key_secret = Mqs.configuration.access_key_secret
+        @access_region     = Mqs.configuration.access_region
+        @access_owner_id   = access_owner_id || Mqs.configuration.access_owner_id
+        @access_queue = name
+        @access_host  = "#{@access_owner_id}.mqs-#{@access_region}.aliyuncs.com"
+        throw '参数不能为nil' if instance_variables.any? {|x| x == nil}
+      end
+
+
+      def destroy
+        verb = 'DELETE'
+        request_resource = "/#{@access_queue}"
+        request_uri = "http://#{@access_host}#{request_resource}"
+        send_request(verb, request_uri)
+      end
+
+      def send(message_body, delay_seconds: 0, priority: 8)
+        verb = 'POST'
+        content_body = to_xml(message_body, delay_seconds, priority)
+        request_resource = "/#{@access_queue}/messages"
+        request_uri = "http://#{@access_host}#{request_resource}"
+        send_request(verb, request_uri, content_body)
+      end
+
+      def receive(waitseconds: nil, peekonly: false)
+        verb = 'GET'
+        query_params = {}
+        query_params[:waitseconds] = waitseconds if waitseconds
+        query_params[:peekonly] = true if peekonly # Aliyun doesn't accept uncessary query params
+        request_resource =  "/#{@access_queue}/messages" + (query_params.length > 0 ? '?' + query_params.to_param : '')
+        request_uri      = "http://#{@access_host}#{request_resource}"
+        send_request(verb, request_uri)
+      end
+
+      def delete message
+        verb = 'DELETE'
+        if String === message
+          receipt_handle = message
+        elsif Response === message
+          receipt_handle = message.receipt_handle
+        end
+        request_resource = "/#{@access_queue}/messages?" + {ReceiptHandle: receipt_handle}.to_param
+        request_uri = "http://#{@access_host}#{request_resource}"
+        send_request(verb, request_uri)
+      end
+
+      def peek(waitseconcds: nil)
+        receive(waitseconds: waitseconcds, peekonly: true)
+      end
+
+      private
+
+      def to_xml(message_body, delay_seconds, priority)
+        xml = Builder::XmlMarkup.new( :indent => 2 )
+        xml.instruct! :xml, :encoding => 'UTF-8'
+        xml.Message(:xmlns => 'http://mqs.aliyuncs.com/doc/v1/') do |m|
+          m.MessageBody message_body
+          m.DelaySeconds delay_seconds
+          m.Priority priority
+        end
+      end
+
+    end
+
+  end
+end

data/lib/aliyun/mqs/response.rb

@@ -0,0 +1,46 @@
+require 'nokogiri'
+require 'active_support/core_ext/string/inflections'
+
+module Aliyun
+  module Mqs
+
+    class Response
+
+      def initialize(queue, response)
+        @queue = queue
+        @success = (response.code =~ /^20./) == 0
+        if response.body
+          begin
+            xml_to_attribute(response.body)
+          end
+        end
+      end
+
+      def success?
+        @success
+      end
+
+      def delete
+        @queue.delete self
+      end
+
+      private
+
+      def xml_to_attribute(xml)
+        Nokogiri::XML(xml).root.children.each do |child|
+          if child.element?
+            name  = child.name.underscore
+            value = child.content.to_s
+            value = Time.at(value.to_f / 1000) if name.end_with?('_time')
+            define_singleton_method name do
+              instance_variable_get ('@' + name)
+            end
+            self.instance_variable_set('@' + name, value)
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/aliyun/mqs/version.rb

@@ -0,0 +1,5 @@
+module Aliyun
+  module Mqs
+    VERSION = "0.0.3"
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: aliyun-mqs
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- mgampkay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: Non-official SDK for Aliyun MQS
+email:
+- mgampkay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aliyun-mqs.gemspec
+- lib/aliyun/mqs.rb
+- lib/aliyun/mqs/configuration.rb
+- lib/aliyun/mqs/http.rb
+- lib/aliyun/mqs/queue.rb
+- lib/aliyun/mqs/response.rb
+- lib/aliyun/mqs/version.rb
+homepage: https://github.com/mgampkay/aliyun-mqs
+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: Ruby SDK for Aliyun MQS (non-official)
+test_files: []