chamber 1.0.3 → 2.0.0

data/lib/chamber/binary/runner.rb

@@ -0,0 +1,94 @@
+require 'thor'
+require 'chamber/binary/travis'
+require 'chamber/binary/heroku'
+require 'chamber/commands/show'
+require 'chamber/commands/files'
+require 'chamber/commands/secure'
+require 'chamber/commands/compare'
+require 'chamber/commands/initialize'
+
+module  Chamber
+module  Binary
+class   Runner < Thor
+  include Thor::Actions
+
+  class_option  :rootpath,
+                type:     :string,
+                aliases:  '-r',
+                default:  ENV['PWD'],
+                desc:     'The root filepath of the application'
+  class_option  :basepath,
+                type:     :string,
+                aliases:  '-b',
+                desc:     'The base filepath where Chamber will look for the conventional settings files'
+  class_option  :files,
+                type:     :array,
+                aliases:  '-f',
+                desc:     'The set of file globs that Chamber will use for processing'
+  class_option  :namespaces,
+                type:     :array,
+                aliases:  '-n',
+                default:  [],
+                desc:     'The set of namespaces that Chamber will use for processing'
+  class_option  :preset,
+                type:     :string,
+                aliases:  '-p',
+                enum:     ['rails'],
+                desc:     'Used to quickly assign a given scenario to the chamber command (eg Rails apps)'
+  class_option  :decryption_key,
+                type:     :string,
+                desc:     'The path to or contents of the private key associated with the project (typically .chamber.pem)'
+  class_option  :encryption_key,
+                type:     :string,
+                desc:     'The path to or contents of the public key associated with the project (typically .chamber.pub.pem)'
+  class_option  :shell,
+                default:  self.new,
+                desc:     'The command runner.  Can be overridden for specific logging capabilities.'
+
+  desc 'travis SUBCOMMAND ...ARGS',   'For manipulating Travis CI environment variables'
+  subcommand 'travis',    Chamber::Binary::Travis
+
+  desc 'heroku SUBCOMMAND ...ARGS',   'For manipulating Heroku environment variables'
+  subcommand 'heroku',    Chamber::Binary::Heroku
+
+  desc 'show', 'Displays the list of settings and their values'
+  method_option :as_env,
+                type:     :boolean,
+                aliases:  '-e',
+                desc:     'Whether the displayed settings should be environment variable compatible'
+  def show
+    puts Commands::Show.call(options)
+  end
+
+  desc 'files', 'Lists the settings files which are parsed with the given options'
+  def files
+    puts Commands::Files.call(options)
+  end
+
+  desc 'compare', 'Displays the difference between what is currently stored in the Heroku application\'s config and what Chamber knows about locally'
+  method_option :keys_only,
+                type:     :boolean,
+                default:  true,
+                desc:     'Whether or not to only compare the keys but not the values of the two sets of settings'
+  method_option :first,
+                type:     :array,
+                desc:     'The list of namespaces which will be used as the source of the comparison'
+  method_option :second,
+                type:     :array,
+                desc:     'The list of namespaces which will be used as the destination of the comparison'
+  def compare
+    Commands::Compare.call(options)
+  end
+
+  desc 'secure', 'Secures any values which appear to need to be encrypted in any of the settings files which match irrespective of namespaces'
+  def secure
+    Commands::Secure.call(options)
+  end
+
+  desc 'init', 'Sets Chamber up matching best practices for secure configuration management'
+  def init
+    Commands::Initialize.call(options)
+  end
+end
+end
+end

data/lib/chamber/binary/travis.rb

@@ -0,0 +1,23 @@
+require 'thor'
+require 'chamber/commands/travis/secure'
+
+module  Chamber
+module  Binary
+class   Travis < Thor
+
+  desc 'secure', 'Uses your Travis CI public key to encrypt the settings you have chosen not to commit to the repo'
+  method_option :dry_run,
+                type:     :boolean,
+                aliases:  '-d',
+                desc:     'Does not actually encrypt anything to .travis.yml, but instead displays what values would be encrypted'
+  method_option :only_sensitive,
+                type:     :boolean,
+                aliases:  '-o',
+                default:  true,
+                desc:     'Does not encrypt settings into .travis.yml unless they are  contained in files which have been gitignored or settings which are marked as "_secure"'
+  def secure
+    Commands::Travis::Secure.call(options)
+  end
+end
+end
+end

