ons 1.0.0

data/lib/ons/consumer.rb

@@ -0,0 +1,71 @@
+module Ons
+  # the ONS Consumer
+  class Consumer
+    # Get all the Consumer instances.
+    #
+    # @return [<Consumer>] all the Consumer instances
+    def self.instances
+      @instances ||= []
+    end
+
+    # Create a new aliyun ONS Consumer instance.
+    #
+    # @param access_key [String] the access key to aliyun ONS
+    # @param secret_key [String] the secret key to aliyun ONS
+    # @param consumer_id [String] the consumer ID
+    # @param options [Hash{String, Symbol => String}]
+    # @option options [String] :namesrv_addr the nameserver used to fetching ons_addr
+    # @option options [String] :ons_addr the ONS server address
+    # @option options [String, Fixnum, Bignum] :thread_num the consumer thread numbers
+    def initialize(access_key, secret_key, consumer_id, options = {})
+      @consumer = Internal::Consumer.new(access_key, secret_key, consumer_id, options)
+
+      # register instance
+      self.class.instances << self
+
+      # start the global LMFAO event thread, so it could consume messages properly
+      LMFAO.start_event_thread
+    end
+
+    # Subsribe a topic.
+    #
+    # @example subscribe tag :tagA under topic :TopicTestMQ
+    #   consumer.subscribe('TopicTestMQ', 'tagA') {}
+    #
+    # @example subscribe tag :tagA and :tagB under topic :TopicTestMQ
+    #   consumer.subscribe('TopicTestMQ', 'tagA || tagB') {}
+    #
+    # @example subscribe all tags under topic :TopicTestMQ
+    #   consumer.subscribe('TopicTestMQ', '*') {}
+    #
+    # @param topic [String] the message topic
+    # @param expression [String] the subsribe expression used to filter messages
+    # @param handler [#call] the handler which will handle the message
+    # @return [self] returns itself
+    def subscribe(topic, expression, handler = nil)
+      @consumer.subscribe(topic, expression, handler || Proc.new)
+      self
+    end
+
+    # Start the Consumer instance.
+    #
+    # @return [self] returns itself
+    #
+    # @note this method should be called after subscribe.
+    # @note thie method will not block the thread, please see also {.loop_forever}.
+    def start
+      @consumer.start
+      self
+    end
+
+    # Shutdown the Consumer instance.
+    #
+    # @return [void]
+    #
+    # @note this method should be called before program exit, otherwise it would case a memory leak.
+    # Please see also {.register_cleanup_hooks} if you want call it automatically.
+    def shutdown
+      @consumer.shutdown
+    end
+  end
+end

data/lib/ons/lmfao.rb

@@ -0,0 +1,18 @@
+module Ons
+  # the LMFAO library
+  module LMFAO
+    # Get the global LMFAO event thread.
+    #
+    # @return [Thread, nil] returns the event thread
+    def self.event_thread
+      @event_thread
+    end
+
+    # Start the global LMFAO event thread manually.
+    #
+    # @return [Thread] returns a created/existed event thread
+    def self.start_event_thread
+      @event_thread ||= Internal::LMFAO.start_event_thread
+    end
+  end
+end

data/lib/ons/producer.rb

@@ -0,0 +1,80 @@
+module Ons
+  # the ONS Producer
+  class Producer
+    # Get all the Producer instances.
+    #
+    # @return [<Producer>] all the Producer instances
+    def self.instances
+      @instances ||= []
+    end
+
+    # Create a new aliyun ONS Producer instance.
+    #
+    # @param access_key [String] the access key to aliyun ONS
+    # @param secret_key [String] the secret key to aliyun ONS
+    # @param producer_id [String] the producer ID
+    # @param options [Hash{String, Symbol => String}]
+    # @option options [String] :namesrv_addr the nameserver used to fetching ons_addr
+    # @option options [String] :ons_addr the ONS server address
+    # @option options [String, Fixnum, Bignum] :send_timeout (3000) send message timeout
+    def initialize(access_key, secret_key, producer_id, options = {})
+      @producer = Internal::Producer.new(access_key, secret_key, producer_id, options)
+
+      # register instance
+      self.class.instances << self
+    end
+
+    # Send a message.
+    #
+    # @example send 'Hello, World!' message with tag :tagA which is under topic :TopicTestMQ
+    #   producer.send_message('TopicTestMQ', 'tagA', 'Hello, World!')
+    #
+    # @see #send_timer_message
+    #
+    # @param topic [String] the message topic
+    # @param tag [String] the message tag
+    # @param body [String] the message body
+    # @param key [String] the message key
+    # @return [String] the message id
+    def send_message(topic, tag, body, key = '')
+      @producer.send_message(topic, tag, body, key)
+    end
+
+    # Send a timer message.
+    #
+    # @example send 'Hello, World!' message at 30 seconds later
+    #   producer.send_timer_message('TopicTestMQ', 'tagA', 'Hello, World!', Time.now + 30)
+    #
+    # @see #send_message
+    #
+    # @param topic [String] the message topic
+    # @param tag [String] the message tag
+    # @param body [String] the message body
+    # @param timer [#to_i] when deliver the message
+    # @param key [String] the message key
+    # @return [String] the message id
+    def send_timer_message(topic, tag, body, timer, key = '')
+      @producer.send_timer_message(topic, tag, body, timer.to_i * 1000, key)
+    end
+
+    # Start the Producer instance.
+    #
+    # @return [self] returns itself
+    #
+    # @note this method should be called before send any message.
+    def start
+      @producer.start
+      self
+    end
+
+    # Shutdown the Producer instance
+    #
+    # @return [void]
+    #
+    # @note this method should be called before program exit, otherwise it would case a memory leak.
+    # Please see also {.register_cleanup_hooks} if you want call it automatically.
+    def shutdown
+      @producer.shutdown
+    end
+  end
+end

data/lib/ons/version.rb

@@ -0,0 +1,3 @@
+module Ons
+  VERSION = '1.0.0'.freeze
+end

data/lib/ons.rb

@@ -0,0 +1,36 @@
+require 'ons/version'
+
+# require dynamic library
+require 'ons/ons'
+
+# require self
+require 'ons/lmfao'
+require 'ons/consumer'
+require 'ons/producer'
+
+# .
+module Ons
+  # Perform an automatic cleanup at program exit.
+  #
+  # It handles:
+  #
+  # * shutdown all the Consumer instances, see also {Consumer#shutdown}
+  # * shutdown all the Producer instances, see also {Producer#shutdown}
+  # * kill the global LMFAO event thread if it's running
+  def self.register_cleanup_hooks
+    return if @registered
+    @registered = true
+
+    at_exit do
+      Consumer.instances.each(&:shutdown)
+      Producer.instances.each(&:shutdown)
+      LMFAO.event_thread && LMFAO.event_thread.terminate
+    end
+  end
+
+  # Block the current thread.
+  def self.loop_forever
+    raise 'please start an Ons::Consumer instance before loop forever' if Consumer.instances.empty?
+    LMFAO.event_thread.join
+  end
+end

