justonedb 1.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 JustOneDB, Inc.
+
+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.rdoc

@@ -0,0 +1,46 @@
+= JustOneDB Command Line Interface
+
+The JustOneDB CLI is used to handle data migrations for JustOneDB Cloud Services accessed via Heroku
+
+For more information, see <http://www.justonedb.com>.
+
+For platform specific details, go to the following
+
+* Heroku, see <http://www.justonedb.com/heroku>.
+
+== Pre-Requisites
+
+The PostgreSQL client program 'pg_dump' must be installed in order to use the migrate function.
+
+== Installation
+
+    $ gem install justonedb
+
+== Commands
+
+* Migrate JustOneDB database from current to 'NEW' on Heroku
+
+    $ justonedb heroku migrate
+	
+    Extracting data from JUSTONEDB_DBI_URL using pg_dump
+    Importing data into JUSTONEDB_NEW_DBI_URL using psql
+    Data imported successfully, please fully check your application before running 'justonedb heroku promote'
+
+* Promote 'NEW' variables to current
+
+    $ justonedb heroku promote
+    Promoting JustOneDB 'NEW' vars to current, and saving current to 'OLD'
+    Variables modified, please check that your application works correctly, before running 'justonedb heroku purge-old'
+
+* Purge 'OLD' variables
+
+    $ justonedb heroku purge-old
+    Purging JustOneDB 'OLD' configuration variables
+
+== License
+
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).
+
+== Credits
+
+Created by Daryl Waycott

data/bin/justonedb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'justonedb/command'
+
+args = ARGV.dup
+ARGV.clear
+
+JustOneDB::Command.load
+
+begin
+	platform = args.shift.strip
+	command = args.shift.strip
+
+	rescue
+		JustOneDB::Command.help
+		exit
+end
+
+JustOneDB::Command.run(platform, command, args)

data/justonedb-1.0.0.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |spec|
+	spec.name = "justonedb"
+	spec.version = "1.0.0"
+
+	spec.authors = ["JustOneDB"]
+	spec.date = "2012-01-18"
+	spec.description = "Command-line tool for JustOneDB to assist in deployments on Heroku"
+	spec.email = "support@justonedb.com"
+	spec.executables = ["justonedb"]
+	spec.files = `svn ls -R`.split("\n")
+	spec.homepage = "http://www.justonedb.com/"
+	spec.require_paths = ['lib']
+	spec.rubygems_version = "1.8.10"
+	spec.summary = "Command-line tool for JustOneDB database deployed on Heroku, or AppHarbor."
+
+	spec.required_rubygems_version = Gem::Requirement.new(">= 0") if spec.respond_to? :required_rubygems_version=
+	spec.add_dependency 'heroku', '~> 2.15'
+	spec.add_dependency 'require_all', '~> 1.2.1'
+end

data/lib/justonedb/command.rb

@@ -0,0 +1,118 @@
+require 'optparse'
+require 'require_all'
+require 'pp'
+
+# Some parts adapted from the heroku gem http://rubygems.org/gems/heroku
+module JustOneDB
+	module Command
+		class InvalidPlatform < RuntimeError; end
+		class InvalidCommand < RuntimeError; end
+
+		class << self
+			def load
+				require_all File.join(File.dirname(__FILE__), "command", '*.rb')
+
+				JustOneDB::Command::Base.load
+			end
+
+			def commands
+				@commands ||= JustOneDB::Command::Base.commands
+			end
+
+			def platforms
+				@platforms ||= JustOneDB::Command::Base.platforms
+			end
+
+			def main_options
+				@main_options ||=	[
+										{
+											:option_id => "app",
+											:short => '-a',
+											:long => '--app APP',
+											:description => 'Heroku application'
+										},
+										{
+											:option_id => "help",
+											:short => '-h',
+											:long => '--help',
+											:description => 'Help'
+										}
+									]
+			end
+
+			def help
+				prefix = "Usage: " + File.basename($PROGRAM_NAME)
+				puts "#{prefix} <platform> <command>"
+
+				main_options.each do |option|
+					puts " " * prefix.length + "[ #{option[:short]} #{option[:long]} (#{option[:description]}) ]"
+				end
+
+				# Show all platforms and commands
+				puts "\nPlatforms and Commands:"
+
+				commands.each do |platform, command_hash|
+					puts " " * prefix.length + "#{platform}"
+					indent = prefix.length + platform.length
+
+					max_length = 0
+					command_hash.each_key { |command| max_length = command.length if command.length > max_length }
+
+					command_hash.each do |command, cmd_details|
+						printf("%*s%-*s - %s\n", indent, " ", max_length, command, cmd_details[:summary])
+						#puts " " * indent + "#{command}"
+					end
+				end
+			end
+
+			def run(platform, command, args)
+				# Check the platform
+				raise InvalidPlatform unless platforms.include?(platform)
+				
+				# See if the command exists
+				raise InvalidCommand unless commands[platform] and commands[platform][command]
+
+				cmd_details = commands[platform][command]
+				options = {}
+
+				# Check any options available
+				optparse = OptionParser.new do |parser|
+					main_options.each do |option|
+						parser.on("#{option[:short]}", "#{option[:long]}", option[:description]) do |value|
+							options[option[:option_id].to_sym] = value
+						end
+					end
+
+					if cmd_details[:options]
+						cmd_details[:options].each do |option|
+							parser.on("#{option[:short]}", "#{option[:long]}", option[:description]) do |value|
+								options[option[:option_id].to_sym] = value
+							end
+						end
+					end
+				end
+
+				begin
+					optparse.parse!(args)
+					
+					rescue OptionParser::ParseError
+						prefix = "Usage: #{$PROGRAM_NAME} "
+						puts "#{prefix} <platform> <command>"
+
+						main_options.each do |option|
+							puts " " * prefix.length + "[ #{option[:short]} #{option[:long]} (#{option[:description]}) ]"
+						end
+
+						cmd_details[:options].each do |option|
+							puts " " * prefix.length + "[ #{option[:short]} #{option[:long]} (#{option[:description]}) ]"
+						end
+				end
+				
+				cmd = cmd_details[:cmd_class].new
+				bound = cmd_details[:method].bind(cmd)
+				bound.call(args, options)
+			end
+
+		end
+	end
+end

