frank 1.0.9 → 1.0.10

data/spec/publish/ftptls_spec.rb

@@ -0,0 +1,143 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+require 'frank/publish/ftptls'
+
+describe Frank::Publish::FTPTLS do
+
+  let(:publisher) do
+    Frank::Publish::FTPTLS.new(Frank.publish) do |ftp|
+      ftp.username = 'my_username'
+      ftp.password = 'my_password'
+      ftp.hostname = 'ftp.example.com'
+      ftp.local_path = '/local/path'
+      ftp.remote_path = '/remote/path'
+    end
+  end
+
+  before(:all) do
+    Frank.bootstrap(File.join(File.dirname(__FILE__), 'template'))
+  end
+
+  describe '#initialize' do
+    it 'should set the correct values' do
+      publisher.username.should == 'my_username'
+      publisher.password.should == 'my_password'
+      publisher.hostname.should == 'ftp.example.com'
+      publisher.port.should == 21
+      publisher.local_path.should == '/local/path'
+      publisher.remote_path.should == 'remote/path'
+
+    end
+
+    it 'should remove any preceeding tilde and slash from the path' do
+      publisher = Frank::Publish::FTPTLS.new(Frank.publish) do |ftp|
+        ftp.remote_path = '~/my_backups/path'
+      end
+      publisher.remote_path.should == 'my_backups/path'
+    end
+
+    context 'when setting configuration defaults' do
+
+
+    end # context 'when setting configuration defaults'
+
+  end # describe '#initialize'
+
+  describe '#connection' do
+    let(:connection) { mock }
+
+    it 'should yield a connection to the remote server' do
+      Net::FTPTLS.expects(:open).with(
+        'ftp.example.com', 'my_username', 'my_password'
+      ).yields(connection)
+
+      connection.expects(:passive=).with(true)
+
+      publisher.send(:connection) do |ftp|
+        ftp.should be(connection)
+      end
+    end
+
+    it 'should set the Net::FTP_PORT constant' do
+      publisher.port = 40
+      Net::FTPTLS.expects(:const_defined?).with(:FTP_PORT).returns(true)
+      Net::FTPTLS.expects(:send).with(:remove_const, :FTP_PORT)
+      Net::FTPTLS.expects(:send).with(:const_set, :FTP_PORT, 40)
+
+      Net::FTPTLS.expects(:open)
+      publisher.send(:connection)
+    end
+
+  end # describe '#connection'
+
+  describe '#transfer!' do
+    let(:connection) { mock }
+    let(:package) { mock }
+    let(:files) { ["file1", "file2", "subdir1/file3", "subdir2/file4"] }
+    let(:dirs) { ["subdir1", "subdir2"] }
+    let(:s) { sequence '' }
+
+    before do
+      publisher.stubs(:connection).yields(connection)
+      publisher.stubs(:files_to_transfer).returns(files)
+      publisher.stubs(:directories).returns(dirs)
+    end
+
+    it 'should transfer the files' do
+
+
+      # connection.expects(:chdir).in_sequence(s).with('remote/path')
+
+      #publisher.expects(:directories).in_sequence(s)
+
+      publisher.expects(:create_remote_path).in_sequence(s).with('remote/path/subdir1', connection)
+      publisher.expects(:create_remote_path).in_sequence(s).with('remote/path/subdir2', connection)
+
+      connection.expects(:put).in_sequence(s).with(
+        File.join('/local/path', 'file1'),
+        File.join('remote/path', 'file1')
+      )
+
+      connection.expects(:put).in_sequence(s).with(
+        File.join('/local/path', 'file2'),
+        File.join('remote/path', 'file2')
+      )
+
+      connection.expects(:put).in_sequence(s).with(
+        File.join('/local/path', 'subdir1/file3'),
+        File.join('remote/path', 'subdir1/file3')
+      )
+
+      connection.expects(:put).in_sequence(s).with(
+        File.join('/local/path', 'subdir2/file4'),
+        File.join('remote/path', 'subdir2/file4')
+      )
+
+      publisher.send(:transfer!)
+    end
+  end # describe '#transfer!'
+
+
+  describe '#create_remote_path' do
+    let(:connection) { mock }
+    let(:remote_path) { 'remote/folder/another_folder' }
+    let(:s) { sequence '' }
+
+    context 'while properly creating remote directories one by one' do
+      it 'should rescue any FTPPermErrors and continue' do
+        connection.expects(:mkdir).in_sequence(s).
+          with("remote").raises(Net::FTPPermError)
+        connection.expects(:mkdir).in_sequence(s).
+          with("remote/folder")
+        connection.expects(:mkdir).in_sequence(s).
+          with("remote/folder/another_folder")
+
+        expect do
+          publisher.send(:create_remote_path, remote_path, connection)
+        end.not_to raise_error
+      end
+    end
+  end
+
+end

