https://github.com/ohler55/piper-ruby

A Ruby management client to push JSON to Piper Push Cache.
https://github.com/ohler55/piper-ruby

Last synced: 8 months ago
JSON representation

A Ruby management client to push JSON to Piper Push Cache.

• Host: GitHub
• URL: https://github.com/ohler55/piper-ruby
• Owner: ohler55
• License: mit
• Created: 2015-10-08T03:11:58.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-03-21T04:57:14.000Z (over 9 years ago)
• Last Synced: 2025-01-22T03:22:26.657Z (9 months ago)
• Language: Ruby
• Size: 11.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# piper-ruby

A Ruby management client to push JSON to [Piper Push Cache](http://www.piperpushcache.com/index.html).

[Piper Push Cache](http://www.piperpushcache.com/index.html). is a websocket

based push cache. A JSON cache is maintained that can be updated via a REST HTTP

API or through alternative means. This cache is pushed through websockets to

browsers using a class and object based subscription protocol that mirrors the

objects in the REST API. Piper is also a simple web server.

Piper Push Ruby is a thin client that can be used to push JSON to

[Piper](http://www.piperpushcache.com/index.html). Raw JSON can be pushed to

Piper or Ruby Objects can be pushed and [Oj](http://www.ohler.com/oj) will be

used to convert those Objects into JSON using the compat mode.

Piper Push Cache has special support for log messages. This gem provides methods

for sending those log messages to Piper.

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.1 - March 20, 2016

 - Added rescue for Interrupt to avoid error message on shutdown with control C.

### 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.

### Release 1.1.1 - November 13, 2015

 - Corrected default log location to be the caller instead of the log class file.

### Release 1.1.0 - November 12, 2015

 - Added support for publishing to Piper.

 - Added support for sending log records to Piper.

### Release 1.0.0 - October 8, 2015

 - Initial release