confswap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dd67f5b084096165578ad492543a3573786f49a
+  data.tar.gz: 82b6e68ce88949d2cfe60234fd1faf10f0e3c4c4
+SHA512:
+  metadata.gz: c47dbc00b593461e9081146e2de2e38fbaa993e1d401e4a6401b75540fd767f5a1c153d95eb2c49706d285f418149059c82f191999e860c4d8d1fbee90b2bec2
+  data.tar.gz: 4523d361fe485aadc40013d38eaf61f665f6582305852552f1d9a773737b88c91f8fdc15d3596675e6352f4b6860fbe60dd55b4f482887ad666be7f4bf1105ba

data/.gitignore

@@ -0,0 +1,44 @@
+## Ignore bundle lock
+*.lock
+
+## My little test files
+test.conf
+test.conf.out
+
+## Ignore Vim swp
+*.swp
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "2.0"

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gem 'clamp'
+
+group :development, :test do
+  gem 'rake'
+	gem 'simplecov'
+	gem 'travis-lint'
+  gem 'rspec'
+	gem 'cucumber'
+	gem 'guard-rspec'
+	gem 'aruba'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,63 @@
+# confswap [![Build Status](https://travis-ci.org/tlcowling/confswap.svg?branch=master)](https://travis-ci.org/tlcowling/confswap) [![Dependency Status](https://gemnasium.com/tlcowling/confswap.svg)](https://gemnasium.com/tlcowling/confswap) [![Code Climate](https://codeclimate.com/github/tlcowling/confswap/badges/gpa.svg)](https://codeclimate.com/github/tlcowling/confswap)
+:cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow: :cow2: :cow:
+
+
+
+
+A simple command line tool to take a configuration file with template placeholders and replace those placeholders with environment variables.
+
+It appears to be taking the shape of a ruby gem...
+
+## Introduction
+
+This is mostly for me to use as a convenience tool when creating docker containers.
+
+When working with elasticsearch, I have used their system for using environment variables in the config, and this has worked very well for me especially when using ENV variables with docker run.
+
+## Usage
+
+Config files can use the `%{}` style to replace a token in a stirng with a variable
+
+`export GIBLET_STATUS=active`
+`export SPLENETIC_JUICE_FACTOR=10`
+
+`example.conf|.toml|.yaml`
+```
+# This is a configuration file
+giblet_status=%{GIBLETS_STATUS}
+splenetic_juice_factor=%{SPLENETIC_JUICE_FACTOR}
+``` 
+
+Then run confswap on the file
+
+## Requirements
+
+Requires ruby version > 2.0
+Bundle install the gems
+
+## Developments
+
+Please feel free to fork and whatnot...
+
+Get the dependencies
+``bundle install``
+
+Run the tests
+``rake spec`` 
+
+### Optional:
+Use guard to rerun tests as you go...
+``guard``
+
+## Tasks to do and improvement ideas
+
+- ~~error message when config contains env variable that doesnt exist~~
+- verbose command
+- summary of what will change?  dry-run maybe?
+- test command.rb
+- ~~acceptance tests~~
+
+- internationalization :) 
+- document...
+- diff on what has changed in a config if overwriting?
+

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+	require 'bundler/gem_tasks'
+  require 'rspec/core/rake_task'
+	require 'cucumber'
+	require 'cucumber/rake/task'
+
+	Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty"
+	end
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => ['spec']
+  task :test    => ['spec','features']
+
+rescue LoadError
+end

data/bin/confswap

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+require 'confswap'
+require 'confswap/command'
+
+exit(Confswap::Command.run || 0)

data/confswap.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'confswap'
+  s.version     = '0.0.1'
+  s.licenses    = ['APACHE2']
+  s.summary     = "Confswap swaps conf variables!"
+  s.description = "Create a configuration from a template using environment variables"
+  s.authors     = ["Tom Cowling"]
+  s.email       = 'tom.cowling@gmail.com'
+  s.homepage    = 'https://www.tlcowling.com/gems/confswap'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/features/overwrite_existing_file.feature

@@ -0,0 +1,3 @@
+Feature:  Overwrite a config that already exists
+  Scenario: A file already exists
+

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'fileutils'
+require 'aruba/cucumber'

data/features/support/hooks.rb

@@ -0,0 +1,7 @@
+Before do
+  FileUtils.rm_rf '/tmp/confswap'
+end
+
+After do
+  FileUtils.rm_rf '/tmp/confswap'
+end

data/features/swap.feature

@@ -0,0 +1,26 @@
+Feature: Confswap should swap template variables
+  Background:
+    Given a file named "/tmp/confswap/test.conf" with:
+    """
+    # This is a test config
+    # that has some variables in it
+    %{TEST}
+    """
+    And I set the environment variables to:
+      | variable       | value    |
+      | TEST           | giblets  |
+
+  Scenario: Test config file with placeholders rename standard
+    When I run `confswap /tmp/confswap/test.conf`
+    Then the file "/tmp/confswap/test.conf.out" should contain:
+    """
+    giblets
+    """
+  Scenario: Test config file specifying the output
+    When I run `confswap --output=/tmp/confswap/different.conf /tmp/confswap/test.conf`
+    Then a file named "/tmp/confswap/different.conf" should exist
+    And the file "/tmp/confswap/different.conf" should contain:
+    """
+    giblets
+    """
+

data/lib/confswap/command.rb

@@ -0,0 +1,75 @@
+require 'clamp'
+require 'confswap'
+
+module Confswap
+  class Command < Clamp::Command
+    def initialize(*args)
+      super(*args)	
+    end
+		def help(*args)
+      return [
+        "This is confswap version #{Confswap::VERSION}",
+				super
+			].join("\n")
+		end
+
+		def run(*args)
+      super(*args)
+		end
+
+    def execute
+
+       if version?
+				 puts Confswap::VERSION
+				 return 0 
+       end
+
+       if configuration_filename.nil?
+         puts 'Specify a template file or use --help for usage information'
+				 return 0
+       end
+
+			 if File.exists? configuration_filename
+		     swap_config configuration_filename	   			   
+			   return 0
+			 else
+         puts "Error: Configuration template file with name #{configuration_filename} does not exist"
+				 return 1
+			 end
+    end
+
+		def swap_config configuration_filename
+      output_filename_default = configuration_filename + '.out' if output_filename.nil?
+
+      configuration_template = Confswap::ConfigurationFileReader.read configuration_filename
+      env_variables = Confswap::EnvironmentVariableReader.read_variables
+      
+			begin
+        output = configuration_template % env_variables
+			rescue KeyError => error
+				puts "#{error.message}.  Your configuration specifies this variable, but it was not found as an environment variable."
+				exit(1)
+			end
+
+      write_file output, output_filename || output_filename_default
+		end
+
+		def write_file output_file_contents, output_filename
+			return File.write output_filename, output_file_contents unless File.exists? output_filename
+      
+      if File.exists? output_filename and force?
+        puts "Overwriting #{output_filename}..."
+        File.write output_filename, output_file_contents
+			else
+        puts "#{output_filename} already exists, use the --force flag to overwrite"
+      end
+		end
+		
+		option ['-f','--force'], :flag, "Overwrite file if it already exists", :attribute_name => :force
+		option ['-v', '--version'], :flag, "The version of confswap you are running", :attribute_name => :version
+    option ['-o', '--output'], "FILE", "Specifies the filepath for the file", :attribute_name => :output_filename
+		option ['--verbose'], :flag, "Be more verbose"
+
+		parameter "[TEMPLATE_FILE]", "Path to the configuration file", :attribute_name => :configuration_filename
+  end
+end

data/lib/confswap/conf_reader.rb

@@ -0,0 +1,7 @@
+module Confswap
+  class ConfigurationFileReader
+    def self.read config_file_path
+      File.read config_file_path if File.exists? config_file_path
+    end
+  end
+end

data/lib/confswap/env_reader.rb

@@ -0,0 +1,7 @@
+module Confswap
+  class EnvironmentVariableReader
+	  def self.read_variables
+			Hash[ENV.map { |key, value| [key.to_sym, value] }]
+	  end
+  end
+end

data/lib/confswap/version.rb

@@ -0,0 +1,3 @@
+module Confswap
+  VERSION = "0.0.1"
+end

data/lib/confswap.rb

@@ -0,0 +1,3 @@
+require 'confswap/env_reader'
+require 'confswap/conf_reader'
+require 'confswap/version'

data/spec/conf_reader_spec.rb

@@ -0,0 +1,20 @@
+require 'confswap/conf_reader'
+require_relative './spec_helper.rb'
+
+describe 'Confswap::ConfigFileReader' do
+  before(:each) do
+    File.write('/tmp/test.txt', sample_config)
+  end
+
+  it 'should read the contents of a file specified' do 
+	  expect(Confswap::ConfigurationFileReader.read '/tmp/test.txt').to eql(sample_config)
+	end
+	
+  it 'should return nil if the file does not exist' do
+    expect(Confswap::ConfigurationFileReader.read '/path/does/not/exist.txt').to be_nil
+  end
+
+	after(:each) do
+	  File.delete('/tmp/test.txt') if File.exists?('/tmp/test.txt')
+	end
+end

data/spec/env_reader_spec.rb

@@ -0,0 +1,12 @@
+require 'confswap/env_reader'
+
+describe 'Confswap::EnvironmentVariableReader' do
+  it 'should read environment variables and store them in a hash' do
+		env_variables = Confswap::EnvironmentVariableReader.read_variables
+		expect(env_variables).to be_instance_of Hash
+  end
+	it 'should store the environment variable FOO=bar in a hash' do
+		ENV['FOO']="bar"
+		expect(Confswap::EnvironmentVariableReader.read_variables).to include(:FOO => "bar")
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'simplecov'
+SimpleCov.start
+
+def sample_config
+  [ "# This is a sample config",
+		"# A bunch of lines that will be in a file",
+		"# Because thats what its all about",
+		"test=%{ITEM1}",
+		"test2=%{ITEM2}",
+		"test3=%{ITEM3}"
+	].join("\n")
+end
+
+def sample_variables
+  { :ITEM1 => "localhost", :ITEM2 => "8.8.8.8", :ITEM3 => 1 }
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: confswap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Cowling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-16 00:00:00.000000000 Z
+dependencies: []
+description: Create a configuration from a template using environment variables
+email: tom.cowling@gmail.com
+executables:
+- confswap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/confswap
+- confswap.gemspec
+- features/overwrite_existing_file.feature
+- features/support/env.rb
+- features/support/hooks.rb
+- features/swap.feature
+- lib/confswap.rb
+- lib/confswap/command.rb
+- lib/confswap/conf_reader.rb
+- lib/confswap/env_reader.rb
+- lib/confswap/version.rb
+- spec/conf_reader_spec.rb
+- spec/env_reader_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.tlcowling.com/gems/confswap
+licenses:
+- APACHE2
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Confswap swaps conf variables!
+test_files:
+- features/overwrite_existing_file.feature
+- features/support/env.rb
+- features/support/hooks.rb
+- features/swap.feature
+- spec/conf_reader_spec.rb
+- spec/env_reader_spec.rb
+- spec/spec_helper.rb