aliyun-mqs 0.0.3 → 0.1.1

checksums.yaml

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

data/.gitignore

@@ -12,3 +12,5 @@
 *.o
 *.a
 mkmf.log
+/.ruby-version
+/.ruby-gemset

data/.travis.yml

@@ -0,0 +1,8 @@
+before_install:
+  - gem update --system 2.1.11
+scripte: "CODECLIMATE_REPO_TOKEN=d9e569a99fb83321e72de3c22e73c4ef9536726a91d524d3e08d9d1b726dcc72 bundle exec rake"
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.0"
+  - "2.1.1"

data/Gemfile

@@ -1,4 +1,5 @@
-source 'https://rubygems.org'
+source 'http://ruby.taobao.org'
 
 # Specify your gem's dependencies in mqs.gemspec
 gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,4 +1,5 @@
 # aliyun-mqs
+[![Build Status](https://travis-ci.org/skinnyworm/aliyun-mqs.svg)](https://travis-ci.org/skinnyworm/aliyun-mqs) [![Code Climate](https://codeclimate.com/github/skinnyworm/aliyun-mqs.png)](https://codeclimate.com/github/skinnyworm/aliyun-mqs) [![Code Coverage](https://codeclimate.com/github/skinnyworm/aliyun-mqs/coverage.png)](https://codeclimate.com/github/skinnyworm/aliyun-mqs) [![Gem Version](https://badge.fury.io/rb/aliyun-mqs.svg)](http://badge.fury.io/rb/aliyun-mqs)
 
 Talk to the mighty Aliyun MQS with charming ruby.
 
@@ -14,110 +15,207 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+As this branch of the gem is not yet merged into the master branch, you can not install it via `gem install` for now.
 
-    $ gem install aliyun-mqs
+## Configuration
 
-## Usage
+### Command line configuration
 
-### Require
+The gem come with a command line tool `mqs`. It can help you easily manage the aliyun mqs within the terminal. In order to use this tool, you need to provide a configuration yaml file in your home directory which contains information about your mqs access_id and keys.
+
+The configuration file should be stored at `~/.aliyun-mqs.yml`
 
-```ruby
-require 'aliyun/mqs'
 ```
 
-###
+access_id:  'lUxxxxxxxx'
+key:        'VWxxxxxxxxxxxxxxxxxxxxx'
+region:     'cn-hangzhou'
+owner_id:   'ckxxxxxxxx'
+
+```
+
+
+### Rails configuration
 
-### Configure
+If you are going to use this gem in a rails environment. You need to create a configuration file at `<RAILS_ROOT>/config/aliyun-mqs.yml`. In this way, you can use different set of queues for your development or production environments.
+
+```
+
+development:
+	access_id:  'lUxxxxxxxx'
+	key:        'VWxxxxxxxxxxxxxxxxxxxxx'
+	region:     'cn-hangzhou'
+	owner_id:   'ckxxxxxxxx'
+
+production:
+	access_id:  'lUxxxxxxxx'
+	key:        'VWxxxxxxxxxxxxxxxxxxxxx'
+	region:     'cn-hangzhou'
+	owner_id:   'ckxxxxxxxx'
+
+```
+
+### Config in an application
+
+At last you can also config the gem in place, by excute the following code before invoking and queue service.
 
 ```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'
+  config.access_id = 'access-id'
+  config.key = "key"
+  config.region = 'region'
+  config.owner_id = 'owner-id'
 end
 ```
 
-### Response
 
-Most API returns a `Response` object, which contains status and all leaf element in the XML response.
-Eg: Every leaf element of
+## Commandline
+
+This gem comes with a handy commandline tool `mqs` to help you manage your queue. Once the queue is installed. Execute 'mqs --help' to find out what commands are supported.
+
+```
+$ mqs --help
+
+Commands:
+  mqs consume [queue] -wait <wait_seconds>  # 从[queue]队列接受消息并删除
+  mqs create [queue]                        # 创建一个消息队列
+  mqs delete [queue]                        # 删除一个消息队列
+  mqs peek [queue]                          # 从[queue]队列中peek消息
+  mqs queues                                # 列出所有消息队列列表
+  mqs send [queue] [message]                # 往[queue]队列发送[message]消息
+```
+
+Following are few examples.
+
+#### 消息队列列表
+
+```
+$ mqs queues
+消息队列列表
+another
+another1
+another2
+another3
+another4
+another5
+```
+
+#### 往队列发送消息
 
-```xml
+```
+$ mqs send another "Test message"
+发送消息到another队列
 <?xml version="1.0"?>
 <Message xmlns="http://mqs.aliyuncs.com/doc/v1">
-  <MessageBodyMD5>654E27D8879283831B664BD8B7F0AD4</MessageBodyMD5>
-  <MessageId>6003A74BEB1D5460-1-147DF4497D4-200000024</MessageId>
+  <MessageBodyMD5>82DFA5549EBC9AFC168EB7931EBECE5F</MessageBodyMD5>
+  <MessageId>55D5B01D1AE93D78-1-14979D45F33-200000001</MessageId>
 </Message>
 ```
-can be accessed as:
 
-```ruby
-Aliyun::Response::message_body_md5
-Aliyun::Response::message_id
+#### Peek队列中的消息
+ ```
+$ mqs peek another
+Peek 队列another中的消息
+=============================================
+队列: another
+ID: 55D5B01D1AE93D78-1-14979D45F33-200000001
+MD5: 82DFA5549EBC9AFC168EB7931EBECE5F
+Enqueue at: 2014-11-04 16:03:21 +0800
+First enqueue at: 2014-11-04 16:03:21 +0800
+Dequeue count: 0
+Priority: 10
+=============================================
+Test message
 ```
 
-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
+#### 消费队列中的消息
+
+Be careful, consume command will first receive the message and then delete the message within a time period specfied by the queue.
+
+ ```
+$ mqs consume another
+Consume 队列another中的消息
+=============================================
+队列: another
+ID: 55D5B01D1AE93D78-1-14979D45F33-200000001
+MD5: 82DFA5549EBC9AFC168EB7931EBECE5F
+Receipt handle: 1-ODU4OTkzNDU5My0xNDE1MDg4MzU2LTEtMTA=
+Enqueue at: 2014-11-04 16:03:21 +0800
+First enqueue at: 2014-11-04 16:05:26 +0800
+Next visible at: 2014-11-04 16:05:56 +0800
+Dequeue count: 1
+Priority: 10
+=============================================
+Test message
 ```
 
-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
+## Usage
+
+Following are some example useage of the gem. You can read the specs to understand the full features of this gem
 
 ```ruby
-queue = Aliyun::Mqs.get 'queue-name'
-queue = Aliyun::Mqs.get 'queue-name', :access_owner_id: 'your_id'
-```
+#get a list of queue object
+queues = Aliyun::Mqs::Queue.queues
 
-### Delete a queue
+#get all queues start with name 'query'
+queues =Aliyun::Mqs::Queue.queues(query: "query")
 
-```ruby
-queue.destroy
-```
+#get all queues start with name 'query'
+queues = Aliyun::Mqs::Queue.queues(size: 5)
 
-### Send messages
+#Obtain a queue object with name "aQueue"
+queue = Aliyun::Mqs::Queue["aQueue"]
 
-```ruby
-resp = queue.send "Hello, World!"
-resp = queue.send "Hello, Cirno!", delay_seconds: 9, priority: 9
-```
+#Create a new queue
+Aliyun::Mqs::Queue["aQueue"].create
 
-### Recveive messages
+#Create a new queue with polling wait 30 seconds
+Aliyun::Mqs::Queue["aQueue"].create(:PollingWaitSeconds => 30)
 
-```ruby
-message = queue.receive
-message = queue.receive waitseconds: 10, peekonly: true
-message = queue.peek
-```
+#Delete an existing queue
+Aliyun::Mqs::Queue["aQueue"].delete
 
-### Delete messages
+#Send a text message
+Aliyun::Mqs::Queue["aQueue"].send_message "text message"
 
-```ruby
+#Send a text message with priority option
+Aliyun::Mqs::Queue["aQueue"].send_message "text message", :Priority=>1
+
+#Receive a message
+message = Aliyun::Mqs::Queue["aQueue"].receive_message
+
+#Sample rspec for a message
+expect(message).not_to be_nil
+expect(message.id).to eq("5fea7756-0ea4-451a-a703-a558b933e274")
+expect(message.body).to eq("This is a test message")
+expect(message.body_md5).to eq("fafb00f5732ab283681e124bf8747ed1")
+expect(message.receipt_handle).to eq("MbZj6wDWli+QEauMZc8ZRv37sIW2iJKq3M9Mx/KSbkJ0")
+expect(message.enqueue_at).to eq(Time.at(1250700979248000/1000.0))
+expect(message.first_enqueue_at).to eq(Time.at(1250700779318000/1000.0))
+expect(message.next_visible_at).to eq(Time.at(1250700799348000/1000.0))
+expect(message.dequeue_count).to eq(1)
+expect(message.priority).to eq(8)
+
+#Receive a message with option to override the default poll wait time of the queue.
+message = Aliyun::Mqs::Queue["aQueue"].receive_message wait_seconds: 60
+
+#Peek message in the queue
+message = Aliyun::Mqs::Queue["aQueue"].peek_message
+
+#Delete received message
+message = Aliyun::Mqs::Queue["aQueue"].receive_message
 message.delete
-queue.delete message
-queue.delete "#{you_message_recipet_handlerer}"
-```
 
-### Change message visibility (not implemented yet)
+#Change message visibility
+message = Aliyun::Mqs::Queue["aQueue"].receive_message
+message.change_visibility 10
 
-```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 )
@@ -125,7 +223,3 @@ resp = message.visibility += 1.hour
 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

@@ -1,2 +1,7 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+require File.join('bundler', 'gem_tasks')
+require File.join('rspec', 'core', 'rake_task')
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aliyun-mqs.gemspec

@@ -6,8 +6,8 @@ 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.authors       = ["mgampkay","skinnyworm"]
+  spec.email         = ["mgampkay@gmail.com", "askinnyworm@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'
@@ -20,7 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'nokogiri', '>= 1.6'
   spec.add_dependency 'activesupport', '>= 4.1'
+  spec.add_dependency "rest-client"
+  spec.add_dependency "thor"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
 end

data/bin/mqs

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'aliyun/mqs'
+
+Aliyun::Mqs::Cli.start(ARGV)

data/lib/aliyun/mqs.rb

@@ -1,26 +1,50 @@
+require 'active_support/core_ext'
+require 'rest-client'
+require 'nokogiri'
+require 'yaml'
 require 'aliyun/mqs/version'
-require 'aliyun/mqs/queue'
-require 'aliyun/mqs/response'
-require 'aliyun/mqs/configuration'
-require 'aliyun/mqs/http'
+# RestClient.log=STDOUT
+
+# Monkey patch hash to support xml array and xml object
+class Hash
+  def self.xml_array content, *path
+    o = xml_object(content, *path)
+    return (o.is_a?(Array) ? o : [o]).reject{|n| n.empty?}
+  end
+
+  def self.xml_object content, *path
+    h = from_xml(content)
+    path.reduce(h){|memo, node|  memo = memo[node] || {}}
+  end
+end
 
 module Aliyun
   module Mqs
+    require 'aliyun/mqs/queue'
+    require 'aliyun/mqs/message'
+    require 'aliyun/mqs/request'
+    require 'aliyun/mqs/cli'
 
     class << self
-      attr_writer :configuration
-    end
-
-    def self.configuration
-      @configuration ||= Configuration.new
-    end
+      def configuration
+        @configuration ||=  begin
+          if defined? Rails
+            config_file = Rails.root.join("config/aliyun-mqs.yml")
+          else
+            config_file = File.expand_path("~/.aliyun-mqs.yml")
+          end
 
-    def self.configure
-      yield(configuration)
-    end
+          if (File.exist?(config_file))
+            config = YAML.load(ERB.new(File.new(config_file).read).result)
+            config = config[Rails.env] if defined? Rails
+          end
+          OpenStruct.new(config || {access_id:"", key:"", region:"", owner_id:""})
+        end
+      end
 
-    def self.get(name,  access_owner_id: nil)
-      Aliyun::Mqs::Queue.new(name, access_owner_id: access_owner_id)
+      def configure
+        yield(configuration)
+      end
     end
 
   end

data/lib/aliyun/mqs/cli.rb

@@ -0,0 +1,54 @@
+require 'thor'
+
+module Aliyun::Mqs
+  class Cli < Thor
+
+    desc "queues", "列出 QueueOwnerId 下的消息队列列表"
+    def queues()
+      execute("消息队列列表"){ Queue.queues }
+    end
+
+    desc "delete [queue]", "删除一个消息队列"
+    def delete(name)
+      execute("删除消息队列'#{name}'"){ Queue[name].delete }
+    end
+
+    desc "create [queue]", "创建一个消息队列"
+    def create(name)
+      execute("创建消息队列'#{name}'"){ Queue[name].create }
+    end
+
+    desc "consume [queue] -wait <wait_seconds>", "从[queue]队列接受消息并删除"
+    option :wait
+    def consume(name)
+      execute("Consume 队列#{name}中的消息") do
+        message = Queue[name].receive_message(wait_seconds: options[:wait])
+        message.delete
+        message
+      end
+    end
+
+    desc "send [queue] [message]", "往[queue]队列发送[message]消息"
+    def send(name, content)
+      execute("发送消息到#{name}队列"){ Queue[name].send_message content }
+    end
+
+    desc "peek [queue]", "从[queue]队列中peek消息"
+    def peek(name)
+      execute("Peek 队列#{name}中的消息"){ Queue[name].peek_message }
+    end
+
+    private
+    def execute info=nil
+      begin
+        puts info
+        result = yield()
+        puts result
+      rescue RequestException => ex
+        puts "#{ex['Code']}: #{ex['Message']}"
+      end
+      puts "\n"
+    end
+
+  end
+end