qrpc 0.2.2 → 0.3.0

data/CHANGES.txt

@@ -1,11 +1,17 @@
 
+0.3.0
+* bad json-rpc-object dependency (but noncritical, some special cases
+    performance lag only)
+* all public methods from Client moved to Client::Dispatcher
+
 0.2.2 (2011-02-13)
 * subminor bug corrections
 * beanstalkd queue now isn't emptified independently of the max 
-  job settings
+    job settings
 * max jobs set to 0 means, it's unlimited
 * max job settings is now 0 by default
 * minor performance optimizations
+* hash-utils gem dependency removed
 
 0.2.1 (2011-02-06)
 * missing UUID dependency in gem specification

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-   gem "json-rpc-objects", ">= 0.3.1"
+   gem "json-rpc-objects", ">= 0.3.3"
    gem "depq", ">= 0.4"
    gem "em-jack", ">= 0.1.3"
    gem "eventmachine", ">= 0.12.10"

data/Gemfile.lock

@@ -7,12 +7,12 @@ GEM
       eventmachine
     eventmachine (0.12.10)
     git (1.2.5)
-    hash-utils (0.4.1)
+    hash-utils (0.10.0)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    json-rpc-objects (0.3.1)
+    json-rpc-objects (0.3.3)
       addressable (>= 2.2.2)
       hash-utils (>= 0.3.0)
       multitype-introspection (>= 0.1.0)
@@ -25,7 +25,7 @@ GEM
       multitype-introspection (>= 0.1.0)
     uuid (2.3.1)
       macaddr (~> 1.0)
-    yajl-ruby (0.7.9)
+    yajl-ruby (0.8.1)
 
 PLATFORMS
   ruby
@@ -36,5 +36,5 @@ DEPENDENCIES
   em-jack (>= 0.1.3)
   eventmachine (>= 0.12.10)
   jeweler (~> 1.5.2)
-  json-rpc-objects (>= 0.3.1)
+  json-rpc-objects (>= 0.3.3)
   uuid (>= 2.3.1)

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/lib/qrpc/client.rb

@@ -1,9 +1,5 @@
 # encoding: utf-8
-require "em-jack"
-require "uuid"
-require "qrpc/general"
-require "qrpc/client/job"
-require "json-rpc-objects/response"
+require "qrpc/client/dispatcher"
 
 ##
 # General QRPC module.
@@ -13,59 +9,24 @@ module QRPC
     
     ##
     # Queue RPC client.
+    #
+    # @note Since 0.3.0, all non-system methods was moved to 
+    #   {Dispatcher} module for maximal avoiding the user API 
+    #   name conflicts.
     # @since 0.2.0
     #
     
     class Client
     
         ##
-        # Holds locator of the target queue.
-        #
-        
-        @locator
-        
-        ##
-        # Holds client session ID.
-        #
-        
-        @id
-        
-        ##
-        # Holds input queue name.
-        #
-        
-        @input_name
-        
-        ##
-        # Holds input queue instance.
-        #
-        
-        @input_queue
-        
-        ##
-        # Holds output queue name.
-        #
-        
-        @output_name
-        
-        ##
-        # Holds output queue instance.
+        # Holds working dispatcher.
         #
-        
-        @output_queue
-        
-        ##
-        # Indicates, results pooling is ran.
+        # @return [Dispatcher] 
+        # @since 0.3.0
         #
         
-        @pooling
-        
-        ##
-        # Holds clients for finalizing.
-        #
-        
-        @@clients = { }
-        
+        attr_accessor :dispatcher
+        @dispatcher
         
         ##
         # Constructor.
@@ -73,46 +34,9 @@ module QRPC
         #
         
         def initialize(locator)
-            @locator = locator
-            @pooling = false
-            @jobs = { }
-        
-            # Destructor
-            ObjectSpace.define_finalizer(self, self.class.method(:finalize).to_proc)
-            @@clients[self.object_id] = self
+            @dispatcher = QRPC::Client::Dispatcher::new(locator)
         end
-        
-        ##
-        # Finalizer handler.
-        # @param [Integer] id id of finalized instance
-        #
-        
-        def self.finalize(id)
-            if @@clients.has_key? id
-                @@clients[id].finalize!
-            end
-        end
-        
-        ##
-        # Destructor.
-        #
-        
-        def finalize!
-            if not @input_queue.nil?
-                @input_queue.watch("default") do
-                    @input_queue.ignore(@input_name.to_s) do
-                        @input_queue.close
-                    end
-                end
-            end
-            
-            if not @output_queue.nil?
-                @output_queue.use("default") do
-                    @output_queue.close
-                end
-            end
-        end
-        
+                
         ##
         # Handles call to RPC. (*********)
         #
