cipherstash-pg 1.0.0.beta.1-x86_64-darwin-22 → 1.0.0.beta.3-x86_64-darwin-22

data/lib/cipherstash-pg.rb

@@ -1,15 +1,60 @@
-require_relative './pg'
+# -*- ruby -*-
+# frozen_string_literal: true
 
-module CipherStash
-  module PG
-    DB_EXT_DIR = File.join(__dir__, '../vendor/database-extensions')
+module CipherStashPG
+  # cipherstash-pg *always* ships a "fat" gem with precompiled libs for
+  # each popular major.minor version of Ruby that is still in use.
+  major_minor = RUBY_VERSION[ /^(\d+\.\d+)/ ] or
+    raise "Oops, can't extract the major/minor version from #{RUBY_VERSION.dump}"
+  begin
+    require "#{major_minor}/pg_ext"
+  rescue => e
+    STDERR.puts "Failed to load pg_ext for #{RUBY_VERSION.dump}"
+    exit 1
+  end
+
+  # Provide a means to read the extension installation scripts
+  DB_EXT_DIR = File.join(__dir__, '../vendor/database-extensions')
+  def self.install_script
+    File.read(File.join(DB_EXT_DIR, "install.sql"))
+  end
+
+  def self.uninstall_script
+    File.read(File.join(DB_EXT_DIR, "uninstall.sql"))
+  end
+
+  class NotAllCopyDataRetrieved < CipherStashPG::Error
+  end
+
+  class NotInBlockingMode < CipherStashPG::Error
+  end
 
-    def self.install_script
-      File.read(File.join(DB_EXT_DIR, "install.sql"))
-    end
+  # Get the CipherStashPG library version.
+  #
+  # +include_buildnum+ is no longer used and any value passed will be ignored.
+  def self.version_string( include_buildnum=nil )
+    "%s %s" % [ self.name, VERSION ]
+  end
 
-    def self.uninstall_script
-      File.read(File.join(DB_EXT_DIR, "uninstall.sql"))
-    end
+  ### Convenience alias for CipherStashPG::Connection.new.
+  def self.connect( *args, &block )
+    Connection.new( *args, &block )
   end
-end
+
+  require 'cipherstash-pg/exceptions'
+  require 'cipherstash-pg/constants'
+  require 'cipherstash-pg/coder'
+  require 'cipherstash-pg/binary_decoder'
+  require 'cipherstash-pg/text_encoder'
+  require 'cipherstash-pg/text_decoder'
+  require 'cipherstash-pg/basic_type_registry'
+  require 'cipherstash-pg/basic_type_map_based_on_result'
+  require 'cipherstash-pg/basic_type_map_for_queries'
+  require 'cipherstash-pg/basic_type_map_for_results'
+  require 'cipherstash-pg/type_map_by_column'
+  require 'cipherstash-pg/connection'
+  require 'cipherstash-pg/result'
+  require 'cipherstash-pg/tuple'
+  require 'cipherstash-pg/version'
+
+end # module CipherStashPG

data/misc/openssl-pg-segfault.rb

@@ -1,31 +1,21 @@
-# -*- ruby -*-
-
-PGHOST   = 'localhost'
-PGDB     = 'test'
-#SOCKHOST = 'github.com'
-SOCKHOST = 'it-trac.laika.com'
-
-# Load pg first, so the libssl.so that libpq is linked against is loaded.
-require 'pg'
-$stderr.puts "connecting to postgres://#{PGHOST}/#{PGDB}"
-conn = PG.connect( PGHOST, :dbname => PGDB )
-
-# Now load OpenSSL, which might be linked against a different libssl.
-require 'socket'
-require 'openssl'
-$stderr.puts "Connecting to #{SOCKHOST}"
-sock = TCPSocket.open( SOCKHOST, 443 )
+PGHOST = "localhost"
+PGDB = "test"
+SOCKHOST = "it-trac.laika.com"
+require("cipherstash-pg")
+$stderr.puts("connecting to postgres://#{PGHOST}/#{PGDB}")
+conn = CipherStashPG.connect(PGHOST, :dbname => (PGDB))
+require("socket")
+require("openssl")
+$stderr.puts("Connecting to #{SOCKHOST}")
+sock = TCPSocket.open(SOCKHOST, 443)
 ctx = OpenSSL::SSL::SSLContext.new
