knowledge-ssm 0.1.0

data/README.md

@@ -0,0 +1,63 @@
+# Knowledge Ssm
+
+This is the official AWS SSM adapter for knowledge gem.
+
+## Disclaimer
+
+The full documentation is currently being written. You should be able to find a better documentation in a few hours or days.
+
+Waiting for the full documentation, you can have a look at the code which is already well-documented.
+
+Have a look to the [wiki](https://github.com/knowledge-ruby/knowledge-ssm/wiki) too.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knowledge-ssm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knowledge-ssm
+
+## Usage
+
+```ruby
+require 'knowledge/ssm'
+  
+knowledge = Knowledge::Learner.new
+knowledge.variables = { ssm: { my_secret: 'path/to/secret' } }
+  
+knowledge.use(name: :ssm)
+knowledge.add_adapter_params(adapter: :ssm, params: { root_path: '/project' })
+  
+knowledge.gather!
+  
+Knowledge::Configuration.my_secret # "Secret value"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/knowledge-ruby/knowledge-ssm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Knowledge::Ssm project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/knowledge-ruby/knowledge-ssm/blob/master/CODE_OF_CONDUCT.md).
+
+## Licensing
+
+This project is licensed under [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.en.html).
+
+You can find it in LICENSE.md file.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'knowledge/ssm'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/knowledge-ssm.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knowledge/ssm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'knowledge-ssm'
+  spec.version       = Knowledge::Ssm::VERSION
+  spec.authors       = ['Johann Wilfrid-Calixte']
+  spec.email         = ['johann.open-source@protonmail.ch']
+
+  spec.summary       = 'SSM adapter for knowledge gem'
+  spec.description   = 'SSM adapter for knowledge gem'
+  spec.homepage      = 'https://github.com/knowledge-ruby/knowledge-ssm'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'https://johann.wilfrid-calixte.fr'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/knowledge-ruby/knowledge-ssm'
+    spec.metadata['changelog_uri'] = 'https://github.com/knowledge-ruby/knowledge-ssm/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'aws-sdk-ssm', '~> 1.34'
+  spec.add_dependency 'knowledge', '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '>= 0.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '>= 0.60'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/knowledge/adapters/ssm.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-ssm'
+
+module Knowledge
+  module Adapters
+    #
+    # === Description ===
+    #
+    # This adapter takes some vars in your SSM parameters and set it in your project's config.
+    #
+    # === Usage ===
+    #
+    # @example:
+    #   adapter = Knowledge::Adapters::Ssm.new(params: { root_path: '/path', setter: MySetter, variables: my_vars)
+    #
+    #   adapter.run
+    #
+    # === Attributes ===
+    #
+    # @attr_reader [Boolean] raise_not_found
+    # @attr_reader [String] root_path
+    # @attr_reader [Class] setter
+    # @attr_reader [Array<Aws::SSM::Types::Parameter>] ssm_parameters
+    # @attr_reader [Hash] variables
+    #
+    class Ssm < Base
+      # == Attributes ==================================================================================================
+      attr_reader :raise_not_found, :root_path, :ssm_parameters
+
+      # == Constructor =================================================================================================
+      #
+      # @param [Hash] :params
+      # @option params [Aws::SSM::Client] :client
+      # @option params [Boolean] :raise_on_parameter_not_found
+      # @option params [String] :root_path
+      # @param [Hash] :variables
+      # @param [Class] :setter
+      #
+      def initialize(params: {}, setter:, variables:)
+        super
+
+        @client = params[:client] || params['client']
+        @raise_not_found = params[:raise_on_parameter_not_found] || params['raise_on_parameter_not_found'] || false
+        @root_path = params[:root_path] || params['root_path']
+        @ssm_parameters = @root_path ? fetch_recursive_parameters : fetch_parameters
+      end
+
+      # == Instance Methods ============================================================================================
+      #
+      # === Description ===
+      #
+      # Runs the actual adapter.
+      #
+      def run
+        variables.each do |name, path|
+          base_path = root_path[0..-2] if root_path&.end_with?('/')
+          path = "/#{path.sub('/', '')}"
+          value = Array(@ssm_parameters).detect { |p| p.name == "#{base_path}#{path}" }&.value
+
+          setter.set(name: name, value: value)
+        end
+      end
+
+      protected
+
+      #
+      # === Description ===
+      #
+      # Credentials for AWS should be loaded from the ENV vars by the client itself.
+      # Authorization is done automatically according to the current AWS policies.
+      #
+      # === Errors ===
+      #
+      # @raise [Aws::SSM::Errors::UnrecognizedClientException]
+      # @raise [Aws::SSM::AccessDeniedException]
+      #
+      # === Parameters ===
+      #
+      # @return [Aws::SSM::Client]
+      #
+      def client
+        @client ||= ::Aws::SSM::Client.new
+      end
+
+      #
+      # === Description ===
+      #
+      # Fetches parameters one by one on SSM according to their specific path
+      #
+      # === Parameters ===
+      #
+      # @return [Array<Aws::SSM::Types::Parameter>]
+      #
+      def fetch_parameters
+        variables.map { |_name, path| fetch_parameter(path: path) }.compact
+      end
+
+      #
+      # === Description ===
+      #
+      # Recursively fetches parameters on SSM according to the given path
+      #
+      # === Errors ===
+      #
+      # @raise [Knowledge::SsmError]
+      #
+      # === Parameters ===
+      #
+      # @return [Array<Aws::SSM::Types::Parameter>]
+      #
+      def fetch_recursive_parameters
+        parameters = []
+        next_token = nil
+        first_page = true
+
+        while next_token || first_page
+          first_page = false
+          result = client.get_parameters_by_path(
+            next_token: next_token,
+            path: root_path,
+            recursive: true,
+            with_decryption: true
+          )
+          parameters += result.parameters
+          next_token = result.next_token
+        end
+
+        parameters
+      rescue ::Aws::SSM::Errors::AccessDeniedException, ::Aws::SSM::Errors::UnrecognizedClientException => e
+        raise ::Knowledge::SsmError, "[#{e.class}]: #{e.message}"
+      end
+
+      #
+      # === Description ===
+      #
+      # Fetches a parameter by its path on SSM
+      #
+      # === Error ===
+      #
+      # @raise [Knowledge::SsmError]
+      #
+      # === Parameters ===
+      #
+      # @param [String] :path
+      #
+      # @return [Aws::SSM::Types::Parameter]
+      #
+      def fetch_parameter(path:)
+        client.get_parameter(name: path, with_decryption: true).parameter
+      rescue ::Aws::SSM::Errors::AccessDeniedException, ::Aws::SSM::Errors::UnrecognizedClientException => e
+        raise ::Knowledge::SsmError, "[#{e.class}]: #{e.message}"
+      rescue ::Aws::SSM::Errors::ParameterNotFound => e
+        raise ::Knowledge::SsmError, "[#{e.class}]: #{e.message}" if raise_not_found
+      end
+    end
+  end
+end
+
+::Knowledge::Learner.register_default_adapter(
+  klass: ::Knowledge::Adapters::Ssm,
+  names: %i[aws_ssm ssm]
+)

data/lib/knowledge/ssm.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'knowledge/ssm/version'
+
+module Knowledge
+  class SsmError < Error; end
+
+  #
+  # === Description ===
+  #
+  # SSM Adapter for Knowledge gem
+  #
+  # === Usage ===
+  #
+  # @example:
+  #   require 'knowledge/ssm'
+  #
+  #   knowledge = Knowledge::Learner.new
+  #   knowledge.variables = { ssm: { my_secret: 'path/to/secret' } }
+  #
+  #   knowledge.use(name: :ssm)
+  #   knowledge.add_adapter_params(adapter: :ssm, params: { root_path: '/project' })
+  #
+  #   knowledge.gather!
+  #
+  #   Knowledge::Configuration.my_secret # "Secret value"
+  #
+  module Ssm; end
+end
+
+require 'knowledge/adapters/ssm'

data/lib/knowledge/ssm/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Knowledge
+  module Ssm
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: knowledge-ssm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johann Wilfrid-Calixte
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.34'
+- !ruby/object:Gem::Dependency
+  name: knowledge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SSM adapter for knowledge gem
+email:
+- johann.open-source@protonmail.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- knowledge-ssm.gemspec
+- lib/knowledge/adapters/ssm.rb
+- lib/knowledge/ssm.rb
+- lib/knowledge/ssm/version.rb
+homepage: https://github.com/knowledge-ruby/knowledge-ssm
+licenses: []
+metadata:
+  homepage_uri: https://github.com/knowledge-ruby/knowledge-ssm
+  source_code_uri: https://github.com/knowledge-ruby/knowledge-ssm
+  changelog_uri: https://github.com/knowledge-ruby/knowledge-ssm/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: SSM adapter for knowledge gem
+test_files: []