json-rpc-objects 0.1.0

data/lib/json-rpc-objects/request.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+require "json-rpc-objects/v20/request"
+require "yajl/json_gem"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Request module for version detection and universal API.
+    #
+    
+    module Request
+    
+        ##
+        # Parses JSON-RPC string for request and uses differential 
+        # heuristic for detecting the right class.
+        #
+        # Be warn, it's impossible to distinguish JSON-RPC 1.1 Alt
+        # and WD if there aren't keyword parameters in request. So 
+        # requests without them are detected as WD. Set the default 1.1 
+        # version by second argument.
+        #
+        # @param [String] string JSON string for parse
+        # @param [:wd, :alt] default_v11 type of the eventually returned 
+        #   1.1 object
+        #
+        
+        def self.parse(string, default_v11 = :wd)
+            data = JSON.load(string)
+            
+            if not data.kind_of? Hash
+                raise Exception::new("Data in JSON string aren't object.")
+            end
+            
+            data.keys_to_sym!
+            
+            # Detects
+            if data.include? :jsonrpc
+                file = "json-rpc-objects/v20/request"
+                cls = V20::Request
+            elsif data.include? :version
+                if (default_v11 == :alt) or (data.include? :kwparams)
+                    file = "json-rpc-objects/v11/alt/procedure-call"
+                    cls = V11::Alt::ProcedureCall
+                else
+                    file = "json-rpc-objects/v11/wd/procedure-call"
+                    cls = V11::WD::ProcedureCall
+                end
+            else
+                file = "json-rpc-objects/v10/request"
+                cls = V10::Request
+            end
+            
+            # Returns
+            require file
+            return cls::new(data)
+        end
+        
+    
+        ##
+        # Returns request of the latest standard.
+        # 
+        # @param [Array] args for target constructor
+        # @return [JsonRpcObjects::V20::Request]  request object
+        #
+        
+        def self.create(*args)
+            JsonRpcObjects::V20::Request::create(*args)
+        end
+                
+    end
+    
+end

data/lib/json-rpc-objects/response.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require "json-rpc-objects/v20/response"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Request module for version detection and universal API.
+    #
+    
+    module Response
+
+        ##
+        # Parses JSON-RPC string for response and uses differential 
+        # heuristic for detecting the right class.
+        #
+        # Be warn, it's impossible to distinguish JSON-RPC 1.1 Alt
+        # and WD if there aren't error. So responsens without it are 
+        # detected as WD. Set the default 1.1 version by second argument.
+        #
+        # @param [String] string JSON string for parse
+        # @param [:wd, :alt] default_v11 type of the eventually returned 
+        #   1.1 object
+        #
+        
+        def self.parse(string, default_v11 = :wd)
+            data = JSON.load(string)
+            
+            if not data.kind_of? Hash
+                raise Exception::new("Data in JSON string aren't object.")
+            end
+            
+            data.keys_to_sym!
+            
+            # Detects
+            if data.include? :jsonrpc
+                file = "json-rpc-objects/v20/response"
+                cls = V20::Response
+            elsif data.include? :version
+                if (default_v11 == :wd) or ((data.include? :error) and (data[:error].kind_of? Hash) and (data[:error].include? "name"))
+                    file = "json-rpc-objects/v11/wd/procedure-return"
+                    cls = V11::WD::ProcedureReturn
+                else
+                    file = "json-rpc-objects/v11/alt/procedure-return"
+                    cls = V11::Alt::ProcedureReturn
+                end
+            else
+                file = "json-rpc-objects/v10/response"
+                cls = V10::Response
+            end
+            
+            # Returns
+            require file
+            return cls::new(data)
+        end
+            
+        ##
+        # Returns request of the latest standard.
+        # 
+        # @param [Array] args for target constructor
+        # @return [JsonRpcObjects::V20::Response]  response object
+        #
+        
+        def self.create(*args)
+            JsonRpcObjects::V20::Response::create(*args)
+        end
+                
+    end
+    
+end

data/lib/json-rpc-objects/v10/error.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "json-rpc-objects/v10/fakes/error"