-sock = OpenSSL::SSL::SSLSocket.new( sock, ctx )
+sock = OpenSSL::SSL::SSLSocket.new(sock, ctx)
 sock.sync_close = true
-
-# The moment of truth...
-$stderr.puts "Attempting to connect..."
+$stderr.puts("Attempting to connect...")
 begin
-	sock.connect
+  sock.connect
 rescue Errno
-	$stderr.puts "Got an error connecting, but no segfault."
+  $stderr.puts("Got an error connecting, but no segfault.")
 else
-	$stderr.puts "Nope, no segfault!"
+  $stderr.puts("Nope, no segfault!")
 end
-

data/misc/postgres/Rakefile

@@ -1,21 +1,14 @@
-# -*- ruby -*-
-
-require 'date'
-require 'rubygems'
-require 'hoe'
-require 'pp'
-
-Hoe.spec 'postgres' do
-	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
-	self.dependency 'pg', '~> 0'
-	self.spec_extras[:date] = Date.parse( '2008/01/30' )
-
-	line = '-' * 75
-	msg = paragraphs_of( 'README.txt', 3..-1 )
-	msg.unshift( line )
-	msg.push( line )
-
-	self.spec_extras[:post_install_message] = msg.join( "\n\n" ) + "\n"
+require("date")
+require("rubygems")
+require("hoe")
+require("pp")
+Hoe.spec("postgres") do
+  self.developer("Michael Granger", "ged@FaerieMUD.org")
+  self.dependency("pg", "~> 0")
+  self.spec_extras[:date] = Date.parse("2008/01/30")
+  line = ("-" * 75)
+  msg = paragraphs_of("README.txt", (3..-1))
+  msg.unshift(line)
+  msg.push(line)
+  self.spec_extras[:post_install_message] = (msg.join("\n\n") + "\n")
 end
-
-# vim: syntax=ruby

data/misc/postgres/lib/postgres.rb

@@ -1,16 +1,12 @@
-# -*- ruby -*-
-
-require 'pathname'
-
+require("pathname")
 module Postgres
-
-	VERSION = '0.8.1'
-
-	gemdir = Pathname( __FILE__ ).dirname.parent
-	readme = gemdir + 'README.txt'
-
-	header, message = readme.read.split( /^== Description/m )
-	abort( message.strip )
-
+  VERSION = "0.8.1"
+  
+  gemdir = Pathname("(string)").dirname.parent
+  
+  readme = (gemdir + "README.txt")
+  
+  header, message = readme.read.split(/^== Description/m)
+  
+  abort(message.strip)
 end
-

data/misc/ruby-pg/Rakefile

@@ -1,21 +1,14 @@
-# -*- ruby -*-
-
-require 'date'
-require 'rubygems'
-require 'hoe'
-require 'pp'
-
-Hoe.spec 'ruby-pg' do
-	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
-	self.dependency 'pg', '~> 0'
-	self.spec_extras[:date] = Date.parse( '2008/01/30' )
-
-	line = '-' * 75
-	msg = paragraphs_of( 'README.txt', 3..-1 )
-	msg.unshift( line )
-	msg.push( line )
-
-	self.spec_extras[:post_install_message] = msg.join( "\n\n" ) + "\n"
+require("date")
+require("rubygems")
+require("hoe")
+require("pp")
+Hoe.spec("ruby-pg") do
+  self.developer("Michael Granger", "ged@FaerieMUD.org")
+  self.dependency("pg", "~> 0")
+  self.spec_extras[:date] = Date.parse("2008/01/30")
+  line = ("-" * 75)
+  msg = paragraphs_of("README.txt", (3..-1))
+  msg.unshift(line)
+  msg.push(line)
+  self.spec_extras[:post_install_message] = (msg.join("\n\n") + "\n")
 end
