chamber 2.12.3 → 2.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 553e93e239b69f83d7fe5fb0cda5153fcc0f8ce7
-  data.tar.gz: 3d9007fe77914b4e7d88a1665cce0fb4291a9c32
+SHA256:
+  metadata.gz: 690d43a7af0262a4fe1ca2f3ab99e66ed6db6a4873a5bdbd50e9bd655a44ffe8
+  data.tar.gz: 57ec92f68941f7a281d5ca3b056bdfd64833cd69567de2c07418180f09729d15
 SHA512:
-  metadata.gz: ea0d5e559bf833679d176bc5a3930c1a49f1e3d2e14233ec6e7f33ae2fed039be9a725138824c7e03930bfbc2360f6ccb66bc4c51f61c3b8fa03a7d4de4e2723
-  data.tar.gz: 6d9d274ddb7871100155501bc811bac435109fb2cd918aa7962f52e55c7270c206cad097dd61c4c4ee80ae73181f7e22177c2e11878896db9a8f9d87d544c97b
+  metadata.gz: d38158c0fa8d6bc2c87b6ee4de139c9a13e8118159f2048846d23945c89156597c7106602bd29cb575dce8f15e5a3ee4a279e63f629e23fb25d2dc70feb693f8
+  data.tar.gz: 6e5ea4037cd71876681dae104acdd4081129be0dce0373cd6a78e5ed67810156e6545bd29e5124c3fcb92e459ea58a68a356f2acba8ed8232808a07c0752445f

data/README.md

