ruby_mailman 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 841cc56a61b4a16b14dcf1126c8a6f1228021042
+  data.tar.gz: 82eea3a9156d4c42b3ed1f6ff6d68dd9a8c58532
+SHA512:
+  metadata.gz: 596d35d65745351ede2e99fdfdb281becbb4fc703c752a8c75db9911b549da031eecba15ffd8345c90210ac716ae4fbe3914fa4a05809a04e1ffd467ba5c8d24
+  data.tar.gz: 464957a5983d49b6f84912775e26102eeed8e205a850076e2650452c90fb36e1df6f460082d6845aa83139535aff422b8736e2628c90a5b27bed64aabf666c4f

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/protobufs
+vendor/bundle
+lib/*pb.rb

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1 @@
+© Regents of the University of Minnesota. All rights reserved.

data/README.md

@@ -0,0 +1,173 @@
+# Ruby Mailman
+
+- A ruby library for interacting with Central Service
+  - Sending Messages
+  - Subscribing to Channels
+  - Follows the spec outlined in https://github.umn.edu/umnapi/services_interface
+
+## Sending Messages
+
+Central Services will expect objects to be serialized [protobuf objects](https://github.umn.edu/umnapi/protobufs). If you send other types of objects in your messages it probably will not work.
+
+```ruby
+
+module Interfaces
+  class Auth < ::Protobuf::Message; end
+
+  class Auth
+    optional :string, :email, 2
+    optional :string, :public_key, 3
+    optional :string, :private_key, 4
+  end
+
+end
+
+
+auth = Interfaces::Auth.new
+message = auth.encode
+
+RubyMailman::Mailman.deliver(:create, message)
+RubyMailman::Mailman.deliver(:update, message)
+RubyMailman::Mailman.deliver(:destroy, message)
+
+RubyMailman::Mailman.create(message)
+RubyMailman::Mailman.update(message)
+RubyMailman::Mailman.destroy(message)
+```
+
+### Responses
+
+Central Services has 3 types of response:
+- success ('200')
+- retry ('409')
+- failure ('500')
+
+#### Success
+
+```ruby
+response = Mailman.deliver(:create, obj)
+response.success?
+#=> true
+response.retry?
+#=> false
+response.fail?
+#=> false
+response.body
+#=> '200'
+```
+
+#### Retry
+
+```ruby
+response = Mailman.deliver(:create, obj)
+response.success?
+#=> false
+response.retry?
+#=> true
+response.fail?
+#=> false
+response.body
+#=> '409'
+```
+
+#### Failure
+
+```ruby
+response = Mailman.deliver(:create, obj)
+response.success?
+#=> false
+response.retry?
+#=> false
+response.fail?
+#=> true
+response.body
+#=> '500'
+```
+
+## Subscribing
+
+You need to write some code that will handle the responses you'll get from subscription. There are a couple of ways to do this.
+
+#### Listener Class
+
+It just has to implement the `call` message with an arity of two. The channel will be the first parameter, the message will be the second. Do whatever you want within the method.
+
+```ruby
+class MyListener
+  def call(channel, message)
+    # your code to handle the new message
+  end
+end
+
+
+RubyMailman::Subscription.subscribe(channel: :key, listener: MyListener.new)
+#=> #<RubyMailman::Subscription:0x007fa2d3835978 ...>
+```
+
+#### Listener Lambda
+
+Since lambdas respond to `call`, you can do
+
+```ruby
+my_listener = lambda{ |channel, message| #your code }
+RubyMailman::Subscription.subscribe(channel: :key, listener: my_listener)
+#=> #<RubyMailman::Subscription:0x007fa2d3835978 ...>
+```
+
+### Subscription Messages
+
+Your listener will receive `call` with  the channel and the message. The message is an instance of RubyMailman::Subscription::Message and responds to:
+
+- channel: the channel again
+- action: `create`, `update` or `destroy`
+- content: A serialized protobuff object
+
+This is a very specific message, since it's really only designed to do one thing -- tell your service about new/changed/destroyed objects. Let's look at an example of a service that care about Auth objects, and it locally persists those Auth objects as LocalAuth:
+
+```ruby
+class AuthListener
+  def call(channel, message)
+    a = Interfaces::Auth.new
+    a.decode(message.content)
+
+    AuthLogger.log("Message received on #{message.channel} telling me to #{message.action} the object #{a.to_s}")
+
+    case message.action
+    when 'create'
+      LocalAuth.new(a).save #We'll leave the implementation of LocalAuth to your imagination.
+    when 'update'
+      LocalAuth.replace(a)
+    when 'destroy'
+      LocalAuth.destroy(a)
+    else
+      raise ArgumentError
+    end
+  end
+end
+
+RubyMailman::Subscription.new(channel: Auth, listener: AuthListener.new)
+```
+
+## Setup
+
+- Add `gem ruby_mailman` to your service
+- `bundle install --path ./vendor/bundle`
+
+## Local Setup and Running Tests
+
+- Clone the repo
+- `bundle install --path ./vendor/bundle`
+- `bundle exec rake`
+
+## Development
+
+To work on the gem:
+
+- Fork this repo
+- Submit your changes through a pull request
+- Tests are required for any pull requests
+
+## License
+
+© Regents of the University of Minnesota. All rights reserved.
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/ruby_mailman/central_service_interface.rb

@@ -0,0 +1,24 @@
+class CentralServiceInterface
+  def self.deliver(action,object,cs_client = CSTransportClient)
+    self.new(cs_client).deliver(action,object)
+  end
+
+  def self.subscribe(channel, listener, cs_client = CSTransportClient)
+    self.new(cs_client).subscribe(channel, listener)
+  end
+
+  def initialize(cs_client)
+    self.central_service_client = cs_client
+  end
+
+  def deliver(action,object)
+    central_service_client.request(action,object)
+  end
+
+  def subscribe(channel, listener)
+    central_service_client.subscribe(channel, listener)
+  end
+
+  private
+  attr_accessor :central_service_client
+end

data/lib/ruby_mailman/mailman.rb

@@ -0,0 +1,33 @@
+module RubyMailman
+  class Mailman
+    def self.deliver(action, obj, cs = CentralServiceInterface)
+      self.new(action, obj, cs).deliver
+    end
+
+    def self.create(obj, cs = CentralServiceInterface)
+      self.deliver(:create, obj, cs)
+    end
+
+    def self.update(obj, cs = CentralServiceInterface)
+      self.deliver(:update, obj, cs)
+    end
+
+    def self.destroy(obj, cs = CentralServiceInterface)
+      self.deliver(:destroy, obj, cs)
+    end
+
+    def initialize(action, object, central_service)
+      self.action = action
+      self.object = object
+      self.central_service = central_service
+    end
+
+    def deliver
+      Response.build(central_service.deliver(action.to_s, object))
+    end
+
+    private
+
+    attr_accessor :action, :object, :central_service
+  end
+end

data/lib/ruby_mailman/response.rb

@@ -0,0 +1,56 @@
+module RubyMailman
+  class Response
+    attr_reader :body
+    def self.build(raw_response)
+      #Work with both a string "200" and an array ["200"]
+      raw_response = Array(raw_response).join
+      case raw_response
+      when "200"
+        SuccessResponse.new(raw_response)
+      when "409"
+        RetryResponse.new(raw_response)
+      when "500"
+        FailResponse.new(raw_response)
+      else
+        self.new(raw_response)
+      end
+    end
+
+    def success?
+      false
+    end
+
+    def retry?
+      false
+    end
+
+    def fail?
+      false
+    end
+
+    def initialize(body)
+      self.body = body
+    end
+
+    private
+    attr_writer :body
+  end
+
+  class SuccessResponse < Response
+    def success?
+      true
+    end
+  end
+
+  class RetryResponse < Response
+    def retry?
+      true
+    end
+  end
+
+  class FailResponse < Response
+    def fail?
+      true
+    end
+  end
+end

data/lib/ruby_mailman/subscription/message.rb

@@ -0,0 +1,15 @@
+module RubyMailman
+  class Subscription
+    class Message
+      attr_reader :channel, :action, :content
+      def initialize(channel, raw_message)
+        self.channel = channel
+        self.action = raw_message[0]
+        self.content = raw_message[1]
+      end
+
+      private
+      attr_writer :channel, :action, :content
+    end
+  end
+end

data/lib/ruby_mailman/subscription.rb

@@ -0,0 +1,25 @@
+module RubyMailman
+  class Subscription
+    def self.subscribe(args, cs = CentralServiceInterface)
+      channel = args.fetch(:channel) do
+        raise ArgumentError, "Subscribtion requries a channel"
+      end
+
+      listener = args.fetch(:listener) do
+        raise ArgumentError, "Subscribtion requries a listener"
+      end
+
+      self.new(channel, listener, cs)
+    end
+
+    def initialize(channel, listener, cs)
+      self.channel = channel
+      self.listener = listener
+      self.central_service = cs
+      central_service.subscribe(channel, listener)
+    end
+
+    private
+    attr_accessor :channel, :listener, :central_service
+  end
+end

data/lib/ruby_mailman/version.rb

@@ -0,0 +1,3 @@
+module RubyMailman
+  VERSION = "0.9.0"
+end

data/lib/ruby_mailman/zmq_client.rb

@@ -0,0 +1,50 @@
+require 'ffi-rzmq'
+
+class ZMQConfiguration
+  def self.server
+    ENV['0MQServerAddress'] || "tcp://localhost:6666"
+  end
+end
+
+class ZMQRequestClient
+  def self.run(action, object)
+    context = ZMQ::Context.new
+    connection = context.socket(ZMQ::REQ)
+    connection.connect(ZMQConfiguration.server)
+    connection.send_strings([action, object])
+    receiver = ""
+    connection.recv_string(receiver)
+    receiver
+  end
+end
+
+class ZMQSubscriptionClient
+  def self.run(channel, listener, message_builder = RubyMailman::Subscription::Message)
+    context = ZMQ::Context.new
+    connection = context.socket(ZMQ::SUB)
+    connection.connect(ZMQConfiguration.server)
+    connection.setsockopt(ZMQ::SUBSCRIBE, channel)
+
+    Thread.new do
+      loop do
+        received_channel = ''
+        connection.recv_string(received_channel)
+        message = []
+        connection.recv_strings(message)
+        listener.call(received_channel, message_builder.new(received_channel, message))
+      end
+    end
+  end
+end
+
+class ZMQClient
+  attr_reader :connection
+
+  def self.request(action, object, concrete_client = ZMQRequestClient)
+    concrete_client.run(action, object)
+  end
+
+  def self.subscribe(channel, listener, concrete_client = ZMQSubscriptionClient)
+    concrete_client.run(channel, listener)
+  end
+end

data/lib/ruby_mailman.rb

@@ -0,0 +1,8 @@
+require "ruby_mailman/version"
+require "ruby_mailman/mailman"
+require "ruby_mailman/subscription"
+require "ruby_mailman/subscription/message"
+require "ruby_mailman/response"
+require "ruby_mailman/central_service_interface"
+require "ruby_mailman/zmq_client"
+CSTransportClient = ZMQClient

data/ruby_mailman.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_mailman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_mailman"
+  spec.version       = RubyMailman::VERSION
+  spec.authors       = ["Ian Whitney"]
+  spec.email         = ["whit0694@umn.edu"]
+  spec.summary       = %q{A ruby library for connecting to Central Service}
+  spec.description   = %q{Ruby implementation of the Central Service interface. Meant for use with UMN API Services written in Ruby.}
+  spec.homepage      = "https://github.umn.edu/umnapi/ruby_mailman/"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "protobuf"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "ffi-rzmq"
+end

data/spec/integration/request_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+require_relative '../../lib/ruby_mailman'
+require_relative '../models/auth.pb'
+require_relative "../zmq_servers/reply"
+
+RSpec.describe "Making requests" do
+
+  let(:auth) { Interfaces::Auth.new }
+
+  describe "main methods work" do
+    before(:example) do
+      @server_configuration = {
+        port: 6666,
+        reply: -> { "#{rand}" }
+      }
+      @pid = TestServer::Reply.run_as_process(@server_configuration)
+    end
+
+    after(:example) do
+      Process.kill("KILL", @pid)
+    end
+
+    it "returns non nil when using the .deliver method" do
+      expect(RubyMailman::Mailman.deliver(:create, auth.encode)).not_to be_nil
+      expect(RubyMailman::Mailman.deliver(:update, auth.encode)).not_to be_nil
+      expect(RubyMailman::Mailman.deliver(:destroy, auth.encode)).not_to be_nil
+    end
+
+    it "returns non nil when using the named method" do
+      expect(RubyMailman::Mailman.create(auth.encode)).not_to be_nil
+      expect(RubyMailman::Mailman.update(auth.encode)).not_to be_nil
+      expect(RubyMailman::Mailman.destroy(auth.encode)).not_to be_nil
+    end
+  end
+
+  describe "responses behave as expected" do
+    describe "When the server repsonds with '200'" do
+      before(:example) do
+        @server_configuration = {
+          port: 6666,
+          reply: -> { "200" }
+        }
+        @pid = TestServer::Reply.run_as_process(@server_configuration)
+      end
+
+      after(:example) do
+        Process.kill("KILL", @pid)
+      end
+
+      it "Requests get a sucessful response" do
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).success?).to be_truthy
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).retry?).to be_falsey
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).fail?).to be_falsey
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).body).to eq("200")
+      end
+    end
+
+    describe "When the server repsonds with '409'" do
+      before(:example) do
+        @server_configuration = {
+          port: 6666,
+          reply: -> { "409" }
+        }
+        @pid = TestServer::Reply.run_as_process(@server_configuration)
+      end
+
+      after(:example) do
+        Process.kill("KILL", @pid)
+      end
+
+      it "Requests get a retry response" do
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).success?).to be_falsey
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).retry?).to be_truthy
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).fail?).to be_falsey
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).body).to eq("409")
+      end
+    end
+
+    describe "When the server repsonds with '500'" do
+      before(:example) do
+        @server_configuration = {
+          port: 6666,
+          reply: -> { "500" }
+        }
+        @pid = TestServer::Reply.run_as_process(@server_configuration)
+      end
+
+      after(:example) do
+        Process.kill("KILL", @pid)
+      end
+
+      it "Requests get a failure response" do
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).success?).to be_falsey
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).retry?).to be_falsey
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).fail?).to be_truthy
+        expect(RubyMailman::Mailman.deliver(:create, auth.encode).body).to eq("500")
+      end
+    end
+  end
+end

data/spec/integration/subscribe_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'securerandom'
+require 'protobuf'
+
+require_relative '../models/auth.pb'
+require_relative '../../lib/ruby_mailman'
+require_relative "../zmq_servers/publish"
+
+class MyListener
+  attr_reader :channel, :message
+  def call(channel, message)
+    @channel = channel
+    @message = message
+  end
+end
+
+RSpec.describe "Subscribing to channels" do
+  let(:listener) { MyListener.new }
+
+  before(:example) do
+    @message_action = ['create','update','destroy'].sample
+    auth = Interfaces::Auth.new
+    auth.email = rand.to_s
+    auth.public_key = SecureRandom.uuid
+    auth.private_key = SecureRandom.uuid
+    @message_content = auth.encode
+
+    @server_configuration = {
+      channel: "mychannel",
+      port: 6666,
+      message_parts: [@message_action, @message_content],
+      publish_delay: 0.05
+    }
+    @pid = TestServer::Publish.run_as_process(@server_configuration)
+    @test_delay = @server_configuration[:publish_delay] * 2
+
+    #wait so the publisher process can get rolling
+    sleep(@test_delay)
+  end
+
+  after(:example) do
+    Process.kill("KILL", @pid)
+  end
+
+  it "returns a RubyMailman::Subscription instance when subscribing" do
+    subscription_return = RubyMailman::Subscription.subscribe(channel: @server_configuration[:channel], listener: listener)
+    expect(subscription_return).to be_a(RubyMailman::Subscription)
+  end
+
+  it "calls the listener when a new message is published" do
+    expect(listener).to receive(:call).at_least(:once)
+    RubyMailman::Subscription.subscribe(channel: @server_configuration[:channel], listener: listener)
+    sleep(@test_delay)
+  end
+
+  it "calls the listener with the channel name and a RubyMailman::Subscription::Message instance" do
+    RubyMailman::Subscription.subscribe(channel: @server_configuration[:channel], listener: listener)
+    sleep(@test_delay)
+
+    expect(listener.channel).to eq(@server_configuration[:channel])
+    expect(listener.message).to be_a(RubyMailman::Subscription::Message)
+  end
+
+  it "The message instance has the channel, action and content we expect" do
+    RubyMailman::Subscription.subscribe(channel: @server_configuration[:channel], listener: listener)
+    sleep(@test_delay)
+
+    expect(listener.message.channel).to eq(@server_configuration[:channel])
+    expect(listener.message.action).to eq(@message_action)
+    expect(listener.message.content).to eq(@message_content)
+  end
+end

data/spec/lib/ruby_mailman/central_service_interface_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+require_relative "../../../lib/ruby_mailman"
+
+RSpec.describe CentralServiceInterface do
+  let (:client_class_double) { class_double(ZMQClient) }
+
+  describe "self.deliver" do
+    before do
+      @action = "action#{rand}"
+      @object = Object.new
+    end
+
+    it "uses the provided client to make a request" do
+      expect(client_class_double).to receive(:request).with(@action, @object) { true }
+      CentralServiceInterface.deliver(@action,@object,client_class_double)
+    end
+  end
+
+  describe "self.subscribe" do
+    before do
+      @channel = "channel#{rand}"
+      @listener = Object.new
+    end
+
+    it "uses the provided client to subscribe" do
+      expect(client_class_double).to receive(:subscribe).with(@channel, @listener) { true }
+      CentralServiceInterface.subscribe(@channel, @listener, client_class_double)
+    end
+  end
+end

data/spec/lib/ruby_mailman/mailman_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require_relative "../../../lib/ruby_mailman"
+
+Mailman = RubyMailman::Mailman
+
+describe Mailman do
+  let (:cs_interface_double) { double(CentralServiceInterface) }
+  let (:object_double) { Object.new }
+
+  before do
+    allow(RubyMailman::Response).to receive(:build) { Object.new }
+  end
+
+  describe "notifies of creation" do
+    it "has the CentralServiceInterface do the work" do
+      expect(cs_interface_double).to receive(:deliver).with("create", object_double)
+      Mailman.deliver(:create, object_double, cs_interface_double)
+    end
+
+    it "supports the .deliver syntax" do
+      expect(cs_interface_double).to receive(:deliver).with("create", object_double)
+      Mailman.deliver(:create, object_double, cs_interface_double)
+    end
+
+    it "works with the .create syntax" do
+      expect(cs_interface_double).to receive(:deliver).with("create", object_double)
+      Mailman.create(object_double, cs_interface_double)
+    end
+  end
+
+  describe "notifies of update" do
+    it "has the CentralServiceInterface do the work" do
+      expect(cs_interface_double).to receive(:deliver).with("update", object_double)
+      Mailman.deliver(:update, object_double, cs_interface_double)
+    end
+
+    it "supports the .deliver syntax" do
+      expect(cs_interface_double).to receive(:deliver).with("update", object_double)
+      Mailman.deliver(:update, object_double, cs_interface_double)
+    end
+
+    it "works with the .update syntax" do
+      expect(cs_interface_double).to receive(:deliver).with("update", object_double)
+      Mailman.update(object_double, cs_interface_double)
+    end
+  end
+
+  describe "notifies of destruction" do
+    it "has the CentralServiceInterface do the work" do
+      expect(cs_interface_double).to receive(:deliver).with("destroy", object_double)
+      Mailman.deliver(:destroy, object_double, cs_interface_double)
+    end
+
+    it "supports the .deliver syntax" do
+      expect(cs_interface_double).to receive(:deliver).with("destroy", object_double)
+      Mailman.deliver(:destroy, object_double, cs_interface_double)
+    end
+
+    it "works with the .destroy syntax" do
+      expect(cs_interface_double).to receive(:deliver).with("destroy", object_double)
+      Mailman.destroy(object_double, cs_interface_double)
+    end
+  end
+end

data/spec/lib/ruby_mailman/response_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+require_relative "../../../lib/ruby_mailman"
+
+Response = RubyMailman::Response
+SuccessResponse = RubyMailman::SuccessResponse
+RetryResponse = RubyMailman::RetryResponse
+FailResponse = RubyMailman::FailResponse
+
+describe Response do
+  describe "build" do
+    it "creates and returns a SuccessResponse if the raw_response is '200'" do
+      x = Object.new
+      expect(SuccessResponse).to receive(:new).with('200') { x }
+      expect(Response.build('200')).to eq(x)
+    end
+
+    it "returns a SuccessResponse if the raw_response is '409'" do
+      x = Object.new
+      expect(RetryResponse).to receive(:new).with('409') { x }
+      expect(Response.build('409')).to eq(x)
+    end
+
+    it "returns a FailResponse if the raw_response is '500'" do
+      x = Object.new
+      expect(FailResponse).to receive(:new).with('500') { x }
+      expect(Response.build('500')).to eq(x)
+    end
+
+    it "returns a undecorated response with any other raw_response" do
+      x = Object.new
+      raw_response = rand(100).to_s
+      expect(Response).to receive(:new).with(raw_response) { x }
+      expect(Response.build(raw_response)).to eq(x)
+    end
+
+    it "has a body equal to the raw_response" do
+      ['200', '409', '500', rand(100).to_s].each do |code|
+        expect(Response.build(code).body).to eq(code)
+      end
+    end
+  end
+
+  describe "success?" do
+    it "is false" do
+      expect(Response.new('').success?).to be_falsey
+    end
+  end
+
+  describe "retry?" do
+    it "is false" do
+      expect(Response.new('').retry?).to be_falsey
+    end
+  end
+
+  describe "fail?" do
+    it "is false" do
+      expect(Response.new('').fail?).to be_falsey
+    end
+  end
+
+  describe SuccessResponse do
+    describe "success?" do
+      it "is false" do
+        expect(SuccessResponse.new('').success?).to be_truthy
+      end
+    end
+
+    describe "retry?" do
+      it "is false" do
+        expect(SuccessResponse.new('').retry?).to be_falsey
+      end
+    end
+
+    describe "fail?" do
+      it "is false" do
+        expect(SuccessResponse.new('').fail?).to be_falsey
+      end
+    end
+  end
+
+  describe FailResponse do
+    describe "success?" do
+      it "is false" do
+        expect(FailResponse.new('').success?).to be_falsey
+      end
+    end
+
+    describe "retry?" do
+      it "is false" do
+        expect(FailResponse.new('').retry?).to be_falsey
+      end
+    end
+
+    describe "fail?" do
+      it "is false" do
+        expect(FailResponse.new('').fail?).to be_truthy
+      end
+    end
+  end
+
+  describe RetryResponse do
+    describe "success?" do
+      it "is false" do
+        expect(RetryResponse.new('').success?).to be_falsey
+      end
+    end
+
+    describe "retry?" do
+      it "is false" do
+        expect(RetryResponse.new('').retry?).to be_truthy
+      end
+    end
+
+    describe "fail?" do
+      it "is false" do
+        expect(RetryResponse.new('').fail?).to be_falsey
+      end
+    end
+  end
+end

data/spec/lib/ruby_mailman/subscription_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require_relative "../../../lib/ruby_mailman"
+
+Subscription = RubyMailman::Subscription
+
+describe Subscription do
+  describe "subscribe" do
+    let(:args) { {channel: 'test', listener: Object.new } }
+    let(:cs_mock) { double(CentralServiceInterface) }
+
+    before do
+      allow(cs_mock).to receive(:subscribe) { true }
+    end
+
+    it "implements the method" do
+      expect(Subscription.respond_to?(:subscribe)).to be_truthy
+    end
+
+    it "requires a channel" do
+      args.delete(:channel)
+      expect { Subscription.subscribe(args,cs_mock) }.to raise_error(ArgumentError)
+    end
+
+    it "requires a listener" do
+      args.delete(:listener)
+      expect { Subscription.subscribe(args,cs_mock) }.to raise_error(ArgumentError)
+    end
+
+    it "uses the Central Service Interface subscription method" do
+      expect(cs_mock).to receive(:subscribe).with(args[:channel], args[:listener])
+      Subscription.subscribe(args, cs_mock)
+    end
+
+    it "returns a Subscription instance" do
+      subscription_double = instance_double(Subscription)
+      expect(Subscription).to receive(:new) { subscription_double }
+      expect(Subscription.subscribe(args, cs_mock)).to eq(subscription_double)
+    end
+  end
+end

data/spec/lib/ruby_mailman/zmq_client_spec.rb

@@ -0,0 +1,88 @@
+require "spec_helper"
+require_relative "../../../lib/ruby_mailman"
+require_relative "../../zmq_servers/reply"
+require_relative "../../zmq_servers/publish"
+
+RSpec.describe ZMQClient do
+  describe "request" do
+    let (:request_client) { class_double(ZMQRequestClient) }
+    let (:action) { "action#{rand}" }
+    let (:object) { Object.new }
+
+    it "uses the provided client to make a request" do
+      expect(request_client).to receive(:run).with(action, object) { true }
+      ZMQClient.request(action, object, request_client)
+    end
+  end
+
+  describe "subscribe" do
+    let (:subscription_client) { class_double(ZMQSubscriptionClient) }
+    let (:channel) { "channel#{rand}" }
+    let (:listener) { Object.new }
+
+    it "uses the provided client to make a request" do
+      expect(subscription_client).to receive(:run).with(channel, listener) { true }
+      ZMQClient.subscribe(channel, listener, subscription_client)
+    end
+  end
+end
+
+RSpec.describe ZMQRequestClient do
+  describe "run" do
+    before(:example) do
+      reply_randomizer = rand
+      @server_configuration = {
+        port: 6666,
+        reply: -> {"reply #{reply_randomizer}"},
+        publish_delay: 0.03
+      }
+      @pid = TestServer::Reply.run_as_process(@server_configuration)
+      @test_delay = @server_configuration[:publish_delay] * 2
+      #wait so the publisher process can get rolling
+      sleep(@test_delay)
+     end
+
+    it "returns a reply" do
+      action = 'action'
+      object = 'object'
+      reply = ZMQRequestClient.run(action,object)
+      expect(reply).to eq(@server_configuration[:reply].call)
+    end
+
+    after(:example) do
+      Process.kill("KILL", @pid)
+    end
+  end
+end
+
+RSpec.describe ZMQSubscriptionClient do
+  describe "run" do
+    let (:message_builder) { class_double(RubyMailman::Subscription::Message) }
+    let (:message) { instance_double(RubyMailman::Subscription::Message) }
+
+    before(:example) do
+      @server_configuration = {
+        channel: "mychannel",
+        port: 6666,
+        message_parts: ["published message", rand(20).to_s],
+        publish_delay: 0.03
+      }
+      @pid = TestServer::Publish.run_as_process(@server_configuration)
+      @test_delay = @server_configuration[:publish_delay] * 2
+      #wait so the publisher process can get rolling
+      sleep(@test_delay)
+    end
+
+    it "Creates a Message and then calls the listener" do
+      listener = lambda{|channel, message| rand}
+      expect(message_builder).to receive(:new).at_least(:once).with(@server_configuration[:channel],@server_configuration[:message_parts]) { message }
+      expect(listener).to receive(:call).at_least(:once).with(@server_configuration[:channel], message)
+      ZMQSubscriptionClient.run(@server_configuration[:channel], listener, message_builder)
+      sleep(@test_delay)
+    end
+
+    after(:example) do
+      Process.kill("KILL", @pid)
+    end
+  end
+end

data/spec/models/auth.pb.rb

@@ -0,0 +1,24 @@
+##
+# This file is auto-generated. DO NOT EDIT!
+#
+require 'protobuf/message'
+
+module Interfaces
+
+  ##
+  # Message Classes
+  #
+  class Auth < ::Protobuf::Message; end
+
+
+  ##
+  # Message Fields
+  #
+  class Auth
+    optional :string, :email, 2
+    optional :string, :public_key, 3
+    optional :string, :private_key, 4
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "rspec/core"

data/spec/zmq_servers/publish.rb

@@ -0,0 +1,27 @@
+require 'ffi-rzmq'
+
+module TestServer
+  class Publish
+    def self.run_as_process(configuration)
+      Kernel.fork do
+
+        port = configuration[:port] || 6666
+        channel = configuration[:channel]
+        message_parts = configuration[:message_parts]
+        publish_delay = configuration[:publish_delay]
+
+        context = ZMQ::Context.new
+        publisher = context.socket(ZMQ::PUB)
+        publisher.setsockopt(ZMQ::LINGER,1)
+        publisher.bind("tcp://*:#{port}")
+
+        loop do
+          full_message = [message_parts[0].to_s, message_parts[1].to_s]
+          publisher.send_string(channel, ZMQ::SNDMORE)
+          publisher.send_strings(full_message)
+          sleep(publish_delay)
+        end
+      end
+    end
+  end
+end

data/spec/zmq_servers/reply.rb

@@ -0,0 +1,20 @@
+require 'ffi-rzmq'
+
+module TestServer
+  class Reply
+    def self.run_as_process(configuration)
+      port = configuration[:port] || '6666'
+      reply = configuration[:reply]
+      Kernel.fork do
+        context = ZMQ::Context.new
+        socket  = context.socket(ZMQ::REP)
+        socket.bind("tcp://*:#{port}")
+        loop do
+          request = []
+          socket.recv_strings(request)
+          socket.send_string(reply.call)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: ruby_mailman
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Ian Whitney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: ffi-rzmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby implementation of the Central Service interface. Meant for use with
+  UMN API Services written in Ruby.
+email:
+- whit0694@umn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_mailman.rb
+- lib/ruby_mailman/central_service_interface.rb
+- lib/ruby_mailman/mailman.rb
+- lib/ruby_mailman/response.rb
+- lib/ruby_mailman/subscription.rb
+- lib/ruby_mailman/subscription/message.rb
+- lib/ruby_mailman/version.rb
+- lib/ruby_mailman/zmq_client.rb
+- ruby_mailman.gemspec
+- spec/integration/request_spec.rb
+- spec/integration/subscribe_spec.rb
+- spec/lib/ruby_mailman/central_service_interface_spec.rb
+- spec/lib/ruby_mailman/mailman_spec.rb
+- spec/lib/ruby_mailman/response_spec.rb
+- spec/lib/ruby_mailman/subscription_spec.rb
+- spec/lib/ruby_mailman/zmq_client_spec.rb
+- spec/models/auth.pb.rb
+- spec/spec_helper.rb
+- spec/zmq_servers/publish.rb
+- spec/zmq_servers/reply.rb
+homepage: https://github.umn.edu/umnapi/ruby_mailman/
+licenses: []
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby library for connecting to Central Service
+test_files:
+- spec/integration/request_spec.rb
+- spec/integration/subscribe_spec.rb
+- spec/lib/ruby_mailman/central_service_interface_spec.rb
+- spec/lib/ruby_mailman/mailman_spec.rb
+- spec/lib/ruby_mailman/response_spec.rb
+- spec/lib/ruby_mailman/subscription_spec.rb
+- spec/lib/ruby_mailman/zmq_client_spec.rb
+- spec/models/auth.pb.rb
+- spec/spec_helper.rb
+- spec/zmq_servers/publish.rb
+- spec/zmq_servers/reply.rb