qrpc 0.4.0 → 0.9.0

data/lib/qrpc/protocol/json-rpc/native/qrpc-object.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8   
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "json-rpc-objects/generic/object"
+require "json-rpc-objects/request"
+require "qrpc/protocol/json-rpc"
+require "qrpc/general"
+require "hash-utils"
+
+##
+# General QRPC module.
+#
+
+module QRPC
+    
+    ##
+    # JSON RPC helper module.
+    # @since 0.2.0
+    #
+
+    module Protocol
+
+        ##
+        # JSON-RPC protocol implementation.
+        # @since 0.9.0
+        #
+        
+        class JsonRpc
+
+            ##
+            # Native JSON-RPC classes.
+            # @since 0.9.0
+            #
+            
+            module Native
+              
+                ##
+                # QRPC JSON-RPC QRPC object. Extends the 
+                # +JsonRpcObjects::Generic::Object+. See its documentation for
+                # additional methods.
+                #
+                # @since 0.2.0
+                #
+                
+                class QrpcObject < JsonRpcObjects::Generic::Object
+                
+                    ##
+                    # Holds JSON-RPC version indication.
+                    #
+                    
+                    VERSION = JsonRpcObjects::Request::VERSION
+                    
+                    ##
+                    # Creates new QRPC JSON-RPC object.
+                    #
+                    # @param [Hash] QRPC object optional arguments
+                    # @return [QRPC::Protocol::QrpcObject] new instance
+                    #
+                    
+                    def self.create(opts = { })
+                        self::new(opts)
+                    end
+                    
+                    ##
+                    # Checks correctness of the object data.
+                    #
+                    
+                    def check!
+                        self.normalize!
+                        
+                        if (not @priority.nil?) and not (@priority.kind_of? Numeric)
+                            raise Exception::new("Priority is expected to be Numeric.")
+                        end
+                        
+                        if not (@notification.boolean?)
+                            raise Exception::new("Notification is expected to be Boolean.")
+                        end
+                    end
+                                
+                    ##
+                    # Renders data to output form.
+                    # @return [Hash] with data of object
+                    #
+        
+                    def output
+                        result = { 
+                            "version" => "1.0.2"
+                        }
+                        
+                        if not @priority.nil?
+                            result["priority"] = @priority
+                        end
+                        
+                        if not @client.nil?
+                            result["client"] = @client.to_s
+                        end
+                        
+                        if @notification.true?
+                            result["notification"] = @notification
+                        end
+                        
+                        return result
+                    end
+               
+        
+                    protected
+                    
+                    ##
+                    # Assigns data.
+                    #
+        
+                    def data=(value, mode = nil)
+                        data = __convert_data(value, mode)
+                        
+                        @priority = data[:priority]
+                        @client = data[:client]
+                        @notification = data[:notification]
+                    end
+        
+                    ##
+                    # Converts data to standard (defined) format.
+                    #
+                    
+                    def normalize!
+                        if not @priority.nil?
+                            @priority = @priority.to_i
+                        end
+                        
+                        if @notification.nil?
+                            @notification = false
+                        end
+                    end
+                end
+            end
+        end                
+    end
+end

data/lib/qrpc/protocol/json-rpc/request.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "qrpc/general"
+require "qrpc/protocol/abstract/request"
+require "qrpc/protocol/json-rpc/native/qrpc-object"
+
+##
+# General QRPC module.
+#
+
+module QRPC
+    
+    ##
+    # Protocols helper module.
+    # @since 0.9.0
+    #
+    
+    module Protocol
+
+        ##
+        # JSON-RPC protocol implementation.
+        # @since 0.9.0
+        #
+        
+        class JsonRpc
+        
+            ##
+            # JSON-RPC request implementation.
+            # @since 0.9.0
+            #
+            
+            class Request < QRPC::Protocol::Abstract::Request
+              
+                ##
+                # Holds native object.
+                #
+                
+                attr_writer :native
+                @native 
+
+                ##
+                # Parses the data for new object.
+                #
+                # @param [String] raw  raw data
+                # @return [Request]  new request according to data
+                #
+                                
+                def self.parse(raw)
+                    object = self::new 
+                    object.native = JsonRpcObjects::Request::parse(raw, :wd, self::options.serializer)
+                    return object
+                end
+                
+
+                ##
+                # Returns the native object.
+                # @return [JsonRpcObjects::Response]  native response object
+                #
+                
+                def native
+                    if @native.nil?
+                        client_id = @options.client_id.to_s
+                        qrpc = QRPC::Protocol::JsonRpc::Native::QrpcObject::create(:client => client_id, :priority => @options.priority, :notification => @options.notification)
+                        qrpc.serializer = @options.serializer
+                        
+                        @native = JsonRpcObjects::Request::create(@options[:method], @options.arguments, :id => @options.id, :qrpc => qrpc.output)
+                        @native.serializer = @options.serializer
+                    end
+                    
+                    @native
+                end
+                
+                ##
+                # Serializes object to the resultant form.
+                # @return [String]  serialized form
+                #
+                
+                def serialize
+                    self.native.serialize
+                end
+                
+                ##
+                # Returns ID of the request.
+                # @return [Object] request ID
+                #
+                
+                def id
+                    self.native.id
+                end
+                
+                ##
+                # Returns method identifier of the request.
+                # @return [Symbol]
+                #
+                
+                def method
+                    @native.method
+                end
+
+                ##
+                # Returns method params of the request.
+                # @return [Array]
+                #
+                
+                def params
+                    @native.params
+                end
+
+                ##
+                # Returns the QRPC request priority.
+                # @return [Integer]
+                #
+                 
+                def priority
+                    @native.qrpc["priority"]
+                end
+
+                ##
+                # Returns the QRPC request client identifier.
+                # @return [Object]
+                #
+                 
+                def client
+                    @native.qrpc["client"]
+                end
+                
+                ##
+                # Indicates, job is notification.
+                # @return [Boolean]
+                #
+                
+                def notification?
+                    @native.qrpc["notification"]
+                end
+                
+            end
+        end
+    end
+end