@@ -125,153 +49,8 @@ module QRPC
         #
         
         def method_missing(name, *args, &block)
-            self.put(self.create_job(name, args, &block))
+            @dispatcher.put(@dispatcher.create_job(name, args, &block))
         end
-        
-        ##
-        # Creates job associated to this client session.
-        # 
-        # @param [Symbol] name name of the method of the job
-        # @param [Array] args arguments of the method call
-        # @param [Integer] priority job priority
-        # @param [Proc] block result returning callback
-        # @return [QRPC::Client::Job] new job
-        #
-        
-        def create_job(name, args, priority = QRPC::DEFAULT_PRIORITY, &block)
-            Client::Job::new(self.id, name, args, priority, &block)
-        end
-        
-        ##
-        # Puts job to client.
-        # @param [QRPC::Client::Job] job  job for put to output queue
-        
-        def put(job)
-            if not job.notification?
-                @jobs[job.id] = job
-            end
-            
-            self.output_queue do |queue|
-                queue.put(job.to_json)
-            end
-            
-            if (not @pooling) and (@jobs.length > 0)
-                self.pool!
-            end
-        end
-     
-        ##
-        # Starts input (results) pooling.
-        #
-        
-        def pool!
-            
-            # Results processing logic
-            processor = Proc::new do |job|
-                response = JsonRpcObjects::Response::parse(job.body)
-                id = response.id.to_sym
-                job.delete()
-                
-                if @jobs.include? id
-                    @jobs[id].assign_result(response)
-                end
-                
-                @jobs.delete(id)
-            end
-            
-            # Runs processor for each job            
-            parent = self
-            worker = EM.spawn do
-                parent.input_queue { |q| q.each_job(&processor) }
-            end
-            
-            ##
-            
-            worker.run
-            @pooling = true
-            
-        end
-        
-        ##
-        # Returns input name.
-        # @return [Symbol] input queue name
-        #
-        
-        def input_name
-            if @input_name.nil?
-                @input_name = (QRPC::QUEUE_PREFIX.dup << "-" << self.id.to_s << "-" << QRPC::QUEUE_POSTFIX_OUTPUT).to_sym
-            end
-            
-            return @input_name
-        end
-        
-        ##
-        # Returns input queue.
-        # @param [Proc] block block to which will be input queue given
-        #
-        
-        def input_queue(&block)
-            if @input_queue.nil?
-                @input_queue = EMJack::Connection::new(:host => @locator.host, :port => @locator.port)
-                @input_queue.watch(self.input_name.to_s) do
-                    @input_queue.ignore("default") do
-
-                        # Results pooler error handler
-                        @input_queue.on_error do |error|
-                            raise ::Exception::new("Beanstalk error: " << error.to_s)
-                        end
-                        
-                        # Returns
-                        block.call(@input_queue)
-                        
-                    end
-                end
-            else
-                block.call(@input_queue)
-            end
-        end
-        
-        ##
-        # Returns output name.
-        # @return [Symbol] output queue name
-        #
-        
-        def output_name
-            if @output_name.nil?
-                @output_name = (QRPC::QUEUE_PREFIX.dup << "-" << @locator.queue << "-" << QRPC::QUEUE_POSTFIX_INPUT).to_sym
-            end
-            
-            return @output_name
-        end
-        
-        ##
-        # Returns output queue.
-        # @param [Proc] block block to which will be output queue given
-        #
-        
-        def output_queue(&block)
-            if @output_queue.nil?
-                @output_queue = EMJack::Connection::new(:host => @locator.host, :port => @locator.port)
-                @output_queue.use(self.output_name.to_s) do
-                    block.call(@output_queue)
-                end
-            else
-                block.call(@output_queue)
-            end
-        end
-        
-        ##
-        # Returns client (or maybe session is better) ID.
-        # @return [Symbol] client (session) ID
-        #
-        
-        def id
-            if @id.nil?
-                @id = UUID.generate.to_sym
-            end
-            
-            return @id
-        end
-                
+               
     end
 end

data/lib/qrpc/client/dispatcher.rb

