sec_config 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjNlNWVhMWRlMWExYjBmYTQxMjNiOTI5OGQwNjNiMmQyYjM0NTViZA==
+  data.tar.gz: !binary |-
+    NjExZTMwYjk2OWJhNjYzMTllYmExMzE1MDhkNTcxMGQyOTE3NmIyYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzFmNDg4YjY2NDlkYjZlMjgxYzg0MzMzYTNmNTM4MWRmMjUzOWJhZTBiNGI5
+    NDIxZWM0M2YwNGQyMjEzZWZmZDljZDg0N2YxZjQwNTBiZmMxNmI5NTUwYjU1
+    Njc4ZDRkM2Q3MGExMGFkZGJhZGE2NzViYWNlNmE4MjJkMzYwNmM=
+  data.tar.gz: !binary |-
+    MmNiN2NmMGVjN2I3NDJiZTY2YzEyNzA2ZTBhZmEwOWU4ZTI1ZjFmMjMwMTZi
+    MDU1ZWVjNmUwY2E2MGM4NzM2Y2Q4MGE0YjA0ZjU2NWQ2Y2I1MmI0NGU5MmYw
+    ZDhlZjhiMDQ3OTFmZGU2ZjM4YzVlOTZlOTZmY2M0NmE0YWZhNDM=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Nowak
+
+MIT License
+
+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,86 @@
+# `sec_config`
+
+it's a tool which should help you to maintain various key-value based data for your rails project:
+
+* often we use some kind of external APIs which require keys or tokens
+* we don't want to save such data directly in the repo, however we would like to use it
+* we would like to have different key values for different environments
+
+this flow is used in [netguru](https://github.com/netguru) and we're happy to recommend it to everybody!
+
+## installation
+
+add this line to your application's gemfile:
+
+    gem 'sec_config'
+
+and then execute:
+
+    $ bundle
+
+or install it yourself as:
+
+    $ gem install sec_config
+
+## usage
+
+generate the structure and you're ready to go.
+
+```shell
+sc install
+```
+
+ok, what now? you have your `config.yml` file which is stored in repo.
+
+```ruby
+# config/config.yml
+
+defaults: &defaults
+  not_important_key: "abcdef"
+  important_key: "123456"
+
+development:
+  <<: *defaults
+  not_important_key: "fedcba"
+
+production:
+  <<: *defaults
+```
+
+you have also a `sec_config.yml.sample` file which you should rename on the target environment to `sec_config.yml` and put the data you want overvrite the defaults with.
+
+```ruby
+# config/sec_config.yml
+
+production:
+  important_key: "abc123"
+```
+
+### usage within your app ###
+
+```ruby
+# on development
+AppConfig.not_important_key
+# => fedcba
+AppConfig.important_key
+# => 123456
+
+# on production
+AppConfig.not_important_key
+# => abcdef
+AppConfig.important_key
+# => abc123
+```
+
+### tips ###
+
+* don't forget that `sec_config.yml` has to be edited directly on the environment which you want to be overwriting the data (`staging`, `production`, etc.)
+* `*_secret`, `*_token`, `*_password` variables seem to be a good example of keys which **should not** be stored in the repo
+
+## contributing
+
+1. fork it
+2. create your feature branch (`git checkout -b my-new-feature`)
+3. commit your changes (`git commit -am 'add some feature'`)
+4. push to the branch (`git push origin my-new-feature`)
+5. create new pull request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/sc

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'sec_config'
+
+SecConfig::CLI.start(ARGV)
+

data/lib/sec_config.rb

@@ -0,0 +1,2 @@
+require "sec_config/version"
+require "sec_config/cli"

data/lib/sec_config/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+require 'sec_config/generators/konf'
+
+class SecConfig::CLI < Thor
+  include Thor::Actions
+
+  desc "install", "prepare structure and files for your app config"
+  method_option :path, default: File.join(Dir.pwd, "/config")
+  method_option :environments, default: [:development, :staging, :beta, :production], type: :array
+
+  def install
+    SecConfig::Generators::Konf.start([options[:path], options[:environments]])
+  end
+
+end

data/lib/sec_config/generators/konf.rb

@@ -0,0 +1,26 @@
+module SecConfig::Generators
+  class Konf < Thor::Group
+    include Thor::Actions
+
+    argument :path, type: :string
+    argument :environments, type: :array
+    class_option :include_preinitializer, type: :boolean
+
+    def create_konf_files
+      template("config.yml.erb", File.join(path, "config.yml"))
+      template("sec_config.yml.sample.erb", File.join(path, "sec_config.sample.yml"))
+    end
+
+    def create_preinitializer
+      template("preinitializer.rb", File.join(path, "preinitializer.rb"))
+    end
+
+    def add_to_gitignore
+      append_file ".gitignore", "config/sec_config.yml"
+    end
+
+    def self.source_root
+      File.expand_path("../templates", __FILE__)
+    end
+  end
+end

data/lib/sec_config/generators/templates/config.yml.erb

@@ -0,0 +1,6 @@
+defaults: &defaults
+#  somek_key: value
+<% environments.each do |env| %>
+<%= "#{env}:" %>
+  <<: *defaults
+<% end %>

data/lib/sec_config/generators/templates/preinitializer.rb

@@ -0,0 +1,6 @@
+require 'active_support/core_ext'
+require 'konf'
+
+pub_config = (YAML.load(ERB.new(File.read(File.expand_path('../config.yml',     __FILE__))).result)[Rails.env] rescue {}) || {}
+sec_config = (YAML.load(ERB.new(File.read(File.expand_path('../sec_config.yml', __FILE__))).result)[Rails.env] rescue {}) || {}
+AppConfig = Konf.new(pub_config.deep_merge(sec_config))

data/lib/sec_config/generators/templates/sec_config.yml.sample.erb

@@ -0,0 +1,6 @@
+defaults: &defaults
+#  some_secret_config: "DON'T TELL ANYONE!"
+<% environments.each do |env| %>
+<%= "#{env}:" %>
+  <<: *defaults
+<% end %>

data/lib/sec_config/version.rb

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

data/sec_config.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sec_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sec_config"
+  spec.version       = SecConfig::VERSION
+  spec.authors       = ["Adam Nowak"]
+  spec.email         = ["lubieniebieski@gmail.com"]
+  spec.description   = %q{tool which should help you to maintain various key-value based data for your rails project}
+  spec.summary       = %q{very useful in situations where we use some kind of external APIs which require keys or tokens and we don't want to save such data directly in the repo, however we would like to use it; we would like to have different key values for different environments}
+  spec.homepage      = "https://github.com/lubieniebieski/sec_config"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "thor"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: sec_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Nowak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: tool which should help you to maintain various key-value based data for
+  your rails project
+email:
+- lubieniebieski@gmail.com
+executables:
+- sc
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sc
+- lib/sec_config.rb
+- lib/sec_config/cli.rb
+- lib/sec_config/generators/konf.rb
+- lib/sec_config/generators/templates/config.yml.erb
+- lib/sec_config/generators/templates/preinitializer.rb
+- lib/sec_config/generators/templates/sec_config.yml.sample.erb
+- lib/sec_config/version.rb
+- sec_config.gemspec
+homepage: https://github.com/lubieniebieski/sec_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.0.7
+signing_key: 
+specification_version: 4
+summary: very useful in situations where we use some kind of external APIs which require
+  keys or tokens and we don't want to save such data directly in the repo, however
+  we would like to use it; we would like to have different key values for different
+  environments
+test_files: []