data/lib/chamber/commands/base.rb

@@ -0,0 +1,33 @@
+require 'chamber/commands/context_resolver'
+require 'chamber/instance'
+
+module  Chamber
+module  Commands
+class   Base
+
+  def initialize(options = {})
+    options       = ContextResolver.resolve(options)
+
+    self.chamber  = Chamber::Instance.new options
+    self.shell    = options[:shell]
+    self.rootpath = options[:rootpath]
+    self.dry_run  = options[:dry_run]
+  end
+
+  def self.call(options = {})
+    self.new(options).call
+  end
+
+  protected
+
+  attr_accessor :chamber,
+                :shell,
+                :dry_run
+  attr_reader   :rootpath
+
+  def rootpath=(other)
+    @rootpath ||= Pathname.new(other)
+  end
+end
+end
+end

data/lib/chamber/commands/comparable.rb

@@ -0,0 +1,37 @@
+require 'tempfile'
+
+module  Chamber
+module  Commands
+module  Comparable
+
+  def initialize(options = {})
+    super
+
+    self.keys_only = options[:keys_only]
+  end
+
+  def call
+    system("git diff --no-index #{first_settings_file} #{second_settings_file}")
+  end
+
+  protected
+
+  attr_accessor :keys_only
+
+  def first_settings_file
+    create_comparable_settings_file 'first',  first_settings_data
+  end
+
+  def second_settings_file
+    create_comparable_settings_file 'second', second_settings_data
+  end
+
+  def create_comparable_settings_file(name, config)
+    Tempfile.open(name) do |file|
+      file.write config
+      file.to_path
+    end
+  end
+end
+end
+end

data/lib/chamber/commands/compare.rb

@@ -0,0 +1,46 @@
+require 'chamber/instance'
+require 'chamber/commands/base'
+require 'chamber/commands/comparable'
+
+module  Chamber
+module  Commands
+class   Compare < Chamber::Commands::Base
+  include Chamber::Commands::Comparable
+
+  def initialize(options = {})
+    super
+
+    first_settings_options        = options.merge(namespaces: options[:first])
+    self.first_settings_instance  = Chamber::Instance.new(first_settings_options)
+
+    second_settings_options       = options.merge(namespaces: options[:second])
+    self.second_settings_instance = Chamber::Instance.new(second_settings_options)
+  end
+
+  def self.call(options = {})
+    self.new(options).call
+  end
+
+  protected
+
+  attr_accessor :first_settings_instance,
+                :second_settings_instance
+
+  def first_settings_data
+    settings_data(first_settings_instance)
+  end
+
+  def second_settings_data
+    settings_data(second_settings_instance)
+  end
+
+  def settings_data(instance)
+    if keys_only
+      instance.to_environment.keys.join("\n")
+    else
+      instance.to_s(pair_separator: "\n")
+    end
+  end
+end
+end
+end

data/lib/chamber/commands/context_resolver.rb