data/lib/json-rpc-objects/v10/fakes/error.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require "json-rpc-objects/generic"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Module of JSON-RPC 1.0.
+    # @see http://json-rpc.org/wiki/specification
+    #
+    
+    module V10
+    
+        ##
+        # In fact, fake error class.
+        #
+        
+        class Error < JsonRpcObjects::Generic::Object
+      
+            ##
+            # Holds link to its version module.
+            #
+            
+            VERSION = JsonRpcObjects::V10
+            
+            ##
+            # Creates new one.
+            #
+            # @param [Object] data error data
+            # @return [JsonRpcObjects::V10::Error] new object
+            #
+            
+            def self.create(data)
+                self::new(data)
+            end
+        
+            ##
+            # Holds request method name.
+            #
+        
+            @data
+            attr_accessor :data
+            
+            ##
+            # Renders data to output form.
+            # @return [Object] with data of object
+            #
+
+            def output
+                @data
+            end
+            
+            
+            protected
+            
+            ##
+            # Assigns request data.
+            #
+
+            def data=(value, mode = nil)
+                @data = value
+            end
+            
+        end
+    end
+end

data/lib/json-rpc-objects/v10/request.rb

@@ -0,0 +1,168 @@
+# encoding: utf-8
+require "json-rpc-objects/generic"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Module of JSON-RPC 1.0.
+    # @see http://json-rpc.org/wiki/specification
+    #
+    
+    module V10
+    
+        ##
+        # Request object class.
+        #
+        
+        class Request < JsonRpcObjects::Generic::Object
+        
+            ##
+            # Holds link to its version module.
+            #
+            
+            VERSION = JsonRpcObjects::V10
+        
+            ##
+            # Holds request method name.
+            #
+        
+            @method
+            attr_accessor :method
+            
+            ##
+            # Holds params for requested method.
+            #
+            
+            @params
+            attr_accessor :params
+            
+            ##
+            # Call ID.
+            #
+            
+            @id
+            attr_accessor :id
+            
+            ##
+            # Creates new one.
+            #
+            # @param [Symbol] method of the request
+            # @param [Array] params array of arguments for the request
+            # @param [Hash] opts additional options
+            # @return [V10::Request] new request
+            #
+            
+            def self.create(method, params = [ ], opts = { })
+                data = {
+                    :method => method,
+                    :params => params
+                }
+                
+                data.merge! opts
+                return self::new(data)
+            end
+            
+            ##
+            # Checks correctness of the request data.
+            #
+            
+            def check!
+                self.normalize!
+                __check_method
+                __check_params
+            end
+                        
+            ##
+            # Renders data to output hash.
+            # @return [Hash] with data of request
+            #
+            
+            def output
+                self.check!
+                data = {
+                    :method => @method.to_s,
+                    :params => @params,
+                    :id => @id
+                }
+            end
+            
+            ##
+            # Indicates, it's notification.
+            # @return [Boolean] true if it is, otherwise false
+            #
+
+            def notification?
+                @id.nil?
+            end
+            
+            
+            protected
+            
+            ##
+            # Assigns request data.
+            #
+
+            def data=(value, mode = nil)            
+                data = __convert_data(value, mode)
+                
+                @method = data[:method]
+                @params = data[:params]
+                @id = data[:id]
+            end
+            
+            ##
+            # Converts request data to standard (defined) format.
+            #
+            
+            def normalize!
+                __normalize_method
+                __normalize_params
+            end
+            
+            ##
+            # Checks method data.
+            #
+            
+            def __check_method
+                if not @method.kind_of? Symbol
+                    raise Exception::new("Service name must be Symbol or convertable to Symbol.")
+                end
+            end
+            
+            ##
+            # Checks params data.
+            #
+            
+            def __check_params
+                if not @params.kind_of? Array
+                    raise Exception::new("Params must be Array.")
+                end
+            end
+            
+            ##
+            # Normalizes method.
+            #
+            
+            def __normalize_method
+                if @method.kind_of? String
+                    @method = @method.to_sym
+                end
+            end
+            
+            ##
+            # Normalizes params.
+            #
+            
+            def __normalize_params
+                if @params.nil?
+                    @params = [ ]
+                end
+            end
+            
+        end
+    end
+end

