sourced_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67bcae6215d95ddc63e2dd5522805c69b73c4357756160d765a9f5581404152d
+  data.tar.gz: e6d714e45c36234238ff22c7c1390273de3df7b4c9d6ea1f52ee9829946f8ff4
+SHA512:
+  metadata.gz: 8d786b59013736cceb1435f5e88351cff813658f88ba88a0a1a927f32c2ad5baf5668b7ed7565179b880f21de5c206cb8b89454798c6545dbc52f8c7578d74ba
+  data.tar.gz: 977b760623e3e29f545de365193b83c2f1555274ed53c68dcb6941b13d56beec8b3b7c976703998a57a8ad04ad1c58c198b6eab451336a37748a0804e408f92d

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sourced_config.gemspec
+gemspec
+
+gem "sqlite3"
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Stephen Ierodiaconou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# SourcedConfig
+
+App configuration & Locales for Rails apps where the config is loaded from a remote or local non-repo source.
+
+Useful in apps that are 'white-labeled' and can have different configurations for different deployments.
+
+Config can be loaded from:
+- S3
+- Local files
+
+Locale data can be loaded from:
+- S3
+- Local files
+- Google Spreadsheets
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add sourced_config
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install sourced_config
+
+## Usage
+
+TODO: Write usage instructions here
+
+- Add an initializer to your app to configure the gem
+- Add a base config file to your app
+
+Access config with `SourcedConfig[key]`
+
+## 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 the created tag, 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/[USERNAME]/sourced_config.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/sourced_config/config_contract.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "dry-monads"
+require "dry-validation"
+
+module SourcedConfig
+  class ConfigContract < ::Dry::Validation::Contract
+    ::Dry::Validation.load_extensions(:monads)
+
+    class LocalesConfig < ConfigContract
+      params do
+        required(:supported).filled(array[:string])
+        optional(:load_from_type).filled(:string)
+        optional(:load_from_source).maybe(:string)
+      end
+    end
+
+    params do
+      required(:locales).hash(LocalesConfig.schema)
+    end
+
+    class << self
+      def key_names
+        schema.key_map.map(&:name)
+      end
+    end
+  end
+end

data/lib/sourced_config/config_manager.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module SourcedConfig
+  class ConfigManager
+    SOURCE_TYPE_LOCAL_FILE = "local_file"
+    SOURCE_TYPE_S3_CONFIG_BUCKET = "s3_config_bucket"
+
+    def root(key, raises: false)
+      raise ConfigurationNotLoadedError, "You cannot access config nodes until you have loaded configuration!" unless loaded?
+      raise ConfigurationRootKeyNotFoundError, "Config key #{key} not found" if raises && !configuration.key?(key)
+      configuration[key]
+    end
+
+    def load!(external_type, external_source_path)
+      Rails.logger.info "Load configuration data from #{external_type} - #{external_source_path}" if external_type
+      if loaded?
+        Rails.logger.warn "An attempt to load configuration happened when it is already loaded"
+        return false
+      end
+      primary_config = load_yaml_and_parse_erb(SourcedConfig.configuration.base_configuration_file_path).deep_symbolize_keys
+      external = external_type.present? && load_external_config(external_type, external_source_path).deep_symbolize_keys
+
+      schema = SourcedConfig.configuration.config_schema_klass.new
+      config_contract = schema.call(external ? primary_config.deep_merge(external) : primary_config)
+      if config_contract.failure?
+        messages = config_contract.errors(full: true).to_h
+        Rails.logger.error "Error in configuration file! #{messages}"
+        raise InvalidConfigurationError, "Failed to load configuration data! #{messages}"
+      end
+      @configuration = config_contract
+
+      loaded?
+    end
+
+    # Reload configuration files, only in development, this is hooked up to a file watcher on the config file
+    # and external directory if specified.
+    def reload!(external_type, external_source_path, force: false)
+      return false if Rails.env.production? && !force
+      Rails.logger.warn "Something changed: Reloading application configuration!"
+      @configuration = nil
+      load!(external_type, external_source_path)
+    end
+
+    def loaded?
+      configuration.present?
+    end
+
+    private
+
+    attr_reader :configuration
+
+    def load_external_config(external_type, external_source_path)
+      Rails.logger.info "Load external configuration data #{external_type}: #{external_source_path}"
+      case external_type
+      when SOURCE_TYPE_LOCAL_FILE
+        load_yaml(external_source_path)
+      when SOURCE_TYPE_S3_CONFIG_BUCKET
+        load_s3_config_bucket_file(external_source_path)
+      else
+        Rails.logger.error "Cannot load external configuration data for unknown #{external_type}"
+        raise ArgumentError, "Invalid external file type"
+      end
+    end
+
+    def load_yaml_and_parse_erb(file)
+      parsed = ERB.new(File.read(file)).result(binding)
+      parse_yaml(parsed)
+    end
+
+    def parse_yaml(str)
+      YAML.safe_load(str, permitted_classes: [Symbol])
+    end
+
+    def load_s3_config_bucket_file(path)
+      file = path || s3_file_path
+      Rails.logger.info "Loading from S3 #{s3_bucket} - #{s3_region} - #{file}"
+      s = SourcedConfig::S3File.read(s3_bucket, file, s3_region)
+      parse_yaml(s)
+    end
+
+    def s3_file_path
+      SourcedConfig.configuration.configuration_file_path
+    end
+
+    def s3_bucket
+      SourcedConfig.configuration.configuration_bucket
+    end
+
+    def s3_region
+      SourcedConfig.configuration.configuration_bucket_region
+    end
+
+    def load_yaml(file)
+      YAML.safe_load_file(file, permitted_classes: [Symbol])
+    end
+  end
+end

