postgressor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac951676c1041a11f52a59de5c58154648a6d77a0a4d5828b8ac4a8045c352d9
+  data.tar.gz: b87bcf598f561ab1385de799a705417bc7d153f560f47fee655f7067de6775d6
+SHA512:
+  metadata.gz: e971443893ae079d788c7b598dc635c0e887218ace8eac059932bfe30969168c98e1ca363c677524ba89af9b0418276d78efe32725faeca4f642f8a26731847c
+  data.tar.gz: b4778abdf4caa5e930982bb324ebed27a29350d47cd09d28b14b5d2916025e146699e4c98a002be05f1e0166908356a5699db44db22f03803355f7fd6e4eb260

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in postgressor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Victor Afanasev
+
+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,115 @@
+# Postgressor
+
+Get tired of typing the same commands over and over like creating Postgres user, database, creating and restoring database backups? Postgressor allow you to manage your (Postgres) application database and user within simple commands:
+
+```
+$ postgressor -h
+Commands:
+  postgressor createuser      # Create app database user
+  postgressor dropuser        # Drop app database user
+  postgressor createdb        # Create app database
+  postgressor dropdb          # Drop app database
+  postgressor dumpdb          # Dump (backup) app database
+  postgressor restoredb       # Restore app database from backup
+
+  postgressor --version, -v   # Print the version
+  postgressor help [COMMAND]  # Describe available commands or one specific command
+```
+
+All what you need is DATABASE_URL in format like: `DATABASE_URL="postgres://app_user:app_user_pass@host/app_db_name"`. Also Postgressor automatically check `.env` file (if present) **to read DATABASE_URL from there.**
+
+## Installation
+
+> Posgressor requires Ruby `>= 2.3.0`.
+
+To install:
+
+```
+$ gem install postgressor
+```
+
+## Usage
+
+> Use `VERBOSE=true` env option (used in examples below) to print postgres commands which will be executed
+
+### createuser and dropuser
+
+To create user:
+
+> You can provide `--superuser` option to create user as SUPERUSER
+
+```
+$ DATABASE_URL="postgres://app_user:123456@localhost/app_db" VERBOSE=true postgressor createuser
+
+Executing: sudo -i -u postgres psql -c CREATE USER app_user WITH CREATEDB LOGIN PASSWORD '123456';
+CREATE ROLE
+Created user app_user
+```
+
+To drop user:
+
+```
+$ DATABASE_URL="postgres://app_user:123456@localhost/app_db" VERBOSE=true postgressor dropuser
+
+Executing: sudo -i -u postgres dropuser app_user
+Dropped user app_user
+```
+
+### createdb and dropdb
+
+To create database:
+
+```
+$ DATABASE_URL="postgres://app_user:123456@localhost/app_db" VERBOSE=true postgressor createdb
+
+Executing: PGPASSWORD=123456 createdb app_db -h localhost -U app_user
+Created database app_db
+```
+
+To drop database:
+
+```
+$ DATABASE_URL="postgres://app_user:123456@localhost/app_db" VERBOSE=true postgressor dropdb
+
+Executing: PGPASSWORD=123456 dropdb app_db -h localhost -U app_user
+Dropped database app_db
+```
+
+### dumpdb and restoredb
+
+To perform database backup to the current directory:
+
+```
+$ DATABASE_URL="postgres://app_user:123456@localhost/app_db" VERBOSE=true postgressor dumpdb
+
+Executing: PGPASSWORD=123456 pg_dump app_db -Fc --no-acl --no-owner -f app_db.dump -h localhost -U app_user
+Dumped database app_db to app_db.dump file
+```
+
+To restore database from backup file:
+
+> Note: sometimes backup restore will fail if current user is not superuser, so there is option `--switch_to_superuser` to temporary switch user to SUPERUSER
+
+> Note: recreate (drop and create) database before restore to omit some possible errors
+
+```
+$ DATABASE_URL="postgres://app_user:123456@localhost/app_db" VERBOSE=true postgressor restoredb app_db.dump --switch_to_superuser
+
+Executing: sudo -i -u postgres psql -c ALTER ROLE app_user SUPERUSER;
+ALTER ROLE
+Set user app_user to SUPERUSER
+Executing: PGPASSWORD=123456 pg_restore app_db.dump -d app_db --no-acl --no-owner --verbose -h localhost -U app_user
+pg_restore: connecting to database for restore
+pg_restore: creating SCHEMA "public"
+pg_restore: creating COMMENT "SCHEMA public"
+pg_restore: creating EXTENSION "plpgsql"
+pg_restore: creating COMMENT "EXTENSION plpgsql"
+Restored database app_db from app_db.dump file
+Executing: sudo -i -u postgres psql -c ALTER ROLE app_user NOSUPERUSER;
+ALTER ROLE
+Set user app_user to NOSUPERUSER
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "postgressor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/postgressor

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'postgressor'
+require 'postgressor/cli'
+
+Postgressor::CLI.start(ARGV)

data/lib/postgressor/cli.rb

@@ -0,0 +1,151 @@
+require 'uri'
+require 'thor'
+require 'dotenv/load'
+
+module Postgressor
+  class CLI < Thor
+    # https://www.postgresql.org/docs/current/app-createuser.html
+    desc "createuser", "Create app database user"
+    option :superuser, type: :string, banner: "Create user as superuser"
+    def createuser
+      preload!
+
+      # Use psql `CREATE USER` instead of `createuser` CLI command, to automatically provide user password:
+      is_superuser = "SUPERUSER" if options[:superuser]
+      psql_command = "CREATE USER #{@conf[:user]} WITH CREATEDB LOGIN #{is_superuser} PASSWORD '#{@conf[:password]}';"
+
+      command = %W(sudo -i -u postgres psql -c #{psql_command})
+      if execute command
+        say "Created user #{@conf[:user]}", :green
+      end
+    end
+
+    # https://www.postgresql.org/docs/current/app-dropuser.html
+    desc "dropuser", "Drop app database user"
+    def dropuser
+      preload!
+
+      command = %W(sudo -i -u postgres dropuser #{@conf[:user]})
+      if execute command
+        say "Dropped user #{@conf[:user]}", :green
+      end
+    end
+
+    ###
+
+    # https://www.postgresql.org/docs/current/app-createdb.html
+    desc "createdb", "Create app database"
+    def createdb
+      preload!
+
+      command = ["createdb", @conf[:db]] + @pg_cli_args
+      if execute command, with_env: true
+        say "Created database #{@conf[:db]}", :green
+      end
+    end
+
+    # https://www.postgresql.org/docs/current/app-dropdb.html
+    desc "dropdb", "Drop app database"
+    def dropdb
+      preload!
+
+      command = ["dropdb", @conf[:db]] + @pg_cli_args
+      if execute command, with_env: true
+        say "Dropped database #{@conf[:db]}", :green
+      end
+    end
+
+    ###
+
+    # https://www.postgresql.org/docs/current/app-pgdump.html
+    desc "dumpdb", "Dump (backup) app database"
+    def dumpdb
+      preload!
+
+      dump_file_name = "#{@conf[:db]}.dump"
+      command = %W(pg_dump #{@conf[:db]} -Fc --no-acl --no-owner -f #{dump_file_name}) + @pg_cli_args
+
+      if execute command, with_env: true
+        say "Dumped database #{@conf[:db]} to #{dump_file_name} file", :green
+      end
+    end
+
+    # https://www.postgresql.org/docs/current/app-pgrestore.html
+    desc "restoredb", "Restore app database from backup"
+    option :switch_to_superuser, type: :string, banner: "Temporary switch user to SUPERUSER while restoring db"
+    def restoredb(dump_file_path)
+      preload!
+
+      set_user_to_superuser if options[:switch_to_superuser]
+
+      command = %W(pg_restore #{dump_file_path} -d #{@conf[:db]} --no-acl --no-owner --verbose) + @pg_cli_args
+      if execute command, with_env: true
+        say "Restored database #{@conf[:db]} from #{dump_file_path} file", :green
+      end
+
+      set_user_to_nosuperuser if options[:switch_to_superuser]
+    end
+
+    ###
+
+    map %w[--version -v] => :__print_version
+    desc "--version, -v", "Print the version"
+    def __print_version
+      puts VERSION
+    end
+
+    private
+
+    def set_user_to_superuser
+      psql_command = "ALTER ROLE #{@conf[:user]} SUPERUSER;"
+      command = %W(sudo -i -u postgres psql -c #{psql_command})
+      if execute command
+        say "Set user #{@conf[:user]} to SUPERUSER", :green
+      end
+    end
+
+    def set_user_to_nosuperuser
+      psql_command = "ALTER ROLE #{@conf[:user]} NOSUPERUSER;"
+      command = %W(sudo -i -u postgres psql -c #{psql_command})
+      if execute command
+        say "Set user #{@conf[:user]} to NOSUPERUSER", :green
+      end
+    end
+
+    def execute(command, with_env: false)
+      if with_env
+        verbose_command = env.map { |k, v| "#{k}=#{v}" } + command
+        say("Executing: #{verbose_command.join(' ')}", :yellow) if ENV["VERBOSE"] == "true"
+
+        system env, *command
+      else
+        say("Executing: #{command.join(' ')}", :yellow) if ENV["VERBOSE"] == "true"
+        system *command
+      end
+    end
+
+    def env
+      { "PGPASSWORD" => @conf[:password] }
+    end
+
+    def preload!
+      url = ENV["DATABASE_URL"]
+      raise "Env variable DATABASE_URL is not provided" if url.nil? || url.strip.empty?
+
+      uri = URI.parse(url)
+      raise "DB adapter is not postgres" if uri.scheme != "postgres"
+
+      @conf = {
+        url: url,
+        db: uri.path.sub("/", ""),
+        host: uri.host,
+        port: uri.port,
+        user: uri.user,
+        password: uri.password
+      }
+
+      @pg_cli_args = ["-h", @conf[:host], "-U", @conf[:user]]
+      @pg_cli_args += ["-p", @conf[:port].to_s] if @conf[:port]
+    end
+  end
+end

data/lib/postgressor/version.rb

@@ -0,0 +1,3 @@
+module Postgressor
+  VERSION = "0.1.0"
+end

data/lib/postgressor.rb

@@ -0,0 +1,6 @@
+require "postgressor/version"
+
+module Postgressor
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/postgressor.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "postgressor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "postgressor"
+  spec.version       = Postgressor::VERSION
+  spec.authors       = ["Victor Afanasev"]
+  spec.email         = ["vicfreefly@gmail.com"]
+
+  spec.summary       = "Manage your application Postgres user and database easily using simple CLI commands"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/vifreefly/postgressor"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = "postgressor"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency "thor"
+  spec.add_dependency "dotenv"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: postgressor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Afanasev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Manage your application Postgres user and database easily using simple
+  CLI commands
+email:
+- vicfreefly@gmail.com
+executables:
+- postgressor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/postgressor
+- lib/postgressor.rb
+- lib/postgressor/cli.rb
+- lib/postgressor/version.rb
+- postgressor.gemspec
+homepage: https://github.com/vifreefly/postgressor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Manage your application Postgres user and database easily using simple CLI
+  commands
+test_files: []