-
-# vim: syntax=ruby

data/misc/ruby-pg/lib/ruby/pg.rb

@@ -1,16 +1,12 @@
-# -*- ruby -*-
-
-require 'pathname'
-
+require("pathname")
 module Pg
-
-	VERSION = '0.8.0'
-
-	gemdir = Pathname( __FILE__ ).dirname.parent.parent
-	readme = gemdir + 'README.txt'
-
-	header, message = readme.read.split( /^== Description/m )
-	abort( message.strip )
-
+  VERSION = "0.8.0"
+  
+  gemdir = Pathname("(string)").dirname.parent.parent
+  
+  readme = (gemdir + "README.txt")
+  
+  header, message = readme.read.split(/^== Description/m)
+  
+  abort(message.strip)
 end
-

data/rakelib/task_extension.rb

@@ -1,46 +1,32 @@
-# This source code is borrowed from:
-# https://github.com/oneclick/rubyinstaller2/blob/b3dcbf69f131e44c78ea3a1c5e0041c223f266ce/lib/ruby_installer/build/utils.rb#L104-L144
-
 module TaskExtension
-  # Extend rake's file task to be defined only once and to check the expected file is indeed generated
-  #
-  # The same as #task, but for #file.
-  # In addition this file task raises an error, if the file that is expected to be generated is not present after the block was executed.
   def file(name, *args, &block)
     task_once(name, block) do
       super(name, *args) do |ta|
         block&.call(ta).tap do
-          raise "file #{ta.name} is missing after task executed" unless File.exist?(ta.name)
+          unless File.exist?(ta.name) then
+            raise("file #{ta.name} is missing after task executed")
+          end
         end
       end
     end
   end
-
-  # Extend rake's task definition to be defined only once, even if called several times
-  #
-  # This allows to define common tasks next to specific tasks.
-  # It is expected that any variation of the task's block is reflected in the task name or namespace.
-  # If the task name is identical, the task block is executed only once, even if the file task definition is executed twice.
+  
   def task(name, *args, &block)
-    task_once(name, block) do
-      super
-    end
+    task_once(name, block) { super }
   end
-
-  private def task_once(name, block)
+  
+  private(def task_once(name, block)
     name = name.keys.first if name.is_a?(Hash)
-    if block &&
-        Rake::Task.task_defined?(name) &&
-        Rake::Task[name].instance_variable_get('@task_block_location') == block.source_location
-      # task is already defined for this target and the same block
-      # So skip double definition of the same action
+    if block and (Rake::Task.task_defined?(name) and (Rake::Task[name].instance_variable_get("@task_block_location") == block.source_location)) then
       Rake::Task[name]
-    elsif block
-      yield.tap do
-        Rake::Task[name].instance_variable_set('@task_block_location', block.source_location)
-      end
     else
-      yield
+      if block then
+        yield.tap do
+          Rake::Task[name].instance_variable_set("@task_block_location", block.source_location)
+        end
+      else
+        yield
+      end
     end
-  end
-end
+  end)
+end

data/sample/array_insert.rb

@@ -1,20 +1,7 @@
-# -*- ruby -*-
-
-require 'pg'
-
-c = PG.connect( dbname: 'test' )
-
-# this one works:
-c.exec( "DROP TABLE IF EXISTS foo" )
-c.exec( "CREATE TABLE foo (strings character varying[]);" )
-
-# But using a prepared statement works:
-c.set_error_verbosity( PG::PQERRORS_VERBOSE )
-c.prepare( 'stmt', "INSERT INTO foo VALUES ($1);" )
-
-# This won't work
-#c.exec_prepared( 'stmt', ["ARRAY['this','that']"] )
-
-# but this will:
-c.exec_prepared( 'stmt', ["{'this','that'}"] )
-
+require("cipherstash-pg")
+c = CipherStashPG.connect(:dbname => "test")
+c.exec("DROP TABLE IF EXISTS foo")
+c.exec("CREATE TABLE foo (strings character varying[]);")
+c.set_error_verbosity(CipherStashPG::PQERRORS_VERBOSE)
+c.prepare("stmt", "INSERT INTO foo VALUES ($1);")
+c.exec_prepared("stmt", ["{'this','that'}"])