@@ -0,0 +1,275 @@
+# encoding: utf-8
+require "em-jack"
+require "uuid"
+require "qrpc/general"
+require "qrpc/client/job"
+require "json-rpc-objects/response"
+
+##
+# General QRPC module.
+#
+
+module QRPC
+    
+    ##
+    # Queue RPC client.
+    #
+    # @note Since 0.3.0, all non-system methods was moved to the 
+    #   {Dispatcher} module for maximal avoiding the user API 
+    #   name conflicts.
+    # @since 0.2.0
+    #
+    
+    class Client
+    
+        ##
+        # Queue RPC client dispatcher (worker).
+        # @since 0.3.0
+        #
+        
+        class Dispatcher
+
+            ##
+            # Holds locator of the target queue.
+            #
+            
+            @locator
+            
+            ##
+            # Holds client session ID.
+            #
+            
+            @id
+            
+            ##
+            # Holds input queue name.
+            #
+            
+            @input_name
+            
+            ##
+            # Holds input queue instance.
+            #
+            
+            @input_queue
+            
+            ##
+            # Holds output queue name.
+            #
+            
+            @output_name
+            
+            ##
+            # Holds output queue instance.
+            #
+            
+            @output_queue
+            
+            ##
+            # Indicates, results pooling is ran.
+            #
+            
+            @pooling
+            
+            ##
+            # Holds clients for finalizing.
+            #
+            
+            @@clients = { }
+            
+            
+            ##
+            # Constructor.
+            # @param [QRPC::Locator] locator of the output queue
+            #
+            
+            def initialize(locator)
+                @locator = locator
+                @pooling = false
+                @jobs = { }
+            
+                # Destructor
+                ObjectSpace.define_finalizer(self, self.class.method(:finalize).to_proc)
+                @@clients[self.object_id] = self
+            end
+            
+            ##
+            # Finalizer handler.
+            # @param [Integer] id id of finalized instance
+            #
+            
+            def self.finalize(id)
+                if @@clients.has_key? id
+                    @@clients[id].finalize!
+                end
+            end
+            
+            ##
+            # Destructor.
+            #
+            
+            def finalize!
+                if not @input_queue.nil?
+                    @input_queue.watch("default") do
+                        @input_queue.ignore(@input_name.to_s) do
+                            @input_queue.close
+                        end
+                    end
+                end
+                
+                if not @output_queue.nil?
+                    @output_queue.use("default") do
+                        @output_queue.close
+                    end
+                end
+            end
+                        
+            ##
+            # Creates job associated to this client session.
+            # 
+            # @param [Symbol] name name of the method of the job
+            # @param [Array] args arguments of the method call
+            # @param [Integer] priority job priority
+            # @param [Proc] block result returning callback
+            # @return [QRPC::Client::Job] new job
+            #
+            
+            def create_job(name, args, priority = QRPC::DEFAULT_PRIORITY, &block)
+                Client::Job::new(self.id, name, args, priority, &block)
+            end
+            
+            ##
+            # Puts job to client.
+            # @param [QRPC::Client::Job] job  job for put to output queue
+            
+            def put(job)
+                if not job.notification?
+                    @jobs[job.id] = job
+                end
+                
+                self.output_queue do |queue|
+                    queue.put(job.to_json)
+                end
+                
+                if (not @pooling) and (@jobs.length > 0)
+                    self.pool!
+                end
+            end
+         
+            ##
+            # Starts input (results) pooling.
+            #
+            
+            def pool!
+                
+                # Results processing logic
+                processor = Proc::new do |job|
+                    response = JsonRpcObjects::Response::parse(job.body)
+                    id = response.id.to_sym
+                    job.delete()
+                    
+                    if @jobs.include? id
+                        @jobs[id].assign_result(response)
+                    end
+                    
+                    @jobs.delete(id)
+                end
+                
+                # Runs processor for each job            
+                parent = self
+                worker = EM.spawn do
+                    parent.input_queue { |q| q.each_job(&processor) }
+                end
+                
+                ##
+                
+                worker.run
+                @pooling = true
+                
+            end
+            
+            ##
+            # Returns input name.
+            # @return [Symbol] input queue name
+            #
+            
+            def input_name
+                if @input_name.nil?
+                    @input_name = (QRPC::QUEUE_PREFIX.dup << "-" << self.id.to_s << "-" << QRPC::QUEUE_POSTFIX_OUTPUT).to_sym
+                end
+                
+                return @input_name
+            end
+            
+            ##
+            # Returns input queue.
+            # @param [Proc] block block to which will be input queue given
+            #
+            
+            def input_queue(&block)
+                if @input_queue.nil?
+                    @input_queue = EMJack::Connection::new(:host => @locator.host, :port => @locator.port)
+                    @input_queue.watch(self.input_name.to_s) do
+                        @input_queue.ignore("default") do
+
+                            # Results pooler error handler
+                            @input_queue.on_error do |error|
+                                raise ::Exception::new("Beanstalk error: " << error.to_s)
+                            end
+                            
+                            # Returns
+                            block.call(@input_queue)
+                            
+                        end
+                    end
+                else
+                    block.call(@input_queue)
+                end
+            end
+            
+            ##
+            # Returns output name.
+            # @return [Symbol] output queue name
+            #
+            
+            def output_name
+                if @output_name.nil?
+                    @output_name = (QRPC::QUEUE_PREFIX.dup << "-" << @locator.queue << "-" << QRPC::QUEUE_POSTFIX_INPUT).to_sym
+                end
+                
+                return @output_name
+            end
+            
+            ##
+            # Returns output queue.
+            # @param [Proc] block block to which will be output queue given
+            #
+            
+            def output_queue(&block)
+                if @output_queue.nil?
+                    @output_queue = EMJack::Connection::new(:host => @locator.host, :port => @locator.port)
+                    @output_queue.use(self.output_name.to_s) do
+                        block.call(@output_queue)
+                    end
+                else
+                    block.call(@output_queue)
+                end
+            end
+            
+            ##
+            # Returns client (or maybe session is better) ID.
+            # @return [Symbol] client (session) ID
+            #
+            
+            def id
+                if @id.nil?
+                    @id = UUID.generate.to_sym
+                end
+                
+                return @id
+            end
+               
+        end
+                
+    end
+end

data/lib/qrpc/client/exception.rb

@@ -10,6 +10,11 @@ module QRPC
     ##
     # Queue RPC client.
     #
+    # @note Since 0.3.0, all non-system methods was moved to the 
+    #   {Dispatcher} module for maximal avoiding the user API 
+    #   name conflicts.
+    # @since 0.2.0
+    #
     
     class Client
     

data/lib/qrpc/client/job.rb

@@ -13,6 +13,11 @@ module QRPC
     ##
     # Queue RPC client.
     #
+    # @note Since 0.3.0, all non-system methods was moved to the 
+    #   {Dispatcher} module for maximal avoiding the user API 
+    #   name conflicts.
+    # @since 0.2.0
+    #
     
     class Client
     

data/qrpc.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{qrpc}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Kozák"]
-  s.date = %q{2011-02-13}
+  s.date = %q{2011-02-27}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "TODO.md",
     "VERSION",
     "lib/qrpc/client.rb",
+    "lib/qrpc/client/dispatcher.rb",
     "lib/qrpc/client/exception.rb",
     "lib/qrpc/client/job.rb",
     "lib/qrpc/general.rb",
@@ -43,14 +44,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/martinkozak/qrpc}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
+  s.rubygems_version = %q{1.5.3}
   s.summary = %q{Queued JSON-RPC client and server. Works as normal RPC server, but through queue interface, so allows highly scalable, distributed and asynchronous remote API implementation and fast data processing. It's based on eventmachine and beanstalkd, so it's fast and thread safe.}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json-rpc-objects>, [">= 0.3.1"])
+      s.add_runtime_dependency(%q<json-rpc-objects>, [">= 0.3.3"])
       s.add_runtime_dependency(%q<depq>, [">= 0.4"])
       s.add_runtime_dependency(%q<em-jack>, [">= 0.1.3"])
       s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
@@ -58,7 +59,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
     else
-      s.add_dependency(%q<json-rpc-objects>, [">= 0.3.1"])
+      s.add_dependency(%q<json-rpc-objects>, [">= 0.3.3"])
       s.add_dependency(%q<depq>, [">= 0.4"])
       s.add_dependency(%q<em-jack>, [">= 0.1.3"])
       s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
@@ -67,7 +68,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     end
   else
-    s.add_dependency(%q<json-rpc-objects>, [">= 0.3.1"])
+    s.add_dependency(%q<json-rpc-objects>, [">= 0.3.3"])
     s.add_dependency(%q<depq>, [">= 0.4"])
     s.add_dependency(%q<em-jack>, [">= 0.1.3"])
     s.add_dependency(%q<eventmachine>, [">= 0.12.10"])

data/test-client.rb

@@ -5,6 +5,7 @@ require "qrpc/client"
 require "qrpc/locator"
 require "eventmachine"
 
+=begin
 EM::run do
     client = QRPC::Client::new QRPC::Locator::new :test
 #    puts client.inspect
@@ -29,8 +30,8 @@ EM::run do
 #        puts i
 #    end
 end
+=end
 
-=begin
 require "beanstalk-client"
 require "json-rpc-objects/request"
 

metadata

@@ -2,7 +2,7 @@
 name: qrpc
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-13 00:00:00 +01:00
+date: 2011-02-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.1
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: *id001
@@ -110,6 +110,7 @@ files:
 - TODO.md
 - VERSION
 - lib/qrpc/client.rb
+- lib/qrpc/client/dispatcher.rb
 - lib/qrpc/client/exception.rb
 - lib/qrpc/client/job.rb
 - lib/qrpc/general.rb
@@ -137,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1069714967795243013
+      hash: 3226549344663935537
       segments: 
       - 0
       version: "0"
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Queued JSON-RPC client and server. Works as normal RPC server, but through queue interface, so allows highly scalable, distributed and asynchronous remote API implementation and fast data processing. It's based on eventmachine and beanstalkd, so it's fast and thread safe.