quartz 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ede307136d543e7451dd9328969152e7d9b29d81
-  data.tar.gz: 01c7dceb7ea7859fda5a716566bca594cfb8c53a
+  metadata.gz: d520e80d9a379cdb4307bb348bb432575e6d1b49
+  data.tar.gz: 3aff1a2208541befddf074d95555989f0dec15fe
 SHA512:
-  metadata.gz: cdfaebcd6fd90c55b8a9e2d11171827f15b92a5fe07d87cfe9306a28f222c1f803672a4fc7e704031b71d5a57daaf5db49e06448da8a9b6632836bc5bccae19c
-  data.tar.gz: a015e450a1f9e6e19d32fed4b3a0ebaf5dd03e37842f8ebb813d65619ce28ed6799aeb09626c60f071a30397f9b06ea7d03f5df55b1afd318b52bdfe200e6032
+  metadata.gz: c00b4e411caff77ac6cbf23eeb921f27cd4fc98ccd73f5fd096c6913dace57037a995e38feeb58d4a8b46c06403a706c8093abf29ccbbc916b42556d442d4493
+  data.tar.gz: 7bbd949d31479cbe7aa5263245d09cc1650fc1024454f90b03d3047948ff24ed8e5d8bdea09c2071b13c5f84a33f81f304992ba36e4c4a9f0698521054b5f121

data/README.md

@@ -0,0 +1,102 @@
+# quartz
+
+Quartz enables you to call Go code from within your
+Ruby code. This is accomplished by running a Go program
+as a child process of your Ruby application and using UNIX domain sockets
+for communication.
+
+With this gem, you can now write performance critical code in Go, and that
+code can be called from anywhere in a Ruby project.
+
+To see some real world examples where Go can aid a Ruby project, please see
+the `examples/` directory.
+
+## Defining exportable structs
+
+Quartz shares Go code by exporting methods on a struct to Ruby.
+
+Quartz requires that all arguments to exported struct methods be JSON-serializable
+structs. Additionally, the arguments to an exported method should be of the form
+`(A, *B)`, where `A` and `B` are struct types. The method should also return an error.
+Here's an example of an exportable struct and method:
+
+```go
+type Adder struct{}
+
+type Args struct {
+	A int
+	B int
+}
+
+type Response struct {
+	Sum int
+}
+
+func (t *Adder) Add(args Args, response *Response) error {
+	*response = Response{args.A + args.B}
+	return nil
+}
+```
+
+## Preparing a Quartz RPC server in Go
+
+Instead of integrating Quartz into an existing Go application,
+it is recommended that a new `go run`-able file is created
+that explicitly defines the structs that should be available
+to Ruby.
+
+First, import the Go package:
+
+```go
+import (
+	"github.com/DavidHuie/quartz/go/quartz"
+)
+```
+
+Quartz maintains most of Go's native RPC interface. Thus, export a struct
+by calling this in your `main` function:
+
+```go
+myAdder := &Adder{}
+quartz.RegisterName("my_adder", myAdder)
+```
+
+Once all structs have been declared, start the RPC server (this is a blocking call):
+
+```go
+quartz.Start()
+```
+
+## In Ruby
+
+Naturally:
+
+```shell
+$ gem install quartz
+```
+
+After you've found created a `go run`-able file, create a Go process wrapper that
+points to that file:
+
+```ruby
+require 'quartz'
+
+go_process = Quartz::GoProcess.new(file_path: 'spec/test.go')
+```
+
+Now, you can create a client:
+
+```ruby
+client = Quartz::Client.new(go_process)
+```
+
+To call a method on a struct:
+
+```ruby
+client[:my_adder].call('Add', 'A' => 2, 'B' => 5)
+# => { 'Sum' => 7 }
+```
+
+## Copyright
+
+Copyright (c) 2014 David Huie. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/examples/lookup_dns.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"net"
+
+	"github.com/DavidHuie/quartz/go/quartz"
+)
+
+type Resolver struct{}
+
+type FindIPsArgs struct {
+	Hostnames []string
+}
+
+type FindIPsResponse struct {
+	HostnameToIPs map[string][]net.IP
+}
+
+func (r *Resolver) FindIPs(args FindIPsArgs, response *FindIPsResponse) error {
+	*response = FindIPsResponse{}
+	response.HostnameToIPs = make(map[string][]net.IP)
+	c := make(chan bool)
+
+	for _, hostname := range args.Hostnames {
+		go func(h string) {
+			addrs, err := net.LookupIP(h)
+			if err != nil {
+				panic(err)
+			}
+
+			response.HostnameToIPs[h] = addrs
+
+			c <- true
+		}(hostname)
+	}
+
+	for i := 0; i < len(args.Hostnames); i++ {
+		<-c
+	}
+
+	return nil
+}
+
+func main() {
+	resolver := &Resolver{}
+	quartz.RegisterName("resolver", resolver)
+	quartz.Start()
+}

