snappconfig 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82216d73ae7c53a02e8d0572eab2ca2e0790ca94
+  data.tar.gz: f0980a18c83716f5e42468c02065093e73c5c68d
+SHA512:
+  metadata.gz: 77ceddc54748e10f4c3c11c56cb56921312c9b99ddded6fd70ee231710cd89ffe52817a3dca93023cecdd5f530bc11c287683b009d19ada9d8dc4b16f3b8f86d
+  data.tar.gz: b7324b3ea3346d24967a089e3775534d2260886e7d154003819c73d5cbe32885651f31f20abe78e551e774c8443045549637e67fe83b1c6b1100e7fe0443a344

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 snappconfig.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yarin Kessler
+
+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,159 @@
+# Snappconfig
+
+Smarter Rails configuration that works with Heroku. Here's why it rocks:
+
+- **It's Simple**. There's no setup code. Just **add some YAML** and you're ready to roll.
+- It supports **nested values and lists**. Use the data structures you want and access them with standard hash notation (e.g. `CONFIG[:this][:that]`)
+- It promotes **secure best practices** that keep your secrets out of source control.
+- It lets you write to a nestable `CONFIG` hash *or* to  `ENV` variables- we don’t tell you how to live.
+- It's **Heroku-friendly**.
+- It's based on Ryan Bates’ excellent [Railscast](http://railscasts.com/episodes/85-yaml-configuration-revised) and inspired by [Figaro](https://github.com/laserlemon/figaro).
+
+## Installation
+  
+  
+  
+**1)** Add it to your Gemfile and run `bundle` to install
+
+    gem 'snappconfig'
+
+**2)** Use the generator to create config files (optional):
+
+    $ rails generate snappconfig:install
+
+This will create:  
+
+- A default config file at `config/application.yml`
+- A git-ignored config file for secrets at `config/application.secrets.yml`
+
+
+
+
+## Usage
+
+To access config values, just use standard hash notation:
+
+    token = CONFIG[:secret_token]
+    stripe_secret = CONFIG[:stripe][:secret_key]
+    
+Or if you wrote values to **ENV**, get them the way you normally would:
+
+    token = ENV['SECRET_TOKEN']
+
+
+
+## YAML file examples
+
+
+
+####Environment specfic (with defaults)
+    mailer_host: "localhost:3000"
+    development:
+      mailer_host: "localhost:3000"
+    test:
+      mailer_host: "test.local"
+    production:
+      mailer_host: "blog.example.com"
+( **NOTE:** Default values can also be put under a 'defaults' group key. )
+
+####Nested values:
+    stripe: 
+      publishable_key: 5883eeb3cd43cee52585
+      secret_key: 0df20bf20903c4404968 
+      
+    development:
+      stripe: 
+        publishable_key: 5883eeb3cd43cee52585
+        secret_key: 0df20bf20903c4404968      
+    production:
+      stripe: 
+        publishable_key: e753e42725fe43d3994a
+        secret_key: e8787290a07b1abecae9
+
+####ENV values:
+
+    ENV: 
+        BLOG_USERNAME: "admin"
+        BLOG_PASSWORD: "secret"
+
+( **NOTE:** Values you put under an **"ENV"** key will be accessible in your app via `ENV['MY_VAR']` instead of `CONFIG[:my_var]`. These values can't be nested. )  
+
+
+
+## Multiple files
+
+The number of config files you use is up to you. Stuff it all in a single file, or use multiple files for different versions, environments, etc.
+
+Snappconfig will load all files in the `config/` directory that start with **"application."** and end with **".yml"**, and merge them down in alphabetical order (minus the file extension), with later values taking precedence.
+
+For example, the following files would be processed in order:
+
+- **application**.yml
+- **application.2**.yml
+- **application.test**.yml
+
+
+<a name='best_practices'/>
+##Best practices
+
+
+There's nothing to stop you from putting all your configuration into a single `application.yml` file. However, best practices dictate that protected values like **passwords and tokens should not be stored in source control.** 
+
+An obvious solution would be to git-ignore the config file, but that approach has its problems. Not all values need to be secret, and without any config file developers won't know what values are expected or what the defaults should be.
+
+###Separating your secrets
+
+A better approach is to separate the secret values from the configuration values that are useful to share. Snappconfig makes this easy with multi-file support and the `_REQUIRED` keyword.
+
+
+For instance, if we already have a mailer configuration that works for our app, there's no reason the bulk of it can't go into source control...
+
+
+**application.yml:**
+
+    secret_token: _REQUIRED
+    mail:
+      delivery_method: :smtp
+      smtp_settings:
+        address: "smtp.gmail.com"
+        port: '587'
+        domain: 'baci.lindsaar.net'
+        user_name: 'acmesupport'
+        password: _REQUIRED
+        authentication: 'plain'
+        enable_starttls_auto: true
+
+Using the `_REQUIRED` keyword, we indicate values we expect to be included in the configuration, even though they're not in this file. 
+
+We can then fulfill that obligation by using a git-ignored file that just stores our secrets: 
+
+**application.secrets.yml:**
+
+    secret_token: "024e1460a4fb8271e611d0f53811a382f1f6be121..."
+    mail:
+      smtp_settings:
+        password: 8675309
+
+Now we've got a complete configuration without compromising anything!
+
+The `_REQUIRED` keyword is really handy. You can use it to stub out an entire config file template. If any of the required values are not present at runtime Snappconfig will raise an error, ensuring you never go live without a complete configuration.
+
+###Working with Heroku
+
+The Heroku file system is read-only, so if you're git-ignoring your config files you won't be able to add them in manually.
+
+But don't worry, Snappconfig's got you covered- just run the custom rake task:
+
+    $ rake snappconfig:heroku
+
+and your app configuration will automatically be passed into Heroku for you. Slick!
+
+
+
+## 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/lib/generators/snappconfig/install/install_generator.rb

@@ -0,0 +1,27 @@
+module Snappconfig
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      # all public methods in here will be run in order
+    
+      def create_configuration
+        template "application.yml", "config/application.yml"
+        template "application.secrets.yml", "config/application.secrets.yml"
+      end
+
+      def ignore_configuration
+        if File.exists?(".gitignore")
+          append_to_file(".gitignore") do
+            <<-EOF.strip_heredoc
+
+            # Ignore application secrets.
+            /config/application.secrets.yml
+            EOF
+          end
+        end
+      end
+    
+    end
+  end
+end

data/lib/generators/snappconfig/install/templates/application.secrets.yml

@@ -0,0 +1,2 @@
+# SECRET APPLICATION CONFIGURATION 
+# Should be git-ignored. See: https://github.com/ykessler/snappconfig#snappconfig

data/lib/generators/snappconfig/install/templates/application.yml

@@ -0,0 +1,3 @@
+# DEFAULT APPLICATION CONFIGURATION
+# For examples, see: https://github.com/ykessler/snappconfig#snappconfig
+

data/lib/snappconfig.rb

@@ -0,0 +1,43 @@
+require "snappconfig/railtie"
+
+module Snappconfig
+  extend self
+  
+  def config_files
+    @config_files ||= Dir.entries(Rails.root.join("config").to_s).grep(/(^application)(\.|\..*\.)(yml$)/).sort { |x,y| x.chomp(".yml") <=> y.chomp(".yml") }
+  end
+  
+  def merged_raw
+    if @merged_raw 
+      return @merged_raw
+    else  
+      @merged_raw = {}
+      config_files.each do | file_name |
+        file = ConfigFile.new(file_name)
+        @merged_raw.deep_merge! file.raw
+      end
+      return @merged_raw
+    end
+  end
+  
+  class ConfigFile
+    
+    def initialize(name)
+      @name = name
+    end
+    
+    def raw
+      @raw ||= yaml && YAML.load(yaml) || {}
+    end
+    
+    def yaml
+      @yaml ||= File.exist?(path) ? ERB.new(File.read(path)).result : nil
+    end
+
+    def path
+      @path ||= Rails.root.join("config", @name)
+    end
+    
+  end
+  
+end

data/lib/snappconfig/railtie.rb

@@ -0,0 +1,61 @@
+require "rails"
+
+CONFIG = {}
+
+module Snappconfig
+  class Railtie < ::Rails::Railtie
+  
+    config.before_configuration do
+
+      # Look for CONFIG file in ENV (For Heroku) or else load from file system:
+      appconfig = ENV['CONFIG'] ? YAML.load(ENV['CONFIG']) : Snappconfig.merged_raw
+    
+      appconfig.deep_merge! appconfig.fetch('defaults', {})
+      appconfig.deep_merge! appconfig.fetch(Rails.env, {})
+
+      check_required(appconfig)
+
+      # Assign ENV values...
+      if appconfig.has_key?('ENV')
+        appconfig['ENV'].each do |key, value|
+          ENV[key] = value.to_s unless value.kind_of? Hash
+        end
+        # ... and clear ENV values from CONFIG so we don't have duplicate data:
+        appconfig.delete('ENV')
+        appconfig.each do |key,value|
+          value.delete('ENV') if value.is_a?(Hash) && value.has_key?('ENV')
+        end
+      end
+
+      appconfig = recursively_symbolize_keys(appconfig)
+      CONFIG.merge! appconfig
+      
+    end
+
+    rake_tasks do
+      load "snappconfig/tasks.rake"
+    end
+    
+    private
+    
+    def check_required(hash)
+      hash.each_pair do |key,value|
+        if value == '_REQUIRED'
+          raise "The configuration value #{key} is required but was not supplied. Check your application.yml file(s)."
+        elsif value.is_a?(Hash)
+          check_required(value) 
+        end
+      end
+    end
+    
+    def recursively_symbolize_keys(hash)
+      sym_hash = {}
+      hash.each_pair do |key,value|
+        hash[key] = value.is_a?(Hash) ? recursively_symbolize_keys(value) : value 
+        sym_hash[(key.to_sym rescue key) || key] = hash[key]
+      end
+      sym_hash
+    end
+    
+  end
+end

data/lib/snappconfig/tasks.rake

@@ -0,0 +1,15 @@
+require "shellwords"
+
+namespace :snappconfig do
+  
+  task :heroku, [:app] => :environment do   
+    puts "Passing application configuration to Heroku..."
+    merged_yaml = Snappconfig.merged_raw.to_yaml
+    shell_yaml = Shellwords.escape(merged_yaml)
+    puts `heroku config:set CONFIG=#{shell_yaml}`
+  end
+  
+end
+
+
+

data/snappconfig.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "snappconfig"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Yarin Kessler"]
+  spec.email         = "ykessler@appgrinders.com"
+  spec.summary       = %q{Smarter Rails configuration with YAML}
+  spec.description   = %q{Smarter, Heroku-friendly Rails configuration using YAML}
+  spec.homepage      = "https://github.com/ykessler/snappconfig"
+  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"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: snappconfig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yarin Kessler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-20 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'
+description: Smarter, Heroku-friendly Rails configuration using YAML
+email: ykessler@appgrinders.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/snappconfig/install/install_generator.rb
+- lib/generators/snappconfig/install/templates/application.secrets.yml
+- lib/generators/snappconfig/install/templates/application.yml
+- lib/snappconfig.rb
+- lib/snappconfig/railtie.rb
+- lib/snappconfig/tasks.rake
+- snappconfig.gemspec
+homepage: https://github.com/ykessler/snappconfig
+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.3
+signing_key: 
+specification_version: 4
+summary: Smarter Rails configuration with YAML
+test_files: []