is2-aws-ssm-env 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2596df3b035e162294fa921eef5782e718d963231d5bb4ca252d5e0aec5d81e9
+  data.tar.gz: d9b45671edb74f506c90bb8d53271ca29387d17b622340ec83ad55543bd7988c
+SHA512:
+  metadata.gz: 34b6a1360750e596072027da2e5d0a7dfa6c86fe3e3e44fa61fcbd506190eec0b75396952e565d70c95f53d714f5ab63eaa0edae221f71b22ee696466912924e
+  data.tar.gz: 5feca5652db1f2d50070783243f34984b8a63c9938069c2cfee8283fbd1bc3a66ec8a3f67b0f95ee362c3d8beb603abe8a6ede1ef778c83ead6019c677030863

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## 0.1.1 (2018-01-16)
+
+- Translate README.
+- Added ruby 2.5 tests.
+

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,355 @@
+[![Build Status](https://travis-ci.org/sonodar/aws-ssm-env-ruby.svg?branch=master)](https://travis-ci.org/sonodar/aws-ssm-env-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/sonodar/aws-ssm-env-ruby/badge.svg?branch=master)](https://coveralls.io/github/sonodar/aws-ssm-env-ruby?branch=master)
+[![Gem Version](https://badge.fury.io/rb/aws-ssm-env.svg)](https://badge.fury.io/rb/aws-ssm-env)
+
+# aws-ssm-env
+
+This tool sets parameters acquired from `AWS EC2 Parameter Store` as environment variables.  
+
+By default, the last hierarchy of the parameter name is
+set as the environment variable name.  
+
+For example, if the parameter name is `/staging/secure/DB_PASSWORD`,
+the parameter value is set to `ENV['DB_PASSWORD']`.  
+The naming of environment variables is optional and can be customized.
+(described later)
+
+## Installation
+
+This gem has been tested with ruby version 2.2 to 2.5.
+
+```
+gem install aws-ssm-env
+```
+
+### Rails
+
+```ruby
+# Gemfile
+gem 'aws-ssm-env', group: :aws
+```
+
+```ruby
+# config/application.rb
+if defined?(AwsSsmEnv)
+  AwsSsmEnv.load(path: "/myapp/#{ENV['RAILS_ENV']}", recursive: true)
+end
+```
+
+### Other ruby program
+
+```ruby
+require 'aws-ssm-env'
+AwsSsmEnv.load!(begins_with: "myapp.#{ENV['RACK_ENV']}.")
+```
+
+## Quick Start
+
+First of all, register the parameters in `AWS EC2 Parameter Store`.
+
+```shell
+# ex) register /myservice/staging/RDS_PASSWORD with SecureString
+aws ssm --region ap-northeast-1 put-parameter \
+  --name /myservice/staging/RDS_PASSWORD \
+  --type SecureString --value <secret value>
+```
+
+Then, set authentication information of AWS.   
+For example, you can use environment variables as follows,
+
+```shell
+export AWS_ACCESS_KEY_ID=YOURACCESSKEYID
+export AWS_SECRET_ACCESS_KEY=YOURSECRETKEY
+bundle exec rails start
+```
+
+Or, you can pass `ssm_client_args` as the argument for `AwsSsmEnv#load`:
+
+```ruby
+AwsSsmEnv.load(
+  fetch: "/myservice/#{ENV['RAILS_ENV']}",
+  ssm_client_args: {
+    access_key_id: 'ACCESS_KEY_ID',
+    secret_access_key: 'SECRET_ACCESS_KEY',
+    region: 'ap-northeast-1',
+  }
+)
+```
+
+You can also use `Aws.config`.
+
+```ruby
+
+if defined?(AwsSsmEnv)
+  AWS.config({
+    access_key_id: 'ACCESS_KEY_ID',
+    secret_access_key: 'SECRET_ACCESS_KEY',
+    region: 'ap-northeast-1',
+  })
+  AwsSsmEnv.load(path: "/myservice/#{ENV['RAILS_ENV']}")
+end
+```
+
+For details, refer to the document of aws-sdk.
+
+## Develop
+
+### Unit test
+
+```shell
+bundle exec rspec
+bundle exec rubocop
+```
+
+### Integration test
+
+```shell
+export AWS_ACCESS_KEY_ID=xxxx
+export AWS_SECRET_ACCESS_KEY=xxxx
+export AWS_REGION=xxxx
+bundle exec rspec --tag integration
+```
+
+IAM users who run tests need the following authorization policy:
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "",
+      "Effect": "Allow",
+      "Action": [
+        "ssm:PutParameter",
+        "ssm:DeleteParameters",
+        "ssm:DescribeParameters",
+        "ssm:GetParameters*"
+      ],
+      "Resource": "*"
+    }
+  ]
+}
+```
+
+
+## Usage
+
+Here are descriptions of the options passed to `AwsSsmEnv#load`.
+
+### decryption: [Boolean]
+
+Flag indicating whether to decrypt SecureString parameters.  
+If `true` is specified, the value of the acquired SecureString parameter is decrypted.  
+In case of `false` it is set as encrypted and environment variable value.  
+Since it is a gem for this, the default is `true` (decrypt).
+
+### overwrite: [Boolean]
+
+Specify whether to overwrite an already set environment variable.  
+If `true` is specified, even if the environment variable is set,
+it overwrites it with the acquired parameter value.  
+If `false` is specified, do not overwrite already set environment variables.  
+The default is `false` (do not overwrite).  
+If you invoke `AwsSsmEnv#load!`, This flag will automatically be set to `true`.
+
+### client: [Aws::SSM::Client]
+
+Specify an instance of `Aws::SSM::Client`.  
+An option to set it if there are already created instances.  
+If there are no instances created, use `ssm_client_args` instead.
+
+### ssm_client_args: [Hash]
+
+Specify a hash to pass to the constructor of `Aws::SSM::Client`.  
+If not specified, `Aws::SSM::Client#new` is called with an empty argument.  
+It is unnecessary when using environment variable
+or authentication information by `EC2 InstanceProfile`.
+
+### fetch: [Symbol, AwsSsmEnv::Fetcher, Object]
+
+Specify parameter fetch strategy.  
+Possible values are `:path`,`:begins_with`
+or an instance of a class that implements `AwsSsmEnv::Fetcher`,
+or an instance of a class with a `each` method.  
+If nothing is specified, it is treated as `:path`.  
+But when `begins_with` (which is described later) is specified,
+it will automatically be `:begins_with`.
+
+#### `:fetch => :path` or default
+
+When `:path` is specified, `AwsSsmEnv::PathFetcher` which fetches
+parameter hierarchy by path specification is used.  
+In this case, the `path` argument described below is required.
+Also, the `recursive` argument (described later) is used.  
+When acquiring parameters in this way, you need `ssm:GetParametersByPath` authority
+for the specified path.  
+An example of the IAM policy is shown below.
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "",
+      "Effect": "Allow",
+      "Action": "ssm:GetParametersByPath",
+      "Resource": "arn:aws:ssm:YOUR_REGION:YOUR_ACCOUNT_ID:parameter/YOUR_PATH"
+    }
+  ]
+}
+```
+
+#### `:fetch => :begins_with`
+
+If `:begins_with` is specified, `AwsSsmEnv::BeginsWithFetcher` is used to fetch
+parameters starting from the character string specified by the parameter name.  
+In this case, the `begins_with` argument described below is required.  
+When acquiring parameters in this way,
+you need the authority of `ssm:DescribeParameters` and `ssm:GetParameters`
+for the specified path.  
+An example of the IAM policy is shown below.
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "",
+      "Effect": "Allow",
+      "Action": "ssm:DescribeParameters",
+      "Resource": "arn:aws:ssm:YOUR_REGION:YOUR_ACCOUNT_ID:parameter"
+    },
+    {
+      "Sid": "",
+      "Effect": "Allow",
+      "Action": "ssm:GetParameters",
+      "Resource": "arn:aws:ssm:YOUR_REGION:YOUR_ACCOUNT_ID:parameter/YOUR_PREFIX*"
+    }
+  ]
+}
+```
+
+#### other
+
+If you specify an instance of a class that implements `AwsSsmEnv::Fetcher` in` fetch`,
+or an instance with a `each` method, that instance will be used as is.
+
+### naming: [Symbol, AwsSsmEnv::NamingStrategy, Object]
+
+Specify the naming strategy for the environment variable name.  
+Possible values are `:basename`,`:snakecase`
+or an instance of a class that implements `AwsSsmEnv::NamingStrategy`,
+or an instance of a class with a `parse_name` method.  
+If nothing is specified, it is treated as `:basename`.
+
+#### `:naming => :basename` or default
+
+If `naming` is not specified or `:basename` is specified,
+`AwsSsmEnv::BasenameNamingStrategy` whose variable name is
+the last hierarchy of the parameter hierarchy is used.  
+In this case, for example, if the parameter name is `/myapp/production/DB_PASSWORD`,
+the parameter value is set to `ENV['DB_PASSWORD']`. 
+
+#### `:naming => :snakecase`
+
+When `:snakecase` is specified, `AwsSsmEnv::SnakeCaseNamingStrategy` which uses
+the underscore delimiter of the parameter name's slash delimiter and converts
+it to uppercase letters as the environment variable name is used.  
+In this case, for example, if the parameter name is `/myapp/production/DB_PASSWORD`,
+the parameter value is set to `ENV['MYAPP_PRODUCTION_DB_PASSWORD']`.  
+You can specify first part of string to exclude with
+the `removed_prefix` argument described below.
+In addition, you can specify characters to be converted to
+underscores with the `delimiter` option described below.  
+In the following example, the parameter `/myapp/production/db.password` is
+set to `ENV['DB_PASSWORD']`.
+
+```ruby
+AwsSsmEnv.load!(
+  naming: :snakecase,
+  removed_prefix: '/myapp/production',
+  delimiter: /[\/.]/
+)
+```
+
+#### other
+
+If you specify an instance of a class that implements `AwsSsmEnv::NamingStrategy` in` fetch`,
+or an instance with a `parse_name` method, that instance is used as is.
+
+
+### path: [String]
+
+Required if nothing is specified for `fetch` or if `:path` is specified.  
+This option specifies the path hierarchy for acquiring parameters from `Parameter Store`.  
+In the example below, the parameter immediately under `/myapp/web/production` is acquired.
+
+```ruby
+AwsSsmEnv.load(path: '/myapp/web/production')
+```
+
+#### recursive: [Boolean]
+
+Used when no parameter is specified for `fetch` option or when `:path` is specified.  
+If true is specified, acquires all parameters below the specified path hierarchy.  
+If nothing is specified this parameter, it is treated as `false`(one level).  
+In the following example, all parameters below `/myapp/web/production` are acquired.
+
+```ruby
+AwsSsmEnv.load(path: '/myapp/web/production', recursive: true)
+```
+
+### begins_with: [String, Array<String>]
+
+Required if `:begins_with` is specified in `fetch`.  
+You can specify the prefix of the parameter name to be acquired by this option.  
+It is also possible to specify more than one in an array (OR condition).  
+In the example below, parameters with names starting with `myapp.web.production` are acquired.
+
+```ruby
+AwsSsmEnv.load(path: 'myapp.web.production')
+```
+
+### removed_prefix: [String]
+
+Used when `:snakecase` is specified in `naming`.  
+By this option, you can specify the prefix of the parameter name to exclude
+from the environment variable name.  
+If `:removed_ prefix` is not specified, and `:begins_with` or `:path` is specified, that will be used.
+
+### delimiter: [String, Regexp]
+
+Used when `:snakecase` is specified in `naming`.  
+By this option, you can specify a string or a regular expression to be converted to an underscore.  
+The default is a slash (`/`).
+
+### fetch_size: [Integer]
+
+Specify the number of parameters to be acquired with one execution of AWS API.  
+If `:path` is specified, the maximum value is `10` and the default is `10`.  
+If `:begins_with` is specified, the maximum value is `50` and the default is `50`.  
+Usually this parameter is never specified.
+
+## Security
+
+Because you must grant authority to acquire secret information,
+careful attention is required for security operation.
+
+
+When the `EC2 InstanceProfile` is set, the parameters can be seen by any account on EC2,
+It is necessary to improve the security level by preparing an IAM User separately
+from the `EC2 InstanceProfile`.
+
+If it is only the administrator that you can log in to EC2, 
+it is not much different from having it in a file.
+
+Since `AWS Fargate` makes it difficult to execute commands on containers,
+this risk is mitigated.
+
+## License
+
+Apache License 2.0
+
+## Contributors
+
+- Ryohei Sonoda <[sonodar](https://github.com/sonodar)>