deployable-zmq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b38da49f52f8b88d57529eb15df09ef2460506e
+  data.tar.gz: f55835752a470568a9667cbd5e745adfb6b4e2ff
+SHA512:
+  metadata.gz: 64651d4e901506a85879df9884700c25fb4944b2bf0551a975c367c53fb50626e532b48d8001bc7570a0546436b9e5e1ff501e43f112f6aaccde5b0a28ff0298
+  data.tar.gz: d7868d05fdbae14a99bb9eaf9c1d8e3bb147ba464a7f20446d04b63c325aca47dec99925a5f8d6c5c9125649e3db2bd0dfed29069697aa6c0610e338638e1d50

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+doc/
+pkg/
+.svn/
+.gems/
+.bundle/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "deployable-zmq Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2014-10-21
+
+* Initial release:
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Deployable Ltd Matt Hoyle
+
+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,27 @@
+# deployable-zmq
+
+* [Homepage](https://rubygems.org/gems/deployable-zmq)
+* [Documentation](http://rubydoc.info/gems/deployable-zmq/frames)
+* [Email](mailto:code at deployable.co)
+
+## Description
+
+TODO: Description
+
+## Features
+
+## Examples
+
+    require 'deployable/zmq'
+
+## Requirements
+
+## Install
+
+    $ gem install deployable-zmq
+
+## Copyright
+
+Copyright (c) 2014 Deployable Ltd Matt Hoyle
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
+end
+
+begin
+  gem 'rspec', '~> 3.1'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.8'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard

data/deployable-zmq.gemspec

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'deployable/zmq/version'
+                  Deployable::Zmq::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/gemspec.yml

@@ -0,0 +1,16 @@
+name: deployable-zmq
+summary: "ZMQ helper classes"
+description: "Standard ZMQ Pattern classes"
+license: MIT
+authors: Deployable Ltd Matt Hoyle
+email: code@deployable.co
+homepage: https://rubygems.org/gems/deployable-zmq
+
+dependencies:
+  deployable-patch: ~> 0.3
+  ffi-rzmq: ~> 2.0.1
+
+development_dependencies:
+  rspec: ~> 3.1
+  rubygems-tasks: ~> 0.2
+  yard: ~> 0.8

data/lib/deployable/zmq/defaults.rb

@@ -0,0 +1,12 @@
+require 'deployable/zmq/version'
+
+# Some defaults to be used about the place
+
+module Deployable; module Zmq
+  
+  DEFAULT_BIND_PORT       = 5563
+  DEFAULT_BIND_ADDRESS    = '*'
+  DEFAULT_CONNECT_ADDRESS = 'localhost'
+
+end; end
+

data/lib/deployable/zmq/publish.rb

@@ -0,0 +1,72 @@
+require 'deployable/zmq/version'
+require 'deployable/zmq/defaults'
+require 'deployable/patch/instance_class_variables'
+
+require 'ffi-rzmq'
+require 'json'
+
+
+module Deployable; module Zmq
+
+# Deployable::Zmq provides a generic set of helpers do you
+# don't have to do so much leg work. 
+
+class Publish
+
+  @port    = DEFAULT_BIND_PORT
+  @address = DEFAULT_BIND_ADDRESS
+
+  def initialize options = {}
+
+    @context   = ZMQ::Context.new
+    @publisher = @context.socket ZMQ::PUB
+
+    @port      = options.fetch :port, __class_ivg( 'port' )
+    @port      = DEFAULT_BIND_PORT if @port.nil?
+
+    @address   = options.fetch :address, __class_ivg( 'address' )
+    @address   = DEFAULT_BIND_ADDRESS if @address.nil?
+
+    uri = "tcp://#{@address}:#{@port}"
+    
+    unless rc = @publisher.bind( uri ) == 0
+      raise "zmq bind failed [#{rc}] [#{uri}]" 
+    end
+
+    #log.debug "zmq publishing on [#{uri}]"
+  end
+
+  # String a simple string
+  def send_string label, message
+    @publisher.send_string label, ZMQ::SNDMORE
+    @publisher.send_string message
+  end
+
+  # Send an array of messages
+  def send_arr label, array
+    @publisher.send_string label, ZMQ::SNDMORE
+
+    # Everything but the last element
+    array[0..-2].each do |e|
+      @publisher.send_string e.to_s, ZMQ::SNDMORE
+    end
+    @publisher.send_string array.last.to_s
+  end
+
+  # Send an object in json
+  def send_json label, obj
+    # parse before send in case of issues
+    message = obj.to_json
+    @publisher.send_string label, ZMQ::SNDMORE
+    @publisher.send_string message
+  end
+
+  # End the connection
+  def end
+    @publisher.close
+  end
+  
+end
+
+
+end;end;

data/lib/deployable/zmq/pubsub.rb

@@ -0,0 +1,3 @@
+require 'deployable/zmq/version'
+require 'deployable/zmq/publish'
+require 'deployable/zmq/subscribe'

data/lib/deployable/zmq/subscribe.rb

@@ -0,0 +1,66 @@
+require 'deployable/zmq/version'
+require 'deployable/zmq/defaults'
+require 'deployable/patch/instance_class_variables'
+
+require 'ffi-rzmq'
+require 'json'
+
+
+module Deployable; module Zmq
+
+# Deployable::Zmq provides a generic set of helpers do you
+# don't have to do so much leg work. 
+
+class Subscribe
+
+  @port    = DEFAULT_BIND_PORT
+  @address = DEFAULT_CONNECT_ADDRESS
+  
+  def initialize options = {}
+    @context    = ZMQ::Context.new
+    @subscriber = @context.socket ZMQ::SUB
+
+    @port       = options.fetch :port, __class_ivg('port')
+    @port       = DEFAULT_BIND_PORT if @port.nil?
+
+    @address    = options.fetch :options, __class_ivg('address')
+    raise "No valid address [#{@address}]" if @address.nil? or @address == '*'
+
+    url = "tcp://#{@address}:#{@port}"
+
+    raise "Failed to connect to [#{url}] [#{rc}]" unless
+      rc = @subscriber.connect( url ) == 0 
+
+    #log.debug "zmq subscribing to [#{url}]"
+
+    @subscribe = options.fetch( :subscribe, nil )
+    
+    raise "Failed to subscribe to [#{url}] [#{rc}]" unless
+      @subscribe.nil? or 
+      rc = @subscriber.setsockopt( ZMQ::SUBSCRIBE, 'REQ_COMP' ) == 0 
+
+  end
+
+  # Recieve a message off the queue
+  def receive
+    @subscriber.recv_strings( parts = [] )
+    #log.debug "a queue item [%s]\n", parts.join(' ')
+    parts
+  end
+
+  # Watch a queue for messages
+  def go callback
+    loop do
+      callback.call receive
+    end
+  end
+
+  # End a subscription
+  def end
+    @subscriber.close
+  end
+  
+end
+
+
+end;end

data/lib/deployable/zmq/version.rb

@@ -0,0 +1,6 @@
+module Deployable
+  module Zmq
+    # deployable-zmq version
+    VERSION = "0.1.0"
+  end
+end

data/lib/deployable/zmq.rb

@@ -0,0 +1,8 @@
+require 'deployable/zmq/version'
+
+module Deployable; module Zmq
+  
+
+end; end
+
+

data/spec/publish_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'deployable/zmq/publish'
+
+describe Deployable::Zmq::Publish do
+
+
+  it "should have a VERSION constant" do
+    expect( Module.const_get('VERSION') ).to_not be_empty
+  end
+
+
+  describe "binds" do
+
+    it "binds a new connection" do
+      @connection = Deployable::Zmq::Publish.new
+    end 
+
+    it "binds a new connection on a port" do
+      @connection = Deployable::Zmq::Publish.new( port: 5123 )
+    end
+
+    it "binds a new connection to an address" do
+      @connection = Deployable::Zmq::Publish.new( address: '127.0.0.1' )
+    end
+
+    it "binds a new connection to an address and port" do
+      @connection = Deployable::Zmq::Publish.new( port: 5123, address: '127.0.0.1' )
+    end
+
+    after :each do
+      @connection.end if @connection
+    end
+
+  end
+
+
+  describe "sends" do
+    
+    before :each do
+      @connection = Deployable::Zmq::Publish.new
+    end
+
+    after :each do
+      @connection.end if @connection
+    end
+
+    it "sends a string" do
+      @connection.send_string "label", 'something'
+    end
+
+    it "sends array of string" do
+      @connection.send_arr "label", ['1','2','3']
+    end
+
+    it "sends arrays of non strings" do
+      @connection.send_arr "label", [1,2,3]
+    end
+
+    it "sends json" do
+      @connection.send_json "label", { sometthing: 2 }
+    end
+
+  end
+  
+
+end

data/spec/pubsub_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'deployable/zmq/pubsub'
+
+describe 'Deployable::Zmq pubsub' do
+
+  it "should have a VERSION constant" do
+    expect( Module.const_get('VERSION') ).to_not be_empty
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+gem 'rspec', '~> 3.1'
+require 'rspec'
+require 'deployable/zmq/version'
+
+include Deployable::Zmq

data/spec/subscribe_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'deployable/zmq/subscribe'
+
+describe Deployable::Zmq::Subscribe do
+
+
+  it "should have a VERSION constant" do
+    expect( Module.const_get('VERSION') ).to_not be_empty
+  end
+
+
+  describe "connects" do
+
+  end
+
+
+  describe "recieves" do
+
+  end
+
+
+end

data/spec/zmq_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'deployable/zmq'
+
+describe Deployable::Zmq do
+  it "should have a VERSION constant" do
+    expect( Module.const_get('VERSION') ).to_not be_empty
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: deployable-zmq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Deployable Ltd Matt Hoyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deployable-patch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Standard ZMQ Pattern classes
+email: code@deployable.co
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- deployable-zmq.gemspec
+- gemspec.yml
+- lib/deployable/zmq.rb
+- lib/deployable/zmq/defaults.rb
+- lib/deployable/zmq/publish.rb
+- lib/deployable/zmq/pubsub.rb
+- lib/deployable/zmq/subscribe.rb
+- lib/deployable/zmq/version.rb
+- spec/publish_spec.rb
+- spec/pubsub_spec.rb
+- spec/spec_helper.rb
+- spec/subscribe_spec.rb
+- spec/zmq_spec.rb
+homepage: https://rubygems.org/gems/deployable-zmq
+licenses:
+- MIT
+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: ZMQ helper classes
+test_files: []
+has_rdoc: