json-rpc-objects 0.1.0

data/lib/json-rpc-objects/v11/generic-types.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+    
+        ##
+        # Module for special generic types as they are defined 
+        # in JSON-RPC 1.1.
+        #
+        
+        module GenericTypes
+
+            ##
+            # Class which means "any type of JSON data", so
+            # "Boolean, Number, String, Array or Object".
+            #
+            # @abstract
+            #
+        
+            class Any
+            end
+            
+            ##
+            # Class which means classical nil. Nil in code means
+            # type isn't defined, so this class is necessary.
+            #
+            # @abstract
+            #
+            
+            class Nil
+            end
+            
+            ##
+            # Class which means Boolean, so true or false.
+            # @abstract
+            #
+            
+            class Boolean
+            end
+            
+        end
+    end
+end

data/lib/json-rpc-objects/v11/wd/error.rb

@@ -0,0 +1,172 @@
+# encoding: utf-8
+require "hash-utils/numeric"
+require "json-rpc-objects/generic"
+require "json-rpc-objects/v11/wd/extensions"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+        
+        ##
+        # Module of Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+        
+            ##
+            # Error description object class for ProcedureReturn.
+            #
+            
+            class Error < JsonRpcObjects::Generic::Object
+            
+                include Extensions
+
+                ##
+                # Holds link to its version module.
+                #
+                
+                VERSION = JsonRpcObjects::V11::WD
+                            
+                ##
+                # Indicates data member name.
+                #
+                
+                DATA_MEMBER_NAME = :error
+            
+                ##
+                # Holds error code.
+                #
+                
+                @code
+                attr_accessor :code
+                
+                ##
+                # Holds error message.
+                #
+                
+                @message
+                attr_accessor :message
+                
+                ##
+                # Holds error data.
+                #
+                
+                @data
+                attr_accessor :data
+
+                ##
+                # Creates new one.
+                #
+                # @param [Numeric] code od the error
+                # @param [String, Exception] message of the error or 
+                #   exception object
+                # @param [Hash] opts additional options
+                # @return [V11::Error] new error object
+                #
+                            
+                def self.create(code, message, opts = { })
+                    data = {
+                        :code => code,
+                    }
+                    
+                    if message.kind_of? Exception
+                        data[:message] = message.message
+                        data[self::DATA_MEMBER_NAME] = message.backtrace
+                    else
+                        data[:message] = message
+                    end
+                    
+                    data.merge! opts
+                    return self::new(data)
+                end
+                
+                ##
+                # Checks correctness of the data.
+                #
+                
+                def check!
+                    self.normalize!
+
+                    if not @code.in? 100..999
+                        raise Exception::new("Code must be between 100 and 999 including them.")
+                    end
+                end
+
+                ##
+                # Renders data to output hash.
+                # @return [Hash] with data of error
+                #
+                
+                def output
+                    self.check!
+                    data = {
+                        :name => :JSONRPCError,
+                        :code => @code,
+                        :message => @message
+                    }
+                    
+                    if not @error.nil?
+                        data[:error] = @data
+                    end
+                    
+                    data.merge! @extensions
+                    return data
+                end
+                                
+                    
+                protected
+                
+                ##
+                # Assigns data.
+                #
+                
+                def data=(value, mode = nil)            
+                    data = __convert_data(value, mode)
+                 
+                    @code = data[:code]
+                    @message = data[:message]
+                    
+                    data.delete(:code)
+                    data.delete(:message)
+                    
+                    __assign_data(data)
+                    
+                    # Extensions
+                    @extensions = data
+                end
+                
+                ##
+                # Converts request data to standard (defined) format.
+                #
+                
+                def normalize!
+                    @message = @message.to_s
+                    @code = @code.to_i
+                    
+                    if @extensions.nil?
+                        @extensions = { }
+                    end
+                end
+                
+                ##
+                # Assigns error data.
+                #
+                
+                def __assign_data(data)
+                    @data = data[:error]
+                    data.delete(:error)
+                end
+
+            end
+        end
+    end
+end

data/lib/json-rpc-objects/v11/wd/extensions.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+    
+        ##
+        # Module of Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+            
+            ##
+            # Module for extension support in JSON-RPC 1.1 WD.
+            #
+            
+            module Extensions
+                   
+                ##
+                # Holds extensions.
+                #
+                
+                @extensions
+                attr_accessor :extensions
+                
+                ##
+                # Handles method missing call for extensions.
+                #
+                # @param [Symbol] name of the method, setter if ends with '='
+                # @param [Object] value for set
+                # @return [Object] value set or get
+                #
+                
+                def method_missing(name, *args)
+                    if name.to_s[-1].chr == ?=
+                        self[name.to_s[0..-2]] = args.first
+                    else
+                        self[name]
+                    end
+                end
+                
+                ##
+                # Handles array access as access for extensions too.
+                #
+                # @param [String] name of extension for return
+                # @return [Object] value of extension member
+                #
+                
+                def [](name)
+                    @extensions[name.to_sym]
+                end
+                
+                ##
+                # Handles array set to extensions.
+                #
+                # @param [String] name of extension for set
+                # @param[Object] value of extension for set
+                #
+                
+                def []=(name, value)
+                    @extensions[name.to_sym] = value
+                end
+
+            end
+        end
+    end
+end