@@ -1,5 +1,33 @@
-# Chamber
-[![Gem Version](https://img.shields.io/gem/v/chamber.svg)](https://rubygems.org/gems/chamber) ![Rubygems Rank Overall](https://img.shields.io/gem/rt/chamber.svg) ![Rubygems Rank Daily](https://img.shields.io/gem/rd/chamber.svg) ![Rubygems Downloads](https://img.shields.io/gem/dv/chamber/stable.svg) [![Build Status](https://img.shields.io/travis/thekompanee/chamber/master.svg)](http://travis-ci.org/thekompanee/chamber) [![Code Climate](https://codeclimate.com/github/thekompanee/chamber.svg)](https://codeclimate.com/github/thekompanee/chamber) [![Code Climate](https://codeclimate.com/github/thekompanee/chamber/coverage.svg)](https://codeclimate.com/github/thekompanee/chamber)
+Chamber
+================================================================================
+
+<div align="center">
+  <a href="https://rubygems.org/gems/chamber" alt="RubyGems Version">
+    <img src="https://img.shields.io/gem/v/chamber.svg?style=flat-square&label=current-version" alt="RubyGems Version" />
+  </a>
+
+  <a href="https://rubygems.org/gems/chamber" alt="RubyGems Rank Overall">
+    <img src="https://img.shields.io/gem/rt/chamber.svg?style=flat-square&label=total-rank" alt="RubyGems Rank Overall" />
+  </a>
+
+  <a href="https://rubygems.org/gems/chamber" alt="RubyGems Rank Daily">
+    <img src="https://img.shields.io/gem/rd/chamber.svg?style=flat-square&label=daily-rank" alt="RubyGems Rank Daily" />
+  </a>
+
+  <a href="https://rubygems.org/gems/chamber" alt="RubyGems Downloads">
+    <img src="https://img.shields.io/gem/dt/chamber.svg?style=flat-square&label=total-downloads" alt="RubyGems Downloads" />
+  </a>
+
+  <a href="https://github.com/thekompanee/chamber/actions?query=workflow%3ABuild" alt="Build Status">
+    <img src="https://img.shields.io/github/workflow/status/thekompanee/chamber/Build?label=CI&style=flat-square&logo=github" alt="Build Status" />
+  </a>
+
+  <a href="#" alt="Maintainability">
+    <img src="https://img.shields.io/codeclimate/maintainability/thekompanee/chamber?style=flat-square&label=grade" alt="Maintainability" />
+  </a>
+</div>
+
+<br>
 
 Chamber is the auto-encrypting, extremely organizable, Heroku-loving,
 CLI-having, non-extra-repo-needing, non-Rails-specific-ing, CI-serving
@@ -9,17 +37,73 @@ We looked at all of the options out there and thought something was still
 missing, so we wrote Chamber.  We made it with lots of ❤ and we hope you like it
 as much as we do.
 
-## What Sets Chamber Apart?
+What Sets Chamber Apart
+--------------------------------------------------------------------------------
 
 For an idea of how Chamber compares to other popular libraries, check out our
 [Gem Comparison][comparison].
 
-## Basic Usage
+Basic Usage
+--------------------------------------------------------------------------------
+
+Before starting this guide, make sure you [install chamber][installation].
+
+Once your app is initialized, you should have a `settings.yml` file somewhere.
+A lot of times it's the root of your project and sometimes it's in a framework
+specific location.
+
+Inside of here you can define any settings you'd like like so:
+
+```yaml
+# settings.yml
+
+smtp_username: 'my_username'
+smtp_password: 'my_password'
+```
+
+From there you can access your settings by using the special `Chamber.env`
+constant.
+
+```ruby
+Chamber.env.smtp_password
+# => 'my_password'
+```
+
+If you want to encrypt a setting, prefix the setting name with `_secure_` like
+so:
+
+```ruby
+# settings.yml
+
+smtp_username:         'my_username'
+_secure_smtp_password: 'my_password'
+```
+
+And then run `chamber secure`.  Your settings file will have an encrypted value:
+
+```ruby
+# settings.yml
+
+smtp_username:         'my_username'
+_secure_smtp_password: JL5hAVux4tERpv49QPWxy9H0VC2Rnk7V8/e8+1XOwPcXcoH/a7Lh253UY/v9m8nI/Onb+ZG9nZ082J4M/BmLa+f7jwMEwufIqbUhUah9eKIW8xcxlppBYpl7JVGf2HJF5TfCN44gMQNgGNzboCQXKqRyeGFm4u772Sg9V2gEx/q7qJ6F4jg7v/cltCFLmJfXA2SHA5Dai4p9L4IvMVVJGm34k5j7KOegNqpVWs2RY99cagjPuzc9VM2XSUsXgqcUJdmH8YtPW8Kqkyg0oYlRh6VQWABlWXwTZz74QjTTjqtqfoELIoFTMBDh+cCvuUTAE5m06LhlqauVrB4UnBsd5g==
+```
+
+which you still access the same way because Chamber handles the decryption for
+you:
+
+```ruby
+Chamber.env.smtp_password
+# => 'my_password'
+```
+
+Full Reference
+--------------------------------------------------------------------------------
 
-You can view our Basic Usage Guide [here][basic-usage].  Otherwise, for the full
+There's so much to Chamber, we couldn't put it all in the README.  For the full
 Chamber guide, visit the [wiki][wiki].
 
-## Credits
+Credits
+--------------------------------------------------------------------------------
 
 Chamber was written by [Jeff Felchner][jeff-profile] and
 [Mark McEahern][mark-profile]
@@ -30,27 +114,18 @@ Chamber is maintained and funded by [The Kompanee, Ltd.][kompanee-site]
 
 The names and logos for The Kompanee are trademarks of The Kompanee, Ltd.
 
-## License
+License
+--------------------------------------------------------------------------------
 
-Chamber is Copyright © 2014-2018 Jeff Felchner and Mark McEahern. It is free
+Chamber is Copyright © 2014-2021 Jeff Felchner and Mark McEahern. It is free
 software, and may be redistributed under the terms specified in the
 [LICENSE][license] file.
 
-[accessing]:      https://github.com/thekompanee/chamber/wiki/Accessing-Settings
-[basic-usage]:    https://github.com/thekompanee/chamber/wiki/Basic-Usage
-[cli]:            https://github.com/thekompanee/chamber/wiki/CLI-Overview
-[commit-hook]:    https://github.com/thekompanee/chamber/wiki/Git-Commit-Hooks
-[comparison]:     https://github.com/thekompanee/chamber/wiki/Gem-Comparison
-[encryption]:     https://github.com/thekompanee/chamber/wiki/Encryption-Basics
-[env-vars]:       https://github.com/thekompanee/chamber/wiki/Environment-Variables
-[heroku]:         https://github.com/thekompanee/chamber/wiki/Heroku
-[inch]:           https://inch-ci.org/github/thekompanee/chamber
-[jeff-profile]:   https://github.com/jfelchner
-[kompanee-logo]:  https://kompanee-public-assets.s3.amazonaws.com/readmes/kompanee-horizontal-black.png
-[kompanee-site]:  http://www.thekompanee.com
-[license]:        https://github.com/thekompanee/chamber/blob/master/LICENSE.txt
-[mark-profile]:   https://github.com/m5rk
-[namespace-keys]: https://github.com/thekompanee/chamber/wiki/Namespaced-Key-Pairs
-[plain-ruby]:     https://github.com/thekompanee/chamber/wiki/Installation#in-a-ruby-project-or-ruby-gem
-[travis]:         https://github.com/thekompanee/chamber/wiki/TravisCI
-[wiki]:           https://github.com/thekompanee/chamber/wiki
+[comparison]:    https://github.com/thekompanee/chamber/wiki/Gem-Comparison
+[jeff-profile]:  https://github.com/jfelchner
+[kompanee-logo]: https://kompanee-public-assets.s3.amazonaws.com/readmes/kompanee-horizontal-black.png
+[kompanee-site]: http://www.thekompanee.com
+[license]:       https://github.com/thekompanee/chamber/blob/master/LICENSE.txt
+[mark-profile]:  https://github.com/m5rk
+[wiki]:          https://github.com/thekompanee/chamber/wiki
+[installation]:  https://github.com/thekompanee/chamber/wiki/Installation

data/lib/chamber.rb

@@ -7,12 +7,8 @@ require 'chamber/rails'
 module  Chamber
   attr_writer :instance
 
-  def load(options = {})
-    self.instance = Instance.new(options)
-  end
-
-  def to_s(options = {})
-    instance.to_s(options)
+  def load(**args)
+    self.instance = Instance.new(**args)
   end
 
   def env
@@ -20,7 +16,69 @@ module  Chamber
   end
 
   def instance
-    @instance ||= Instance.new({})
+    @instance ||= Instance.new
+  end
+
+  def [](key)
+    instance.[](key)
+  end
+
+  def dig!(*args)
+    instance.dig!(*args)
+  end
+
+  def dig(*args)
+    instance.dig(*args)
+  end
+
+  def configuration
+    instance.configuration
+  end
+
+  def decrypt(value, **args)
+    instance.decrypt(value, **args)
+  end
+
+  def encrypt(value, **args)
+    instance.encrypt(value, **args)
+  end
+
+  def files
+    instance.files
+  end
+
+  def filenames
+    instance.filenames
+  end
+
+  def namespaces
+    instance.namespaces
+  end
+
+  def secure
+    instance.secure
+  end
+
+  def sign
+    instance.sign
+  end
+
+  def verify
+    instance.verify
+  end
+
+  def to_environment
+    instance.to_environment
+  end
+
+  def to_hash
+    instance.to_hash
+  end
+
+  def to_s(**args)
+    return '' unless @instance
+
+    instance.to_s(**args)
   end
 
   def method_missing(name, *args)
@@ -33,11 +91,25 @@ module  Chamber
     instance.respond_to?(name, include_private)
   end
 
-  module_function :load,
-                  :to_s,
+  module_function :[],
+                  :configuration,
+                  :decrypt,
+                  :dig!,
+                  :dig,
+                  :encrypt,
                   :env,
+                  :filenames,
+                  :files,
                   :instance,
                   :instance=,
+                  :load,
                   :method_missing,
-                  :respond_to_missing?
+                  :namespaces,
+                  :respond_to_missing?,
+                  :secure,
+                  :sign,
+                  :to_environment,
+                  :to_hash,
+                  :to_s,
+                  :verify
 end

data/lib/chamber/adapters/cloud/circle_ci.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module  Chamber
+module  Adapters
+module  Cloud
+class   CircleCi
+  API_HOST     = 'circleci.com'
+  API_PORT     = 443
+  API_BASE_URI = '/api/v1.1'
+
+  attr_accessor :api_token,
+                :project,
+                :username,
+                :vcs_type
+
+  def initialize(api_token:, project:, username:, vcs_type:)
+    self.api_token = api_token
+    self.project   = project
+    self.username  = username
+    self.vcs_type  = vcs_type
+  end
+
+  def add_environment_variable(name, value)
+    value   = value.gsub(/\n/, '\n')
+    request = ::Net::HTTP::Post.new(request_uri(resource: 'envvar'))
+
+    request.basic_auth api_token, ''
+    request['Content-Type'] = 'application/json'
+    request.body            = ::JSON.dump(name: name, value: value)
+
+    response = ::JSON.parse(response(request).body)
+
+    fail NameError, response['message'] if response['message']
+
+    response['name']
+  end
+
+  # rubocop:disable Layout/MultilineAssignmentLayout
+  def environment_variables
+    @environment_variables ||= \
+      begin
+        request = ::Net::HTTP::Get.new(request_uri(resource: 'envvar'))
+
+        request.basic_auth api_token, ''
+        request['Content-Type'] = 'application/json'
+
+        ::JSON
+          .parse(response(request).body)
+          .each_with_object({}) { |e, m| m[e['name']] = e['value'] }
+      end
+  end
+  # rubocop:enable Layout/MultilineAssignmentLayout
+
+  def remove_environment_variable(name)
+    request = ::Net::HTTP::Delete.new(request_uri(resource: "envvar/#{name}"))
+
+    request.basic_auth api_token, ''
+    request['Content-Type'] = 'application/json'
+
+    ::JSON.parse(response(request).body)['message'] == 'ok'
+  end
+
+  private
+
+  def request_uri(resource:)
+    "#{API_BASE_URI}/project/#{vcs_type}/#{username}/#{project}/#{resource}"
+  end
+
+  def response(request)
+    connection.request(request)
+  end
+
+  def connection
+    @connection ||= ::Net::HTTP.new(API_HOST, API_PORT).tap do |conn|
+      conn.use_ssl = true
+    end
+  end
+end
+end
+end
+end

data/lib/chamber/adapters/cloud/heroku.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module  Chamber
+module  Adapters
+module  Cloud
+class   Heroku
+  API_HOST     = 'api.heroku.com'
+  API_PORT     = 443
+  API_BASE_URI = ''
+
+  attr_accessor :api_token,
+                :app
+
+  def initialize(api_token:, app:)
+    self.api_token = api_token
+    self.app       = app
+  end
+
+  def add_environment_variable(name, value) # rubocop:disable Metrics/AbcSize
+    value   = value.gsub(/\n/, '\n') if value
+    request = ::Net::HTTP::Patch.new(config_vars_uri)
+
+    request['Authorization'] = "Bearer #{api_token}"
+    request['Accept']        = 'application/vnd.heroku+json; version=3'
+    request['Content-Type']  = 'application/json'
+    request.body             = ::JSON.dump(Hash[name, value])
+
+    response = ::JSON.parse(response(request).body)
+
+    fail NameError, response['message'] if response['message']
+
+    response
+  end
+
+  def environment_variables
+    request = ::Net::HTTP::Get.new(config_vars_uri)
+
+    request['Authorization'] = "Bearer #{api_token}"
+    request['Accept']        = 'application/vnd.heroku+json; version=3'
+
+    response = ::JSON.parse(response(request).body)
+
+    fail NameError, response['message'] if response['message']
+
+    response
+  end
+
+  def remove_environment_variable(name)
+    add_environment_variable(name, nil)
+  end
+
+  private
+
+  def config_vars_uri
+    "#{API_BASE_URI}/apps/#{app}/config-vars"
+  end
+
+  def response(request)
+    connection.request(request)
+  end
+
+  def connection
+    @connection ||= ::Net::HTTP.new(API_HOST, API_PORT).tap do |conn|
+      conn.use_ssl = true
+    end
+  end
+end
+end
+end
+end

data/lib/chamber/binary/circle_ci.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'chamber/core_ext/hash'
+require 'chamber/commands/cloud/clear'
+require 'chamber/commands/cloud/push'
+require 'chamber/commands/cloud/pull'
+require 'chamber/commands/cloud/compare'
+
+module  Chamber
+module  Binary
+class   CircleCi < Thor
+  include Thor::Actions
+
+  class_option :api_token,
+               type:     :string,
+               aliases:  '-t',
+               required: true,
+               desc:     'The API token to access your CircleCI project.'
+
+  class_option :project,
+               type:     :string,
+               aliases:  '-p',
+               required: true,
+               desc:     'The project name in your VCS (eg Github).'
+
+  class_option :username,
+               type:     :string,
+               aliases:  '-u',
+               required: true,
+               desc:     'The user/organization name in your VCS (eg Github).'
+
+  class_option :vcs_type,
+               type:    :string,
+               aliases: '-v',
+               default: 'github',
+               desc:    'The type of VCS your project is using.',
+               enum:    %w{github bitbucket}
+
+  desc 'clear',
+       'Removes all CircleCi environment variables which match settings that Chamber ' \
+       'knows about'
+
+  method_option :dry_run,
+                type:    :boolean,
+                aliases: '-d',
+                desc:    'Does not actually remove anything, but instead displays what ' \
+                         'would change if cleared'
+
+  def clear
+    Commands::Cloud::Clear.call(**options
+                                    .transform_keys(&:to_sym)
+                                    .merge(shell: self, adapter: 'circle_ci'))
+  end
+
+  desc 'push',
+       'Sends settings to CircleCi so that they may be used in the application ' \
+       'once it is deployed'
+
+  method_option :dry_run,
+                type:    :boolean,
+                aliases: '-d',
+                desc:    'Does not actually push anything to CircleCi, but instead ' \
+                         'displays what would change if pushed'
+
+  method_option :keys,
+                type:    :boolean,
+                aliases: '-k',
+                desc:    'Pushes private Chamber keys to CircleCi as environment ' \
+                         'variables. Chamber will automatically detect it and ' \
+                         'transparently decrypt your secure settings without any ' \
+                         'further synchronization.'
+
+  method_option :only_sensitive,
+                type:    :boolean,
+                aliases: '-o',
+                default: true,
+                desc:    'When enabled, only settings contained in files which have ' \
+                         'been gitignored or settings which are marked as "_secure" ' \
+                         'will be pushed'
+
+  def push
+    Commands::Cloud::Push.call(**options
+                                   .transform_keys(&:to_sym)
+                                   .merge(shell: self, adapter: 'circle_ci'))
+  end
+
+  desc 'pull',
+       'Retrieves the environment variables for the application and stores them in a ' \
+       'temporary file'
+
+  method_option :into,
+                type: :string,
+                desc: 'The file into which the CircleCi config information should be ' \
+                      'stored. This file WILL BE OVERRIDDEN.'
+
+  def pull
+    Commands::Cloud::Pull.call(**options
+                                   .transform_keys(&:to_sym)
+                                   .merge(shell: self, adapter: 'circle_ci'))
+  end
+
+  desc 'compare',
+       'Displays the difference between what is currently stored in the ' \
+       'CircleCi application\'s config and what Chamber knows about locally'
+
+  method_option :only_sensitive,
+                type:    :boolean,
+                aliases: '-o',
+                default: true,
+                desc:    'When enabled, the diff will only consider settings ' \
+                         'contained in files which have been gitignored or settings ' \
+                         'which are marked as "_secure"'
+
+  def compare
+    Commands::Cloud::Compare.call(**options
+                                      .transform_keys(&:to_sym)
+                                      .merge(shell: self, adapter: 'circle_ci'))
+  end
+end
+end
+end