data/spec/publish/scp_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+require 'frank/publish/scp'
+
+describe Frank::Publish::SCP do
+
+  let(:publisher) do
+    Frank::Publish::SCP.new(Frank.publish) do |scp|
+      scp.username = 'my_username'
+      scp.password = 'my_password'
+      scp.hostname = 'scp.example.com'
+      scp.local_path = '/local/path'
+      scp.remote_path = '/remote/path'
+    end
+  end
+
+  before(:all) do
+    Frank.bootstrap(File.join(File.dirname(__FILE__), 'template'))
+  end
+
+  describe '#initialize' do
+    it 'should set the correct values' do
+      publisher.username.should == 'my_username'
+      publisher.password.should == 'my_password'
+      publisher.hostname.should == 'scp.example.com'
+      publisher.port.should == 22
+      publisher.local_path.should == '/local/path'
+      publisher.remote_path.should == '/remote/path'
+
+    end
+
+  end # describe '#initialize'
+
+  describe '#connection' do
+    let(:connection) { mock }
+
+    it 'should yield a connection to the remote server' do
+      Net::SCP.expects(:start).with('scp.example.com', 'my_username', :password => 'my_password').yields(connection)
+
+      publisher.send(:connection) do |scp|
+        scp.should be(connection)
+      end
+    end
+
+  end # describe '#connection'
+
+  describe '#transfer!' do
+    let(:connection) { mock }
+
+    before do
+      publisher.stubs(:connection).yields(connection)
+    end
+
+    it 'should transfer the local_path to remote_path using upload!' do
+      connection.expects(:upload!).with('/local/path', '/remote/path')
+
+      publisher.send(:transfer!)
+    end
+  end # describe '#transfer!'
+
+end

data/spec/publish/sftp_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper.rb', __FILE__)
+require 'frank/publish/sftp'
+
+describe Frank::Publish::SFTP do
+
+  let(:publisher) do
+    Frank::Publish::SFTP.new(Frank.publish) do |scp|
+      scp.username = 'my_username'
+      scp.password = 'my_password'
+      scp.hostname = 'scp.example.com'
+      scp.local_path = '/local/path'
+      scp.remote_path = '/remote/path'
+    end
+  end
+
+  before(:all) do
+    Frank.bootstrap(File.join(File.dirname(__FILE__), 'template'))
+  end
+
+  describe '#initialize' do
+    it 'should set the correct values' do
+      publisher.username.should == 'my_username'
+      publisher.password.should == 'my_password'
+      publisher.hostname.should == 'scp.example.com'
+      publisher.port.should == 22
+      publisher.local_path.should == '/local/path'
+      publisher.remote_path.should == '/remote/path'
+
+    end
+
+  end # describe '#initialize'
+
+  describe '#connection' do
+    let(:connection) { mock }
+
+    it 'should yield a connection to the remote server' do
+      Net::SFTP.expects(:start).with('scp.example.com', 'my_username', :password => 'my_password').yields(connection)
+
+      publisher.send(:connection) do |scp|
+        scp.should be(connection)
+      end
+    end
+
+  end # describe '#connection'
+
+  describe '#transfer!' do
+    let(:connection) { mock }
+
+    before do
+      publisher.stubs(:connection).yields(connection)
+    end
+
+    it 'should transfer the local_path to remote_path using upload!' do
+      connection.expects(:upload!).with('/local/path', '/remote/path')
+
+      publisher.send(:transfer!)
+    end
+  end # describe '#transfer!'
+
+end

data/spec/publish_spec.rb

@@ -1,23 +1,73 @@
-require File.dirname(__FILE__) + '/helper'
+require File.dirname(__FILE__) + '/spec_helper'
+
 
 describe Frank::Publish do
   include Rack::Test::Methods
   include Frank::Spec::Helpers
 
-    let(:proj_dir) { File.join(File.dirname(__FILE__), 'template') }
+  let(:proj_dir) { File.join(File.dirname(__FILE__), 'template') }
+  let(:protocols) { [:ftp, :ftptls, :sftp, :scp] }
 
-    before :all do
-      Dir.chdir proj_dir do
-        frank 'publish'
-      end
+  before(:all) do
+    Frank.bootstrap(proj_dir)
+  end
+
+  describe '#exit_unless_configured' do
+
+    before do
+      Frank.publish.host = 'example.com'
+      Frank.publish.username = 'test'
     end
 
-    it 'creates the published folder' do
-      File.exist?("/tmp/frankexp-#{proj_dir.split('/').last}").should be_true
+    # How do I prohibit SystemExit from really exiting?
+    #
+    #it 'should exit if mandatory username param is missing' do
+    #  Frank.publish.username= nil
+    #
+    #  lambda {
+    #    Frank::Publish.exit_unless_configured
+    #  }.should raise_error(SystemExit)
+    #end
+    #
+    #it 'should exit if mandatory host param is missing' do
+    #  Frank.publish.host= nil
+    #
+    #  lambda {
+    #    Frank::Publish.exit_unless_configured
+    #  }.should raise_error(SystemExit)
+    #end
+
+    it 'should return the publish protocol to use' do
+      protocols.each do |p|
+        Frank.publish.mode = p
+
+        Frank::Publish.exit_unless_configured.should == p
+      end
+
     end
 
