pg-aws_rds_iam 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8de2c77e449ab425d3294a78bfb769377b96e33ef415144066c442103bdca6db
-  data.tar.gz: a10dcfe36a489d448cfaaa5a598af4bf99d1f29cb9abc7b0f27fb85de00c08c7
+  metadata.gz: abc5ffd5784f5ad5c2fc33e510cd99d9f02ad9a0cf6a231427abf2b8593dbdf2
+  data.tar.gz: 6552886d708ea4a2e819d4cb6fa6db9d1c59eec9dffeb09b1a38d135bbde1da1
 SHA512:
-  metadata.gz: e07d05f1b3ba640764c8493e0b27bc94722c8b7afb2688a9168551821dc2518eccc4d74f241a6a91bec51ea67a16e93a72924100014c6643bc7e4c1ddc0fc0aa
-  data.tar.gz: 8a3b8388bac508791363b4252283bc48d6b8412c3b99337dad6640ea1475005062bfb1528a82f042b0fd76f46f97afa85d41b221881fee9520f2e4bf2064a9df
+  metadata.gz: 5d1c3a0f5d0e292ec0199ed8e420644cc1574ef80b2fbf2b71a0c9b8656e6f757aeb575cc0198c47dbdb92b1013e46c61ab5428d142cca650d35063ea2c2a7ad
+  data.tar.gz: 629e158616fc8319beb73ea54010bee5f6eb41adc30fecaf9ff0480aa693706b026572cb72597a62bd7b4fd765a83d831687f8ee9da7385b4c5e92bbd95b6295

data/CHANGELOG.md

@@ -8,6 +8,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 No notable changes.
 
+## [0.7.0] - 2024-12-04
+
+### Changed
+* Reuse tokens ([#690](https://github.com/haines/pg-aws_rds_iam/pull/690))
+
+## [0.6.2] - 2024-11-12
+
+### Changed
+* Fix broken link in changelog ([#687](https://github.com/haines/pg-aws_rds_iam/pull/687))
+
 ## [0.6.1] - 2024-11-12
 
 ### Changed
@@ -91,7 +101,10 @@ 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.6.0...HEAD
+[Unreleased]: https://github.com/haines/pg-aws_rds_iam/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/haines/pg-aws_rds_iam/compare/v0.6.2...v0.7.0
+[0.6.2]: https://github.com/haines/pg-aws_rds_iam/compare/v0.6.1...v0.6.2
+[0.6.1]: https://github.com/haines/pg-aws_rds_iam/compare/v0.6.0...v0.6.1
 [0.6.0]: https://github.com/haines/pg-aws_rds_iam/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/haines/pg-aws_rds_iam/compare/v0.4.2...v0.5.0
 [0.4.2]: https://github.com/haines/pg-aws_rds_iam/compare/v0.4.1...v0.4.2

data/lib/pg/aws_rds_iam/auth_token.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PG
+  module AWS_RDS_IAM
+    class AuthToken
+      def initialize(token)
+        @token = token
+        @generated_at = now
+        @expiry = parse_expiry || 900
+      end
+
+      def valid?
+        (now - @generated_at) < (@expiry - 60)
+      end
+
+      def to_str
+        @token
+      end
+
+      private
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
+      def parse_expiry
+        URI
+          .decode_www_form(URI.parse("https://#{@token}").query)
+          .lazy
+          .filter_map { |(key, value)| Integer(value, 10) if key.downcase == "x-amz-expires" }
+          .first
+      rescue StandardError
+        nil
+      end
+    end
+
+    private_constant :AuthToken
+  end
+end

data/lib/pg/aws_rds_iam/auth_token_generator.rb

@@ -13,16 +13,39 @@ module PG
       def initialize(credentials:, region:)
         @generator = Aws::RDS::AuthTokenGenerator.new(credentials:)
         @region = region
+        @mutex = Mutex.new
+        @cache = {}
       end
 
       # Generates an authentication token for connecting to an Amazon RDS instance.
+      # Generated tokens are cached and reused until 1 minute before they are due to expire.
       #
       # @param host [String] the host name of the RDS instance that you want to access
       # @param port [String] the port number used for connecting to your RDS instance
       # @param user [String] the database account that you want to access
       # @return [String] the generated authentication token
       def call(host:, port:, user:)
-        @generator.auth_token(region: @region, endpoint: "#{host}:#{port}", user_name: user)
+        endpoint = "#{host}:#{port}"
+        key = "#{user}@#{endpoint}"
+
+        token = cached_token(key)
+        return token if token
+
+        @mutex.synchronize do
+          token = cached_token(key)
+          break token if token
+
+          @generator.auth_token(region: @region, endpoint:, user_name: user).tap do |new_token|
+            @cache[key] = AuthToken.new(new_token)
+          end
+        end
+      end
+
+      private
+
+      def cached_token(key)
+        token = @cache[key]
+        token.to_str if token&.valid?
       end
     end
   end

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.6.1"
+    VERSION = "0.7.0"
   end
 end

data/lib/pg/aws_rds_iam.rb

@@ -5,6 +5,7 @@ require "pg"
 require "strscan"
 require "uri"
 
+require_relative "aws_rds_iam/auth_token"
 require_relative "aws_rds_iam/auth_token_generator"
 require_relative "aws_rds_iam/auth_token_generator_registry"
 require_relative "aws_rds_iam/auth_token_injector"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg-aws_rds_iam
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrew Haines
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-rds
@@ -55,6 +55,7 @@ files:
 - 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.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
@@ -73,7 +74,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.6.1
+  documentation_uri: https://rubydoc.info/gems/pg-aws_rds_iam/0.7.0
   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'