ons 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80474fb3032832392ef7844f0eb062d11203fcd8
+  data.tar.gz: f4014c329ff734765715541a016631b1c00d73b5
+SHA512:
+  metadata.gz: 2201e16dd77b6e767a706b1fc40e2fc644c3c0a31575f480d123aee995fd9d890aae3a43dd61f95cde34454fe13c1d287ef74a27dd5d8feace32b827f51982fb
+  data.tar.gz: d5970d7a6b0742bb2ade1ae031e6f9c903ad831f3d48c4e769c39acdb18ed9893977fbda76e8f1763d3438e8f17e0dbbc9991f12e692a54467feb3068a9b39df

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/ext/ons/mkmf.log
+/ext/ons/Makefile
+/ext/ons/*.o
+/ext/ons/*.so
+/lib/ons/ons.so

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require: rubocop-rspec
+
+Metrics/LineLength:
+  Max: 160
+
+RSpec/ExampleLength:
+  Max: 16

data/.yardopts

@@ -0,0 +1,3 @@
+-
+README.md
+README-zh_CN.md

data/Gemfile

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

data/README-zh_CN.md

@@ -0,0 +1,80 @@
+# Ons
+
+阿里云 ONS 消息队列服务 Ruby SDK（非官方版本）
+
+## 项目依赖
+
+* Linux/Unix 系统
+* Ruby 2.1.5 或以上版本
+* Boost C++ 程序库
+
+## 安装步骤
+
+### 安装 Ruby 程序
+
+```sh
+$ rvm install 2.1.5
+```
+
+### 安装 Boost C++ 程序库
+
+```sh
+$ apt-get install libboost-all-dev
+```
+
+### 安装 ons
+
+```sh
+$ git clone https://github.com/souche/aliyun-ons-ruby-sdk.git
+$ cd ons
+$ ./bin/setup
+$ ./bin/rake install
+```
+
+## 使用方式
+
+### 环境准备
+
+* 安装 ons rubygems。
+* 代码里涉及到的 TOPIC、PRODUCER_ID、CONSUMER_ID，需要在 MQ 控制台上创建。 Message Tag 可以完全由应用自定义，具体创建过程可参考 [申请MQ资源](https://help.aliyun.com/document_detail/29536.html)。
+* 使用 MQ 服务的应用程序需要部署在阿里云 ECS 上。
+
+部分资料来自 [消息队列 > TCP 接入(专业) > C/C++ SDK 环境准备](https://help.aliyun.com/document_detail/29555.html)
+
+### 生产者
+
+```ruby
+producer = Ons::Producer.new('<ONS_ACCESS_KEY>', '<ONS_SECRET_KEY>', '<ONS_PRODUCER_ID>')
+
+# 资源准备
+producer.start
+
+# 在 topic <ONS_TOPIC> 下发送消息
+producer.send_message('<ONS_TOPIC>', 'tag', 'Hello, World!')
+
+# 必须在程序退出前调用 shutdown 方法释放相关资源，否则可能出现栈错误
+producer.shutdown
+```
+
+更多用法，请参考 {file:samples/producer.rb} 及 API 文档
+
+### 消费者
+
+```ruby
+consumer = Ons::Consumer.new('<ONS_ACCESS_KEY>', '<ONS_SECRET_KEY>', '<ONS_CONSUMER_ID>')
+
+# 订阅 topic <ONS_TOPIC> 下的所有消息
+# 注意，当消息达到时，会调用下述函数，此函数会被调度到单独线程中执行
+consumer.subscribe('<ONS_TOPIC>', '*') { |message| p message }
+
+# 资源准备
+consumer.start
+
+# 等待消息到达
+sleep 32
+
+# 必须在程序退出前调用 shutdown 方法释放相关资源，否则可能出现栈错误
+consumer.shutdown
+```
+
+更多用法，请参考 {file:samples/consumer.rb} 及 API 文档

data/README.md

@@ -0,0 +1,36 @@
+# Ons
+
+unoffical aliyun ONS sdk (ruby version)
+
+## Requirements
+
+* Linux/Unix
+* Ruby 2.1.5 or later
+* Boost C++ library
+
+## Installation
+
+### install Ruby
+
+```sh
+$ rvm install 2.1.5
+```
+
+### install Boost C++ library
+
+```sh
+$ apt-get install libboost-all-dev
+```
+
+### install ons
+
+```sh
+$ git clone https://github.com/souche/aliyun-ons-ruby-sdk.git
+$ cd ons
+$ ./bin/setup
+$ ./bin/rake install
+```
+
+## Usage
+
+Please take a look at {file:samples/producer.rb} and {file:samples/consumer.rb}

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+require 'rspec/core/rake_task'
+
+Rake::ExtensionTask.new(:ons) do |ext|
+  ext.lib_dir = './lib/ons'
+end
+
+RSpec::Core::RakeTask.new spec: %w(clobber compile)
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ons'
+
+# 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/rake

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

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/ext/ons/aliyun-mq-cpp-sdk/include/ons/Action.h

@@ -0,0 +1,12 @@
+#ifndef __ACTION_H__
+#define __ACTION_H__
+
+//consuming result
+enum Action{
+//consume success, application could continue to consume next message
+CommitMessage,
+//consume fail, server will deliver this message later, application could continue to consume next message
+ReconsumeLater
+};
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/ConsumeContext.h

@@ -0,0 +1,15 @@
+#ifndef __CONSUMECONTEXT_H__
+#define __CONSUMECONTEXT_H__
+
+namespace ons{
+
+class ONSCLIENT_API ConsumeContext{
+public:
+    ConsumeContext(){}
+    virtual ~ConsumeContext(){}
+
+};
+
+}
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/LocalTransactionChecker.h

@@ -0,0 +1,16 @@
+#ifndef __LOCALTRANSACTIONCHECKER_H__
+#define __LOCALTRANSACTIONCHECKER_H__
+
+#include "Message.h"
+#include "TransactionStatus.h"
+
+namespace ons{
+    class LocalTransactionChecker {
+        public:
+            virtual TransactionStatus  check(Message& msg) =0;
+            virtual ~LocalTransactionChecker() {}
+    };
+}
+
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/LocalTransactionExecuter.h

@@ -0,0 +1,16 @@
+#ifndef __LOCALTRANSACTIONEXECUTER_H__
+#define __LOCALTRANSACTIONEXECUTER_H__
+
+#include "Message.h"
+#include "TransactionStatus.h"
+
+namespace ons{
+    class LocalTransactionExecuter{
+        public:
+            virtual TransactionStatus  execute(Message& msg) =0;
+            virtual ~LocalTransactionExecuter(){}
+    };
+}
+
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/Message.h

@@ -0,0 +1,96 @@
+#ifndef __MESSAGE_H__
+#define __MESSAGE_H__
+
+#include <map>
+#include <vector>
+#include <sstream>
+#include "ONSClient.h"
+namespace ons {
+
+    class ONSCLIENT_API SystemPropKey
+    {
+        public:
+            SystemPropKey(){}
+            ~SystemPropKey(){}
+            static CONSTSTRING TAG;
+            static CONSTSTRING KEY;
+            static CONSTSTRING MSGID;
+            static CONSTSTRING RECONSUMETIMES;
+            static CONSTSTRING STARTDELIVERTIME;
+    };
+
+    //<!***************************************************************************
+    class ONSCLIENT_API Message
+    {        
+    public:
+        Message();
+        Message(CONSTSTRING topic, CONSTSTRING tags, CONSTSTRING body);
+        Message(CONSTSTRING topic, CONSTSTRING tags, CONSTSTRING keys, CONSTSTRING body);
+
+        virtual ~Message();
+        
+        Message(const Message& other);
+        Message& operator=(const Message& other);
+
+        //userProperties was used to save user specific parameters which doesn't belong to SystemPropKey
+        void   putUserProperties(CONSTSTRING key, CONSTSTRING value);
+        CONSTSTRING getUserProperties(CONSTSTRING key) const;
+        void   setUserProperties(std::map<std::string, std::string>& userProperty);
+        std::map<std::string, std::string> getUserProperties() const;
+
+       //systemProperties only save parameters defined in SystemPropKey, please do not add other parameters into systemProperties, else it was not saved.
+        void   putSystemProperties(CONSTSTRING key,CONSTSTRING value);
+        CONSTSTRING getSystemProperties(CONSTSTRING key) const;
+        void   setSystemProperties(std::map<std::string, std::string>& systemProperty);
+        std::map<std::string, std::string> getSystemProperties() const;
+        
+        CONSTSTRING  getTopic()const;
+        void    setTopic(CONSTSTRING topic);
+    
+        CONSTSTRING  getTag() const;
+        void    setTag(CONSTSTRING tags);
+    
+        CONSTSTRING  getKey() const;
+        void    setKey(CONSTSTRING keys);
+
+        CONSTSTRING getMsgID() const;
+        void   setMsgID(CONSTSTRING msgId);
+    
+        const long long  getStartDeliverTime() const;
+        void   setStartDeliverTime(long long level);
+    
+        CONSTSTRING getBody()const;
+        void   setBody(CONSTSTRING msgbody);
+    
+        const int    getReconsumeTimes() const;
+        void  setReconsumeTimes(int reconsumeTimes);
+
+        long long getStoreTimestamp() const;
+        void setStoreTimestamp(long long storeTimestamp);
+    
+        const std::string toString() const;
+
+        const std::string toSystemString() const;
+
+        const std::string toUserString() const;
+    
+    protected:
+        void Init(const std::string& topic,
+                  const std::string& tags,
+                  const std::string& keys,
+                  const std::string& body);
+    
+    
+    private:
+        std::string  topic;
+        std::string  body;
+         long long m_storeTimestamp;
+        std::map<std::string, std::string> systemProperties;
+        std::map<std::string, std::string> userProperties;
+    };
+    //<!***************************************************************************
+    
+
+}//<!end namespace;
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/MessageListener.h

@@ -0,0 +1,20 @@
+#ifndef __MESSAGELISTENER_H__
+#define __MESSAGELISTENER_H__
+
+#include "Action.h"
+#include "Message.h"
+#include "ConsumeContext.h"
+
+namespace ons{
+
+class ONSCLIENT_API MessageListener {
+public:
+    MessageListener(){}
+    virtual ~MessageListener(){}
+    
+    //interface of consuming message, should be realized by application
+    virtual Action consume(Message& message, ConsumeContext& context) = 0;
+};
+
+}
+#endif

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/ONSChannel.h

@@ -0,0 +1,17 @@
+#ifndef __ONSCHANNEL_H__
+#define __ONSCHANNEL_H__
+
+namespace ons
+{
+
+    enum ONSChannel 
+    {
+        CLOUD,
+        ALIYUN,
+        ALL
+    };
+
+}
+
+
+#endif

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/ONSClient.h

@@ -0,0 +1,28 @@
+/********************************************************************
+author:     ×ÔÐÞ jianlin.yjl@alibaba-cn.com
+*********************************************************************/
+#ifndef __ONSCLIENT_H__
+#define  __ONSCLIENT_H__
+
+#include <string>
+
+#ifdef WIN32
+    typedef const char* CONSTSTRING;
+    typedef char* STRING;
+#else
+    typedef const std::string CONSTSTRING;
+    typedef std::string STRING;
+#endif
+
+
+#ifdef WIN32
+#ifdef ONSCLIENT_EXPORTS
+#define ONSCLIENT_API __declspec(dllexport)
+#else
+#define ONSCLIENT_API __declspec(dllimport)
+#endif
+#else
+#define ONSCLIENT_API
+#endif
+
+#endif

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/ONSClientException.h

