saorin 0.1.4 → 0.2.0

data/lib/saorin/adapters/clients/base.rb

@@ -12,25 +12,22 @@ module Saorin
         def initialize(options = {})
         end
 
-        def call_single(method, *args)
-          request = Saorin::Request.new method, args, seqid!
+        def call(method, *args)
+          apply Saorin::Request.new(method, args, :id => seqid!)
+        end
+
+        def notify(method, *args)
+          apply Saorin::Request.new(method, args)
+        end
+
+        def apply(request)
           response = send_request request.to_json
           content = process_response response
           raise content if content.is_a?(Saorin::RPCError)
           content
         end
 
-        alias_method :call, :call_single
-
-        def call_multi(*args)
-          requests = args.map do |arg|
-            request_args = arg.to_a.flatten
-            method = request_args.shift
-            Saorin::Request.new method, request_args, seqid!
-          end
-          response = send_request requests.to_json
-          process_response response
-        end
+        protected
 
         def send_request(content)
           raise NotImplementedError
@@ -39,11 +36,15 @@ module Saorin
         def process_response(content)
           response = parse_response content
           if response.is_a?(::Array)
-            response.map { |res| to_content handle_response(res) }
+            response.map { |res| handle_response res }
           else
-            to_content handle_response(response)
+            handle_response response
           end
+        rescue Saorin::InvalidResponse => e
+          raise e
         rescue => e
+          p e
+          print e.backtrace.join("\t\n")
           raise Saorin::InvalidResponse, e.to_s
         end
 
@@ -53,20 +54,23 @@ module Saorin
           raise Saorin::InvalidResponse, e.to_s
         end
 
-        def to_content(res)
-          if res.error?
-            code = res.error['code']
+        def to_content(response)
+          return nil if response.nil?
+          if response.error?
+            code, message, data = response.error.values_at('code', 'message', 'data')
             error_class = Saorin.code_to_error code
-            error_class.new
+            raise Error, 'unknown error code' unless error_class
+            error_class.new message, :code => code, :data => data
           else
-            res.result
+            response.result
           end
         end
 
         def handle_response(hash)
+          return nil if hash.nil?
           response = Response.from_hash(hash)
           response.validate
-          response
+          to_content response
         end
 
         def seqid

data/lib/saorin/adapters/servers/base.rb

@@ -27,7 +27,7 @@ module Saorin
                          handle_request(request)
                        end
                      rescue Saorin::Error => e
-                       Response.new(nil, e)
+                       Response.new(:error => e)
                      end
 
           response && MultiJson.dump(response)
@@ -43,29 +43,30 @@ module Saorin
           begin
             request = Request.from_hash(hash)
             request.validate
-            result = dispatch_request request
-            response = Response.new(result, nil, request.id)
-            notify?(hash) ? nil : response
+            dispatch_request_with_trap_notification request
           rescue Saorin::InvalidRequest => e
-            Response.new(nil, e)
+            Response.new(:error => e)
           rescue Saorin::Error => e
-            Response.new(nil, e, request.id)
+            Response.new(:error => e, :id => request.id)
           rescue Exception => e
-            p e
-            Response.new(nil, Saorin::InternalError.new, request && request.id)
+            options = {:error => Saorin::InternalError.new}
+            options[:id] = request.id if request
+            Response.new(options)
           end
         end
 
-        def notify?(hash)
-          hash.is_a?(::Hash) && !hash.has_key?('id')
+        def dispatch_request_with_trap_notification(request)
+          result = dispatch_request request
+          Response.new(:result => result, :id => request.id)
+        ensure
+          return nil if request.notify?
         end
 
         def dispatch_request(request)
           method = request.method.to_s
           params = request.params || []
 
-          unless @allowed_methods.include?(method) &&
-            @handler.respond_to?(method)
+          unless @allowed_methods.include?(method) && @handler.respond_to?(method)
             raise Saorin::MethodNotFound
           end
 

data/lib/saorin/error.rb

@@ -5,15 +5,20 @@ module Saorin
   end
 
   class RPCError < Error
-    attr_reader :code
+    attr_reader :code, :data
 
-    def initialize(code, message)
-      @code = code
+    def initialize(message, options = {})
       super message
+      @code = options[:code]
+      @data = options[:data]
     end
 
     def to_h
