capistrano2-postgresql 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86c3ce349d28888d7be08ce28e2f4aabaf35f82d
+  data.tar.gz: 121784094558c83db48305d076e467776c881f4e
+SHA512:
+  metadata.gz: 49d4b1aecdcbc38733c2aaeb5eaa1a78b8ab38361021268e7e81525bf3a315cc36b1aa310e430f12131d0ba100931e77325128f7df7528a5028bccaa2013a7d8
+  data.tar.gz: 67d011e4f45bcd134cc8288ded9609570c0159920f81c7c0f5fae788d5d9f2398059ade15eeff2fcdba463b5dda67126a3a04c54da5b233be24838840c71daf7

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+capistrano2-postgresql is MIT licensed.
+
+Copyright (C) 2014 Bruno Sutic
+
+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,166 @@
+# Capistrano 2 PostgreSQL
+
+**Note: this plugin works only with Capistrano 2.** Plase check the capistrano
+gem version you're using before installing this gem:
+`$ bundle show | grep capistrano`
+
+Plugin for Capistrano 3 coming soon.
+
+### About
+
+Capistrano 2 PostgreSQL plugin abstracts and speeds up common administration
+tasks for PostgreSQL when deploying rails applications.
+
+Here are the specific things this plugin does for your rails app capistrano
+deployment process:
+
+* creates a new PostgreSQL database and database user on the server
+* generates and populates `database.yml` file with the right data on the server
+  (no need to ssh to the server and do this manually!)
+* no config necessary (or it's kept to a minimum)
+
+### Installation
+
+Put the following in your application's `Gemfile`:
+
+    group :development do
+      gem 'capistrano2-postgresql', require: false
+    end
+
+Install the gem with:
+
+    $ bundle install
+
+### Standard usage
+
+If you're deploying a standard rails app, all that you need to do is put
+the following in `config/deploy.rb` file:
+
+    require "capistrano-postgresql"
+
+Easy, right?
+
+Check below to see what happens in the background.
+
+### How it works
+
+The following tasks run automatically after `cap deploy:setup`:
+
+* `postgresql:create_database` creates a postgresql user and a database for
+  your app. Password for the user is automatically generated and used in the
+  next step.
+
+* `postgresql:setup` it creates a `database.yml` file and copies it to
+  `#{shared_path}/config/database.yml` on the server.
+
+The following task runs automatically after `cap deploy:cold` and each
+`cap deploy`:
+
+* `postgresql:symlink` ensures the `database.yml` from the previous step is
+  always symlinked to `config/database.yml` for new app release.
+
+The above tasks are all you need for getting rails app to work with PostgreSQL.
+
+### Gotchas
+
+Be sure to remove `database.yml` from your application's version control.
+
+### Configuration
+
+This plugin should just work with no configuration whatsoever. However,
+customization is possible. Here's the list of options and the defaults for each
+option:
+
+* `set :postgresql_user`<br/>
+Name of the database user. Defaults to `"#{capistrano_user}_#{application}"`
+which is most likely something like `deploy_myapp`.
+
+* `set :postgresql_database`<br/>
+Name of the database for your app. Defaults to `#{application}`.
+
+* `set :postgresql_password`<br/>
+Password for the database user. By default this option is not set and
+**new random password** is generated each time you create a new database.
+If you set this option to `"some_secure_password"` - that will be the db
+password. Keep in mind that having a hardcoded password in `deploy.rb` (or
+anywhere in version control) is a bad practice.
+I recommend sticking to the default and generating a new secure and random
+password each time a database is generated. That way you don't have to worry
+about it or try to remember it.
+
+* `set :postgresql_ask_for_password`, default `false`<br/>
+Set this option to `true` if you want to be prompted for the password when
+database user is created. This is safer than setting the password via
+`postgresql_password`, but the downside is you have to choose and remember
+yet another fricking password.<br/>
+`postgresql_password` option has precedence. If it is set,
+`postgresql_ask_for_password` is ignored.
+
+* `set :postgresql_default_tasks`<br/>
+This task determines whether capistrano tasks from this plugin are executed
+automatically during capistrano deploy process. Defaults to `true`. Tasks that
+are run automatically are: `postgresql:create_database`, `postgresql:setup` and
+`postgresql:symlink`.
+
+`database.yml` template-only settings:
+
+* `set :postgresql_pool`<br/>
+Pool config in `database.yml` template. Defaults to `5`.
+
+* `set :postgresql_host`<br/>
+`hostname` config in `database.yml` template. Defaults to `localhost`.
+
+* `set :postgresql_encoding`<br/>
+`encogind` config in `database.yml` template. Defaults to `unicode`.
+
+### Customizing the `database.yml` template
+
+This is the default `database.yml` template that gets copied to the capistrano
+shared directory on the server:
+
+```yml
+production:
+  adapter: postgresql
+  encoding: <%= postgresql_encoding %>
+  database: <%= postgresql_database %>
+  pool: <%= postgresql_pool %>
+  username: <%= postgresql_user %>
+  password: '<%= postgresql_password %>'
+  host: <%= postgresql_host %>
+```
+
+If for any reason you want to edit or tweak this template, you can copy it to
+`config/deploy/templates/postgresql.yml.erb` with this command:
+
+    rails g capistrano:postgresql:template
+
+After you edit this newly created file in your repo, it will be used as a
+template for `database.yml` on the server.
+
+You can configure the template location. For example:
+`set :templates_path, "config"` and the template will be copied to
+`config/postgresql.yml.erb`.
+
+### Contributing and bug reports
+
+Contributions and improvements are very welcome. Just open a pull request and
+I'll look it up shortly.
+
+If something is not working for you, or you find a bug please report it.
+
+### Thanks
+
+Here are other plugins and people this project was based upon:
+
+* [Matt Bridges](https://github.com/mattdbridges) - capistrano postgresql tasks
+from this plugin are heavily based on his
+[capistrano-recipes repo](https://github.com/mattdbridges/capistrano-recipes).
+
+* [Kalys Osmonom](https://github.com/kalys) - his
+[capistrano-nginx-unicorn](https://github.com/kalys/capistrano-nginx-unicorn)
+gem structure was an inspiration for this plugin. A lot of the features were
+directly copied from his project (example: `database.yml` template generator).
+
+### License
+
+[MIT](LICENSE.md)

data/Rakefile

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

data/capistrano2-postgresql.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/postgresql/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano2-postgresql"
+  gem.version       = Capistrano::Postgresql::VERSION
+  gem.authors       = ["Bruno Sutic"]
+  gem.email         = ["bruno.sutic@gmail.com"]
+  gem.description   = %q{Capistrano2 tasks for PostgreSQL configuration and management for Rails apps. Manages `database.yml` on the server. Works for Capistrano2. Does *not* support Capistrano3.}
+  gem.summary       = %q{Creates application database user and creates `database.yml` on the server. No SSH login required!}
+  gem.homepage      = "https://github.com/bruno-/capistrano2-postgresql"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '~> 2.0'
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano/postgresql/tasks.rb

@@ -0,0 +1,105 @@
+require 'capistrano'
+require 'securerandom'
+
+Capistrano::Configuration.instance.load do
+
+  def set_default(name, *args, &block)
+    set(name, *args, &block) unless exists?(name)
+  end
+
+  set_default(:postgresql_database) { application }
+  set_default(:postgresql_user)     { "#{user}_#{application}" }
+  set_default(:postgresql_ask_for_password, false)
+  set_default(:postgresql_password) { ask_for_or_generate_password }
+  set_default(:postgresql_default_tasks, true) # postgres tasks are done automatically
+
+  # template only settings (used in postgresql.yml.erb)
+  set_default(:postgresql_pool, 5)
+  set_default(:postgresql_encoding, "unicode")
+  set_default(:postgresql_host, "localhost")
+
+  set_default(:templates_path, "config/deploy/templates")
+
+  namespace :postgresql do
+
+    desc "Install the latest stable release of PostgreSQL."
+    task :install, roles: :db, only: { primary: true } do
+      run "#{sudo} add-apt-repository ppa:pitti/postgresql"
+      run "#{sudo} apt-get -y update"
+      run "#{sudo} apt-get -y install postgresql libpq-dev"
+    end
+
+    desc "Drop a database for this application."
+    task :drop_database, roles: :db, only: { primary: true } do
+      run %Q{#{psql} -c "drop database #{postgresql_database};"}
+      run %Q{#{psql} -c "drop user #{postgresql_user};"}
+    end
+
+    desc "Create a database for this application."
+    task :create_database, roles: :db, only: { primary: true } do
+      ensure_db_user_created(postgresql_user, postgresql_password)
+      ensure_database_created(postgresql_database, postgresql_user)
+    end
+
+    desc "Generate the database.yml configuration file."
+    task :setup, roles: :app do
+      run "mkdir -p #{shared_path}/config"
+      unless remote_file_exists?("#{shared_path}/config/database.yml")
+        database_yml_template "postgresql.yml.erb", "#{shared_path}/config/database.yml"
+      end
+    end
+
+    desc "Symlink the database.yml file into latest release"
+    task :symlink, roles: :app do
+      run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml"
+    end
+
+    if postgresql_default_tasks
+      after "deploy:setup",           "postgresql:create_database"
+      after "deploy:setup",           "postgresql:setup"
+      after "deploy:finalize_update", "postgresql:symlink"
+    end
+  end
+
+  def database_yml_template(template_name, target)
+    config_file = "#{templates_path}/#{template_name}"
+    # If there's no customized file in your rails app template directory,
+    # proceed with the default.
+    unless File.exists?(config_file)
+      config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/postgresql/templates/#{template_name}")
+    end
+    put ERB.new(File.read(config_file)).result(binding), target
+  end
+
+  def ask_for_or_generate_password
+    if postgresql_ask_for_password
+      Capistrano::CLI.ui.ask "Postgresql database password for the app: "
+    else
+      generate_random_password
+    end
+  end
+
+  def generate_random_password
+    SecureRandom.hex(10)
+  end
+
+  # Checks if DB user already exits. If not - creates DB user.
+  def ensure_db_user_created(name, password)
+    run %Q{#{psql} -tAc "SELECT 1 FROM pg_roles WHERE rolname='#{name}';" | grep -q 1 || \
+      #{psql} -c "create user #{name} with password '#{password}';"}
+  end
+
+  # Checks if database already exits. If not - creates database.
+  def ensure_database_created(db_name, user_name)
+    run %Q{#{psql} -tAc "SELECT 1 FROM pg_database WHERE datname='#{db_name}';" | grep -q 1 || \
+      #{psql} -c "create database #{db_name} owner #{user_name};"}
+  end
+
+  def psql
+    %Q{#{sudo} -u postgres psql}
+  end
+
+  def remote_file_exists?(path)
+    capture("if [ -e #{path} ]; then echo 'true'; fi").strip == 'true'
+  end
+end

data/lib/capistrano/postgresql/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Postgresql
+    VERSION = "1.0.0"
+  end
+end

data/lib/capistrano-postgresql.rb

@@ -0,0 +1,2 @@
+require "capistrano/postgresql/version"
+require "capistrano/postgresql/tasks"

data/lib/generators/capistrano/postgresql/README.md

@@ -0,0 +1,10 @@
+To create local `database.yml.erb` template in a default path
+"config/deploy/templates" type this in your shell:
+
+    rails generate capistrano:postgresql:template
+
+This is how you override the default path:
+
+    rails generate capistrano:postgresql:template "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/capistrano/postgresql/template_generator.rb

@@ -0,0 +1,19 @@
+module Capistrano
+  module Postgresql
+    module Generators
+      class TemplateGenerator < Rails::Generators::Base
+
+        desc "Create local postgresql.yml.erb (database.yml on the server) template file for customization"
+        source_root File.expand_path('../templates', __FILE__)
+        argument :templates_path, type: :string,
+          default: "config/deploy/templates",
+          banner: "path to templates"
+
+        def copy_template
+          copy_file "postgresql.yml.erb", "#{templates_path}/postgresql.yml.erb"
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/capistrano/postgresql/templates/postgresql.yml.erb

@@ -0,0 +1,8 @@
+production:
+  adapter: postgresql
+  encoding: <%= postgresql_encoding %>
+  database: <%= postgresql_database %>
+  pool: <%= postgresql_pool %>
+  username: <%= postgresql_user %>
+  password: '<%= postgresql_password %>'
+  host: <%= postgresql_host %>

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: capistrano2-postgresql
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bruno Sutic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Capistrano2 tasks for PostgreSQL configuration and management for Rails
+  apps. Manages `database.yml` on the server. Works for Capistrano2. Does *not* support
+  Capistrano3.
+email:
+- bruno.sutic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano2-postgresql.gemspec
+- lib/capistrano-postgresql.rb
+- lib/capistrano/postgresql/tasks.rb
+- lib/capistrano/postgresql/version.rb
+- lib/generators/capistrano/postgresql/README.md
+- lib/generators/capistrano/postgresql/template_generator.rb
+- lib/generators/capistrano/postgresql/templates/postgresql.yml.erb
+homepage: https://github.com/bruno-/capistrano2-postgresql
+licenses: []
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Creates application database user and creates `database.yml` on the server.
+  No SSH login required!
+test_files: []