@@ -0,0 +1,27 @@
+#ifndef __ONSCLIENTEXCEPTION_H__
+#define __ONSCLIENTEXCEPTION_H__
+
+#include <exception>
+#include "ONSClient.h"
+
+namespace ons{
+
+class ONSCLIENT_API ONSClientException: public std::exception
+{
+    public:
+        ONSClientException() throw();
+        virtual ~ONSClientException() throw();
+        ONSClientException(std::string msg, int error) throw();
+        const char* GetMsg() const throw();
+        const char* what() const throw();
+        int GetError() const throw();
+        
+    private:
+        std::string  m_msg;
+        int             m_error;
+};
+
+}
+
+
+#endif

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/ONSFactory.h

@@ -0,0 +1,73 @@
+#ifndef __ONSFACTORY_H_
+#define __ONSFACTORY_H_
+
+#include "Producer.h"
+#include "TransactionProducer.h"
+#include "PushConsumer.h"
+#include "ONSChannel.h"
+#include "LocalTransactionChecker.h"
+
+namespace ons {
+class ONSCLIENT_API ONSFactoryProperty{
+public:
+    ONSFactoryProperty();
+    virtual ~ONSFactoryProperty();
+    bool checkValidityOfFactoryProperties(const std::string& key, const std::string& value);
+    void setSendMsgTimeout(const int value);
+    void setOnsChannel(ONSChannel onsChannel);
+    void setFactoryProperty(CONSTSTRING& key, CONSTSTRING value);
+    void setFactoryProperties(std::map<std::string, std::string> factoryProperties);
+    std::map<std::string, std::string> getFactoryProperties() const;
+    CONSTSTRING getProducerId() const;
+    CONSTSTRING getConsumerId() const;
+    CONSTSTRING getPublishTopics() const;
+    CONSTSTRING getMessageModel() const;
+    const int getMessageTimeout() const;
+    const int getConsumeThreadNums() const;
+    const ONSChannel  getOnsChannel() const;
+    CONSTSTRING  getChannel() const;
+    CONSTSTRING getMessageContent() const;
+    CONSTSTRING getNameSrvAddr() const;
+    CONSTSTRING getNameSrvDomain() const;
+    CONSTSTRING getAccessKey() const;
+    CONSTSTRING getSecretKey() const;
+public:
+    static CONSTSTRING ProducerId;
+    static CONSTSTRING ConsumerId;
+    static CONSTSTRING PublishTopics;
+    static CONSTSTRING MsgContent;
+    static CONSTSTRING ONSAddr;
+    static CONSTSTRING AccessKey;
+    static CONSTSTRING SecretKey;
+    static CONSTSTRING MessageModel;
+    static CONSTSTRING BROADCASTING;
+    static CONSTSTRING CLUSTERING;
+    static CONSTSTRING SendMsgTimeoutMillis;
+    static CONSTSTRING NAMESRV_ADDR;
+    static CONSTSTRING ConsumeThreadNums;
+    static CONSTSTRING OnsChannel;
+private:    
+    std::map<std::string, std::string> m_onsFactoryProperties;    
+};   
+
+class ONSCLIENT_API ONSFactoryAPI{
+public:
+    ONSFactoryAPI();
+    virtual ~ONSFactoryAPI();
+
+    virtual Producer*     createProducer(ONSFactoryProperty factoryProperty);
+    virtual TransactionProducer* createTransactionProducer(ONSFactoryProperty factoryProperty, LocalTransactionChecker *checker);
+    virtual PushConsumer* createPushConsumer(ONSFactoryProperty factoryProperty);
+};
+
+class ONSCLIENT_API ONSFactory{
+public:
+    virtual ~ONSFactory();
+    static ONSFactoryAPI* getInstance(); 
+private:
+     ONSFactory();
+     static ONSFactoryAPI *onsFactoryInstance;
+};
+}
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/Producer.h

