seamus-pasqual 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b6ea3b9ef075f0d38fd1211c83e1ac7ca6ac288
+  data.tar.gz: 2d68abe021da7274c9ec7d47ebca6dfd57099830
+SHA512:
+  metadata.gz: 518ac9fc203fa42988edd8361931c24c64958b8bd8ebc32a0d00b23df71d4109bdcdd33780e372b814917e0f7280586fb788a8af1714114a4e9c7b91249ddbee
+  data.tar.gz: 72e5ee83324396b9ff12eb47ba738639914b91fc9f545a42b3fbb19fb7924b24fa723f94ace4902f662801e63dc2ef6122e004124c525f4ae34b9cd3858fd0df

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+bin/rspec

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.1
+
+addons:
+  postgresql: "9.3"
+
+env: DATABASE_URL=postgres://postgres@localhost:5432/pasqual_test
+
+script: bundle exec rspec spec

data/CHANGELOG

@@ -0,0 +1,15 @@
+* 0.2.2 - 2017-10-13
+
+  * Enhancements
+
+    * No more arbitrary 30-second limit
+
+* 0.2.0 - 2015-05-06
+
+  * Enhancements
+
+    * Add pasqual bin
+
+* 0.1.3 - 2015-03-16
+
+  * Added more detailed failure message on createdb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Derek Kastner
+
+MIT License
+
+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,80 @@
+# Pasqual
+
+Run Postgres CLI commands with the help of database settings configured with environment variables.
+
+![](https://travis-ci.org/dkastner/pasqual.svg?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pasqual'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pasqual
+
+## Usage
+
+First, get an instance of Pasqual: 
+
+``` ruby
+psql = Pasqual.for ENV['DATABASE_URL']
+```
+
+### createdb
+
+Createdb automatically uses the database name defined in `ENV`.
+
+```ruby
+psql.createdb
+```
+
+A custom name can optionally be specified:
+
+```ruby
+psql.createdb 'foodb'
+```
+
+### dropdb
+
+Dropdb automatically uses the database name defined in `ENV`.
+
+```ruby
+psql.dropdb
+```
+A custom name can optionally be specified:
+
+```ruby
+psql.dropdb 'foodb'
+```
+
+### command
+
+Executes an SQL script, the same as piping text into the psql command.
+
+```ruby
+psql.command "SELECT * from users;"
+```
+
+### pipe
+
+You can pipe a file into the `psql` command:
+
+```ruby
+psql.pipe_sql '/path/to/file.sql'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pasqual/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/pasqual

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'pasqual/cli'
+Pasqual::CLI.start ARGV

data/lib/pasqual.rb

@@ -0,0 +1,14 @@
+require "pasqual/version"
+require 'pasqual/database'
+
+module Pasqual
+
+  def self.new
+    self.for ENV['DATABASE_URL']
+  end
+
+  def self.for(url)
+    Database.new url
+  end
+
+end

data/lib/pasqual/arglist.rb

@@ -0,0 +1,19 @@
+module Pasqual
+
+  module Arglist
+
+    def self.args(username, password, host, port, name)
+      list = []
+      list << '-h' << host if host.to_s.length > 0
+      list << '-U' << username if username.to_s.length > 0
+      list << '-p' << port.to_s if port.to_s.length > 0
+      list << '-w' if password.to_s.length == 0
+      list << '--no-psqlrc'
+      list << '--pset' << 'pager=off'
+
+      list + [name]
+    end
+    
+  end
+
+end

data/lib/pasqual/cli.rb

@@ -0,0 +1,118 @@
+require 'thor'
+
+require 'pasqual'
+
+module Pasqual
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "create DATABASE_URL", "create database"
+    def create(url = nil)
+      puts "Creating #{pasqual(url).name}"
+      pasqual(url).createdb
+    rescue Pasqual::Createdb::AlreadyExists
+      puts "#{pasqual(url).name} already exists, skipped creation"
+    end
+
+    desc "drop DATABASE_URL", "drop database"
+    def drop(url = nil)
+      puts "Dropping #{pasqual(url).name}"
+      pasqual(url).dropdb
+    rescue Pasqual::Dropdb::Failed
+      puts "Could not drop #{pasqual(url).name}, skipped"
+    end
+
+    desc "poll DATABASE_URL", "poll for the existence of a database server"
+    def poll(url = nil)
+      say "Waiting for Postgres to come available"
+      if attempt_connect(url)
+        say "Connected!"
+        exit 0
+      else
+        say "Failed to connect"
+        exit 1
+      end
+    end
+
+    desc "reset [SQL_FILE] [DATABASE_URL]", "drop, create, structure"
+    def reset(path = nil, url = nil)
+      drop(url)
+      create(url)
+      file(path, url) if path
+    end
+
+    desc "psql [SQL] [DATABASE_URL]", "start a psql console or run an SQL statement"
+    def psql(*cmd_args)
+      url = nil
+      sql_args = []
+      cmd_args.each do |arg|
+        if arg =~ /postgres:/
+          url = arg
+        else
+          sql_args << arg
+        end
+      end
+      db = pasqual(url)
+      args = Pasqual::Arglist.
+        args(db.username, db.password, db.host, db.port, db.name)
+      if sql_args.any?
+        args << '-c'
+        args += sql_args.map(&:inspect)
+        puts "Executing in #{db.name}: #{sql_args.inspect}"
+      else
+        cmd = "psql #{args.join(' ')}"
+      end
+      puts "Running #{cmd}"
+      Kernel.exec({ 'PGPASSWORD' => db.password }, "psql #{args.join(' ')}")
+    end
+
+    
+    desc "file PATH [DATABASE_URL]", "execute an SQL script in a file"
+    def file(path, url = nil)
+      puts "Structuring #{pasqual(url).name}"
+      pasqual(url).pipe_sql path
+    rescue Errno::EPIPE
+      puts "#{pasqual(url).name} doesn't exist, skipped structure"
+    end
+
+    private
+
+    def pasqual(url)
+      @pasqual ||= Pasqual.for(url || ENV['DATABASE_URL'])
+    end
+
+    def pg_connection(url, no_db: false)
+      db = pasqual(url)
+      conn = PG::Connection.connect_start(
+        host: db.host,
+        port: db.port,
+        dbname: no_db ? nil : db.name,
+        user: db.username,
+        password: db.password,
+        connect_timeout: (60 * 5))
+    end
+
+    def attempt_connect(url)
+      require 'pg'
+
+      timeout = Time.now.to_i + (60 * 5)
+
+      # Don't connect to a specific database because we may be polling the
+      # the server to know whether we can _create_ a database yet.
+      conn = pg_connection(url, no_db: true)
+      status = conn.connect_poll
+      while(Time.now.to_i < timeout && status != PG::PGRES_POLLING_OK) do
+        sleep 2
+        status = conn.connect_poll
+
+        conn = pg_connection(url, no_db: true) if status == PG::PGRES_POLLING_FAILED
+        puts "Status: #{status.inspect}, Timeout: #{Time.now.to_i - timeout}" if ENV['DEBUG']
+      end
+      conn.finish
+      status == PG::PGRES_POLLING_OK
+    end
+
+  end
+end

data/lib/pasqual/command.rb

@@ -0,0 +1,65 @@
+require 'pasqual/arglist'
+
+module Pasqual
+
+  class Command
+
+    def self.execute(program, username, password, host, port, name, file = nil)
+      new(program, username, password, host, port, name, file).tap { |c| c.execute }
+    end
+
+    attr_accessor :program, :username, :password, :host, :port, :name, :file,
+      :output, :status
+
+    def initialize(program, username, password, host, port, name, file = nil)
+      self.program = program
+      self.username = username
+      self.password = password
+      self.host = host
+      self.port = port
+      self.name = name
+      self.file = file
+    end
+
+    def execute
+      outfile = Tempfile.new("pasqual-#{name}")
+      outfile.sync = true
+
+      process = ChildProcess.build program,
+        *Arglist.args(username, password, host, port, name)
+
+      process.io.stdout = process.io.stderr = outfile
+
+      process.duplex = true if file
+
+      # TODO: find out why piping to stdin doesn't work :(
+      ENV['PGPASSWORD'] = password
+      process.start
+
+      if file && File.exist?(file)
+        File.open file do |f|
+          process.io.stdin.puts f.read
+          process.io.stdin.flush
+        end
+        process.io.stdin.close
+      elsif file
+        process.io.stdin.puts file
+        process.io.stdin.flush
+        process.io.stdin.close
+      end
+
+      process.wait
+      ENV['PGPASSWORD'] = nil
+
+      outfile.rewind
+      self.output = outfile.read
+      self.status = process.exit_code
+    end
+
+    def success?
+      status == 0
+    end
+
+  end
+
+end

data/lib/pasqual/createdb.rb

@@ -0,0 +1,22 @@
+require 'childprocess'
+require 'tempfile'
+
+require 'pasqual/command'
+
+module Pasqual
+
+  module Createdb
+    class AlreadyExists < StandardError; end
+    class Failed < StandardError; end
+
+    def self.execute(username, password, host, port, name)
+      cmd = Command.execute 'createdb', username, password, host, port, name
+
+      raise AlreadyExists if cmd.output =~ /already exists/
+      raise(Failed, cmd.output) unless cmd.success?
+      true
+    end
+
+  end
+
+end

data/lib/pasqual/database.rb

@@ -0,0 +1,42 @@
+require 'uri'
+require 'pasqual/createdb'
+require 'pasqual/dropdb'
+require 'pasqual/psql'
+
+module Pasqual
+
+  class Database
+    attr_reader :username, :password, :host, :port, :name
+
+    def initialize(url)
+      uri = URI.parse url
+      @username = uri.user
+      @password = uri.password
+      @host = uri.host
+      @port = uri.port
+      @name = uri.path.sub(/^\//, '')
+    end
+
+    def port
+      @port ||= 5432
+    end
+
+    def createdb(create_name = name)
+      Createdb.execute username, password, host, port, create_name
+    end
+
+    def dropdb(drop_name = name)
+      Dropdb.execute username, password, host, port, drop_name
+    end
+
+    def command(statement)
+      Psql.command statement, username, password, host, port, name
+    end
+
+    def pipe_sql(file, dbname = name)
+      Psql.pipe file, username, password, host, port, dbname
+    end
+
+  end
+
+end

data/lib/pasqual/dropdb.rb

@@ -0,0 +1,20 @@
+require 'childprocess'
+require 'tempfile'
+
+require 'pasqual/command'
+
+module Pasqual
+
+  module Dropdb
+    class Failed < StandardError; end
+
+    def self.execute(username, password, host, port, name)
+      cmd = Command.execute 'dropdb', username, password, host, port, name
+
+      raise Failed unless cmd.success?
+      true
+    end
+
+  end
+
+end

data/lib/pasqual/psql.rb

@@ -0,0 +1,22 @@
+module Pasqual
+
+  module Psql
+    class Failed < StandardError; end
+
+    def self.pipe(file, username, password, host, port, name)
+      cmd = Command.execute 'psql', username, password, host, port, name, file
+
+      raise Failed unless cmd.success?
+      true
+    end
+
+    def self.command(statement, username, password, host, port, name)
+      cmd = Command.execute 'psql', username, password, host, port, name, statement
+
+      raise Failed unless cmd.success?
+      cmd.output
+    end
+
+  end
+
+end

data/lib/pasqual/version.rb

@@ -0,0 +1,3 @@
+module Pasqual
+  VERSION = "0.2.2"
+end

data/pasqual.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pasqual/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seamus-pasqual"
+  spec.version       = Pasqual::VERSION
+  spec.authors       = ["Derek Kastner"]
+  spec.email         = ["dkastner@gmail.com"]
+  spec.summary       = %q{Interface easily with postgres CLI tools}
+  spec.description   = %q{Shortcuts for postgres commands, with option to use ENV-configured conenction URLs}
+  spec.homepage      = "https://github.com/dkastner/pasqual"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "childprocess", "~> 0.5"
+  spec.add_runtime_dependency "thor", "~> 0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+end

data/spec/pasqual/database_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'securerandom'
+require 'pasqual/database'
+
+describe Pasqual::Database do
+  let(:database) { Pasqual::Database.new ENV['DATABASE_URL'] }
+
+  describe '#createdb' do
+    let(:name) { SecureRandom.hex(10) }
+
+    after :each do
+      database.dropdb name
+    end
+
+    it 'creates a database' do
+      expect(database.createdb(name)).to be true
+    end
+
+    it 'raises an error if a database already exists' do
+      database.createdb name
+
+      expect do
+        database.createdb name
+      end.to raise_error(Pasqual::Createdb::AlreadyExists)
+    end
+
+  end
+
+  describe '#command' do
+    before { database.createdb rescue Pasqual::Dropdb::Failed }
+
+    it 'runs an sql command' do
+      expect do
+        database.command "SELECT 0;"
+      end.to_not raise_error
+    end
+
+  end
+
+  describe '#pipe_sql' do
+    before { database.createdb rescue Pasqual::Dropdb::Failed }
+
+    it 'runs an sql script file' do
+      file = Tempfile.new 'sql-script'
+      file.puts "SELECT 0;"
+
+      expect do
+        database.pipe_sql file.path
+      end.to_not raise_error
+    end
+
+  end
+
+end
+

data/spec/pasqual_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'securerandom'
+require 'pasqual'
+
+describe Pasqual do
+
+  describe '.new' do
+
+    it 'returns a Pasqual::Database configured for a URL' do
+      p = Pasqual.new
+      expect(p).to be_a(Pasqual::Database)
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |file| require file }
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: seamus-pasqual
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Derek Kastner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Shortcuts for postgres commands, with option to use ENV-configured conenction
+  URLs
+email:
+- dkastner@gmail.com
+executables:
+- pasqual
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pasqual
+- lib/pasqual.rb
+- lib/pasqual/arglist.rb
+- lib/pasqual/cli.rb
+- lib/pasqual/command.rb
+- lib/pasqual/createdb.rb
+- lib/pasqual/database.rb
+- lib/pasqual/dropdb.rb
+- lib/pasqual/psql.rb
+- lib/pasqual/version.rb
+- pasqual.gemspec
+- spec/pasqual/database_spec.rb
+- spec/pasqual_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dkastner/pasqual
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Interface easily with postgres CLI tools
+test_files:
+- spec/pasqual/database_spec.rb
+- spec/pasqual_spec.rb
+- spec/spec_helper.rb