-      {'code' => code, 'message' => message}
+      h = {}
+      h['code'] = code
+      h['message'] = message
+      h['data'] = data if data
+      h
     end
 
     def to_json(*args)
@@ -41,23 +46,29 @@ module Saorin
   JSON_RPC_ERRORS.each do |code, name, message|
     class_eval <<-EOS
       class #{name} < RPCError
-        def initialize
-          super #{code}, '#{message}'
+        def initialize(message = nil, options = {})
+          options[:code] = #{code}
+          super message || '#{message}', options
         end
       end
     EOS
   end
 
   class ServerError < RPCError
-    def initialize(e, code = -32000)
-      super code, e.to_s
+    def initialize(message, options = {})
+      options[:code] ||= -32000
+      super message, options
     end
   end
 
   class << self
     def code_to_error(code)
-      @map ||= Hash[JSON_RPC_ERRORS.map { |c, n, m| [c, const_get(n)] }]
-      @map[code]
+      if (-32099..-32000).include?(code)
+        ServerError
+      else
+        @map ||= Hash[JSON_RPC_ERRORS.map { |c, n, m| [c, const_get(n)] }]
+        @map[code]
+      end
     end
   end
 

data/lib/saorin/request.rb

@@ -1,16 +1,22 @@
 require 'saorin'
 require 'saorin/error'
+require 'saorin/utility'
 require 'multi_json'
 
 module Saorin
   class Request
     attr_accessor :version, :method, :params, :id
 
-    def initialize(method, params, id = nil, version = Saorin::JSON_RPC_VERSION)
-      @version = version
+    def initialize(method, params, options = {})
+      @version = options[:version] || Saorin::JSON_RPC_VERSION
       @method = method
       @params = params
-      @id = id
+      @id = options[:id]
+      @notify = !options.has_key?(:id)
+    end
+
+    def notify?
+      @notify
     end
 
     def valid?
@@ -33,7 +39,7 @@ module Saorin
       h['jsonrpc'] = @version
       h['method'] = @method
       h['params'] = @params if @params && !@params.empty?
-      h['id'] = @id
+      h['id'] = @id unless notify?
       h
     end
 
@@ -42,9 +48,20 @@ module Saorin
       MultiJson.dump to_h, options
     end
 
+    def self.symbolized_keys(hash)
+      hash.each do |k, v|
+        if k.is_a? ::String
+          hash[k.to_sym] = v
+        end
+      end
+    end
+
     def self.from_hash(hash)
       raise Saorin::InvalidRequest unless hash.is_a?(::Hash)
-      new *hash.values_at('method', 'params', 'id', 'jsonrpc')
+      options = hash.dup
+      method = options.delete('method')
+      params = options.delete('params')
+      new method, params, Saorin::Utility.symbolized_keys(options)
     end
   end
 end

data/lib/saorin/response.rb

@@ -1,16 +1,17 @@
 require 'saorin'
 require 'saorin/error'
+require 'saorin/utility'
 require 'multi_json'
 
 module Saorin
   class Response
     attr_accessor :version, :result, :error, :id
 
-    def initialize(result, error, id = nil, version = Saorin::JSON_RPC_VERSION)
-      @version = version
-      @result = result
-      @error = error
-      @id = id
+    def initialize(options = {})
+      @version = options[:version] || Saorin::JSON_RPC_VERSION
+      @result = options[:result]
+      @error = options[:error]
+      @id = options[:id]
     end
 
     def error?
@@ -20,7 +21,7 @@ module Saorin
     def valid?
       return false unless !(@result && @error)
       return false unless [String].any? { |type| @version.is_a? type }
-      return false unless [String, NilClass].any? { |type| @result.is_a? type }
+      return false unless [Object].any? { |type| @result.is_a? type }
       return false unless [Saorin::Error, Hash, NilClass].any? { |type| @error.is_a? type }
       return false unless [String, Numeric, NilClass].any? { |type| @id.is_a? type }
       return false unless @version == JSON_RPC_VERSION
@@ -47,7 +48,7 @@ module Saorin
 
     def self.from_hash(hash)
       raise Saorin::InvalidResponse unless hash.is_a?(::Hash)
