shadow_db_credentials 1.0.2 → 1.1.0

data/.ruby-gemset

@@ -0,0 +1 @@
+shadow_db_credentials

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/CHANGES

@@ -2,4 +2,12 @@
 
 == Version 1.0.0
 
-* Initial release.
+* Initial release.
+
+== Version 1.0.3
+
+* Bug fixes.
+
+== Version 1.1.0
+
+* Small API and build changes; writing documentation

data/Gemfile

@@ -1,8 +1,4 @@
-source :rubygems
-
-group :default do
-
-end
+source 'https://rubygems.org'
 
 group :development do
   gem "gemspec_deps_gen"
@@ -10,6 +6,11 @@ group :development do
 end
 
 group :test do
-  gem "rspec", "2.9.0"
-  gem "mocha", "0.10.3"
+  gem "rspec"
+  gem "mocha"
+end
+
+group :debug do
+  #gem "ruby-debug-base19x", "0.11.30.pre12"
+  gem "ruby-debug-ide", "0.4.17"
 end

data/README.md

@@ -1,4 +1,126 @@
-shadow_db_credentials
-=====================
+# Shadow DB Credentials
+
+## Helps to keep DB credentials for rails app in private place
+
+## Installation
+
+Add this line to to your Gemfile:
+
+    gem "shadow_db_credentials"
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create "shadowed" credentials file (**your_prod_credentials**) inside some directory (e.g. **~/.credentials**):
+
+```yml
+username: your_username
+password: your_password
+```
+
+The location of your **credentials directory** is controlled by **CREDENTIALS_DIR** environment
+variable. Register it in **config/initializers/env_variables.rb** file:
+
+```ruby
+ENV['CREDENTIALS_DIR'] ||= "#{ENV['HOME']}/.credentials"
+```
+
+If you want to have different **credentials directory** per environment, define it in corresponding env file:
+
+```ruby
+# config/environments/development.rb
+...
+ENV['CREDENTIALS_DIR'] ||= "#{ENV['HOME']}/.credentials"
+```
+
+Remove all the credentials (username/password) that you don't want to keep inside **config/database.yml**
+and replace them with single **credentials** attriubute. It points to the name of credentials file
+(**your_prod_credentials**):
+
+```yml
+development:
+  adapter: postgresql
+  database: your_dev_db
+  credentials: your_dev_credentials
+
+production:
+  adapter: postgresql
+  database: your_prod_db
+  credentials: your_prod_credentials
+```
+
+If you want, you can also move other sensitive information, such as database name, url etc.
+
+Next, you have to create code hook inside rails **config/application.rb** in order to call gem's API:
+
+```ruby
+require 'shadow_db_credentials'
+
+...
+
+module YourRailsApp
+  class Application < Rails::Application
+    ...
+
+    def config.database_configuration
+      orig_db_configurations = super
+
+      processor = ShadowDbCredentials.new(ENV['CREDENTIALS_DIR'])
+
+      processor.process_configurations(orig_db_configurations)
+    end
+  end
+end
+```
+
+The hook will access original DB configuration and try to expand all **credentials** attributes
+with corresponding values dynamically, at run time.
+
+You can check result of your work:
+
+```bash
+$ rails console production
+
+> ActiveRecord::Base.configurations["production"]
+ => {"adapter"=>"postgresql", "username"=>"your_username", "password"=>"your_password"}
+
+> Rails.application.config.database_configuration['production']
+ => {"adapter"=>"postgresql", "username"=>"your_username", "password"=>"your_password"}
+```
+
+Or you can get it with API call:
+
+```ruby
+require 'shadow_db_credentials'
+
+credentials_dir = ENV['CREDENTIALS_DIR']
+processor = ShadowDbCredentials.new(credentials_dir)
+
+# 1. get production hash, read configuration from default location
+
+connection_hash1 = processor.retrieve_configuration "production"
+connection_hash1.inspect
+
+# 2. get development hash, read configuration from dynamic source
+
+source = StringIO.new <<-TEXT
+  development:
+    adapter: postgresql
+    credentials: your_dev_db
+TEXT
+
+connection_hash2 = processor.retrieve_configuration 'development', source
+connection_has2.inspect
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
-Class that helps to keep database credentials for rails application in private place

data/Rakefile

@@ -6,20 +6,25 @@ require "rspec/core/rake_task"
 require "shadow_db_credentials/version"
 require "gemspec_deps_gen/gemspec_deps_gen"
 
-def version
-  ShadowDbCredentials::VERSION
-end
+version = ShadowDbCredentials::VERSION
+project_name = File.basename(Dir.pwd)
+
+task :gen do
+  generator = GemspecDepsGen.new project_name
 
-def project_name
-  File.basename(Dir.pwd)
+  generator.generate_dependencies "spec", "#{project_name}.gemspec.erb", "#{project_name}.gemspec"
 end
 
-task :build do
-  generator = GemspecDepsGen.new
+task :build => :gen do
+  system "gem build #{project_name}.gemspec"
+end
 
-  generator.generate_dependencies "#{project_name}.gemspec.erb", "#{project_name}.gemspec"
+task :install do
+  system "gem install #{project_name}-#{version}.gem"
+end
 
-  system "gem build #{project_name}.gemspec"
+task :uninstall do
+  system "gem uninstall #{project_name}"
 end
 
 task :release => :build do
@@ -31,4 +36,3 @@ RSpec::Core::RakeTask.new do |task|
   task.verbose = false
 end
 
-

data/lib/shadow_db_credentials.rb

@@ -1 +1,2 @@
+require "shadow_db_credentials/version"
 require "shadow_db_credentials/shadow_db_credentials"

data/lib/shadow_db_credentials/shadow_db_credentials.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 class ShadowDbCredentials
 
   def initialize credentials_dir
@@ -9,12 +11,12 @@ class ShadowDbCredentials
 
     template = ERB.new file.read
 
-    config = YAML.load(template.result(binding))
+    config = indifferent_access(YAML.load(template.result(binding)))
 
-    process_credentials(config[rails_env])
+    process_credentials(config[rails_env.to_sym])
   end
 
-  def process_all_configurations configurations
+  def process_configurations configurations
     new_configurations = {}
 
     configurations.each do |name, params|
@@ -24,24 +26,16 @@ class ShadowDbCredentials
     new_configurations
   end
 
-  def process_configuration configurations, rails_env
-    new_configurations = configurations.clone
-
-    new_configurations[rails_env] = process_credentials(configurations[rails_env])
-
-    new_configurations
-  end
-
   private
 
   def process_credentials params
-    if params['credentials']
-      credentials = params.delete('credentials')
+    if params[:credentials]
+      credentials = params.delete(:credentials)
 
-      file_name = "#@credentials_dir/#{credentials}"
+      file_name = "#{@credentials_dir}/#{credentials}"
 
       if File.exist? file_name
-        params.merge!(YAML.load_file(file_name))
+        params.merge!(indifferent_access(YAML.load_file(file_name)))
       else
         puts "Missing credentials file: #{file_name}."
       end
@@ -49,5 +43,20 @@ class ShadowDbCredentials
 
     params
   end
+
+  def indifferent_access hash
+    case hash
+      when Hash
+        Hash[
+          hash.map do |k, v|
+            [ k.respond_to?(:to_sym) ? k.to_sym : k, indifferent_access(v) ]
+          end
+        ]
+      when Enumerable
+        hash.map { |v| indifferent_access(v) }
+      else
+        hash
+    end
+  end
 end
 

data/lib/shadow_db_credentials/version.rb

@@ -1,3 +1,3 @@
-module ShadowDbCredentials
-  VERSION = "1.0.2"
+class ShadowDbCredentials
+  VERSION = "1.1.0"
 end

data/shadow_db_credentials.gemspec

@@ -17,8 +17,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.version       = ShadowDbCredentials::VERSION
 
+  
   spec.add_development_dependency "gemspec_deps_gen", [">= 0"]
   spec.add_development_dependency "gemcutter", [">= 0"]
-  
+
 end
 

data/shadow_db_credentials.gemspec.erb

@@ -17,6 +17,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.version       = ShadowDbCredentials::VERSION
 
-  <%= include_dependencies %>
+  <%= project_dependencies %>
 end
 

data/spec/shadow_db_credentials_spec.rb

@@ -4,17 +4,38 @@ require 'shadow_db_credentials'
 require 'yaml'
 
 describe ShadowDbCredentials do
-  it "should read credentials from the file" do
-    YAML.expects(:load_file).with("#{ENV['HOME']}/.credentials/rails_app_tmpl").returns(
-        {"url" => "some_url", "username" => "username", "password" => "password"}
+  before do
+    @credentials_dir = 'some_credentials_dir'
+
+    credentials_file_name = "#{@credentials_dir}/your_dev_db"
+
+    YAML.expects(:load_file).with(credentials_file_name).returns(
+      {url: "some_url", username: "username", password: "password"}
     )
+    File.expects(:exist? => true).with(credentials_file_name)
+  end
+
+  subject do
+    ShadowDbCredentials.new(@credentials_dir)
+  end
+
+  it "should process credentials attrubute" do
+    configurations = {production: { adapter: 'oracle_enhanced', credentials: 'your_dev_db'}}
 
-    subject = ShadowDbCredentials.new("#{ENV['HOME']}/.credentials")
+    result = subject.process_configurations configurations
+
+    result[:production][:url].should == 'some_url'
+  end
 
-    configurations = {'production' => { 'adapter' => 'oracle_enhanced', 'credentials' => 'rails_app_tmpl'}}
+  it "should retrieve given configuration" do
+    source = StringIO.new <<-TEXT
+development:
+  adapter: postgresql
+  credentials: your_dev_db
+TEXT
 
-    result = subject.process_all_configurations configurations
+    result = subject.retrieve_configuration "development", source
 
-    result["production"]["url"].should == 'some_url'
+    result[:development][:url].should == 'some_url'
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,5 @@
 $: << File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 RSpec.configure do |config|
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-
   config.mock_with :mocha
-  #config.mock_with :rspec
-
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: shadow_db_credentials
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexander Shvets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemspec_deps_gen
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: gemcutter
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Class that helps to keep database credentials for rails application in
@@ -55,13 +50,15 @@ files:
 - .idea/.rakeTasks
 - .idea/cssxfire.xml
 - .idea/encodings.xml
+- .idea/jenkinsSettings.xml
 - .idea/misc.xml
 - .idea/modules.xml
 - .idea/scopes/scope_settings.xml
 - .idea/shadow_db_credentials.iml
 - .idea/vcs.xml
 - .idea/workspace.xml
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - CHANGES
 - Gemfile
 - LICENSE
@@ -76,27 +73,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/shvets/shadow_db_credentials
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Class that helps to keep database credentials for rails application in private
   place
 test_files: