ezmq 0.1.1

data/ezmq.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'ezmq'
+  gem.version     = '0.1.1'
+  gem.licenses    = 'MIT'
+  gem.authors     = ['Chris Olstrom']
+  gem.email       = 'chris@olstrom.com'
+  gem.homepage    = 'https://github.com/colstrom/ezmq'
+  gem.summary     = 'Effortless ZMQ'
+  gem.description = 'Syntactic sugar around FFI bindings for ZMQ, to stop C from seeping into your Ruby.'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'ffi-rzmq', '~> 2.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'flog'
+  gem.add_development_dependency 'flay'
+  gem.add_development_dependency 'roodi'
+  gem.add_development_dependency 'reek'
+  gem.add_development_dependency 'churn'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'inch'
+end

data/lib/ezmq.rb

@@ -0,0 +1,227 @@
+require 'ffi-rzmq'
+
+# Syntactic sugar for 0MQ, because Ruby shouldn't feel like C.
+module EZMQ
+  # Wrapper class to simplify 0MQ sockets.
+  class Socket
+    attr_accessor :context, :socket, :encode, :decode
+
+    # Creates a 0MQ socket.
+    #
+    # @param [Symbol] mode the mode of the socket. `:bind` or `:connect`
+    # @param [Object] type the type of socket to use.
+    # @param [Hash] options optional parameters.
+    #
+    # @option options [ZMQ::Context] context a context to use for this socket
+    #   (one will be created if not provided).
+    # @option options [lambda] encode how to encode messages. Default unaltered.
+    # @option options [lambda] decode how to decode messages. Default unaltered.
+    # @option options [String] address specifies protocol, address and port (if
+    #   needed). Default is 'tcp://127.0.0.1:5555'
+    #
+    # @return [Socket] a new instance of Socket.
+    #
+    def initialize(mode, type, **options)
+      fail ArgumentError unless [:bind, :connect].include? mode
+      @context = options[:context] || ZMQ::Context.new
+      @socket = @context.socket type
+      @encode = options[:encode] || -> m { m }
+      @decode = options[:decode] || -> m { m }
+      method(mode).call address: options[:address] || 'tcp://127.0.0.1:5555'
+    end
+
+    # Receive a message from the socket.
+    #
+    # @note This method blocks until a message arrives.
+    #
+    # @param [lambda] decode how to decode the message.
+    #
+    # @return [void] the decoded message.
+    #
+    def receive(decode: @decode)
+      message = ''
+      @socket.recv_string message
+      decode.call message
+    end
+
+    # Sends a message on the socket.
+    #
+    # @note If `message` is not a String, `encode` must convert it to one.
+    #
+    # @param [String] message the message to send.
+    # @param [lambda] encode how to encode the message.
+    #
+    # @return [Fixnum] the size of the message.
+    #
+    def send(message = '', encode: @encode)
+      @socket.send_string encode.call message
+    end
+
+    # Binds the socket to the given address.
+    #
+    # @note 'localhost' does not always work as expected. Prefer '127.0.0.1'
+    #
+    # @param [String] address specifies protocol, address and port (if needed).
+    #   Default is 'tcp://127.0.0.1:5555'
+    #
+    # @return [Boolean] was binding successful?
+    #
+    def bind(address: 'tcp://127.0.0.1:5555')
+      @socket.bind(address) == 0 ? true : false
+    end
+
+    # Connects the socket to the given address.
+    #
+    # @param [String] address specifies protocol, address and port (if needed).
+    #   Default is 'tcp://127.0.0.1:5555'
+    #
+    # @return [Boolean] was connection successful?
+    #
+    def connect(address: 'tcp://127.0.0.1:5555')
+      @socket.connect(address) == 0 ? true : false
+    end
+  end
+
+  # Reply socket that listens for and replies to requests.
+  class Server < EZMQ::Socket
+    attr_accessor :provides
+
+    # Creates a new Server socket.
+    #
+    # @param [lambda] provides the service provided by this server.
+    # @param [Hash] options optional parameters
+    #
+    # @see EZMQ::Socket EZMQ::Socket for a list of optional parameters.
+    #
+    # @return [Server] a new instance of Server
+    #
+    def initialize(provides: -> m { m }, **options)
+      @provides = provides
+      super :bind, ZMQ::REP, options
+    end
+
+    # By default, waits to receive a message, calls @action with it, replies
+    # with the result, then loops.
+    #
+    # @param [lambda] handler how requests are handled.
+    #
+    # @return [void] the return from handler.
+    #
+    def listen(handler: -> { send @provides.call(receive) })
+      loop { handler.call }
+    end
+  end
+
+  # Request socket that sends messages and receives replies.
+  class Client < EZMQ::Socket
+    # Creates a new Client socket.
+    #
+    # @param [Hash] options optional parameters
+    #
+    # @see EZMQ::Socket EZMQ::Socket for a list of optional parameters.
+    #
+    # @return [Client] a new instance of Client.
+    #
+    def initialize(**options)
+      super :connect, ZMQ::REQ, options
+    end
+
+    # Sends a message and waits to receive a response.
+    #
+    # @param [String] message the message to send.
+    # @param [lambda] encode how to encode the message.
+    # @param [lambda] decode how to decode the message.
+    #
+    # @return [void] the decoded response message.
+    #
+    def request(message = '', encode: @encode, decode: @decode)
+      send message, encode: encode
+      receive decode: decode
+    end
+  end
+
+  # Publish socket that broadcasts messages with an optional topic.
+  class Publisher < EZMQ::Socket
+    # Creates a new Publisher socket.
+    #
+    # @param [Hash] options optional parameters
+    #
+    # @see EZMQ::Socket EZMQ::Socket for a list of optional parameters.
+    #
+    # @return [Publisher] a new instance of Publisher.
+    #
+    def initialize(**options)
+      super :bind, ZMQ::PUB, options
+    end
+
+    # Sends a message on the socket, with an optional topic.
+    #
+    # @param [String] message the message to send.
+    # @param [String] topic an optional topic for the message.
+    # @param [lambda] encode how to encode the message.
+    #
+    # @return [Fixnum] the size of the message.
+    #
+    def send(message = '', topic: '', encode: @encode)
+      @socket.send_string "#{ topic } #{ encode.call message }"
+    end
+  end
+
+  # Subscribe socket that listens for messages with an optional topic.
+  class Subscriber < EZMQ::Socket
+    attr_accessor :action
+
+    # Creates a new Subscriber socket.
+    #
+    # @param [lambda] action the action to perform when a message is received.
+    # @param [Hash] options optional parameters
+    #
+    # @option options [String] topic a topic to subscribe to.
+    #
+    # @see EZMQ::Socket EZMQ::Socket for a list of optional parameters.
+    #
+    # @return [Publisher] a new instance of Publisher.
+    #
+    def initialize(action: -> m { m }, **options)
+      @action = action
+      super :connect, ZMQ::SUB, options
+      subscribe options[:topic] if options[:topic]
+    end
+
+    # Establishes a new message filter on the socket.
+    #
+    # @note By default, a Subscriber filters all incoming messages. Without
+    # calling subscribe at least once, no messages will be accepted. If topic
+    # was provided, #initialize calls #subscribe automatically.
+    #
+    # @param [String] topic a topic to subscribe to. Messages matching this
+    # prefix will be accepted.
+    #
+    # @return [Boolean] was subscription successful?
+    #
+    def subscribe(topic)
+      @socket.setsockopt(ZMQ::SUBSCRIBE, topic) == 0 ? true : false
+    end
+
+    # Removes a message filter (as set with subscribe) from the socket.
+    #
+    # @param [String] topic the topic to unsubscribe from. If multiple filters
+    #   with the same topic are set, this will only remove one.
+    #
+    # @return [Boolean] was unsubscription successful?
+    #
+    def unsubscribe(topic)
+      @socket.setsockopt(ZMQ::UNSUBSCRIBE, topic) == 0 ? true : false
+    end
+
+    # By default, waits for a message and calls @action with the message.
+    #
+    # @param [lambda] handler how requests are handled.
+    #
+    # @return [void] the return from handler.
+    #
+    def listen(handler: -> { @action.call(receive) })
+      loop { handler.call }
+    end
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: ezmq
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chris Olstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi-rzmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rubocop
+  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: flog
+  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: flay
+  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: roodi
+  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: reek
+  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: churn
+  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: yard
+  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: inch
+  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: Syntactic sugar around FFI bindings for ZMQ, to stop C from seeping into
+  your Ruby.
+email: chris@olstrom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- doc/EZMQ.html
+- doc/EZMQ/Client.html
+- doc/EZMQ/Publisher.html
+- doc/EZMQ/Server.html
+- doc/EZMQ/Socket.html
+- doc/EZMQ/Subscriber.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- ezmq.gemspec
+- lib/ezmq.rb
+homepage: https://github.com/colstrom/ezmq
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Effortless ZMQ
+test_files: []
+has_rdoc: