gift 0.0.5

data/.gift/recipients.yml

@@ -0,0 +1,29 @@
+--- !ruby/object:Gift::Recipient 
+connection: !ruby/object:Net::FTP 
+  binary: true
+  debug_mode: false
+  last_response: |
+    226-Options: -a 
+    226 3 matches total
+
+  last_response_code: "226"
+  mon_count: 0
+  mon_entering_queue: []
+
+  mon_owner: 
+  mon_waiting_queue: []
+
+  passive: false
+  resume: false
+  sock: !ruby/object:TCPSocket {}
+
+  welcome: |
+    230-User dev+involved.com.au has group access to:  involved  
+    230 OK. Current restricted directory is /
+
+host: involved.com.au
+id: ftp-1
+password: d8u2gy
+path: gift-test
+port: 21
+username: dev+involved.com.au

data/.gitignore

@@ -0,0 +1,18 @@
+# rcov generated
+coverage
+ 
+# jeweler generated
+pkg
+ 
+# yard generated
+doc
+.yardoc
+ 
+# ctags generated
+tags
+ 
+# tmp directories used during testing
+test/tmp
+test/jeweler/version_tmp
+test/version_tmp
+tmp

data/README.textile

@@ -0,0 +1,25 @@
+h1. Gift - Git and FTP, the easy way
+
+"We":http://www.involved.com.au recently adopted Ruby on Rails as our primary web application framework of choice. The marriage of Rails, Git and Heroku made for a carefree development, deployment and management strategy. Unfortunately, the reality is that we're not always able to use our favourite technologies. And more often than not often a client will have existing hosting arrangements that simply cannot (easily) support a Rails setup, or maybe we're just doing a simple Wordpress blog. Regardless - we wanted to have that same ease of deployment; a way to manage development in the style to which we have become accustomed.
+
+So we made Gift.
+
+h2. Usage
+
+Install the gem:
+
+<pre>
+	gem install gift
+</pre>
+
+Initialise your FTP server:
+
+<pre>
+	gift wrap ftp://username:password@127.0.0.1:21
+</pre>
+
+Push your commits:
+
+<pre>
+	gift deliver
+</pre>

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "gift"
+    gemspec.summary = "Git and FTP, the easy way."
+    gemspec.description = "Gift provides a simple interface for pushing your site to a server that does not support git, via FTP."
+    gemspec.email = "nicholas@bruning.com.au"
+    gemspec.homepage = "http://github.com/thetron/gift"
+    gemspec.authors = ["Nicholas Bruning"]
+    gemspec.add_dependency('ptools', '>= 1.1.8')
+    gemspec.add_dependency('git', '>= 1.2.5')
+    gemspec.executables = ["gift"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/bin/gift

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+# == About 
+#   Gift – Git and FTP, the easy way
+#   Gift provides a simple interface for pushing your site to a server that does not support git, via FTP.
+#
+#   This version of Gift currenly only supports the master branch of a git repository.
+#
+# == Examples
+#   Start my initialising your FTP settings
+#     $ gift wrap ftp://username:password@127.0.0.1:21
+#
+#   When you're ready to deploy, use:
+#     $ gift deliver
+#
+# == Usage 
+#   $ gift wrap [server-name] ftp://username:password@127.0.0.1:21
+#   $ gift deliver [options]
+#
+#   For help use: gift -h
+#
+# == Options
+#   -h, --help          Displays help message
+#   -v, --version       Display the version, then exit
+#   -q, --quiet         Output as little as possible, overrides verbose
+#   -V, --verbose       Verbose output
+#
+# == Author
+#   Nicholas Bruning
+#
+# == Copyright
+#   Copyright (c) 2010 Nicholas Bruning. Licensed under the MIT License:
+#   http://www.opensource.org/licenses/mit-license.php
+
+# use this for testing:
+# ruby lib/cli.rb wrap ftp://dev+involved.com.au:d8u2gy@involved.com.au:21/gift-test
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'cli'
+exit Gift::Cli.new(ARGV, STDIN).run

data/gift.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gift}
+  s.version = "0.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nicholas Bruning"]
+  s.date = %q{2010-03-18}
+  s.default_executable = %q{gift}
+  s.description = %q{Gift provides a simple interface for pushing your site to a server that does not support git, via FTP.}
+  s.email = %q{nicholas@bruning.com.au}
+  s.executables = ["gift"]
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gift/recipients.yml",
+     ".gitignore",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bin/gift",
+     "gift.gemspec",
+     "lib/cli.rb",
+     "lib/recipient.rb"
+  ]
+  s.homepage = %q{http://github.com/thetron/gift}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Git and FTP, the easy way.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ptools>, [">= 1.1.8"])
+      s.add_runtime_dependency(%q<git>, [">= 1.2.5"])
+    else
+      s.add_dependency(%q<ptools>, [">= 1.1.8"])
+      s.add_dependency(%q<git>, [">= 1.2.5"])
+    end
+  else
+    s.add_dependency(%q<ptools>, [">= 1.1.8"])
+    s.add_dependency(%q<git>, [">= 1.2.5"])
+  end
+end
+

data/lib/cli.rb

@@ -0,0 +1,175 @@
+
+
+require 'optparse' 
+require 'rdoc/usage'
+require 'ostruct'
+require 'date'
+require 'uri'
+require 'net/ftp'
+require 'yaml'
+require 'recipient'
+
+module Gift
+  class Cli
+    
+    attr_reader :options
+    
+    def initialize(arguments, stdin)
+      @arguments = arguments
+      @stdin = stdin
+
+      # Set defaults
+      @options = OpenStruct.new
+      @options.verbose = false
+      @options.quiet = false
+    end
+    
+    def run
+      if parsed_options?
+        puts "Start at #{DateTime.now}\n\n" if @options.verbose
+        
+        output_options if @options.verbose # [Optional]
+
+        process_arguments            
+        process_command
+        
+        puts "\nFinished at #{DateTime.now}" if @options.verbose
+      else
+        output_usage
+      end
+      
+      return 0
+    end
+    
+    protected
+    
+    def wrap
+      puts "Gift wrapping #{@server_address}"
+      
+      #check a local git repository exists
+      @errors = fail(["No local git repository found"]) unless File.exists?(".git")
+      
+      uri = URI.parse(@options.server_address)
+      recipient = Gift::Recipient.new
+      
+      #recipient.id = @options.server_name
+      recipient.id = "ftp-1"
+      recipient.username = uri.userinfo.split(":")[0]
+      recipient.password = uri.userinfo.split(":")[1]
+      recipient.host = uri.host
+      recipient.port = uri.port
+      recipient.path = uri.path    
+      
+      begin
+        puts "Connected to #{recipient.host}" if recipient.valid_connection?
+        
+        puts "Initialising remote files in #{recipient.host}/#{recipient.path}"
+        recipient.setup_remote_dirs
+        puts "Remote setup complete"
+        
+        puts "Initialising local files"
+        recipient.setup_local_dirs
+        recipient.save
+        puts "Local setup complete"
+      rescue Exception => e
+        fail(["#{e} #{e.class}"])
+      end
+      
+      #populate or refresh .gift/remotes.yml locally
+      
+    end
+    
+    def unwrap
+      #remove @server_name from local list
+      
+    end
+        
+    def deliver
+      recipient = Recipient.find_by_id(nil)
+      puts "Delivering gift to '#{recipient.id}'"
+      recipient.update_remote
+    end
+    
+    def output_version
+      File.open(File.join(File.dirname(__FILE__), '..', 'VERSION'), "r") do |f|
+        f.each { |f| puts "Gift v#{f}" }
+      end
+    end
+    
+    def output_help
+      output_version
+      RDoc::usage() #exits app
+    end
+    
+    def output_usage()
+      RDoc::usage('usage') # gets usage from comments above
+    end
+    
+    def fail(errors)
+      puts "The following errors occurred:"
+      puts "\t" + errors.join("\n\t") + "\t"
+      output_usage
+      
+      exit 0;
+    end
+    
+    def parsed_options?
+      # Specify options
+      opts = OptionParser.new
+      
+      opts.on('-h', '--help')       { output_help }
+      opts.on('-V', '--verbose')    { @options.verbose = true }  
+      opts.on('-q', '--quiet')      { @options.quiet = true }
+            
+      opts.on('-v', '--version') do |version|
+        output_version
+        exit 0
+      end
+        
+      opts.parse!(@arguments) rescue return false
+
+      process_options
+      true      
+    end
+    
+    def process_options
+      @options.verbose = false if @options.quiet
+    end
+    
+    def output_options
+      puts "Options:\n"
+
+      @options.marshal_dump.each do |name, val|        
+        puts "  #{name} = #{val}"
+      end
+    end
+    
+    def arguments_valid?
+      if @command == :wrap
+        @options.server_address != nil
+      else
+        true
+      end
+    end
+    
+    def process_arguments
+      @command = (@arguments.shift || 'help').to_sym
+      
+      if(@command == :wrap)
+        @options.server_name = @arguments.shift if @arguments.length > 1
+        @options.server_address = @arguments.shift
+      elsif( [:unwrap, :delivery].include?(@command) )
+        @options.server_name = @arguments.shift
+      end
+    end
+    
+    def process_command
+      if[:wrap, :unwrap, :deliver].include?(@command) && arguments_valid?
+        send(@command)
+      else
+        output_help
+        exit 0
+      end
+    end
+  end
+end

data/lib/recipient.rb

@@ -0,0 +1,157 @@
+require 'ftools'
+require 'yaml'
+require 'ptools'
+require 'git'
+
+module Gift
+  class Recipient
+    attr_accessor :id, :username, :password, :host, :port, :path
+    
+    def valid_connection?
+      begin
+        connect
+        disconnect
+        true
+      rescue Exception => e
+        false
+      end
+    end
+    
+    def setup_remote_dirs
+      connect
+      unless @connection.nlst.include?('.gift')
+        @connection.mkdir('.gift')
+      else
+        puts 'Remote gift directory already exists'
+      end
+      
+      @connection.chdir('.gift')
+      
+      unless @connection.nlst.include?('deliveries')
+        @connection.mkdir('deliveries')
+      else
+        puts 'Remote deliveries directory already exists'
+      end
+      disconnect
+    end
+    
+    def setup_local_dirs
+      File.makedirs '.gift' unless File.exists?('.gift')
+      File.makedirs '.gift/deliveries' unless File.exists?('.gift/deliveries')
+      File.makedirs ".gift/deliveries/#{self.id}"# unless File.exists?(".gift/deliveries/#{self.id}")
+    end
+    
+    def update_remote
+      repo = Git.open('./')
+      
+      remote_commit = last_remote_commit
+      remote_commit = repo.log.to_a.last.sha if remote_commit == ""
+            
+      file_count = 0  
+      
+      puts("Last remote commit: #{remote_commit} | Current local commit: #{repo.log.to_a.first.sha}")
+      
+      connect
+      repo.diff(remote_commit, repo.log.to_a.first.sha).each do |file|
+        unless(file.path.split('/').first == ".gift")
+          if file.type == "deleted"
+            begin
+              size = @connection.size(file.path)
+              puts "Deleting #{file.path} [          ] 0%"
+              delete_remote_file(file.path)
+            rescue Exception => e
+              puts "Delete skipped #{file.path} (file not found)"
+            end
+          else
+            puts "Uploading #{file.path} [          ] 0%"
+            upload_file(file.path)
+          end
+        end
+        file_count += 1
+      end
+      disconnect
+      
+      if file_count == 0
+        puts "Everything up to date!"
+      else
+        save_commit(repo.log.to_a.first.sha)
+      end
+    end
+    
+    def last_remote_commit
+      sha = ""
+      connect
+      @connection.chdir('.gift/deliveries')
+      if @connection.nlst.length > 2
+        @connection.gettextfile(@connection.nlst.last) do |f|
+          sha = f
+        end
+      end
+      disconnect
+      
+      sha
+    end
+    
+    def save_commit(sha)
+      file_name = ".gift/deliveries/#{id}/#{Time.now.to_i.to_s}"
+      fp = File.open(file_name, "w")
+      fp.puts sha
+      fp.close
+      
+      connect
+      @connection.chdir('.gift/deliveries')
+      @connection.puttextfile(file_name)
+      disconnect
+      
+      puts "Remote state saved"
+    end
+    
+    def save
+      unless self.id
+        self.id = "ftp-1"
+      end
+      
+      yaml = YAML::dump(self)
+      fp = open('.gift/recipients.yml', 'w')
+      fp.write(yaml)
+      fp.close
+    end
+    
+    def connect
+      @connection = Net::FTP.new(host, username, password)
+      @connection.chdir(path)
+    end
+    
+    def disconnect
+      @connection.close
+    end
+    
+    def self.find_by_id(id)
+      #search recipients.yml for id
+      YAML::load_file('.gift/recipients.yml')
+    end
+    
+    def self.all
+      YAML::load_file('.gift/recipients.yml')
+    end
+    
+    protected
+    
+    def upload_file(filename)
+      #this will also have to create any missing dirs (unless they're handled the same as files)
+      connect
+      if File.binary?(filename)
+        @connection.putbinaryfile(filename)
+      else 
+        @connection.puttextfile(filename)
+      end
+      disconnect
+    end
+    
+    def delete_remote_file(filename)
+      connect
+      @connection.delete(filename)
+      disconnect
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: gift
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Nicholas Bruning
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-18 00:00:00 +11:00
+default_executable: gift
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ptools
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 8
+        version: 1.1.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: git
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :runtime
+  version_requirements: *id002
+description: Gift provides a simple interface for pushing your site to a server that does not support git, via FTP.
+email: nicholas@bruning.com.au
+executables: 
+- gift
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gift/recipients.yml
+- .gitignore
+- README.textile
+- Rakefile
+- VERSION
+- bin/gift
+- gift.gemspec
+- lib/cli.rb
+- lib/recipient.rb
+has_rdoc: true
+homepage: http://github.com/thetron/gift
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Git and FTP, the easy way.
+test_files: []
+