pg-aws_rds_iam 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7894b340911ed1dd4bf4ade1a3a93830f34a353107036f0bf974b098b332ad04
-  data.tar.gz: 7387170d637e6f5a57cb4e39146c03496595d7fd2bc785eae4dacd1dc7978a90
+  metadata.gz: 920be3b0e703f19eb05fbd79801ee15ffc4a261d811682426f8ff90e870b7445
+  data.tar.gz: b8b799ef04905de4e760320b6b7928f6e989ca7f167b2e5c0b5fa94b87c786a7
 SHA512:
-  metadata.gz: 7ed4c84823ac809c74ac63358df8a31aebaa8ba09572cd8a8343a47c41768f5bb226b6ce99fb8ec052e90c37575e296538680ba1a3ab03bb4d100120fc0e044d
-  data.tar.gz: 1575d6f6e008a311edd01fb62cd9d3bf4615a14b41d0ed2f5163812999661180da5010252cf8013c82abcfc46c4d680d6dc995a21e8c02d3164949f929887b14
+  metadata.gz: 8661064d598861e2c7f9a0d91598335627c12acc901ec92a4de1b833a1b768dec4d3108a86d2d6e7331b831645db9092b4ea5b8ef2c0f36330465d2764203117
+  data.tar.gz: 439ab6a13b36c36baeb56c0e3bbdf33406e92816209e30cc6ed080e068e96eea201fcde24499d8a664bbc3523628fc9fd90ab83845800301d1fed852716f00ac

data/.github/workflows/pull-request.yml

@@ -66,7 +66,7 @@ jobs:
 
     steps:
       - name: Install dependencies
-        run: apk add build-base git postgresql-dev tar
+        run: apk add build-base git postgresql-client postgresql-dev tar
 
       - name: Check out source code
         uses: actions/checkout@v3
@@ -93,6 +93,8 @@ jobs:
         with:
           key: ${{ steps.cache-key.outputs.cache-key }}-gems-${{ hashFiles('Gemfile.lock') }}
           path: vendor/bundle
+          restore-keys: |
+            ${{ steps.cache-key.outputs.cache-key }}-gems-
 
       - name: Install gems
         run: bin/bundle install

data/.rubocop.yml

@@ -31,6 +31,8 @@ Naming/VariableNumber:
 
 Style/Documentation:
   Exclude:
+    - lib/pg/aws_rds_iam/active_record_postgresql_database_tasks.rb
+    - lib/pg/aws_rds_iam/active_record_postgresql_database_tasks/**/*.rb
     - lib/pg/aws_rds_iam/auth_token_injector.rb
     - lib/pg/aws_rds_iam/connection_info.rb
     - lib/pg/aws_rds_iam/connection_info/**/*.rb

data/CHANGELOG.md

@@ -8,6 +8,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 No notable changes.
 