data/lib/justonedb/command/base.rb

@@ -0,0 +1,106 @@
+require 'require_all'
+require 'open3'
+require 'tmpdir'
+
+class JustOneDB::Command::Base
+	class MigrationFailed < RuntimeError; end
+
+	class << self
+		def load
+			# Now ask each sub-class to load it's commands
+			@@commands = {}
+			@@platforms = []
+			sub_classes.each do |curr_class|
+				if curr_class.respond_to?("get_commands")
+					commands = curr_class.get_commands
+
+					commands.each do |command|
+						@@commands[command[:platform]] = {} unless @@commands[command[:platform]]
+						@@commands[command[:platform]][command[:command]] = command
+						@@platforms.push command[:platform] unless @@platforms.include?(command[:platform])
+					end
+				end
+			end
+		end
+
+		def commands
+			@@commands ||= {}
+		end
+
+		def platforms
+			@@platforms ||= []
+		end
+
+		protected
+			def inherited(new_class)
+				# Store all sub-classes
+				sub_classes.push new_class
+			end
+
+			def sub_classes
+				@@sub_classes ||= []
+			end
+
+	end
+
+	def migrate(from, to, tmpdir)
+		# Extract details from URI
+		dbi = URI.parse(from)
+		username, password = dbi.userinfo.split(':')
+		path = dbi.path.sub('/', '')
+
+		tmpfile = File.join(tmpdir, "pg_dump_#{$$}.dmp")
+		
+		# Construct pg_dump command
+		pg_dump = "pg_dump -Fp --no-privileges --no-owner --no-tablespaces " +
+					"-h #{dbi.host}  -p #{dbi.port} -U #{username} #{path} 2>&1 > #{tmpfile}"
+
+		puts "Extracting data from JUSTONEDB_DBI_URL using pg_dump"
+		dumpin, dumpout, wait_thr = Open3.popen2({ "PGPASSWORD" => password }, pg_dump)
+		dumpin.close
+		dump_stdout = dumpout.read
+		dumpout.close
+
+		begin
+			if wait_thr.value.exitstatus > 0
+				puts dump_stdout
+				raise MigrationFailed, "Database dump failed"
+			end
+
+			# Get a psql process read to read from us (pipe it's input, so that we can remove anything that we don't like
+			new_dbi = URI.parse(to)
+			username, password = dbi.userinfo.split(':')
+			path = new_dbi.path.sub('/', '')
+			psqlcmd = "psql --set=ON_ERROR_STOP=on -h #{new_dbi.host} -p #{new_dbi.port} -U #{username} -d #{path}"
+			psqlin, psqlout, psqlerr, wait_thr = Open3.popen3({ "PGPASSWORD" => password }, psqlcmd)
+
+			infd = open(tmpfile, "r")
+
+			# Ignore creation of plpgsql language, as the user will not have permission to replace the one there
+			puts "Importing data into JUSTONEDB_NEW_DBI_URL using psql"
+
+			# Send everything to psql
+			infd.each { |line| psqlin.write line unless line.match(/^create( or replace)? procedural language plpgsql;$/i) }
+
+			infd.close
+			psqlin.close
+
+			psqlerr.each { |line| puts line }
+
+			psqlout.close
+			psqlerr.close
+
+			if wait_thr.value.exitstatus > 0
+				raise MigrationFailed, "Database restore failed"
+			end
+
+			puts "Data imported successfully, please fully check your application before running 'justonedb heroku promote'"
+
+			rescue
+				File.unlink(tmpfile) if File.exists?(tmpfile)
+				raise
+		end
+	end
+end
+
+require_all File.join(File.dirname(__FILE__), "**", '*.rb')

