quartz 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05b5dae726bdb30517440604cef9323e3f603977
-  data.tar.gz: 0b29eb3c722db7dd97b38807b0801914c6bb7bbd
+  metadata.gz: 38e17e14fd92fe48bde386619caf1a6c290b382f
+  data.tar.gz: 67579895994930814c09d929af14a4df14e38a42
 SHA512:
-  metadata.gz: 46f9a875047aeb19208991da607f1bfd21e2e747a660137aa9c75627e11ac0ced0b31d91faab36d565c19caa2c22fdd958c797e1136af5615e572c043fbc0c69
-  data.tar.gz: 41b49e461b6859c33b4ab87bb6d8f7ff0ef483cacb83ea7317824b49f8b8c6bdd307535d73fd188db3d6db167d1944013eac6b5c5dad36b99446757ba78a524c
+  metadata.gz: 1be3464bd2d6dd945f2f7abc0d4da0551c362fa1d69011a35699daa515b325533f43b3acad5e1a91bd83bb30b8a141fe4daad5d626190fa3bfe13395d694cba9
+  data.tar.gz: dea73da76d59574c5b984e612b5ff1b97c8025db45c42edeb05b4560500521e54943704532c8a3abd187a63f27dab9d3a35d58d9b5a9bfe1da08eed0a6f3fe6b

data/README.md

@@ -1,6 +1,6 @@
 # quartz
 