data/sample/async_api.rb

@@ -1,102 +1,60 @@
-# -*- ruby -*-
-
-require 'pg'
-
-# This is a example of how to use the asynchronous API to query the
-# server without blocking other threads. It's intentionally low-level;
-# if you hooked up the PG::Connection#socket to some kind of reactor, you
-# could make this much nicer.
-
-TIMEOUT = 5.0 # seconds to wait for an async operation to complete
-
-# Print 'x' continuously to demonstrate that other threads aren't
-# blocked while waiting for the connection, for the query to be sent,
-# for results, etc. You might want to sleep inside the loop or
-# comment this out entirely for cleaner output.
-progress_thread = Thread.new { loop { print 'x' } }
-
-# Output progress messages
-def output_progress( msg )
-	puts "\n>>> #{msg}\n"
+require("cipherstash-pg")
+TIMEOUT = 5.0
+progress_thread = Thread.new { loop { print("x") } }
+def output_progress(msg)
+  puts("\n>>> #{msg}\n")
 end
-
-# Start the connection
-output_progress "Starting connection..."
-conn = PG::Connection.connect_start( :dbname => 'test' ) or
-	abort "Unable to create a new connection!"
-abort "Connection failed: %s" % [ conn.error_message ] if
-	conn.status == PG::CONNECTION_BAD
-
-# Track the progress of the connection, waiting for the socket to become readable/writable
-# before polling it
-poll_status = PG::PGRES_POLLING_WRITING
-until poll_status == PG::PGRES_POLLING_OK ||
-	  poll_status == PG::PGRES_POLLING_FAILED
-
-	# If the socket needs to read, wait 'til it becomes readable to poll again
-	case poll_status
-	when PG::PGRES_POLLING_READING
-		output_progress "  waiting for socket to become readable"
-		select( [conn.socket_io], nil, nil, TIMEOUT ) or
-			raise "Asynchronous connection timed out!"
-
-	# ...and the same for when the socket needs to write
-	when PG::PGRES_POLLING_WRITING
-		output_progress "  waiting for socket to become writable"
-		select( nil, [conn.socket_io], nil, TIMEOUT ) or
-			raise "Asynchronous connection timed out!"
-	end
-
-	# Output a status message about the progress
-	case conn.status
-	when PG::CONNECTION_STARTED
-		output_progress "  waiting for connection to be made."
-	when PG::CONNECTION_MADE
-		output_progress "  connection OK; waiting to send."
-	when PG::CONNECTION_AWAITING_RESPONSE
-		output_progress "  waiting for a response from the server."
-	when PG::CONNECTION_AUTH_OK
-		output_progress "  received authentication; waiting for backend start-up to finish."
-	when PG::CONNECTION_SSL_STARTUP
-		output_progress "  negotiating SSL encryption."
-	when PG::CONNECTION_SETENV
-		output_progress "  negotiating environment-driven parameter settings."
-	when PG::CONNECTION_NEEDED
-		output_progress "  internal state: connect() needed."
-	end
-
-	# Check to see if it's finished or failed yet
-	poll_status = conn.connect_poll
+output_progress("Starting connection...")
+(conn = CipherStashPG::Connection.connect_start(:dbname => "test") or abort("Unable to create a new connection!"))
+if (conn.status == CipherStashPG::CONNECTION_BAD) then
+  abort(("Connection failed: %s" % [conn.error_message]))
 end
