em-pg-client 0.1.0 → 0.1.1

data/HISTORY.rdoc

@@ -0,0 +1,9 @@
+0.1.1
+- added on_reconnect callback
+- docs updated
+- added development dependency for eventmachine >= 1.0.0.beta.1
+- added separate client specs for eventmachine = 0.12.10
+- added error checking to eventmachine specs
+
+0.1.0
+- first release

data/README.rdoc

@@ -1,17 +1,17 @@
 = em-pg-client
 
-Author::    Rafał Michalski  (mailto:royaltm75@gmail.com)
+Author::    Rafał Michalski  (mailto:rafal@yeondir.com)
 
 * http://github.com/royaltm/ruby-em-pg-client
 
 == DESCRIPTION
 
 *em-pg-client* is a PostgreSQL EventMachine client wrapper for Ruby
-based on (ruby-pg)[https://bitbucket.org/ged/ruby-pg]
+based on ruby-pg[https://bitbucket.org/ged/ruby-pg]
 
 == FEATURES
 
-* minimal changes to PG::Conncet API
+* minimal changes to PG::Connection API
 * auto reconnects on socket connection loss (like server restarts)
 * true non-blocking asynchronous processing
 * EM-Synchrony[https://github.com/igrigorik/em-synchrony] support
@@ -49,7 +49,7 @@ I've found at least 3 other implementations of EM postgres client:
 and (except the bundled one which uses no longer maintained postgres-pr library)
 all of them have similiar flaws:
 
-* 2 of them are designed to support some ORM only (ActiveRecord or Sequel)
+* 2 of them are designed to support some ORM (ActiveRecord or Sequel)
   so they are EM-Synchrony only,
 * non-standard API method names,
 * no (nonexistent or non-working) autoreconnect implementation,
@@ -81,14 +81,14 @@ The greetz go to:
   # no async
   pg = PG::EM::Client.new dbname: 'test'
   pq.query('select * from foo') do |result|
-    puts result
+    puts Array(result).inspect
   end
   
   # asynchronous
   EM.run do
     pq.query('select * from foo') do |result|
       raise result if result.is_a? ::Exception
-      puts result
+      puts Array(result).inspect
       EM.stop
     end
     puts "sent"
@@ -98,11 +98,10 @@ The greetz go to:
 
   EM.run do
     pg = PG::EM::Client.new dbname: 'test'
-    
-    try_query = lambda |&blk| do
-      pq.query('select * from foo') do |result|
+    try_query = lambda do |&blk|
+      pg.query('select * from foo') do |result|
         raise result if result.is_a? ::Exception
-        puts result
+        puts Array(result).inspect
         blk.call
       end
     end
@@ -124,6 +123,37 @@ or
   pg = PG::EM::Client.new dbname: 'test',
     async_autoreconnect: false
 
+It's also possible to define +on_reconnect+ callback to be invoked
+while the connection has been reset. It's called just before the send query
+command is executed:
+
+  EM.run do
+    pg = PG::EM::Client.new dbname: 'test'
+    pg.prepare('bar', 'select * from foo order by cdate desc') do
+      pg.on_reconnect = proc { |c, e|
+        c.prepare('bar', 'select * from foo order by cdate desc')
+      }
+      try_query = lambda do |&blk|
+        pg.exec_prepared('bar') do |result|
+          raise result if result.is_a? ::Exception
+          puts Array(result).inspect
+          blk.call
+        end
+      end
+      try_query.call {
+        system 'pg_ctl stop -m fast'
+        system 'pg_ctl start -w'
+        EM.add_timer(1) do
+          try_query.call { EM.stop }
+        end
+      }
+    end
+  end
+
+As you can see it's possible to send async query from inside on_reconnect
+proc. However you have to pass +Deferrable+ from the async callback to the
+caller. See +#on_reconnect+ docs for details.
+
 === TRUE ASYNC
 
   EM.run do
@@ -147,7 +177,7 @@ or
   EM.synchrony do
     pg = PG::EM::Client.new dbname: 'test'
     pg.query('select * from foo') do |result|
-      puts result
+      puts Array(result).inspect
     end
     EM.stop
   end
@@ -198,6 +228,31 @@ or
     EM.stop
   end
 
+==== Async reconnect with on_reconnect callback
+
+    EM.synchrony do
+    pg = EM::Synchrony::ConnectionPool.new(size: 5) do
+      p = PG::EM::Client.new dbname: 'test'
+      p.on_reconnect = proc do |c, e|
+        c.prepare('bar', 'select * from foo order by cdate desc')
+      end
+      p.on_reconnect.call p
+      p
+    end
+    try_query = lambda do
+      pg.exec_prepared('bar') do |result|
+        raise result if result.is_a? ::Exception
+        puts Array(result).inspect
+      end
+    end
+    try_query.call
+    system 'pg_ctl stop -m fast'
+    system 'pg_ctl start -w'
+    EM::Synchrony.sleep(1)
+    try_query.call
+    EM.stop
+  end
+
 == LICENCE
 
 The MIT License - Copyright (c) 2012 Rafał Michalski

data/Rakefile

@@ -7,7 +7,8 @@ $gem_name = "em-pg-client"
 desc "Run tests"
 task :test do
   puts "WARNING: The test needs to be run with an available local PostgreSQL server"
-  sh "rspec spec/em_client.rb"
+  sh "rspec spec/em_release_client.rb"
+  sh "rspec spec/em_devel_client.rb"
   sh "rspec spec/em_synchrony_client.rb"
 end
 

data/em-pg-client.gemspec

@@ -2,7 +2,7 @@ $:.unshift "lib"
 
 Gem::Specification.new do |s|
   s.name = "em-pg-client"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
   s.required_ruby_version = ">= 1.9.1"
   s.date = "#{Time.now.strftime("%Y-%m-%d")}"
   s.summary = "EventMachine PostgreSQL client"
@@ -21,5 +21,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "pg", ">= 0.13.2"
   s.add_runtime_dependency "eventmachine", ">= 0.12.10"
   s.add_development_dependency "rspec", "~> 2.8.0"
+  s.add_development_dependency "eventmachine", ">= 1.0.0.beta.1"
   s.add_development_dependency "em-synchrony", "~> 1.0.0"
 end

data/lib/pg/em.rb

@@ -1,48 +1,75 @@
 require 'pg'
 module PG
   module EM
+    # == PostgreSQL EventMachine client
+    #
+    # Author:: Rafal Michalski (mailto:royaltm75@gmail.com)
+    # Licence:: MIT License
+    #
+    #
+    # PG::EM::Client is a wrapper for PG::Connection which (re)defines methods:
+    #
+    # - +async_exec+ (alias: +async_query+)
+    # - +async_prepare+
+    # - +async_exec_prepared+
+    #
+    # and following:
+    #
+    # - +exec+ (alias: +query+)
+    # - +exec_prepared+
+    # - +prepare+
+    #
+    # which autodetects if EventMachine is running and uses appropriate
+    # (async or sync) method version.
+    #
+    # Async methods might try to reset connection on connection error,
+    # you won't even notice that (except for warning message from PG).
+    #
+    # To disable such behavior set:
+    #   client.async_autoreconnect = false
+    #
+    # or pass as new() hash argument:
+    #   PG::EM::Client.new database: 'bar', async_autoreconnect: false
+    #
+    # Otherwise nothing changes in PG::Connect API.
+    # See PG::Connect docs for arguments to above methods.
+    #
+    # *Warning:*
+    #
+    # +async_exec_prepared+ after +async_prepare+ should only be invoked on
+    # the *same* connection.
+    # If you are using connection pool, make sure to acquire single connection first.
+    #
     class Client < PG::Connection
-      # == PostgreSQL EventMachine client
-      #
-      # Author:: Rafal Michalski (mailto:royaltm75@gmail.com)
-      # Licence:: MIT License
-      #
-      #
-      # PG::EM::Client is a wrapper for PG::Connection which (re)defines methods:
-      #
-      # - +async_exec+ (alias: +async_query+)
-      # - +async_prepare+
-      # - +async_exec_prepared+
-      #
-      # and following:
-      #
-      # - +exec+ (alias: +query+)
-      # - +exec_prepared+
-      # - +prepare+
-      #
-      # which autodetects if EventMachine is running and uses appropriate
-      # (async or sync) method version.
-      #
-      # Async methods might try to reset connection on connection error,
-      # you won't even notice that (except for warning message from PG).
-      #
-      # To disable such behavior set:
-      #   client.async_autoreconnect = false
+
+      attr_accessor :async_autoreconnect
+      
+      # +on_reconnect+ is a user defined Proc that is called after a connection
+      # with the server has been re-established.
+      # It's invoked with +connection+ as first argument and original
+      # +exception+ that caused the reconnecting process as second argument.
       #
-      # or pass as new() hash argument:
-      #   PG::EM::Client.new database: 'bar', async_autoreconnect: false
+      # Certain rules should apply to on_reconnect proc:
       #
-      # Otherwise nothing changes in PG::Connect API.
-      # See PG::Connect docs for arguments to above methods.
+      # - +async_autoreconnect+ is switched off (do not try to change it from
+      #   inside on_reconnect proc).
+      # - If proc returns +false+ (explicitly, +nil+ is ignored)
+      #   the original +exception+ is raised and the send query command is
+      #   not invoked at all.
+      # - If return value responds to +callback+ and +errback+ methods
+      #   (like +Deferrable+), the send query command will be bound to this
+      #   deferrable's success callback. Otherwise the send query command is called
+      #   immediately after on_reconnect proc is executed.
+      # - Other return values are ignored.
       #
-      # *Warning:*
+      # You may pass this proc as +:on_reconnect+ option to PG::EM::Client.new.
       #
-      # +async_exec_prepared+ after +async_prepare+ should only be invoked on
-      # the *same* connection.
-      # If you are using connection pool, make sure to acquire single connection first.
+      # Example:
+      #   pg.on_reconnect = proc do |conn, ex|
+      #     conn.prepare("birds_by_name", "select id, name from animals order by name where species=$1", ['birds'])
+      #   end
       #
-
-      attr_accessor :async_autoreconnect
+      attr_accessor :on_reconnect
 
       module Watcher
         def initialize(client, deferrable)
@@ -66,11 +93,16 @@ module PG
 
       def initialize(*args)
         @async_autoreconnect = true
+        @on_reconnect = nil
         if args.last.is_a? Hash
           args.last.reject! do |key, value|
-            if key.to_s == 'async_autoreconnect'
+            case key.to_s
+            when 'async_autoreconnect'
               @async_autoreconnect = !!value
               true
+            when 'on_reconnect'
+              @on_reconnect = value if value.respond_to? :call
+              true
             end
           end
         end
@@ -85,22 +117,41 @@ module PG
 
         class_eval <<-EOD
         def async_#{name}(*args, &blk)
+          df = ::EM::DefaultDeferrable.new
+          if block_given?
+            df.callback(&blk)
+            df.errback(&blk)
+          end
           begin
             #{send_name}(*args)
           rescue PG::Error => e
             if self.status != PG::CONNECTION_OK && async_autoreconnect
               reset
-              #{send_name}(*args)
+              if on_reconnect
+                begin
+                  self.async_autoreconnect = false
+                  returned_df = on_reconnect.call(self, e)
+                  raise e if returned_df == false
+                  if returned_df.respond_to?(:callback) && returned_df.respond_to?(:errback)
+                    returned_df.callback do
+                      #{send_name}(*args)
+                      ::EM.watch(self.socket, Watcher, self, df).notify_readable = true
+                    end
+                    returned_df.errback do |ex|
+                      df.fail(ex)
+                    end
+                    return df
+                  end
+                ensure
+                  self.async_autoreconnect = true
+                end
+              end
+              #{send_name}(*args) 
             else
               raise e
             end
           end
-          df = ::EM::DefaultDeferrable.new
           ::EM.watch(self.socket, Watcher, self, df).notify_readable = true
-          if block_given?
-            df.callback(&blk)
-            df.errback(&blk)
-          end
           df
         end
         EOD

data/spec/{em_client.rb → em_devel_client.rb}

@@ -1,4 +1,5 @@
 $:.unshift "lib"
+gem 'eventmachine', '>= 1.0.0.beta.1'
 require 'date'
 require 'eventmachine'
 require 'pg/em'
@@ -6,8 +7,10 @@ require 'pg/em'
 describe PG::EM::Client do
 
   it "should create simple table `foo`" do
-    @client.query('DROP TABLE IF EXISTS foo') do
-      @client.query('CREATE TABLE foo (id integer,cdate timestamp with time zone,data varchar)') do
+    @client.query('DROP TABLE IF EXISTS foo') do |result|
+      raise result if result.is_a? ::Exception
+      @client.query('CREATE TABLE foo (id integer,cdate timestamp with time zone,data varchar)') do |result|
+        raise result if result.is_a? ::Exception
         EM.stop
       end
     end
@@ -16,6 +19,7 @@ describe PG::EM::Client do
   it "should populate foo with some data " do
     EM::Iterator.new(@values).map(proc{ |(data, id), iter|
       @client.query('INSERT INTO foo (id,cdate,data) VALUES($1,$2,$3) returning cdate', [id, DateTime.now, data]) do |result|
+        raise result if result.is_a? ::Exception
         iter.return(DateTime.parse(result[0]['cdate']))
       end
     }, proc{ |results|
@@ -27,8 +31,10 @@ describe PG::EM::Client do
   end
 
   it "should read foo table with prepared statement" do
-    @client.prepare('get_foo', 'SELECT * FROM foo order by id') do
+    @client.prepare('get_foo', 'SELECT * FROM foo order by id') do |result|
+      raise result if result.is_a? ::Exception
       @client.exec_prepared('get_foo') do |result|
+        raise result if result.is_a? ::Exception
         result.each_with_index do |row, i|
           row['id'].to_i.should == i
           DateTime.parse(row['cdate']).should == @cdates[i]

data/spec/em_release_client.rb

@@ -0,0 +1,69 @@
+$:.unshift "lib"
+gem 'eventmachine', '= 0.12.10'
+require 'date'
+require 'eventmachine'
+require 'pg/em'
+
+describe PG::EM::Client do
+
+  it "should create simple table `foo`" do
+    @client.query('DROP TABLE IF EXISTS foo') do |result|
+      raise result if result.is_a? ::Exception
+      @client.query('CREATE TABLE foo (id integer,cdate timestamp with time zone,data varchar)') do |result|
+        raise result if result.is_a? ::Exception
+        EM.stop
+      end
+    end
+  end
+
+  it "should populate foo with some data " do
+    values = @values.dup
+    results = []
+    do_query = proc do
+      data, id = values.shift
+      @client.query('INSERT INTO foo (id,cdate,data) VALUES($1,$2,$3) returning cdate', [id, DateTime.now, data]) do |result|
+        raise result if result.is_a? ::Exception
+        results << DateTime.parse(result[0]['cdate'])
+        if values.empty?
+          @cdates.replace results
+          results.length.should == @values.length
+          results.each {|r| r.class.should == DateTime }
+          EM.stop
+        else
+          do_query.call
+        end
+      end
+    end
+    do_query.call
+  end
+
+  it "should read foo table with prepared statement" do
+    @client.prepare('get_foo', 'SELECT * FROM foo order by id') do
+      @client.exec_prepared('get_foo') do |result|
+        raise result if result.is_a? ::Exception
+        result.each_with_index do |row, i|
+          row['id'].to_i.should == i
+          DateTime.parse(row['cdate']).should == @cdates[i]
+          row['data'].should == @values[i][0]
+        end
+        EM.stop
+      end
+    end
+  end
+  
+  around(:each) do |testcase|
+    EM.run &testcase
+  end
+
+  before(:all) do
+    @cdates = []
+    @values = Array(('AA'..'ZZ').each_with_index)
+    @client = PG::EM::Client.new(dbname: 'test')
+    @client.query 'BEGIN TRANSACTION'
+  end
+
+  after(:all) do
+    @client.query 'ROLLBACK TRANSACTION'
+    @client.close
+  end
+end

metadata

@@ -1,126 +1,124 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: em-pg-client
-version: !ruby/object:Gem::Version
-  version: 0.1.0
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.1.1
 platform: ruby
-authors:
+authors: 
 - Rafal Michalski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-04-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: pg
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.13.2
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 0.13.2
-- !ruby/object:Gem::Dependency
-  name: eventmachine
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.12.10
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 0.12.10
-- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 2.8.0
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-- !ruby/object:Gem::Dependency
-  name: em-synchrony
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0.beta.1
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: em-synchrony
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.0.0
+  type: :development
+  version_requirements: *id005
 description: PostgreSQL asynchronous EventMachine client (ruby-pg) wrapper
 email: rafal@yeondir.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.rdoc
 - BENCHMARKS.rdoc
-files:
+files: 
 - BENCHMARKS.rdoc
+- HISTORY.rdoc
 - README.rdoc
 - Rakefile
 - benchmarks/em_pg.rb
 - em-pg-client.gemspec
 - lib/em-synchrony/pg.rb
 - lib/pg/em.rb
-- spec/em_client.rb
+- spec/em_devel_client.rb
+- spec/em_release_client.rb
 - spec/em_synchrony_client.rb
 homepage: http://github.com/royaltm/ruby-em-pg-client
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --title
 - em-pg-client
 - --main
 - README.rdoc
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
       version: 1.9.1
-required_rubygems_version: !ruby/object:Gem::Requirement
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-requirements:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: 
 - PostgreSQL server
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: EventMachine PostgreSQL client
-test_files:
-- spec/em_client.rb
+test_files: 
 - spec/em_synchrony_client.rb
+- spec/em_devel_client.rb
+- spec/em_release_client.rb