-      new *hash.values_at('result', 'error', 'id', 'jsonrpc')
+      new Saorin::Utility.symbolized_keys(hash)
     end
   end
 end

data/lib/saorin/test.rb

@@ -0,0 +1,128 @@
+require 'saorin/server'
+require 'saorin/client'
+require 'thread'
+require 'logger'
+require 'rspec'
+
+module Saorin
+  module Test
+    class Handler
+      def identity(value)
+        value
+      end
+
+      def subtract1(a, b)
+        a - b
+      end
+
+      def subtract2(options)
+        options['minuend'] - options['subtrahend']
+      end
+
+      def update(a, b, c, d, e)
+        'OK'
+      end
+
+      def sum(a, b, c)
+        a + b + c
+      end
+
+      def notify_hello(a)
+        'OK'
+      end
+
+      def get_data
+        ['hello', 5]
+      end
+
+      def notify_sum(a, b, c)
+        a + b + c
+      end
+    end
+
+    HOST = '127.0.0.1'
+    PORT = 45339
+
+    attr_reader :pid
+    attr_reader :server
+    attr_reader :client
+
+    def create_test_server(options = {})
+      @pid = Process.fork do
+        @server = Saorin::Server.start(Handler.new, {
+          :host => HOST,
+          :port => PORT,
+          :Logger => Logger.new('/dev/null'),
+          :AccessLog => [],
+        }.merge(options))
+      end
+      sleep 3
+    end
+
+    def shutdown_test_server
+      Process.kill :INT, @pid
+      sleep 3
+    end
+
+    def create_test_client(options = {})
+      @client = Saorin::Client.new({
+        :url => "http://127.0.0.1:#{PORT}"
+      }.merge(options))
+    end
+
+    def test_call(*args)
+      @client.call *args
+    end
+
+    def test_notify(*args)
+      @client.notify *args
+    end
+
+    shared_context 'setup rpc server client' do
+      let(:server_adapter) {}
+      let(:client_adapter) {}
+      before(:all) do
+        create_test_server :adapter => server_adapter
+        create_test_client :adapter => client_adapter
+      end
+      after(:all) do
+        shutdown_test_server
+      end
+    end
+
+    shared_examples 'rpc server client' do
+      it 'string' do
+        value = '123'
+        test_call('identity', value).should eq value
+      end
+
+      it 'number' do
+        value = 123
+        test_call('identity', value).should eq value
+      end
+
+      it 'array' do
+        value = [1, 2, 3]
+        test_call('identity', value).should eq value
+      end
+
+      it 'hash' do
+        value = {'foo' => 1, 'bar' => 2}
+        test_call('identity', value).should eq value
+      end
+
+      it 'nil' do
+        value = nil
+        test_call('identity', value).should eq value
+      end
+
+      it 'not found' do
+        lambda { test_call('xxx') }.should raise_error MethodNotFound
+      end
+
+      it 'invalid params' do
+        lambda { test_call('identity', 1, 2, 3, 4, 5) }.should raise_error InvalidParams
+      end
+    end
+  end
+end

data/lib/saorin/utility.rb

@@ -0,0 +1,15 @@
+module Saorin
+  module Utility
+    class << self
+      def symbolized_keys(hash)
+        hash = hash.dup
+        hash.keys.each do |key|
+          if key.is_a?(::String)
+            hash[key.to_sym] = hash.delete(key)
+          end
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/saorin/version.rb

@@ -1,3 +1,3 @@
 module Saorin
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/saorin.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'multi_json'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack'
+  gem.add_development_dependency 'reel'
+  gem.add_development_dependency 'faraday'
 end

data/server.rb

@@ -4,7 +4,7 @@ require 'saorin'
 
 class Handler
   def log(tag, time, record)
-    puts [tag, time, record]
+    p [tag, time, record]
     nil
   end
 end

data/spec/adapter/base_spec.rb

@@ -4,7 +4,7 @@ require 'saorin/adapters/servers/base'
 describe Saorin::Adapters::Servers::Base do
   it_should_behave_like 'rpc call' do
     let(:process) do
-      handler = Handler.new
+      handler = Saorin::Test::Handler.new
       server = Saorin::Adapters::Servers::Base.new handler
       proc do |input|
         server.process_request input

data/spec/adapter/servers/rack_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'saorin/test'
+require 'saorin/adapters/servers/rack'
+
+describe Saorin::Adapters::Servers::Rack do
+  include Saorin::Test
+
+  let(:server_adapter) { :rack }
+  include_context 'setup rpc server client'
+  it_should_behave_like 'rpc server client'
+end

data/spec/adapter/servers/reel_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'saorin/test'
+require 'saorin/adapters/servers/reel'
+
+describe Saorin::Adapters::Servers::Reel do
+  include Saorin::Test
+
+  let(:server_adapter) { :reel }
+  include_context 'setup rpc server client'
+  it_should_behave_like 'rpc server client'
+end

data/spec/request_spec.rb

@@ -9,7 +9,9 @@ describe Saorin::Request do
       :id => rand(1 << 31),
     }
     options = default_options.merge(options)
-    Saorin::Request.new *options.values_at(:method, :params, :id, :version)
+    method = options.delete(:method)
+    params = options.delete(:params)
+    Saorin::Request.new method, params, options
   end
 
   describe '#initialize' do

data/spec/response_spec.rb

@@ -9,12 +9,12 @@ describe Saorin::Response do
       :id => rand(1 << 31),
     }
     options = default_options.merge(options)
-    Saorin::Response.new *options.values_at(:result, :error, :id, :version)
+    Saorin::Response.new options
   end
 
   describe '#initialize' do
     context 'success' do
-      before { @r = create_response :result => '123', :error => nil, :id => 123 }
+      before { @r = Saorin::Response.new :result => '123', :id => 123 }
       subject { @r }
       its(:version) { should eq Saorin::JSON_RPC_VERSION }
       its(:result) { should eq '123' }
@@ -23,10 +23,10 @@ describe Saorin::Response do
       its(:error?) { should be_false }
     end
 
-    context 'fail' do
+    context 'error' do
       before do
         @e = Saorin::InvalidRequest.new
-        @r = create_response :result => nil, :error => @e, :id => 123
+        @r = Saorin::Response.new :error => @e, :id => 123
       end
       subject { @r }
       its(:version) { should eq Saorin::JSON_RPC_VERSION }
@@ -44,21 +44,28 @@ describe Saorin::Response do
       create_response(:version => 2).should_not be_valid
     end
 
-    it 'result / error' do
-      create_response(:error => nil, :result => 123).should_not be_valid
-      create_response(:error => nil, :result => '123').should be_valid
-      create_response(:error => nil, :result => []).should_not be_valid
-      create_response(:error => nil, :result => {}).should_not be_valid
+    context 'result' do
+      def create_success_response(result)
+        create_response(:result => result, :error => nil)
+      end
+
+      it('number') { create_success_response(123).should be_valid }
+      it('string') { create_success_response('123').should be_valid }
+      it('nil') { create_success_response(nil).should be_valid }
+      it('array') { create_success_response([]).should be_valid }
+      it('hash') { create_success_response({}).should be_valid }
+    end
 
-      create_response(:result => nil, :error => 123).should_not be_valid
-      create_response(:result => nil, :error => '123').should_not be_valid
-      create_response(:result => nil, :error => nil).should_not be_valid
-      create_response(:result => nil, :error => []).should_not be_valid
-      create_response(:result => nil, :error => {}).should be_valid
-      create_response(:result => nil, :error => Saorin::InvalidResponse.new).should be_valid
+    context 'error' do
+      def create_fail_response(error)
+        create_response(:result => nil, :error => error)
+      end
 
-      create_response(:error => nil, :result => nil).should_not be_valid
-      create_response(:error => 123, :result => 123).should_not be_valid
+      it('number') { create_fail_response(123).should_not be_valid }
+      it('string') { create_fail_response('123').should_not be_valid }
+      it('array') { create_fail_response([]).should_not be_valid }
+      it('hash') { create_fail_response({}).should be_valid }
+      it('exception') { create_fail_response(Saorin::InvalidResponse.new).should be_valid }
     end
 
     it 'id' do
@@ -95,7 +102,7 @@ describe Saorin::Response do
       h.should_not include('result')
       h.should include('error')
     end
-    it 'fail' do
+    it 'error' do
       h = create_response(:error => nil).to_h
       h.should include('result')
       h.should_not include('error')

