piper-ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfc1c00fe2695fa0f233af913096fedc63e00fe5
-  data.tar.gz: 0a218f8cc28a0019383d2aa7e7a8525bf20ed539
+  metadata.gz: 331d325f2fb2468aef24b9ccea3fd8de4a7b0b2a
+  data.tar.gz: 4c6af26939954d8055f64b487239184b6d4008e1
 SHA512:
-  metadata.gz: 12aa9c159a8b4d6aef85db5b6c08124b5c8a073af68ba7ef3b960d1db0838ceae2ccd4553d1162faadccb0512696d313524b74378e85296b7dbf983a3862876a
-  data.tar.gz: 931b9df08582a5f6b3cdfc7259f12d7b46b170b36c9ae138b3cf9d33aafc876f44732f8ecd6c773078224731344de3086da6b07d3e78c1d2d9b1a49ef91068fb
+  metadata.gz: 00a0790054bba47fe7c9d804757e713fea1f72cef35330e4440956a642232b55a99899773f1c886635ee096597f15bf836f85d0cb50dfa5b23c0752447adca36
+  data.tar.gz: 50bd81cafe0874446d3ffc618e91235a640c0ac3923a6f39fa983bc15aae6f3fb97d12facb8aee4ceac6677026186012256e881870fa4410f854cbeff83aa347

data/README.md

@@ -1,4 +1,5 @@
 # piper-push-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
@@ -11,3 +12,25 @@ 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.
+
+## Release Notes
+
+### 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
+
+
+

data/lib/piper.rb

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

data/lib/piper/logrec.rb

@@ -0,0 +1,58 @@
+
+require 'oj'
+
+module Piper
+
+  # Piper::LogRec is a class for creating JSON log records for Piper Push Cache
+  # server.
+  class LogRec
+    @@level_map = {
+      'fatal' => 0,
+      'error' => 1,
+      'warn' => 2,
+      'info' => 3,
+      'debug' => 4,
+      :fatal => 0,
+      :error => 1,
+      :warn => 2,
+      :info => 3,
+      :debug => 4,
+    }
+    @@who = File.basename($PROGRAM_NAME)
+
+    def self.who()
+      return @@who
+    end
+    attr_reader :kind
+    attr_accessor :when
+    attr_accessor :who
+    attr_accessor :where
+    attr_accessor :what
+    attr_accessor :tid
+
+    def initialize(level, what, tid=nil, where=nil)
+      @kind = 'Log'
+      if level.is_a?(Integer)
+        @level = level
+      else
+        @level = @@level_map[level]
+      end
+      @who = @@who
+      if where.nil?
+        @where = "#{File.basename(__FILE__)}:#{__LINE__}"
+      else
+        @where = where
+      end
+      @what = what
+      @when = Time.now
+      @when.gmtime unless @when.gmt?
+      @tid = tid
+    end
+
+    def to_s()
+      Oj.dump(self, :mode => :compat, :time_format => :unix)
+    end
+
+  end # LogRec
+
+end # Piper

data/lib/piper/manager.rb

@@ -2,6 +2,11 @@
 require 'net/http'
 require 'oj'
 
+begin
+  require 'nats/client'
+rescue Exception
+end
+
 module Piper
 
   # Piper::Manager is a simple class that is used to manage cached content in a
@@ -14,6 +19,9 @@ module Piper
     def initialize(host, port)
       @host = host
       @port = port
+      @prev_log_rid = nil
+      @nats_url = nil
+      @subject = nil
     end
 
     # Pushes JSON to Piper and associates it with the provided record
@@ -52,6 +60,95 @@ module Piper
       h.send_request('GET', "/#{rid}")
     end
 
