smps 0.5.4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d28b459006110169081af4ffa0bbf3602cd87ec18bec0c3090f61a83031e4118
-  data.tar.gz: 516d0b9783c8ea2a5c4685be3240cf0526d69e9a88b79bb8121c59786e1319d6
+  metadata.gz: 1f96c8e9ae3647f188be9954b4329d83225dc9f304d210db4ee814054b7ad637
+  data.tar.gz: b950c5a34727aa05eb1fafa79b84ebf75ecac4c85f607186238fc851667bcfa6
 SHA512:
-  metadata.gz: ac4b56d53277286c7ee4e5662bbc21f58ada8330263acfa9fdd574c443b37fb6825d662e4daa6c3d3e8dfdd2e2b4757aab16a91f233cc366a07687ccd41fe16c
-  data.tar.gz: 679c488a2b926beea73ffb4c6e58c76eff6ca36f14b4994a879f66f66e69ceb0385fd6e221eccba7f354cf93a7a3da3068bb676108d7828dac87f507f342e661
+  metadata.gz: 5de9fd79a6fb9aa583b279c4022093f9cba3e3a75862f3b473ca6a423221b608d88fa1e385780f651b849b5d18acb7d20956b24268b07e89ec8e0b8db53550d5
+  data.tar.gz: 461c7551bb6ad0ee04befd9867ef3a233e42578d878addd63ca42c79b43206556bfcf1a369500bd3e910ae3247e855fd87572d7598f57d9d5f940b3dbc5f888c

data/README.md

@@ -4,7 +4,9 @@ A command line tool and library to interact with the Amazon System Manager Param
 
 ## Installation
 
-    $ gem install smps
+```bash
+gem install smps
+```
 
 ## Usage
 
@@ -18,20 +20,19 @@ gem 'smps'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 ### CLI
 
-After installation, 2 executable scripts will be installed: `smps` & `smps-cli`:
-
-- smps: the simple version of this utility.
-- smps-cli: The thor cli executable offers a different interface.
+After installation the `smps` executable will be available.
 
 #### smps
 
 Run the command with `--help` for more information.
 
-```
+```text
 smps [OPTION]
 
     -h, --help:
@@ -61,83 +62,58 @@ smps [OPTION]
     Debug level.
 ```
 
-#### smps-cli
+## Development
 
-The smps-cli command is a new cli with more straightforward actions.
+After checking out the repo, install dependencies.
 
-Run the command with `help` for more information: `smps-cli help`. For each individual action,
-you can also use `smps-cli help <action>`
+```bash
+./bin/setup
+```
 
-##### help
+ Then run the tests.
 
-```
-Commands:
-  smps-cli get NAME                    # Get path or path indicated by the name
-  smps-cli help [COMMAND]              # Describe available commands or one s...
-  smps-cli set NAME VALUE --type=TYPE  # Set the parameter to this value
-
-Options:
-  [--role=PROFILE]                 # IAM profile/role to use. From ~/.aws/config
-  [--region=REGION]                # Override the aws region
-  [--debug=N]                      # AwsSession debug level.
-                                   # Default: 0
-  [--user-data], [--no-user-data]  # Retrieve the name or path, and the key values from the userdata
+ ```bash
+bundle exec rake spec
 ```
 
-##### get NAME
+To install this gem onto your local machine.
 
-```
-Usage:
-  smps-cli get NAME
-
-Options:
-  [--role=PROFILE]                 # IAM profile/role to use. From ~/.aws/config
-  [--region=REGION]                # Override the aws region
-  [--debug=N]                      # AwsSession debug level.
-                                   # Default: 0
-  [--user-data], [--no-user-data]  # Retrieve the name or path, and the key values from the userdata
-
-Description:
-  Gets a value from the parameter store.
+```bash
+bundle exec rake install
 ```
 
-##### set NAME VALUE
+To create a package that can be installed on a different machine.
 
-```
-Usage:
-  smps-cli set NAME VALUE --type=TYPE
-
-Options:
-  --type=TYPE
-                                   # Default: String
-  [--key=ARN]                      # KMS key for SecureString encryption/decryption
-  [--role=PROFILE]                 # IAM profile/role to use. From ~/.aws/config
-  [--region=REGION]                # Override the aws region
-  [--debug=N]                      # AwsSession debug level.
-                                   # Default: 0
-  [--user-data], [--no-user-data]  # Retrieve the name or path, and the key values from the userdata
-
-Set the parameter to this value
+```bash
+bundle exec rake build
 ```
 
-## Development
+This will create a `.gem` file in the `pkg` directory.
 
-After checking out the repo, run `./bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To release a new version, update the version number in `version.rb` and then run
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+bundle exec rake release
+```
 
-To test the `smps` utility on your local machine, run `bundle exec smps --help` to see command-line options.
+This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To test the `smps` utility on your local machine, run the command below to see command-line options.
+
+```bash
+bundle exec smps --help
+```
 
 ## Contributing
 
 We use git flow in this project. To create your pull request, you can either use the git-flow helper or
 manually create a new feature branch and pull request.
 
-1. Fork it ( https://github.com/vrtdev/smps/fork )
+1. Fork it ( <https://github.com/vrtdev/smps/fork> )
 2. Clone your forked repository.
 3. Create your feature branch (`git checkout -b feature/my-new-feature`)
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin feature/my-new-feature`)
 6. Create a new Pull Request. Remember to make the pull request against the `develop` branch.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/vrtdev/smps.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/vrtdev/smps>.

data/changelog.md

@@ -5,6 +5,24 @@ Version format based on http://semver.org/
 
 ## [Unreleased]
 
+## [1.0.1] - 2024-12-17
+
+### Changed
+
+- Update dependencies.
+
+## [1.0.0] - 2024-12-16
+
+### Removed
+
+- Removed Thor CLI version.
+
+## [0.5.5] - 2024-12-16
+
+### Changed
+
+- Added automatic discovery of instance type. EC2 Vs ECS.
+
 ## [0.5.4] - 2021-09-17
 
 ### Changed

data/lib/smps/aws.rb

@@ -9,15 +9,24 @@ module SmPs
   # Some helpers to setup and interact with various aws services.
   module AwsHelpers
     SSM_PARAMETER_TYPES = %w[String StringList SecureString].freeze
-    DEFAULT_USERDATA_URI = 'http://169.254.169.254/latest/user-data'
 
-    def aws_region
-      @aws_region ||= initialize_aws_region
+    def instance_type
+      @instance_type ||= initialize_instance_type
     end
 
-    def retrieve_from_userdata(key, userdata_type = :auto, source = DEFAULT_USERDATA_URI)
-      userdata = user_data(source, userdata_type)
-      userdata[key]
+    def initialize_instance_type
+      i_type = nil
+      if ENV['ECS_CONTAINER_METADATA_URI_V4']
+        i_type = 'ecs'
+      else
+        get_resource('http://169.254.169.254/latest')
+        i_type = 'ec2'
+      end
+      i_type
+    end
+
+    def aws_region
+      @aws_region ||= initialize_aws_region
     end
 
     def user_data(source, type = :auto)
@@ -83,6 +92,20 @@ module SmPs
     end
 
     def initialize_aws_region
+      if instance_type == 'ecs'
+        return initialize_ecs_aws_region
+      elsif instance_type == 'ec2'
+        return initialize_ec2_aws_region
+      end
+    end
+
+    def initialize_ecs_aws_region
+      url = ENV['ECS_CONTAINER_METADATA_URI_V4']
+      c_arn = JSON.parse(get_resource(url))['ContainerARN']
+      c_arn.split(':')[3]
+    end
+
+    def initialize_ec2_aws_region
       url = 'http://169.254.169.254/latest/dynamic/instance-identity/document'
       JSON.parse(get_resource(url))['region']
     end

data/lib/smps/version.rb

@@ -2,5 +2,5 @@
 
 module SmPs
   # Current version.
-  VERSION = '0.5.4'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: smps
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 1.0.1
 platform: ruby
 authors:
 - Stefan - Zipkid - Goethals
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-03 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
     - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -21,6 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
     - - ">"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -28,6 +34,9 @@ dependencies:
   name: aws-sdk-ssm
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -35,6 +44,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -75,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: SMPS - Systems Manager Parameter Store