@@ -0,0 +1,29 @@
+#ifndef __PRODUCER_H__
+#define __PRODUCER_H__
+
+
+#include "SendResultONS.h"
+#include "Message.h"
+
+
+namespace ons {
+
+class ONSCLIENT_API Producer{
+        
+public:
+  
+    Producer(){}
+    virtual ~Producer(){}
+    
+    //before send msg, start must be called to allocate resources.
+    virtual void start()=0;
+    //before exit ons, shutdown must be called to release all resources allocated by ons internally.
+    virtual void shutdown()=0;
+    //retry max 3 times if send failed. if no exception throwed, it sends success; 
+    virtual SendResultONS send(Message& msg)=0;
+
+};
+
+}
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/PushConsumer.h

@@ -0,0 +1,22 @@
+#ifndef __PUSHCONSUMER_H__
+#define __PUSHCONSUMER_H__
+
+#include "MessageListener.h"
+
+namespace ons {
+
+class ONSCLIENT_API PushConsumer{
+        
+public:
+    PushConsumer(){} 
+    virtual ~PushConsumer(){}
+  
+    virtual void start()=0;
+    virtual void shutdown()=0;
+    virtual void subscribe(CONSTSTRING topic, CONSTSTRING subExpression, MessageListener* listener)=0;
+    //virtual void setNamesrvAddr(const std::string& nameSrvAddr) = 0;
+};
+
+}
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/SendResultONS.h

