jsonrpc2 0.0.7 → 0.0.8

data/README.markdown

@@ -2,6 +2,22 @@
 
 A Rack compatible, documenting JSON-RPC 2 DSL/server implementation for ruby.
 
+## Changes
+
+* 0.0.8 - 3-Sep-2012
+  Add #request to access Rack::Request object
+  Make URLs in HTML interface clickable
+
+* 0.0.7 - 27-Aug-2012
+  Add bundled Bootstrap assets for HTML test interface
+
+* 0.0.6 - 24-Aug-2012
+  Add Date/Time/DateTime as special string types with regex checks for validation
+
+* 0.0.5 - 19-Jul-2012
+  Add commandline client jsonrpc2
+  Add #auth to access currently authenticated username
+
 ## Features
 
 * Inline documentation

data/lib/jsonrpc2/html.rb

@@ -167,9 +167,12 @@ EOS
   end
   # Format JSON result
   def format_result(result)
-    CGI.escapeHTML(JSON.pretty_unparse(JSON.parse(result)))
-  rescue Exception
-    result
+    CGI.escapeHTML(JSON.pretty_unparse(JSON.parse(result))).gsub(%r<("|&quot;)https?://[^"]+?("|&quot;)>) do |str|
+      url = CGI.unescapeHTML(str)[1...-1]
+       %Q["<a href="#{CGI.escapeHTML(url)}">#{CGI.escapeHTML(url)}</a>"]
+    end
+  rescue Exception => e
+    CGI.escapeHTML(result.to_s)
   end
   end
 end

data/lib/jsonrpc2/interface.rb

@@ -17,7 +17,7 @@ module JSONRPC2
 
 # Base class for JSONRPC2 interface
 class Interface
-	class << self
+  class << self
 
 # @!group Authentication
 
@@ -25,13 +25,13 @@ class Interface
     #
     # @param [#check] args An object that responds to check(environment, json_call_data)
     # @return [#check, nil] Currently set object or nil
-		def auth_with *args
-			if args.empty?
-				return @auth_with
-			else
-				@auth_with = args[0]
-			end
-		end
+    def auth_with *args
+      if args.empty?
+        return @auth_with
+      else
+        @auth_with = args[0]
+      end
+    end
 
 # @!endgroup
 
@@ -66,14 +66,15 @@ class Interface
 
 # @!endgroup
 
-	end
+  end
 
   # Create new interface object
   #
   # @param [Hash] env Rack environment
-	def initialize(env)
-		@env = env
-	end
+  def initialize(env)
+    @_jsonrpc_env = env
+    @_jsonrpc_request = Rack::Request.new(env)
+  end
   # Internal
   def rack_dispatch(rpcData)
     catch(:rack_response) do
@@ -87,54 +88,58 @@ 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
+    case rpc_data
     when Array
-			rpc_data.map { |rpc| dispatch_single(rpc) }.to_json
-		else
-			dispatch_single(rpc_data).to_json
-		end
-	end
+      rpc_data.map { |rpc| dispatch_single(rpc) }.to_json
+    else
+      dispatch_single(rpc_data).to_json
+    end
+  end
 
-	protected
+  protected
   # JSON result helper
-	def response_ok(id, result)
-		{ 'jsonrpc' => '2.0', 'result' => result, 'id' => id }
-	end
+  def response_ok(id, result)
+    { 'jsonrpc' => '2.0', 'result' => result, 'id' => id }
+  end
   # JSON error helper
-	def response_error(code, message, data)
-		{ 'jsonrpc' => '2.0', 'error' => { 'code' => code, 'message' => message, 'data' => data }, 'id' => (@jsonrpc_call && @jsonrpc_call['id'] || nil) }
-	end
+  def response_error(code, message, data)
+    { 'jsonrpc' => '2.0', 'error' => { 'code' => code, 'message' => message, 'data' => data }, 'id' => (@_jsonrpc_call && @_jsonrpc_call['id'] || nil) }
+  end
   # Params helper
   def params
-    @jsonrpc_call['params']
+    @_jsonrpc_call['params']
   end
   # Auth info
   def auth
-    @jsonrpc_auth
+    @_jsonrpc_auth
+  end
+  # Rack::Request
+  def request
+    @_jsonrpc_request
   end
   # Check call validity and authentication & make a single method call
   #
   # @param [Hash] rpc JSON-RPC-2 call
-	def dispatch_single(rpc)
-		unless rpc.has_key?('id') && rpc.has_key?('method') && rpc['jsonrpc'].eql?('2.0')
-			return response_error(-32600, 'Invalid request', nil)
-		end
-    @jsonrpc_call = rpc
-
-		begin
-      if self.class.auth_with && ! @jsonrpc_auth
-        (@jsonrpc_auth = self.class.auth_with.client_check(@env, rpc)) or raise AuthFail, "Invalid credentials"
+  def dispatch_single(rpc)
+    unless rpc.has_key?('id') && rpc.has_key?('method') && rpc['jsonrpc'].eql?('2.0')
+      return response_error(-32600, 'Invalid request', nil)
+    end
+    @_jsonrpc_call = rpc
+
+    begin
+      if self.class.auth_with && ! @_jsonrpc_auth
+        (@_jsonrpc_auth = self.class.auth_with.client_check(@_jsonrpc_env, rpc)) or raise AuthFail, "Invalid credentials"
       end
 
-			call(rpc['method'], rpc['id'], rpc['params'])
-		rescue AuthFail => e
-			response_error(-32000, "AuthFail: #{e.class}: #{e.message}", {}) # XXX: Change me
-	  rescue APIFail => e
-			response_error(-32000, "APIFail: #{e.class}: #{e.message}", {}) # XXX: Change me
-		rescue Exception => e
-			response_error(-32000, "#{e.class}: #{e.message}", e.backtrace) # XXX: Change me
-		end
-	end
+      call(rpc['method'], rpc['id'], rpc['params'])
+    rescue AuthFail => e
+      response_error(-32000, "AuthFail: #{e.class}: #{e.message}", {}) # XXX: Change me
+    rescue APIFail => e
+      response_error(-32000, "APIFail: #{e.class}: #{e.message}", {}) # XXX: Change me
+    rescue Exception => e
+      response_error(-32000, "#{e.class}: #{e.message}", e.backtrace) # XXX: Change me
+    end
+  end
   # List API methods
   #
   # @return [Array] List of api method names
@@ -148,41 +153,41 @@ class Interface
   # @param [Integer] id Method call ID - for response
   # @param [Hash] params Method parameters
   # @return [Hash] JSON response
-	def call(method, id, params)
-		if api_methods.include?(method)
-			begin
-				Types.valid_params?(self.class, method, params)
-			rescue Exception => e
-				return response_error(-32602, "Invalid params - #{e.message}", {})
-			end
+  def call(method, id, params)
+    if api_methods.include?(method)
+      begin
+        Types.valid_params?(self.class, method, params)
+      rescue Exception => e
+        return response_error(-32602, "Invalid params - #{e.message}", {})
+      end
 
       if self.method(method).arity.zero?
-  			result = send(method)
+        result = send(method)
       else
-	  		result = send(method, params)
+        result = send(method, params)
       end
 
-			begin
-				Types.valid_result?(self.class, method, result)
-			rescue Exception => e
-				return response_error(-32602, "Invalid result - #{e.message}", {})
-			end
-				
-			response_ok(id, result)
-		else
-			response_error(-32601, "Unknown method `#{method.inspect}'", {})
-		end
-	end
-
-	class << self
+      begin
+        Types.valid_result?(self.class, method, result)
+      rescue Exception => e
+        return response_error(-32602, "Invalid result - #{e.message}", {})
+      end
+        
+      response_ok(id, result)
+    else
+      response_error(-32601, "Unknown method `#{method.inspect}'", {})
+    end
+  end
+
+  class << self
     # Store parameter in internal hash when building API
-		def ___append_param name, type, options
-			@params ||= []
-			unless options.has_key?(:required)
-				options[:required] = true
-			end
-			@params << options.merge({ :name => name, :type => type })
-		end
+    def ___append_param name, type, options
+      @params ||= []
+      unless options.has_key?(:required)
+        options[:required] = true
+      end
+      @params << options.merge({ :name => name, :type => type })
+    end
     private :___append_param
 
 # @!group DSL
@@ -191,119 +196,119 @@ class Interface
     #
     # @param [String] name parameter name
     # @param [String] type description of type see {Types}
-		def param name, type, desc = nil, options = nil
-			if options.nil? && desc.is_a?(Hash)
-				options, desc = desc, nil
-			end
-			options ||= {}
-			options[:desc] = desc if desc.is_a?(String)
-			
-			___append_param name, type, options
-		end
+    def param name, type, desc = nil, options = nil
+      if options.nil? && desc.is_a?(Hash)
+        options, desc = desc, nil
+      end
+      options ||= {}
+      options[:desc] = desc if desc.is_a?(String)
+      
+      ___append_param name, type, options
+    end
 
     # Define an optional parameter for next method
-		def optional name, type, desc = nil, options = nil
-			if options.nil? && desc.is_a?(Hash)
-				options, desc = desc, nil
-			end
-			options ||= {}
-			options[:desc] = desc if desc.is_a?(String)
+    def optional name, type, desc = nil, options = nil
+      if options.nil? && desc.is_a?(Hash)
+        options, desc = desc, nil
+      end
+      options ||= {}
+      options[:desc] = desc if desc.is_a?(String)
 
-			___append_param(name, type, options.merge(:required => false))
-		end
+      ___append_param(name, type, options.merge(:required => false))
+    end
 
     # Define type of return value for next method
-		def result type, desc = nil
-			@result = { :type => type, :desc => desc }
-		end
+    def result type, desc = nil
+      @result = { :type => type, :desc => desc }
+    end
 
     # Set description for next method
-		def desc str
-			@desc = str
-		end
+    def desc str
+      @desc = str
+    end
 
     # Add an example for next method
-		def example desc, code
-			@examples ||= []
-			@examples << { :desc => desc, :code => code }
-		end
+    def example desc, code
+      @examples ||= []
+      @examples << { :desc => desc, :code => code }
+    end
 
     # Define a custom type
-		def type name, *fields
-			@types ||= {}
-			type = JsonObjectType.new(name, fields)
+    def type name, *fields
+      @types ||= {}
+      type = JsonObjectType.new(name, fields)
 
-			if block_given?
-				yield(type)
-			end
+      if block_given?
+        yield(type)
+      end
 
-			@types[name] = type
-		end
+      @types[name] = type
+    end
 
     # Group methods
-		def section name, summary=nil
-			@sections ||= []
-			@sections << {:name => name, :summary => summary}
-
-			@current_section = name
-			if block_given?
-				yield
-				@current_section = nil
-			end
-		end
+    def section name, summary=nil
+      @sections ||= []
+      @sections << {:name => name, :summary => summary}
+
+      @current_section = name
+      if block_given?
+        yield
+        @current_section = nil
+      end
+    end
 
     # Exclude next method from documentation
-		def nodoc
-			@nodoc = true
-		end
+    def nodoc
+      @nodoc = true
+    end
 
     # Set interface title
-		def title str = nil
-			@title = str if str
-		end
+    def title str = nil
+      @title = str if str
+    end
 
     # Sets introduction for interface
-		def introduction str = nil
-			@introduction = str if str
-		end
+    def introduction str = nil
+      @introduction = str if str
+    end
 
 # @!endgroup
 
     # Catch methods added to class & store documentation
-		def method_added(name)
-			return if self == JSONRPC2::Interface
-			@about ||= {}
-			method = {}
-			method[:params] = @params if @params
-			method[:returns] = @result if @result
-			method[:desc] = @desc if @desc
-			method[:examples] = @examples if @examples
-			
-			if method.empty?
-				if public_methods(false).include?(name)
-					unless @nodoc
-						#logger.info("#{name} has no API documentation... :(")
-					end
-				else
-					#logger.debug("#{name} isn't public - so no API")
-				end
-			else
-				method[:name] = name
-				method[:section] = @current_section
-				method[:index] = @about.size
-				@about[name.to_s] = method
-			end
-
-			@result = nil
-			@params = nil
-			@desc = nil
-			@examples = nil
-			@nodoc = false
-		end
+    def method_added(name)
+      return if self == JSONRPC2::Interface
+      @about ||= {}
+      method = {}
+      method[:params] = @params if @params
+      method[:returns] = @result if @result
+      method[:desc] = @desc if @desc
+      method[:examples] = @examples if @examples
+      
+      if method.empty?
+        if public_methods(false).include?(name)
+          unless @nodoc
+            #logger.info("#{name} has no API documentation... :(")
+          end
+        else
+          #logger.debug("#{name} isn't public - so no API")
+        end
+      else
+        method[:name] = name
+        method[:section] = @current_section
+        method[:index] = @about.size
+        @about[name.to_s] = method
+      end
+
+      @result = nil
+      @params = nil
+      @desc = nil
+      @examples = nil
+      @nodoc = false
+    end
     private :method_added
-		attr_reader :about, :types
+    attr_reader :about, :types
 
-	end
+  end
 
   extend JSONRPC2::TextileEmitter
 end

data/lib/jsonrpc2/version.rb

@@ -1,5 +1,5 @@
 # JSONRPC2 namespace module
 module JSONRPC2
   # Version
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonrpc2
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient