traquitana 0.0.11 → 0.0.12

data/.gitignore

@@ -0,0 +1,2 @@
+.*.swp
+*.gem

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Eustaquio Rangel
+
+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,71 @@
+# Traquitana
+
+This project is a collection of scripts I used before met Capistrano and the
+other tools to do that.
+It send some files from your local Rails app directory to a production remote
+server, using some
+default libs on Ruby like net/ssh and net/scp, and rubyzip to zip all the files
+and try to make
+things faster.
+
+It was made to run on GNU/Linux, but should work on similar systems. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'traquitana'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install traquitana
+
+## Usage
+
+- Go to your Rails app directory.
+- Run traq setup.
+- Now you have a traq.yml file on the config dir. Open It.
+- There are simple configurations there:
+	- host: where your production server is, for example, myhost.com
+	- user: user name to connect to the server (SSH)
+	- password: user password (SSH), can be blank if you use connect with no password to the server
+	- directory: where your app is on the server. please use the full path based on where the login occurs! ex: /home/user/myapp/
+	- ignore: it will just send the files that had changed on less than the number of hours configured here
+	- server: the webserver running on the server. ex: passenger
+	- list: the list of file patterns searched to send to the server
+
+	On the list can have two elements by row, like:
+
+   - - public/images/**/*
+     - public/images/uploads/**/*
+
+	On this example, all below public/images will be send BUT ignoring what is on public/images/uploads. This is a way to
+	make sure you'll not overwrite some production files with your development versions.
+
+- PLEASE PLEASE PLEASE configure this file. You can create an app on your localhost and 
+make some tests on it 'till you think is safe deal with real apps on production servers.
+- Run traq (just type traq). 
+	- It will search for changed files
+	- Will create a list with the file names found
+	- Will zíp the files.
+	- Will send the list to the server, together with some control files.
+		- What the control files deal: they are shell scripts that will zip the old files (based on what new files are going),
+		unzip the new files, run migrations if needed and restart the web server. There are two files: one generic to make all
+		sort of things BUT not restarting the web server. The webserver script will be send based on what webserver you need.
+- Now everything should be updated. On the next time you want to update your project, just run traq again.
+
+* The list and the zip file created with the old files will be used on future versions as a rollback feature.	
+
+Use for your risk. I think it's all ok but I don't give you guarantee if it break something.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+   t.libs = ["lib"]
+   t.test_files = FileList['spec/**/*_spec.rb']
+end

data/bin/traq

@@ -6,9 +6,32 @@ require "zip/zip"
 require "net/scp"
 require "net/ssh"
 require "fileutils"
-require File.dirname(__FILE__)+"/../lib/config.rb"
-require File.dirname(__FILE__)+"/../lib/deploy.rb"
+require "optparse"
+require File.dirname(File.expand_path(__FILE__))+"/../lib/traquitana.rb"
 
-traq = Traquitana::Deploy.new
-traq.setup if ARGV[0] =~ /setup/
-traq.run
+@options = {:verbose=>false}
+
+opts = OptionParser.new
+opts.banner = "Usage: traq [options] <setup>"
+
+opts.on("-v","--version","Show version") do 
+   puts Traquitana::VERSION
+   exit 0
+end
+
+opts.on("-c","--cleanup","Clean up old files") do 
+   Traquitana::Cleaner.new.run
+   exit 0
+end
+
+opts.on("-V","--verbose","Verbose mode") do 
+   @options[:verbose] = true
+end
+
+opts.parse!
+
+if ARGV[0] =~ /setup/
+   Traquitana::Config.instance.setup
+else   
+   Traquitana::Deployer.new(@options).run
+end   

data/config/default.yml

@@ -1,8 +1,7 @@
 # Default configuration--- 
-:directory: /tmp/traq_test
-:ignore: 24
-:user: taq
-:list: 
+directory: /tmp/traq_test
+user: taq
+list: 
 - Rakefile
 - config.ru
 - Gemfile
@@ -19,7 +18,7 @@
 - - lib/**/*
 - - public/images/**/*
   - public/images/uploads/**/*
-:password: fill your password here
-:host: localhost
-:server: passenger
-:shell: bash -l -c 
+password: fill your password here
+host: localhost
+server: passenger
+shell: bash -l -c 

data/config/extra.sh

@@ -0,0 +1 @@
+# insert custom stuff here

data/config/nginx.sh

@@ -0,0 +1,6 @@
+if [ -d tmp ]; then
+   echo -n "Restarting Nginx ... "
+   rm -f tmp/restart.txt
+   touch tmp/restart.txt
+   echo "done."
+fi   

data/config/passenger.sh

@@ -1,7 +1,6 @@
-echo
-echo Restarting Passenger
-echo --------------------
-# sometimes passenger needs a "forced" tip to restart - removing the file first
-rm -f tmp/restart.txt
-touch tmp/restart.txt
-echo Ok.
+if [ -d tmp ]; then
+   echo -n "Restarting Passenger ... "
+   rm -f tmp/restart.txt
+   touch tmp/restart.txt
+   echo "done."
+fi

data/config/proc.sh

@@ -4,33 +4,54 @@ export RAILS_ENV=production
 # move to the correct directory
 cd $1/..
 
+# verbose mode
+verbose="$3"
+
 # make a copy of the old contents
-echo Making a safe copy of the old contents ...
+if [ "$verbose" == "true" ]; then
+   echo -n "Making a safety copy of the old contents on traq/$2 ... "
+fi   
 zip -q traq/$2.safe.zip `cat traq/$2.list` &> /dev/null
-echo Stored on traq/$2.safe.zip
+if [ "$verbose" == "true" ]; then
+   echo "done."
+fi   
 
 # install the new files
-echo
-echo Unzipping the new content
-echo -------------------------
+echo -n "Unzipping $2.zip ... "
 unzip -o traq/$2.zip &> /dev/null
+echo "done."
 
 # run migrations if needed
 migrations=$(grep "^db/migrate" traq/$2.list)
-
 if [ -n "$migrations" ]; then
-	echo
-	echo Running migrations
-	echo ------------------
-	bundle exec rake db:migrate
+	echo "Running migrations ... "
+	bundle exec rake db:migrate 2> /dev/null
+   echo "Migrations done."
+fi
+
+# precompile assets if needed
+if [ -d app/assets ]; then
+   bundle exec rake assets:precompile 2> /dev/null
 fi
 
 # change file permissions on public dir
-echo 
-echo Changing file permissions on public to 0755
-echo -------------------------------------------
+if [ "$verbose" == "true" ]; then
+   echo -n "Changing file permissions on public to 0755 ... "
+fi
 chmod -R 0755 public/*
-echo Changed.
+if [ "$verbose" == "true" ]; then
+   echo "done."
+fi
+
+# restart server
+if [ -x ./traq/server.sh -a -f ./traq/server.sh ]; then
+   ./traq/server.sh
+fi   
+
+# extra configs
+if [ -x ./traq/extra.sh -a -f ./traq/extra.sh ]; then
+   ./traq/extra.sh
+fi
 
-# restart the server
-traq/server.sh
+# erase file
+rm traq/$2.zip

data/config/traq.yml

@@ -0,0 +1,25 @@
+# Sample configuration--- 
+directory: /tmp/traq_test
+user: taq
+list: 
+- Rakefile
+- config.ru
+- Gemfile
+- - config/application.rb
+- - config/environment.rb
+- - config/initializers/**/*
+- - config/environments/production.rb
+- - config/locales/**/*
+- - config/routes.rb
+- - app/**/*
+- - db/migrate/**/*
+- - public/javascripts/**/*
+- - public/stylesheets/**/*
+- - lib/**/*
+- - public/images/**/*
+  - public/images/uploads/**/*
+  - public/images/themes/**/*
+password: fill your password here
+host: localhost
+server: passenger
+shell: bash -l -c 

data/lib/bar.rb

@@ -0,0 +1,39 @@
+module Traquitana
+   class Bar
+      attr_reader :current
+      attr_accessor :name, :total
+
+      def initialize
+         reset
+      end      
+
+      def reset
+         @name       = nil
+         @total      = 0
+         @current    = 0
+         @bar_size   = 20
+         @bar_step   = 5
+      end
+
+      def indicator(current)
+         bar = Array.new(@bar_size,"_")
+			return bar.join if current<=0 
+
+			prop = current>0 ? ((100/(total/current.to_f))/@bar_step).to_i : 0
+			return bar.join if prop<=0 
+
+         bar[0...prop] = Array.new(prop,"#")
+         bar.join
+      end
+
+      def update(current)
+         @current = current
+         file     = File.basename(@name).ljust(25)
+         STDOUT.print "#{file} : #{self.indicator(current)}\r"
+         if @current>=@total
+            STDOUT.puts "\n"
+            @current = -1
+         end
+      end
+   end
+end

data/lib/cleaner.rb

@@ -0,0 +1,17 @@
+module Traquitana
+   class Cleaner
+      attr_accessor :network
+
+      def initialize
+         @config  = Traquitana::Config.instance
+         @config.load
+         @network = Traquitana::SSH.new(@config.host,@config.user)
+      end
+
+      def run
+         STDOUT.print "Cleaning old files ... "
+         @network.execute(["find #{@config.directory}/traq -type f -iname '*.zip' -o -iname '*.list' | sort | head -n-2 | xargs rm $1"])
+         STDOUT.puts "done."
+      end
+   end
+end

data/lib/config.rb

@@ -1,32 +1,48 @@
 require "singleton"
 
 module Traquitana
-	class Config
-		include Singleton
-
-		def initialize
-			@configs = {}
-		end
-
-		def dir
-			"traq"
-		end
-
-		def config
-			"#{dir}/config.yml"
-		end
-
-		def default
-			"#{File.dirname(File.expand_path(__FILE__))}/../config/default.yml"
-		end
-
-		def load(other=nil)
-			@configs = YAML.load(File.read(other || config))
-		end
-
-		def method_missing(meth)
-			c = @configs[meth.to_sym]
-			c ? c : ""
-		end
-	end
+   class Config
+      include Singleton
+
+      def initialize
+         @configs = {}
+      end
+
+      def filename
+         "config/traq.yml"
+      end
+
+      def default
+         "#{File.dirname(File.expand_path(__FILE__))}/../config/default.yml"
+      end
+
+      def load(file=nil)
+         @configs = YAML.load(File.read(file || self.filename))
+      end
+
+      def method_missing(meth)
+         @configs[meth.to_s] || ""
+      end
+
+      def setup
+			STDOUT.puts "Running setup"
+         if File.exists?(self.filename)
+            STDERR.puts "The configuration file #{self.filename} already exists."
+            return false
+         end
+
+         dir = File.dirname(self.filename)
+			Dir.mkdir(dir) if !File.exist?(dir)
+
+			STDOUT.puts "Writing #{self.filename}"
+			File.open(self.filename,"w") do |file|
+				file << "# Default configuration"
+				file << File.read(self.default)
+			end
+
+			STDOUT.puts "Setup completed!"
+			STDOUT.puts "You MUST check the configurations on #{self.filename} before deploying!"
+         true
+      end
+   end
 end

data/lib/deployer.rb

@@ -0,0 +1,59 @@
+module Traquitana
+	class Deployer
+		def initialize(options=nil)
+			@config	= Traquitana::Config.instance
+			@options = @config.password.size>1 ? {:password=>@config.password} : {}
+         @verbose = !options.nil? && options[:verbose]
+		end			
+
+		def run
+			STDOUT.puts "Running Traquitana version #{VERSION}\n"
+         Traquitana::Migrator.new.run
+
+			if !File.exist?(@config.filename)
+				STDERR.puts "No config file (#{@config.filename}) found."	
+				STDERR.puts "Did you run traq setup?"
+				STDERR.puts "Run it and check the configuration before deploying."
+				exit 1
+			end
+			@config.load
+
+         @shell   = @config.shell ? "#{@config.shell} " : ""
+         @network = Traquitana::SSH.new(@config.host,@config.user,@options)
+
+         @packager = Traquitana::Packager.new
+         @packager.verbose = @verbose
+         all_list_file, all_list_zip = @packager.pack
+         if !File.exists?(all_list_file) ||
+            !File.exists?(all_list_zip)
+            STDERR.puts "Could not create the needed files."
+            exit 2
+         end
+
+			# check if the traq destination and config directories exists 
+			@network.execute(["mkdir -p #{@config.directory}/traq"],@verbose)
+         @updater = Traquitana::Bar.new
+
+         STDOUT.puts "Sending files ..."
+         @network.send_files([["#{File.dirname(File.expand_path(__FILE__))}/../config/proc.sh","#{@config.directory}/traq/proc.sh"],
+                              ["#{File.dirname(File.expand_path(__FILE__))}/../config/#{@config.server}.sh","#{@config.directory}/traq/server.sh"],
+                              [all_list_file,"#{@config.directory}/traq/#{File.basename(all_list_file)}"],
+                              [all_list_zip ,"#{@config.directory}/traq/#{File.basename(all_list_zip)}"]],@updater)
+         STDOUT.puts "All files sent."
+
+         @network.execute(["chmod +x #{@config.directory}/traq/proc.sh"],@verbose)
+         @network.execute(["chmod +x #{@config.directory}/traq/server.sh"],@verbose)
+
+			cmd = "#{@config.directory}/traq/proc.sh #{@config.directory}/traq #{@packager.id} #{@verbose}"
+			cmd = "#{@shell} \"#{cmd}\"" if @shell
+
+         STDOUT.puts "Running remote update commands, please wait ..."
+         STDOUT.puts @network.execute([cmd],@verbose).join
+
+			# clean up
+			File.unlink(all_list_file)
+			File.unlink(all_list_zip)
+			STDOUT.puts "All done. Have fun.\n"
+		end
+	end
+end