stomp_actors 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Emilien Taque
+
+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,85 @@
+# StompActors
+
+A suite of Celluloid actors to interact with Stomp protocol, using OnStomp gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stomp_actors'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stomp_actors
+
+## Usage
+
+### Consumers
+
+Inherit from `StompActors::Consumer` then define `#queue` and `#uri`
+values, and `#receive(msg)` method.
+
+Define `#subscribe_opts` to customize subscription options.
+
+Use `ack(msg)` to acknowledge message.
+
+Example:
+
+```ruby
+class MyConsumer < StompActors::Consumer
+  def uri
+    "stomp://127.0.0.1:61613"
+  end
+
+  def queue
+    "/queue/foo"
+  end
+
+  def subscribe_opts
+    { ack: 'client' }
+  end
+
+  def receive(msg)
+    # do something
+    ack(msg)
+  end
+end
+
+MyConsumer.new # your actor is now subscribed and will process messages.
+```
+
+### Producers
+
+Inherit from `StompActors::Producer` then define `#queue` and `#uri`
+values.
+
+Use `emit(msg)` to send message to the defined queue.
+
+Example:
+
+```ruby
+class MyProducer < StompActors::Producer
+  def uri
+    "stomp://127.0.0.1:61613"
+  end
+
+  def queue
+    "/queue/foo"
+  end
+end
+
+p = MyProducer.new
+p.emit("stuff") # message sent by actor
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+

data/lib/stomp_actors/client.rb

@@ -0,0 +1,51 @@
+module StompActors
+  module Client
+
+    class DisconnectionError < StandardError; end
+    class BrokerError < StandardError; end
+
+    def self.included(base)
+      base.extend ClassMethods
+
+      base.class_eval do
+        attr_accessor :client
+      end
+    end
+
+    module ClassMethods
+    end
+
+    def connect
+      @client = OnStomp.open(uri)
+
+      me = current_actor
+
+      @client.on_connection_closed do |_, _, msg|
+        me.async.connection_closed(msg)
+      end
+
+      @client.on_error do |e, *_|
+        me.async.broker_error(e)
+      end
+    end
+
+    def connection_closed(msg)
+      unless @disconnecting
+        error "Connection closed: #{msg}" if respond_to?(:error)
+        raise DisconnectionError.new(msg)
+      end
+    end
+
+    def broker_error(e)
+      error("Broker error: #{e.inspect}") if respond_to?(:error)
+      raise BrokerError.new(e[:message])
+    end
+
+    def disconnect
+      @disconnecting = true
+      @client.disconnect if @client && @client.connected?
+    end
+
+  end
+end
+

data/lib/stomp_actors/consumer.rb

@@ -0,0 +1,41 @@
+module StompActors
+  class Consumer
+    include Celluloid
+    include Celluloid::Logger
+
+    include Client
+
+    attr_accessor :subscription_id
+
+    def initialize
+      connect
+      subscribe
+    end
+
+    def subscribe
+      me = current_actor
+
+      @subscription_id = client.subscribe(queue, subscribe_opts) do |msg|
+        me.receive(msg)
+      end
+    end
+
+    def subscribe_opts
+      {}
+    end
+
+    def ack(msg)
+      client.ack(msg)
+    end
+
+    def finalize
+      unsubscribe
+      disconnect
+    end
+
+    def unsubscribe
+      client.unsubscribe(@subscription_id) if @subscription_id
+    end
+  end
+end
+

data/lib/stomp_actors/producer.rb

@@ -0,0 +1,22 @@
+module StompActors
+  class Producer
+    include Celluloid
+    include Celluloid::Logger
+
+    include Client
+
+    def initialize
+      connect
+    end
+
+    def emit(msg)
+      client.send(queue, msg)
+    end
+
+    def finalize
+      disconnect
+    end
+  end
+end
+
+

data/lib/stomp_actors/version.rb

@@ -0,0 +1,3 @@
+module StompActors
+  VERSION = "0.0.1"
+end

data/lib/stomp_actors.rb

@@ -0,0 +1,7 @@
+require "stomp_actors/version"
+require "stomp_actors/client"
+require "stomp_actors/producer"
+require "stomp_actors/consumer"
+
+module StompActors
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+
+require 'celluloid'
+require 'stomp_droid'
+require 'onstomp'
+require 'pry'
+
+require 'stomp_actors'
+
+logfile = File.open(File.expand_path("../../log/test.log", __FILE__), 'a')
+Celluloid.logger = Logger.new(logfile)
+
+RSpec.configure do |config|
+  config.before :each do
+  end
+end
+
+
+

data/spec/stomp_actors/client_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe StompActors::Client do
+  let(:host) { '127.0.0.1' }
+  let(:port) { 61623 }
+
+  before do
+    class MyActor
+      include Celluloid
+      include StompActors::Client
+
+      def uri
+        "stomp://127.0.0.1:61623"
+      end
+    end
+
+    @server_thread = StompDroid::Server.start(host, port)
+    sleep 0.1 # let start
+  end
+
+  after do
+    @server_thread.terminate
+  end
+
+  it "should connect and disconnect" do
+    actor = MyActor.new
+
+    actor.connect
+    actor.client.connected?.should be_true
+
+    actor.disconnect
+    actor.client.connected?.should be_false
+  end
+
+  pending "should handle errors"
+end

data/spec/stomp_actors/consumer_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe StompActors::Consumer do
+  let(:host) { '127.0.0.1' }
+  let(:port) { 61623 }
+  let(:queue) { "/queue/foo" }
+  let(:msg) { "something" }
+
+  before do
+    class MyConsumer < StompActors::Consumer
+      attr_reader :queue
+
+      def initialize(host, port, queue)
+        @host = host
+        @port = port
+        @queue = queue
+        super()
+      end
+
+      def uri
+        "stomp://#{@host}:#{@port}"
+      end
+
+      def receive(msg)
+        do_something
+        ack(msg)
+      end
+
+      def do_something; end
+    end
+
+    @server_thread = StompDroid::Server.start(host, port, queue_name: queue, message: msg)
+    sleep 0.1 # let start
+  end
+
+  after do
+    @server_thread.terminate
+  end
+
+  it "should subscribe, handle and ack message on connect" do
+    MyConsumer.any_instance.should_receive(:do_something)
+    consumer = MyConsumer.new(host, port, queue)
+    sleep 0.1
+  end
+
+  it "should unsubscribe on finalize" do
+    consumer = MyConsumer.new(host, port, queue)
+    sleep 0.1
+    consumer.finalize
+  end
+end

data/spec/stomp_actors/producer_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe StompActors::Producer do
+  let(:host) { '127.0.0.1' }
+  let(:port) { 61623 }
+  let(:queue) { "/queue/foo" }
+  let(:message_dir) { 'tmp/messages' }
+
+  before do
+    class MyProducer < StompActors::Producer
+      def uri
+        "stomp://127.0.0.1:61623"
+      end
+      def queue
+        '/queue/foo'
+      end
+    end
+
+    @server_thread = StompDroid::Server.start(host, port, queue_name: queue, sent_message_dir: message_dir)
+    sleep 0.1 # let start
+  end
+
+  after do
+    @server_thread.terminate
+    FileUtils.rm(Dir.glob("#{message_dir}/*.msg"))
+  end
+
+  it "should send message" do
+    producer = MyProducer.new
+    expect {
+      producer.emit("message")
+      sleep 0.5
+    }.to change { Dir["#{message_dir}/*.msg"].to_a.length }.by(1)
+  end
+end
+

data/stomp_actors.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stomp_actors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stomp_actors"
+  spec.version       = StompActors::VERSION
+  spec.authors       = ["Emilien Taque"]
+  spec.email         = ["e.taque@alphalink.fr"]
+  spec.description   = %q{Celluloid actors for Stomp}
+  spec.summary       = %q{Build Stomp consumers and publishers with Celluloid actors framework and OnStomp lib.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'stomp_droid'
+  spec.add_development_dependency 'pry'
+  
+  spec.add_runtime_dependency 'celluloid', '~> 0.12'
+  spec.add_runtime_dependency 'onstomp', '~> 1.0'
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: stomp_actors
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Emilien Taque
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stomp_droid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: onstomp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Celluloid actors for Stomp
+email:
+- e.taque@alphalink.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stomp_actors.rb
+- lib/stomp_actors/client.rb
+- lib/stomp_actors/consumer.rb
+- lib/stomp_actors/producer.rb
+- lib/stomp_actors/version.rb
+- spec/spec_helper.rb
+- spec/stomp_actors/client_spec.rb
+- spec/stomp_actors/consumer_spec.rb
+- spec/stomp_actors/producer_spec.rb
+- stomp_actors.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Build Stomp consumers and publishers with Celluloid actors framework and
+  OnStomp lib.
+test_files:
+- spec/spec_helper.rb
+- spec/stomp_actors/client_spec.rb
+- spec/stomp_actors/consumer_spec.rb
+- spec/stomp_actors/producer_spec.rb