pasqual 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b72c3b9c9bf68e2d65a72a8e52c21b23bae4d3c
-  data.tar.gz: baf933fc8e884fd46773c521c1b9b7daffed2443
+  metadata.gz: 16d0bb1110e38f1ff70ae8c108949c29052b8faa
+  data.tar.gz: 87c42ab7e84370f7d448117b227c717439c82e3f
 SHA512:
-  metadata.gz: dddc6b3cf7f6c86a1974c53aabc1db702b7f4cb5ae16a0adfee30f51abd63b3d921a3bb2480aea3db856ecb4b21fbbe2351b37b2379a3ff30c53f108e6db473a
-  data.tar.gz: c5e077062401bc2e0bc42d0f29839453715680070bab6582f03474af57f91912265954aa8cb50db5fb4ead9f66d5ad404ab6b9802eea20d4801fccca0c6cddef
+  metadata.gz: 74fbc561d80a6258ba47bb5ac43719d607cebedf6179160aac00d02f933d120152d40de391b98b93aa72ccd2d648cb46e7db82541bafaec95ce0af750f94d045
+  data.tar.gz: b9473965169ecb96b5368b21069f436c59308843e0fbaa0a514cb8b17b011470fb08893889868f4236b0be16088569f55eed272f9fb63a6d20d79d5d16113759

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+bin/rspec

data/README.md

@@ -1,6 +1,6 @@
 # Pasqual
 
-TODO: Write a gem description
+Run Postgres CLI commands with the help of database settings configured with environment variables.
 
 ## Installation
 
@@ -20,7 +20,54 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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
 

data/lib/pasqual/command.rb

@@ -4,20 +4,21 @@ module Pasqual
 
   class Command
 
-    def self.execute(program, username, password, host, port, name)
-      new(program, username, password, host, port, name).tap { |c| c.execute }
+    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,
+    attr_accessor :program, :username, :password, :host, :port, :name, :file,
       :output, :status
 
-    def initialize(program, username, password, host, port, name)
+    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
@@ -29,17 +30,27 @@ module Pasqual
 
       process.io.stdout = process.io.stderr = outfile
 
-      if password
-        # TODO: find out why piping to stdin doesn't work :(
-        ENV['PGPASSWORD'] = password
-        process.start
-        process.poll_for_exit(30)
-        ENV['PGPASSWORD'] = nil
-      else
-        process.start
-        process.poll_for_exit(30)
+      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.poll_for_exit(30)
+      ENV['PGPASSWORD'] = nil
+
       outfile.rewind
       self.output = outfile.read
       self.status = process.exit_code

data/lib/pasqual/database.rb

@@ -1,6 +1,7 @@
 require 'uri'
 require 'pasqual/createdb'
 require 'pasqual/dropdb'
+require 'pasqual/psql'
 
 module Pasqual
 
@@ -20,12 +21,20 @@ module Pasqual
       @port ||= 5432
     end
 
-    def createdb(name)
-      Createdb.execute username, password, host, port, name
+    def createdb(create_name = name)
+      Createdb.execute username, password, host, port, create_name
     end
 
-    def dropdb(name)
-      Dropdb.execute username, password, host, port, name
+    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)
+      Psql.pipe file, username, password, host, port, name
     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

@@ -1,3 +1,3 @@
 module Pasqual
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/pasqual.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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      = ""
+  spec.homepage      = "https://github.com/dkastner/pasqual"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/pasqual/database_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'securerandom'
 require 'pasqual/database'
 
 describe Pasqual::Database do
@@ -25,5 +26,28 @@ describe Pasqual::Database do
 
   end
 
+  describe '#command' do
+
+    it 'runs an sql command' do
+      expect do
+        database.command "SELECT 0;"
+      end.to_not raise_error
+    end
+
+  end
+
+  describe '#pipe_sql' do
+
+    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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pasqual
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Derek Kastner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-01 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -70,8 +70,7 @@ description: Shortcuts for postgres commands, with option to use ENV-configured
   URLs
 email:
 - dkastner@gmail.com
-executables:
-- rspec
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -80,19 +79,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/rspec
 - lib/pasqual.rb
 - lib/pasqual/arglist.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: ''
+homepage: https://github.com/dkastner/pasqual
 licenses:
 - MIT
 metadata: {}

data/bin/rspec

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rspec-core', 'rspec')