sync_service 0.0.8

data/.autotest

@@ -0,0 +1,5 @@
+require 'autotest/bundler'
+
+Autotest.add_hook(:initialize) do |at|
+  at.add_exception %r{^./(.git|coverage)}
+end

data/.gitignore

@@ -0,0 +1,9 @@
+vendor/
+.bundle/
+coverage/
+spec/reports
+*.log
+.yardoc
+*.gem
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--profile

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gemspec
+
+group :osx do
+  gem "growl"
+  gem 'rb-fsevent'
+end
+
+group :linux do
+  gem "rb-inotify"
+  gem "libnotify"
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,66 @@
+## Introduction
+
+sync_service is a library to create synchronous SOA daemons. It's built on top of the JSON/RPC protocol and can be deployed anywhere you deploy a Rack application.
+
+## Install
+
+Requires ruby-1.9.3p0.
+
+Then do:
+
+    $ gem install sync_service
+
+## Hosting a Service
+
+A service is just any Ruby object that descends from <code>SyncService::Base</code>. Any public method in the object is automatically exposed via SOA.
+
+
+    require "sync_service"
+
+    class Application < SyncService::Base
+      @service_name = "mobme.infrastructure.rpc.test"
+
+      def server_timestamp
+        Time.now.to_i
+      end
+
+      def buggy_method
+        raise MobME::Infrastructure::RPC::Error, "This exception is expected."
+      end
+
+      def method_missing(name, *args)
+        logger.err "[SERVER] received method #{name} with #{args.inspect}"
+      end
+    end
+
+To expose the Application, you can either create a standalone server and run it via <code>SyncService::Runner</code>:
+
+    require 'sync_service'
+    require_relative 'application'
+
+    SyncService::Runner.start Application.new, '0.0.0.0', 8080, '/test_application'
+
+or make a simple config.ru via SyncService::Adaptor:
+
+    require 'sync_service'
+    require Pathname.new(File.dirname(__FILE__)).join('application')
+
+    map("/test_application") do
+      run SyncService::Adaptor.new(Application.new)
+    end
+
+## Consuming a Service
+
+To consume services, use <code>SyncService::Client</code>:
+
+    require "sync_service"
+    RPC.logging = true
+
+    client = SyncService::Client.setup("http://127.0.0.1:8080/test_application")
+
+    # Get result of an existing method.
+    puts "Server timestamp is #{client.server_timestamp}"
+
+
+You can see the complete example in the examples/ folder.
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rspec/core/rake_task'
+require "rake/tasklib"
+require "flog"
+require 'ci/reporter/rake/rspec'
+
+RSpec::Core::RakeTask.new(:spec => ["ci:setup:rspec"]) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+desc "Analyze for code complexity"
+task :flog do
+  flog = Flog.new
+  flog.flog [ "lib" ]
+  threshold = 10
+
+  bad_methods = flog.totals.select do | name, score |
+    name != "main#none" && score > threshold
+  end
+  bad_methods.sort do | a, b |
+    a[ 1 ] <=> b[ 1 ]
+  end.reverse.each do | name, score |
+    puts "%8.1f: %s" % [ score, name ]
+  end
+  unless bad_methods.empty?
+    raise "#{ bad_methods.size } methods have a flog complexity > #{ threshold }"
+  end
+end

data/examples/application.rb

@@ -0,0 +1,17 @@
+require "sync_service"
+
+class Application < SyncService::Base
+  @service_name = "mobme.infrastructure.rpc.test"
+
+  def server_timestamp
+    Time.now.to_i
+  end
+
+  def buggy_method
+    raise MobME::Infrastructure::RPC::Error, "This exception is expected."
+  end
+
+  def method_missing(name, *args)
+    logger.err "[SERVER] received method #{name} with #{args.inspect}"
+  end
+end

data/examples/client.rb

@@ -0,0 +1,29 @@
+require "sync_service"
+
+RPC.logging = true
+
+client = SyncService::Client.setup("http://127.0.0.1:8080/test_application")
+
+# Get result of an existing method.
+puts "Server timestamp is #{client.server_timestamp}"
+
+# Get result of a non-existing method via method_missing.
+puts "Method missing works: #{client + 1}"
+
+# Synchronous error handling.
+begin
+  client.buggy_method
+rescue MobME::Infrastructure::RPC::Error => exception
+  STDERR.puts "EXCEPTION CAUGHT: #{exception.inspect}"
+end
+
+# Notification isn't supported, because HTTP works in
+# request/response mode, so it does behave in the same
+# manner as rpc via method_missing. Sense of this is
+# only to check, that it won't blow up.
+puts "Sending a notification ..."
+client.notification(:log, "Some shit.")
+
+# Batch.
+result = client.batch([[:log, ["Message"], nil], [:a_method, []]])
+puts "Batch result: #{result}"

data/examples/config.ru

@@ -0,0 +1,7 @@
+require 'sync_service'
+
+require Pathname.new(File.dirname(__FILE__)).join('application')
+
+map("/test_application") do
+  run SyncService::Adaptor.new(Application.new)
+end

data/examples/php/client.php

@@ -0,0 +1,17 @@
+<?php
+require_once 'jsonRPCClient.php';
+$client = new jsonRPCClient('http://127.0.0.1:8080/test_application');
+
+// Get result of an existing method.
+echo 'Server timestamp is '. $client->server_timestamp() . "\n";
+
+// Get result of a non-existing method via method_missing.
+echo 'Method missing works: ' . $client->plus(1) . "\n";
+
+// Synchronous error handling.
+try {
+	$client->buggy_method();
+} catch (Exception $e) {
+	echo 'EXCEPTION CAUGHT: ' . nl2br($e->getMessage()) . "\n";
+}
+?>

