agent_zmq 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: c1810d095c41ef4752fbde11dfcdd2cc1b156c7a
+  data.tar.gz: b95f4154d6e47fabd960273cf02fb1f8e0997785
+SHA512: 
+  metadata.gz: 7f9b59119a7a03c1a998fb39545f33ffa6d36aa9ec9d4fd0f9ecbc38dea42f58dc3491516e7066d3cd46fab0b988130efb924f087134f3a16f50e219c104abcb
+  data.tar.gz: 7922703be2d5ac0b9267dbdffe5ae62581263745aa2fc1b866f0796677e0510235f03fa90ed94412e2fac5471969a1cf071d5b5364d63df6ad024c2450b6c823

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+before_install: sudo apt-get install libzmq3-dev
+language: ruby
+rvm:
+- 1.9.2
+- 1.9.3
+- 2.0.0

data/CONTRIBUTION_GUIDELINES.md

@@ -0,0 +1,22 @@
+If you come across any issues, please [tell us](https://github.com/connamara/agent_zmq/issues).
+Pull requests (with tests) are appreciated. No pull request is too small. Please help with:
+
+* Reporting bugs
+* Suggesting features
+* Writing or improving documentation
+* Fixing typos
+* Cleaning whitespace
+* Refactoring code
+* Adding tests
+* Closing [issues](https://github.com/connamara/agent_zmq/issues)
+
+Contributing to agent_zmq:
+
+1. Fork the [official repository](https://github.com/connamara/agent_zmq/tree/master).
+2. Make your changes in a topic branch.
+3. Send a pull request.
+
+Notes:
+* If you report a bug and don't include a fix, please include a failing test.
+* Contributions without tests won't be accepted.
+* Please don't update the Gem version

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem 'ffi-rzmq', "~> 0.9.3"
+gem "rspec", "~> 2.14"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "jeweler", "~> 1.8"
+  gem "cucumber", "~> 1.3"
+  gem "rake", "~> 10.1"
+end

data/Gemfile.lock

@@ -0,0 +1,76 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    cucumber (1.3.6)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    ffi (1.9.0)
+    ffi-rzmq (0.9.7)
+      ffi
+    gherkin (2.12.1)
+      multi_json (~> 1.3)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.9)
+    multi_test (0.0.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber (~> 1.3)
+  ffi-rzmq (~> 0.9.3)
+  jeweler (~> 1.8)
+  rake (~> 10.1)
+  rspec (~> 2.14)

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (C) 2013 Connamara Systems, llc
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,182 @@
+agent\_zmq [![Build Status](https://travis-ci.org/connamara/agent_zmq.png?branch=master)](https://travis-ci.org/connamara/agent_zmq)
+============
+
+Agent framework designed for testing [ZeroMQ](http://zeromq.org/) Applications 
+
+Usage
+-----
+
+
+### Agent Types
+
+The agent types correspond to underlying ZMQ Socket type under test
+
+#### ZMQ\_SUB
+
+* Connects or Binds to local address
+* Includes message caching for inspection
+
+#### ZMQ\_PUB
+
+* Connects or Binds to local address
+* Publishes
+
+#### ZMQ\_REQ
+
+* Connects or Binds to local address
+* Publishes request, returns response
+
+#### ZMQ\_REP
+
+* Connects or Binds to local address
+* Listens for request, sends response
+
+
+### Configuration
+
+Inside of your project, declare your agents inside of ```config/zmq_agents.rb``` like this:     
+
+```ruby
+require 'agent_zmq'
+
+AgentZMQ.define_ZMQ_SUB :my_sub_agent do |a|
+  a.socket_opts << {ZMQ::SUBSCRIBE=>'com.connamara.BODPosition'}
+  a.end_point_type=:bind
+  a.end_point='tcp://*:5556'
+end
+
+AgentZMQ.define_ZMQ_PUB :my_pub_agent do |a|
+  a.end_point_type=:connect
+  a.end_point='tcp://127.0.0.1:5558'
+end
+
+AgentZMQ.define_ZMQ_REQ :my_req_agent do |a|
+  a.end_point_type=:connect
+  a.end_point='tcp://127.0.0.1:5552'
+end
+
+AgentZMQ.define_ZMQ_REP :my_rep_agent do |a|
+  a.reply = Proc.new {|msg| "ok"}
+  a.end_point_type=:bind
+  a.end_point='tcp://*:5552'
+end
+```
+
+### Starting, Stopping and Resetting
+
+```ruby
+require 'agent_zmq'
+AgentZMQ.start
+at_exit { AgentZMQ.stop }
+```
+
+You may want to reset the agent states between tests without stopping and starting. This may be done with ```AgentZMQ.reset```
+
+### Getting your agent
+
+Grab the agent by the name given in the config file
+
+```ruby
+my_agent = AgentZMQ.agents_hash[:my_sub_agent]  
+```
+
+### Agent Interfaces
+
+
+#### ZMQ\_SUB
+
+This agent provides a message cache
+
+```ruby
+all_messages_received = my_sub_agent.messages_received
+
+# returns and removes the last message received from the cache
+last_message_received = my_sub_agent.pop
+```
+
+On `reset`, the sub agent cache is cleared
+    
+#### ZMQ\_PUB
+
+The ```publish``` method takes a single message of one or more parts
+
+```ruby
+my_pub_agent.publish "single part message"
+my_pub_agent.publish ["part 1", "part 2"]
+```
+
+#### ZMQ\_REQ
+
+The ```publish``` method takes a single message of one or more parts. The agent blocks until a response is received and returned as an array of message parts
+
+```ruby
+response = my_req_agent.publish "single part message"
+response = my_pub_agent.publish ["part 1", "part 2"]
+```
+
+#### ZMQ\_REP
+
+Like the ZMQ_SUB agent, ZMQ_REP provides a message cache
+
+```ruby
+all_messages_received = my_rep_agent.messages_received
+
+# returns and removes the last message received from the cache
+last_message_received = my_rep_agent.pop
+```
+
+When receiving requests, the agent will reply with the output of the ```reply``` Proc.  The return value of this proc may be in the form of a multi-part message.
+
+### Cucumber
+
+There is some support for cucumber.  See [features](https://github.com/connamara/agent_zmq/blob/master/features) for example usage.
+
+### More
+
+Check out [specs](https://github.com/connamara/agent_zmq/blob/master/spec) and [features](https://github.com/connamara/agent_zmq/blob/master/features) to see all the ways you can use agent_zmq.
+
+Install
+-------
+
+```shell
+gem install agent_zmq
+```
+
+or add the following to Gemfile:
+```ruby
+gem 'agent_zmq'
+```
+and run `bundle install` from your shell.
+
+More Information
+----------------
+
+* [Rubygems](https://rubygems.org/gems/agent_zmq)
+* [Issues](https://github.com/connamara/agent_zmq/issues)
+* [Connamara Systems](http://connamara.com)
+
+Contributing
+------------
+
+Please see the [contribution guidelines](https://github.com/connamara/agent_zmq/blob/master/CONTRIBUTION_GUIDELINES.md).
+
+Credits
+-------
+
+Contributers:
+
+* Chris Busbey
+* Brad Haan
+
+![Connamara Systems](http://www.connamara.com/images/home-connamara-logo-lg.png)
+
+agent_zmq is maintained and funded by [Connamara Systems, llc](http://connamara.com).
+
+The names and logos for Connamara Systems are trademarks of Connamara Systems, llc.
+
+Licensing
+---------
+
+agent_zmq is Copyright © 2013 Connamara Systems, llc. 
+
+This software is available under the GPL and a commercial license.  Please see the [LICENSE](https://github.com/connamara/agent_zmq/blob/master/LICENSE.txt) file for the terms specified by the GPL license.  The commercial license offers more flexible licensing terms compared to the GPL, and includes support services.  [Contact us](mailto:info@connamara.com) for more information on the Connamara commercial license, what it enables, and how you can start developing with it.

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:cucumber)
+
+task :test => [:spec, :cucumber]
+task :default => :test
+
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "agent_zmq"
+  gem.homepage = "https://github.com/connamara/agent_zmq"
+  gem.license = "GPL"
+  gem.summary = %Q{Acceptance test framework for ZeroMQ applications}
+  gem.description = %Q{Acceptance test framework for ZeroMQ applications. Includes some cucumber helpers.}
+  gem.email = "info@connamara.com"
+  gem.authors = ["Chris Busbey"]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/agent_zmq.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "agent_zmq"
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Busbey"]
+  s.date = "2013-08-29"
+  s.description = "Acceptance test framework for ZeroMQ applications. Includes some cucumber helpers."
+  s.email = "info@connamara.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "CONTRIBUTION_GUIDELINES.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "agent_zmq.gemspec",
+    "config/zmq_agents.rb",
+    "features/MessageInspection.feature",
+    "features/step_definitions/steps.rb",
+    "features/support/env.rb",
+    "lib/agent_zmq.rb",
+    "lib/agent_zmq/agent.rb",
+    "lib/agent_zmq/agents/base_agent.rb",
+    "lib/agent_zmq/agents/pub_agent.rb",
+    "lib/agent_zmq/agents/rep_agent.rb",
+    "lib/agent_zmq/agents/req_agent.rb",
+    "lib/agent_zmq/agents/sub_agent.rb",
+    "lib/agent_zmq/cucumber.rb",
+    "lib/agent_zmq/helpers.rb",
+    "lib/agent_zmq/message_cache.rb",
+    "spec/agent_zmq/message_cache_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/connamara/agent_zmq"
+  s.licenses = ["GPL"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.7"
+  s.summary = "Acceptance test framework for ZeroMQ applications"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi-rzmq>, ["~> 0.9.3"])
+      s.add_runtime_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<cucumber>, ["~> 1.3"])
+      s.add_development_dependency(%q<rake>, ["~> 10.1"])
+    else
+      s.add_dependency(%q<ffi-rzmq>, ["~> 0.9.3"])
+      s.add_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<cucumber>, ["~> 1.3"])
+      s.add_dependency(%q<rake>, ["~> 10.1"])
+    end
+  else
+    s.add_dependency(%q<ffi-rzmq>, ["~> 0.9.3"])
+    s.add_dependency(%q<rspec>, ["~> 2.14"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<cucumber>, ["~> 1.3"])
+    s.add_dependency(%q<rake>, ["~> 10.1"])
+  end
+end
+

data/config/zmq_agents.rb

@@ -0,0 +1,14 @@
+AgentZMQ.define_ZMQ_SUB :my_subscriber do |a|
+  a.socket_opts << {ZMQ::SUBSCRIBE=>""} 
+
+  a.end_point_type=:connect
+  a.end_point='tcp://127.0.0.1:5560'
+end
+
+AgentZMQ.define_ZMQ_PUB :my_publisher do |a|
+  a.end_point_type=:bind
+  a.end_point='tcp://*:5560'
+end
+
+
+

data/features/MessageInspection.feature

@@ -0,0 +1,13 @@
+Feature: The Cucumber interface allows message inspection
+
+Scenario: A message is received
+
+  Given publisher "my_publisher" sends the following: 
+  |hello|world|
+
+  And I sleep 2 seconds
+
+  Then I should receive a message on ZeroMQ with agent "my_subscriber" 
+  And the ZeroMQ message should have 2 parts
+  And part 1 of the ZeroMQ message should be "hello"
+  And part 2 of the ZeroMQ message should be "world"

data/features/step_definitions/steps.rb

@@ -0,0 +1,7 @@
+Given /^publisher "([^"]*)" sends the following:$/ do |publisher, message|
+  AgentZMQ.agents_hash[publisher.to_sym].publish message.raw.first
+end
+
+Given /^I sleep (\d+) seconds$/ do |seconds|
+  sleep(seconds.to_i)
+end

data/features/support/env.rb

@@ -0,0 +1,8 @@
+$: << File.expand_path("../../../lib", __FILE__)
+
+require 'agent_zmq/cucumber'
+
+AgentZMQ.start
+at_exit {
+  AgentZMQ.stop
+}

data/lib/agent_zmq.rb

@@ -0,0 +1,71 @@
+module AgentZMQ
+  extend self
+
+  def agent_path
+    "./config/zmq_agents.rb"
+  end
+
+  def agents
+    return @agents if @agents
+
+    (@agents=[]).tap do
+      load_agents if agent_files_loaded.empty?
+    end
+  end
+
+  def agent_files_loaded
+    @agent_files_loaded ||=[]
+  end
+
+  def load_agents path=nil
+    path = File.expand_path(path || agent_path, Dir.pwd)
+    return if agent_files_loaded.include? path
+    agent_files_loaded << path
+    load path
+  end
+
+  def define_agent(agent, &blk)
+    yield agent
+    agents << agent
+  end
+
+  def define_ZMQ_SUB(name, &blk) 
+    define_agent(AgentZMQ::SubAgent.new(name), &blk)
+  end
+
+  def define_ZMQ_PUB(name, &blk)
+    define_agent(AgentZMQ::PubAgent.new(name), &blk)
+  end
+
+  def define_ZMQ_REQ(name, &blk)
+    define_agent(AgentZMQ::ReqAgent.new(name), &blk)
+  end
+
+  def define_ZMQ_REP(name, &blk)
+    define_agent(AgentZMQ::RepAgent.new(name), &blk)
+  end
+
+  #starts all configured agents
+  def start
+    raise RuntimeError, "No ZMQ Agents Defined" if agents.empty?
+
+    agents.each do |a|
+      a.start
+    end
+  end
+
+  def stop
+    agents.each {|a| a.stop}
+  end
+
+  def reset
+    agents.each {|a| a.reset}
+  end
+
+  def agents_hash
+    Hash[agents.map { |a| [a.name.to_sym, a]}]
+  end
+end
+
+require 'agent_zmq/helpers'
+require 'agent_zmq/agent'

data/lib/agent_zmq/agent.rb

@@ -0,0 +1,4 @@
+require 'agent_zmq/agents/sub_agent.rb'
+require 'agent_zmq/agents/pub_agent.rb'
+require 'agent_zmq/agents/req_agent.rb'
+require 'agent_zmq/agents/rep_agent.rb'

data/lib/agent_zmq/agents/base_agent.rb

@@ -0,0 +1,31 @@
+module AgentZMQ::BaseAgent
+  attr_reader :name
+
+  attr_accessor :end_point_type, :end_point, :socket_opts
+
+  def zmq_context
+    @ctx ||= ZMQ::Context.new 1
+  end
+
+  def zmq_socket
+    return @sub_socket unless @sub_socket.nil?
+
+    (@sub_socket = sock_type).tap do
+
+      case @end_point_type 
+        when :connect
+          @sub_socket.connect(@end_point) 
+        else
+          @sub_socket.bind(@end_point) 
+      end
+
+      if @socket_opts.is_a? Array
+        @socket_opts.each do |opts|
+          opts.each_pair do |opt_name, opt_val|
+            @sub_socket.setsockopt(opt_name,opt_val)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/agent_zmq/agents/pub_agent.rb

@@ -0,0 +1,31 @@
+require 'agent_zmq/agents/base_agent'
+
+class AgentZMQ::PubAgent
+  include AgentZMQ::BaseAgent
+
+  def initialize name
+    @name=name
+    @socket_opts=[]
+  end
+
+  def sock_type
+    zmq_context.socket(ZMQ::PUB)
+  end
+
+  def start
+    zmq_socket
+    sleep 0.8 # slow joiner
+  end
+
+  def stop
+    zmq_socket.close
+  end
+
+  def publish msg
+    AgentZMQ::Helpers.publish zmq_socket, msg
+  end
+
+  def reset
+
+  end
+end

data/lib/agent_zmq/agents/rep_agent.rb

@@ -0,0 +1,65 @@
+require 'agent_zmq/agents/base_agent'
+require 'thread'
+
+class AgentZMQ::RepAgent
+  include AgentZMQ::BaseAgent
+  include AgentZMQ::MessageCache
+
+  attr_accessor :reply
+
+  def initialize name
+    @name=name
+    @socket_opts=[]
+
+    @read_thread=nil
+    @mutex = Mutex.new
+    @do_run_read_thread = true
+  end
+
+  def do_read 
+    while true 
+      @mutex.synchronize do
+        return unless @do_run_read_thread
+      end
+      @zmq_poller.poll(1000)
+
+      @zmq_poller.readables.each do |sock|
+        request=AgentZMQ::Helpers.read_msg sock
+        add_msg request
+
+        unless @reply.nil?
+          AgentZMQ::Helpers.publish(sock, @reply.call(request))
+        end
+      end
+    end
+
+    zmq_socket.close 
+  end
+
+  def sock_type
+    zmq_context.socket(ZMQ::REP)
+  end
+
+  def start_read_thread
+    @zmq_poller = ZMQ::Poller.new
+    @zmq_poller.register(zmq_socket, ZMQ::POLLIN)
+
+    @read_thread = Thread.new {do_read}
+  end
+
+  def start
+    start_read_thread
+  end
+
+  def stop
+    @mutex.synchronize do
+      @do_run_read_thread=false
+    end
+    @read_thread.join
+    zmq_socket.close
+  end
+
+  def reset
+    clear
+  end
+end

data/lib/agent_zmq/agents/req_agent.rb

@@ -0,0 +1,32 @@
+require 'agent_zmq/agents/base_agent'
+
+class AgentZMQ::ReqAgent
+  include AgentZMQ::BaseAgent
+
+  def initialize name
+    @name=name
+    @socket_opts=[]
+  end
+
+  def sock_type
+    zmq_context.socket(ZMQ::REQ)
+  end
+
+  def start
+    zmq_socket
+    sleep 0.8 # slow joiner
+  end
+
+  def stop
+    zmq_socket.close
+  end
+
+  def publish msg
+    AgentZMQ::Helpers.publish(zmq_socket, msg)
+    AgentZMQ::Helpers.read_msg zmq_socket
+ end
+
+  def reset
+    #no-op
+  end
+end

data/lib/agent_zmq/agents/sub_agent.rb

@@ -0,0 +1,66 @@
+require 'ffi-rzmq'
+require 'thread'
+
+require 'agent_zmq/message_cache'
+require 'agent_zmq/agents/base_agent'
+
+class AgentZMQ::SubAgent
+  include AgentZMQ::MessageCache
+  include AgentZMQ::BaseAgent
+
+  attr_reader :name
+
+  def initialize name
+    @name=name
+    @socket_opts=[]
+
+    @mutex=Mutex.new
+    @read_thread=nil
+    @do_run_read_thread = true
+  end
+
+  def do_read 
+    while true 
+      @mutex.synchronize do
+        return unless @do_run_read_thread
+      end
+
+      @zmq_poller.poll(1000)
+
+      @zmq_poller.readables.each do |sock|
+        add_msg AgentZMQ::Helpers.read_msg sock
+      end
+    end
+
+    zmq_socket.close 
+  end
+
+  def sock_type
+    zmq_context.socket(ZMQ::SUB)
+  end
+
+
+  def start_read_thread
+    @zmq_poller = ZMQ::Poller.new
+    @zmq_poller.register(zmq_socket, ZMQ::POLLIN)
+
+    @read_thread = Thread.new {do_read}
+  end
+
+  def start
+    start_read_thread
+  end
+
+  def stop
+    @mutex.synchronize do
+      @do_run_read_thread = false
+    end
+    @read_thread.join
+    zmq_socket.close
+  end
+
+  def reset
+    clear
+  end
+
+end

data/lib/agent_zmq/cucumber.rb

@@ -0,0 +1,32 @@
+require File.expand_path("../../agent_zmq", __FILE__)
+
+require 'rspec'
+
+module ZMQMessageCache
+  def last_zmq_message
+    @message
+  end
+end
+
+World(ZMQMessageCache)
+
+Then /^I should receive a (?:request|response|message) on ZeroMQ with agent "([^"]*)"$/ do |subscriber|
+  throw "Unknown agent #{subscriber}" unless AgentZMQ.agents_hash.has_key?(subscriber.to_sym)
+  throw "#{subscriber} is not an agent type that receives messages" unless AgentZMQ.agents_hash[subscriber.to_sym].respond_to?(:pop)
+
+  @message=AgentZMQ.agents_hash[subscriber.to_sym].pop
+  @message.should_not be_nil
+end
+
+Then /^the ZeroMQ (?:request|response|message) should have (\d+) parts$/ do |length|
+  throw "last_zmq_message is nil" if last_zmq_message.nil?
+
+  last_zmq_message.length == length.to_i
+end
+
+Then /^part (\d+) of the ZeroMQ (?:request|response|message) should be "([^"]*)"$/ do |index, value|
+  throw "last_zmq_message is nil" if last_zmq_message.nil?
+
+  last_zmq_message.length.should >= index.to_i
+  last_zmq_message[(index.to_i - 1)].should == value
+end

data/lib/agent_zmq/helpers.rb

@@ -0,0 +1,32 @@
+module AgentZMQ
+  module Helpers
+    extend self
+
+    def read_msg socket
+      msg_parts = []
+
+      begin
+        part=""
+        socket.recv_string part
+        msg_parts << part
+      end while socket.more_parts?
+
+      msg_parts
+    end
+
+    def publish socket, msg
+      msg = [msg] unless msg.is_a? Array
+
+      while true do
+        msg_part=msg.shift
+
+        if msg.empty?
+          socket.send_string msg_part
+          break
+        else
+          socket.send_string msg_part, ZMQ::SNDMORE
+        end
+      end
+    end
+  end
+end

data/lib/agent_zmq/message_cache.rb

@@ -0,0 +1,36 @@
+require 'thread'
+module AgentZMQ::MessageCache
+  def messages_received
+    lock.synchronize do
+      return messages.dup
+    end
+  end
+
+  def pop
+    lock.synchronize do
+      return messages.pop
+    end
+  end
+
+  def add_msg msg
+    lock.synchronize do
+      messages << msg
+    end
+  end
+
+  def clear
+    lock.synchronize do
+      messages.clear
+    end
+  end
+
+  private
+
+  def messages
+    @messages||=[]
+  end
+
+  def lock
+    @lock||=Mutex.new
+  end
+end

data/spec/agent_zmq/message_cache_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+class DummyClass
+end
+
+describe AgentZMQ::MessageCache do
+  before(:each) do
+    @cache = DummyClass.new
+    @cache.extend(AgentZMQ::MessageCache)
+  end
+
+  describe "pop" do
+    it "returns nil if empty" do
+      @cache.pop.should be_nil
+    end
+
+    it "returns pops messages in lifo" do
+      @cache.add_msg "hello"
+      @cache.add_msg "world"
+
+      @cache.pop.should ==("world")
+      @cache.pop.should ==("hello")
+      @cache.pop.should be_nil
+    end
+  end
+
+  describe "clear" do
+    it "removes all cached messages" do
+      @cache.add_msg "hello"
+      @cache.add_msg "world"
+
+      @cache.clear
+      @cache.pop.should be_nil
+    end
+  end
+
+  describe "messages_received" do
+    it "duplicates the internal message cache" do
+      @cache.add_msg "hello"
+      @cache.add_msg "world"
+
+      msgs_received = @cache.messages_received
+      @cache.clear
+      msgs_received.should ==["hello", "world"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'agent_zmq'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: agent_zmq
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+platform: ruby
+authors: 
+- Chris Busbey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-08-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi-rzmq
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.14"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.8"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "10.1"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Acceptance test framework for ZeroMQ applications. Includes some cucumber helpers.
+email: info@connamara.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- .travis.yml
+- CONTRIBUTION_GUIDELINES.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- agent_zmq.gemspec
+- config/zmq_agents.rb
+- features/MessageInspection.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- lib/agent_zmq.rb
+- lib/agent_zmq/agent.rb
+- lib/agent_zmq/agents/base_agent.rb
+- lib/agent_zmq/agents/pub_agent.rb
+- lib/agent_zmq/agents/rep_agent.rb
+- lib/agent_zmq/agents/req_agent.rb
+- lib/agent_zmq/agents/sub_agent.rb
+- lib/agent_zmq/cucumber.rb
+- lib/agent_zmq/helpers.rb
+- lib/agent_zmq/message_cache.rb
+- spec/agent_zmq/message_cache_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/connamara/agent_zmq
+licenses: 
+- GPL
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id006 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id006
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Acceptance test framework for ZeroMQ applications
+test_files: []
+