aws_local_config_parser 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc6188e4608ff366bd6f57b7975082ba99fc61d49741c8248969ab7af6b7116
-  data.tar.gz: 69470d17630fa9091eef0b5d3f2f6d88aa0d57ca6a9c13e10d42a03827869924
+  metadata.gz: 9cca023a99a6a952e6f0adef530645e5c6b94287346d25f7edad8a13474f3ba6
+  data.tar.gz: df35c97974f876463d77fcf151e347b354249d6ff594eb915b035a47ed71c1e9
 SHA512:
-  metadata.gz: 872144e59590f0ab41a0faad170213ae3d35790bfdd8767a55d3a4f14b80f2ff35fd9f92ddd65bd91717d350ca622c8d783d8a1874c86bf94cd2f1819238e8da
-  data.tar.gz: f47dc8ac720d09ab547004adf1857eb469892336b8ee31f2627ff767a0b1aaf804d1fbdd787d4a848b991e7681b3d94f16340c0e062f79c9b9dfdea54e4a0391
+  metadata.gz: 38a1a0634c67ea90dd15520901668b3fecb65548793733462bcdb77d9700b674250835b603c3e66e9daa1f9d06576cefafe906a70df666f5d9d1f907560dfea0
+  data.tar.gz: e3ccbc778c3122eda9acd3afdea088121d6810856b9666a00c47f72a2b9a96d158178fede5111ea89cc30e839732a924801b937989b9b2a31cf0b7248d4087ac

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 FreeAgent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# AwsLocalConfigParser
+
+Parse your local `"$HOME"/.aws/config` to use it within a Ruby script.
+
+## Up and Running
+1. Checkout this repo: `gh repo clone fac/aws_local_config_parser`
+1. Run: `bin/setup`
+1. Run: `bin/demo`
+
+## Usage
+See [`demo`](./bin/demo) for examples on how to use the gem.
+
+Supports parsing and returning:
+- Profiles with SSO
+- Profiles with Access Key + Secret
+- SSO Sessions
+
+``` ruby
+require 'aws_local_config_parser'
+
+config = AwsLocalConfigParser.new
+
+# Profile with SSO
+my_sso_profile = config.profile('my-sso-profile-name')
+my_sso_profile.sso_session
+my_sso_profile.sso_account_id
+my_sso_profile.sso_role_name
+my_sso_profile.region
+
+## Profile with Access Key + Secret
+non_sso_profile = config.profile('my-non-sso-profile-name')
+non_sso_profile.aws_access_key_id
+non_sso_profile.aws_secret_access_key
+non_sso_profile.region
+
+## SSO Session
+my_sso_session = config.sso_session('sso-session')
+my_sso_session.sso_start_url
+my_sso_session.sso_registration_scopes
+my_sso_session.sso_region
+
+## Listing all names
+config.all_profiles
+config.all_sso_sessions
+```
+
+## Making a commit
+[Lefthook](https://github.com/evilmartians/lefthook/) has [been configured](./lefthook.yml) with pre-commit checks to:
+- run `rubocop` for any `ruby` files
+- run `actionlint` for any GitHub workflow files
+
+If for some reason it's necessary, it's possible to temporarily skip `lefthook` with: `LEFTHOOK=0 git commit`.
+
+## Create a new release
+Following [Sematic Versioning](https://semver.org/), bump the version:
+1. `gem bump --version "<sem_ver_bump>"` and merge the changes to `main`
+1. The [Release and Build Gem](https://github.com/fac/aws_local_config_parser/actions/workflows/release_gem.yml) wokflow will trigger a new version build
+1. Manually create a new [release](https://github.com/fac/aws_local_config_parser/releases):
+    1. Click on `Draft a new release`
+    1. In the `Choose a tag` dropdown, selecting the new version
+    1. Click `Generate release notes` and review the notes
+    1. Ensure `Set as the latest release` is checked
+    1. Click `Publish release`

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'aws_local_config_parser'
+require 'debug'
+require 'pry'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/demo

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require_relative '../lib/aws_local_config_parser'
+
+require 'debug'
+require 'pastel'
+
+config = AwsLocalConfigParser.new
+pastel = Pastel.new
+
+puts pastel.bold.blue('Profile:')
+
+puts pastel.bold.magenta('fa-ci-stage') + pastel.bold.green(' [SSO Profile]')
+stage = config.profile('fa-ci-stage')
+puts "\tsso_session: #{stage.sso_session}"
+puts "\tsso_account_id: #{stage.sso_account_id}"
+puts "\tsso_role_name: #{stage.sso_role_name}"
+puts "\tregion: #{stage.region}"
+
+begin
+  puts "\n"
+  puts pastel.bold.magenta('component-finder-uploader') + pastel.bold.green(' [Access Key+Secret Profile]')
+  non_sso_profile = config.profile('component-finder-uploader')
+  puts "\taws_access_key_id: #{non_sso_profile.aws_access_key_id}"
+  puts "\taws_secret_access_key: #{non_sso_profile.aws_secret_access_key}"
+  puts "\tregion: #{non_sso_profile.region}"
+rescue AwsLocalConfigParser::NoMatchingProfile => e
+  puts pastel.bold.red 'No local Access Key+Secret Profile to demo'
+  puts pastel.bold.red e.message.to_s
+end
+
+puts "\n"
+puts pastel.bold.blue('SSO Session:')
+puts pastel.bold.magenta('fa-sso')
+sso_session = config.sso_session('fa-sso')
+puts "\tsso_start_url: #{sso_session.sso_start_url}"
+puts "\tsso_registration_scopes: #{sso_session.sso_registration_scopes}"
+puts "\tsso_region: #{sso_session.sso_region}"
+
+puts "\n"
+puts pastel.bold.blue('Custom Errors:')
+begin
+  puts config.profile('non-existant-profile')
+rescue AwsLocalConfigParser::NoMatchingProfile => e
+  puts pastel.bold.red "🚨 #{e.message}"
+end
+
+begin
+  puts config.sso_session('non-existant-sso-session')
+rescue AwsLocalConfigParser::NoMatchingSsoSession => e
+  puts pastel.bold.red "🚨 #{e.message}"
+end
+
+puts "\n"
+puts pastel.bold.blue('SSO Sessions:')
+puts config.all_sso_sessions
+
+puts "\n"
+puts pastel.bold.blue('Profiles:')
+puts config.all_profiles

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+bundle check || bundle install
+lefthook install -f
+brew bundle

data/lib/aws_local_config_parser/errors.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class AwsLocalConfigParser
+  class NoAwsConfig < StandardError
+    attr_reader :config_path
+
+    def initialize(config_path:)
+      @config_path = config_path
+      super(msg: message)
+    end
+
+    def message
+      "No AWS config file at: '#{config_path}'."
+    end
+  end
+
+  class NoMatchingProfile < StandardError
+    attr_reader :profile_name, :config_path
+
+    def initialize(profile_name:, config_path:)
+      @profile_name = profile_name
+      @config_path = config_path
+      super(msg: message)
+    end
+
+    def message
+      "No matching profile, '#{profile_name}', in '#{config_path}'."
+    end
+  end
+
+  class NoMatchingSsoSession < StandardError
+    attr_reader :sso_session, :config_path
+
+    def initialize(sso_session:, config_path:)
+      @sso_session = sso_session
+      @config_path = config_path
+      super(msg: message)
+    end
+
+    def message
+      "No matching sso-session, '#{sso_session}', in '#{config_path}'."
+    end
+  end
+end

data/lib/aws_local_config_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class AwsLocalConfigParser
+  VERSION = '1.0.1'
+end

data/lib/aws_local_config_parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'aws_local_config_parser/version'
+require_relative 'aws_local_config_parser/errors'
+
+require 'inifile'
+require 'ostruct'
+
+class AwsLocalConfigParser
+  attr_accessor :config, :config_path
+
+  def initialize(config_path: "#{ENV["HOME"]}/.aws/config")
+    @config_path = config_path
+    @config = read_config_file
+  end
+
+  def profile(profile_name)
+    raise NoMatchingProfile.new(profile_name:, config_path:) unless config.has_section?("profile #{profile_name}")
+
+    OpenStruct.new(config_hash["profile #{profile_name}"])
+  end
+
+  def sso_session(sso_session)
+    raise NoMatchingSsoSession.new(sso_session:, config_path:) unless config.has_section?("sso-session #{sso_session}")
+
+    OpenStruct.new(config_hash["sso-session #{sso_session}"])
+  end
+
+  def all_sso_sessions
+    list_of_sso_sessions = config_hash.keys.select { |entry| entry.start_with?('sso-session') }.sort
+    list_of_sso_sessions.map { |sso_session| sso_session.gsub('sso-session ', '') }
+  end
+
+  def all_profiles
+    list_of_profiles = config_hash.keys.select { |entry| entry.start_with?('profile') }.sort
+    list_of_profiles.map { |profile| profile.gsub('profile ', '') }
+  end
+
+  private
+
+  def read_config_file
+    raise AwsLocalConfigParser::NoAwsConfig.new(config_path:) unless File.exist?(config_path)
+
+    IniFile.load(config_path)
+  end
+
+  def config_hash
+    config.to_h
+  end
+end

metadata

@@ -1,28 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: aws_local_config_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - FreeAgent
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 2025-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parse your local '"$HOME"/.aws/config' file.
 email:
 - opensource@freeagent.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://www.freeagent.com/
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/demo
+- bin/setup
+- lib/aws_local_config_parser.rb
+- lib/aws_local_config_parser/errors.rb
+- lib/aws_local_config_parser/version.rb
+homepage: https://github.com/fac/aws_local_config_parser
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://www.freeagent.com/
-post_install_message:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fac/aws_local_config_parser
+  source_code_uri: https://github.com/fac/aws_local_config_parser
+  changelog_uri: https://github.com/fac/aws_local_config_parser/releases
 rdoc_options: []
 require_paths:
 - lib
@@ -30,15 +67,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
-summary: Placeholder gem
+summary: A simple gem to parse your local AWS config file.
 test_files: []