blinkist-config 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fcbcd596ce5bde72a5ffe9ee8b07f772f4034dbc
+  data.tar.gz: 91711dab272c12e0ec40b4dbc2ccdef1d2ea7995
+SHA512:
+  metadata.gz: de38e2672296c3d350d225eceae51f4773fa5deaf4b12a9437f2a98ebbda3bd62626b731be296b604977afcef530ac069cc692c5c9c9b84ba8ed5f1f80ce2a04
+  data.tar.gz: db98b96b4fdd279187c2130ecd12dd86c5d405038a71090cef298e173c6753110a076be7f077f1d846e5222f7a7f4669a420366b8409f8b89837211c9465a9f6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,77 @@
+AllCops:
+  Exclude:
+    - '**/schema.rb'
+    - 'bin/**'
+    - 'vendor/**/*'
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/BlockDelimiters:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+# Offense count: 9
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Enabled: false
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# Offense count: 79
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Enabled: false
+
+# Offense count: 10
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Enabled: false
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Enabled: false

data/Dockerfile

@@ -0,0 +1,32 @@
+FROM ruby:2.3.1-slim
+
+ENV RAILS_ENV=production
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US.UTF-8
+ENV LC_ALL en_US.UTF-8
+ENV LC_CTYPE en_US.UTF-8
+
+ENV RUNTIME_PACKAGES pkg-config netcat supervisor nodejs git jq uuid-runtime libxslt1-dev build-essential libxml2-dev libxslt1-dev
+
+RUN mkdir /tmp/tmpapp
+WORKDIR /tmp/tmpapp
+ADD . /tmp/tmpapp
+
+RUN echo 'gem: --no-document' >> ~/.gemrc && \
+    apt-get clean && apt-get update -qq && apt-get install -y build-essential $RUNTIME_PACKAGES && \
+    gem install bundler --version 1.12.5 && \
+    gem install gem-release && \
+    bundle update && bundle install --jobs 20 --retry 5 && \
+    rm -Rf /tmp/tmpapp/ && \
+    rm -rf /usr/share/doc/ /usr/share/man/ /usr/share/locale/ && apt-get clean
+
+RUN mkdir /app
+ADD . /app
+WORKDIR /app
+
+RUN bundle install -j1
+
+RUN chown -R nobody:nogroup /app
+RUN whoami
+USER nobody
+RUN whoami

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blinkist-config.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Blinkist
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sebastian Schleicher
+
+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,103 @@
+# Blinkist::Config
+
+This GEM allows you to access configuration stores with different adapters. Here're some examples of usage:
+
+### Using the ENV
+
+```ruby
+# First setup the Config to use the ENV as config store
+Blinkist::Config.env = ENV["RAILS_ENV"]
+Blinkist::Config.app_name = "my_nice_app"
+Blinkist::Config.adapter_type = :env
+
+my_config_value = Blinkist::Config.get "some/folder/config"
+
+# This is being translated to ENV["SOME_FOLDER_CONFIG"]
+```
+
+### Having a default value
+
+```ruby
+my_config_value = Blinkist::Config.get "some/folder/config", "default value"
+
+# If ENV["SOME_FOLDER_CONFIG"] is nil, "default value" will be returned
+```
+
+### Using Diplomat & Consul
+
+If you want to use Consul's key value store, simply use our diplomat adapter.
+
+* [https://www.consul.io/](https://www.consul.io/)
+* [https://github.com/WeAreFarmGeek/diplomat](https://github.com/WeAreFarmGeek/diplomat)
+
+The GEM expects consul to listen to `http://172.17.0.1:8500`
+
+```ruby
+# First setup the Config to use the ENV as config store
+Blinkist::Config.env = ENV["RAILS_ENV"]
+Blinkist::Config.app_name = "my_nice_app"
+Blinkist::Config.adapter_type = ENV["CONSUL_AVAILABLE"] == "true" ? :diplomat : :env
+
+my_config_value = Blinkist::Config.get "some/folder/config"
+
+# This is will try to get a value from Consul's KV store at "my_nice_app/some/folder/config"
+```
+
+### Using Diplomat with a folder scope
+```ruby
+# Here we setting a scope outside of the app
+
+my_config_value = Blinkist::Config.get "another/config", scope: "global"
+
+# This will replace `my_nice_app` with `global` and try to resolve "global/another/config"
+# With :env the scope will simply be ignored
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "blinkist-config"
+```
+
+## Usage
+
+You have to set up the GEM before you can use it. The basic setup requires this
+
+```ruby
+Blinkist::Config.env = "production" || "test" || "development"
+Blinkist::Config.app_name = "your_app_name" # Used only with diplomat adapter
+Blinkist::Config.adapter_type = :diplomat || :env
+```
+
+It's best to drop a `config.rb` into your app and load this file before every other file. In Rails you can link it into your `application.rb`
+
+```ruby
+require_relative "boot"
+require_relative "config"
+
+require "rails"
+# ...
+```
+
+## Development
+
+You can build this project easily with [docker compose](https://docs.docker.com/compose/).
+
+```
+docker-compose run rake
+```
+
+This will execute rake and run all specs by auto correcting the code with rubocop.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/blinkist-config.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new do |task|
+	task.options = ["-a"]
+  task.patterns = ["lib/**/*.rb", "spec/**/*.rb"]
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task(:default).clear
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "blinkist/config"
+
+# 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

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/blinkist-config.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "lib/blinkist/config/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "blinkist-config"
+  spec.version       = Blinkist::Config::VERSION
+  spec.authors       = ["Sebastian Schleicher, Blinks Labs GmbH"]
+  spec.email         = ["sj@blinkist.com"]
+
+  spec.summary       = %q{Simple adapter based configuration handler (supports ENV and Consul/Diplomat).}
+  spec.description   = %q{This GEM allows you to keep your configuration class-based by calling Blinkist::Config.get(...) instead of accessing the ENV directly. You can set up different types of adapters to connect to various configuration systems like your ENV or Consul's key-value-store.}
+  spec.homepage      = "https://github.com/blinkist/blinkist-config"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", '~> 0'
+
+  spec.add_runtime_dependency "diplomat", "~> 1"
+end

data/docker-compose.yml

@@ -0,0 +1,21 @@
+version: "2"
+services:
+  rake:
+    entrypoint: bundle exec rake
+    build:
+      context: .
+    environment:
+      - RAILS_ENV=test
+      - RACK_ENV=test
+    volumes:
+      - .:/app
+  
+  gem:
+    build:
+      context: .
+    entrypoint: gem
+    volumes:
+      - .:/app
+      - ~/.gitconfig:/nonexistent/.gitconfig
+      - ~/.ssh:/nonexistent/.ssh
+      - ~/.gem:/nonexistent/.gem

data/lib/blinkist/config/adapters/adapter.rb

@@ -0,0 +1,27 @@
+module Blinkist
+  class Config
+    class Adapter
+      def initialize(env, app_name)
+        @env = env
+        @app_name = app_name
+      end
+
+      def get(_key, _default=nil, **)
+        raise NotImplementedError
+      end
+
+      class << self
+        def instance_for(type, env, app_name)
+          case type
+          when :env
+            EnvAdapter.new env, app_name
+          when :diplomat
+            DiplomatAdapter.new env, app_name
+          else
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/blinkist/config/adapters/diplomat_adapter.rb

@@ -0,0 +1,28 @@
+require_relative "adapter"
+require "diplomat"
+
+module Blinkist
+  class Config
+    class DiplomatAdapter < Adapter
+      def initialize(env, app_name)
+        super env, app_name
+
+        @items_cache = {}
+
+        Diplomat.configure do |config|
+          config.url = "http://172.17.0.1:8500"
+        end
+      end
+
+      def get(key, default=nil, scope: nil)
+        scope ||= @app_name
+
+        diplomat_key = "#{scope}/#{key}"
+
+        @items_cache.fetch(diplomat_key, Diplomat::Kv.get(diplomat_key))
+      rescue Diplomat::KeyNotFound
+        default
+      end
+    end
+  end
+end

data/lib/blinkist/config/adapters/env_adapter.rb

@@ -0,0 +1,12 @@
+require_relative "adapter"
+
+module Blinkist
+  class Config
+    class EnvAdapter < Adapter
+      def get(key, default = nil, **)
+        env_key = key.tr("/", "_").upcase
+        ENV[env_key] || default
+      end
+    end
+  end
+end

data/lib/blinkist/config/version.rb

@@ -0,0 +1,5 @@
+module Blinkist
+  class Config
+    VERSION = "1.0.0".freeze
+  end
+end

data/lib/blinkist/config.rb

@@ -0,0 +1,16 @@
+require_relative "config/version"
+require_relative "config/adapters/env_adapter"
+require_relative "config/adapters/diplomat_adapter"
+
+module Blinkist
+  class Config
+    class << self
+      attr_accessor :adapter_type, :logger, :env, :app_name
+
+      def get(key, default = nil, scope: nil)
+        adapter ||= Adapter.instance_for adapter_type, env, app_name
+        adapter.get(key, scope: scope) || default
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: blinkist-config
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sebastian Schleicher, Blinks Labs GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diplomat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: This GEM allows you to keep your configuration class-based by calling
+  Blinkist::Config.get(...) instead of accessing the ENV directly. You can set up
+  different types of adapters to connect to various configuration systems like your
+  ENV or Consul's key-value-store.
+email:
+- sj@blinkist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Dockerfile
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blinkist-config.gemspec
+- docker-compose.yml
+- lib/blinkist/config.rb
+- lib/blinkist/config/adapters/adapter.rb
+- lib/blinkist/config/adapters/diplomat_adapter.rb
+- lib/blinkist/config/adapters/env_adapter.rb
+- lib/blinkist/config/version.rb
+homepage: https://github.com/blinkist/blinkist-config
+licenses:
+- MIT
+metadata: {}
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Simple adapter based configuration handler (supports ENV and Consul/Diplomat).
+test_files: []