data/examples/lookup_dns.rb

@@ -0,0 +1,9 @@
+require 'quartz'
+
+go_process = Quartz::GoProcess.new(file_path: 'lookup_dns.go')
+client = Quartz::Client.new(go_process)
+
+puts client[:resolver].call('FindIPs',
+                            'Hostnames' => ['www.google.com',
+                                            'www.facebook.com',
+                                            'www.microsoft.com'])

data/lib/quartz/go_process.rb

@@ -1,20 +1,35 @@
 class Quartz::GoProcess
 
   def initialize(opts)
-    @socket_name = "/tmp/quartz#{rand(10000)}.sock"
-    ENV['QUARTZ_SOCKET'] = @socket_name
+    @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]} }` }
     elsif opts[:bin_path]
       @go_process = Thread.new { `#{opts[:bin_path]} }` }
     else
-      raise 'Missing go binary path'
+      raise 'Missing go binary'
     end
 
-    sleep(1)
+    block_until_server_starts
+  end
+
+  def socket
+    Thread.current[:quartz_socket] ||= UNIXSocket.new(@socket_path)
+  end
 
-    @socket = UNIXSocket.new(@socket_name)
+  def block_until_server_starts
+    max_retries = 10
+    retries = 0
+    delay = 0.1 # seconds
+
+    loop do
+      raise 'RPC server not starting' if retries > max_retries
+      return if File.exists?(@socket_path)
+      sleep(delay * retries * 2**retries)
+      retries += 1
+    end
   end
 
   def get_metadata
@@ -24,7 +39,7 @@ class Quartz::GoProcess
       'id' => 1
     }
 
-    @socket.send(payload.to_json, 0)
+    socket.send(payload.to_json, 0)
     read
   end
 
@@ -39,14 +54,14 @@ class Quartz::GoProcess
       'id' => 1
     }
 
-    @socket.send(payload.to_json, 0)
+    socket.send(payload.to_json, 0)
     read
   end
 
   MAX_MESSAGE_SIZE = 1_000_000_000 # Bytes
 
   def read
-    JSON(@socket.recv(MAX_MESSAGE_SIZE))['result']
+    JSON(socket.recv(MAX_MESSAGE_SIZE))['result']
   end
 
 end

data/quartz.gemspec

@@ -2,21 +2,20 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: quartz 0.0.1 ruby lib
+# stub: quartz 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "quartz"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
   s.authors = ["David Huie"]
   s.date = "2014-06-16"
   s.description = "A gem for calling #golang code from ruby"
   s.email = "dahuie@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -24,9 +23,11 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
+    "examples/lookup_dns.go",
+    "examples/lookup_dns.rb",
     "go/quartz/quartz.go",
     "lib/quartz.rb",
     "lib/quartz/client.rb",
@@ -41,7 +42,8 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/DavidHuie/quartz"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.1.11"
   s.summary = "A gem for calling #golang code from ruby"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quartz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David Huie
@@ -14,70 +14,70 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 'A gem for calling #golang code from ruby'
@@ -86,16 +86,18 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
-- ".document"
-- ".rspec"
+- .document
+- .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
+- examples/lookup_dns.go
+- examples/lookup_dns.rb
 - go/quartz/quartz.go
 - lib/quartz.rb
 - lib/quartz/client.rb
@@ -117,17 +119,17 @@ 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: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: 'A gem for calling #golang code from ruby'

data/README.rdoc

@@ -1,18 +0,0 @@
-= quartz
-
-A gem for calling #golang code from ruby
-
-== Contributing to quartz
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2014 David Huie. See LICENSE.txt for
-further details.