-    after(:all) do
-      #FileUtils.rm_r File.join(File.dirname(__FILE__), 'template/output')
+  end
+
+  describe '#execute!' do
+
+    let(:publisher) { mock }
+
+    it 'should instatiate and call perform! on the appropriate class' do
+      protocols.each do |proto|
+        Frank.publish.mode = proto
+
+        require "frank/publish/#{proto}"
+
+        clazz = Frank::Publish.const_get(proto.to_s.upcase)
+        clazz.stubs(:new).with(Frank.publish).returns(publisher)
+        publisher.expects(:perform!)
+
+        Frank::Publish.execute!
+
+      end
+
     end
+  end
+
 
 end

data/spec/render_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe Frank::Render do
   include Rack::Test::Methods
@@ -56,7 +56,7 @@ describe Frank::Render do
      template = @app.render('partial_locals_test.haml')
      template.should == "\n<div id='p'>/partial_locals_test</div>\n<div id='layout'>\n  <h1>hello worlds</h1>\n  <h2>/partial_locals_test</h2>\n  <p>hello from local</p>\n</div>\n"
    end
-   
+
    it 'renders less template' do
      template = @app.render('stylesheets/less.less')
      template.should include("#hello-worlds { background: red; }")

data/spec/{helper.rb → spec_helper.rb}

@@ -1,23 +1,24 @@
 testdir = File.dirname(__FILE__)
 $:.unshift testdir unless $LOAD_PATH.include?(testdir)
 
-require 'bundler'
-Bundler.setup
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'bundler/setup'
 
 require 'stringio'
 require 'rack/test'
 require 'template/helpers'
 require 'frank'
+require 'frank/publish/base'
 
 module Kernel
- def capture_stdout
-   out = StringIO.new
-   $stdout = out
-   yield
-   return out
- ensure
-   $stdout = STDOUT
- end
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    return out
+  ensure
+    $stdout = STDOUT
+  end
 end
 
 module Frank
@@ -37,3 +38,20 @@ module Frank
     end
   end
 end
+
+module Frank
+  module Publish
+    def self.ok_message str, prefix = "";
+    end
+
+    def self.err_message str, prefix = "";
+    end
+  end
+end
+
+RSpec.configure do |config|
+  ##
+  # Use Mocha to mock with RSpec
+  config.mock_with :mocha
+
+end

data/spec/template/setup.rb

@@ -1,4 +1,5 @@
 Frank.environment = :test
-Frank.publish.path = '/tmp'
-Frank.publish.host = 'linda'
-Frank.publish.user = 'badmin'
+Frank.publish.path = '/remote/path'
+Frank.publish.host = 'example.com'
+Frank.publish.user = 'test'
+Frank.publish.password = 'secret'

data/spec/template_helpers_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/helper'
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe Frank::TemplateHelpers do
   include Rack::Test::Methods
@@ -27,12 +27,12 @@ describe Frank::TemplateHelpers do
     template = @app.render('refresh.haml')
     template.should include("<script type=\"text/javascript\">\n            (function(){")
   end
-  
+
   it 'renders content_for haml in the layout' do
     template = @app.render('content_for_haml.haml')
     template.should == "<meta foo='content' />\n<div id='p'>/content_for_haml</div>\n<div id='layout'>\n  \n</div>\n"
   end
-  
+
   it 'renders content_for erb in the layout' do
     template = @app.render('content_for_erb.erb')
     template.should == "  <meta foo='content' />\n<div id='p'>/content_for_erb</div>\n<div id='layout'>\n  \n</div>\n"
@@ -84,7 +84,7 @@ describe Frank::TemplateHelpers do
     it 'render image url using imager' do
       template = @app.render('lorem_test.haml')
       reg1 = /<img src='http:\/\/placehold\.it\/400x300' \/>/
-      reg2 = /<img src='http:\/\/placehold\.it\/400x300\/[a-z0-9]{6}\/[a-z0-9]{6}' \/>/      
+      reg2 = /<img src='http:\/\/placehold\.it\/400x300\/[a-z0-9]{6}\/[a-z0-9]{6}' \/>/
       reg3 = /<img src='http:\/\/placehold\.it\/400x300\/444\/eee' \/>/
       reg4 = /<img src='http:\/\/placehold\.it\/400x300\/ccc\/aaa' \/>/
       reg5 = /<img src='http:\/\/placehold\.it\/400x300\/444(&amp;|&)text=blah' \/>/