qrpc 0.4.0 → 0.9.0

data/lib/qrpc/client/exception.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
 require "qrpc/protocol/exception-data"
 
 ##
@@ -24,51 +26,20 @@ module QRPC
         #
         
         class Exception < ::Exception
-
-            ##
-            # Gets one from protocol exception object.
-            # Returns marshalled original or reconstructed version.
-            #
-            # @param [JsonRpcObjects::Generic::Error] proto JSON-RPC error object
-            # @return [Exception, QRPC::Client::Exception] exception according
-            #   to sucessfullness of the unmarshaling
-            #
-            
-            def self.get(proto)
-            
-                # Converts protocol exception to exception data object
-                proto = QRPC::Protocol::ExceptionData::new(proto.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?
-                    exception = self::new(proto)
-                end
-
-                return exception
-            end
             
             ##
             # Constructor.
             # Initializes from protocol exception data object.
             #
-            # @param [QRPC::Protocol::ExceptionData] data exception data object
+            # @param [String] name  a exception name
+            # @param [String] message  a exception message
+            # @param [Array] backtrace  the backtrace array
             #
             
-            def initialize(data)
-                message = data.name.dup << ": " << data.message
-                backtrace = data.backtrace.map { |i| Base64.decode64(i) }
-                backtrace.reject! { |i| i.empty? }
-                
+            def initialize(name, message, backtrace = [ ])
+                message = name + ": " + message
                 super(message)
+                
                 self.set_backtrace(backtrace)
             end
             

data/lib/qrpc/client/job.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
 require "uuid"
 require "qrpc/protocol/request"
 require "qrpc/client/exception"
@@ -64,6 +66,20 @@ module QRPC
             
             @priority
             
+            ##
+            # Protocol.
+            # @since 0.9.0
+            #
+            
+            @protocol
+
+            ##
+            # ID generator.
+            # @since 0.9.0
+            #
+            
+            @generator
+                        
             ##
             # Job result.
             #
@@ -77,15 +93,19 @@ module QRPC
             # @param [Symbol] method  job method name
             # @param [Array] arguments  array of arguments for job
             # @param [Integer] priority  job priority
+            # @param [QRPC::Generator] ID generator
+            # @param [QRPC::Protocol::Abstract] protocol  protocol instance
             # @param [Proc] callback  result callback
             #
             
-            def initialize(client_id, method, arguments = [ ], priority = QRPC::DEFAULT_PRIORITY, &callback)
+            def initialize(client_id, method, arguments = [ ], priority = QRPC::DEFAULT_PRIORITY, generator = QRPC::default_generator, protocol = QRPC::default_protocol, &callback)
                 @client_id = client_id
                 @method = method
                 @arguments = arguments
                 @callback = callback
                 @priority = priority
+                @protocol = protocol
+                @generator = generator
             end
             
             ##
@@ -95,21 +115,44 @@ module QRPC
             
             def id
                 if @id.nil?
-                    @id = UUID.generate(:compact).to_sym
+                    @id = @generator.generate(self)
+                else
+                    @id
                 end
-                
-                return @id
             end
             
             ##
             # Converts job to JSON.
+            #
             # @return [String] job in JSON form (JSON-RPC)
+            # @deprecated (since 0.4.0) Use +#serialize+.
+            # @see #serialize
             #
             
             def to_json
-                QRPC::Protocol::Request::create(@client_id, @id, @method, @arguments, @priority).to_json
+                JsonRpc::Request::create(@client_id, @id, @method, @arguments, @priority).to_json
             end
+
+            ##
+            # Serializes job using serializer.
+            #
+            # @return [Object] serialized object
+            # @since 0.4.0
+            #
             
+            def serialize
+                options = {
+                    :client_id => @client_id,
+                    :id => @id,
+                    :method => @method,
+                    :arguments => @arguments,
+                    :priority => @priority,
+                    :notification => self.notification?
+                }
+                
+                @protocol.request::new(options).serialize
+            end
+             
             ##
             # Indicates message is notification. So callback isn't set
             # and it doesn't expect any result.
@@ -130,17 +173,7 @@ module QRPC
                 if not result.error?
                     @result = result.result
                 else
-=begin
-                    STDERR.write(">>> Exception while call ID: " << self.id.to_s << "\n")
-=end                    
-                    exception = QRPC::Client::Exception::get(result.error)
-=begin
-                    STDERR.write exception.class.name.dup << ": " << exception.message << "\n"
-                    
-                    exception.backtrace.each do |i|
-                        STDERR.write "	from " << i << "\n"
-                    end
-=end                    
+                    exception = result.error
                     raise exception
                 end
                 

data/lib/qrpc/general.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "qrpc/generator/uuid"
 
 ##
 # General QRPC module.
@@ -33,5 +36,62 @@ module QRPC
     #
     
     DEFAULT_PRIORITY = 50
-
+    
+    ##
+    # Holds default generator module link.
+    # @since 0.9.0
+    #
+    
+    DEFAULT_GENERATOR = QRPC::Generator::UUID
+    
+    ##
+    # Holds default protocol instance.
+    # @since 0.4.0
+    #
+    
+    @@default_protocol = nil
+    
+    ##
+    # Holds default generator instance.
+    # @since 0.9.0
+    #
+    
+    @@default_generator = nil
+    
+    ##
+    # Returns default protocol instance.
+    #
+    # @return [QRPC::Protocol::Abstract] protocol instance
+    # @since 0.9.0
+    #
+    
+    def self.default_protocol
+        if @@default_protocol.nil?
+            begin
+                @@default_protocol = QRPC::Protocol::JsonRpc::new(:serializer => JsonRpcObjects::Serializer::JSON::new)
+            rescue NameError
+                require "json-rpc-objects/serializer/json"  # >= 0.4.1
+                require "qrpc/protocol/json-rpc"
+                retry
+            end
+        else
+            @@default_protocol
+        end
+    end
+    
+    ##
+    # Returns default generator instance.
+    #
+    # @return [QRPC::Generator::UUID] generator instance
+    # @since 0.9.0
+    #
+    
+    def self.default_generator
+        if @@default_generator.nil?
+            @@default_generator = QRPC::DEFAULT_GENERATOR::new
+        else
+            @@default_generator
+        end
+    end
+            
 end

data/lib/qrpc/generator/object-id.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "hash-utils/object"  # >= 1.1.0
+
+##
+# General QRPC module.
+#
+
+module QRPC
+    
+    ##
+    # General generators module.
+    # @since 0.9.0
+    #
+    
+    module Generator
+      
+        ##
+        # Ruby object ID generator.
+        # @since 0.9.0
+        #
+        
+        class ObjectID
+          
+            ##
+            # Generates Ruby object ID as ID for given object.
+            #
+            # @param [Object] object  required object
+            # @return [Symbol] new ID
+            #
+            
+            def generate(object)
+                object.object_id
+            end
+            
+            alias :generate! :generate
+            
+        end
+        
+    end
+    
+end

data/lib/qrpc/generator/uuid.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "uuid"
+
+##
+# General QRPC module.
+#
+
+module QRPC
+    
+    ##
+    # General generators module.
+    #
+    
+    module Generator
+      
+        ##
+        # UUID generator.
+        # @since 0.9.0
+        #
+        
+        class UUID
+          
+            ##
+            # Generates UUID as ID for given object.
+            #
+            # @param [Object] object  required object
+            # @return [String] new ID
+            # @since 0.9.0
+            #
+            
+            def generate(object = nil)
+                ::UUID.generate(:compact).to_sym
+            end
+            
+            alias :generate! :generate
+            
+        end
+        
+    end
+    
+end

data/lib/qrpc/locator.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
+require "qrpc/locator/em-jack"
 
 ##
 # General QRPC module.
@@ -9,96 +11,20 @@ module QRPC
     
     ##
     # Resource locator.
+    # @deprecated (since 0.9.0) in favour to locators for each queue types
     #
     
-    class Locator
-    
-        ##
-        # Contains queue name.
-        # @return [Symbol]
-        #
-
-        attr_accessor :queue
-        @queue
-        
-        ##
-        # Contains host.
-        # @return [String]
-        #
-
-        attr_accessor :host
-        @host
-        
-        ##
-        # Contains port.
-        # @return [Integer]
-        #
-
-        attr_accessor :port
-        @port
-        
-        ##
-        # Parser.
-        #
-        
-        PARSER = /^(.+)@(.+)(?:\:(\d+))?$/
-        
-        ##
-        # Default port.
-        #
-        
-        DEFAULT_PORT = 11300
-        
-        ##
-        # Constructor.
-        #
-        # @param [String, Symbol] queue queue name
-        # @param [String] host host name
-        # @param [Integer] port port of the host
-        #
-        
-        def initialize(queue, host = "localhost", port = 11300)
-            @queue = queue.to_s
-            @host = host
-            @port = port
-        end
-        
+    module Locator
+      
         ##
-        # Parses the locator.
-        # Excpects form +<queue>@<host>:<port>+. Port is optional.
+        # Returns new instance of {EMJackLocator}.
+        # @returns [EMJackLocator]
         #
-        # @param [String] string locator in string form
-        # @return [QRPC::Locator] new instance
-        #
-        
-        def self.parse(string)
-            match = string.match(self::PARSER)
-            
-            queue = match[1]
-            host = match[2]
-            
-            if match.length == 3
-                port = match[3]
-            else
-                port = self::DEFAULT_PORT
-            end
-            
-            port = port.to_i
-            
-            ##
-            
-            return self::new(queue, host, port);
-        end
-        
-        ##
-        # Converts back to string.
-        # @return [String] locator in string form
-        #
-        
-        def to_s
-            @queue.dup << "@" << @host << ":" << @port.to_s
+         
+        def self.new(*args, &block)
+            EMJackLocator::new(*args, &block)
         end
         
     end
-    
+        
 end