data/examples/php/jsonRPCClient.php

@@ -0,0 +1,165 @@
+<?php
+/*
+					COPYRIGHT
+
+Copyright 2007 Sergio Vaccaro <sergio@inservibile.org>
+
+This file is part of JSON-RPC PHP.
+
+JSON-RPC PHP is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+JSON-RPC PHP is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with JSON-RPC PHP; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+/**
+ * The object of this class are generic jsonRPC 1.0 clients
+ * http://json-rpc.org/wiki/specification
+ *
+ * @author sergio <jsonrpcphp@inservibile.org>
+ */
+class jsonRPCClient {
+	
+	/**
+	 * Debug state
+	 *
+	 * @var boolean
+	 */
+	private $debug;
+	
+	/**
+	 * The server URL
+	 *
+	 * @var string
+	 */
+	private $url;
+	/**
+	 * The request id
+	 *
+	 * @var integer
+	 */
+	private $id;
+	/**
+	 * If true, notifications are performed instead of requests
+	 *
+	 * @var boolean
+	 */
+	private $notification = false;
+	
+	/**
+	 * Takes the connection parameters
+	 *
+	 * @param string $url
+	 * @param boolean $debug
+	 */
+	public function __construct($url,$debug = false) {
+		// server URL
+		$this->url = $url;
+		// proxy
+		empty($proxy) ? $this->proxy = '' : $this->proxy = $proxy;
+		// debug state
+		empty($debug) ? $this->debug = false : $this->debug = true;
+		// message id
+		$this->id = 1;
+	}
+	
+	/**
+	 * Sets the notification state of the object. In this state, notifications are performed, instead of requests.
+	 *
+	 * @param boolean $notification
+	 */
+	public function setRPCNotification($notification) {
+		empty($notification) ?
+							$this->notification = false
+							:
+							$this->notification = true;
+	}
+	
+	/**
+	 * Performs a jsonRCP request and gets the results as an array
+	 *
+	 * @param string $method
+	 * @param array $params
+	 * @return array
+	 */
+	public function __call($method,$params) {
+		
+		// check
+		if (!is_scalar($method)) {
+			throw new Exception('Method name has no scalar value');
+		}
+		
+		// check
+		if (is_array($params)) {
+			// no keys
+			$params = array_values($params);
+		} else {
+			throw new Exception('Params must be given as array');
+		}
+		
+		// sets notification or request task
+		if ($this->notification) {
+			$currentId = NULL;
+		} else {
+			$currentId = $this->id;
+		}
+		
+		// prepares the request
+		$request = array(
+						'method' => $method,
+						'params' => $params,
+						'id' => $currentId
+						);
+		$request = json_encode($request);
+		$this->debug && $this->debug.='***** Request *****'."\n".$request."\n".'***** End Of request *****'."\n\n";
+		
+		// performs the HTTP POST
+		$opts = array ('http' => array (
+							'method'  => 'POST',
+							'header'  => 'Content-type: application/json',
+							'content' => $request
+							));
+		$context  = stream_context_create($opts);
+		if ($fp = fopen($this->url, 'r', false, $context)) {
+			$response = '';
+			while($row = fgets($fp)) {
+				$response.= trim($row)."\n";
+			}
+			$this->debug && $this->debug.='***** Server response *****'."\n".$response.'***** End of server response *****'."\n";
+			$response = json_decode($response,true);
+		} else {
+			throw new Exception('Unable to connect to '.$this->url);
+		}
+		
+		// debug output
+		if ($this->debug) {
+			echo nl2br($debug);
+		}
+		
+		// final checks and return
+		if (!$this->notification) {
+			// check
+			if ($response['id'] != $currentId) {
+				throw new Exception('Incorrect response id (request id: '.$currentId.', response id: '.$response['id'].')');
+			}
+			if (!is_null($response['error'])) {
+				throw new Exception('Request error: '.$response['error']);
+			}
+			
+			return $response['result'];
+			
+		} else {
+			return true;
+		}
+	}
+}
+?>

data/examples/python/README

@@ -0,0 +1,5 @@
+Python client requires the python-jsonrpc library.
+
+$ svn checkout http://svn.json-rpc.org/trunk/python-jsonrpc
+$ cd python-jsonrpc
+$ sudo python setup.py install

data/examples/python/client.py

@@ -0,0 +1,16 @@
+from jsonrpc import ServiceProxy
+
+client = ServiceProxy("http://127.0.0.1:8080/test_application")
+
+# Get result of an existing method.
+print 'Server timestamp is ' + str(client.server_timestamp())
+
+# Get result of a non-existing method via method_missing.
+print 'Method missing works: ' + client.plus(1)
+
+# Synchronous error handling.
+try:
+  client.buggy_method()
+except Exception, e:
+  print 'EXCEPTION CAUGHT: ' + e.error['message']
+  

data/examples/server.rb

@@ -0,0 +1,4 @@
+require 'sync_service'
+require_relative 'application'
+
+SyncService::Runner.start Application.new, '0.0.0.0', 8080, '/test_application'

data/lib/mobme/infrastructure/rpc/adaptor.rb

@@ -0,0 +1,31 @@
+module MobME::Infrastructure::RPC
+  class Adaptor
+    def initialize(service_object)
+      @service_object = service_object
+    end
+
+    def server
+      @server ||= RPC::Server.new(@service_object)
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      command = request.body.read
+      binary = server.execute(command)
+
+      if binary.match(/NoMethodError/)
+        response(404, binary)
+      else
+        response(200, binary)
+      end
+    end
+
+    def response(status, body)
+      headers = {
+        "Content-Type" => "application/json-rpc",
+        "Content-Length" => body.bytesize.to_s
+      }
+      [status, headers, [body]]
+    end
+  end
+end