exercism-config 0.50.0 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682ac352cd9846f8485bb5e27ec597871df5c57d227cd3663e60e14c09ec273a
-  data.tar.gz: 208acd5687549ada0d4ec85bdf2b4ca1015f32ace42c1937bd7f216eaa820409
+  metadata.gz: c6e54c12d701536a89b8e382b481dce7e13407e2c98491901b8e711284b8e63a
+  data.tar.gz: a69555d9cc2681c780ae0a9395d4483efc961bb1c886de410a26fc42e265bd28
 SHA512:
-  metadata.gz: 609b4aa9b5682437fd3ed8e7f1961c2f40121a7ab1bd9ecf8d20aee43c7cc515ede573a244ba1c0534aa35a215a9ebd1f8a516a395559acca09aeafe362609db
-  data.tar.gz: dbd577ed0ad922c6f8a595d8f8e562470172b419431b5ccd77357d82568218bc75587c050c70b609eaa10d200eea7e1ac53621835ba4ad660c3ea937db0ced4d
+  metadata.gz: 516a52a717400357843f5bdcb9a628747dfb3bfddd06a933cb32cb72f401231692248bd2d67d94cff42198ab871f322d0ad4b6564e5556f5f907540708fa2c59
+  data.tar.gz: 4b9f8884c5fb26390bece3826c26ff165e7f7f9e74ff89286d9e85cfb1becf4817a3580e2d99666de19d8a16ed57e7d17e36267be8afb1db987a0b24d781d1ee

data/.github/workflows/rubocop.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+        uses: ruby/setup-ruby@a699edbce608a2c128dedad88e3b6a0e28687b3c
         with:
           ruby-version: 2.6.6
 

data/.github/workflows/tests.yml

@@ -11,10 +11,10 @@ jobs:
     runs-on: ubuntu-latest
 
     services:
-      dynamodb:
-        image: "amazon/dynamodb-local"
+      aws:
+        image: "localstack/localstack"
         ports:
-          - 8000
+          - 4566
 
     steps:
       ###
@@ -24,19 +24,10 @@ jobs:
       ###
       # Setup Ruby - this needs to match the version in the Gemfile
       - name: Set up Ruby
-        uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+        uses: ruby/setup-ruby@a699edbce608a2c128dedad88e3b6a0e28687b3c
         with:
           ruby-version: 2.6.6
-
-      ###
-      # Caching using GitHub's caching action
-      - name: Cache Bundler
-        uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-
+          bundler-cache: true
 
       ###
       # Install bundler and yarn dependencies
@@ -44,10 +35,8 @@ jobs:
         env:
           EXERCISM_ENV: test
           EXERCISM_CI: true
-          DYNAMODB_PORT: ${{ job.services.dynamodb.ports['8000'] }}
+          AWS_PORT: ${{ job.services.aws.ports['4566'] }}
         run: |
-          bundle config path vendor/bundle # This is needed for the caching above
-          bundle install --jobs 4 --retry 3
           bundle exec setup_exercism_config
 
       ###
@@ -64,7 +53,7 @@ jobs:
         env:
           EXERCISM_ENV: test
           EXERCISM_CI: true
-          DYNAMODB_PORT: ${{ job.services.dynamodb.ports['8000'] }}
+          AWS_PORT: ${{ job.services.aws.ports['4566'] }}
           CAPTURE_CODE_COVERAGE: true
         run: |
           bundle exec rake test

data/README.md

