piper-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfc1c00fe2695fa0f233af913096fedc63e00fe5
+  data.tar.gz: 0a218f8cc28a0019383d2aa7e7a8525bf20ed539
+SHA512:
+  metadata.gz: 12aa9c159a8b4d6aef85db5b6c08124b5c8a073af68ba7ef3b960d1db0838ceae2ccd4553d1162faadccb0512696d313524b74378e85296b7dbf983a3862876a
+  data.tar.gz: 931b9df08582a5f6b3cdfc7259f12d7b46b170b36c9ae138b3cf9d33aafc876f44732f8ecd6c773078224731344de3086da6b07d3e78c1d2d9b1a49ef91068fb

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Peter Ohler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,13 @@
+# 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
+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.

data/lib/piper/manager.rb

@@ -0,0 +1,57 @@
+
+require 'net/http'
+require 'oj'
+
+module Piper
+
+  # Piper::Manager is a simple class that is used to manage cached content in a
+  # Piper Push Cache server. It uses HTTP request in a REST pattern.
+  class Manager
+
+    attr_accessor :host
+    attr_accessor :port
+    
+    def initialize(host, port)
+      @host = host
+      @port = port
+    end
+
+    # Pushes JSON to Piper and associates it with the provided record
+    # identifier.
+    # @param [String] rid record identifier
+    # @param [String] json JSON to store in Piper
+    # @return [Net::HTTP::Response] of the send request.
+    def push_json(rid, json)
+      h = Net::HTTP.new(@host, @port)
+      h.send_request('PUT', "/#{rid}", json, {'Content-Type' => 'text/plain; charset=utf-8'})
+    end
+
+    # Converts an object to JSON and then pushed that JSON to Piper and
+    # associates it with the provided record identifier.
+    # @param [String] rid record identifier
+    # @param [Object] object Object to convert to JSON before storing
+    # @return [Net::HTTP::Response] of the send request.
+    def push(rid, obj)
+      push_json(rid, Oj::dump(obj, mode: :compat))
+    end
+
+    # Deletes a record from the Piper cache.
+    # @param [String] rid record identifier of the record to delete
+    # @return [Net::HTTP::Response] of the send request.
+    def delete(rid)
+      h = Net::HTTP.new(@host, @port)
+      h.send_request('DELETE', "/#{rid}")
+    end
+
+    # Gets a record from the Piper cache. The JSON will be in the body of the
+    # response if successful.
+    # @param [String] rid record identifier of the record to get
+    # @return [Net::HTTP::Response] of the send request.
+    def get(rid)
+      h = Net::HTTP.new(@host, @port)
+      h.send_request('GET', "/#{rid}")
+    end
+
+  end # Manager
+
+end # Piper

data/lib/piper/version.rb

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

data/lib/piper.rb

@@ -0,0 +1,6 @@
+
+module Piper
+end # Piper
+
+require 'piper/version'
+require 'piper/manager'

data/test/pipe_test.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+$VERBOSE = true
+
+$: << File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'lib')
+
+require 'minitest'
+require 'minitest/autorun'
+require 'piper'
+
+$verbose = true
+
+class PipeTest < Minitest::Test
+
+  # Steps need to be done in order since they modify and then inspect the remote
+  # piper cache.
+  #
+  # Before running the tests, start the connection_count sample in Piper Push
+  # Cache. Piper Push Cache can be downloaded from piperpushcache.com. Follow
+  # the instructions there to start the sample.
+  def test_all
+    man = Piper::Manager.new('localhost', 7661)
+    iron = {
+      'class' => 'Pipe',
+      'id' => 'pipe-iron',
+      'color' => 'gray',
+      'hot-ok' => true
+    }
+    resp = man.push(iron['id'], iron);
+    puts " PUT /#{iron['id']} response: #{resp.code} - #{resp.body}" if $verbose
+    assert_equal(202, resp.code.to_i, 'expected a 202 when pushing iron')
+
+    black = {
+      'class' => 'Pipe',
+      'id' => 'pipe-black',
+      'color' => 'black',
+      'hot-ok' => true
+    }
+    resp = man.push(black['id'], black);
+    puts " PUT /#{black['id']} response: #{resp.code} - #{resp.body}" if $verbose
+    assert_equal(202, resp.code.to_i, 'expected a 202 when pushing black')
+
+    resp = man.get(iron['id']);
+    puts " GET /#{iron['id']} response: #{resp.code} - #{resp.body}" if $verbose
+    assert_equal(202, resp.code.to_i, 'expected a 202 when getting iron')
+
+    resp = man.delete(iron['id']);
+    puts " DELETE /#{iron['id']} response: #{resp.code} - #{resp.body}" if $verbose
+    assert_equal(202, resp.code.to_i, 'expected a 202 when deleting iron')
+
+    resp = man.get(iron['id']);
+    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')
+    
+  end
+
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: piper-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Ohler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby management client to push JSON to Piper Push Cache.
+email: peter@ohler.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/piper.rb
+- lib/piper/manager.rb
+- lib/piper/version.rb
+- test/pipe_test.rb
+homepage: http://www.piperpushcache.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+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: piper-ruby
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Management client for Piper Push Cache.
+test_files: []
+has_rdoc: true