jsonrpc2 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb244988f3e6da4bd9e07cb696ae0527dc60c5ec
+  data.tar.gz: 8b378af79f04b2603d6ac7ad669918bb9e055962
+SHA512:
+  metadata.gz: 8ec025d776da30ad4251511f1907cad21fe1dc76580a907113417fe7e658de63435ec67976b96488c02b41806ab794452e1aad695769cb60059fc9d6dc35ceb7
+  data.tar.gz: 0f7017e7d77711638377d340d7aae1a6355ddca9b40a0ec7e0218c16dd31bc33a364a7e07acdcf10b9a991c1465987bda927fae0c0cb90c245028ebeb38fc8f3

data/README.markdown

@@ -4,6 +4,9 @@ A Rack compatible, documenting JSON-RPC 2 DSL/server implementation for ruby.
 
 ## Changes
 
+* 0.1.1 - 4-Jan-2013
+  Improve logging of exceptions / failure
+
 * 0.1.0 - 4-Jan-2013
   Turn on timing & logging of all requests
 

data/example/config.ru

@@ -13,6 +13,7 @@ class ::Object::Calculator < JSONRPC2::Interface
       param 'b', 'Number', 'b'
       result 'Number', 'a * b'
       def mul
+        raise JSONRPC2::KnownError, [123, "Don't like negative numbers", params] if params['a'] < 0 or params['b'] < 0
         params['a'] * params['b']
       end
 

data/lib/jsonrpc2/interface.rb

@@ -61,6 +61,7 @@ class Interface
     # @param [Hash] environment Rack environment hash
     # @return [Array<Fixnum, Hash<String,String>, Array<String>>] Rack-compatible response
     def call(environment)
+      environment['json.request-id'] = Digest::MD5.hexdigest("#{$host ||= Socket.gethostname}-#{$$}-#{Time.now.to_f}")[0,8]
       request = Rack::Request.new(environment)
       catch :rack_response do
         best = JSONRPC2::HTTPUtils.which(environment['HTTP_ACCEPT'], %w[text/html application/json-rpc application/json])
@@ -84,8 +85,8 @@ class Interface
       end
 
     rescue Exception => e
-      if env['rack.logger'].respond_to?(:error)
-        env['rack.logger'].error "#{e.class}: #{e.message} - #{e.backtrace * "\n    "}"
+      if environment['rack.logger'].respond_to?(:error)
+        environment['rack.logger'].error "#{e.class}: #{e.message} - #{e.backtrace * "\n    "}"
       end
       raise e.class, e.message, e.backtrace
     end
@@ -99,13 +100,13 @@ class Interface
         else
           auth = env["HTTP_AUTHORIZATION"]
         end
-        env['rack.logger'].info("[#{Time.now.strftime('%d/%m/%Y %H:%M:%S')}] [JSON-RPC2] #{env['REQUEST_URI']} - Auth: #{auth}, Data: #{data.inspect}")
+        env['rack.logger'].info("[JSON-RPC2] #{env['json.request-id']} #{env['REQUEST_URI']} - Auth: #{auth}, Data: #{data.is_a?(String) ? data : data.inspect}")
       end
       t = Time.now.to_f
       return yield
     ensure
       if env['rack.logger'].respond_to?(:info)