-
-abort "Connect failed: %s" % [ conn.error_message ] unless conn.status == PG::CONNECTION_OK
-
-output_progress "Sending query"
-conn.send_query( "SELECT * FROM pg_stat_activity" )
-
-# Fetch results until there aren't any more
+poll_status = CipherStashPG::PGRES_POLLING_WRITING
+until ((poll_status == CipherStashPG::PGRES_POLLING_OK) or (poll_status == CipherStashPG::PGRES_POLLING_FAILED)) do
+  (case poll_status
+  when CipherStashPG::PGRES_POLLING_READING then
+    output_progress("  waiting for socket to become readable")
+    (select([conn.socket_io], nil, nil, TIMEOUT) or raise("Asynchronous connection timed out!"))
+  when CipherStashPG::PGRES_POLLING_WRITING then
+    output_progress("  waiting for socket to become writable")
+    (select(nil, [conn.socket_io], nil, TIMEOUT) or raise("Asynchronous connection timed out!"))
+  end
+  case conn.status
+  when CipherStashPG::CONNECTION_STARTED then
+    output_progress("  waiting for connection to be made.")
+  when CipherStashPG::CONNECTION_MADE then
+    output_progress("  connection OK; waiting to send.")
+  when CipherStashPG::CONNECTION_AWAITING_RESPONSE then
+    output_progress("  waiting for a response from the server.")
+  when CipherStashPG::CONNECTION_AUTH_OK then
+    output_progress("  received authentication; waiting for backend start-up to finish.")
+  when CipherStashPG::CONNECTION_SSL_STARTUP then
+    output_progress("  negotiating SSL encryption.")
+  when CipherStashPG::CONNECTION_SETENV then
+    output_progress("  negotiating environment-driven parameter settings.")
+  when CipherStashPG::CONNECTION_NEEDED then
+    output_progress("  internal state: connect() needed.")
+  end
+  poll_status = conn.connect_poll)
+end
+unless (conn.status == CipherStashPG::CONNECTION_OK) then
+  abort(("Connect failed: %s" % [conn.error_message]))
+end
+output_progress("Sending query")
+conn.send_query("SELECT * FROM pg_stat_activity")
 loop do
-	output_progress "  waiting for a response"
-
-	# Buffer any incoming data on the socket until a full result is ready.
-	conn.consume_input
-	while conn.is_busy
-		select( [conn.socket_io], nil, nil, TIMEOUT ) or
-			raise "Timeout waiting for query response."
-		conn.consume_input
-	end
-
-	# Fetch the next result. If there isn't one, the query is finished
-	result = conn.get_result or break
-
-	puts "\n\nQuery result:\n%p\n" % [ result.values ]
+  output_progress("  waiting for a response")
+  conn.consume_input
+  while conn.is_busy do
+    (select([conn.socket_io], nil, nil, TIMEOUT) or raise("Timeout waiting for query response."))
+    conn.consume_input
+  end
+  (result = conn.get_result or break)
+  puts(("\n\nQuery result:\n%p\n" % [result.values]))
 end
-
-output_progress "Done."
+output_progress("Done.")
 conn.finish
-
-if defined?( progress_thread )
-	progress_thread.kill
-	progress_thread.join
+if defined? progress_thread then
+  progress_thread.kill
+  progress_thread.join
 end
-

data/sample/async_copyto.rb

@@ -1,39 +1,24 @@
-# -*- ruby -*-
-
-require 'pg'
-require 'stringio'
-
-# Using COPY asynchronously
-
-$stderr.puts "Opening database connection ..."
-conn = PG.connect( :dbname => 'test' )
-conn.setnonblocking( true )
-
+require("cipherstash-pg")
+require("stringio")
+$stderr.puts("Opening database connection ...")
+conn = CipherStashPG.connect(:dbname => "test")
+conn.setnonblocking(true)
 socket = conn.socket_io
-
-$stderr.puts "Running COPY command ..."
-buf = ''
+$stderr.puts("Running COPY command ...")
+buf = ""
 conn.transaction do