data/lib/qrpc/protocol/json-rpc/response.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "base64"
+
+require "qrpc/general"
+require "qrpc/protocol/abstract/response"
+require "qrpc/protocol/json-rpc/native/qrpc-object"
+
+##
+# General QRPC module.
+#
+
+module QRPC
+    
+    ##
+    # Protocols helper module.
+    # @since 0.9.0
+    #
+    
+    module Protocol
+
+        ##
+        # JSON-RPC protocol implementation.
+        # @since 0.9.0
+        #
+        
+        class JsonRpc
+        
+            ##
+            # JSON-RPC response implementation.
+            # @since 0.9.0
+            #
+            
+            class Response < QRPC::Protocol::Abstract::Response
+              
+                ##
+                # Holds native object.
+                #
+                
+                attr_writer :native
+                @native 
+
+                ##
+                # Parses the data for new object.
+                #
+                # @param [String] raw  raw data
+                # @return [Response]  new request according to data
+                #
+                                
+                def self.parse(raw)
+                    object = self::new
+                    object.native = JsonRpcObjects::Response::parse(raw, :wd, self::options.serializer)
+                    return object
+                end
+                
+                ##
+                # Returns the native object.
+                # @return [JsonRpcObjects::Response]  native response object
+                #
+                
+                def native
+                    if @native.nil?
+                        result = @options.result
+                        error = @options.error
+                        request = @options.request
+                        
+                        error_native = error.nil? ? nil : error.native
+                        @native = request.native.class::version.response::create(result, error_native, :id => request.id)
+                        @native.serializer = @options.serializer
+                        @native.qrpc = QRPC::Protocol::JsonRpc::Native::QrpcObject::create.output
+                    end
+                    
+                    @native
+                end
+                
+                ##
+                # Serializes object to the resultant form.
+                # @return [String]  serialized form
+                #
+                
+                def serialize
+                    self.native.serialize
+                end
+                
+                ##
+                # Returns ID of the response.
+                # @return [Object] response ID
+                #
+                
+                def id
+                    self.native.id
+                end
+                
+                ##
+                # Indicates, error state of the response.
+                # @return [Boolean] error indication
+                #
+                
+                def error?
+                    self.native.error?
+                end
+                                  
+                ##
+                # Returns response error.
+                # @return [Exception] error object
+                #
+                
+                def error
+            
+                    # Converts protocol exception to exception data object
+                    proto = QRPC::Protocol::JsonRpc::Native::ExceptionData::new(native.error.data)
+                
+                    # Tries to unmarshall
+                    if proto.dump.format == :ruby
+                        begin
+                            exception = Marshal.load(Base64.decode64(proto.dump.raw))
+                        rescue
+                            # pass
+                        end
+                    end
+                    
+                    # If unsuccessfull, creates from data
+                    if exception.nil?
+                        backtrace = data.backtrace.map { |i| Base64.decode64(i) }
+                        backtrace.reject! { |i| i.empty? }
+                        exception = self::new(data.name, data.message, backtrace)
+                    end
+    
+                    return exception
+                    
+                end
+                
+                ##
+                # Returns response result.
+                # @return [Object] response result
+                #
+                
+                def result
+                    self.native.result
+                end
+                             
+            end
+        end
+    end
+end

data/lib/qrpc/protocol/object.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+# (c) 2012 Martin Kozák (martinkozak@martinkozak.net)
+
+require "qrpc/protocol/abstract"
+
+##
+# General QRPC module.
+#
+
+module QRPC
+    
+    ##
+    # Protocols helper module.
+    # @since 0.9.0
+    #
+    
+    module Protocol
+
+        ##
+        # Object protocol implementation.
+        # @since 0.9.0
+        #
+        
+        class Object < Abstract
+        end
+               
+    end
+end
+
+require "qrpc/protocol/object/error"
+require "qrpc/protocol/object/request"
+require "qrpc/protocol/object/response"