data/spec/support/{shared_examples.rb → rpc_call.rb}

@@ -1,55 +1,6 @@
+require 'support/utils'
 require 'json'
 
-class Handler
-  def subtract1(a, b)
-    a - b
-  end
-
-  def subtract2(options)
-    options['minuend'] - options['subtrahend']
-  end
-
-  def update(a, b, c, d, e)
-    'OK'
-  end
-
-  def foobar1
-    'OK'
-  end
-  
-  def foobar3(a, b)
-    'OK'
-  end
-
-  def sum(a, b, c)
-    a + b + c
-  end
-
-  def notify_hello(a)
-    'OK'
-  end
-
-  def get_data
-    ['hello', 5]
-  end
-
-  def notify_sum(a, b, c)
-    a + b + c
-  end
-end
-
-def deserialize(data)
-  data && JSON.load(data)
-end
-
-def validates(process, inputs, answers)
-  inputs.zip(answers).each do |input, answer|
-    output = deserialize process.call(input)
-    answer = deserialize answer
-    output.should eq answer
-  end
-end
-
 shared_examples 'rpc call with positional parameters' do
   it 'rpc call with positional parameters' do
     inputs  << %({"jsonrpc": "2.0", "method": "subtract1", "params": [42, 23], "id": 1})
@@ -74,7 +25,7 @@ shared_examples 'a Notification' do
   it 'a Notification' do
     inputs  << %({"jsonrpc": "2.0", "method": "update", "params": [1,2,3,4,5]})
     answers << nil
-    inputs  << %({"jsonrpc": "2.0", "method": "foobar1"})
+    inputs  << %({"jsonrpc": "2.0", "method": "foobar"})
     answers << nil
     validates process, inputs, answers
   end
@@ -82,7 +33,7 @@ end
 
 shared_examples 'rpc call of non-existent method' do
   it 'rpc call of non-existent method' do
-    inputs  << %({"jsonrpc": "2.0", "method": "foobar2", "id": "1"})
+    inputs  << %({"jsonrpc": "2.0", "method": "foobar", "id": "1"})
     answers << %({"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found"}, "id": "1"})
     validates process, inputs, answers
   end
@@ -90,7 +41,7 @@ end
 
 shared_examples 'rpc call with invalid JSON' do
   it 'rpc call with invalid JSON' do
-    inputs  << %({"jsonrpc": "2.0", "method": "foobar3, "params": "bar", "baz])
+    inputs  << %({"jsonrpc": "2.0", "method": "foobar, "params": "bar", "baz])
     answers << %({"jsonrpc": "2.0", "error": {"code": -32700, "message": "Parse error"}, "id": null})
     validates process, inputs, answers
   end

data/spec/support/utils.rb

@@ -0,0 +1,13 @@
+require 'saorin/test'
+
+def deserialize(data)
+  data && JSON.load(data)
+end
+
+def validates(process, inputs, answers)
+  inputs.zip(answers).each do |input, answer|
+    output = deserialize process.call(input)
+    answer = deserialize answer
+    output.should eq answer
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saorin
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -59,6 +59,54 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: JSON-RPC 2.0 implementation
 email:
 - mail@mashiro.org
@@ -87,14 +135,19 @@ files:
 - lib/saorin/request.rb
 - lib/saorin/response.rb
 - lib/saorin/server.rb
+- lib/saorin/test.rb
+- lib/saorin/utility.rb
 - lib/saorin/version.rb
 - saorin.gemspec
 - server.rb
 - spec/adapter/base_spec.rb
+- spec/adapter/servers/rack_spec.rb
+- spec/adapter/servers/reel_spec.rb
 - spec/request_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_examples.rb
+- spec/support/rpc_call.rb
+- spec/support/utils.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -109,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2090599809932543204
+      hash: -2145368172034945708
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -118,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2090599809932543204
+      hash: -2145368172034945708
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -127,7 +180,10 @@ specification_version: 3
 summary: JSON-RPC 2.0 server and client implementation for any protocols
 test_files:
 - spec/adapter/base_spec.rb
+- spec/adapter/servers/rack_spec.rb
+- spec/adapter/servers/reel_spec.rb
 - spec/request_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_examples.rb
+- spec/support/rpc_call.rb
+- spec/support/utils.rb