@@ -0,0 +1,72 @@
+module  Chamber
+module  Commands
+class   ContextResolver
+
+  def initialize(options = {})
+    self.options = options.dup
+  end
+
+  def resolve
+    options[:rootpath]       ||= Pathname.pwd
+    options[:rootpath]         = Pathname.new(options[:rootpath])
+    options[:encryption_key]   = resolve_encryption_key(options[:encryption_key])
+    options[:decryption_key]   = resolve_decryption_key(options[:decryption_key])
+    options[:namespaces]     ||= []
+    options[:preset]         ||= resolve_preset
+
+    if options[:preset] == 'rails'
+      options[:basepath]     ||= options[:rootpath] + 'config'
+
+      if options[:namespaces] == []
+        require options[:rootpath].join('config', 'application')
+
+        options[:namespaces]   = [::Rails.env]
+      end
+    else
+      options[:basepath]     ||= options[:rootpath]
+    end
+
+    options
+  rescue LoadError
+    options
+  end
+
+  def self.resolve(options = {})
+    self.new(options).resolve
+  end
+
+  protected
+
+  attr_accessor :options
+
+  def resolve_preset
+    if in_a_rails_project?
+      'rails'
+    end
+  end
+
+  def resolve_encryption_key(key)
+    key ||= options[:rootpath] + '.chamber.pub.pem'
+
+    key if Pathname.new(key).readable?
+  end
+
+  def resolve_decryption_key(key)
+    key ||= options[:rootpath] + '.chamber.pem'
+
+    key if Pathname.new(key).readable?
+  end
+
+  def in_a_rails_project?
+    (options[:rootpath] + 'config.ru').exist? &&
+    rails_executable_exists?
+  end
+
+  def rails_executable_exists?
+    options[:rootpath].join('bin',    'rails').exist? ||
+    options[:rootpath].join('script', 'rails').exist? ||
+    options[:rootpath].join('script', 'console').exist?
+  end
+end
+end
+end

data/lib/chamber/commands/files.rb

@@ -0,0 +1,12 @@
+require 'chamber/commands/base'
+
+module  Chamber
+module  Commands
+class   Files < Chamber::Commands::Base
+
+  def call
+    chamber.filenames
+  end
+end
+end
+end

data/lib/chamber/commands/heroku.rb

@@ -0,0 +1,30 @@
+require 'bundler'
+
+module  Chamber
+module  Commands
+module  Heroku
+
+  def initialize(options = {})
+    super
+
+    self.app = options[:app]
+  end
+
+  protected
+
+  attr_accessor :app
+
+  def configuration
+    @configuration ||= heroku("config --shell").chomp
+  end
+
+  def heroku(command)
+    Bundler.with_clean_env { `heroku #{command}#{app_option}` }
+  end
+
+  def app_option
+    app ? " --app #{app}" : ""
+  end
+end
+end
+end

data/lib/chamber/commands/heroku/clear.rb

@@ -0,0 +1,25 @@
+require 'chamber/commands/base'
+require 'chamber/commands/heroku'
+
+module  Chamber
+module  Commands
+module  Heroku
+class   Clear < Chamber::Commands::Base
+  include Chamber::Commands::Heroku
+
+  def call
+    chamber.to_environment.keys.each do |key|
+      next unless configuration.match(key)
+
+      if dry_run
+        shell.say_status 'remove', key, :blue
+      else
+        shell.say_status 'remove', key, :green
+        shell.say heroku("config:unset #{key}")
+      end
+    end
+  end
+end
+end
+end
+end

data/lib/chamber/commands/heroku/compare.rb

@@ -0,0 +1,31 @@
+require 'chamber/commands/securable'
+require 'chamber/commands/heroku'
+require 'chamber/commands/comparable'
+
+module  Chamber
+module  Commands
+module  Heroku
+class   Compare < Chamber::Commands::Base
+  include Chamber::Commands::Securable
+  include Chamber::Commands::Heroku
+  include Chamber::Commands::Comparable
+
+  protected
+
+  def first_settings_data
+    if only_sensitive
+      secured_settings.to_s(pair_separator:   "\n",
+                            value_surrounder: '')
+    else
+      all_settings.to_s(pair_separator:   "\n",
+                        value_surrounder: '')
+    end
+  end
+
+  def second_settings_data
+    configuration
+  end
+end
+end
+end
+end

data/lib/chamber/commands/heroku/pull.rb

@@ -0,0 +1,30 @@
+require 'chamber/commands/base'
+require 'chamber/commands/heroku'
+
+module  Chamber
+module  Commands
+module  Heroku
+class   Pull < Chamber::Commands::Base
+  include Chamber::Commands::Heroku
+
+  def initialize(options = {})
+    super
+
+    self.target_file = options[:into]
+  end
+
+  def call
+    if target_file
+      shell.create_file target_file, configuration
+    else
+      configuration
+    end
+  end
+
+  protected
+
+  attr_accessor :target_file
+end
+end
+end
+end