rsync-deploy 0.0.13 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0d8bd2f75921bfade8891d99baf5728fea343a4
-  data.tar.gz: 2756d336765d28db681f0972caa33babc12c1be1
+  metadata.gz: 3717284c1b26d927d0e36696e2539e5964165f75
+  data.tar.gz: df5757be4cec9ed087d0b3295d187aadb6b9c856
 SHA512:
-  metadata.gz: 91236019ec3336df7c25891c4936b89a450b76dc6183d1a75fba8fa15bd6d533334e213143445bb8ef17087646984f8cb8f6a44c5576e5288dc03917ed550c9d
-  data.tar.gz: 0de91dbc4e02509b4845230e4f54efcd5130d1c5e2c57bfbbe770eea02954cadd58f72363287ba9a26a89ae49592861f500116dee788188635320f02215ae353
+  metadata.gz: 9856b050bbfa3c7f53b0203428d77467054f772ee28772ff2be04314c9cf9b3a9456d395c6edc56c51cc6a153b50c659327f291554eb2c1a5bb0adbd700b5a1a
+  data.tar.gz: 3159216a6de8b0d6d451080b8f866e318d96a92e0b14d7060f0339fe1780e164ac102ffd9bf28d0a631bfdfe2d044971ce230c561394a636a15b1b3d74363521

data/README.md

@@ -58,9 +58,24 @@ Or to multiple servers, like this:
 deploy dev staging production
 ```
 
+#### deploy download [env...]
+
+Will download from the environment(s) listed. This works in reverse, so files from `path.remote` will go into `path.local`
+
+This command is also aliased as `down` and `d`, so it can be run like:
+
+```
+deploy down staging
+```
+
+#### deploy list
+
+Will list all configured environments.
+
 #### deploy config NAME
 
-Will change the name of deployment configuration files. By default they are named `deploy.yml`, but this can be changed to names such as `.deploy` which makes them hidden files. Keep in mind that **this is a global setting and will be applied to all deployments.**
+Will change the name of deployment configuration files. By default they are named `deploy.yml`, but this can be changed to names such as `.deploy` which makes them hidden files. Keep in mind that **this is a global setting** and will be applied to all deployments.
+
 
 #### deploy help
 
@@ -126,7 +141,8 @@ The password to login to the server. If SSH keys aren't available, then the `pas
 - 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:
+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

data/bin/deploy

@@ -3,39 +3,45 @@
 require 'deploy'
 require 'fileutils'
 
-# TODO: Create `-r`, `--rev`, `--reverse`, `rev`, `reverse` command to download
-# from the server instead of upload
+# TODO: Allow creation of environments from install command, for example
+# `deploy install live dev` would create a file with live and dev
+# configurations to be filled in
+
 # 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]
+  Usage: deploy [COMMAND] [OPTIONS] [ENVIRONMENTS]
 
   Commands:
-  	install             Configure directory for deployment
-  	config NAME         Changes the deployment config file name
-  	help                Prints this help document
-  	version             Prints the siteleaf gem version
+  
+  	[env...]			     Deploys listed environments
+  	reverse [env...]      Downloads listed environments \(aliased as `r` or `rev`\) 
+  	download [env...]     Downloads listed environments \(aliased as `d` or `down`\)
+  	
+  	install               Configure directory for deployment
+  	list					 Lists all configured environments
+  	config FILENAME       Changes the deployment config file name
+  	help                  Prints this help document
+  	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.
 
   Options:
-  	-h, --help          Prints this help document
-  	-v, --version       Prints the deploy gem version
+  	-h, --help            Prints this help document
+  	-v, --version         Prints the deploy gem version
 
   See https://github.com/rosszurowski/deploy for additional documentation.
   )
 end
 
-# TODO: Allow creation of environments from install command, for example
-# `deploy install live dev` would create a file with live and dev
-# configurations to be filled in
+
 def install
 	
 	if File.exist?(Deploy::CONFIG_PATH)
@@ -72,37 +78,70 @@ def install
 	
 end
 
-# See if they're running a command
-if ARGV.size > 0
-	case ARGV[0]
-	when '-v', '--version', 'version'
-		puts "Deploy v" + Deploy::VERSION
-		exit
-	when '-h', '--help', 'help'
-		puts help
-		exit
-	when 'install', 'setup'
-		install
-		exit
-	when 'config'
-		unless ARGV[1].empty?
-			File.open(Deploy::GEM_SETTINGS_PATH, 'w+') do |file|
-				# Remove illegal characters and add to file
-				file.puts 'config_path: ' + ARGV[1].gsub(/[^\w\.]/, '_')
-			end
-			puts "Configuration file renamed to `#{ARGV[1].gsub(/[^\w\.]/, '_')}`"
-		else
-			puts "Please provide a name for configuration files. See `deploy help` for more details."
+def set_config(new_path)
+	unless ARGV[1].empty?
+		File.open(Deploy::GEM_SETTINGS_PATH, 'w+') do |file|
+			# Remove illegal characters and add to file
+			file.puts 'config_path: ' + new_path
+		end
+		puts "Configuration file renamed to `#{new_path}`"
+	else
+		puts "Please provide a name for configuration files. See `deploy help` for more details."
+	end
+end
+
+def list
+	if File.exist?(Deploy::CONFIG_PATH)
+		deploy = Deploy::Deployment.new
+		
+		# List out environments
+		longest_env = (deploy.environments.sort { |a, b| a.name.length <=> b.name.length }).last
+		deploy.environments.each.with_index(1) do |env, i|
+			printf "* \e[91m%-#{longest_env.name.length + 3}s\e[0m %s\n", "#{env.name}", "(#{env.config[:user]}@#{env.config[:host]})"
 		end
+		
+	else
+		puts "No config file found, run `deploy install` to create one"
 		exit
 	end
 end
 
+def go(rev=false)
+	if File.exist?(Deploy::CONFIG_PATH)
+		deploy = Deploy::Deployment.new
+		deploy.reverse = rev
+		# Pass the arguments to the deploy, but remove the reverse command
+		deploy.go ARGV.reject { |cmd| cmd =~ /\b((?:r)|(?:rev)|(?:reverse)|(?:d)|(?:down)|(?:download))\b/i }
+	else
+		puts "No config file found, run `deploy install` to create one"
+		exit
+	end
+end
 
-if File.exist?(Deploy::CONFIG_PATH)
-	deploy = Deploy::Deployment.new
-	deploy.go ARGV
-else
-	puts "No config file found, run `deploy install` to create one"
+# See if they're running a command
+case ARGV[0]
+when '-v', '--version', 'version'
+	puts "Deploy v" + Deploy::VERSION
+	exit
+when '-h', '--help', 'help'
+	puts help
+	exit
+when 'install', 'setup'
+	install
+	exit
+when 'r', 'rev', 'reverse',
+	 'd', 'down', 'download'
+	# Run the deploy in reverse
+	go(true)
+	exit
+when 'list'
+	list
 	exit
-end
+when 'config'
+	set_config ARGV[1].gsub(/[^\w\.]/, '_')
+	exit
+end
+
+
+# Run the deploy straight if nothing else triggered
+go(false)

data/lib/deploy/environment.rb

@@ -34,9 +34,9 @@ module Deploy
 
 			@config[:excludes] = hash['exclude'] || Array.new
 
-			
-			@options[:verbose] = hash['verbose'] unless hash['verbose'].nil?
-			@options[:sync] = hash['sync'] unless hash['sync'].nil?
+			@options[:reverse] = false
+			@options[:verbose] = hash['verbose'].to_s.empty? ? false : hash['verbose']
+			@options[:sync] = hash['sync'].to_s.empty? ? true : hash['sync']
 
 			validate
 
@@ -60,50 +60,58 @@ 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
-			rsync_cmd += 'z'																																	# Always zip files
+			rsync_cmd = 'rsync -a'																																# Always keep permissions
+			rsync_cmd += 'v' if @options[:verbose]																									# Verbose if requested
+			rsync_cmd += 'z'																																			# Always zip files
 
-			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 += " --password-file=#{tmp_pass.path}" unless @config[:pass].empty?				# Include password file if it exists
+			rsync_cmd += ' --progress'																														# Always show progress
+			
+			if (@options[:sync] && !@options[:reverse])
+				rsync_cmd += ' --force --delete --delete-excluded'    																# Sync unless explicitly requested or downloading
+			end
+			rsync_cmd += " --exclude-from=#{tmp_exclude.path}" unless @config[:excludes].empty?			# Include exclude file if it exists
+			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
+				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
-			
-			rsync_cmd += " "																																	# Adding a space here means we don't need an if/else statement
-			rsync_cmd += "#{@config[:user]}@" unless @config[:user].empty?											# Only add user if not empty
-			rsync_cmd += "#{@config[:host]}:"																									# Add host
-			rsync_cmd += "~#{@config[:remote]}"																								# Add remote (relative to remote user home)
+			rsync_cmd += "-p#{@config[:port]}\" "																									# Choose port if specified
+
+			unless @options[:reverse]
+				rsync_cmd += `pwd`.gsub(/\s+/, "") + "#{@config[:local]} "														# The local path from the current directory
+			end
 
+			rsync_cmd += "#{@config[:user]}@" unless @config[:user].empty?													# Only add user if not empty
+			rsync_cmd += "#{@config[:host]}:"																											# Add host
+			rsync_cmd += "~#{@config[:remote]}"																										# Add remote (relative to remote user home)
+			
+			if @options[:reverse]
+				rsync_cmd += " " + `pwd`.gsub(/\s+/, "") + "#{@config[:local]}"												# Put the local path after if we're downloading
+			end
+			
 			# Run the command
-			puts rsync_cmd
-			# system(rsync_cmd)
+			# puts rsync_cmd
+			system(rsync_cmd)
 
 			# Remove excludes/pass file if needed
 			tmp_exclude.unlink unless @config[:excludes].empty?
 			tmp_pass.unlink unless @config[:pass].empty?
-
+		
 		end
-
+		
 		private
-
+		
 		def validate
-
+		
 			# Fail without hostname (user/password are optional)
 			(puts "Error: no hostname set for `#{@name}`"; exit;) if @config[:host].empty?
 
@@ -113,6 +121,6 @@ module Deploy
 			(puts "Error: no remote path set for `#{@name}`"; exit;) if @config[:remote].empty?
 
 		end
-
+		
 	end
 end

data/lib/deploy/version.rb

@@ -1,5 +1,5 @@
 module Deploy
   
-  VERSION = "0.0.13"
+  VERSION = "0.0.16"
   
 end

data/lib/deploy.rb

@@ -14,6 +14,8 @@ module Deploy
   class Deployment
 
     attr_reader :environments
+    
+    attr_accessor :reverse
 
     def initialize()
 
@@ -24,12 +26,15 @@ module Deploy
         @environments.push Environment.new(env[0], env[1])
       end
 
+      @reverse = false
+
     end
 
-    def go(args)
+    def go(args = [])
 
       # If there are no arguments, deploy using the first environment in
       # the configuration file, otherwise loop through and deploy each one
+      # Note: the to_a statement ensures that args is not nil
       if args.size == 0
         
         @environments.first.deploy
@@ -51,7 +56,17 @@ module Deploy
         end
         
       end
+      
+    end
 
+    # Set deployment reverse and apply it to all associated environments too
+    def reverse=(reverse)
+      
+      @reverse = reverse
+      @environments.each do |env|
+        env.options[:reverse] = reverse
+      end
+      
     end
 
   end

metadata

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