data/lib/sourced_config/locale/g_sheets_client.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module SourcedConfig
+  module Locale
+    class GSheetsClient
+      def initialize(url)
+        @url = url
+      end
+
+      attr_reader :url
+
+      def load(locale)
+        Rails.logger.debug { "[locale - #{locale}] Strings read (as UTF-8) from remote URL #{url}" }
+        content = get_content
+        parse_body(content.body.force_encoding("UTF-8")).reduce({}) do |memo, row|
+          parse_item(row, memo)
+        end
+      rescue => e
+        Rails.logger.error "[locale - #{locale}] Could not fetch TSV doc directly from Google Spreadsheets: #{e.message}"
+        {}
+      end
+
+      private
+
+      def parse_body(text)
+        CSV.parse(text, col_sep: "\t", quote_char: "^", skip_lines: /^\s*#.*$/, skip_blanks: true, headers: true)
+      end
+
+      def parse_item(item, locale_hash)
+        *keys, string = item.to_a.map { |x| x[1] }
+        keys.compact!
+        leaf_item = keys[..-2].reduce(locale_hash) do |h, k|
+          next h unless k.present?
+          h[k] ||= {}
+        end
+        leaf_item[keys.last] = string
+        locale_hash
+      end
+
+      def get_content
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.read_timeout = 5
+        http.open_timeout = 5
+        http.use_ssl = true
+        http.start do |http|
+          http.get(uri.request_uri)
+        end
+      end
+    end
+  end
+end

data/lib/sourced_config/locale/i18n_backend.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "loader"
+require_relative "null_client"
+
+module SourcedConfig
+  module Locale
+    class I18nBackend < ::I18n::Backend::Simple
+      def load_translations
+        return unless ::SourcedConfig.loaded?
+        type = ::SourcedConfig[:locales][:load_from_type]
+        source = ::SourcedConfig[:locales][:load_from_source]
+        null_client = Rails.env.test? ? NullClient.new : nil
+        loader = Loader.new(type, source, client: null_client)
+        ::SourcedConfig[:locales][:supported].each do |locale|
+          Rails.logger.info "Load I18n: for supported locale #{locale}"
+          store_translations(locale, loader.load(locale.to_sym)[locale])
+        end
+      end
+    end
+  end
+end

data/lib/sourced_config/locale/loader.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "./g_sheets_client"
+require_relative "./s3_config_client"
+
+module SourcedConfig
+  module Locale
+    class Loader
+      COPY_SOURCE_TYPE_LOCAL_DIRECTORY = "local-directory"
+      COPY_SOURCE_TYPE_S3_CONFIG = "s3-config"
+      COPY_SOURCE_TYPE_GOOGLE_SHEETS = "google-sheets"
+      COPY_SOURCE_TYPE_DEFAULT = "default"
+
+      def initialize(type, source, client: nil)
+        @type = type
+        @source = source
+        @client = client
+      end
+
+      attr_reader :locale, :type, :source
+
+      def load(locale)
+        Rails.logger.debug { "[locale - #{locale}] Load copy from #{type} #{source}" }
+        case type
+        when COPY_SOURCE_TYPE_LOCAL_DIRECTORY
+          HashWithIndifferentAccess.new load_from_local_dir(locale)
+        when COPY_SOURCE_TYPE_S3_CONFIG, COPY_SOURCE_TYPE_GOOGLE_SHEETS
+          HashWithIndifferentAccess.new(locale => HashWithIndifferentAccess.new(client.load(locale)))
+        when COPY_SOURCE_TYPE_DEFAULT
+          Rails.logger.warn "[locale - #{locale}] Using only default app copy"
+          HashWithIndifferentAccess.new(locale => {})
+        else
+          raise StandardError, "When loading the Copy and Content the type was unrecognised! #{type}"
+        end
+      end
+
+      private
+
+      def client
+        return @client if @client
+        @client = case type
+        when COPY_SOURCE_TYPE_S3_CONFIG
+          S3ConfigClient.new
+        when COPY_SOURCE_TYPE_GOOGLE_SHEETS
+          GSheetsClient.new(source)
+        end
+      end
+
+      def load_from_local_dir(locale)
+        YAML.safe_load_file(Rails.root.join(source, "#{locale}.yml")) || {}
+      end
+    end
+  end
+end

data/lib/sourced_config/locale/null_client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SourcedConfig
+  module Locale
+    class NullClient
+      def load(_locale)
+        {}
+      end
+    end
+  end
+end

data/lib/sourced_config/locale/s3_config_client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../s3_file"
+
+module SourcedConfig
+  module Locale
+    class S3ConfigClient
+      def initialize(
+        bucket: ::SourcedConfig.configuration.configuration_bucket,
+        region: ::SourcedConfig.configuration.configuration_bucket_region
+      )
+        @bucket = bucket
+        @region = region
+      end
+
+      attr_reader :bucket, :region
+
+      def load(locale)
+        Rails.logger.debug "Locale read from S3 locale file"
+        file = "locales/#{locale}.yml" # TODO: make this configurable
+        str = ::SourcedConfig::S3File.read(bucket, file, region)
+        yaml = YAML.safe_load(str)
+        root_node = yaml[locale.to_s]
+        return {} if root_node.blank?
+        root_node
+      end
+    end
+  end
+end

data/lib/sourced_config/railtie.rb

@@ -0,0 +1,7 @@
+module SourcedConfig
+  class Railtie < ::Rails::Railtie
+    # rake_tasks do
+    #   load "tasks/sourced_config_tasks.rake"
+    # end
+  end
+end

data/lib/sourced_config/s3_file.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SourcedConfig
+  class S3File
+    def self.read(bucket, path, region, retry_limit: 10)
+      s3 = Aws::S3::Client.new(retry_limit: retry_limit, region: region)
+      resp = s3.get_object(bucket: bucket, key: path)
+      resp.body
+    end
+  end
+end

data/lib/sourced_config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SourcedConfig
+  VERSION = "0.1.0"
+end

data/lib/sourced_config.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "sourced_config/version"
+require_relative "sourced_config/railtie"
+require_relative "sourced_config/config_manager"
+require_relative "sourced_config/config_contract"
+require_relative "sourced_config/locale/i18n_backend"
+
+module SourcedConfig
+  class ConfigurationNotLoadedError < StandardError; end
+
+  class InvalidConfigurationError < StandardError; end
+
+  class ConfigurationRootKeyNotFoundError < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration) if block_given?
+      configuration
+    end
+  end
+
+  class Configuration
+    attr_accessor :config_schema_klass,
+      :config_type,
+      :base_configuration_file_path, # Can also be ERB
+      :configuration_bucket,
+      :configuration_bucket_region,
+      :configuration_file_path # Can not be ERB
+
+    def initialize
+      @config_schema_klass = ConfigContract
+      @base_configuration_file_path = Rails.root.join("config/config.yml.erb")
+    end
+  end
+
+  # The configuration class API
+  # Uses the ConfigManager to actually hold and prepare configuration data
+  class << self
+    # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/i18n_railtie.rb
+    @inited = false
+
+    def config_type_file?
+      configuration.config_type == ConfigManager::SOURCE_TYPE_LOCAL_FILE
+    end
+
+    def setup(app)
+      return if @inited
+
+      I18n.backend = I18n::Backend::Chain.new(Locale::I18nBackend.new, I18n.backend)
+
+      files = [configuration.base_configuration_file_path]
+
+      files << Rails.root.join(configuration.configuration_file_path) if config_type_file?
+
+      reloader = app.config.file_watcher.new(files) do
+        Rails.logger.warn "*** Application configuration changed in #{Rails.env} " \
+            "(zeitwerk: #{Rails.autoloaders.zeitwerk_enabled?})"
+        SourcedConfig.load!(configuration.config_type, configuration.configuration_file_path)
+      end
+
+      app.reloaders << reloader
+      app.reloader.to_run do
+        # We are *not* using execute_if_updated cause if anything causes Classes to be reloaded it will kill the config
+        # persisted in the class variable in the Config singleton. So we want to always execute a reload (eg when
+        # I18n content changes)
+        reloader.execute { require_unload_lock! }
+      end
+
+      # Load now
+      reloader.execute
+
+      @started_up ||= Time.zone.now
+      @inited = true
+    end
+
+    def load!(type = SourcedConfig.configuration.config_type, source_path = SourcedConfig.configuration.configuration_file_path, force: false)
+      loaded? ? manager.reload!(type, source_path, force: force) : manager.load!(type, source_path)
+    end
+
+    def startup_time
+      @started_up
+    end
+
+    # Get a key from the configuration
+    def [](key)
+      manager.root(key)
+    end
+
+    # Dig lets you reach in and extract deeply nested keys from an array of keys. Note will NOT raise if the key
+    # doesnt exist, like Hash#dig etc
+    def dig(root, *keys)
+      manager.root(root).dig(*keys)
+    end
+
+    def loaded?
+      manager&.loaded?
+    end
+
+    private
+
+    def manager
+      @manager ||= ConfigManager.new
+    end
+  end
+end

data/lib/tasks/sourced_config_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sourced_config do
+#   # Task goes here
+# end

data/sig/sourced_config.rbs

@@ -0,0 +1,4 @@
+module SourcedConfig
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: sourced_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Ierodiaconou
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  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: dry-validation
+  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'
+description: Load configuration & locales for Rails apps from a remote or local non-repo
+  source.
+email:
+- stevegeek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sourced_config.rb
+- lib/sourced_config/config_contract.rb
+- lib/sourced_config/config_manager.rb
+- lib/sourced_config/locale/g_sheets_client.rb
+- lib/sourced_config/locale/i18n_backend.rb
+- lib/sourced_config/locale/loader.rb
+- lib/sourced_config/locale/null_client.rb
+- lib/sourced_config/locale/s3_config_client.rb
+- lib/sourced_config/railtie.rb
+- lib/sourced_config/s3_file.rb
+- lib/sourced_config/version.rb
+- lib/tasks/sourced_config_tasks.rake
+- sig/sourced_config.rbs
+homepage: https://github.com/stevegeek/sourced_config
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stevegeek/sourced_config
+  source_code_uri: https://github.com/stevegeek/sourced_config
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Load configuration & locales for Rails apps from a remote or local non-repo
+  source.
+test_files: []