consul_application_settings 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17d69e290b5ebc4231d99908108785b70dba8ed6deb822734e4e45afff42f919
-  data.tar.gz: 4075003ed050f4f4562b998848d2c6596ada40dee54da09c5ffad9aaefe11596
+  metadata.gz: 9af6fab64f896c6b73c82ed78561f870968460c4cdb41990cac1032030baf3fa
+  data.tar.gz: 2108b97a57db3a42008960887cf1c1e17962cd7a6f10bd694412d1836536d461
 SHA512:
-  metadata.gz: bc59c2b40d1dbb47a0eb85e001cf2ef9753e6210fb0f0491dd0f246e3825630d13b118f8e635acfe82d9571fbf046f338918a73e40e4738a0d0a439239572179
-  data.tar.gz: ba7b6d50bd9e859b2e65c29597807f91906c1de84361195d6b7a9f38ac635934c057b25cc818a65d46f894a17ef5329bb2fbb1dd08e31300a65bd13f33465168
+  metadata.gz: 7cba0e8a105b7974e18d58e37daec38d830882c74fc3bc4e76e341cababc5497298d142c2a934bf826699b27af6b316aa6675974c35b04725a53716f4829c47b
+  data.tar.gz: fd68775e59908f91f947a4154413203cd98b278ab31807637fc504aff7a8499bbf4e2d94fa0feb1bf2cee8c9a6e70b6b4762c2b10f1283ca3dde7c14b22e1945

data/.codeclimate.yml

@@ -5,6 +5,9 @@ plugins:
 #    enabled: true
   rubocop:
     enabled: true
+    channel: rubocop-0-73
+    config:
+      file: ".rubocop.yml"
   bundler-audit:
     enabled: true
 exclude_patterns:

data/.github/workflows/main.yml

@@ -0,0 +1,79 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5.x', '2.6.x' ]
+    services:
+      redis:
+        image: consul:1.6
+        ports:
+          - '8500:8500'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.OS }}-ruby-${{ matrix.ruby }}
+          restore-keys: ${{ runner.OS }}-
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Set up Bundler
+        run: gem install bundler:2.0.1
+      - name: Set up Dependencies
+        run: bundle install --path vendor/bundle
+
+      - name: Run Tests
+        uses: paambaati/codeclimate-action@v2.3.0
+        env:
+          COVERAGE: true
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: ./bin/rspec
+
+  release:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - name: Set up Bundler
+        run: gem install bundler:2.0.1
+      - name: Set up credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${{secrets.RUBYGEMS_AUTH_TOKEN}}\n" > $HOME/.gem/credentials
+
+      - name: Get version
+        run: echo "${GITHUB_REF/refs\/tags\//}" > release.tag
+      - name: Set version
+        run: sed -i "s/0.0.0/$(<release.tag)/g" */**/version.rb
+
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Push gem
+        run: gem push *.gem

data/CHANGELOG.md

@@ -1,11 +1,19 @@
 ## [Unreleased]
 
+## [0.1.1]
+### New features
+- Allow Operations without Consul
+### Tech debt
+- Replace CI to GitHub Actions
+
 ## [0.1.0]
+### New features
 - Gem init
 - Reading settings from consul
 - Reading settings from defaults
 - Support deep settings search
 - Support nested configs
 
-[Unreleased]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.0...HEAD
+[Unreleased]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.1...HEAD
+[0.1.1]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.0...0.1.1
 [0.1.0]: https://github.com/matic-insurance/consul_application_settings/compare/cb7194f...0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    consul_application_settings (0.1.0)
+    consul_application_settings (0.0.0)
       diplomat (~> 2.1.3)
 
 GEM
@@ -14,11 +14,11 @@ GEM
       deep_merge (~> 1.0, >= 1.0.1)
       faraday (~> 0.9)
     docile (1.3.1)
-    faraday (0.15.4)
+    faraday (0.17.1)
       multipart-post (>= 1.2, < 3)
     jaro_winkler (1.5.2)
     json (2.2.0)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     parallel (1.16.2)
     parser (2.6.2.0)
       ast (~> 2.4.0)

data/README.md

@@ -1,6 +1,6 @@
 # ConsulApplicationSettings
 
