cloudcontrol-rails 0.0.3

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    cloudcontrol-rails (0.0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cloudcontrol-rails!
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 Alexander Rösel, Inc. (http://justfrontend.com)
+
+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,57 @@
+#cctrl_database_configuration
+
+Override empty database.yml settings with the ENV vars on the cloudControl plattform. Supports [MySQLs](https://www.cloudcontrol.com/add-ons/mysqls "MySQLs Addon at cloudControl"), [MySQLd](https://www.cloudcontrol.com/add-ons/mysqld "MySQLd Addon at cloudControl") and [ElephantSQL](https://www.cloudcontrol.com/add-ons/elephantsql "ElephantSQL Addon at cloudControl") (Postgres)
+
+##Installation
+
+Add the following to your gemfile
+~~~
+gem "cloudcontrol-rails", :git => "git://github.com/Traxmaxx/cctrl_database_configuration.git"
+~~~
+
+And run `bundle install`
+
+Now modify or create your `database.yml` and leave the credentials empty. You can override everything anytime by just adding them again.
+
+To share a database over two deployments without hardcoding the credentials you need to add them with the [Custom Config Addon](https://www.cloudcontrol.com/add-ons/config "Custom Config Addon at cloudControl")
+
+##Example database.yml
+
+Credentials will be served through the gem:
+~~~
+production:
+  host:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database:
+  pool: 5
+  username:
+  password:
+~~~
+
+Credentials will not be touched because they are not empty:
+~~~
+production:
+  host: localhost
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: db_name
+  pool: 5
+  username: username
+  password: password
+~~~
+
+You can also serve specific values only through the gem:
+~~~
+production:
+  host: localhost
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: db_name
+  pool: 5
+  username:
+  password:
+~~~

data/cloudcontrol-rails.gemspec

@@ -0,0 +1,16 @@
+# encoding = utf-8
+
+Gem::Specification.new do |s|
+  s.name          = 'cloudcontrol-rails'
+  s.version       = "0.0.3"
+  s.authors       = ["Alexander Rösel"]
+  s.email         = ["info@netzok.net"]
+  s.summary       = "Autoload MySQL and Postgres credentials from ENV vars on cloudControl"
+  s.description   = "Use credentials set in ENV vars if database.yml credentials are empty. Supports MySQL and ElephantSQL (Postgres) on the cloudControl platform."
+  s.homepage      = "http://justfrontend.com"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/cloudcontrol-rails.rb

@@ -0,0 +1,15 @@
+require 'erb'
+
+require 'cloudcontrol/cloudcontrol'
+
+module Rails
+  class Application
+    class Configuration < ::Rails::Engine::Configuration
+      def database_configuration
+        config = YAML::load ERB.new(IO.read(paths['config/database'].first)).result
+
+        return Cloudcontrol::reconfigure_database_configuration config
+      end
+    end
+  end
+end

data/lib/cloudcontrol/cloudcontrol.rb

@@ -0,0 +1,16 @@
+require 'cloudcontrol/mysql'
+require 'cloudcontrol/postgres'
+
+module Cloudcontrol
+  def self.reconfigure_database_configuration(config)
+    rails_env = ENV['RAILS_ENV'] || 'development'
+
+    # set creds for the different adapters
+    case config[rails_env]['adapter']
+      when 'mysql2'
+        Cloudcontrol::configure_mysql config, rails_env
+      when 'postgresql'
+        Cloudcontrol::configure_postgres config, rails_env
+    end
+  end
+end

data/lib/cloudcontrol/mysql.rb

@@ -0,0 +1,15 @@
+module Cloudcontrol
+  def self.configure_mysql(config, rails_env)  # NOTE addons MySQLS and MySQLD
+    config[rails_env].each do |key, value|
+      if value.nil?
+        if key == 'username'  # NOTE auto match breaks on username so we need to look for it manually
+          config[rails_env][key] = ENV['MYSQLD_USER'] || ENV['MYSQLS_USER'] || nil
+        else
+          config[rails_env][key] = ENV["MYSQLD_#{ key.upcase }"] || ENV["MYSQLS_#{ key.upcase }"] || nil
+        end
+      end
+    end
+
+    return config
+  end
+end

data/lib/cloudcontrol/postgres.rb

@@ -0,0 +1,23 @@
+module Cloudcontrol
+  def self.configure_postgres(config, rails_env)  # NOTE addon ElephantSQL
+    config[rails_env].each do |key, value|
+      if value.nil? && ENV['ELEPHANTSQL_URL']
+        elephant_uri = URI.parse ENV['ELEPHANTSQL_URL']
+        case key
+          when 'database'
+            config[rails_env][key] = elephant_uri.path[1 .. -1]
+          when 'username'
+            config[rails_env][key] = elephant_uri.user
+          when 'password'
+            config[rails_env][key] = elephant_uri.password
+          when 'host'
+            config[rails_env][key] = elephant_uri.host
+          when 'port'
+            config[rails_env][key] = elephant_uri.port
+        end
+      end
+    end
+
+    return config
+  end
+end

data/spec/database_configuration_spec.rb

@@ -0,0 +1,233 @@
+require 'erb'
+require 'uri'
+require 'yaml'
+
+require 'spec_helper'
+require 'cloudcontrol/cloudcontrol'
+
+describe "Cloudcontrol" do
+  let(:db_config_dev) { [ adapter ] + [ 'env' ] * 5 }
+  let(:db_config_prod) { [ adapter ] + [ 'env' ] * 5 }
+
+  let(:database_yml) do
+    yml = <<END
+development:
+  adapter: %s
+  encoding: utf8
+  reconnect: false
+  pool: 5
+  host: %s
+  port: %s
+  database: %s
+  username: %s
+  password: %s
+production:
+  adapter: %s
+  encoding: utf8
+  reconnect: false
+  pool: 5
+  host: %s
+  port: %s
+  database: %s
+  username: %s
+  password: %s
+END
+
+    yml % db_config
+end
+
+  let(:db_config) { db_config_dev + db_config_prod }
+
+  let(:config) do
+    IO.stub!(:read).and_return database_yml
+    YAML::load ERB.new(IO.read('config/database')).result
+  end
+
+  let(:not_modified) do
+    {
+      "adapter" => adapter,
+      "host" => 'env',
+      "port" => 'env',
+      "database" => 'env',
+      "username" => 'env',
+      "password" => 'env',
+    }
+  end
+
+  before do
+    ENV = {
+      'RAILS_ENV' => "production",
+      'MYSQLS_HOST' => "env",
+      'MYSQLS_PORT' => "env",
+      'MYSQLS_DATABASE' => "env",
+      'MYSQLS_USER' => "env",
+      'MYSQLS_PASSWORD' => "env",
+      'ELEPHANTSQL_URL' => 'postgres://env:env@env.env.env:42/env',
+    }
+  end
+
+  describe "MySQL" do
+    let(:adapter) { 'mysql2' }
+
+    describe "without provided values" do
+      let(:db_config_prod) { [ adapter ] + [ nil] * 5 }
+      let(:expected_res) { not_modified }  # HACK
+
+      it "should return proper value" do
+        env = 'production'
+        ENV["RAILS_ENV"] = env
+        res = Cloudcontrol::reconfigure_database_configuration config
+        res[env].should include(expected_res)
+      end
+    end
+
+    describe "with partially provided values" do
+      let(:expected_res) do
+        {
+          "adapter"=>adapter,
+          "host"=>"host",
+          "port"=>42,
+          "database"=>"db",
+          "username"=>"env",
+          "password"=>"env"
+        }
+      end
+
+      describe "for production" do
+        let(:db_config_prod) { [ adapter, 'host', '42', 'db', nil, nil ] }
+
+        it "should return proper value" do
+          env = 'production'
+          other_env = 'development'
+          ENV["RAILS_ENV"] = env
+
+          res = Cloudcontrol::reconfigure_database_configuration config
+          res[env].should include(expected_res)
+          res[other_env].should include(not_modified)
+        end
+      end
+
+      describe "for development" do
+        let(:db_config_dev) { [ adapter, 'host', '42', 'db', nil, nil ] }
+
+        it "should return proper value" do
+          env = 'development'
+          other_env = 'production'
+          ENV["RAILS_ENV"] = env
+
+          res = Cloudcontrol::reconfigure_database_configuration config
+          res[env].should include(expected_res)
+          res[other_env].should include(not_modified)
+        end
+      end
+    end
+
+    describe "with fully provided values" do
+      let(:db_config_prod) { [ adapter, 'host', '42', 'db', 'username', 'pass' ] }
+      let(:expected_res) do
+        {
+          "adapter"=>adapter,
+          "host"=>"host",
+          "port"=>42,
+          "database"=>"db",
+          "username"=>"username",
+          "password"=>"pass"
+        }
+      end
+
+      it "should return proper value" do
+        env = 'production'
+        ENV["RAILS_ENV"] = env
+        res = Cloudcontrol::reconfigure_database_configuration config
+        res[env].should include(expected_res)
+      end
+    end
+  end
+
+  describe "PostgreSQL" do
+    let(:adapter) { 'postgresql' }
+
+    describe "without provided values" do
+      let(:db_config_prod) { [ adapter ] + [ nil] * 5 }
+      let(:expected_res) do
+        {
+          "adapter" => adapter,
+          "host" => 'env.env.env',
+          "port" => 42,
+          "database" => 'env',
+          "username" => 'env',
+          "password" => 'env',
+        }
+      end
+
+      it "should return proper value" do
+        env = 'production'
+        ENV["RAILS_ENV"] = env
+        res = Cloudcontrol::reconfigure_database_configuration config
+        res[env].should include(expected_res)
+      end
+    end
+
+    describe "with partially provided values" do
+      let(:expected_res) do
+        {
+          "adapter"=>adapter,
+          "host"=>"host",
+          "port"=>42,
+          "database"=>"db",
+          "username"=>"env",
+          "password"=>"env"
+        }
+      end
+
+      describe "for production" do
+        let(:db_config_prod) { [ adapter, 'host', '42', 'db', nil, nil ] }
+
+        it "should return proper value" do
+          env = 'production'
+          other_env = 'development'
+          ENV["RAILS_ENV"] = env
+
+          res = Cloudcontrol::reconfigure_database_configuration config
+          res[env].should include(expected_res)
+          res[other_env].should include(not_modified)
+        end
+      end
+
+      describe "for development" do
+        let(:db_config_dev) { [ adapter, 'host', '42', 'db', nil, nil ] }
+
+        it "should return proper value" do
+          env = 'development'
+          other_env = 'production'
+          ENV["RAILS_ENV"] = env
+
+          res = Cloudcontrol::reconfigure_database_configuration config
+          res[env].should include(expected_res)
+          res[other_env].should include(not_modified)
+        end
+      end
+    end
+
+    describe "with fully provided values" do
+      let(:db_config_prod) { [ adapter, 'host', '42', 'db', 'username', 'pass' ] }
+      let(:expected_res) do
+        {
+          "adapter"=>adapter,
+          "host"=>"host",
+          "port"=>42,
+          "database"=>"db",
+          "username"=>"username",
+          "password"=>"pass"
+        }
+      end
+
+      it "should return proper value" do
+        env = 'production'
+        ENV["RAILS_ENV"] = env
+        res = Cloudcontrol::reconfigure_database_configuration config
+        res[env].should include(expected_res)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: cloudcontrol-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Rösel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies: []
+description: Use credentials set in ENV vars if database.yml credentials are empty.
+  Supports MySQL and ElephantSQL (Postgres) on the cloudControl platform.
+email:
+- info@netzok.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- cloudcontrol-rails.gemspec
+- lib/cloudcontrol-rails.rb
+- lib/cloudcontrol/cloudcontrol.rb
+- lib/cloudcontrol/mysql.rb
+- lib/cloudcontrol/postgres.rb
+- spec/database_configuration_spec.rb
+- spec/spec_helper.rb
+homepage: http://justfrontend.com
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Autoload MySQL and Postgres credentials from ENV vars on cloudControl
+test_files: []