+    # Sets up NATS. A connection is not made until a log entry is made or a
+    # publish is made. The subject should provided will be the prefix for
+    # published records and for log messages. Log messages are published on
+    # <subject>.log
+    # @param [String] url URL to connect to NATS server e.g., nats://localhost:4222
+    # @param [String] subject subkect prefix
+    def nats_init(url, subject)
+      if (defined? NATS)
+        @nats_url = url
+        @nats_url = 'nats://localhost:4222' if url.nil?
+        @subject = subject
+      else
+        raise Exception.new("NATS gem not installed.")
+      end
+    end
+
+    # Publishs a JSON message using a NATS client.
+    # @param [String] rid record identifier for the published record
+    # @param [Object] object Object to convert to JSON before storing
+    def publish(rid, obj)
+      NATS.start(:uri => uri) { NATS.publish("#{@subject}.#{rid}", Oj::dump(obj, mode: :compat)) { NATS.stop } }
+    end
+
+    # Publishs a JSON message using a NATS client.
+    # @param [String] rid record identifier for the published record
+    # @param [String] json json to publish to Piper
+    def publish_json(rid, json)
+      NATS.start(:uri => uri) { NATS.publish("#{@subject}.#{rid}", json) { NATS.stop } }
+    end
+
+    # Send a log entry to Piper either by a publish over NATS or by a HTTP PUT.
+    # @param [Integer|String|Symbol] level severity level (e.g., 1, "error", or :error)
+    # @param [String] what reason or contents of the record
+    # @param [String] tid tracking identifier if any
+    # @param [String] where where the log even was created, default is <file>:<line>
+    # @param [String] the record identifier of the created log record.
+    def log(level, what, tid=nil, where=nil)
+      rec = LogRec.new(level, what, tid, where)
+      rid_num = rec.when.strftime('%Y%m%d%H%M%S%N').to_i
+      rid_num = @prev_log_rid + 1 if !@prev_log_rid.nil? && @prev_log_rid >= rid_num
+      rid = "#{LogRec.who}-#{rid_num}"
+      if @subject.nil?
+        push_json(rid, rec.to_s)
+      else
+        NATS.start(:uri => uri) { NATS.publish("#{@subject}.#{rid}", rec.to_s) { NATS.stop } }
+      end
+      rid
+    end
+
+    # Put or publish a fatal log record.
+    # @param [String] what reason or contents of the record
+    # @param [String] tid tracking identifier if any
+    # @param [String] the record identifier of the created log record.
+    def fatal(what, tid=nil)
+      log(:fatal, what, tid)
+    end
+
+    # Put or publish a error log record.
+    # @param [String] what reason or contents of the record
+    # @param [String] tid tracking identifier if any
+    # @param [String] the record identifier of the created log record.
+    def error(what, tid=nil)
+      log(:error, what, tid)
+    end
+
+    # Put or publish a warning log record.
+    # @param [String] what reason or contents of the record
+    # @param [String] tid tracking identifier if any
+    # @param [String] the record identifier of the created log record.
+    def warn(what, tid=nil)
+      log(:warn, what, tid)
+    end
+
+    # Put or publish a info log record.
+    # @param [String] what reason or contents of the record
+    # @param [String] tid tracking identifier if any
+    # @param [String] the record identifier of the created log record.
+    def info(what, tid=nil)
+      log(:info, what, tid)
+    end
+
+    # Put or publish a debug log record.
+    # @param [String] what reason or contents of the record
+    # @param [String] tid tracking identifier if any
+    # @param [String] the record identifier of the created log record.
+    def debug(what, tid=nil)
+      log(:debug, what, tid)
+    end
+
   end # Manager
 
 end # Piper

data/lib/piper/version.rb

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

data/test/pipe_test.rb

@@ -8,6 +8,7 @@ $: << File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'lib')
 require 'minitest'
 require 'minitest/autorun'
 require 'piper'
+require 'oj'
 
 $verbose = true
 
@@ -53,6 +54,15 @@ class PipeTest < Minitest::Test
     puts " GET /#{iron['id']} response: #{resp.code} - #{resp.body}" if $verbose
     assert_equal(404, resp.code.to_i, 'expected a 404 when getting iron after delete')
     
+    puts man.log(2, "what happens?")
+    resp = man.get('foobar')
+    puts " GET /foobar response: #{resp.code} - #{resp.body}"
+
+    rid = man.info("Done with test.")
+    resp = man.get(rid);
+    puts " GET /#{rid} response: #{resp.code} - #{resp.body}" if $verbose
+    assert_equal(202, resp.code.to_i, 'expected a 202 when getting #{rid} after logging')
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piper-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby management client to push JSON to Piper Push Cache.
 email: peter@ohler.com
@@ -20,6 +20,7 @@ files:
 - LICENSE
 - README.md
 - lib/piper.rb
+- lib/piper/logrec.rb
 - lib/piper/manager.rb
 - lib/piper/version.rb
 - test/pipe_test.rb