-[![Build Status](https://travis-ci.org/matic-insurance/consul_application_settings.svg?branch=master)](https://travis-ci.org/matic-insurance/consul_application_settings)
+![Build Status](https://github.com/matic-insurance/consul_application_settings/workflows/ci/badge.svg?branch=master)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/b0eaebcf83898535ea4e/test_coverage)](https://codeclimate.com/github/matic-insurance/consul_application_settings/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/b0eaebcf83898535ea4e/maintainability)](https://codeclimate.com/github/matic-insurance/consul_application_settings/maintainability)
 
@@ -37,7 +37,7 @@ gem 'consul_application_settings'
 
 ### Initialization
 
-At the load of application 
+At the load of application: 
 ```ruby
 ConsulApplicationSettings.configure do |config|
   # Specify path to defaults file
@@ -57,23 +57,25 @@ APP_SETTINGS = ConsulApplicationSettings.load
 
 Assuming your defaults file in repository `config/settings.yml` looks like:
 ```yaml
-app_name: 'MyCoolApp'
-hostname: 'http://localhost:3001'
-
-integrations:
-  database:
-    domain: localhost
-    user: app
-    password: password1234
-  slack:
-    enabled: false
-    webhook_url: 'https://hooks.slack.com/services/XXXXXX/XXXXX/XXXXXXX'
+staging:
+  my_cool_app:
+    app_name: 'MyCoolApp'
+    hostname: 'http://localhost:3001'
+    
+    integrations:
+      database:
+        domain: localhost
+        user: app
+        password: password1234
+      slack:
+        enabled: false
+        webhook_url: 'https://hooks.slack.com/services/XXXXXX/XXXXX/XXXXXXX'
 ```
 
 And consul has following settings
 ```json
 {
-  "production": {
+  "staging": {
     "my_cool_app": {
      "hostname": "https://mycoolapp.com",
      "integrations": {
@@ -123,6 +125,26 @@ slack_settings.enabled              # true
 slack_settings.get('webhook_url')   # "https://hooks.slack.com/services/XXXXXX/XXXXX/XXXXXXX"
 ``` 
 
+### Gem Configuration
+You can configure gem with block:
+```ruby
+ConsulApplicationSettings.configure do |config|
+  config.namespace = 'staging/my_cool_app'
+end
+```
+or one option at a time
+```ruby
+ConsulApplicationSettings.config.namespace = 'staging/my_cool_app'
+```
+
+All Gem configurations
+
+| Configuration                    | Required | Default | Type    | Description                                                                  |
+|----------------------------------|----------|---------|---------|------------------------------------------------------------------------------|
+| defaults                         | yes      |         | String  | Path to the file with default settings                                       |
+| namespace                        | no       |         | String  | Base path to read settings from in consul and defaults                       |
+| disable_consul_connection_errors | no       | false   | Boolean | Do not raise exception when consul is not available (useful for development) |
+
 ## Development
 
 1. [Install Consul](https://www.consul.io/docs/install/index.html)

data/bin/rspec

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/consul_application_settings/configuration.rb

@@ -5,6 +5,7 @@ module ConsulApplicationSettings
     attr_accessor :defaults_path
     # Optional attributes
     attr_accessor :namespace
+    attr_accessor :disable_consul_connection_errors
 
     def initialize
       self.namespace = ''

data/lib/consul_application_settings/defaults.rb

@@ -36,6 +36,7 @@ module ConsulApplicationSettings
     def read_value(hash, key)
       raise ConsulApplicationSettings::Error, 'reading arrays not implemented' if hash.is_a? Array
       return {} if hash.nil?
+
       hash.fetch(key.to_s)
     end
   end

data/lib/consul_application_settings/options.rb

@@ -16,7 +16,7 @@ module ConsulApplicationSettings
     end
 
     def get(name)
-      consul_value = Diplomat::Kv.get(key_path(name), {}, :return)
+      consul_value = key_value(name)
       if consul_value.nil? || consul_value.empty?
         defaults.get(name)
       else
@@ -40,6 +40,12 @@ module ConsulApplicationSettings
 
     private
 
+    def key_value(name)
+      Diplomat::Kv.get(key_path(name), {}, :return)
+    rescue Faraday::ConnectionFailed => e
+      raise e unless ConsulApplicationSettings.config.disable_consul_connection_errors
+    end
+
     def key_path(name)
       ConsulApplicationSettings::Utils.generate_path(path, name)
     end

data/lib/consul_application_settings/utils.rb

@@ -28,7 +28,7 @@ module ConsulApplicationSettings
       def cast_complex_value(value)
         PARSING_CLASSES.each do |parser|
           return parser.call(value)
-        rescue StandardError => _
+        rescue StandardError => _e
           nil
         end
         value.to_s

data/lib/consul_application_settings/version.rb

@@ -1,3 +1,3 @@
 module ConsulApplicationSettings
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul_application_settings
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Volodymyr Mykhailyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diplomat
@@ -118,11 +118,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -131,6 +131,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
 - bin/setup
 - consul_application_settings.gemspec
 - lib/consul_application_settings.rb

data/.travis.yml

@@ -1,48 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.5.1
-
-env:
-  - CONSUL_VERSION=1.4.4
-
-before_install:
-  # Install bundler 2.x
-  - gem update --system
-  - gem install bundler
-  # Install Code Climate
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-  # Install consul
-  - curl -sLo consul.zip https://releases.hashicorp.com/consul/${CONSUL_VERSION}/consul_${CONSUL_VERSION}_linux_amd64.zip
-  - unzip "consul.zip"
-  - ./consul --version
-
-install:
-  - bin/setup
-
-before_script:
-  # Run consul
-  - ./consul agent -dev -node travis &
-
-script:
-  - COVERAGE=true bundle exec rspec
-  - gem build consul_application_settings
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-deploy:
-  provider: rubygems
-  api_key: "$RUBY_GEMS_API_KEY"
-  on:
-    tags: true
-
-branches:
-  only:
-    - master
-    - /^\d+\.\d+\.\d+$/