mmonad 0.0.0.pre → 0.0.1.p2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 289e0bed47ec57709b0da562d947db420b6e5d44
-  data.tar.gz: 4b973ab60f7efcac727fc72d20f794db8797c7b1
+  metadata.gz: cb11907403ea9a8b1c443a69142b5aebe3439b5f
+  data.tar.gz: 625206acc0e8a2286e74b825e0d8b637ed549e94
 SHA512:
-  metadata.gz: 0b455fbf907d690d8a1858f43a7db4d87b5952ae58a7588ac713b40009c7434cf92248d7c899e498eeb93eb44b58ea4e139b95e3a38e7624dd623b02907936cf
-  data.tar.gz: da9187f248e9f83bf9f2a5ec7c14e6ba6081db593a5ea40c4a9bdd1d095257f5241aaa6fbb48131ad83a2688748d19570d5d7ea50dfa458997517e13116181cb
+  metadata.gz: 0f9eb8e439dd2f927c5add0b869c9386008b8e493b422df218e9bcf172339e98ff86d72196d068dc57c08d4f9937362c7351cf919e2a53102900a6c44363f4ec
+  data.tar.gz: cb385b6e5914a84954e67d634637bdaee863e368a773db838e0db0018fc2f7409885d49bb442fac5ed0a7281fa14c1b0d6a3c5fab8d2e47561aa69df69ff8669

data/README.md

@@ -0,0 +1,94 @@
+[![Gem Version](https://badge.fury.io/rb/mmonad.svg)](https://badge.fury.io/rb/mmonad)
+[![CircleCI](https://circleci.com/gh/Jared-Prime/mmonad.svg?style=svg)](https://circleci.com/gh/Jared-Prime/mmonad)
+
+# MMonad
+
+Messaging Monad, backed by 0MQ
+
+## Purpose
+
+`MMonad` provides a DSL for sending and receiving messages through 0MQ sockets.
+
+## Installation Requirements
+
+1. 0MQ
+  - `libzmq` ZeroMQ core engine in C++, implements ZMTP/3.0 https://github.com/zeromq/libzmq
+  - `czmq` High-level C binding for ØMQ https://github.com/zeromq/czmq
+2. Ruby
+  - `2.4.2` minimum supported. [`rbenv` is the recommended Ruby install tool](https://github.com/rbenv/rbenv#installation)
+3. Docker https://store.docker.com/search?offering=community&type=edition (optional, but highly recommended)
+
+Users with a Docker installation will find the first two requirements met by using the published image layer at https://hub.docker.com/r/jprime/mmonad
+
+## Contributions & Licensing
+
+User contributions are welcome and subject to the [CONTRIBUTING](https://github.com/Jared-Prime/mmonad/blob/master/CONTRIBUTING) guide. All code made available under [AGPL-3.0](https://github.com/Jared-Prime/mmonad/blob/master/LICENSE).
+
+## Project Specifications
+
+`MMonad` makes two interfaces available to Ruby programmers: (1) the `MMonad::Agent` and (2) the `MMonad::Client`. These interfaces are provided as modules. Users `extend` a class with the chosen interface, supplying specific behaviors via the DSL.
+
+DSL for _data-processing_ nodes:
+
+- `MMonad::Agent`
+  - `.socket` specifies underlying socket or address for networking
+  - `.pattern` specifies the 0MQ socket pattern for message delivery
+  - `.process` specifies the programmer's steps for message ingestion and/or transformation
+  - `.exceptions` specifies the programmer's custom error handling behavior
+  - `.run` initiates the data-processing loop with the above DSL specifications, blocking on the thread
+
+DSL for _data-passing_ nodes:
+
+- `MMonad::Client`
+  - `.endpoint` specifies the underlying socket or address for networking
+  - `.pattern` specifies the 0MQ socket pattern for message passing
+  - `.response` specifies the programmer's steps for response parsing
+  - `.timeout` specifies how long to wait on a socket for a response
+  - `.message` accepts a Hash to pass along the 0MQ socket as data
+
+The structure of the `Mmonad` DSL has been designed such that projects using the `gem` need only focus on their specific business logic, leaving all the generic 0MQ pattern implementation to this project. The examples below demonstrate how projects using `mmonad` focus on their own business logic.
+
+## Examples
+
+Each example below has a corresponding feature test. See the feature test directory for basic testing strategies. See the `MMonad::Pattern::LIBRARY` for currently supported patterns.
+
+### Synchronous Request / Reply
+
+```ruby
+class MyAgent
+  extend MMonad::Agent
+
+  socket 'tcp://0.0.0.0:5678'
+  pattern :reply
+
+  process do |message|
+    puts "got a message: #{message}"
+
+    { business_reply: "Business is great!" }
+  end
+
+  exceptions do |exception|
+    { business_reply: "This is not good for business: #{exception}" }
+  end
+end
+
+class MyClient
+  extend MMonad::Client
+
+  endpoint 'tcp://localhost:5678'
+  pattern :request
+
+  timeout 5 # seconds
+
+  response do |message|
+    puts "got a response: #{message}"
+  end
+end
+
+Thread.new { MyAgent.run }
+
+MyClient << { customer_message: "How is business?" }
+
+#=> got a message: { "customer_message" => "How is business?" }
+#=> got a response: { "business_reply" => "Business is great!" }
+```

data/lib/m_monad.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 require 'require_all'
-
-require_all './lib/m_monad'
-require_all './lib/version'
+require_all File.join(File.dirname(__FILE__))
 
 module MMonad
 end

data/lib/version.rb

@@ -3,14 +3,14 @@
 module MMonad
   MAJOR = 0
   MINOR = 0
-  PATCH = 0
-  RELEASE = 'pre'
+  PATCH = 1
+  RELEASE = 'p2'
 
   VERSION = [
     MAJOR,
     MINOR,
     PATCH,
-    RELEASE
+    RELEASE,
   ].join('.')
             .freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mmonad
 version: !ruby/object:Gem::Version
-  version: 0.0.0.pre
+  version: 0.0.1.p2
 platform: ruby
 authors:
 - Jared Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2017-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -129,6 +129,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - lib/m_monad.rb
 - lib/m_monad/agent.rb
 - lib/m_monad/client.rb
@@ -142,6 +143,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/m_monad
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="