-        env['rack.logger'].info("[#{Time.now.strftime('%d/%m/%Y %H:%M:%S')}] [JSON-RPC2] Completed in #{'%.3f' % ((Time.now.to_f - t) * 1000)}ms")
+        env['rack.logger'].info("[JSON-RPC2] #{env['json.request-id']} Completed in #{'%.3f' % ((Time.now.to_f - t) * 1000)}ms#{ $! ? " - exception = #{$!.class}:#{$!.message}" : "" }")
       end
     end
 
@@ -133,12 +134,14 @@ class Interface
   # @param [Hash,Array] rpc_data Array of calls or Hash containing one call
   # @return [Hash,Array] Depends on input, but either a hash result or an array of results corresponding to calls.
   def dispatch(rpc_data)
-    case rpc_data
+    result = case rpc_data
     when Array
-      rpc_data.map { |rpc| dispatch_single(rpc) }.to_json
+      rpc_data.map { |rpc| dispatch_single(rpc) }
     else
-      dispatch_single(rpc_data).to_json
+      dispatch_single(rpc_data)
     end
+
+    return result.to_json
   end
 
   protected
@@ -162,17 +165,32 @@ class Interface
   def request
     @_jsonrpc_request
   end
+  def env
+    @_jsonrpc_env
+  end
 
   # Logger
   def logger
-    @_jsonrpc_logger ||= (request['rack.logger'] || Rack::NullLogger.new("null"))
+    @_jsonrpc_logger ||= (@_jsonrpc_env['rack.logger'] || Rack::NullLogger.new("null"))
   end
   # Check call validity and authentication & make a single method call
   #
   # @param [Hash] rpc JSON-RPC-2 call
   def dispatch_single(rpc)
     t = Time.now.to_f
-    logger.info("[JSON-RPC2] Call #{rpc.inspect}\n")
+
+    result = _dispatch_single(rpc)
+
+    if result['result']
+      logger.info("[JSON-RPC2] #{env['json.request-id']} Call completed OK in #{'%.3f' % ((Time.now.to_f - t) * 1000)}ms")
+    elsif result['error']
+      logger.info("[JSON-RPC2] #{env['json.request-id']} Call to ##{rpc['method']} failed in #{'%.3f' % ((Time.now.to_f - t) * 1000)}ms with error #{result['error']['code']} - #{result['error']['message']}")
+    end
+
+    result
+  end
+  def _dispatch_single(rpc)
+    t = Time.now.to_f
     unless rpc.has_key?('id') && rpc.has_key?('method') && rpc['jsonrpc'].eql?('2.0')
       return response_error(-32600, 'Invalid request', nil)
     end
@@ -191,10 +209,10 @@ class Interface
     rescue KnownError => e
       response_error(e.code, e.message, e.data) # XXX: Change me
     rescue Exception => e
+      logger.error("#{env['json.request-id']} Internal error calling #{rpc.inspect} - #{e.class}: #{e.message} #{e.backtrace.join("\n    ")}") if logger.respond_to?(:error)
       response_error(-32000, "#{e.class}: #{e.message}", e.backtrace) # XXX: Change me
+    else
     end
-  ensure
-    logger.info("[JSON-RPC2] Call completed in #{'%.3f' % ((Time.now.to_f - t) * 1000)}ms\n")
   end
   # List API methods
   #

data/lib/jsonrpc2/version.rb

@@ -1,5 +1,5 @@
 # JSONRPC2 namespace module
 module JSONRPC2
   # Version
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,124 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jsonrpc2
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Geoff Youngs
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-01-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httpclient
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   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 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: RedCloth
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: thor
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-description: |+
-  == Description
-  
-  A Rack compatible JSON-RPC2 server domain specific language (DSL) - allows JSONRPC APIs to be 
-  defined as mountable Rack applications with inline documentation, authentication and type checking.
-  
-  e.g.
-  
-    class Calculator < JSONRPC2::Interface
-      title "JSON-RPC2 Calculator"
-      introduction "This interface allows basic maths calculations via JSON-RPC2"
-      auth_with JSONRPC2::BasicAuth.new({'user' => 'secretword'})
-  
-      section 'Simple Ops' do
-          desc 'Multiply two numbers'
-          param 'a', 'Number', 'a'
-          param 'b', 'Number', 'b'
-          result 'Number', 'a * b'
-          def mul args
-            args['a'] * args['b']
-          end
-  
-          desc 'Add numbers'
-          example "Calculate 1 + 1 = 2", :params => { 'a' => 1, 'b' => 1}, :result => 2
-  
-          param 'a', 'Number', 'First number'
-          param 'b', 'Number', 'Second number'
-          optional 'c', 'Number', 'Third number'
-          result 'Number', 'a + b + c'
-          def sum args
-            val = args['a'] + args['b']
-            val += args['c'] if args['c']
-            val
-          end
-      end
-    end
-  
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "== Description\n\nA Rack compatible JSON-RPC2 server domain specific
+  language (DSL) - allows JSONRPC APIs to be \ndefined as mountable Rack applications
+  with inline documentation, authentication and type checking.\n\ne.g.\n\n  class
+  Calculator < JSONRPC2::Interface\n    title \"JSON-RPC2 Calculator\"\n    introduction
+  \"This interface allows basic maths calculations via JSON-RPC2\"\n    auth_with
+  JSONRPC2::BasicAuth.new({'user' => 'secretword'})\n\n    section 'Simple Ops' do\n
+  \       desc 'Multiply two numbers'\n        param 'a', 'Number', 'a'\n        param
+  'b', 'Number', 'b'\n        result 'Number', 'a * b'\n        def mul args\n          args['a']
+  * args['b']\n        end\n\n        desc 'Add numbers'\n        example \"Calculate
+  1 + 1 = 2\", :params => { 'a' => 1, 'b' => 1}, :result => 2\n\n        param 'a',
+  'Number', 'First number'\n        param 'b', 'Number', 'Second number'\n        optional
+  'c', 'Number', 'Third number'\n        result 'Number', 'a + b + c'\n        def
+  sum args\n          val = args['a'] + args['b']\n          val += args['c'] if args['c']\n
+  \         val\n        end\n    end\n  end\n\n"
+email:
 - git@intersect-uk.co.uk
-executables: 
+executables:
 - jsonrpc2
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.markdown
@@ -145,37 +113,25 @@ files:
 - test/test_types.rb
 homepage: http://github.com/geoffyoungs/jsonrpc2
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+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: 1.8.15
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: JSON-RPC2 server DSL
 test_files: []
-
-has_rdoc: