aws_ec2_environment 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3775e63eb372f1dccbf0ca69fb1df16f02e4fd9bfc092944d7880f73ef668988
-  data.tar.gz: 1a37c44fcb4c6258165c3890cc12f4b3de3b16142ddb80c3071baa4d9de78cfd
+  metadata.gz: b294268a688df38dfde011db33d1cf3e69f6d5562424b93a487224e180f5268d
+  data.tar.gz: 6aff34b804255143bf4095d1346d13fc4635e6549d767b22b512d37129f8b6e8
 SHA512:
-  metadata.gz: 055a9fa886280c9e088f2dac3c66ebee130c62db48300d7d7f8d47714fe2c30192c1482711cadf55422381d55d284a9e7e5df49dfb2c994606de8d9bac3b4ef1
-  data.tar.gz: e60c5ee60a9fb247d2e101c75f36bca67866874ba64ee80fe6530ad236c690394073e686a6665dc9e43ca7c409de22431abdfbe7ecee3772285d9e8c47c528da
+  metadata.gz: 5219053812134a5b2143d22be1c882f73cba47bbb06f41fbd560cdfbbac43e93d987169bd10fa62bd8b57126ded34bfcfd894303edeb4eaf81431a5ebd1239b7
+  data.tar.gz: e18d61043d7a0acc999b98e11cec1fb733e1c48e52bd41762233c67f7a2cd669b190663c442a411f383fd158ca395478697c13b27e3389fce61ba957fd844f04

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-01-09
+
+### Added
+
+- Support using alternative documents and parameters with
+  `SsmPortForwardingSession`
+  ([#22](https://github.com/ackama/aws_ec2_environment/pull/22))
+
+## [0.1.1] - 2025-12-15
+
+### Fixed
+
+- Make sure string used for capturing cmd output is unfrozen
+  ([#25](https://github.com/ackama/aws_ec2_environment/pull/25))
+
 ## [0.1.0] - 2022-08-17
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aws_ec2_environment (0.1.0)
+    aws_ec2_environment (0.2.0)
       aws-sdk-ec2 (~> 1.0)
       aws-sdk-ssm (~> 1.0)
 
@@ -9,27 +9,32 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    aws-eventstream (1.2.0)
-    aws-partitions (1.619.0)
-    aws-sdk-core (3.132.0)
-      aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.525.0)
-      aws-sigv4 (~> 1.1)
+    aws-eventstream (1.4.0)
+    aws-partitions (1.1172.0)
+    aws-sdk-core (3.233.0)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.992.0)
+      aws-sigv4 (~> 1.9)
+      base64
+      bigdecimal
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-ec2 (1.327.0)
-      aws-sdk-core (~> 3, >= 3.127.0)
-      aws-sigv4 (~> 1.1)
+      logger
+    aws-sdk-ec2 (1.562.0)
+      aws-sdk-core (~> 3, >= 3.231.0)
+      aws-sigv4 (~> 1.5)
     aws-sdk-ssm (1.138.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.5.1)
+    aws-sigv4 (1.12.1)
       aws-eventstream (~> 1, >= 1.0.2)
     base64 (0.1.1)
+    bigdecimal (3.3.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    jmespath (1.6.1)
-    json (2.6.3)
+    jmespath (1.6.2)
+    json (2.15.1)
     language_server-protocol (3.17.0.3)
+    logger (1.7.0)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
@@ -38,7 +43,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
-    rexml (3.2.6)
+    rexml (3.4.2)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -88,6 +93,8 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
+  arm64-darwin-23
   x86_64-darwin-19
   x86_64-darwin-20
   x86_64-linux
@@ -102,4 +109,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.3.17
+   2.5.7

data/README.md

@@ -199,6 +199,44 @@ task :forward_port, %i[instance_id remote_port local_port] => :environment do |_
 end
 ```
 
+You can also use specific documents, and pass in extra parameters, which can be
+useful for using tunnels to access other private resources like database
+instances:
+
+```ruby
+require "aws_ec2_environment"
+
+desc "Dumps a copy of the postgres database using AWS and PG environment variables"
+task :dump_pg_database, %i[instance_id dump_file] => :environment do |_, args|
+  instance_id = args.fetch(:instance_id)
+  dump_file = args.fetch(:dump_file)
+
+  remote_host = ENV.fetch("PGHOST")
+  remote_port = ENV.fetch("PGPORT", 5432).to_i
+
+  session = AwsEc2Environment::SsmPortForwardingSession.new(
+    instance_id,
+    remote_port,
+    document: "AWS-StartPortForwardingSessionToRemoteHost",
+    extra_params: { "host" => [remote_host] }
+  )
+
+  at_exit { session.close }
+
+  local_port = session.wait_for_local_port
+
+  system(
+    "pg_dump",
+    "--format=c",
+    "--no-owner",
+    "--no-privileges",
+    "--host=localhost",
+    "--port=#{local_port}",
+    "--file=#{dump_file}",
+  )
+end
+```
+
 ### AWS Authentication and Permissions
 
 Since this gem interacts with AWS, it must be configured with credentials - see

data/aws_ec2_environment.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/aws_ec2_environment/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "aws_ec2_environment"
+  spec.version = AwsEc2Environment::VERSION
+  spec.authors = ["Gareth Jones"]
+  spec.email = %w[open-source@ackama.com]
+
+  spec.summary = "Interact with AWS EC2-based Ruby apps easily"
+  spec.homepage = "https://github.com/ackama/aws_ec2_environment"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # TODO: we expect to have to disable this if we switch to automatic releases
+  #   but until then we've got it enabled to make Rubocop happy
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk-ec2", "~> 1.0"
+  spec.add_dependency "aws-sdk-ssm", "~> 1.0"
+end

data/lib/aws_ec2_environment/ssm_port_forwarding_session.rb

@@ -22,8 +22,9 @@ class AwsEc2Environment
     # rubocop:disable Metrics/ParameterLists
     def initialize(
       instance_id, remote_port,
+      document: "AWS-StartPortForwardingSession",
       local_port: nil, logger: Logger.new($stdout),
-      timeout: 15, reason: nil
+      timeout: 15, reason: nil, extra_params: {}
     )
       # rubocop:enable Metrics/ParameterLists
       @logger = logger
@@ -32,9 +33,9 @@ class AwsEc2Environment
       @local_port = nil
       @timeout = timeout
 
-      @reader, @writer, @pid = PTY.spawn(ssm_port_forward_cmd(local_port, reason))
+      @reader, @writer, @pid = PTY.spawn(ssm_port_forward_cmd(local_port, reason, document, extra_params))
 
-      @cmd_output = ""
+      @cmd_output = +""
       @session_id = wait_for_session_id
 
       @logger.info("SSM session #{@session_id} opening, forwarding port #{remote_port} on #{instance_id}")
@@ -64,9 +65,8 @@ class AwsEc2Environment
 
     private
 
-    def ssm_port_forward_cmd(local_port, reason)
-      document_name = "AWS-StartPortForwardingSession"
-      parameters = { "portNumber" => [remote_port.to_s] }
+    def ssm_port_forward_cmd(local_port, reason, document_name, extra_params)
+      parameters = extra_params.merge({ "portNumber" => [remote_port.to_s] })
       parameters["localPortNumber"] = [local_port.to_s] unless local_port.nil?
       flags = [
         ["--target", instance_id],

data/lib/aws_ec2_environment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class AwsEc2Environment
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/sig/aws_ec2_environment/ssm_port_forwarding_session.rbs

@@ -16,10 +16,12 @@ class AwsEc2Environment
     def initialize: (
         String instance_id,
         Integer remote_port,
+        ?document: String,
         ?local_port: Integer | nil,
         ?logger: Logger,
         ?timeout: Numeric,
-        ?reason: String | nil
+        ?reason: String | nil,
+        ?extra_params: Hash[String, untyped]
       ) -> void
 
     def close: () -> void
@@ -38,7 +40,12 @@ class AwsEc2Environment
     @writer: IO
     @cmd_output: String
 
-    def ssm_port_forward_cmd: (Integer | nil local_port, String | nil reason) -> String
+    def ssm_port_forward_cmd: (
+        Integer | nil local_port,
+        String | nil reason,
+        String document_name,
+        Hash[String, untyped] extra_params
+      ) -> String
 
     # Checks the cmd process output until either the given +pattern+ matches or the +timeout+ is over.
     #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: aws_ec2_environment
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gareth Jones
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ec2
@@ -38,7 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
 email:
 - open-source@ackama.com
 executables: []
@@ -58,6 +56,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- aws_ec2_environment.gemspec
 - lib/aws_ec2_environment.rb
 - lib/aws_ec2_environment/ci_service.rb
 - lib/aws_ec2_environment/config.rb
@@ -75,7 +74,6 @@ metadata:
   source_code_uri: https://github.com/ackama/aws_ec2_environment
   changelog_uri: https://github.com/ackama/aws_ec2_environment
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -90,8 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Interact with AWS EC2-based Ruby apps easily
 test_files: []