@@ -5,11 +5,49 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/513edbd6599a2de3218d/test_coverage)](https://codeclimate.com/github/exercism/config/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/exercism-config.svg)](https://badge.fury.io/rb/exercism-config)
 
+## Usage
+
+This gem provides you with the following config and secrets:
+
+```ruby
+# Config
+
+Exercism.config.anycable_redis_url
+Exercism.config.anycable_rpc_host
+Exercism.config.aws_submissions_bucket
+Exercism.config.aws_tooling_jobs_bucket
+Exercism.config.dynamodb_tooling_jobs_table
+Exercism.config.dynamodb_tooling_language_groups_table
+Exercism.config.mysql_master_endpoint
+Exercism.config.mysql_port
+Exercism.config.spi_url
+Exercism.config.tooling_orchestrator_url
+Exercism.config.language_server_url
+
+# Secrets
+Exercism.secrets.github_omniauth_app_id
+Exercism.secrets.github_omniauth_app_secret
+Exercism.secrets.hcaptcha_site_key
+Exercism.secrets.hcaptcha_secret
+```
+
+## Explaination
+
 When terraform creates Exercism's infrastructure, it writes endpoints and DNS entries to DynamoDB.
 This gem allows you to trivially retrieve that data.
 
 When running on AWS, simply ensure the machine has read-access to the relevant table (currently hardcoded to `config`).
-On a local machine specify the AWS_PROFILE environment variable with the relevant profile stored in your `.aws/credentials`.
+
+## Local AWS
+
+This requires a local version of AWS to work.
+We use localstack for this.
+If you use the development-environment this will be handled for you.
+If not, to start localstack use the following:
+
+```bash
+docker run -dp 3042:8080 -p 3040:4566 -p 3041:4566 localstack/localstack
+```
 
 ## Usage
 

data/bin/setup_exercism_config

@@ -10,8 +10,8 @@ if Exercism.env.production?
   exit
 end
 
-def create_table(client)
-  client.create_table(
+def create_dynamodb_table
+  Exercism.dynamodb_client.create_table(
     table_name: :config,
     attribute_definitions: [
       {
@@ -33,13 +33,13 @@ def create_table(client)
 end
 
 def delete_table(client)
-  client.delete_table(
+  Exercism.dynamodb_client.delete_table(
     table_name: :config
   )
 end
 
-def set_config_value(client, id, value)
-  client.put_item(
+def set_config_value(id, value)
+  Exercism.dynamodb_client.put_item(
     table_name: :config,
     item: {
       id: id,
@@ -48,15 +48,13 @@ def set_config_value(client, id, value)
   )
 end
 
-client = ExercismConfig::SetupDynamoDBClient.call
-
 begin
-  create_table(client)
+  create_dynamodb_table
 rescue Aws::DynamoDB::Errors::ResourceInUseException => e
   if ARGV.include?('--force')
     puts 'Table exists. Recreating...'
-    delete_table(client)
-    create_table(client)
+    delete_table
+    create_dynamodb_table
     puts 'Table recreated.'
   else
     puts 'Table exists. Not recreating.'
@@ -79,5 +77,16 @@ puts "Using settings file: #{settings_file}"
 settings = YAML.load(ERB.new(File.read(settings_file)).result)
 
 settings.each do |key, value|
-  set_config_value(client, key, value)
+  set_config_value(key, value)
 end
+
+secrets_file = File.expand_path('../settings/secrets.yml', __dir__)
+puts "Using secrets file: #{secrets_file}"
+secrets_json = YAML.load(ERB.new(File.read(secrets_file)).result).to_json
+
+secrets_client = Aws::SecretsManager::Client.new(ExercismConfig::GenerateAwsSettings.())
+secrets_client.create_secret(
+  description: "Exercism Config used secrets", 
+  name: "config", 
+  secret_string: secrets_json
+)

data/bin/setup_exercism_local_aws

@@ -7,8 +7,6 @@ return if Exercism.env.production?
 
 puts "Create AWS/DynamoDB tables..."
 
-Exercism.config.dynamodb_client = ExercismConfig::SetupDynamoDBClient.()
-
 ##################
 # Setup local s3 #
 ##################
@@ -19,7 +17,7 @@ unless ENV["EXERCISM_SKIP_S3"]
     Exercism.config.aws_tooling_jobs_bucket,
   ].each do |bucket|
     begin
-      ExercismConfig::SetupS3Client.().create_bucket(bucket: bucket)
+      Exercism.s3_client.create_bucket(bucket: bucket)
     rescue Seahorse::Client::NetworkingError => e
       puts "local S3 not up yet..."
       sleep 2 # slighty retry delaty

data/exercism_config.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Retrieves stored config for Exercism'
   spec.homepage      = 'https://exercism.io'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.6')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/exercism/config'
@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'aws-sdk-dynamodb', '~> 1.0'
+  spec.add_dependency 'aws-sdk-secretsmanager', '~> 1.0'
   spec.add_dependency 'mandate'
   spec.add_dependency 'zeitwerk'
 
@@ -36,6 +37,7 @@ Gem::Specification.new do |spec|
 
   # This isn't a compulsary dependency
   # but can be used if someone puts it in their
-  # own gemfile
+  # own Gemfile when using this.
   spec.add_development_dependency 'aws-sdk-s3'
+  spec.add_development_dependency 'aws-sdk-ecr'
 end

data/lib/exercism-config.rb

@@ -1,4 +1,5 @@
 require 'aws-sdk-dynamodb'
+require 'aws-sdk-secretsmanager'
 require 'mandate'
 require 'ostruct'
 require 'json'
@@ -9,10 +10,12 @@ require_relative 'exercism_config/generate_aws_settings'
 require_relative 'exercism_config/setup_dynamodb_client'
 require_relative 'exercism_config/setup_ecr_client'
 require_relative 'exercism_config/setup_s3_client'
-require_relative 'exercism_config/retrieve'
-require_relative 'exercism_config/version'
+require_relative 'exercism_config/retrieve_config'
+require_relative 'exercism_config/retrieve_secrets'
 
+require_relative 'exercism_config/version'
 require_relative 'exercism/config'
+require_relative 'exercism/secrets'
 
 module Exercism
   class ConfigError < RuntimeError; end
@@ -21,12 +24,29 @@ module Exercism
     @env ||= ExercismConfig::DetermineEnvironment.()
   end
 
-  def self.environment
-    puts "Exercism.environment is deprecated. Use Exercism.env"
-    env
+  def self.config
+    @config ||= ExercismConfig::RetrieveConfig.()
   end
 
-  def self.config
-    @config ||= ExercismConfig::Retrieve.()
+  def self.secrets
+    @secrets ||= ExercismConfig::RetrieveSecrets.()
+  end
+
+  def self.dynamodb_client
+    Aws::DynamoDB::Client.new(ExercismConfig::GenerateAwsSettings.())
+  end
+
+  def self.s3_client
+    require 'aws-sdk-s3'
+    Aws::S3::Client.new(
+      ExercismConfig::GenerateAwsSettings.().merge(
+        force_path_style: true
+      )
+    )
+  end
+
+  def self.ecr_client
+    require 'aws-sdk-ecr'
+    Aws::ECR::Client.new(ExercismConfig::GenerateAwsSettings.())
   end
 end

data/lib/exercism/secrets.rb

@@ -0,0 +1,4 @@
+module Exercism
+  class Secrets < OpenStruct
+  end
+end

data/lib/exercism_config/determine_environment.rb

@@ -4,9 +4,7 @@ module ExercismConfig
 
     def call
       env = ENV['EXERCISM_ENV'] || ENV['RAILS_ENV'] || ENV['APP_ENV']
-      unless env
-        env = Rails.env.to_s if Object.const_defined?(:Rails) && Rails.respond_to?(:env)
-      end
+      env = Rails.env.to_s if !env && Object.const_defined?(:Rails) && Rails.respond_to?(:env)
 
       raise Exercism::ConfigError, 'No environment set - set one of EXERCISM_ENV, RAILS_ENV or APP_ENV' unless env
 

data/lib/exercism_config/generate_aws_settings.rb

@@ -5,7 +5,7 @@ module ExercismConfig
     def call
       {
         region: 'eu-west-2',
-        profile: profile,
+        endpoint: endpoint,
         access_key_id: aws_access_key_id,
         secret_access_key: aws_secret_access_key
       }.select { |_k, v| v }
@@ -22,8 +22,12 @@ module ExercismConfig
     end
 
     memoize
-    def profile
-      Exercism.env.production? ? nil : 'exercism_staging'
+    def endpoint
+      return nil if Exercism.env.production?
+      return "http://127.0.0.1:#{ENV['AWS_PORT']}" if Exercism.env.test? && ENV['EXERCISM_CI']
+
+      host = ENV['EXERCISM_DOCKER'] ? 'aws:3040' : 'localhost:3040'
+      "http://#{host}"
     end
   end
 end

data/lib/exercism_config/{retrieve.rb → retrieve_config.rb}

@@ -1,5 +1,5 @@
 module ExercismConfig
-  class Retrieve
+  class RetrieveConfig
     include Mandate
 
     def call
@@ -13,24 +13,14 @@ module ExercismConfig
       require 'erb'
       require 'yaml'
 
-      filename = if ENV["EXERCISM_CI"]
-                   'ci'
-                 elsif ENV["EXERCISM_DOCKER"]
-                   'docker'
-                 else
-                   'local'
-                 end
-
-      settings_file = File.expand_path("../../../settings/#{filename}.yml", __FILE__)
+      settings_file = File.expand_path("../../../settings/#{settings_filename}.yml", __FILE__)
       settings = YAML.safe_load(ERB.new(File.read(settings_file)).result)
 
       Exercism::Config.new(settings, {})
     end
 
     def retrieve_from_dynamodb
-      client = SetupDynamoDBClient.()
-
-      resp = client.scan({ table_name: 'config' })
+      resp = Exercism.dynamodb_client.scan({ table_name: 'config' })
       items = resp.to_h[:items]
       data = items.each_with_object({}) do |item, h|
         h[item['id']] = item['value']
@@ -44,17 +34,15 @@ module ExercismConfig
       raise Exercism::ConfigError, "Exercism Config could not be loaded: #{e.message}"
     end
 
-    memoize
-    def aws_client
-      config = {
-        region: 'eu-west-2',
-        profile: profile,
-        endpoint: endpoint,
-        access_key_id: aws_access_key_id,
-        secret_access_key: aws_secret_access_key
-      }.select { |_k, v| v }
-
-      Aws::DynamoDB::Client.new(config)
+    def settings_filename
+      if ENV["EXERCISM_CI"]
+        'ci'
+      elsif ENV["EXERCISM_DOCKER"]
+        'docker'
+      else
+        'local'
+      end
     end
+
   end
 end

data/lib/exercism_config/retrieve_secrets.rb

@@ -0,0 +1,30 @@
+module ExercismConfig
+  class RetrieveSecrets
+    include Mandate
+
+    def call
+      return generate_mock if Exercism.env.test?
+
+      retrieve_from_aws
+    end
+
+    private
+    def generate_mock
+      require 'erb'
+      require 'yaml'
+
+      settings_file = File.expand_path('../../settings/secrets.yml', __dir__)
+      settings = YAML.safe_load(ERB.new(File.read(settings_file)).result)
+
+      Exercism::Settings.new(settings, {})
+    end
+
+    def retrieve_from_aws
+      client = Aws::SecretsManager::Client.new(GenerateAwsSettings.())
+      json = client.get_secret_value(secret_id: "config").secret_string
+      Exercism::Secrets.new(JSON.parse(json))
+    rescue StandardError => e
+      raise Exercism::ConfigError, "Exercism's secrets could not be loaded: #{e.message}"
+    end
+  end
+end

data/lib/exercism_config/setup_dynamodb_client.rb

@@ -3,25 +3,9 @@ module ExercismConfig
     include Mandate
 
     def call
-      aws_settings = GenerateAwsSettings.().merge(
-        endpoint: config_endpoint,
+      puts "[DEPRECATION] ExercismConfig::SetupDynamoDBClient.() is deprecated. Please use Exercism.dynamodb_client"
 
-        # We don't want a profile for this AWS service
-        # as we run it locally. But we do normally, so
-        # we locally override this here.
-        profile: nil
-      ).select { |_k, v| v }
-      Aws::DynamoDB::Client.new(aws_settings)
-    end
-
-    private
-    memoize
-    def config_endpoint
-      return nil if Exercism.env.production?
-      return "http://127.0.0.1:#{ENV['DYNAMODB_PORT']}" if Exercism.env.test? && ENV['EXERCISM_CI']
-
-      host = ENV['EXERCISM_DOCKER'] ? 'dynamodb:8000' : 'localhost:3040'
-      "http://#{host}"
+      Exercism.dynamodb_client
     end
   end
 end

data/lib/exercism_config/setup_ecr_client.rb

@@ -3,16 +3,9 @@ module ExercismConfig
     include Mandate
 
     def call
-      aws_settings = GenerateAwsSettings.().merge(
-        # endpoint: config_endpoint,
+      puts "[DEPRECATION] ExercismConfig::SetupECRClient.() is deprecated. Please use Exercism.ecr_client"
 
-        # We don't want a profile for this AWS service
-        # as we run it locally. But we do normally, so
-        # we locally override this here.
-        profile: nil
-      ).select { |_k, v| v }
-
-      Aws::ECR::Client.new(aws_settings)
+      Exercism.ecr_client
     end
   end
 end

data/lib/exercism_config/setup_s3_client.rb

@@ -3,28 +3,9 @@ module ExercismConfig
     include Mandate
 
     def call
-      require 'aws-sdk-s3'
+      puts "[DEPRECATION] ExercismConfig::SetupS3Client.() is deprecated. Please use Exercism.s3_client"
 
-      aws_settings = GenerateAwsSettings.().merge(
-        endpoint: config_endpoint,
-        force_path_style: true,
-
-        # We don't want a profile for this AWS service
-        # as we run it locally. But we do normally, so
-        # we locally override this here.
-        profile: nil
-      ).select { |_k, v| v }
-      Aws::S3::Client.new(aws_settings)
-    end
-
-    private
-    memoize
-    def config_endpoint
-      return nil if Exercism.env.production?
-      return "http://127.0.0.1:#{ENV['S3_PORT']}" if Exercism.env.test? && ENV['EXERCISM_CI']
-
-      host = ENV['EXERCISM_DOCKER'] ? 's3:9090' : 'localhost:3041'
-      "http://#{host}"
+      Exercism.s3_client
     end
   end
 end

data/lib/exercism_config/version.rb

@@ -1,3 +1,3 @@
 module ExercismConfig
-  VERSION = '0.50.0'.freeze
+  VERSION = '0.51.0'.freeze
 end

data/settings/secrets.yml

@@ -0,0 +1,4 @@
+github_omniauth_app_id: "some-github-app-id"
+github_omniauth_app_secret: "some-github-app-exercism-secret"
+hcaptcha_site_key: "some-hcaptcha-site-key"
+hcaptcha_secret: "some-hcaptcha-secret"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exercism-config
 version: !ruby/object:Gem::Version
-  version: 0.50.0
+  version: 0.51.0
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-secretsmanager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: mandate
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ecr
+  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:
 email:
 - jez.walker@gmail.com
@@ -148,10 +176,12 @@ files:
 - exercism_config.gemspec
 - lib/exercism-config.rb
 - lib/exercism/config.rb
+- lib/exercism/secrets.rb
 - lib/exercism_config/determine_environment.rb
 - lib/exercism_config/environment.rb
 - lib/exercism_config/generate_aws_settings.rb
-- lib/exercism_config/retrieve.rb
+- lib/exercism_config/retrieve_config.rb
+- lib/exercism_config/retrieve_secrets.rb
 - lib/exercism_config/setup_dynamodb_client.rb
 - lib/exercism_config/setup_ecr_client.rb
 - lib/exercism_config/setup_s3_client.rb
@@ -160,6 +190,7 @@ files:
 - settings/ci.yml
 - settings/docker.yml
 - settings/local.yml
+- settings/secrets.yml
 - yarn.lock
 homepage: https://exercism.io
 licenses: []
@@ -174,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="