data/lib/json-rpc-objects/v10/response.rb

@@ -0,0 +1,189 @@
+# encoding: utf-8
+require "json-rpc-objects/generic"
+require "json-rpc-objects/v10/error"
+
+##
+# Main JSON-RPC Objects module.
+#
+
+module JsonRpcObjects
+
+    ##
+    # Module of JSON-RPC 1.0.
+    # @see http://json-rpc.org/wiki/specification
+    #
+
+    module V10
+    
+        ##
+        # Response object class.
+        #
+        
+        class Response < JsonRpcObjects::Generic::Object
+
+            ##
+            # Holds link to its version module.
+            #
+            
+            VERSION = JsonRpcObjects::V10
+
+            ##
+            # Identifies the error object class.
+            #
+            
+            ERROR_CLASS = JsonRpcObjects::V10::Error
+            
+            ##
+            # Holds result data.
+            #
+        
+            @result
+            attr_accessor :result
+            
+            ##
+            # Holds error data.
+            #
+            
+            @error
+            attr_accessor :error
+            
+            ##
+            # Call ID.
+            #
+            
+            @id
+            attr_accessor :id
+
+            ##
+            # Creates new one.
+            #
+            # @param [Object] result of the call for response
+            # @param [Object] error of the call for response
+            # @param [Hash] opts additional options
+            # @return [V10::Response] new response
+            #
+            
+            def self.create(result = nil, error = nil, opts = { })
+                data = {
+                    :result => result,
+                    :error => error
+                }
+                
+                data.merge! opts
+                return self::new(data)
+            end
+            
+            ##
+            # Checks correctness of the request data.
+            #
+            
+            def check!
+                self.normalize!
+                
+                __check_coherency
+                __check_id
+                __check_error
+            end
+                        
+            ##
+            # Renders data to output hash.
+            # @return [Hash] with data of response
+            #
+            
+            def output
+                self.check!
+                data = {
+                    :result => @result,
+                    :error => @error,
+                    :id => @id
+                }
+                
+                return data
+            end
+            
+            ## 
+            # Receives result by array fill operator.
+            # @param [Object] result for the response
+            #
+            
+            def <<(result)
+                @result = result
+            end
+            
+            
+            protected
+            
+            ##
+            # Assigns request data.
+            #
+
+            def data=(value, mode = nil)            
+                data = __convert_data(value, mode)
+                
+                @result = data[:result]
+                @error = data[:error]
+                @id = data[:id]
+                
+                __create_error
+            end
+            
+            ##
+            # Converts request data to standard (defined) format.
+            #
+                
+            def normalize!
+                __normalize_error
+            end
+
+            ##
+            # Checks coherency of result and error.
+            #
+            
+            def __check_coherency
+                if not @result.nil? and not @error.nil?
+                    raise Exception::new("Either result or error must be nil.")
+                end
+            end
+            
+            ##
+            # Checks ID.
+            #
+            def __check_id
+                if @id.nil?
+                    raise Exception::new("ID is required for 1.0 responses.")
+                end           
+            end 
+            
+            ##
+            # Creates error object.
+            #
+            
+            def __create_error
+                if not @error.nil? and not @error.kind_of? self.class::ERROR_CLASS
+                    @error = self.class::ERROR_CLASS::new(@error)
+                end
+            end
+            
+            ##
+            # Checks error settings.
+            #
+            
+            def __check_error
+                if not @error.nil?
+                    if not @error.kind_of? self.class::ERROR_CLASS
+                        raise Exception::new("Error object must be of type " << self.class::ERROR_CLASS.name << ".")
+                    end
+                    
+                    @error.check!
+                end
+            end
+            
+            ##
+            # Normalizes error.
+            #
+            
+            alias :__normalize_error :__create_error
+                        
+        end
+    end
+end