-	conn.send_query( "COPY logs TO STDOUT WITH csv" )
-	buf = nil
-
-	# #get_copy_data returns a row if there's a whole one to return, false
-	# if there isn't one but the COPY is still running, or nil when it's
-	# finished.
-	begin
-		$stderr.puts "COPY loop"
-		conn.consume_input
-		while conn.is_busy
-			$stderr.puts "  ready loop"
-			select( [socket], nil, nil, 5.0 ) or
-				raise "Timeout (5s) waiting for query response."
-			conn.consume_input
-		end
-
-		buf = conn.get_copy_data
-		$stdout.puts( buf ) if buf
-	end until buf.nil?
+  conn.send_query("COPY logs TO STDOUT WITH csv")
+  buf = nil
+  begin
+    ($stderr.puts("COPY loop")
+    conn.consume_input
+    while conn.is_busy do
+      $stderr.puts("  ready loop")
+      (select([socket], nil, nil, 5.0) or raise("Timeout (5s) waiting for query response."))
+      conn.consume_input
+    end
+    buf = conn.get_copy_data
+    $stdout.puts(buf) if buf)
+  end until buf.nil?
 end
-
 conn.finish
-

data/sample/async_mixed.rb

@@ -1,56 +1,28 @@
-# -*- ruby -*-
-
-require 'pg'
-
+require("cipherstash-pg")
 $stdout.sync = true
-
-# This is a example of how to mix and match synchronous and async APIs. In this case,
-# the connection to the server is made syncrhonously, and then queries are
-# asynchronous.
-
-TIMEOUT = 5.0 # seconds to wait for an async operation to complete
-CONN_OPTS = {
-	:host     => 'localhost',
-	:dbname   => 'test',
-}
-
-# Output progress messages
-def output_progress( msg )
-	puts ">>> #{msg}\n"
+TIMEOUT = 5.0
+CONN_OPTS = { :host => "localhost", :dbname => "test" }
+def output_progress(msg)
+  puts(">>> #{msg}\n")
+end
+output_progress("Starting connection...")
+(conn = CipherStashPG.connect(CONN_OPTS) or abort("Unable to create a new connection!"))
+unless (conn.status == CipherStashPG::CONNECTION_OK) then
+  abort(("Connect failed: %s" % [conn.error_message]))
 end
-
-# Start the (synchronous) connection
-output_progress "Starting connection..."
-conn = PG.connect( CONN_OPTS ) or abort "Unable to create a new connection!"
-
-abort "Connect failed: %s" % [ conn.error_message ] unless conn.status == PG::CONNECTION_OK
-
-# Now grab a reference to the underlying socket to select() on while the query is running
 socket = conn.socket_io
-
-# Send the (asynchronous) query
-output_progress "Sending query"
-conn.send_query( "SELECT * FROM pg_stat_activity" )
-
-# Fetch results until there aren't any more
+output_progress("Sending query")
+conn.send_query("SELECT * FROM pg_stat_activity")
 loop do
-	output_progress "  waiting for a response"
-
-	# Buffer any incoming data on the socket until a full result is ready.
-	conn.consume_input
-	while conn.is_busy
-		output_progress "  waiting for data to be available on %p..." % [ socket ]
-		select( [socket], nil, nil, TIMEOUT ) or
-			raise "Timeout waiting for query response."
-		conn.consume_input
-	end
-
-	# Fetch the next result. If there isn't one, the query is finished
-	result = conn.get_result or break
-
-	output_progress "Query result:\n%p\n" % [ result.values ]
+  output_progress("  waiting for a response")
+  conn.consume_input
+  while conn.is_busy do
+    output_progress(("  waiting for data to be available on %p..." % [socket]))
+    (select([socket], nil, nil, TIMEOUT) or raise("Timeout waiting for query response."))
+    conn.consume_input
+  end
+  (result = conn.get_result or break)
+  output_progress(("Query result:\n%p\n" % [result.values]))
 end
-
-output_progress "Done."
+output_progress("Done.")
 conn.finish
-