zero-moo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0bab789674475cb28264d22f2a00921e0c67357
+  data.tar.gz: 9c8bb11d05b8b355c666a5021546671aeac77075
+SHA512:
+  metadata.gz: 81ac54f2f9ccf32ad7d46b36624ed52b25ad41e855e0fa42281851ebf6667bfa614af8885f53cef9d99837eee60cd674d71999b4d401ff3750984b84dd3ea7ed
+  data.tar.gz: 32a28e22a66cad1ef50b7aa2679c75f6bf3b86fdc358d0172e2385709dadd57ac08b827fba63964bc5ff863447718fcc651e4babadcd23c4992778cc41b78572

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'pry'
+gem 'ffi-rzmq-core', path: "/tmp/ffi-rzmq-core"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tim Förster
+
+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,53 @@
+# Zero::Moo
+
+An easy to use publisher - subscriber communication util.
+
+*It is currently hard under development. 
+There is no recovery after server restart* 
+
+Unit tests will also follow.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zero-moo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zero-moo
+
+## Usage
+
+**Add a subscriber: **
+
+```ruby
+ require 'zero/moo/subscriber'
+ s = Zero::Moo::Subscriber address: '127.0.0.1:64000'
+ s.on_receive{|message| puts message}
+```
+
+**Add a publisher: **
+
+```ruby
+ require 'zero/moo/publisher'
+ p = Zero::Moo::Publisher address: '127.0.0.1:64000'
+ p.push! "moo"
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/timmyArch/zero-moo.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zero/moo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zero/moo.rb

@@ -0,0 +1,11 @@
+require "zero/moo/version"
+require "zero/moo/logger"
+require 'ffi-rzmq'
+
+module Zero
+  module Moo
+
+    class Error < StandardError; end
+
+  end
+end

data/lib/zero/moo/communicator.rb

@@ -0,0 +1,79 @@
+require 'zero/moo'
+require 'ffi-rzmq'
+
+Thread.abort_on_exception
+
+module Zero
+  module Moo
+
+    class Communicator
+
+      class Error < Zero::Moo::Error; end
+      class ContextError < Error; end
+      class ArgumentError < Error; end
+
+      attr_reader :context
+
+      ##
+      # Instanziate ZeroMQ context.
+      #
+      # @params type [Fixnum] ZMQ::Context type
+      #
+      def initialize type: ZMQ::REQ
+        logger.debug "Creating ZMQ::Context type: #{type.inspect}"
+        @context = ZMQ::Context.create(type)
+        raise ContextError, "Zmq context couldn't created." unless @context
+        logger.debug "Add finalizer for context termination."
+        ObjectSpace.define_finalizer(self, 
+                                     proc{self.context.terminate if self.context})
+      end
+
+      protected
+
+      ##
+      # Get logger instance.
+      #
+      # @return [Zero::Moo::Logger]
+      #
+      def logger
+        unless @logger
+          @logger = Logger.dup
+          @logger.instance_variable_set(:@progname, 
+                                        "#{self.class.name} ##{self.__id__}")
+        end
+        @logger
+      end
+
+      ##
+      # Checking return codes.
+      #
+      # @param rc [Fixnum] Return code
+      # @params raize [Class]
+      #
+      # @return [TrueClass, FalseClass] 
+      #   If true, an error has ocoured.
+      #
+      def error?(rc, raize: nil)
+        if raize and raize.is_a?(Class) and 
+          not raize.ancestors.include?(StandardError)
+          raise ArgumentError, ":raize must contain a raisable class"
+        end
+        logger.debug "Checking error code ..."
+        if ZMQ::Util.resultcode_ok?(rc)
+          false
+        else
+          err = <<-ERR.split.join(' ') 
+            Operation failed, errno [#{ZMQ::Util.errno}] 
+            description [#{ZMQ::Util.error_string}]
+          ERR
+          logger.error err
+          caller(1).each { |callstack| logger.error(callstack) }
+          raise raize, err if raize
+          true
+        end
+      end
+
+    end
+
+  end
+end

data/lib/zero/moo/logger.rb

@@ -0,0 +1,10 @@
+require 'syslog/logger'
+
+module Zero
+  module Moo
+
+    #Logger = Syslog::Logger.new("Zero::Moo")
+    Logger = Logger.new(STDOUT)
+
+  end
+end

data/lib/zero/moo/publisher.rb

@@ -0,0 +1,107 @@
+require 'zero/moo/communicator'
+
+module Zero
+  module Moo
+
+    class Publisher < Communicator
+
+      class Error < Communicator::Error; end
+      class MissingAddressError < Error; end
+      class InvalidAddressError < Error; end
+      class SocketOptionError < Error; end
+      class SocketShutdownError < Error; end
+      class MessageError < Error; end
+      class BindError < Error; end
+
+      attr_reader :address, :thread, :socket
+      private :thread, :socket
+
+      ##
+      # Get publishing instance.
+      #
+      # @param address [String]
+      #
+      def initialize **kwargs
+        @address = kwargs.delete(:address)
+        kwargs[:type] = 1 
+        raise MissingAddressError, 
+          ":address for bind was not given" unless @address
+        validate_address
+        validate_port
+        super **kwargs
+      end
+     
+      ##
+      # Push a message to all subscribers.
+      #
+      def push! message
+        bind! unless socket
+        error? socket.send_string(message), raize: MessageError
+        message
+      end
+      
+      private
+
+      ##
+      # Bind publisher to address.
+      #
+      # @return [void] 
+      #
+      def bind!
+        @socket = context.socket(ZMQ::PUSH)
+        error? @socket.setsockopt(ZMQ::LINGER, 1), raize: SocketOptionError
+        error? @socket.bind("tcp://#{address}"), raize: BindError
+      end
+
+
+      ##
+      # Closing the publisher socket.
+      #
+      # @return [void]
+      #
+      def stop!
+        if socket.respond_to? :close
+          error? socket.close, raize: SocketShutdownError
+        end
+        if thread.instance_of? Thread
+          thread.kill
+        end
+        @thread = nil
+      end
+
+      protected
+
+      ##
+      # Validating Address/Host part of given address.
+      #
+      # @return [void]
+      #
+      def validate_address
+        logger.debug "Validating address: #{@address.inspect}"
+        address = @address.to_s[/[^:]+/]
+        ip = IPAddr.new(address) rescue nil
+        Socket.gethostbyname(address) unless ip 
+      rescue SocketError => e
+        raise InvalidAddressError, 
+          "Address: #{@address.inspect} is invalid. - #{e.message}"
+      end
+
+      ##
+      # Validating port section in @address
+      #
+      # @return [void]
+      #
+      def validate_port
+        logger.debug "Validating port: #{@address.inspect}"
+        port = @address.to_s[/[^:]+$/].to_s[/\d+/]
+        raise InvalidAddressError, "Missing port in #{address}" if port.nil?
+        unless (1024..65535).include? port.to_i
+          raise InvalidAddressError, 
+            "Out of range. Port must be between 1024 and 65535"
+        end
+      end
+
+    end
+  
+  end
+end

data/lib/zero/moo/subscriber.rb

@@ -0,0 +1,75 @@
+require 'zero/moo/publisher'
+
+module Zero
+  module Moo
+
+    class Subscriber < Publisher
+
+      class Error < Communicator::Error; end
+      class MissingAddressError < Error; end
+      class InvalidAddressError < Error; end
+      class SocketOptionError < Error; end
+      class SocketShutdownError < Error; end
+      class MessageError < Error; end
+      class ConnectError < Error; end
+
+      undef :bind!
+      undef :push!
+
+      attr_reader :receivers
+      private :receivers, :stop!
+
+      ##
+      # Add callbacks. The block will called with one 
+      # argument. The message.
+      #
+      # @yield [message]
+      # @yieldparam message [String]
+      #
+      # @return [void]
+      #
+      def on_receive &block
+        listen! unless thread.instance_of? Thread
+        unless @receivers 
+          ObjectSpace.define_finalizer(self, proc{ stop! })
+        end
+        @receivers ||= []
+        @receivers << block
+      end
+
+      private
+
+      ##
+      # Bind listener.
+      #
+      # @return [void]
+      #
+      def listen!
+        @thread = Thread.new do
+          @socket = context.socket(ZMQ::PULL)
+          error? socket.setsockopt(ZMQ::LINGER, 1), raize: SocketOptionError
+          error? socket.connect("tcp://#{address}"), raize: ConnectError
+          loop do
+            message = ''
+            error? socket.recv_string(message), raize: MessageError
+            handle_callbacks message
+          end
+        end
+      end
+
+      ##
+      # Iterate over all callbacks and 
+      # call them with given message.
+      #
+      # @return [void]
+      #
+      def handle_callbacks message
+        receivers.to_a.each do |block|
+          block.call message
+        end
+      end
+
+    end
+
+  end
+end

data/lib/zero/moo/version.rb

@@ -0,0 +1,5 @@
+module Zero
+  module Moo
+    VERSION = "0.1.0"
+  end
+end

data/zero-moo.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zero/moo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zero-moo"
+  spec.version       = Zero::Moo::VERSION
+  spec.authors       = ["Tim Förster"]
+  spec.email         = ["github@mailserver.1n3t.de"]
+
+  spec.summary       = %q{ZMQ based communication util}
+  spec.homepage      = "https://github.com/timmyArch/zero-moo"
+  spec.license       = "MIT"
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  
+  spec.add_dependency "ffi-rzmq", '2.0.4'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: zero-moo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Förster
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+description: 
+email:
+- github@mailserver.1n3t.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zero/moo.rb
+- lib/zero/moo/communicator.rb
+- lib/zero/moo/logger.rb
+- lib/zero/moo/publisher.rb
+- lib/zero/moo/subscriber.rb
+- lib/zero/moo/version.rb
+- zero-moo.gemspec
+homepage: https://github.com/timmyArch/zero-moo
+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.4.5
+signing_key: 
+specification_version: 4
+summary: ZMQ based communication util
+test_files: []