petite-lettre 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Thibaut Barrère
+
+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.textile

@@ -0,0 +1,52 @@
+Petite-lettre is a little gem allowing YAML communication between a process and the child it launches.
+
+h1. USAGE
+
+The parent process launches its child and passes it a message using this kind of code:
+
+  PetiteLettre.call("ruby child_program.rb", { :command => :start_sale, :isbn => "1234567", :price => 12.4 })
+
+The child process read the parent message using this kind of code:
+
+  PetiteLettre.receive do |message|
+	response = {}
+	if message[:command] == :start_sale
+      # do something here
+      raise "Price is too low" if message[:price] < 15.0
+      response[:status] = "OK"
+	  response[:transaction_id] = "1235"
+	else
+	  raise "Unknown command '#{message[:command]}'"
+	end
+	response
+  end
+
+Petite-lettre uses $stdin and $stdout by default, although these can be customized with PetiteLettre.receive(input,output).
+
+h1. MORE USAGE
+
+Nothing stops you from writing a child process in another language (ie: C#, Java), as long as it knows how to read YAML from $stdin and output YAML on $stdout. Just the same - you can write a parent process in another language.
+
+See petite_lettre.rb for implementation details.
+
+h1. HISTORY
+
+Petite-lettre is born out of the need to communicate between a MRI/Shoes front-end and a JRuby/Celerity back-end.
+
+I'm pretty sure there is something already available out there to do that kind of things already. I just could not find them in a reasonable amount of time.
+
+If it's the case, please mail me so I can bury petite-lettre for ever.
+
+h1. CREDITS
+
+I think I got that idea after using CouchDB for a while. I believe CouchDB uses JSON to communicate between its processes.
+
+h1. IDEAS
+
+* create a C# or Java client
+* allow continuous communication (à la server)
+* throw petite-lettre to the bin if I discover something that does the same thing at the same level of simplicity
+
+h1. COPYRIGHT
+
+Copyright (c) 2008 Thibaut Barrère. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 0
+:patch: 0

data/lib/petite_lettre.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+
+module PetiteLettre
+  def self.call(command,message)
+    IO.popen(command,mode='r+') do |io|
+      io.write(YAML::dump(message))
+      io.close_write
+      result = YAML::load(io.read)
+      raise result[:error][:message] if result.is_a?(Hash) && result[:error]
+      result
+    end
+  end
+  
+  def self.receive(input=$stdin,output=$stdout)
+    message = YAML::load(input.read)
+    result = nil
+    begin
+      result = yield message
+    rescue => e
+      result = { :error => { :message => e.message } }
+    end
+    output.write(YAML::dump(result))
+  end
+end

data/spec/petite_lettre_spec.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+CLIENT = File.dirname(__FILE__) + "/sample_client.rb"
+
+describe PetiteLettre do
+  def response_for(hash)
+    PetiteLettre.call("ruby #{CLIENT}",hash)
+  end
+  
+  it "allows to send a simple message and get an answer" do
+    response_for({ :a => 5, :b => 2.0 }).should == 5/2.0
+  end
+
+  it "understands errors" do
+    lambda { response_for({ :a => 5, :b => 0}) }.should raise_error("divided by 0")
+  end
+  
+end

data/spec/sample_client.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + "/../lib/petite_lettre"
+
+PetiteLettre.receive do |message|
+  message[:a] / message[:b]
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'petite_lettre'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: petite-lettre
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- "Thibaut Barr\xC3\xA8re"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-29 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: thibaut.barrere@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+files: 
+- README.textile
+- VERSION.yml
+- lib/petite_lettre.rb
+- spec/petite_lettre_spec.rb
+- spec/sample_client.rb
+- spec/spec_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/thbar/petite-lettre
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: petite-lettre
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: YAML-based inter-process communication
+test_files: []
+