data/lib/json-rpc-objects/v11/wd/fakes/request.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require "json-rpc-objects/v11/wd/procedure-call"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+        
+        ##
+        # Module of Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+                
+            ##
+            # Fake procedure call (request) class.
+            #
+            
+            class Request < JsonRpcObjects::V11::WD::ProcedureCall
+            end
+            
+        end
+    end
+end
+

data/lib/json-rpc-objects/v11/wd/fakes/response.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require "json-rpc-objects/v11/wd/procedure-return"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+        
+        ##
+        # Module of Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+                
+            ##
+            # Fake procedure return (response) class.
+            #
+            
+            class Response < JsonRpcObjects::V11::WD::ProcedureReturn
+            end
+            
+        end
+    end
+end
+

data/lib/json-rpc-objects/v11/wd/procedure-call.rb

@@ -0,0 +1,205 @@
+# encoding: utf-8
+require "hash-utils/hash"
+require "json-rpc-objects/v10/request"
+require "json-rpc-objects/v11/wd/extensions"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # General module of JSON-RPC 1.1.
+    #
+
+    module V11
+        
+        ##
+        # Module of Working Draft.
+        # @see http://json-rpc.org/wd/JSON-RPC-1-1-WD-20060807.html
+        #
+        
+        module WD
+                
+            ##
+            # Procedure call (request) class.
+            #
+            
+            class ProcedureCall < JsonRpcObjects::V10::Request
+            
+                include Extensions
+
+                ##
+                # Holds link to its version module.
+                #
+                
+                VERSION = JsonRpcObjects::V11::WD
+                
+                ##
+                # Holds JSON-RPC version specification.
+                #
+                
+                VERSION_NUMBER = :"1.1"
+                
+                ##
+                # Holds JSON-RPC version member identification.
+                #
+                
+                VERSION_MEMBER = :version
+                
+                ##
+                # Holds keyword parameters.
+                #
+                
+                @keyword_parameters
+                attr_accessor :keyword_parameters
+                
+                ##
+                # Checks correctness of the request data.
+                #
+                
+                def check!
+                    super()
+                    
+                    if not @keyword_params.nil? and not @keyword_params.kind_of? Hash
+                        raise Exception::new("Keyword params must be Hash.")
+                    end
+                end
+                
+                
+                ##
+                # Renders data to output hash.
+                # @return [Hash] with data of call
+                #
+                
+                def output
+                    self.check!
+                    
+                    data = { }
+
+                    # Version
+                    __assign_version(data)
+                    
+                    # Method
+                    data[:method] = @method.to_s
+                    
+                    # Params
+                    __assign_params(data)
+                    
+                    # ID
+                    if not @id.nil?
+                        data[:id] = @id
+                    end
+                    
+                    data.merge! @extensions                
+                    return data
+                end
+                
+                
+                protected
+                
+                ##
+                # Assigns request data.
+                #
+
+                def data=(value, mode = nil)
+                    data = __convert_data(value, mode)
+                    super(data, :converted)
+                    
+                    # Params
+                    __get_params(data)
+                    
+                    data.delete(:method)
+                    data.delete(:params)
+                    data.delete(:id)
+                    
+                    __delete_version(data)
+                    
+                    # Extensions
+                    @extensions = data
+                end            
+                
+                ##
+                # Converts request data to standard (defined) format.
+                #
+                
+                def normalize!
+                    __normalize_method
+                    
+                    if @extensions.nil?
+                        @extensions = { }
+                    end
+                end
+
+                ##
+                # Gets params from input.
+                #
+                
+                def __get_params(data)
+                
+                    # If named arguments used, assigns keys as symbols
+                    #   but keeps numeric arguments as integers
+                    
+                    if @params.kind_of? Hash
+                        @params = @params.dup
+                        @keyword_params = @params.remove! { |k, v| not k.numeric? }
+                        @params = @params.sort_by { |i| i[0].to_i }.map { |i| i[1] }
+                    else
+                        @keyword_params = { }
+                    end
+                    
+                    @keyword_params.map_keys! { |k| k.to_sym }
+                    
+                end
+                
+                ##
+                # Assigns the parameters settings.
+                #
+                
+                def __assign_params(data)
+                    params = { }
+                    
+                    if not @params.nil?
+                        @params.each_index do |i|
+                            params[i.to_s.to_sym] = @params[i]
+                        end
+                    end
+                    if not @keyword_params.nil?
+                        params.merge! @keyword_params
+                    end
+                
+                    data[:params] = params
+                end
+                            
+                ##
+                # Checks params data.
+                #
+                
+                def __check_params
+                    if not @params.nil? and not @params.kind_of? Array
+                        raise Exception::new("Params must be Array.")
+                    end
+                end
+                
+                ##
+                # Assignes the version specification.
+                #
+                
+                def __assign_version(data)
+                    data[self.class::VERSION_MEMBER] = self.class::VERSION_NUMBER
+                end
+                
+                ##
+                # Removes the version specification.
+                #
+                
+                def __delete_version(data)
+                    data.delete(self.class::VERSION_MEMBER)
+                end
+                
+            end
+        end
+    end
+end
+