dandelion 0.1.7 → 0.2.0

data/README.md

@@ -9,7 +9,7 @@ Ensure that Ruby and RubyGems are installed, then run:
     
 Alternatively, you can build the gem yourself:
 
-    $ git clone git://github.com/scottbnel/dandelion.git
+    $ git clone git://github.com/scttnlsn/dandelion.git
     $ cd dandelion
     $ rake install
     
@@ -19,7 +19,7 @@ Configuration options are specified in a YAML file (Dandelion looks for a file
 named `dandelion.yml` by default):
 
     # Required
-    scheme: sftp
+    scheme: sftp # sftp/ftp
     host: example.com
     username: user
     password: pass
@@ -34,11 +34,11 @@ Usage
 -----
 From the root directory of a Git repository, run:
 
-    $ dandelion
+    $ dandelion deploy
     
 Or:
 
-    $ dandelion path/to/config.yml
+    $ dandelion deploy path/to/config.yml
     
 This will deploy the local `HEAD` revision to the server specified in the config
 file.  Dandelion keeps track of the most recently deployed revision so that only
@@ -47,8 +47,11 @@ files which have changed since the last deployment need to be transferred.
 For a more complete summary of usage options, run:
 
     $ dandelion -h
-    Usage: dandelion [options] [config_file]
-        -f, --force                      Force deployment
-        -s, --status                     Display revision status
+    Usage: dandelion [options] [[command] [options]]
         -v, --version                    Display the current version
-        -h, --help                       Display this screen
+        -h, --help                       Display this screen
+            --repo=[REPO]                Use the given repository
+
+    Available commands:
+        deploy
+        status

data/Rakefile

@@ -1,3 +1,10 @@
 require 'bundler'
+require 'rake/testtask'
 
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/dandelion.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Scott Nelson']
   s.email       = ['scottbnel@gmail.com']
-  s.homepage    = 'http://github.com/scottbnel/dandelion'
+  s.homepage    = 'http://github.com/scttnlsn/dandelion'
   s.summary     = "dandelion-#{s.version}"
-  s.description = 'Git repository deployment via SFTP'
+  s.description = 'Git repository deployment via FTP/SFTP'
   
   s.add_dependency 'net-sftp', '>= 2.0.5'
   s.add_dependency 'grit', '>= 2.4.1'

data/lib/dandelion/cli.rb

@@ -8,23 +8,50 @@ require 'yaml'
 
 module Dandelion
   module Cli
-    class UnsupportedSchemeError < StandardError; end
-    
     class Options
+      attr_reader :config_file
+      
       def initialize
         @options = {}
-        @optparse = OptionParser.new do |opts|
-          opts.banner = 'Usage: dandelion [options] [config_file]'
-
-          @options[:force] = false
-          opts.on('-f', '--force', 'Force deployment') do
-            @options[:force] = true
+        @config_file = 'dandelion.yml'
+        @global = global_parser
+        @commands = { 'deploy' => deploy_parser, 'status' => status_parser }
+        @commands_help = "\nAvailable commands:\n    #{@commands.keys.join("\n    ")}"
+      end
+      
+      def parse(args)
+        order @global, args
+        command = args.shift
+        if command and @commands[command]
+          order @commands[command], args
+        end
+        
+        if @commands.key? command
+          @config_file = args.shift.strip if args[0]
+          command
+        else
+          if not @command.nil?
+            puts "Invalid command: #{command}"
           end
+          puts @global.help
+          puts @commands_help
+          exit
+        end
+      end
+      
+      def [](key)
+        @options[key]
+      end
 
-          @options[:status] = false
-          opts.on('-s', '--status', 'Display revision status') do
-            @options[:status] = true;
-          end
+      def []=(key, value)
+        @options[key] = value
+      end
+      
+      private
+      
+      def global_parser
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: dandelion [options] [[command] [options]]'
 
           opts.on('-v', '--version', 'Display the current version') do
             puts "Dandelion v#{Dandelion::VERSION}"
@@ -33,117 +60,135 @@ module Dandelion
 
           opts.on('-h', '--help', 'Display this screen') do
             puts opts
+            puts @commands_help
             exit
           end
+          
+          @options[:repo] = '.'
+          opts.on('--repo=[REPO]', 'Use the given repository') do |repo|
+            @options[:repo] = repo
+          end
         end
       end
       
-      def parse!(args)
-        @args = args
-        @optparse.parse!(@args)
+      def deploy_parser
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: dandelion deploy [options]'
+          
+          @options[:force] = false
+          opts.on('-f', '--force', 'Force deployment') do
+            @options[:force] = true
+          end
+        end
       end
       
-      def config_file
-        if @args[0]
-          @args[0].strip
-        else
-          'dandelion.yml'
+      def status_parser
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: dandelion status'
         end
       end
       
-      def [](key)
-        @options[key]
-      end
-
-      def []=(key, value)
-        @options[key] = value
+      def order(parser, args)
+        begin
+          parser.order!(args)
+        rescue OptionParser::InvalidOption => e
+          puts e.to_s.capitalize
+          puts parser.help
+          exit
+        end
       end
     end
     
     class Main
       class << self
         def execute(args)
-          new(args).execute!
+          new(args).execute
         end
       end
       
       def initialize(args)
         @options = Options.new
-        @options.parse!(args)
+        @command = @options.parse args
+        
+        validate_files
+        @config = YAML.load_file(File.expand_path @options.config_file)
+        @repo = Git::Repo.new(File.expand_path @options[:repo])
       end
       
       def log
         Dandelion.logger
       end
       
-      def check_files!
-        unless File.exists? '.git'
-          log.fatal('Not a git repository: .git')
-          exit
-        end
-        unless File.exists? @options.config_file
-          log.fatal("Could not find file: #{@options.config_file}")
-          exit
-        end
-      end
-
-      def service(config)
-        if config['scheme'] == 'sftp'
-          Service::SFTP.new(config['host'], config['username'], config['password'], config['path'])
-        else
-          raise UnsupportedSchemeError
+      def execute
+        log.info("Connecting to:    #{service.uri}")
+        deployment(service) do |d|
+          log.info("Remote revision:  #{d.remote_revision || '---'}")
+          log.info("Local revision:   #{d.local_revision}")
+          
+          if @command == 'status'
+            exit
+          elsif @command == 'deploy'
+            validate_deployment d
+            d.deploy
+            log.info("Deployment complete")
+          end
         end
       end
       
-      def execute!
-        check_files!
-        config = YAML.load_file @options.config_file
-
-        begin
-          service = service config
-        rescue UnsupportedSchemeError
-          log.fatal("Unsupported scheme: #{config['scheme']}")
-          exit
-        end
-
-        log.info("Connecting to:    #{service.uri}")
-        repo = Git::Repo.new('.')
-
+      private
+      
+      def deployment(service)
         begin
-          deployment = Deployment::DiffDeployment.new(repo, service, config['exclude'])
+          deployment = Deployment::DiffDeployment.new(@repo, service, @config['exclude'])
         rescue Deployment::RemoteRevisionError
-          deployment = Deployment::FullDeployment.new(repo, service, config['exclude'])
+          deployment = Deployment::FullDeployment.new(@repo, service, @config['exclude'])
         rescue Git::DiffError
           log.fatal('Error: could not generate diff')
           log.fatal('Try merging remote changes before running dandelion again')
           exit
         end
-        
+        if block_given?
+          yield(deployment)
+        else
+          deployment
+        end
+      end
+      
+      def service
+        if @config['scheme'] == 'sftp'
+          Service::SFTP.new(@config['host'], @config['username'], @config['password'], @config['path'])
+        elsif @config['scheme'] == 'ftp'
+          Service::FTP.new(@config['host'], @config['username'], @config['password'], @config['path'])
+        else
+          log.fatal("Unsupported scheme: #{@config['scheme']}")
+          exit
+        end
+      end
+      
+      def validate_deployment(deployment)
         begin
-          repo.remote_list.each do |remote|
+          @repo.remote_list.each do |remote|
             deployment.validate_state(remote)
           end
         rescue Deployment::FastForwardError
-          if !@options[:force] and !@options[:status]
+          if !@options[:force]
             log.warn('Warning: you are trying to deploy unpushed commits')
             log.warn('This could potentially prevent others from being able to deploy')
             log.warn('If you are sure you want to this, use the -f option to force deployment')
             exit
           end
         end
-
-        remote_revision = deployment.remote_revision || '---'
-        local_revision = deployment.local_revision
-
-        log.info("Remote revision:  #{remote_revision}")
-        log.info("Local revision:   #{local_revision}")
-
-        if @options[:status]
+      end
+      
+      def validate_files
+        unless File.exists? File.expand_path File.join(@options[:repo], '.git')
+          log.fatal("Not a git repository: #{@options[:repo]}")
+          exit
+        end
+        unless File.exists?(File.expand_path @options.config_file)
+          log.fatal("Could not find file: #{@options.config_file}")
           exit
         end
-
-        deployment.deploy
-        log.info("Deployment complete")
       end
     end
   end

data/lib/dandelion/deployment.rb

@@ -30,8 +30,11 @@ module Dandelion
       end
       
       def validate_state(remote = nil)
-        if remote and @repo.git.native(:remote, {:raise => true}, 'show', remote) =~ /fast-forward/i
-          raise FastForwardError
+        begin
+          if remote and @repo.git.native(:remote, {:raise => true}, 'show', remote) =~ /fast-forward/i
+            raise FastForwardError
+          end
+        rescue Grit::Git::CommandFailed
         end
       end
       

data/lib/dandelion/service.rb

@@ -1,29 +1,107 @@
+require 'net/ftp'
 require 'net/sftp'
 require 'tempfile'
 
 module Dandelion
   module Service
     class MissingFileError < StandardError; end
-  
+
     class Service
       def initialize(host, username, path)
         @host = host
         @username = username
         @path = path
       end
-    
+
       def uri
         "#{@scheme}://#{@username}@#{@host}/#{@path}"
       end
+
+      protected
+
+      def temp(file, data)
+        tmp = Tempfile.new(file.gsub('/', '.'))
+        tmp << data
+        tmp.flush
+        yield(tmp.path)
+        tmp.close
+      end
+    end
+
+    class FTP < Service
+      def initialize(host, username, password, path)
+        super(host, username, path)
+        @scheme = 'ftp'
+        @ftp = Net::FTP.open(host, username, password)
+        @ftp.passive = true
+        @ftp.chdir(path)
+      end
+
+      def read(file)
+        begin
+          # Implementation of FTP#getbinaryfile differs between 1.8
+          # and 1.9 so we call FTP#retrbinary directly
+          content = ''
+          @ftp.retrbinary("RETR #{file}", 4096) do |data|
+            content += data
+          end
+          content
+        rescue Net::FTPPermError => e
+          raise MissingFileError
+        end
+      end
+
+      def write(file, data)
+        # Creates directory only if necessary
+        mkdir_p(File.dirname(file))
+
+        temp(file, data) do |temp|
+          @ftp.putbinaryfile(temp, file)
+        end
+      end
+
+      def delete(file)
+        begin
+          @ftp.delete(file)
+          cleanup(File.dirname(file))
+        rescue Net::FTPPermError => e
+        end
+      end
+
+      private
+
+      def cleanup(dir)
+        unless File.identical?(dir, @path)
+          if empty?(dir)
+            @ftp.rmdir(dir)
+            cleanup(File.dirname(dir))
+          end
+        end
+      end
+
+      def empty?(dir)
+        return @ftp.nlst(dir).empty?
+      end
+
+      def mkdir_p(dir)
+        return if dir == "."
+        parent_dir = File.dirname(dir)
+        file_names = @ftp.nlst(parent_dir)
+        unless file_names.include? dir
+          mkdir_p(parent_dir)
+          @ftp.mkdir(dir)
+        end
+
+      end
     end
-  
+
     class SFTP < Service
       def initialize(host, username, password, path)
         super(host, username, path)
         @scheme = 'sftp'
         @sftp = Net::SFTP.start(host, username, :password => password)
       end
-    
+
       def read(file)
         begin
           @sftp.file.open(File.join(@path, file), 'r') do |f|
@@ -34,7 +112,7 @@ module Dandelion
           raise MissingFileError
         end
       end
-    
+
       def write(file, data)
         path = File.join(@path, file)
         begin
@@ -44,13 +122,11 @@ module Dandelion
           raise unless e.code == 2
           mkdir_p(dir)
         end
-        tmp = Tempfile.new(file.gsub('/', '.'))
-        tmp << data
-        tmp.flush
-        @sftp.upload!(tmp.path, path)
-        tmp.close
+        temp(file, data) do |temp|
+          @sftp.upload!(temp, path)
+        end
       end
-    
+
       def delete(file)
         begin
           path = File.join(@path, file)
@@ -60,9 +136,9 @@ module Dandelion
           raise unless e.code == 2
         end
       end
-    
+
       private
-    
+
       def cleanup(dir)
         unless File.identical?(dir, @path)
           if empty?(dir)
@@ -71,13 +147,13 @@ module Dandelion
           end
         end
       end
-    
+
       def empty?(dir)
         @sftp.dir.entries(dir).map do |entry|
           entry.name unless entry.name == '.' or entry.name == '..'
         end.compact.empty?
       end
-    
+
       def mkdir_p(dir)
         begin
           @sftp.mkdir!(dir)