polytalk 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,18 @@
 # Polytalk
 
-TODO: Write a gem description
+Polytalk is a simple protocol which allows communication between different languages via TCP.
+
+Polytalk currently supports PHP, Node.js and Ruby.
+
+## Protocol
+
+The protocol is a simple language agnostic JSON object containing the class, method and arguments. It will then return an response as either a string or JSON object.
+
+Key          | Value
+------------ | ------------- 
+class        | The class to call the method on. Namespaced classes require the `::` separator.
+method       | The method you want to call.
+arguments    | The arguments to inject into the method in key value pairs.
 
 ## Installation
 
@@ -16,9 +28,40 @@ Or install it yourself as:
 
     $ gem install polytalk
 
-## Usage
+## Server Example
+
+Be sure that any classes you want to be exposed by the server to the client are included/required from the server.
+
+```ruby
+server = Polytalk::Server.new({ port: 9090 })
+server.run do |connection, request|
+  response = server.call(request)
+  server.push(connection, response)
+end
+```
 
-TODO: Write usage instructions here
+## Client Example
+  
+```ruby
+request = {
+    class: 'Model::Order',
+    method: 'findBySize',
+    arguments: {
+      size: 'large',
+      limit: 3
+    }
+}
+
+client = Polytalk::Client.new({ port: 9090 })
+
+puts client.call(request)
+
+# Passing a block
+first = client.call(request) do |r|
+  r.first
+end
+puts first
+```
 
 ## Contributing
 
@@ -27,3 +70,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+### License
+
+MIT, see LICENSE.

data/examples/server.rb

@@ -12,6 +12,7 @@ class Test
 end
 
 server = Polytalk::Server.new({ port: 9090 })
+puts "Ruby Server running on port 9090. PID=#{Process.pid}"
 server.run do |connection, request|
   response = server.call(request)
   server.push(connection, response)

data/lib/polytalk/server.rb

@@ -14,22 +14,39 @@ module Polytalk
       loop do
         Thread.start(server.accept) do |connection|
           request = connection.recv(2048)
-          yield(connection, JSON.parse(request))
+          yield(connection, JSON.parse(request, symbolize_names: true))
         end
       end
     end
 
     def call(request)
       required_constant = nil
-      request['class'].split('::').each_with_index do |c, index|
+      request[:class].split('::').each_with_index do |c, index|
         if index == 0
           required_constant = Kernel.const_get(c)
         else
           required_constant = required_constant.const_get(c)
         end
       end
-      required_method = required_constant.method(request['method'])
-      required_method.call *request['arguments'].values
+
+      # Convert string prefixed with `:` to symbols
+      if request[:arguments].is_a? Hash
+        request[:arguments].each do |key, arg|
+          if arg.is_a? String
+            if arg.match(/^:/)
+              request[:arguments][key] = arg[1..-1].to_sym
+            end
+          end
+        end
+      end
+
+      required_method = required_constant.method(request[:method])
+
+      if request[:arguments].is_a? Hash
+        required_method.call *request[:arguments].values
+      else
+        required_method.call
+      end
     end
 
     def push(connection, response)

data/lib/polytalk/version.rb

@@ -1,3 +1,3 @@
 module Polytalk
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polytalk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2012-12-08 00:00:00.000000000 Z
 dependencies: []
 description: Polytalk is a simple protocol which allows communication between different
   languages via TCP.
@@ -52,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Polytalk is a simple protocol which allows communication between different