capistrano-postgresql 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2dac275e309610b300e6673f9494259d963d38e
+  data.tar.gz: 5226e2c5a19a04f6666a640bf8fdd24a9164a79f
+SHA512:
+  metadata.gz: dee66b2eb1e43e5128b9947303ff2f5dcd2a9430bde3aea592de5f0becfa9b5348dd1ff06c7d9c823fc3f58efef4731fedd26a2ad0e2ae8d9f8077b78a957661
+  data.tar.gz: ecd277b7db65cb20f815edcacd8a239c36e9c47d609e70217bcb3fa399b5598675bad75646c0f4c417a99492a622aa1c43d0bad183093c7d0d71cd23cfe70a6c

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+capistrano-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,179 @@
+# Capistrano::PostgreSQL
+
+**Note: this plugin works only with Capistrano 3.** Plase check the capistrano
+gem version you're using before installing this gem:
+`$ bundle show | grep capistrano`
+
+Plugin for Capistrano 2 [is here](https://github.com/bruno-/capistrano2-postgresql).
+
+### About
+
+Capistrano PostgreSQL plugin abstracts and speeds up common administration
+tasks for PostgreSQL when deploying rails apps.
+
+Here are the specific things this plugin does for your 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 'capistrano' ~> '3.1'
+      gem 'capistrano-postgresql'
+    end
+
+Install the gem with:
+
+    $ bundle install
+
+### Standard usage
+
+If you're deploying a standard rails app, all you need to do is put
+the following in `Capfile` file:
+
+    require 'capistrano/postgresql'
+
+Easy, right?
+
+Check below to see what happens in the background.
+
+### How it works
+
+Check here for the full capistrano deployment flow
+[http://capistranorb.com/documentation/getting-started/flow/](http://capistranorb.com/documentation/getting-started/flow/).
+
+The following tasks run automatically after `deploy:started` task:
+
+* `postgresql:create_database`<br/>
+creates a postgresql user and a database for your app. Password for the user is
+automatically generated and used in the next step.
+* `postgresql:generate_database_yml`<br/>
+creates a `database.yml` file and copies it to
+`#{shared_path}/config/database.yml` on the server.
+* `postgresql:ensure_database_yml_symlink`<br/>
+adds `config/database.yml` to the `linked_files` array. Capistrano handles
+symlinking `database.yml` to the application release path.
+
+The above tasks are all you need for getting rails app to work with PostgreSQL.
+
+### Gotchas
+
+Be sure to remove `config/database.yml` from your application's version control.
+
+### Debugging
+
+A debugging task is provided. Run `bundle exec <your_stage> cap postgres:debug`
+and you should get a list of all capistrano-postgresql settings and their
+values.
+
+I deeply hope you'll never need to use this, as this plugins strives to be
+very easy to use with minimal or no configuration.
+
+### Configuration
+
+This plugin should just work with no configuration whatsoever. However,
+configuration is possible. Put all your configs in capistrano stage files i.e.
+`config/deploy/production.rb`, `config/deploy/staging.rb`.
+
+Here's the list of options and the defaults for each option:
+
+* `set :postgresql_database`<br/>
+Name of the database for your app. Defaults to `#{application}_#{stage}`,
+example: `myface_production`.
+
+* `set :postgresql_user`<br/>
+Name of the database user. Defaults to whatever is set for `postgresql_database`
+option.
+
+* `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.<br/>
+If you set this option to `"some_secure_password"` - that will be the db user's
+password. Keep in mind that having a hardcoded password in `deploy.rb` (or
+anywhere in version control) is a bad practice.<br/>
+I recommend sticking to the default and generating a new secure and random
+password each time a db user is generated. That way you don't have to worry
+about it or try to remember it.
+
+* `set :postgresql_ask_for_password`<br/>
+Default `false`. 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`. 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:generate_database_yml` and `postgresql:ensure_database_yml_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/>
+`encoding` 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
+<%= fetch :stage %>:
+  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:
+
+    bundle exec 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 :postgresql_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/capistrano-postgresql.gemspec

@@ -0,0 +1,29 @@
+# -*- 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          = "capistrano-postgresql"
+  gem.version       = Capistrano::Postgresql::VERSION
+  gem.authors       = ["Bruno Sutic"]
+  gem.email         = ["bruno.sutic@gmail.com"]
+  gem.description   = <<-EOF.gsub(/^\s+/, '')
+    Capistrano tasks for PostgreSQL configuration and management for Rails
+    apps. Manages `database.yml` template on the server.
+
+    Works with Capistrano 3 (only!). For Capistrano 2 support see:
+    https://github.com/bruno-/capistrano2-postgresql
+  EOF
+  gem.summary       = %q{Creates application database user and `database.yml` on the server. No SSH login required!}
+  gem.homepage      = "https://github.com/bruno-/capistrano-postgresql"
+
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'capistrano', '~> 3.0'
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano/postgresql.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/postgresql.rake", __FILE__)

data/lib/capistrano/postgresql/version.rb

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

data/lib/capistrano/tasks/postgresql.rake

@@ -0,0 +1,180 @@
+require 'securerandom'
+require 'erb'
+
+def database_yml_template(template_name, target)
+  config_file = "#{fetch(:postgresql_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
+  upload! StringIO.new(ERB.new(File.read(config_file)).result(binding)), target
+end
+
+# This method is invoked only if `:postgresql_password` is not already set in
+# `config/deploy.rb`. Directly setting `:postgresql_password` has precedence.
+def ask_for_or_generate_password
+  if fetch(:postgresql_ask_for_password)
+    ask :postgresql_password, "Postgresql database password for the app: "
+  else
+    set :postgresql_password, generate_random_password
+  end
+end
+
+def generate_random_password
+  SecureRandom.hex(10)
+end
+
+def db_user_exists?(name)
+  psql "-tAc", %Q{"SELECT 1 FROM pg_roles WHERE rolname='#{name}';" | grep -q 1}
+end
+
+def create_db_user(name, password)
+  if psql "-c", %Q{"CREATE user #{name} WITH password '#{password}';"}
+    info "postgresq: database user '#{name}' created"
+  else
+    error "postgresql: creating database user failed!"
+    exit 1
+  end
+end
+
+def ensure_db_user_created(name, password)
+  unless db_user_exists?(name)
+    create_db_user(name, password)
+  end
+end
+
+def database_exists?(db_name)
+  psql "-tAc", %Q{"SELECT 1 FROM pg_database WHERE datname='#{db_name}';" | grep -q 1}
+end
+
+def create_database(db_name, user_name)
+  if psql "-c", %Q{"CREATE database #{db_name} owner #{user_name};"}
+    info "postgresql: database '#{db_name}' created"
+  else
+    error "postgresql: creating database '#{db_name}' failed!"
+    exit 1
+  end
+end
+
+def ensure_database_created(db_name, user_name)
+  unless database_exists?(db_name)
+    create_database(db_name, user_name)
+  end
+end
+
+# returns true or false depending on the remote command exit status
+def psql(*args)
+  test :sudo, "-u postgres psql", *args
+end
+
+def remote_file_exists?(path)
+  test "[ -e #{path} ]"
+end
+
+namespace :load do
+  task :defaults do
+    set :postgresql_database,   -> { "#{fetch(:application)}_#{fetch(:stage)}" }
+    set :postgresql_user,       -> { fetch(:postgresql_database) }
+    set :postgresql_password,   -> { ask_for_or_generate_password }
+    set :postgresql_ask_for_password, false
+    set :postgresql_default_tasks,    true
+
+    # template only settings (used in postgresql.yml.erb)
+    set :postgresql_templates_path,   "config/deploy/templates"
+    set :postgresql_pool,     5
+    set :postgresql_encoding, "unicode"
+    set :postgresql_host,     "localhost"
+  end
+end
+
+namespace :postgresql do
+
+  desc "Print all the variables"
+  task :debug do
+    puts "postgresql_database:         #{fetch(:postgresql_database)}"
+    puts "postgresql_user:             #{fetch(:postgresql_user)}"
+    puts "postgresql_password:         #{fetch(:postgresql_password)}"
+    puts "postgresql_ask_for_password: #{fetch(:postgresql_ask_for_password)}"
+    puts "postgresql_default_tasks:    #{fetch(:postgresql_default_tasks)}"
+    puts "postgresql_pool:             #{fetch(:postgresql_pool)}"
+    puts "postgresql_encoding:         #{fetch(:postgresql_encoding)}"
+    puts "postgresql_host              #{fetch(:postgresql_host)}"
+  end
+
+  # This task never runs automatically
+  # desc "Drop a database for this application"
+  task :drop_database do
+    on roles(:db) do
+      psql "-c", %Q{"DROP database #{fetch(:postgresql_database)};"}
+    end
+  end
+
+  # This task never runs automatically
+  # desc "Delete database user for this application"
+  task :delete_db_user do
+    on roles(:db) do
+      psql "-c", %Q{"DROP user #{fetch(:postgresql_user)};"}
+    end
+  end
+
+  # this task never runs automatically
+  # desc "Delete `config/database.yml` from the shared path on the server"
+  task :delete_database_yml do
+    on roles(:app) do
+      database_yml_path = shared_path.join("config/database.yml")
+      if remote_file_exists? database_yml_path
+        execute :rm, database_yml_path
+      end
+    end
+  end
+
+  # this task never runs automatically. DANGEROUS! Destroys database on the server!
+  # desc "Removes application database, DB user and removes `database.yml` from the server"
+  task remove_all: [:drop_database, :delete_db_user, :delete_database_yml]
+
+
+  desc "Create a database for this application"
+  task :create_database do
+    on roles(:db) do
+      ensure_db_user_created fetch(:postgresql_user), fetch(:postgresql_password)
+      ensure_database_created fetch(:postgresql_database), fetch(:postgresql_user)
+    end
+  end
+
+  desc "Generate the database.yml configuration file"
+  task :generate_database_yml do
+    on roles(:app) do
+      database_yml_path = shared_path.join("config/database.yml")
+      if remote_file_exists? database_yml_path
+        info "postgresql: database.yml already exists in the shared path"
+      else
+        info "postgresql: generating database.yml in shared path"
+        execute :mkdir, "-p", shared_path.join("config")
+        database_yml_template "postgresql.yml.erb", database_yml_path
+      end
+    end
+  end
+
+  desc "Adds `config/database.yml` to the linked_files array"
+  task :ensure_database_yml_symlink do
+    on roles(:app) do
+      if fetch(:linked_files).nil?
+        set :linked_files, ["config/database.yml"]
+      elsif !fetch(:linked_files).include? "config/database.yml"
+        fetch(:linked_files) << "config/database.yml"
+      end
+    end
+  end
+
+  after "deploy:started", "postgresql:started" do
+    # `postgresql_default_tasks` true by default -> capistrano-postgresql tasks
+    # run automatically on deploy
+    if fetch(:postgresql_default_tasks)
+      invoke "postgresql:create_database"
+      invoke "postgresql:generate_database_yml"
+      invoke "postgresql:ensure_database_yml_symlink"
+    end
+  end
+
+end

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

@@ -0,0 +1,11 @@
+To create local `database.yml.erb` template in a default path
+"config/deploy/templates" type this in your shell:
+
+    bundle exec rails generate capistrano:postgresql:template
+
+This is how you override the default path:
+
+    bundle exec rails generate capistrano:postgresql:template "config/templates"
+
+If you override templates path, don't forget to set "postgresql_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 @@
+<%= fetch :stage %>:
+  adapter: postgresql
+  encoding: <%= fetch :postgresql_encoding %>
+  database: <%= fetch :postgresql_database %>
+  pool: <%= fetch :postgresql_pool %>
+  username: <%= fetch :postgresql_user %>
+  password: '<%= fetch :postgresql_password %>'
+  host: <%= fetch :postgresql_host %>

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-postgresql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruno Sutic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: |
+  Capistrano tasks for PostgreSQL configuration and management for Rails
+  apps. Manages `database.yml` template on the server.
+  Works with Capistrano 3 (only!). For Capistrano 2 support see:
+  https://github.com/bruno-/capistrano2-postgresql
+email:
+- bruno.sutic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-postgresql.gemspec
+- lib/capistrano-postgresql.rb
+- lib/capistrano/postgresql.rb
+- lib/capistrano/postgresql/version.rb
+- lib/capistrano/tasks/postgresql.rake
+- 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-/capistrano-postgresql
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Creates application database user and `database.yml` on the server. No SSH
+  login required!
+test_files: []