data/lib/justonedb/command/heroku/base.rb

@@ -0,0 +1,51 @@
+require 'justonedb/command/base'
+require 'heroku/auth'
+require 'heroku/command'
+require 'heroku/command/base'
+require 'open3'
+
+module JustOneDB::Command
+	class InvalidAppConfig < RuntimeError; end
+
+	class Heroku < JustOneDB::Command::Base
+		# Define available commands
+		
+		class << self
+			def get_commands
+				[
+					{
+						:cmd_class => self,
+						:method => self.instance_method(:migrate),
+						:platform => "heroku",
+						:command => "migrate",
+						:summary => "Migrate Data from current to 'NEW' database",
+						:options => [
+										{
+											:option_id => "directory",
+											:short => '-d',
+											:long => '--directory TMP_DIR',
+											:description => 'Write temporary data to TMP_DIR (default ".")'
+										}
+									],
+					},
+					{
+						:cmd_class => self,
+						:method => self.instance_method(:promote),
+						:platform => "heroku",
+						:command => "promote",
+						:summary => "Promote JustOneDB 'NEW' database to live",
+						:options => NIL
+					},
+					{
+						:cmd_class => self,
+						:method => self.instance_method(:purge_old),
+						:platform => "heroku",
+						:command => "purge-old",
+						:summary => "Purge 'OLD' JustOneDB variables",
+						:options => NIL
+					},
+				]
+			end
+		end
+	end
+end

data/lib/justonedb/command/heroku/migrate.rb

@@ -0,0 +1,27 @@
+require 'justonedb/command/base'
+require 'heroku/auth'
+require 'heroku/command'
+require 'heroku/command/base'
+require 'open3'
+require 'tmpdir'
+
+module JustOneDB::Command
+	class Heroku < JustOneDB::Command::Base
+		def migrate(args, options)
+			# Migrate data from JUSTONEDB_DBI_URL to JUSTONEDB_NEW_DBI_URL
+			# -d, --directory # Specify temporary dump directory
+			directory = options[:directory]
+			directory = Dir::tmpdir unless directory
+
+			herokuapi = ::Heroku::Command::BaseWithApp.new(args, options)
+
+			vars = herokuapi.heroku.config_vars(herokuapi.app)
+
+			# Check that we have an old and a new DBI entry
+			raise InvalidAppConfig, "JUSTONEDB_DBI_URL undefined" unless vars["JUSTONEDB_DBI_URL"]
+			raise InvalidAppConfig, "JUSTONEDB_NEW_DBI_URL undefined" unless vars["JUSTONEDB_NEW_DBI_URL"]
+
+			super(vars["JUSTONEDB_DBI_URL"], vars["JUSTONEDB_NEW_DBI_URL"], directory)
+		end
+	end
+end

data/lib/justonedb/command/heroku/promote.rb

@@ -0,0 +1,44 @@
+require 'justonedb/command/base'
+require 'heroku/auth'
+require 'heroku/command'
+require 'heroku/command/base'
+
+module JustOneDB::Command
+	class Heroku < JustOneDB::Command::Base
+
+		def promote(args, options)
+			herokuapi = ::Heroku::Command::BaseWithApp.new(args, options)
+
+			vars = herokuapi.heroku.config_vars(herokuapi.app)
+
+			# Check that we have an old and a new DBI entry
+			raise InvalidAppConfig, "JUSTONEDB_NEW_DBI_URL undefined" unless vars["JUSTONEDB_NEW_DBI_URL"]
+			raise InvalidAppConfig, "JUSTONEDB_NEW_REST_BASE undefined" unless vars["JUSTONEDB_NEW_REST_BASE"]
+			raise InvalidAppConfig, "JUSTONEDB_NEW_REST_DB undefined" unless vars["JUSTONEDB_NEW_REST_DB"]
+			raise InvalidAppConfig, "JUSTONEDB_NEW_SUPPORT_ID undefined" unless vars["JUSTONEDB_NEW_SUPPORT_ID"]
+
+			puts "Promoting JustOneDB 'NEW' vars to current, and saving current to 'OLD'"
+
+			detected_app = herokuapi.app
+
+			new_vars = {}
+			new_vars["JUSTONEDB_OLD_DBI_URL"] = vars["JUSTONEDB_DBI_URL"]
+			new_vars["JUSTONEDB_OLD_REST_BASE"] = vars["JUSTONEDB_REST_BASE"]
+			new_vars["JUSTONEDB_OLD_REST_DB"] = vars["JUSTONEDB_REST_DB"]
+			new_vars["JUSTONEDB_OLD_SUPPORT_ID"] = vars["JUSTONEDB_SUPPORT_ID"]
+			new_vars["JUSTONEDB_DBI_URL"] = vars["JUSTONEDB_NEW_DBI_URL"]
+			new_vars["JUSTONEDB_REST_BASE"] = vars["JUSTONEDB_NEW_REST_BASE"]
+			new_vars["JUSTONEDB_REST_DB"] = vars["JUSTONEDB_NEW_REST_DB"]
+			new_vars["JUSTONEDB_SUPPORT_ID"] = vars["JUSTONEDB_NEW_SUPPORT_ID"]
+
+			herokuapi.heroku.add_config_vars(detected_app, new_vars)
+
+			herokuapi.heroku.remove_config_var(detected_app, "JUSTONEDB_NEW_DBI_URL")
+			herokuapi.heroku.remove_config_var(detected_app, "JUSTONEDB_NEW_REST_BASE")
+			herokuapi.heroku.remove_config_var(detected_app, "JUSTONEDB_NEW_REST_DB")
+			herokuapi.heroku.remove_config_var(detected_app, "JUSTONEDB_NEW_SUPPORT_ID")
+
+			puts "Variables modified, please check that your application works correctly, before running 'justonedb heroku purge-old'"
+		end
+	end
+end

data/lib/justonedb/command/heroku/purge-old.rb

@@ -0,0 +1,30 @@
+require 'justonedb/command/base'
+require 'heroku/auth'
+require 'heroku/command'
+require 'heroku/command/base'
+
+module JustOneDB::Command
+	class Heroku < JustOneDB::Command::Base
+
+		def purge_old(args, options)
+			herokuapi = ::Heroku::Command::BaseWithApp.new(args, options)
+
+			vars = herokuapi.heroku.config_vars(herokuapi.app)
+
+			# Check that we have the old entries
+			raise InvalidAppConfig, "JUSTONEDB_OLD_DBI_URL undefined" unless vars["JUSTONEDB_OLD_DBI_URL"]
+			raise InvalidAppConfig, "JUSTONEDB_OLD_REST_BASE undefined" unless vars["JUSTONEDB_OLD_REST_BASE"]
+			raise InvalidAppConfig, "JUSTONEDB_OLD_REST_DB undefined" unless vars["JUSTONEDB_OLD_REST_DB"]
+			raise InvalidAppConfig, "JUSTONEDB_OLD_SUPPORT_ID undefined" unless vars["JUSTONEDB_OLD_SUPPORT_ID"]
+
+			puts "Purging JustOneDB 'OLD' configuration variables"
+
+			detected_app = herokuapi.app
+
+			herokuapi.heroku.remove_config_var(detected_app, "JUSTONEDB_OLD_DBI_URL")
+			herokuapi.heroku.remove_config_var(detected_app, "JUSTONEDB_OLD_REST_BASE")
+			herokuapi.heroku.remove_config_var(detected_app, "JUSTONEDB_OLD_REST_DB")
+			herokuapi.heroku.remove_config_var(detected_app, "JUSTONEDB_OLD_SUPPORT_ID")
+		end
+	end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: justonedb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- JustOneDB
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: heroku
+  requirement: &74934430 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74934430
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: &74934000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *74934000
+description: Command-line tool for JustOneDB to assist in deployments on Heroku
+email: support@justonedb.com
+executables:
+- justonedb
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.rdoc
+- bin/justonedb
+- justonedb-1.0.0.gemspec
+- lib/justonedb/command/base.rb
+- lib/justonedb/command/heroku/base.rb
+- lib/justonedb/command/heroku/migrate.rb
+- lib/justonedb/command/heroku/promote.rb
+- lib/justonedb/command/heroku/purge-old.rb
+- lib/justonedb/command.rb
+homepage: http://www.justonedb.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Command-line tool for JustOneDB database deployed on Heroku, or AppHarbor.
+test_files: []
+has_rdoc: