rsync-deploy 0.0.9

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ross Zurowski
+
+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,70 @@
+**_Note: This tool is still in development and likely will not work in many cases._**
+
+# Deploy
+
+**Deploy is an rsync deployment tool built using Ruby**  
+Essentially acts as a wrapper for the rsync utility, providing a simple YAML based configuration file.
+
+
+## Install
+
+To install just run:
+
+```
+gem install rsync-deploy
+```
+
+
+## Commands
+
+#### deploy install
+
+Will create an template `deploy.yml` file in the current directory.
+
+#### deploy [env...]
+
+Will deploy to the environment(s) listed in the command. This can be used to deploy to a single server, like this:
+
+```
+deploy production
+```
+
+Or to multiple servers, like this:
+
+```
+deploy dev staging production
+```
+
+All environments called (eg. **dev**, **staging**, and **production**) are expected to be listed in your `deploy.yml` file.
+
+# Basic example
+
+Set up your server in the `deploy.yml` file
+
+```
+production:
+    host: "server.com"
+    user: "username"
+    path:
+        local: "deploy/"
+        remote: "public_html/"
+```
+
+And then use the following command to deploy:
+
+```
+deploy production
+```
+
+# Mentions
+
+Deploy is almost identical to [DPLOY](https://github.com/LeanMeanFightingMachine/dploy), which was in turn inspired by [dandelion](https://github.com/scttnlsn/dandelion). However, Deploy separates version control from deployment, which helps avoid messy version control history with commits like _bug fix_, _typo_, and so on.
+
+
+## Uninstall
+
+To uninstall Deploy, download the [project files](https://github.com/rosszurowski/deploy/archive/master.zip), navigate to the unzipped directory, and run:
+
+```
+gem uninstall rsync-deploy
+```

data/Rakefile

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

data/bin/deploy

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+require 'deploy'
+require 'fileutils'
+
+def help
+	%Q(
+  Usage: deploy [COMMAND] [ENVIRONMENTS] [OPTIONS]
+
+  Commands:
+  	install             Configure directory for deployment
+  	help                Prints this help document
+  	version             Prints the siteleaf gem version
+  	
+  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
+
+  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)
+		
+		puts "Deployment configuration file `#{Deploy::CONFIG_PATH}` already exists."
+		
+		# Use a Y/n prompt to see if things should be overwritten
+		prompt = "Would you like to overwrite it?"
+		answer = ''
+		default = 'y'
+		until %w[y n].include? answer
+			print prompt + ' [Y/n]:'
+			answer = STDIN.gets.chomp.downcase
+			answer = default if answer.length == 0
+		end
+		
+		if(answer == 'y')
+			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."
+		else
+			puts "No congifuration file has been installed."
+		end
+		
+	else
+		
+		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."
+		
+	end
+	
+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
+	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"
+	exit
+end

data/lib/deploy/environment.rb

@@ -0,0 +1,96 @@
+# Parses and provides an easy interface for working with
+# deployment environment variables.
+
+require 'tempfile'
+
+module Deploy
+	class Environment
+
+		attr_reader :name
+		attr_accessor :config, :options
+
+		def initialize(name, hash)
+
+			@name = name
+			@config = { :host => '', :user => '', :pass => '', :local => '', :remote => '' }
+			@options = { :verbose => false, :sync => true }
+
+			@config[:host] = hash['host']
+			@config[:user] = hash['user']
+			@config[:pass] = hash['pass'] unless hash['pass'].nil?
+
+			@config[:local] = hash['path']['local'].gsub(/\s+/, "")
+			@config[:remote] = hash['path']['remote'].gsub(/\s+/, "")
+
+			# Set to project and server root if local/remote are empty
+			@config[:local] = '/' if @config[:local].empty?
+			@config[:local].insert(0,'/') unless @config[:local].start_with?('/')
+			@config[:remote] = '/' if @config[:remote].empty?
+			@config[:remote].insert(0,'/') unless @config[:remote].start_with?('/')
+
+
+			@config[:excludes] = hash['exclude'] if hash['exclude']
+
+			@options[:verbose] = hash['verbose'] unless hash['verbose'].nil?
+			@options[:sync] = hash['sync'] unless hash['sync'].nil?
+
+			validate
+
+			# TODO: Find a way to do a setter for @config[:excludes] instead of
+			# freezing the hash
+			@config[:excludes].freeze
+
+		end
+
+		# Runs the deploy based upon the current @config and @options settings
+		# Creates rsync command and creates exclude file then cleans up
+		def deploy
+
+			# Create excludes file if needed
+			if(@config[:excludes])
+				tmp_exclude = Tempfile.new(['excludes','.txt'])
+				@config[:excludes].each do |ex|
+					tmp_exclude.puts ex
+				end
+				tmp_exclude.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 += ' --progress'																										# Always show progress
+			rsync_cmd += ' --force --delete' unless !@options[:sync]												# Sync unless explicitly requested
+			rsync_cmd += " --exclude-from=#{tmp_exclude.path}" if @config[:excludes]					# Include exclude file if it exists
+			rsync_cmd += " -e \"ssh -p22\""
+
+			rsync_cmd += " " + `pwd`.gsub(/\s+/, "") + "#{@config[:local]}"									# The local path from the current directory
+			rsync_cmd += " #{@config[:user]}@#{@config[:host]}:"
+			rsync_cmd += "~#{@config[:remote]}"
+
+			# Run the command
+			# puts rsync_cmd
+			system(rsync_cmd)
+
+			# Remove excludes file if needed
+			tmp_exclude.unlink if @config[:excludes]
+
+		end
+
+		private
+
+		def validate
+
+			# Fail without hostname/username (password is optional)
+			raise "Error: no hostname set for #{@name}" if @config[:host].empty?
+			raise "Error: no user set for #{@name}" if @config[:user].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?
+
+		end
+
+	end
+end

data/lib/deploy/version.rb

@@ -0,0 +1,5 @@
+module Deploy
+  
+  VERSION = "0.0.9"
+  
+end

data/lib/deploy.rb

@@ -0,0 +1,58 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'yaml'
+require 'deploy/version'
+require 'deploy/environment'
+
+module Deploy
+
+  # TODO: Make this adjustable from the command line
+  CONFIG_PATH = "deploy.yml"
+
+  class Deployment
+
+    attr_reader :environments
+
+    def initialize()
+
+      @config = YAML::load(File.open(CONFIG_PATH))
+      @environments = Array.new
+
+      @config.each do |env|
+        @environments.push Environment.new(env[0], env[1])
+      end
+
+    end
+
+    def go(args)
+
+      # If there are no arguments, deploy using the first environment in
+      # the configuration file, otherwise loop through and deploy each one
+      if args.size == 0
+        
+        @environments.first.deploy
+        
+      else
+        
+        # Loop through the arguments and deploy any given ones that are also
+        # present in the config file.
+        args.each do |arg_env|
+          
+          curr_env = @environments.find { |e| e.name == arg_env }
+          
+          if curr_env.nil?
+            puts "No environment found for #{arg_env}, add it to `#{Deploy::CONFIG_PATH}`"
+          else
+            curr_env.deploy
+          end
+        
+        end
+        
+      end
+
+    end
+
+  end
+
+end

data/rsync-deploy.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'deploy/version'
+
+Gem::Specification.new do |s|
+  
+  s.name          = 'rsync-deploy'
+  s.version       = Deploy::VERSION
+  s.date          = '2013-12-23'
+
+  s.summary       = "Deployments based on rsync"
+  s.description   = "A simple rsync based deployment gem"
+
+  s.authors       = ["Ross Zurowski"]
+  s.email         = 'ross@rosszurowski.com'
+  s.homepage      = 'http://rubygems.org/gems/rsync-deploy'
+  s.license       = 'WTFPL'
+
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  
+  s.files         = `git ls-files`.split($/)
+  s.files         += Dir.glob("lib/**/*.rb")
+  s.executables   = ["deploy"]
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rsync-deploy
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+  prerelease: 
+platform: ruby
+authors:
+- Ross Zurowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple rsync based deployment gem
+email: ross@rosszurowski.com
+executables:
+- deploy
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/deploy
+- lib/deploy.rb
+- lib/deploy/environment.rb
+- lib/deploy/version.rb
+- rsync-deploy.gemspec
+homepage: http://rubygems.org/gems/rsync-deploy
+licenses:
+- WTFPL
+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.23
+signing_key: 
+specification_version: 3
+summary: Deployments based on rsync
+test_files: []