+## [0.4.1] - 2022-07-20
+
+### Fixed
+* Generate auth token for Active Record structure load ([#374](https://github.com/haines/pg-aws_rds_iam/pull/374))
+
 ## [0.4.0] - 2022-06-22
 
 ### Changed
@@ -52,7 +57,8 @@ No notable changes.
 * A plugin for the [`pg` gem](https://rubygems.org/gems/pg) that adds support for [IAM authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) when connecting to PostgreSQL databases hosted in Amazon RDS. ([#1](https://github.com/haines/pg-aws_rds_iam/pull/1))
 * ActiveRecord support. ([#3](https://github.com/haines/pg-aws_rds_iam/pull/3))
 
-[Unreleased]: https://github.com/haines/pg-aws_rds_iam/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/haines/pg-aws_rds_iam/compare/v0.4.1...HEAD
+[0.4.1]: https://github.com/haines/pg-aws_rds_iam/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/haines/pg-aws_rds_iam/compare/v0.3.2...v0.4.0
 [0.3.2]: https://github.com/haines/pg-aws_rds_iam/compare/v0.3.1...v0.3.2
 [0.3.1]: https://github.com/haines/pg-aws_rds_iam/compare/v0.3.0...v0.3.1

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    pg-aws_rds_iam (0.4.0)
+    pg-aws_rds_iam (0.4.1)
       aws-sdk-rds (~> 1.0)
       pg (>= 0.18, < 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3)
-      activesupport (= 7.0.3)
-    activerecord (7.0.3)
-      activemodel (= 7.0.3)
-      activesupport (= 7.0.3)
-    activesupport (7.0.3)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -21,16 +21,16 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.600.0)
+    aws-partitions (1.607.0)
     aws-sdk-core (3.131.2)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.525.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-ec2 (1.319.0)
+    aws-sdk-ec2 (1.322.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-rds (1.146.0)
+    aws-sdk-rds (1.148.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.5.0)
@@ -39,11 +39,12 @@ GEM
     coderay (1.1.3)
     commonmarker (0.23.5)
     concurrent-ruby (1.1.10)
-    i18n (1.10.0)
+    i18n (1.11.0)
       concurrent-ruby (~> 1.0)
     jmespath (1.6.1)
+    json (2.6.2)
     method_source (1.0.0)
-    minitest (5.16.1)
+    minitest (5.16.2)
     minitest-reporters (1.5.0)
       ansi
       builder
@@ -52,7 +53,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
-    pg (1.4.0)
+    pg (1.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -60,7 +61,8 @@ GEM
     rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.30.1)
+    rubocop (1.31.2)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -69,7 +71,7 @@ GEM
       rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
+    rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
     rubocop-minitest (0.20.1)
       rubocop (>= 0.90, < 2.0)
@@ -79,7 +81,7 @@ GEM
     timecop (0.9.5)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
@@ -105,4 +107,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.16
+   2.3.18

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem](https://img.shields.io/gem/v/pg-aws_rds_iam?style=flat-square)](https://rubygems.org/gems/pg-aws_rds_iam)
  
-[![Docs](https://img.shields.io/badge/yard-docs-blue?style=flat-square)](https://haines.github.io/pg-aws_rds_iam/)
+[![Docs](https://img.shields.io/badge/yard-docs-blue?style=flat-square)](https://www.rubydoc.info/gems/pg-aws_rds_iam)
 
 `PG::AWS_RDS_IAM` is a plugin for the [`pg` gem](https://rubygems.org/gems/pg) that adds support for [IAM authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) when connecting to PostgreSQL databases hosted in Amazon RDS.
 

data/lib/pg/aws_rds_iam/active_record_postgresql_database_tasks/psql_env.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PG
+  module AWS_RDS_IAM
+    module ActiveRecordPostgreSQLDatabaseTasks
+      private
+
+      def psql_env
+        super.tap do |psql_env|
+          AuthTokenInjector.new.inject_into_psql_env! configuration_hash, psql_env
+        end
+      end
+    end
+  end
+end

data/lib/pg/aws_rds_iam/active_record_postgresql_database_tasks/set_psql_env.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PG
+  module AWS_RDS_IAM
+    module ActiveRecordPostgreSQLDatabaseTasks
+      private
+
+      def set_psql_env
+        super
+        hash = respond_to?(:configuration_hash, true) ? configuration_hash : configuration.symbolize_keys
+        AuthTokenInjector.new.inject_into_psql_env! hash, ENV
+      end
+    end
+  end
+end

data/lib/pg/aws_rds_iam/active_record_postgresql_database_tasks.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PG
+  module AWS_RDS_IAM
+    module ActiveRecordPostgreSQLDatabaseTasks
+    end
+
+    private_constant :ActiveRecordPostgreSQLDatabaseTasks
+  end
+end
+
+if ActiveRecord::Tasks::PostgreSQLDatabaseTasks.private_instance_methods.include?(:psql_env)
+  require_relative "active_record_postgresql_database_tasks/psql_env"
+else
+  require_relative "active_record_postgresql_database_tasks/set_psql_env"
+end

data/lib/pg/aws_rds_iam/auth_token_injector.rb

@@ -3,38 +3,39 @@
 module PG
   module AWS_RDS_IAM
     class AuthTokenInjector
-      def self.call(connection_string, auth_token_generators: AWS_RDS_IAM.auth_token_generators)
-        new(connection_string, auth_token_generators: auth_token_generators).call
-      end
-
-      def initialize(connection_string, auth_token_generators:)
-        @connection_string = connection_string
-        @connection_info = ConnectionInfo.new(connection_string)
-        @connection_defaults = PG::Connection.conndefaults_hash
+      def initialize(auth_token_generators: AWS_RDS_IAM.auth_token_generators)
         @auth_token_generators = auth_token_generators
+        @connection_defaults = PG::Connection.conndefaults_hash
       end
 
-      def call
-        return @connection_string unless generate_auth_token?
+      def inject_into_connection_string(connection_string)
+        connection_info = ConnectionInfo.from_connection_string(connection_string)
+        return connection_string unless generate_auth_token?(connection_info)
+
+        connection_info.password = generate_auth_token(connection_info)
+        connection_info.to_s
+      end
 
-        @connection_info.password = generate_auth_token
+      def inject_into_psql_env!(configuration_hash, psql_env)
+        connection_info = ConnectionInfo.from_active_record_configuration_hash(configuration_hash)
+        return unless generate_auth_token?(connection_info)
 
-        @connection_info.to_s
+        psql_env["PGPASSWORD"] = generate_auth_token(connection_info)
       end
 
       private
 
-      def generate_auth_token?
-        @connection_info.auth_token_generator_name
+      def generate_auth_token?(connection_info)
+        connection_info.auth_token_generator_name
       end
 
-      def generate_auth_token
+      def generate_auth_token(connection_info)
         @auth_token_generators
-          .fetch(@connection_info.auth_token_generator_name)
+          .fetch(connection_info.auth_token_generator_name)
           .call(
-            user: @connection_info.user || default(:user),
-            host: @connection_info.host || default(:host),
-            port: @connection_info.port || default(:port)
+            user: connection_info.user || default(:user),
+            host: connection_info.host || default(:host),
+            port: connection_info.port || default(:port)
           )
       end
 

data/lib/pg/aws_rds_iam/connection.rb

@@ -8,7 +8,7 @@ module PG
       end
 
       def conninfo_parse(connection_string)
-        connection_info = ConnectionInfo.new(connection_string)
+        connection_info = ConnectionInfo.from_connection_string(connection_string)
 
         super(connection_info.to_s).tap do |result|
           result << conndefault_aws_rds_iam_auth_token_generator.merge(val: connection_info.auth_token_generator_name) if connection_info.auth_token_generator_name
@@ -16,7 +16,7 @@ module PG
       end
 
       def parse_connect_args(*args)
-        AuthTokenInjector.call(super)
+        AuthTokenInjector.new.inject_into_connection_string(super)
       end
 
       private

data/lib/pg/aws_rds_iam/connection_info/active_record_configuration_hash.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PG
+  module AWS_RDS_IAM
+    module ConnectionInfo
+      class ActiveRecordConfigurationHash
+        def initialize(configuration_hash)
+          @configuration_hash = configuration_hash
+        end
+
+        def auth_token_generator_name
+          @configuration_hash[:aws_rds_iam_auth_token_generator]
+        end
+
+        def user
+          @configuration_hash[:username]
+        end
+
+        def host
+          @configuration_hash[:host]
+        end
+
+        def port
+          @configuration_hash[:port]
+        end
+      end
+    end
+  end
+end

data/lib/pg/aws_rds_iam/connection_info.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "connection_info/active_record_configuration_hash"
 require_relative "connection_info/keyword_value_string"
 require_relative "connection_info/parse_error"
 require_relative "connection_info/uri"
@@ -7,13 +8,17 @@ require_relative "connection_info/uri"
 module PG
   module AWS_RDS_IAM
     module ConnectionInfo
-      def self.new(connection_string)
+      def self.from_connection_string(connection_string)
         if URI.match?(connection_string)
           URI.new(connection_string)
         else
           KeywordValueString.new(connection_string)
         end
       end
+
+      def self.from_active_record_configuration_hash(configuration_hash)
+        ActiveRecordConfigurationHash.new(configuration_hash)
+      end
     end
 
     private_constant :ConnectionInfo

data/lib/pg/aws_rds_iam/version.rb

@@ -3,6 +3,6 @@
 module PG
   module AWS_RDS_IAM
     # The current version of the gem.
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

data/lib/pg/aws_rds_iam.rb

@@ -26,5 +26,11 @@ module PG
     end
 
     PG::Connection.singleton_class.prepend Connection
+
+    if defined?(ActiveRecord)
+      require_relative "aws_rds_iam/active_record_postgresql_database_tasks"
+
+      ActiveRecord::Tasks::PostgreSQLDatabaseTasks.prepend ActiveRecordPostgreSQLDatabaseTasks
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg-aws_rds_iam
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Andrew Haines
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-22 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-rds
@@ -74,11 +74,15 @@ files:
 - bin/version-matrix
 - bin/yard
 - lib/pg/aws_rds_iam.rb
+- lib/pg/aws_rds_iam/active_record_postgresql_database_tasks.rb
+- lib/pg/aws_rds_iam/active_record_postgresql_database_tasks/psql_env.rb
+- lib/pg/aws_rds_iam/active_record_postgresql_database_tasks/set_psql_env.rb
 - lib/pg/aws_rds_iam/auth_token_generator.rb
 - lib/pg/aws_rds_iam/auth_token_generator_registry.rb
 - lib/pg/aws_rds_iam/auth_token_injector.rb
 - lib/pg/aws_rds_iam/connection.rb
 - lib/pg/aws_rds_iam/connection_info.rb
+- lib/pg/aws_rds_iam/connection_info/active_record_configuration_hash.rb
 - lib/pg/aws_rds_iam/connection_info/keyword_value_string.rb
 - lib/pg/aws_rds_iam/connection_info/parse_error.rb
 - lib/pg/aws_rds_iam/connection_info/uri.rb
@@ -90,7 +94,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/haines/pg-aws_rds_iam/issues
   changelog_uri: https://github.com/haines/pg-aws_rds_iam/blob/main/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/pg-aws_rds_iam/0.4.0
+  documentation_uri: https://rubydoc.info/gems/pg-aws_rds_iam/0.4.1
   homepage_uri: https://github.com/haines/pg-aws_rds_iam
   source_code_uri: https://github.com/haines/pg-aws_rds_iam
   rubygems_mfa_required: 'true'
@@ -109,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.16
+rubygems_version: 3.3.18
 signing_key:
 specification_version: 4
 summary: IAM authentication for PostgreSQL on Amazon RDS