@@ -0,0 +1,22 @@
+#ifndef __SENDRESULTONS_H__
+#define __SENDRESULTONS_H__
+
+#include "ONSClient.h"
+
+namespace ons{
+
+class ONSCLIENT_API SendResultONS{
+public:
+    SendResultONS();
+    virtual ~SendResultONS();
+    void setMessageId(const std::string& msgId);
+    CONSTSTRING getMessageId() const;
+
+
+private:
+    std::string messageId;
+
+};
+
+}
+#endif

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/TransactionProducer.h

@@ -0,0 +1,22 @@
+#ifndef __TRANSACTIONPRODUCER_H__
+#define __TRANSACTIONPRODUCER_H__
+
+#include "LocalTransactionExecuter.h"
+
+namespace ons{
+    class TransactionProducer{
+        public:    
+            TransactionProducer(){}
+            virtual ~TransactionProducer(){}
+    
+            //before send msg, start must be called to allocate resources.
+            virtual void start()=0;
+            //before exit ons, shutdown must be called to release all resources allocated by ons internally.
+            virtual void shutdown()=0;
+            //retry max 3 times if send failed. if no exception throwed, it sends success; 
+            virtual SendResultONS send(Message& msg, LocalTransactionExecuter *executer)=0;
+    };
+}
+
+#endif
+

data/ext/ons/aliyun-mq-cpp-sdk/include/ons/TransactionStatus.h

@@ -0,0 +1,15 @@
+#ifndef __TRANSACTIONSTATUS_H__
+#define __TRANSACTIONSTATUS_H__
+
+namespace ons {
+
+enum TransactionStatus  {
+    CommitTransaction=0,//Ìá½»ÊÂÎñ
+    RollbackTransaction=1,//»Ø¹öÊÂÎñ
+    Unknow=2,//δ֪״̬£¬Ò»°ãÔÚÓû§ÎÞ·¨È·¶¨ÊÂÎñÊdzɹ¦»¹ÊÇʧ°ÜʱʹÓÃ
+};
+
+
+}
+
+#endif