piper-ruby 1.1.2 → 1.2.0

data/README.md

@@ -20,8 +20,16 @@ This Piper client support publishing on [NATS](http://nats.io) as a means of
 delivery if the NATS gem is installed. A flag is also provided to control which
 method is used to deliver log messages to Piper.
 
+The Piper::Actor module provides methods for receiving and responding to
+JSON messages from tasks in the Piper process flows. The test/simple_actor.rb provides
+an example of how to use the Piper::Actor module functions.
+
 ## Release Notes
 
+### Release 1.2.0 - March 20, 2016
+
+ - Added the Piper::Actor module to support the Piper Push Cache process flows.
+
 ### Release 1.1.2 - December 9, 2015
 
  - Removed an extranious 'z' character in the where field.

data/lib/piper.rb

@@ -5,3 +5,4 @@ end # Piper
 require 'piper/version'
 require 'piper/manager'
 require 'piper/logrec'
+require 'piper/actor'

data/lib/piper/actor.rb

@@ -0,0 +1,40 @@
+
+require 'oj'
+
+module Piper
+
+  # Piper::Actor module provides a shell for a spawned Piper Push Cache task
+  # actor. Piper Push Cache supports process flows where the individual tasks in
+  # a flow can be implemented as a separate application that is spawned when it
+  # is needed. The spawned application is expected to continue to run and accept
+  # input on stdin. Output is over stdout. Both the input and output are JSON
+  # strings. This module takes care of the parsing and serialization.
+  #
+  # The JSON format for input is a JSON object with an 'id' field and a 'rec'
+  # field. The output expected is an 'id' field, 'rec' field, and a 'link' field
+  # that identifies the link to follow.
+  module Actor
+
+    # Starts a JSON processing loop that reads from $stdin. The proc provided
+    # with the call should call ship() to continue on with the processing.
+    def self.process()
+      Oj::load($stdin, :mode => :strict) { |json|
+        begin
+          id = json['id']
+          rec = json['rec']
+          yield(id, rec)
+        rescue Exception => e
+          ship(id, { 'kind' => 'Error', 'message' => e.message, 'class' => e.class.to_s }, 'error')
+        end
+      }
+    end
+
+    # Ships or sends a response to the calling task in the Piper Flow.
+    def self.ship(id, rec, link)
+      $stdout.puts Oj::dump({ 'id' => id, 'rec' => rec, 'link' => link }, :mode => :strict )
+      $stdout.flush()
+    end
+
+  end # Actor
+end # Piper
+

data/lib/piper/version.rb

@@ -1,4 +1,4 @@
 module Piper
   # Current version of the module. 
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

data/test/simple_actor.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+$VERBOSE = true
+
+$: << File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'lib')
+
+require 'piper'
+require 'oj'
+
+# Try executing this file and then typing in the string to the console
+#
+# {"id":"abc","rec":{"kind":"Test", "num":3}}
+#
+# The following should appear on stderr which is used for debugging.
+#
+# received - id: {id} rec: {"kind"=>"Test", "num"=>3, "link"=>"foo"}
+#
+# The response JSON should appear on stdout as:
+#
+# {"id":"abc","rec":{"kind":"Test","num":3,"link":"foo","wall":["I was here."]},"link":"foo"}
+#
+Piper::Actor::process() { |id,rec|
+  $stderr.puts "received - id: {id} rec: #{rec}"
+  
+  rec['wall'] = [] if rec['wall'].nil?
+  rec['wall'] << "I was here."
+
+  Piper::Actor::ship(id, rec, rec['link'])
+}

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: piper-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2016-03-20 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby management client to push JSON to Piper Push Cache.
 email: peter@ohler.com
@@ -17,38 +18,40 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- LICENSE
-- README.md
-- lib/piper.rb
+- lib/piper/actor.rb
 - lib/piper/logrec.rb
 - lib/piper/manager.rb
 - lib/piper/version.rb
+- lib/piper.rb
 - test/pipe_test.rb
+- test/simple_actor.rb
+- LICENSE
+- README.md
 homepage: http://www.piperpushcache.com
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options:
-- "--main"
+- --main
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: piper-ruby
-rubygems_version: 2.4.5
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Management client for Piper Push Cache.
 test_files: []
-has_rdoc: true

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 157dbe77d354d635b57c0de330bf66b95a05824e
-  data.tar.gz: a9a6eba3c8fa827971e4e0822abef32e0267f21b
-SHA512:
-  metadata.gz: c19e72eaa0ec4eb3f8802910406b0b43a8f9f3a3353e43a73611635b6cb223c4085de1b4797edbff7319ab7d69ea94ff71840db83393edd26b313fb875724843
-  data.tar.gz: 77fa60d4c01db4ec8bc5858edd211deace1499d1ac27cf91608a0293c435f67c9ecefa4c224b786859e4cec27ba9d7a98bdacc65d3b3869ca33e7fb18dd58d10