data/ons.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ons/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ons'
+  spec.version       = Ons::VERSION
+  spec.authors       = ['caochaoping']
+  spec.email         = ['caochaoping@souche.com']
+
+  spec.summary       = 'unoffical aliyun ONS sdk (ruby version)'
+  spec.description   = 'unoffical aliyun ONS sdk (ruby version).'
+  spec.homepage      = 'https://github.com/souche/aliyun-ons-ruby-sdk'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata) # rubocop: disable Style/GuardClause
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.extensions    = ['ext/ons/extconf.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rice', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.5'
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'concurrent-ruby', '~> 1.0'
+end

data/samples/consumer.rb

@@ -0,0 +1,32 @@
+require 'bundler/setup'
+require 'ons'
+
+# register cleanup hooks, it will shutdown any Consumer instances at program exit
+Ons.register_cleanup_hooks
+
+# create an ONS Consumer instance
+consumer = Ons::Consumer.new(ENV.fetch('ONS_ACCESS_KEY'), ENV.fetch('ONS_SECRET_KEY'), ENV.fetch('ONS_CONSUMER_ID'))
+
+# subscribe all tags under specify topic
+consumer.subscribe(ENV.fetch('ONS_TOPIC'), '*') do |message|
+  begin
+    print format("===== consume message =====\n")
+    print format("        topic: %s\n", message[:topic])
+    print format("          tag: %s\n", message[:tag])
+    print format("         body: %s\n", message[:body])
+    print format("           id: %s\n", message[:id])
+    print format("          key: %s\n", message[:key])
+    print format("    reconsume: %s times\n", message[:reconsume_times])
+    print format("     store at: %s (%s)\n", message[:store_timestamp], Time.at(message[:store_timestamp] / 1_000).localtime)
+    print format("   deliver at: %s (%s)\n", message[:deliver_timestamp], Time.at(message[:deliver_timestamp] / 1_000).localtime)
+    print "\n"
+  rescue => ex # handle any exception here
+    print format("      failure: %s\n", ex.message)
+    print "\n"
+  end
+
+  true # commit message
+end
+
+# start it after subscribe topic
+consumer.start && Ons.loop_forever

data/samples/producer.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+require 'ons'
+
+# register cleanup hooks, it will shutdown any Producer instances at program exit
+Ons.register_cleanup_hooks
+
+# create an ONS Producer instance
+producer = Ons::Producer.new(ENV.fetch('ONS_ACCESS_KEY'), ENV.fetch('ONS_SECRET_KEY'), ENV.fetch('ONS_PRODUCER_ID'))
+
+# start it before send any message
+producer.start
+
+# send messages
+data = Array('a'..'z').join + Array('A'..'Z').join
+loop do
+  topic = ENV.fetch('ONS_TOPIC')
+  tag = 'onsTag#samples'
+  body = Range.new(1, 64).map(&->(_) { data[rand(data.size)] }).join
+  key = 'samples-' + Range.new(1, 16).map(&->(_) { data[rand(data.size)] }).join
+
+  begin
+    print format("===== produce message =====\n")
+    print format("        topic: %s\n", topic)
+    print format("          tag: %s\n", tag)
+    print format("         body: %s\n", body)
+    id = producer.send_message(topic, tag, body, key)
+    print format("           id: %s\n", id)
+    print "\n"
+  rescue => ex # such as Timeout, etc.
+    print format("      failure: %s\n", ex.message)
+    print "\n"
+  end
+
+  sleep rand(8)
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: ons
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- caochaoping
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: unoffical aliyun ONS sdk (ruby version).
+email:
+- caochaoping@souche.com
+executables: []
+extensions:
+- ext/ons/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- Gemfile
+- README-zh_CN.md
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/Action.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/ConsumeContext.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/LocalTransactionChecker.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/LocalTransactionExecuter.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/Message.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/MessageListener.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/ONSChannel.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/ONSClient.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/ONSClientException.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/ONSFactory.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/Producer.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/PushConsumer.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/SendResultONS.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/TransactionProducer.h
+- ext/ons/aliyun-mq-cpp-sdk/include/ons/TransactionStatus.h
+- ext/ons/aliyun-mq-cpp-sdk/lib/libonsclient4cpp.so
+- ext/ons/consumer.cpp
+- ext/ons/consumer.hpp
+- ext/ons/extconf.rb
+- ext/ons/listener.cpp
+- ext/ons/listener.hpp
+- ext/ons/lmfao.cpp
+- ext/ons/lmfao.hpp
+- ext/ons/ons.cpp
+- ext/ons/ons.hpp
+- ext/ons/producer.cpp
+- ext/ons/producer.hpp
+- lib/ons.rb
+- lib/ons/consumer.rb
+- lib/ons/lmfao.rb
+- lib/ons/producer.rb
+- lib/ons/version.rb
+- ons.gemspec
+- samples/consumer.rb
+- samples/producer.rb
+homepage: https://github.com/souche/aliyun-ons-ruby-sdk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: unoffical aliyun ONS sdk (ruby version)
+test_files: []