pg_audit_log 0.3.6 → 0.4.0

data/README.rdoc

@@ -13,19 +13,11 @@ Compatible with Rails 3.0.x and 3.1.x
 
 == INSTALL
 
-=== Enable custom variables in your postgresql instance
+=== Enable plpgsql langauges in your postgresql instance
 
-  To enable auditing you need to set a variable in your postgresql.conf file:
+  As a superuser in postgres make sure your database has plpgsql enabled:
 
-  For macports: /opt/local/var/db/postgresql84/defaultdb/postgresql.conf
-  For homebrew: /usr/local/var/postgres/postgresql.conf
-  For linux: it varies from distro to distro.
-
-  At the bottom of the file add the following:
-
-    custom_variable_classes = 'audit'
-
-  Then restart your PostgreSQL server
+  CREATE OR REPLACE PROCEDURAL LANGUAGE plpgsql;
 
 === Rails 3
 

data/lib/pg_audit_log.rb

@@ -7,6 +7,7 @@ require "pg_audit_log/version"
 
 case ::ActiveRecord::VERSION::MAJOR
 when 3
+  require "pg_audit_log/extensions/shared/postgresql_adapter.rb"
   if ::ActiveRecord::VERSION::MINOR == 0
     require "pg_audit_log/extensions/3.0/postgresql_adapter.rb"
   else

data/lib/pg_audit_log/extensions/3.0/postgresql_adapter.rb

@@ -3,11 +3,9 @@ require "active_record/connection_adapters/postgresql_adapter"
 # Did not want to reopen the class but sending an include seemingly is not working.
 class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
   def execute_with_auditing(sql, name = nil)
