rsync-deploy 0.0.11 → 0.0.12

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmRmZGVkYWUwMzkwNTE2YzA2Yjc4YTQ3NTQ0NWRjMDQ3OTY0MTgyMQ==
+    NDNjODI1ZjBkOWJhMWIwZThjMjVmNjEwOGQ3NjNjYjcxNTg1MGZjZg==
   data.tar.gz: !binary |-
-    ZmRmMTBkOGNjNjQxZTAxYjE1ZGRhNTU4MTdmZTkzN2JjMWVkYjMyZg==
+    ODliZmE4MDNkOGMxMGI3ZmIwOGI3N2JlMWRjZDAzMTBlN2FmMjc0MA==
 SHA512:
   metadata.gz: !binary |-
-    NmU2MGE1MjQyOTA2ZGVjNjQ3Nzc5YWFhMmY3NmJiYzRhYTlhYzc1YjljMDFm
-    NDA5NmQwMjUwMDRhODcxOGQzZmNjZDJmYmQ4OGUzZWJiZGIwN2ZiYzg2MTg5
-    MGUxZWJmZWEyZmM0YTQ3YTM1YjAxMzU1NTA4NzI3MDkyMjg0ZjU=
+    NDFlMDZiMDIxYzg4NTc4YmZkYWY5OTczYTE2MDliYTJmZjFhMzU5Mzk0MWRj
+    NWM5YTU1ODQ4MTJlN2VkNWVmNzcyNDE4OTY0MzM4ZDVjYjI1MTg4YWQ3NTgx
+    MTc1NDgyNDY5NzI4MGM1N2RmZWQ1ZGNhYWM5Y2FkNDkzYmExYTA=
   data.tar.gz: !binary |-
-    YjQxNTNkY2YzZDlhZDRjZTIwNTIyMzEwMGQzOTdlODc1MmEyNTZmNDYyZjhk
-    YjZkMDBjODI0NGYzMTM5ZDJlZjM1MDRiYWMyZjMyMmVmNmY0Y2FjMGY1YTFh
-    ZGEwMjNhNTUyMjAyMDc5NjU4Y2Q5OGE4NDdlN2M0NjIxNDU0ZDI=
+    NTRmMTBhNDY5NzI3MWJlZDQ3ZmUxYTdjZmQ4MjhjNjg3ZjgzMGJhMjkyOGM3
+    OGVjNzEzMjQ1NjEwMGJjYTMxM2NiMzNhZGYwODlhZmVlZDg4ODBkMmU2Njk4
+    NDEyZjI4ZWY4MGM5NjY4ZDVhOTIyMDFjZTc1ODgyNzdiZWUxYjc=

data/README.md

@@ -95,12 +95,38 @@ Below is a list of all available configuration options.
 
 The server that the files should be deployed to.
 
+### port
+
+- Type: `Number`
+- Default: `22`
+- Required: `Yes`
+
+The port that the connection should happen over
+
 ### user
 
 - Type: `String`
 - Default: `none`
 
-The username to login to the server. If no username is set, your computer account username will be used. Passwords will need to be typed in manually, however, SSH keys will be used if available.
+The username to login to the server. If no username is set, your computer account username will be used.
+
+### pass
+
+- Type: `String`
+- Default: `none`
+
+The password to login to the server. If SSH keys aren't available, then the `pass` option will be used. If neither SSH keys nor `pass` are set, a prompt will be given.
+
+### privateKey
+
+- Type: `String`
+- Default: `none`
+
+The path to an alternative SSH key. This only needs to be set if your key isn't one of the following:
+```
+~/.ssh/id_rsa
+~/.ssh/id_dsa
+```
 
 ### sync
 

data/bin/deploy

@@ -3,6 +3,12 @@
 require 'deploy'
 require 'fileutils'
 
+# TODO: Create `-r`, `--rev`, `--reverse`, `rev`, `reverse` command to download
+# from the server instead of upload
+# TODO: Allow pre/post-deploy tasks to be run on a per-environment basis for 
+# both local and remote servers. That could help some people, but not really
+# needed for a while yet.
+
 def help
 	%Q(
   Usage: deploy [COMMAND] [ENVIRONMENTS] [OPTIONS]
@@ -13,9 +19,10 @@ def help
   	version             Prints the siteleaf gem version
   	
   Environments:
-  	<env>			   Deploys listed environments
+  	<env>               Deploys listed environments
   	
-  	If no commands, environments, or options are given, the first environment in the config file will be deployed.
+  	If no commands, environments, or options are given,
+  	the first environment in the config file will be deployed.
 
   Options:
   	-h, --help          Prints this help document
@@ -48,7 +55,7 @@ def install
 			File.open(Deploy::CONFIG_PATH, 'w+') do |file|
 				file.puts 'server_name:','  host: ""','  user: ""','  pass: ""','  path:','    local: "/"','    remote: "/public_html/"'
 			end
-			puts "Configuration file created. Fill in `#{Deploy::CONFIG_PATH}` with server details before deploying."
+			puts "Configuration file `#{Deploy::CONFIG_PATH}` created."
 		else
 			puts "No congifuration file has been installed."
 		end
@@ -58,7 +65,7 @@ def install
 		File.open(Deploy::CONFIG_PATH, 'w+') do |file|
 			file.puts 'server_name:','  host: ""','  user: ""','  pass: ""','  path:','    local: "/"','    remote: "/public_html/"'
 		end
-		puts "Deployment configuration file created. Fill in `#{Deploy::CONFIG_PATH}` with server details before deploying."
+		puts "Configuration file `#{Deploy::CONFIG_PATH}` created."
 		
 	end
 	
@@ -79,6 +86,7 @@ if ARGV.size > 0
 	end
 end
 
+
 if File.exist?(Deploy::CONFIG_PATH)
 	deploy = Deploy::Deployment.new
 	deploy.go ARGV

data/lib/deploy/environment.rb

@@ -12,12 +12,15 @@ module Deploy
 		def initialize(name, hash)
 
 			@name = name
-			@config = { :host => '', :user => '', :pass => '', :local => '', :remote => '' }
+			@config = { :host => '', :port => '',  :user => '', :pass => '', :private_key => '', :local => '', :remote => '' }
 			@options = { :verbose => false, :sync => true }
 
 			@config[:host] = hash['host']
+			@config[:port] = hash['port'] || '22'
+			
 			@config[:user] = hash['user'] || ''
 			@config[:pass] = hash['pass'] || ''
+			@config[:private_key] = hash['privateKey'] || ''
 
 			@config[:local] = hash['path']['local'].gsub(/\s+/, "")
 			@config[:remote] = hash['path']['remote'].gsub(/\s+/, "")
@@ -29,8 +32,9 @@ module Deploy
 			@config[:remote].insert(0,'/') unless @config[:remote].start_with?('/')
 
 
-			@config[:excludes] = hash['exclude'] if hash['exclude']
+			@config[:excludes] = hash['exclude'] || Array.new
 
+			
 			@options[:verbose] = hash['verbose'] unless hash['verbose'].nil?
 			@options[:sync] = hash['sync'] unless hash['sync'].nil?
 
@@ -47,7 +51,7 @@ module Deploy
 		def deploy
 
 			# Create excludes file if needed
-			if(@config[:excludes])
+			unless @config[:excludes].empty?
 				tmp_exclude = Tempfile.new(['excludes','.txt'])
 				@config[:excludes].each do |ex|
 					tmp_exclude.puts ex
@@ -56,6 +60,12 @@ module Deploy
 				tmp_exclude.puts Deploy::CONFIG_PATH 
 				tmp_exclude.close
 			end
+			
+			unless @config[:pass].empty?
+				tmp_pass = Tempfile.new(['pass','.txt'])
+				tmp_pass.puts @config[:pass]
+				tmp_pass.close
+			end
 
 			rsync_cmd = 'rsync -a'																														# Always keep permissions
 			rsync_cmd += 'v' if @options[:verbose]																							# Verbose if requested
@@ -64,7 +74,14 @@ module Deploy
 			rsync_cmd += ' --progress'																												# Always show progress
 			rsync_cmd += ' --force --delete' unless @options[:sync] == false										# Sync unless explicitly requested
 			rsync_cmd += " --exclude-from=#{tmp_exclude.path}" unless @config[:excludes].empty?	# Include exclude file if it exists
-			rsync_cmd += " -e \"ssh -p22\""
+			rsync_cmd += " --password-file=#{tmp_pass.path}" unless @config[:pass].empty?				# Include password file if it exists
+			rsync_cmd += " -e \"ssh "
+			
+			if(@config[:pass].empty? and @config[:private_key].empty?)
+				rsync_cmd += " -i #{@config[:private_key]} " 																		# Include a custom private key if requested
+			end
+			
+			rsync_cmd += "-p#{@config[:port]}\""																								# Choose port if specified
 
 			rsync_cmd += " " + `pwd`.gsub(/\s+/, "") + "#{@config[:local]}"											# The local path from the current directory
 			
@@ -77,8 +94,9 @@ module Deploy
 			# puts rsync_cmd
 			system(rsync_cmd)
 
-			# Remove excludes file if needed
-			tmp_exclude.unlink if @config[:excludes]
+			# Remove excludes/pass file if needed
+			tmp_exclude.unlink unless @config[:excludes].empty?
+			tmp_pass.unlink unless @config[:pass].empty?
 
 		end
 
@@ -87,12 +105,12 @@ module Deploy
 		def validate
 
 			# Fail without hostname (user/password are optional)
-			raise "Error: no hostname set for #{@name}" if @config[:host].empty?
+			(puts "Error: no hostname set for `#{@name}`"; exit;) if @config[:host].empty?
 
 			# Fail if local/remote paths not set (because they should be in initialize
 			# even if they're not set in the yml config file.
-			raise "Error: no local path set for #{@name}" if @config[:local].empty?
-			raise "Error: no remote path set for #{@name}" if @config[:remote].empty?
+			(puts "Error: no local path set for `#{@name}`"; exit;) if @config[:local].empty?
+			(puts "Error: no remote path set for `#{@name}`"; exit;) if @config[:remote].empty?
 
 		end
 

data/lib/deploy/version.rb

@@ -1,5 +1,5 @@
 module Deploy
   
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsync-deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Ross Zurowski