jimson-client 0.1.0

data/LICENSE.txt

@@ -0,0 +1,17 @@
+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/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:rspec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :rspec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jimson #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/jimson.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'jimson/server'
+require 'jimson/client'
+
+module Jimson
+end

data/lib/jimson/client.rb

@@ -0,0 +1,168 @@
+require 'patron'
+require 'jimson/server_error'
+require 'jimson/client_error'
+require 'jimson/request'
+require 'jimson/response'
+
+module Jimson
+  class ClientHelper
+    JSON_RPC_VERSION = '2.0'
+
+    def self.make_id
+      rand(10**12)
+    end
+
+    def initialize(url)
+      @http = Patron::Session.new
+      uri = URI(url)
+      @path = uri.path
+      @http.base_url = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+      @batch = []
+    end
+
+    def process_call(sym, args)
+      resp = send_single_request(sym.to_s, args)
+
+      begin
+        data = JSON.parse(resp)
+      rescue
+        raise Jimson::ClientError::InvalidJSON.new(json)
+      end
+
+      return process_single_response(data)
+    end
+
+    def send_single_request(method, args)
+      post_data = {
+                    'jsonrpc' => JSON_RPC_VERSION,
+                    'method'  => method,
+                    'params'  => args,
+                    'id'      => self.class.make_id
+                  }.to_json
+      resp = @http.post(@path, post_data)
+      if resp.nil? || resp.body.nil? || resp.body.empty?
+        raise Jimson::ClientError::InvalidResponse.new
+      end
+
+      return resp.body
+
+      rescue Exception, StandardError
+        raise new Jimson::ClientError::InternalError.new($!)
+    end
+
+    def send_batch_request(batch)
+      post_data = batch.to_json
+      resp = @http.post(@path, post_data)
+      if resp.nil? || resp.body.nil? || resp.body.empty?
+        raise Jimson::ClientError::InvalidResponse.new
+      end
+
+      return resp.body
+    end
+
+    def process_batch_response(responses)
+      responses.each do |resp|
+        saved_response = @batch.map { |r| r[1] }.select { |r| r.id == resp['id'] }.first
+        raise Jimson::ClientError::InvalidResponse.new unless !!saved_response
+        saved_response.populate!(resp)
+      end
+    end
+
+    def process_single_response(data)
+      raise Jimson::ClientError::InvalidResponse.new if !valid_response?(data)
+
+      if !!data['error']
+        code = data['error']['code']
+        if Jimson::ServerError::CODES.keys.include?(code)
+          raise Jimson::ServerError::CODES[code].new
+        else
+          raise Jimson::ClientError::UnknownServerError.new(code, data['error']['message'])
+        end
+      end
+
+      return data['result']
+
+      rescue Exception, StandardError
+        raise new Jimson::ClientError::InternalError.new
+    end
+
+    def valid_response?(data)
+      return false if !data.is_a?(Hash)
+
+      return false if data['jsonrpc'] != JSON_RPC_VERSION
+
+      return false if !data.has_key?('id')
+
+      return false if data.has_key?('error') && data.has_key?('result')
+
+      if data.has_key?('error')
+        if !data['error'].is_a?(Hash) || !data['error'].has_key?('code') || !data['error'].has_key?('message') 
+          return false
+        end
+
+        if !data['error']['code'].is_a?(Fixnum) || !data['error']['message'].is_a?(String)
+          return false
+        end
+      end
+
+      return true
+      
+      rescue
+        return false
+    end
+
+    def push_batch_request(request)
+      request.id = self.class.make_id
+      response = Jimson::Response.new(request.id)
+      @batch << [request, response]
+      return response
+    end
+
+    def send_batch
+      batch = @batch.map(&:first) # get the requests 
+      response = send_batch_request(batch)
+
+      begin
+        responses = JSON.parse(response)
+      rescue
+        raise Jimson::ClientError::InvalidJSON.new(json)
+      end
+
+      process_batch_response(responses)
+      @batch = []
+    end
+
+  end
+
+  class BatchClient
+    
+    def initialize(helper)
+      @helper = helper
+    end
+
+    def method_missing(sym, *args, &block)
+      request = Jimson::Request.new(sym.to_s, args)
+      @helper.push_batch_request(request) 
+    end
+
+  end
+
+  class Client
+    
+    def self.batch(client)
+      helper = client.instance_variable_get(:@helper)
+      batch_client = BatchClient.new(helper)
+      yield batch_client
+      helper.send_batch
+    end
+
+    def initialize(url)
+      @helper = ClientHelper.new(url)
+    end
+
+    def method_missing(sym, *args, &block)
+      @helper.process_call(sym, args) 
+    end
+
+  end
+end

data/lib/jimson/client_error.rb

@@ -0,0 +1,28 @@
+module Jimson
+  module ClientError
+    class InvalidResponse < Exception
+      def initialize()
+        super('Invalid or empty response from server.')
+      end
+    end
+
+    class InvalidJSON < Exception
+      def initialize(json)
+        super("Couldn't parse JSON string received from server:\n#{json}")
+      end
+    end
+
+    class InternalError < Exception
+      def initialize(e)
+        super("An internal client error occurred when processing the request: #{e}\n#{e.backtrace.join("\n")}")
+      end
+    end
+
+    class UnknownServerError < Exception
+      def initialize(code, message)
+        super("The server specified an error the client doesn't know about: #{code} #{message}")
+      end
+    end
+
+  end
+end

data/lib/jimson/request.rb

@@ -0,0 +1,25 @@
+module Jimson
+  class Request
+
+    attr_accessor :method, :params, :id
+    def initialize(method, params, id = nil)
+      @method = method
+      @params = params
+      @id = id
+    end
+
+    def to_h
+      h = {
+        'jsonrpc' => '2.0',
+        'method'  => @method
+      }
+      h.merge!('params' => @params) if !!@params && !params.empty?
+      h.merge!('id' => id)
+    end
+
+    def to_json(*a)
+      self.to_h.to_json(*a)
+    end
+
+  end
+end

data/lib/jimson/response.rb

@@ -0,0 +1,30 @@
+module Jimson
+  class Response
+    attr_accessor :result, :error, :id
+
+    def initialize(id)
+      @id = id
+    end
+
+    def to_h
+      h = {'jsonrpc' => '2.0'}
+      h.merge!('result' => @result) if !!@result
+      h.merge!('error' => @error) if !!@error
+      h.merge!('id' => @id)
+    end
+
+    def is_error?
+      !!@error
+    end
+
+    def succeeded?
+      !!@result
+    end
+
+    def populate!(data)
+      @error = data['error'] if !!data['error']
+      @result = data['result'] if !!data['result']
+    end
+
+  end
+end

data/lib/jimson/server.rb

@@ -0,0 +1,163 @@
+require 'eventmachine'
+require 'evma_httpserver'
+require 'logger'
+require 'json'
+require 'jimson/server_error'
+
+module Jimson
+  class HttpServer < EM::Connection
+    include EM::HttpServer
+
+    JSON_RPC_VERSION = '2.0'
+
+    def self.handler=(handler)
+      @@handler = handler
+    end
+
+    def process_http_request
+      resp = EM::DelegatedHttpResponse.new( self )
+      resp.status = 200
+      resp.content = process_post(@http_post_content)
+      resp.send_response
+    end
+
+    def process_post(content)
+      begin
+        request = parse_request(@http_post_content)
+        if request.is_a?(Array)
+          raise Jimson::ServerError::InvalidRequest.new if request.empty?
+          response = request.map { |req| handle_request(req) }
+        else
+          response = handle_request(request)
+        end
+      rescue Jimson::ServerError::ParseError, Jimson::ServerError::InvalidRequest => e
+        response = error_response(e)
+      rescue Jimson::ServerError::Generic => e
+        response = error_response(e, request)
+      rescue StandardError, Exception
+        response = error_response(Jimson::ServerError::InternalError.new)
+      end
+
+      response.compact! if response.is_a?(Array)
+
+      return nil if response.nil? || (response.respond_to?(:empty?) && response.empty?)
+
+      response.to_json
+    end
+
+    def handle_request(request)
+      response = nil
+      begin
+        if !validate_request(request)
+          response = error_response(Jimson::ServerError::InvalidRequest.new)
+        else
+          response = create_response(request)
+        end
+      rescue Jimson::ServerError::Generic => e
+        response = error_response(e, request)
+      end
+
+      response
+    end
+
+    def validate_request(request)
+      required_keys = %w(jsonrpc method)
+      required_types = {
+                         'jsonrpc' => [String],
+                         'method'  => [String], 
+                         'params'  => [Hash, Array],
+                         'id'      => [String, Fixnum, NilClass]
+                       }
+      
+      return false if !request.is_a?(Hash)
+
+      required_keys.each do |key|
+        return false if !request.has_key?(key)
+      end
+
+      required_types.each do |key, types|
+        return false if request.has_key?(key) && !types.any? { |type| request[key].is_a?(type) }
+      end
+
+      return false if request['jsonrpc'] != JSON_RPC_VERSION
+      
+      true
+    end
+
+    def create_response(request)
+      params = request['params']
+      begin
+        if params.is_a?(Hash)
+          result = @@handler.send(request['method'], params)
+        else
+          result = @@handler.send(request['method'], *params)
+        end
+      rescue NoMethodError
+        raise Jimson::ServerError::MethodNotFound.new 
+      rescue ArgumentError
+        raise Jimson::ServerError::InvalidParams.new
+      rescue
+        raise Jimson::ServerError::ApplicationError.new($!)
+      end
+
+      response = success_response(request, result)
+
+      # A Notification is a Request object without an "id" member.
+      # The Server MUST NOT reply to a Notification, including those 
+      # that are within a batch request.
+      response = nil if !request.has_key?('id')
+
+      response 
+    end
+
+    def error_response(error, request = nil)
+      resp = {
+               'jsonrpc' => JSON_RPC_VERSION,
+               'error'   => error.to_h,
+             }
+      if !!request && request.has_key?('id')
+        resp['id'] = request['id'] 
+      else
+        resp['id'] = nil
+      end
+
+      resp
+    end
+
+    def success_response(request, result)
+      {
+        'jsonrpc' => JSON_RPC_VERSION,
+        'result'  => result,  
+        'id'      => request['id']
+      }
+    end
+
+    def parse_request(post)
+      data = JSON.parse(post)
+      rescue 
+        raise Jimson::ServerError::ParseError.new 
+    end
+
+  end
+
+  class Server
+    
+    attr_accessor :handler, :host, :port, :logger
+
+    def initialize(handler, host = '0.0.0.0', port = 8999, logger = Logger.new(STDOUT))
+      @handler = handler
+      @host = host
+      @port = port
+      @logger = logger
+    end
+
+    def start
+      Jimson::HttpServer.handler = @handler
+      EM.run do
+        EM::start_server(@host, @port, Jimson::HttpServer)
+        @logger.info("Server listening on #{@host}:#{@port} with handler '#{@handler}'")
+      end
+    end
+
+  end
+end

data/lib/jimson/server_error.rb

@@ -0,0 +1,64 @@
+module Jimson
+  module ServerError
+    class Generic < Exception
+      attr_accessor :code, :message
+
+      def initialize(code, message)
+        @code = code
+        @message = message
+        super(message)
+      end
+
+      def to_h
+        {
+          'code'    => @code,
+          'message' => @message
+        }
+      end
+    end
+
+    class ParseError < Generic
+      def initialize
+        super(-32700, 'Invalid JSON was received by the server. An error occurred on the server while parsing the JSON text.')
+      end
+    end
+
+    class InvalidRequest < Generic
+      def initialize
+        super(-32600, 'The JSON sent is not a valid Request object.')
+      end
+    end
+
+    class MethodNotFound < Generic
+      def initialize
+        super(-32601, 'Method not found.')
+      end
+    end
+
+    class InvalidParams < Generic
+      def initialize
+        super(-32602, 'Invalid method parameter(s).')
+      end
+    end
+
+    class InternalError < Generic
+      def initialize
+        super(-32603, 'Internal server error.')
+      end
+    end
+
+    class ApplicationError < Generic
+      def initialize(err)
+        super(-32099, "The application being served raised an error: #{err}")
+      end
+    end
+
+    CODES = {
+              -32700 => ParseError,
+              -32600 => InvalidRequest,
+              -32601 => MethodNotFound,
+              -32602 => InvalidParams,
+              -32603 => InternalError
+            }
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: jimson-client
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Kite
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-20 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: patron
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.12
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- VERSION
+- LICENSE.txt
+- CHANGELOG.rdoc
+- README.rdoc
+- Rakefile
+- lib/jimson.rb
+- lib/jimson/client_error.rb
+- lib/jimson/server.rb
+- lib/jimson/server_error.rb
+- lib/jimson/response.rb
+- lib/jimson/request.rb
+- lib/jimson/client.rb
+has_rdoc: true
+homepage: http://www.github.com/chriskite/jimson
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: JSON-RPC 2.0 client
+test_files: []
+