exercism_config 0.1.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4acb86b0b382be29813209eed5fa2263bd146835c50b5b6c58e3bc86c958905
-  data.tar.gz: 2ccddb5bdb07c5aa546778dc006676cb47da901abcc8e20212922fc4dda88f9e
+  metadata.gz: 620afb9bb7623f6ed560ad3e6431b4466ad985379c4e0af174b8a635fc4b19df
+  data.tar.gz: ad2d2b64388d893da5099aa3d3827a706c5ec98de2e1ca5e0f2802d0e79d41a8
 SHA512:
-  metadata.gz: 454f3c7ed928f36cf094d97f88a23182b650ef46d84c61b6d276104cb3e6bb61dbc956f089e7d15d2d264bc5e3c0f8ace7420a4b870dc3281f098fbef2d9accf
-  data.tar.gz: 30d210c3b575278ddfa1f48fae8569e46c46bfc75e2961ed081f675f69bc0f7f527312d680e2a45d75a8ea0e1af4806e9ca8a79e1a50e6f0e29dc1cdf8bd3f3f
+  metadata.gz: 105e94188dbcd307eba148de2107912e1bb35431181f0ee1399b49553a1420d2db946ee467a0a12d81ad784138f68c785905b3ae349b63a9592f65e8cd5b5641
+  data.tar.gz: 9c2bb195adf603c26c9d0236f21b35c1bdef5b57ebbca7ccc3f91c8c0b4ec21d9cc28a379314ed04813c1f40a9b6f4cfc257b292a46330e924cdef58e477f962

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+exercism_config-*.gem

data/Gemfile

@@ -3,9 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in exercism_config.gemspec
 gemspec
 
-gem 'aws-sdk-dynamodb'
-gem 'mandate'
-gem 'zeitwerk'
-
 gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -1,14 +1,17 @@
 PATH
   remote: .
   specs:
-    exercism_config (0.1.0)
+    exercism_config (0.6.0)
+      aws-sdk-dynamodb (~> 1.0)
+      mandate
+      zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
     aws-eventstream (1.1.0)
-    aws-partitions (1.343.0)
-    aws-sdk-core (3.104.1)
+    aws-partitions (1.345.0)
+    aws-sdk-core (3.104.3)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
@@ -21,19 +24,19 @@ GEM
     jmespath (1.4.0)
     mandate (0.3.0)
     minitest (5.14.1)
+    mocha (1.11.2)
     rake (12.3.3)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aws-sdk-dynamodb
+  bundler (~> 2.1)
   exercism_config!
-  mandate
   minitest (~> 5.0)
+  mocha
   rake (~> 12.0)
-  zeitwerk
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,36 +1,26 @@
-# ExercismConfig
+# Exercism Config
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/exercism_config`. To experiment with that code, run `bin/console` for an interactive prompt.
+When terraform creates Exercism's infrastructure, it writes endpoints and DNS entries to DynamoDB.
+This gem allows you to trivially retrieve that data.
 
-TODO: Delete this and the text above, and describe your gem
+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`.
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Simply include this gem in your Gemfile, require it, and then refer to the object:
 
 ```ruby
+# Gemfile
 gem 'exercism_config'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install exercism_config
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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
+# Your code
+require 'exercism_config'
+ExercismConfig.config.webservers_alb_dns_name
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/exercism_config.
+To print out all the config from the command-line, you can run:
 
+```bash
+AWS_PROFILE=exercism_terraform ./bin/run
+```

data/exercism_config.gemspec

@@ -21,4 +21,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk-dynamodb", "~> 1.0"
+  spec.add_dependency "mandate"
+  spec.add_dependency "zeitwerk"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha"
 end

data/lib/exercism/config.rb

@@ -0,0 +1,12 @@
+module Exercism
+  class Config < OpenStruct
+    def initialize(data, aws_settings)
+      super(data)
+      self.aws_settings = aws_settings
+    end
+
+    def to_json
+      to_h.to_json
+    end
+  end
+end

data/lib/exercism_config.rb

@@ -2,13 +2,14 @@ require "exercism_config/version"
 require 'aws-sdk-dynamodb'
 require 'mandate'
 require "ostruct"
+require 'json'
 
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
 loader.setup
 
-module ExercismConfig
+module Exercism
   def self.config
-    @config ||= Retrieve.()
+    @config ||= ExercismConfig::Retrieve.()
   end
 end

data/lib/exercism_config/retrieve.rb

@@ -2,22 +2,54 @@ module ExercismConfig
   class Retrieve
     include Mandate
 
+    def initialize(environment = nil)
+      @environment = environment
+    end
+
     def call
-      resp = aws_client.scan({table_name: "config"})
+      aws_settings = GenerateAwsSettings.(environment)
+      client = Aws::DynamoDB::Client.new(aws_settings)
+
+      resp = client.scan({table_name: "config"})
       items = resp.to_h[:items]
       data = items.each_with_object({}) do |item, h|
         h[item['id']] = item['value']
       end
 
-      Config.new(data)
+      Exercism::Config.new(data, aws_settings)
+    rescue Exercism::ConfigError
+      raise
+    rescue => e
+      raise Exercism::ConfigError, "Exercism Config could not be loaded: #{e.message}"
     end
 
+    private
     memoize
     def aws_client
-      config = {region: 'eu-west-2'}
-      config[:profile] = ENV["AWS_PROFILE"] if ENV["AWS_PROFILE"]
+      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)
     end
+
+    memoize
+    def environment
+      return @environment.to_sym if @environment
+
+      env = ENV["EXERCISM_ENV"] || ENV["RAILS_ENV"] || ENV["APP_ENV"]
+      raise Exercism::ConfigError, "No environment set - set one of EXERCISM_ENV, RAILS_ENV or APP_ENV" unless env
+
+      unless %w[development test production].include?(env)
+        raise Exercism::ConfigError, "environments must be one of development test production. Got #{env}"
+      end
+
+      env.to_sym
+    end
   end
 end
 

data/lib/exercism_config/version.rb

@@ -1,3 +1,3 @@
 module ExercismConfig
-  VERSION = "0.1.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,15 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: exercism_config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
-dependencies: []
+date: 2020-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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
@@ -27,8 +125,8 @@ files:
 - bin/run
 - bin/setup
 - exercism_config.gemspec
+- lib/exercism/config.rb
 - lib/exercism_config.rb
-- lib/exercism_config/config.rb
 - lib/exercism_config/retrieve.rb
 - lib/exercism_config/version.rb
 homepage: https://exercism.io

data/lib/exercism_config/config.rb

@@ -1,7 +0,0 @@
-module ExercismConfig
-  class Config < SimpleDelegator
-    def to_json
-      to_h.to_json
-    end
-  end
-end