-    current_user = Thread.current[:current_user]
-    user_unique_name = current_user.try(:unique_name) || "UNKNOWN"
-
-    log_user_id = %[SET audit.user_id = #{current_user.try(:id) || "-1"}]
-    log_user_unique_name = %[SET audit.user_unique_name = "#{user_unique_name}"]
+    user_id, unique_name = user_id_and_name
+    log_user_id = PgAuditLog::Function.user_identifier_temporary_function(user_id)
+    log_user_unique_name = PgAuditLog::Function.user_unique_name_temporary_function(unique_name)
 
     log([log_user_id, log_user_unique_name, sql].join("; "), name) do
       if @async
@@ -23,62 +21,5 @@ class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
   end
 
   alias_method_chain :execute, :auditing
-
-  def begin_db_transaction
-    execute_without_auditing "BEGIN"
-  end
-
-  # Commits a transaction.
-  def commit_db_transaction
-    execute_without_auditing "COMMIT"
-  end
-
-  # Aborts a transaction.
-  def rollback_db_transaction
-    execute_without_auditing "ROLLBACK"
-  end
-
-  def create_savepoint
-    execute_without_auditing("SAVEPOINT #{current_savepoint_name}")
-  end
-
-  def rollback_to_savepoint
-    execute_without_auditing("ROLLBACK TO SAVEPOINT #{current_savepoint_name}")
-  end
-
-  def release_savepoint
-    execute_without_auditing("RELEASE SAVEPOINT #{current_savepoint_name}")
-  end
-
-  def drop_table_with_auditing(table_name, options = {})
-    if PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
-      PgAuditLog::Triggers.drop_for_table(table_name)
-    end
-    drop_table_without_auditing(table_name, options)
-  end
-  alias_method_chain :drop_table, :auditing
-
-  def create_table_with_auditing(table_name, options = {}, &block)
-    create_table_without_auditing(table_name, options, &block)
-    unless options[:temporary] ||
-      PgAuditLog::IGNORED_TABLES.include?(table_name) ||
-      PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
-      PgAuditLog::Triggers.create_for_table(table_name)
-    end
-  end
-  alias_method_chain :create_table, :auditing
-
-  def rename_table_with_auditing(table_name, new_name)
-    rename_table_without_auditing(table_name, new_name)
-    if PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
-      PgAuditLog::Triggers.drop_for_table(table_name)
-    end
-    unless PgAuditLog::IGNORED_TABLES.include?(table_name) ||
-      PgAuditLog::Triggers.tables_with_triggers.include?(new_name)
-      PgAuditLog::Triggers.create_for_table(new_name)
-    end
-  end
-  alias_method_chain :rename_table, :auditing
-
 end
 

data/lib/pg_audit_log/extensions/3.1/postgresql_adapter.rb

@@ -3,11 +3,9 @@ require "active_record/connection_adapters/postgresql_adapter"
 # Did not want to reopen the class but sending an include seemingly is not working.
 class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
   def generate_auditing_sql(sql)
-    current_user = Thread.current[:current_user]
-    user_unique_name = current_user.try(:unique_name) || "UNKNOWN"
-
-    log_user_id = %[SET audit.user_id = #{current_user.try(:id) || "-1"}]
-    log_user_unique_name = %[SET audit.user_unique_name = "#{user_unique_name}"]
+    user_id, unique_name = user_id_and_name
+    log_user_id = PgAuditLog::Function.user_identifier_temporary_function(user_id)
+    log_user_unique_name = PgAuditLog::Function.user_unique_name_temporary_function(unique_name)
     { :user_id => log_user_id, :unique_name => log_user_unique_name, :sql => sql }
   end
 
@@ -32,62 +30,5 @@ class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
     end
   end
   alias_method_chain :execute, :auditing
-
-  def begin_db_transaction
-    execute_without_auditing "BEGIN"
-  end
-
-  # Commits a transaction.
-  def commit_db_transaction
-    execute_without_auditing "COMMIT"
-  end
-
-  # Aborts a transaction.
-  def rollback_db_transaction
-    execute_without_auditing "ROLLBACK"
-  end
-
-  def create_savepoint
-    execute_without_auditing("SAVEPOINT #{current_savepoint_name}")
-  end
-
-  def rollback_to_savepoint
-    execute_without_auditing("ROLLBACK TO SAVEPOINT #{current_savepoint_name}")
-  end
-
-  def release_savepoint
-    execute_without_auditing("RELEASE SAVEPOINT #{current_savepoint_name}")
-  end
-
-  def drop_table_with_auditing(table_name, options = {})
-    if PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
-      PgAuditLog::Triggers.drop_for_table(table_name)
-    end
-    drop_table_without_auditing(table_name, options)
-  end
-  alias_method_chain :drop_table, :auditing
-
-  def create_table_with_auditing(table_name, options = {}, &block)
-    create_table_without_auditing(table_name, options, &block)
-    unless options[:temporary] ||
-      PgAuditLog::IGNORED_TABLES.include?(table_name) ||
-      PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
-      PgAuditLog::Triggers.create_for_table(table_name)
-    end
-  end
-  alias_method_chain :create_table, :auditing
-
-  def rename_table_with_auditing(table_name, new_name)
-    rename_table_without_auditing(table_name, new_name)
-    if PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
-      PgAuditLog::Triggers.drop_for_table(table_name)
-    end
-    unless PgAuditLog::IGNORED_TABLES.include?(table_name) ||
-      PgAuditLog::Triggers.tables_with_triggers.include?(new_name)
-      PgAuditLog::Triggers.create_for_table(new_name)
-    end
-  end
-  alias_method_chain :rename_table, :auditing
-
 end
 

data/lib/pg_audit_log/extensions/shared/postgresql_adapter.rb

@@ -0,0 +1,68 @@
+require "active_record/connection_adapters/postgresql_adapter"
+
+# Did not want to reopen the class but sending an include seemingly is not working.
+class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+  def begin_db_transaction
+    execute_without_auditing "BEGIN"
+  end
+
+  def commit_db_transaction
+    execute_without_auditing "COMMIT"
+  end
+
+  def rollback_db_transaction
+    execute_without_auditing "ROLLBACK"
+  end
+
+  def create_savepoint
+    execute_without_auditing("SAVEPOINT #{current_savepoint_name}")
+  end
+
+  def rollback_to_savepoint
+    execute_without_auditing("ROLLBACK TO SAVEPOINT #{current_savepoint_name}")
+  end
+
+  def release_savepoint
+    execute_without_auditing("RELEASE SAVEPOINT #{current_savepoint_name}")
+  end
+
+  def drop_table_with_auditing(table_name, options = {})
+    if PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
+      PgAuditLog::Triggers.drop_for_table(table_name)
+    end
+    drop_table_without_auditing(table_name, options)
+  end
+  alias_method_chain :drop_table, :auditing
+
+  def create_table_with_auditing(table_name, options = {}, &block)
+    create_table_without_auditing(table_name, options, &block)
+    unless options[:temporary] ||
+      PgAuditLog::IGNORED_TABLES.include?(table_name) ||
+      PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
+      PgAuditLog::Triggers.create_for_table(table_name)
+    end
+  end
+  alias_method_chain :create_table, :auditing
+
+  def rename_table_with_auditing(table_name, new_name)
+    rename_table_without_auditing(table_name, new_name)
+    if PgAuditLog::Triggers.tables_with_triggers.include?(table_name)
+      PgAuditLog::Triggers.drop_for_table(table_name)
+    end
+    unless PgAuditLog::IGNORED_TABLES.include?(table_name) ||
+      PgAuditLog::Triggers.tables_with_triggers.include?(new_name)
+      PgAuditLog::Triggers.create_for_table(new_name)
+    end
+  end
+  alias_method_chain :rename_table, :auditing
+
+  private
+
+  def user_id_and_name
+    current_user = Thread.current[:current_user]
+    user_id = current_user.try(:id) || "-1"
+    user_unique_name = current_user.try(:unique_name) || "UNKNOWN"
+    return [user_id, user_unique_name]
+  end
+
+end

data/lib/pg_audit_log/function.rb

@@ -5,10 +5,6 @@ module PgAuditLog
         "audit_changes"
       end
 
-      def custom_variable
-        "audit"
-      end
-
       def users_table_name
         "users"
       end
@@ -25,6 +21,30 @@ module PgAuditLog
         "last_accessed_at"
       end
 
+      def user_identifier_temporary_function(user_id)
+        sql = <<-SQL
+          CREATE OR REPLACE FUNCTION pg_temp.pg_audit_log_user_identifier() RETURNS integer
+          LANGUAGE plpgsql
+          AS $_$
+            BEGIN
+              RETURN #{user_id};
+            END
+            $_$;
+        SQL
+      end
+
+      def user_unique_name_temporary_function(username)
+        sql = <<-SQL
+          CREATE OR REPLACE FUNCTION pg_temp.pg_audit_log_user_unique_name() RETURNS varchar
+          LANGUAGE plpgsql
+          AS $_$
+            BEGIN
+              RETURN '#{username}';
+            END
+            $_$;
+        SQL
+      end
+
       def install
         execute <<-SQL
         CREATE OR REPLACE PROCEDURAL LANGUAGE plpgsql;
@@ -46,8 +66,8 @@ module PgAuditLog
                 old_value := NULL;
                 primary_key_column := NULL;
                 primary_key_value := NULL;
-                user_identifier := current_setting('#{custom_variable}.#{user_id_field}');
-                unique_name := current_setting('#{custom_variable}.#{user_name_field}');
+                user_identifier := pg_temp.pg_audit_log_user_identifier();
+                unique_name := pg_temp.pg_audit_log_user_unique_name();
                 column_name := col.column_name;
 
                 EXECUTE 'SELECT pg_attribute.attname

data/lib/pg_audit_log/version.rb

@@ -1,3 +1,3 @@
 module PgAuditLog
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/spec/configuration_spec.rb

@@ -5,14 +5,8 @@ describe "the PostgreSQL database" do
     ActiveRecord::Base.connection.reconnect!
   end
 
-  it "allows custom class variables for audit" do
-    lambda {
-      ActiveRecord::Base.connection.execute('SET audit.test = 1')
-    }.should_not raise_error(ActiveRecord::StatementInvalid), "Your postgres is not configured for auditing. See README.rdoc"
-  end
-
   it "has an audit log table" do
     ActiveRecord::Base.connection.table_exists?("audit_log").should be_true
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_audit_log
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-02 00:00:00.000000000Z
+date: 2011-10-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2160154260 !ruby/object:Gem::Requirement
+  requirement: &2152506680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2160154260
+  version_requirements: *2152506680
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &2160153480 !ruby/object:Gem::Requirement
+  requirement: &2152505720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *2160153480
+  version_requirements: *2152505720
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2160152760 !ruby/object:Gem::Requirement
+  requirement: &2152505120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160152760
+  version_requirements: *2152505120
 - !ruby/object:Gem::Dependency
   name: with_model
-  requirement: &2160151720 !ruby/object:Gem::Requirement
+  requirement: &2152503960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.1.3
   type: :development
   prerelease: false
-  version_requirements: *2160151720
+  version_requirements: *2152503960
 - !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &2160150700 !ruby/object:Gem::Requirement
+  requirement: &2152503100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160150700
+  version_requirements: *2152503100
 description: A completely transparent audit logging component for your application
   using a stored procedure and triggers. Comes with specs for your project and a rake
   task to generate the reverse SQL to undo changes logged
@@ -94,6 +94,7 @@ files:
 - lib/pg_audit_log/entry.rb
 - lib/pg_audit_log/extensions/3.0/postgresql_adapter.rb
 - lib/pg_audit_log/extensions/3.1/postgresql_adapter.rb
+- lib/pg_audit_log/extensions/shared/postgresql_adapter.rb
 - lib/pg_audit_log/function.rb
 - lib/pg_audit_log/triggers.rb
 - lib/pg_audit_log/version.rb
@@ -119,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2478681401597337909
+      hash: -732310515117041189
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -128,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2478681401597337909
+      hash: -732310515117041189
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10