-[![Build Status](https://travis-ci.org/DavidHuie/quartz.svg?branch=travis-ci-test)](https://travis-ci.org/DavidHuie/quartz)
+[![Build Status](https://travis-ci.org/DavidHuie/quartz.svg?branch=master)](https://travis-ci.org/DavidHuie/quartz)
 
 Quartz enables you to call Go code from within your
 Ruby code. This is accomplished by running a Go program
@@ -43,7 +43,7 @@ func (t *Adder) Add(args Args, response *Response) error {
 ## Preparing a Quartz RPC server in Go
 
 Instead of integrating Quartz into an existing Go application,
-it is recommended to create a new `go run`-able file
+it is recommended to create a new program
 that explicitly defines the structs that should be available
 to Ruby.
 
@@ -77,11 +77,18 @@ Naturally:
 $ gem install quartz
 ```
 
-After you've found created a `go run`-able file, create a Go client that
+If you have a `go run`-able file, you can create a Go client that
 points to that file:
 
 ```ruby
-client = Quartz::Client.new(file_path: 'spec/test.go')
+client = Quartz::Client.new(file_path: 'my_adder.go')
+```
+
+If you compiled the Go program yourself, you can create a client
+that points to the binary like this:
+
+```ruby
+client = Quartz::Client.new(bin_path: 'my_adder_binary')
 ```
 
 To list exported structs:

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/go/quartz/quartz.go

@@ -118,8 +118,13 @@ func (q *Quartz) GetMetadata(_ interface{}, value *map[string]*StructMetadata) e
 }
 
 func init() {
+	socket_path := os.Getenv("QUARTZ_SOCKET")
+	if socket_path == "" {
+		socket_path = "/tmp/quartz.socket"
+	}
+
 	var err error
-	listener, err = net.Listen("unix", os.Getenv("QUARTZ_SOCKET"))
+	listener, err = net.Listen("unix", socket_path)
 	if err != nil {
 		panic(err)
 	}
@@ -131,7 +136,7 @@ func init() {
 
 	// Cleanup the socket file when the server is killed
 	sigc := make(chan os.Signal)
-	signal.Notify(sigc, os.Interrupt, os.Kill, syscall.SIGTERM)
+	signal.Notify(sigc, syscall.SIGTERM)
 	go func() {
 		<-sigc
 		err := listener.Close()

data/lib/quartz/client.rb

@@ -1,7 +1,7 @@
 class Quartz::Client
 
   def initialize(opts)
-    @process = Quartz::GoProcess.new(file_path: opts[:file_path])
+    @process = Quartz::GoProcess.new(opts)
     @structs = {}
     @process.get_metadata.each do |struct_name, metadata|
       @structs[struct_name.to_sym] = Quartz::GoStruct.new(struct_name, metadata, @process)

data/lib/quartz/go_process.rb

@@ -1,18 +1,39 @@
 class Quartz::GoProcess
 
+  attr_reader :temp_file_path
+
+  def self.processes
+    @processes ||= []
+  end
+
   def initialize(opts)
-    @socket_path = "/tmp/quartz#{rand(10000)}.sock"
+    @socket_path = "/tmp/quartz_#{rand(10000)}.sock"
     ENV['QUARTZ_SOCKET'] = @socket_path
 
     if opts[:file_path]
-      @go_process = Thread.new { `go run #{opts[:file_path]} }` }
+      compile_and_run(opts[:file_path])
     elsif opts[:bin_path]
-      @go_process = Thread.new { `#{opts[:bin_path]} }` }
+      @go_process = IO.popen(opts[:bin_path])
     else
       raise 'Missing go binary'
     end
 
     block_until_server_starts
+    self.class.processes << self
+  end
+
+  def compile_and_run(path)
+    @temp_file_path = "/tmp/quartz_runner_#{rand(10000)}"
+
+    unless system('go', 'build', '-o', @temp_file_path, path)
+      raise 'Go compilation failed'
+    end
+
+    @go_process = IO.popen(@temp_file_path)
+  end
+
+  def pid
+    @go_process.pid
   end
 
   def socket
@@ -40,7 +61,13 @@ class Quartz::GoProcess
     }
 
     socket.send(payload.to_json, 0)
-    read
+    response = read
+
+    if response['error']
+      raise "Metadata error: #{read['error']}"
+    end
+
+    response['result']
   end
 
   def call(struct_name, method, args)
@@ -61,7 +88,20 @@ class Quartz::GoProcess
   MAX_MESSAGE_SIZE = 1_000_000_000 # Bytes
 
   def read
-    JSON(socket.recv(MAX_MESSAGE_SIZE))['result']
+    JSON(socket.recv(MAX_MESSAGE_SIZE))
+  end
+
+  def cleanup
+    Process.kill('SIGTERM', pid)
+    Process.wait(pid)
+    File.delete(@temp_file_path) if @temp_file_path
+    self.class.processes.delete(self)
+  end
+
+  def self.cleanup
+    processes.each { |p| p.cleanup }
   end
 
 end
+
+at_exit { Quartz::GoProcess.cleanup }

data/lib/quartz/go_struct.rb

@@ -30,7 +30,13 @@ class Quartz::GoStruct
       # TODO: validate type
     end
 
-    @process.call(@struct_name, method_name, args)
+    response = @process.call(@struct_name, method_name, args)
+
+    if response['error']
+      raise "Error calling #{method_name}: #{response['error']}"
+    end
+
+    response['result']
   end
 
 end

data/quartz.gemspec

@@ -2,15 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: quartz 0.1.0 ruby lib
+# stub: quartz 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "quartz"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Huie"]
-  s.date = "2014-06-16"
+  s.date = "2014-06-17"
   s.description = "A gem for calling #golang code from ruby"
   s.email = "dahuie@gmail.com"
   s.extra_rdoc_files = [

data/spec/go_process_spec.rb

@@ -20,7 +20,40 @@ describe Quartz::GoProcess do
 
     it 'is able to call a method on a struct' do
       result = process.call('adder', 'Add', { 'A' => 5, 'B' => 6 })
-      result.should eq({"X"=>11})
+      result.should eq({"id"=>1, "result"=>{"X"=>11}, "error"=>nil})
+    end
+
+  end
+
+  it 'works with an existing binary file' do
+    temp_file = "/tmp/quartz_test_#{rand(10000)}"
+    system('go', 'build', '-o', temp_file, 'spec/test.go')
+    process = Quartz::GoProcess.new(bin_path: temp_file)
+    result = process.call('adder', 'Add', { 'A' => 5, 'B' => 6 })
+    result.should eq({"id"=>1, "result"=>{"X"=>11}, "error"=>nil})
+    File.delete(temp_file)
+  end
+
+  describe '.cleanup' do
+
+    context 'files' do
+
+      it "it deletes temporary files" do
+        File.exists?(process.temp_file_path).should be_true
+        process.cleanup
+        File.exists?(process.temp_file_path).should be_false
+      end
+
+    end
+
+    context 'processes' do
+
+      it "it kills child processes" do
+        File.exists?(process.temp_file_path).should be_true
+        process.cleanup
+        File.exists?(process.temp_file_path).should be_false
+      end
+
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quartz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Huie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec