frank 1.0.9 → 1.0.10

data/Gemfile.lock

@@ -1,3 +1,13 @@
+PATH
+  remote: .
+  specs:
+    frank (1.0.9)
+      haml (~> 3.0)
+      mongrel (~> 1.2.0.pre2)
+      net-ssh (~> 2.0)
+      rack (~> 1.1)
+      tilt (~> 1.3)
+
 GEM
   remote: http://rubygems.org/
   specs:
@@ -10,7 +20,6 @@ GEM
     coffee-script-source (1.1.2)
     compass (0.10.2)
       haml (>= 3.0.4)
-    contest (0.1.2)
     daemons (1.0.10)
     diff-lcs (1.1.2)
     erubis (2.6.6)
@@ -18,26 +27,24 @@ GEM
     execjs (1.2.4)
       multi_json (~> 1.0)
     gem_plugin (0.2.3)
-    gemcutter (0.6.1)
-    git (1.2.5)
     haml (3.0.13)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
-      git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json_pure (1.4.3)
     less (1.2.21)
       mutter (>= 0.4.2)
       treetop (>= 1.4.2)
     liquid (2.1.2)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
     mongrel (1.2.0.pre2)
       daemons (~> 1.0.10)
       gem_plugin (~> 0.2.3)
     multi_json (1.0.3)
     mutter (0.5.3)
-    net-scp (1.0.1)
+    net-scp (1.0.4)
       net-ssh (>= 1.99.1)
-    net-ssh (2.0.23)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.3.0)
     polyglot (0.3.1)
     rack (1.2.1)
     rack-test (0.5.4)
@@ -52,8 +59,6 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
     tilt (1.3.3)
     treetop (1.4.8)
       polyglot (>= 0.3.1)
@@ -66,18 +71,14 @@ DEPENDENCIES
   builder
   coffee-script (~> 2.2.0)
   compass (~> 0.10.2)
-  contest
   erubis
-  haml (~> 3.0)
-  jeweler
+  frank!
   less
   liquid
-  mongrel (~> 1.2.0.pre2)
-  net-scp (~> 1.0)
-  net-ssh (~> 2.0)
-  rack (~> 1.1)
+  mocha
+  net-scp
+  net-sftp
   rack-test (~> 0.5)
   rake
   rdiscount
   rspec (~> 2.6.0)
-  tilt (~> 1.3)

data/Rakefile

@@ -1 +1,8 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new do |t|
+  t.name = :tests
+  t.pattern = "spec/**/*_spec.rb"
+end

data/frank.gemspec

@@ -16,18 +16,18 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.add_runtime_dependency 'rack', '~> 1.1'
   s.add_runtime_dependency 'mongrel', '~> 1.2.0.pre2'
   s.add_runtime_dependency 'haml', '~> 3.0'
   s.add_runtime_dependency 'tilt', '~> 1.3'
   s.add_runtime_dependency 'net-ssh', '~> 2.0'
-  s.add_runtime_dependency 'net-scp', '~> 1.0'
-  
+
   s.add_development_dependency 'rspec', '~> 2.6.0'
   s.add_development_dependency 'rack-test', '~> 0.5'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'builder'
+  s.add_development_dependency 'mocha'
   s.add_development_dependency 'erubis'
   s.add_development_dependency 'compass', '~> 0.10.2'
   s.add_development_dependency 'rdiscount'
@@ -35,4 +35,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'less'
   s.add_development_dependency 'coffee-script', '~> 2.2.0'
   s.add_development_dependency 'RedCloth'
-end
+  s.add_development_dependency 'net-scp'
+  s.add_development_dependency 'net-sftp'
+end

data/lib/frank/base.rb

@@ -223,15 +223,6 @@ module Frank
     Frank.reset
     Frank.root = new_root if new_root
 
-    if %w[publish p].include? ARGV.first
-      begin
-        require 'net/ssh'
-        require 'net/scp'
-      rescue LoadError
-        puts "\033[31mpublish requires the 'net-scp' gem. `gem install net-scp'\033[0m"
-        exit!
-      end
-    end
 
     # setup compass
     begin

data/lib/frank/cli.rb

@@ -130,7 +130,7 @@ module Frank
         when 'publish', 'p'
           # compile the project and scp it to server
           Frank.publishing!
-          Frank::Publish::SCP.execute!
+          Frank::Publish.execute!
         when 'upgrade'
           # upgrade if we need to upgrade
           Frank.upgrade!

data/lib/frank/middleware/statik.rb

@@ -1,7 +1,7 @@
 module Frank
   module Middleware
     class Statik
- 
+
       def initialize(app, options={})
         @app = app
         frank_root = File.expand_path(File.dirname(File.dirname(__FILE__))) + '/templates'
@@ -9,13 +9,13 @@ module Frank
         @frank_server = Rack::File.new(frank_root)
         @static_server = Rack::File.new(root)
       end
- 
+
       # handles serving from __frank__
       # looks for static access, if not found,
       # passes request to frank
       def call(env)
         path = env['PATH_INFO'].dup
- 
+
         if path.include? '__frank__'
           env['PATH_INFO'].gsub!('/__frank__', '')
           result = @frank_server.call(env)
@@ -24,18 +24,18 @@ module Frank
           env['PATH_INFO'] << 'index.html' if path[-1..-1] == '/'
           result = @static_server.call(env)
         end
-      
+
         # return if static assets found
         # else reset the path and pass to frank
-        if result[0] == 200
+        if result[0] == 200 || result[0] == 304
           result
         else
           env['PATH_INFO'] = path
           @app.call(env)
         end
-      
+
       end
-      
+
     end
   end
-end
+end

data/lib/frank/publish.rb

@@ -1,68 +1,76 @@
 module Frank
   module Publish
 
-    class SCP
-      def self.execute!
-        exit_unless_configured
 
-        unless Frank.silent_export?
-          puts "\nFrank is..."
-          puts " - \033[32mExporting templates\033[0m"
-        end
+    def self.execute!
+      protocol = exit_unless_configured.to_s
 
-        tmp_folder = "/tmp/frankexp-#{Frank.proj_name}"
+      ok_message "", "\nFrank is..."
+      ok_message "Exporting templates", " - "
 
-        # remove stale folder if it exists
-        FileUtils.rm_rf(tmp_folder) if File.exist?(tmp_folder)
+      # upload the files and report progress
+      ok_message "Publishing to: `#{Frank.publish.host}:#{Frank.publish.path}' via #{protocol}", " - "
 
-        # dump the project in production mode to tmp folder
-        Frank.export.path = tmp_folder
-        Frank.export.silent = true
-        Frank::Compile.export!
 
-        puts " - \033[32mPublishing to:\033[0m `#{Frank.publish.host}:#{Frank.publish.path}'" unless Frank.silent_export?
+      req = "frank/publish/#{protocol.downcase}"
+      rescue_load_error protocol do
+        require req
+        clazz = Frank::Publish.const_get(protocol.upcase)
+        publisher = clazz.new(Frank.publish)
+        publisher.perform!
+      end
 
-        ssh_options = {
-          :password => Frank.publish.password,
-          :port     => Frank.publish.port
-        }
+      ok_message "\nPublish complete!"
+    end
 
-        current = nil
+    def self.exit_unless_configured
+      required_settings = {:host => Frank.publish.host, :path => Frank.publish.path, :username => Frank.publish.username}
 
-        # upload the files and report progress
-        Net::SSH.start(Frank.publish.host, Frank.publish.username, ssh_options) do |ssh|
-          ssh.scp.upload!("#{tmp_folder}/", Frank.publish.path, :recursive => true, :chunk_size => 2048) do |ch, name, sent, total|
+      should_exit = false
+      message = ""
 
-            puts "   - #{name[tmp_folder.length..-1]}" unless name == current || Frank.silent_export?
+      protocol = Frank.publish.mode || :scp
+      unless [:ftp, :ftptls, :sftp, :scp].include?(protocol.to_sym)
+        message << "Frank.publish.mode = #{protocol} is not supported. Supported publish modes are 'ftp', 'ftptls', 'sftp' or 'scp' (default)\n"
+        should_exit = true
+      end
 
-            current = name
-          end
+      required_settings.each do |name, value|
+        if value.nil?
+          message << "Frank.publish.#{name} is required to publish. You can configure it in setup.rb\n"
+          should_exit = true
         end
+      end
 
-        # cleanup by removing tmp folder
-        FileUtils.rm_rf(tmp_folder)
 
-        puts "\n\033[32mPublish complete!\033[0m" unless Frank.silent_export?
+      if should_exit
+        err_message message
+        exit!
       end
 
-      def self.exit_unless_configured
-        required_settings = { :host => Frank.publish.host, :path => Frank.publish.path, :username => Frank.publish.username }
-        should_exit       = false
-        message           = "\033[31m"
+      protocol
+    end
 
-        required_settings.each do |name, value|
-          if value.nil?
-            message << "Frank.publish.#{name} is required to publish. You can configure it in setup.rb\n"
-            exiting = true
-          end
-        end
+    def self.rescue_load_error protocol, &blk
+      gem = "net-#{protocol}"
+      begin
+        yield
+      rescue LoadError
+        err_message "Publishing via #{protocol} requires the '#{gem}' gem. `gem install #{gem}'"
+        exit!
+      end
+    end
 
-        message << "\033[0m"
 
-        puts message and exit! if should_exit
-      end
+    def self.ok_message str, prefix = ''
+      puts "#{prefix}\033[32m#{str}\033[0m"
+    end
 
+    def self.err_message str, prefix = ''
+      puts "#{prefix}\033[31m#{str}\033[0m"
     end
 
+
   end
+
 end

data/lib/frank/publish/base.rb

@@ -0,0 +1,94 @@
+module Frank
+  module Publish
+    class Base
+
+      attr_accessor :username, :password
+      attr_accessor :hostname, :port
+      attr_accessor :remote_path
+      attr_accessor :local_path
+
+
+      def initialize(options)
+        @username = options.user || options.username
+        @password = options.password
+        @hostname = options.host
+        @remote_path = options.path
+        @port = options.port
+        @local_path = "/tmp/frank-publish-#{Frank.proj_name}-#{Time.now.to_i}"
+      end
+
+      ##
+      # Performs the backup transfer
+      def perform!
+        export!
+        begin
+          transfer!
+        rescue SocketError
+          err_message "Transfer failed. SocketError. Do you have internet?"
+        end
+        cleanup!
+      end
+
+
+      private
+
+      def export!
+        # remove stale folder if it exists
+        FileUtils.rm_rf(local_path) if File.exist?(local_path)
+
+        # dump the project in production mode to tmp folder
+        Frank.export.path = @local_path
+        Frank.export.silent = true
+        Frank::Compile.export!
+      end
+
+
+      ##
+      # returns a local_path relative list of all files to transfer for this export
+      def files_to_transfer
+        list = []
+        return list unless File.exist?(local_path)
+
+        Dir.chdir(local_path) do
+          list = Dir.glob("**/*").map do |f|
+            f unless File.directory? f
+          end.compact!
+        end
+
+        list
+      end
+
+      ##
+      # returns a local_path relative list of all directories to export
+      def directories
+        list = []
+        return list unless File.exist?(local_path)
+
+        Dir.chdir(local_path) do
+          list = Dir.glob("**/*").map do |f|
+            f if File.directory? f
+          end.compact!
+        end
+
+        list
+      end
+
+      def cleanup!
+        FileUtils.rm_rf(@local_path)
+      end
+
+      # ZOMG, we a need a Logger or sth.
+      def ok_message *args
+        Frank::Publish.ok_message *args
+      end
+
+      def err_message *args
+        Frank::Publish.err_message *args
+      end
+
+
+    end
+
+
+  end
+end

data/lib/frank/publish/ftp.rb

@@ -0,0 +1,80 @@
+require 'frank/publish/base'
+require 'net/ftp'
+
+module Frank
+  module Publish
+
+    class FTP < Base
+
+      def initialize(options, &block)
+        super(options)
+        instance_eval(&block) if block_given?
+
+        @port ||= 21
+        @remote_path = remote_path.sub(/^\~\//, '').sub(/^\//, '')
+      end
+
+      private
+
+      ##
+      # Establishes a connection to the remote server
+      #
+      # Note:
+      # Since the FTP port is defined as a constant in the Net::FTP class, and
+      # might be required to change by the user, we dynamically remove and
+      # re-add the constant with the provided port value
+      def connection
+        if Net::FTP.const_defined?(:FTP_PORT)
+          Net::FTP.send(:remove_const, :FTP_PORT)
+        end; Net::FTP.send(:const_set, :FTP_PORT, port)
+
+        Net::FTP.open(hostname, username, password) do |ftp|
+          ftp.passive = true
+          yield ftp
+        end
+      end
+
+      ##
+      # Transfers the archived file to the specified remote server
+      def transfer!
+        connection do |ftp|
+          directories.each do |dir|
+            create_remote_path(File.join(remote_path, dir), ftp)
+          end
+
+          files_to_transfer.each do |file|
+            ok_message "Uploading #{file}", "    - "
+            ftp.put(
+              File.join(local_path, file),
+              File.join(remote_path, file)
+            )
+          end
+        end
+      end
+
+      ##
+      # Creates (if they don't exist yet) all the directories on the remote
+      # server in order to upload the backup file. Net::FTP does not support
+      # paths to directories that don't yet exist when creating new
+      # directories. Instead, we split the parts up in to an array (for each
+      # '/') and loop through that to create the directories one by one.
+      # Net::FTP raises an exception when the directory it's trying to create
+      # already exists, so we have rescue it
+      def create_remote_path(remote_path, ftp)
+        path_parts = []
+        remote_path.split('/').each do |path_part|
+          path_parts << path_part
+          begin
+            dir = path_parts.join('/')
+            ftp.mkdir(dir) unless dir.empty?
+          rescue Net::FTPPermError;
+          end
+        end
+      end
+
+
+    end
+
+
+  end
+end