middleman-deploy 0.0.12 → 0.1.0

data/Gemfile

@@ -4,15 +4,15 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem "rake",     "~> 0.9.2"
-  gem "rdoc",     "~> 3.9"
-  gem "yard",     "~> 0.8.0"
+  gem "rake"
+  gem "rdoc"
+  gem "yard"
 end
 
 group :test do
-  gem "cucumber", "~> 1.2.0"
+  gem "cucumber"
   gem "fivemat"
-  gem "aruba",    "~> 0.4.11"
-  gem "rspec",    "~> 2.7"
+  gem "aruba"
+  gem "rspec"
   gem "simplecov"
 end

data/README.md

@@ -1,35 +1,30 @@
-Middleman Deploy - Deploy a [middleman](http://middlemanapp.com/) built site over rsync, git (e.g. gh-pages on github) or via ftp.
+Middleman Deploy - Deploy a [middleman](http://middlemanapp.com/)
+built site over rsync, ftp, sftp, or git (e.g. gh-pages on github).
 
 [![Build Status](https://secure.travis-ci.org/tvaughan/middleman-deploy.png)](http://travis-ci.org/tvaughan/middleman-deploy)
 
-===
+# QUICK START
 
-## QUICK START
-
-### Step 1
-
-    gem install middleman-deploy
-
-### Step 2
+## Step 1
 
     middleman init example-site
     cd example-site
 
-### Step 3
+## Step 2
 
 Edit `Gemfile`, and add:
 
-    gem "middleman-deploy", "~> 0.0.12"
+    gem "middleman-deploy", ">= 0.1.0"
 
 Then run:
 
     bundle install
 
-### Step 4a - Rsync setup
+## Step 3a - Rsync setup
 
 First be sure that `rsync` is installed.
 
-#### These settings are required.
+**These settings are required.**
 
 Edit `config.rb`, and add:
 
@@ -42,7 +37,7 @@ Edit `config.rb`, and add:
 
 Adjust these values accordingly.
 
-#### These settings are optional.
+**These settings are optional.**
 
 To use a particular SSH port, add:
 
@@ -56,7 +51,11 @@ To remove orphaned files or directories on the remote host, add:
 
 Default is `false`.
 
-### Step 4b - Git setup
+## Step 3b - Git setup
+
+First be sure that `git` is installed.
+
+**These settings are required.**
 
 Edit `config.rb`, and add:
 
@@ -67,7 +66,7 @@ Edit `config.rb`, and add:
 By default this will deploy to the `gh-pages` branch on the `origin`
 remote. The `build` directory will become a git repo.
 
-#### These settings are optional.
+**These settings are optional.**
 
 To use a particular remote, add:
 
@@ -86,9 +85,9 @@ To use a particular branch, add:
 Default is `gh-pages`. This branch will be created on the remote if it
 doesn't already exist.
 
-### Step 4c - FTP setup
+## Step 3c - FTP setup
 
-#### These settings are required.
+**These settings are required.**
 
 Edit `config.rb`, and add:
 
@@ -102,21 +101,49 @@ Edit `config.rb`, and add:
 
 Adjust these values accordingly.
 
-### Step 5
+## Step 3d - SFTP setup
+
+**These settings are required.**
+
+Edit `config.rb`, and add:
+
+    activate :deploy do |deploy|
+      deploy.method = :sftp
+      deploy.host = "sftp.example.com"
+      deploy.user = "tvaughan"
+      deploy.password = "secret"
+      deploy.path = "/srv/www/site"
+    end
+
+Adjust these values accordingly.
+
+## Step 4
 
     middleman build [--clean]
-    middleman deploy [--clean]
+    middleman deploy [--build-before]
 
-To automatically run middleman-deploy after `middleman build`, add:
+To run `middleman build` before `middleman deploy`, add:
 
-      deploy.after_build = true
+    deploy.build_before = true
 
 Default is `false`.
 
-Please note that if the `--clean` or `--no-clean` option is passed to
-`middleman build` it will not be passed to `middleman deploy`. For now
-only the value of `deploy.clean` in `config.rb` will be used.
+## BREAKING CHANGES
+
+ * v0.1.0
+
+   * Removed the `--clean` command-line option. This option only applied
+   to the rsync deploy method. The idea going forward is that
+   command-line options must apply to all deploy methods. Options that
+   are specific to a deploy method will only be available in
+   `config.rb`.
+
+   * Removed `deploy` from the `after_build` hook. This caused a
+   `deploy` to be run each time `build` was called. This workflow never
+   made sense. `deploy` was added to the `after_build` hook simply
+   because it was available.
 
-### NOTES
+## NOTES
 
-Inspired by the rsync task in [Octopress](https://github.com/imathis/octopress).
+Inspired by the rsync task in
+[Octopress](https://github.com/imathis/octopress).

data/lib/middleman-deploy/commands.rb

@@ -22,12 +22,23 @@ module Middleman
         true
       end
 
-      desc "deploy", "Deploy build directory to a remote host via rsync or git"
-      method_option "clean",
+      desc "deploy [options]", Middleman::Deploy::TAGLINE
+      method_option "build_before",
       :type => :boolean,
-      :aliases => "-c",
-      :desc => "Remove orphaned files or directories on the remote host"
+      :aliases => "-b",
+      :desc => "Run `middleman build` before the deploy step"
+
       def deploy
+        if options.has_key? "build_before"
+          build_before = options.build_before
+        else
+          build_before = self.deploy_options.build_before
+        end
+        if build_before
+          # http://forum.middlemanapp.com/t/problem-with-the-build-task-in-an-extension
+          builder = ::Middleman::Cli::Build.new(args=[], options={:instrument=>false})
+          builder.build
+        end
         send("deploy_#{self.deploy_options.method}")
       end
 
@@ -36,7 +47,7 @@ module Middleman
       def print_usage_and_die(message)
         raise Error, "ERROR: " + message + "\n" + <<EOF
 
-You should follow one of the three examples below to setup the deploy
+You should follow one of the four examples below to setup the deploy
 extension in config.rb.
 
 # To deploy the build directory to a remote host via rsync:
@@ -70,6 +81,16 @@ activate :deploy do |deploy|
   deploy.password = "secret"
   deploy.path = "/srv/www/site"
 end
+
+# To deploy the build directory to a remote host via sftp:
+activate :deploy do |deploy|
+  deploy.method = :sftp
+  # host, user, passwword and path *must* be set
+  deploy.host = "sftp.example.com"
+  deploy.user = "tvaughan"
+  deploy.password = "secret"
+  deploy.path = "/srv/www/site"
+end
 EOF
       end
 
@@ -90,15 +111,14 @@ EOF
           print_usage_and_die "The deploy extension requires you to set a method."
         end
 
-        if (options.method == :rsync)
+        case options.method
+        when :rsync
           if (!options.host || !options.user || !options.path)
             print_usage_and_die "The rsync deploy method requires host, user, and path to be set."
           end
-        end
-
-        if (options.method == :ftp)
+        when :ftp, :sftp
           if (!options.host || !options.user || !options.password || !options.path)
-            print_usage_and_die "The ftp deploy method requires host, user, password, and path to be set."
+            print_usage_and_die "The #{options.method} method requires host, user, password, and path to be set."
           end
         end
 
@@ -115,13 +135,7 @@ EOF
 
         command = "rsync -avze '" + "ssh -p #{port}" + "' #{self.inst.build_dir}/ #{user}@#{host}:#{path}"
 
-        if options.has_key? "clean"
-          clean = options.clean
-        else
-          clean = self.deploy_options.clean
-        end
-
-        if clean
+        if self.deploy_options.clean
           command += " --delete"
         end
 
@@ -158,7 +172,7 @@ EOF
           end
 
           #if there is a branch with that name, switch to it, otherwise create a new one and switch to it
-          if `git branch`.split("\n").delete_if{ |r| r =~ Regexp.new(branch,true) }.count == 0
+          if `git branch`.split("\n").any? { |b| b =~ /#{branch}/i }
             `git checkout #{branch}`
           else
             `git checkout -b #{branch}`
@@ -220,6 +234,45 @@ EOF
         ftp.close
       end
 
+      def deploy_sftp
+        require 'net/sftp'
+        require 'ptools'
+
+        host = self.deploy_options.host
+        user = self.deploy_options.user
+        pass = self.deploy_options.password
+        path = self.deploy_options.path
+
+        puts "## Deploying via sftp to #{user}@#{host}:#{path}"
+
+        Net::SFTP.start(host, user, :password => pass) do |sftp|
+          sftp.mkdir(path)
+          Dir.chdir(self.inst.build_dir) do
+            files = Dir.glob('**/*', File::FNM_DOTMATCH)
+            files.reject { |a| a =~ Regexp.new('\.$') }.each do |f|
+              if File.directory?(f)
+                begin
+                  sftp.mkdir("#{path}/#{f}")
+                  puts "Created directory #{f}"
+                rescue
+                end
+              else
+                begin
+                  sftp.upload(f, "#{path}/#{f}")
+                rescue Exception => e
+                  reply = e.message
+                  err_code = reply[0,3].to_i
+                  if err_code == 550
+                    sftp.upload(f, "#{path}/#{f}")
+                  end
+                end
+                puts "Copied #{f}"
+              end
+            end
+          end
+        end
+      end
+
     end
 
     # Alias "d" to "deploy"

data/lib/middleman-deploy/extension.rb

@@ -5,7 +5,7 @@ require "middleman-core"
 module Middleman
   module Deploy
 
-    class Options < Struct.new(:whatisthis, :method, :host, :port, :user, :password, :path, :clean, :remote, :branch, :after_build); end
+    class Options < Struct.new(:whatisthis, :method, :host, :port, :user, :password, :path, :clean, :remote, :branch, :build_before); end
 
     class << self
 
@@ -22,11 +22,7 @@ module Middleman
         options.remote ||= "origin"
         options.branch ||= "gh-pages"
 
-        options.after_build ||= false
-
-        app.after_build do |builder|
-          ::Middleman::Cli::Deploy.new.deploy if options.after_build
-        end
+        options.build_before ||= false
 
         @@options = options
 

data/lib/middleman-deploy/pkg-info.rb

@@ -1,6 +1,7 @@
 module Middleman
   module Deploy
     PACKAGE = "middleman-deploy"
-    VERSION = "0.0.12"
+    VERSION = "0.1.0"
+    TAGLINE = "Deploy a middleman built site over rsync, ftp, sftp, or git (e.g. gh-pages on github)."
   end
 end

data/middleman-deploy.gemspec

@@ -9,8 +9,9 @@ Gem::Specification.new do |s|
   s.authors     = ["Tom Vaughan"]
   s.email       = ["thomas.david.vaughan@gmail.com"]
   s.homepage    = "http://tvaughan.github.com/middleman-deploy/"
-  s.summary     = %q{Deploy a middleman built site over rsync, ftp, or git (e.g. gh-pages on github).}
-  s.description = %q{Deploy a middleman built site over rsync, ftp, or git (e.g. gh-pages on github).}
+  s.summary     = Middleman::Deploy::TAGLINE
+  s.description = Middleman::Deploy::TAGLINE
+  s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -22,4 +23,5 @@ Gem::Specification.new do |s|
 
   # Additional dependencies
   s.add_runtime_dependency("ptools")
+  s.add_runtime_dependency("net-sftp")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -43,7 +43,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Deploy a middleman built site over rsync, ftp, or git (e.g. gh-pages
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deploy a middleman built site over rsync, ftp, sftp, or git (e.g. gh-pages
   on github).
 email:
 - thomas.david.vaughan@gmail.com
@@ -65,7 +81,8 @@ files:
 - lib/middleman_extension.rb
 - middleman-deploy.gemspec
 homepage: http://tvaughan.github.com/middleman-deploy/
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -87,6 +104,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Deploy a middleman built site over rsync, ftp, or git (e.g. gh-pages on github).
+summary: Deploy a middleman built site over rsync, ftp, sftp, or git (e.g. gh-pages
+  on github).
 test_files: []
 has_rdoc: