middleman-deploy-with-notifications 0.0.30

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6bb21ad698e22b91a8b1930291fe5d88f5fd5607
+  data.tar.gz: 1742203e9541ac3f9db5506b5e47687962ed511a
+SHA512:
+  metadata.gz: 68d7a9d039a590179b9bf0d81ff860f9ac171045efcf2fd9fa46ddfdb35b28a5816d304e05d086bcbb6d6391af5122661464d61c38d219422e4050469b54ad1c
+  data.tar.gz: aafc196453206172c4156284ccde8f95e0fdc97dd64c18cbeb4af05da421906ed62fb99f40a36dfa202f9a721934393e547661128f6cf40b7e098b12dd40de57

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+coverage
+*.gem

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tom Vaughan <thomas.david.vaughan@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+# Specify your gem's dependencies in middleman-deploy.gemspec
+gemspec
+
+group :development do
+  gem "rake",     "~> 0.9.2"
+  gem "rdoc",     "~> 3.9"
+  gem "yard",     "~> 0.8.0"
+end
+
+group :test do
+  gem "cucumber", "~> 1.2.0"
+  gem "fivemat"
+  gem "aruba",    "~> 0.4.11"
+  gem "rspec",    "~> 2.7"
+  gem "simplecov"
+end

data/README.md

@@ -0,0 +1,122 @@
+Middleman Deploy - Deploy a [middleman](http://middlemanapp.com/) built site over rsync, git (e.g. gh-pages on github) or via ftp.
+
+[![Build Status](https://secure.travis-ci.org/tvaughan/middleman-deploy.png)](http://travis-ci.org/tvaughan/middleman-deploy)
+
+===
+
+## QUICK START
+
+### Step 1
+
+    gem install middleman-deploy
+
+### Step 2
+
+    middleman init example-site
+    cd example-site
+
+### Step 3
+
+Edit `Gemfile`, and add:
+
+    gem "middleman-deploy", "~> 0.0.11"
+
+Then run:
+
+    bundle install
+
+### Step 4a - Rsync setup
+
+First be sure that `rsync` is installed.
+
+#### These settings are required.
+
+Edit `config.rb`, and add:
+
+    activate :deploy do |deploy|
+      deploy.method = :rsync
+      deploy.user = "tvaughan"
+      deploy.host = "www.example.com"
+      deploy.path = "/srv/www/site"
+    end
+
+Adjust these values accordingly.
+
+#### These settings are optional.
+
+To use a particular SSH port, add:
+
+      deploy.port = 5309
+
+Default is `22`.
+
+To remove orphaned files or directories on the remote host, add:
+
+      deploy.clean = true
+
+Default is `false`.
+
+### Step 4b - Git setup
+
+Edit `config.rb`, and add:
+
+    activate :deploy do |deploy|
+      deploy.method = :git
+    end
+
+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.
+
+To use a particular remote, add:
+
+      deploy.remote = "some-other-remote-name"
+
+Default is `origin`. This can be a remote name or a git url.
+
+If you use a remote name, you must first add it using `git remote
+add`. Run `git remote -v` to see a list of possible remote names. If
+you use a git url, it must end with '.git'.
+
+To use a particular branch, add:
+
+      deploy.branch = "some-other-branch-name"
+
+Default is `gh-pages`. This branch will be created on the remote if it
+doesn't already exist.
+
+### Step 4c - FTP setup
+
+#### These settings are required.
+
+Edit `config.rb`, and add:
+
+    activate :deploy do |deploy|
+      deploy.method = :ftp
+      deploy.host = "ftp.example.com"
+      deploy.user = "tvaughan"
+      deploy.password = "secret"
+      deploy.path = "/srv/www/site"
+    end
+
+Adjust these values accordingly.
+
+### Step 5
+
+    middleman build [--clean]
+    middleman deploy [--clean]
+
+To automatically run middleman-deploy after `middleman build`, add:
+
+      deploy.after_build = 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.
+
+### NOTES
+
+Inspired by the rsync task in [Octopress](https://github.com/imathis/octopress).

data/Rakefile

@@ -0,0 +1,35 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
+end
+
+require 'rake/clean'
+
+task :test => ["cucumber"]
+
+require "middleman-deploy/pkg-info"
+
+PACKAGE = "#{Middleman::DeployWithNotifications::PACKAGE}"
+VERSION = "#{Middleman::DeployWithNotifications::VERSION}"
+
+task :package do
+  system "gem build #{PACKAGE}.gemspec"
+end
+
+task :install => :package do
+  Dir.chdir("pkg") do
+    system "gem install #{PACKAGE}-#{VERSION}"
+  end
+end
+
+task :release => :package do
+  Dir.chdir("pkg") do
+    system "gem push #{PACKAGE}-#{VERSION}"
+  end
+end
+
+task :default => :test

data/THANKS

@@ -0,0 +1,4 @@
+Ben Cates - Git deploy method.
+Gilbert Townshend - Bug reports and feature requests.
+Konstantin Gribov -- Git deploy method improvements.
+Benjamin Knofe -- FTP deploy method and Git improvements.

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require "simplecov"
+SimpleCov.start
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-deploy')

data/lib/middleman-deploy-with-notifications.rb

@@ -0,0 +1,9 @@
+require "middleman-core"
+
+require "middleman-deploy-with-notifications/commands"
+
+::Middleman::Extensions.register(:deploy) do
+  require "middleman-deploy-with-notifications/extension"
+  ::Middleman::DeployWithNotifications
+end
+

data/lib/middleman-deploy-with-notifications/commands.rb

@@ -0,0 +1,283 @@
+require "middleman-core/cli"
+
+require "middleman-deploy-with-notifications/extension"
+require "middleman-deploy-with-notifications/pkg-info"
+
+# for hipchat notifications
+require "net/http"
+require "uri"
+
+PACKAGE = "#{Middleman::DeployWithNotifications::PACKAGE}"
+VERSION = "#{Middleman::DeployWithNotifications::VERSION}"
+
+module Middleman
+  module Cli
+
+    # This class provides a "deploy" command for the middleman CLI.
+    class DeployWithNotifications < Thor
+      include Thor::Actions
+
+      check_unknown_options!
+
+      namespace :deploy
+
+      # Tell Thor to exit with a nonzero exit code on failure
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "deploy", "Deploy build directory to a remote host via rsync or git"
+      method_option "clean",
+      :type => :boolean,
+      :aliases => "-c",
+      :desc => "Remove orphaned files or directories on the remote host"
+      def deploy
+        send("deploy_#{self.deploy_options.method}")
+      end
+
+      protected
+
+      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
+extension in config.rb.
+
+# To deploy the build directory to a remote host via rsync:
+activate :deploy do |deploy|
+  deploy.method = :rsync
+  # host, user, and path *must* be set
+  deploy.user = "tvaughan"
+  deploy.host = "www.example.com"
+  deploy.path = "/srv/www/site"
+  # clean is optional (default is false)
+  deploy.clean = true
+end
+
+# To deploy to a remote branch via git (e.g. gh-pages on github):
+activate :deploy do |deploy|
+  deploy.method = :git
+  # remote is optional (default is "origin")
+  # run `git remote -v` to see a list of possible remotes
+  deploy.remote = "some-other-remote-name"
+  # branch is optional (default is "gh-pages")
+  # run `git branch -a` to see a list of possible branches
+  deploy.branch = "some-other-branch-name"
+end
+
+# To deploy the build directory to a remote host via ftp:
+activate :deploy do |deploy|
+  deploy.method = :ftp
+  # host, user, passwword and path *must* be set
+  deploy.host = "ftp.example.com"
+  deploy.user = "tvaughan"
+  deploy.password = "secret"
+  deploy.path = "/srv/www/site"
+end
+EOF
+      end
+
+      def deploy_options
+        options = nil
+
+        begin
+          options = ::Middleman::Application.server.inst.options
+        rescue
+          print_usage_and_die "You need to activate the deploy extension in config.rb."
+        end
+
+        if (!options.method)
+          print_usage_and_die "The deploy extension requires you to set a method."
+        end
+
+        if (options.method == :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)
+          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."
+          end
+        end
+
+        options
+      end
+
+      def send_hc_mesg(mesg, fmt = "text")
+        uri = uri || URI.parse( "http://api.hipchat.com/v1/rooms/message" )
+        hipchat_token = "66975dc754b5e7a0800e627708d61a"
+        hipchat_rooms = [26057,39979] # Engineering + BAP hc rooms
+
+        hipchat_rooms.each do |room|
+          Net::HTTP.post_form( uri, {
+            "format"          => "json",
+            "color"           => "random",
+            "auth_token"      => hipchat_token,
+            "room_id"         => room,
+            "from"            => "280 Deploy",
+            "message"         => mesg,
+            "message_format"  => fmt || "text"}
+          )
+        end
+      end
+
+      def hipchat_start(who, github_project)
+        send_hc_mesg( "Yo yo! @#{who} is deploying #{github_project}:" )
+      end
+
+      def hipchat_complete(who, github_project, github_user, rev, comment)
+        puts "Notifying hipchat room(s)".yellow
+
+        message =  "<a href='http://github.com/#{github_user}/#{github_project}/commit/#{rev}'>#{rev}</a> (#{comment}) is now live on <b><a href='http://#{github_project}'>production</a></b>."
+        send_hc_mesg(message, "html")
+      end
+
+      remove_task :send_hc_mesg, :hipchat_start, :hipchat_complete
+
+      def deploy_rsync
+        host = self.deploy_options.host
+        port = self.deploy_options.port
+        user = self.deploy_options.user
+        path = self.deploy_options.path
+
+        airbrake_api_key = self.deploy_options.airbrake_api_key
+        hipchat_rooms    = self.deploy_options.hipchat_rooms
+        hipchat_token    = self.deploy_options.hipchat_token
+
+        github_user, github_project = `git remote -v | grep "/" | head -n1`.gsub( /.*:([\w_-]+)\/([\w_\.-]+).git.*/, '\1/\2' ).split( "/" )
+        github_project.chomp!
+
+        who     = `git config --get github.user`.chomp
+        rev     = `git rev-parse --short HEAD`.gsub( /\s*$/, '' ).chomp
+        branch  = `git rev-parse --abbrev-ref HEAD`.gsub( /\s*/, '' ).chomp
+        comment = `git log -1 --pretty=%B`.gsub( /\s*$/, '' ).chomp
+
+        if self.deploy_options.airbrake_api_key
+          puts "Recording a timestamped deploy in Airbrake: #{rev}".green
+          url = "api_key=#{airbrake_api_key}&deploy[rails_env]=production&deploy[local_username]=#{who}&deploy[scm_repository]=git://github.com/140proof/280.140proof.com&deploy[scm_revision]=#{rev}"
+          `curl -d "#{url}" http://airbrake.io/deploys &> /dev/null`
+        end
+
+        hipchat_start(who, github_project)
+
+        puts "Deploying via rsync to #{user}@#{host}".red
+
+        command = "rsync -avze '" + "ssh -p #{port}" + "' build/ #{user}@#{host}:#{path}"
+
+        if options.has_key? "clean"
+          clean = options.clean
+        else
+          clean = self.deploy_options.clean
+        end
+
+        if clean
+          command += " --delete"
+        end
+
+        run command
+
+        hipchat_complete(who, github_project, github_user, rev, comment)
+
+      end
+
+      def deploy_git
+        remote = self.deploy_options.remote
+        branch = self.deploy_options.branch
+
+        puts "## Deploying via git to remote=\"#{remote}\" and branch=\"#{branch}\""
+
+        #check if remote is not a git url
+        unless remote =~ /\.git$/
+          remote = `git config --get remote.#{remote}.url`.chop
+        end
+
+        #if the remote name doesn't exist in the main repo
+        if remote == ''
+          puts "Can't deploy! Please add a remote with the name '#{self.deploy_options.remote}' to your repo."
+          exit
+        end
+
+        Dir.chdir('build') do
+          unless File.exists?('.git')
+            `git init`
+            `git remote add origin #{remote}`
+          else
+            #check if the remote repo has changed
+            unless remote == `git config --get remote.origin.url`.chop
+              `git remote rm origin`
+              `git remote add origin #{remote}`
+            end
+          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
+            `git checkout #{branch}`
+          else
+            `git checkout -b #{branch}`
+          end
+
+          `git add -A`
+          `git commit --allow-empty -am 'Automated commit at #{Time.now.utc} by #{PACKAGE} #{VERSION}'`
+          `git push -f origin #{branch}`
+        end
+      end
+
+      def deploy_ftp
+        require 'net/ftp'
+        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 ftp to #{user}@#{host}:#{path}"
+
+        ftp = Net::FTP.new(host)
+        ftp.login(user, pass)
+        ftp.chdir(path)
+        ftp.passive = true
+
+        Dir.chdir('build/') do
+          files = Dir.glob('**/*', File::FNM_DOTMATCH)
+          files.reject { |a| a =~ Regexp.new('\.$') }.each do |f|
+            if File.directory?(f)
+              begin
+                ftp.mkdir(f)
+                puts "Created directory #{f}"
+              rescue
+              end
+            else
+              begin
+                if File.binary?(f)
+                  ftp.putbinaryfile(f, f)
+                else
+                  ftp.puttextfile(f, f)
+                end
+              rescue Exception => e
+                reply = e.message
+                err_code = reply[0,3].to_i
+                if err_code == 550
+                  if File.binary?(f)
+                    ftp.putbinaryfile(f, f)
+                  else
+                    ftp.puttextfile(f, f)
+                  end
+                end
+              end
+              puts "Copied #{f}"
+            end
+          end
+        end
+        ftp.close
+      end
+
+    end
+
+    # Alias "d" to "deploy"
+    Base.map({ "d" => "deploy" })
+
+  end
+end

data/lib/middleman-deploy-with-notifications/extension.rb

@@ -0,0 +1,47 @@
+# Require core library
+require "middleman-core"
+
+# Extension namespace
+module Middleman
+  module DeployWithNotifications
+
+    class Options < Struct.new(:whatisthis, :method, :host, :port, :user, :password, :path, :clean, :remote, :branch, :after_build, :airbrake_api_key, :hipchat_rooms, :hipchat_token); end
+
+    class << self
+
+      def options
+        @@options
+      end
+
+      def registered(app, options_hash={}, &block)
+        options = Options.new(options_hash)
+        yield options if block_given?
+
+        options.port ||= 22
+        options.clean ||= false
+        options.remote ||= "origin"
+        options.branch ||= "gh-pages"
+
+        options.after_build ||= false
+
+        app.after_build do |builder|
+          ::Middleman::Cli::DeployWithNotifications.new.deploy if options.after_build
+        end
+
+        @@options = options
+
+        app.send :include, Helpers
+      end
+
+      alias :included :registered
+
+    end
+
+    module Helpers
+      def options
+        ::Middleman::DeployWithNotifications.options
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,6 @@
+module Middleman
+  module DeployWithNotifications
+    PACKAGE = "middleman-deploy-with-notifications"
+    VERSION = "0.0.30"
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-deploy-with-extensions"

data/middleman-deploy-with-notifications.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-deploy-with-notifications/pkg-info"
+
+Gem::Specification.new do |s|
+  s.name        = Middleman::DeployWithNotifications::PACKAGE
+  s.version     = Middleman::DeployWithNotifications::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Manoogian III", "Tom Vaughan"]
+  s.email       = ["jm3+gems@140proof.com"]
+  s.license     = "MIT"
+  s.homepage    = "http://github.com/jm3/middleman-deploy/"
+  s.summary     = %q{Deploy a middleman built site over rsync or via git (e.g. gh-pages on github).}
+  s.description = %q{Deploy a middleman-built site over rsync or via git with airbrake + hipchat notifications.}
+
+  s.files         = `git ls-files`.split("\n")
+  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"]
+
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 3.0.0"])
+
+  # Additional dependencies
+  s.add_runtime_dependency("airbrake")
+  s.add_runtime_dependency("colorize")
+  s.add_runtime_dependency("hipchat")
+  s.add_runtime_dependency("ptools")
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: middleman-deploy-with-notifications
+version: !ruby/object:Gem::Version
+  version: 0.0.30
+platform: ruby
+authors:
+- John Manoogian III
+- Tom Vaughan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deploy a middleman-built site over rsync or via git with airbrake + hipchat
+  notifications.
+email:
+- jm3+gems@140proof.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- COPYING
+- Gemfile
+- README.md
+- Rakefile
+- THANKS
+- features/support/env.rb
+- lib/middleman-deploy-with-notifications.rb
+- lib/middleman-deploy-with-notifications/commands.rb
+- lib/middleman-deploy-with-notifications/extension.rb
+- lib/middleman-deploy-with-notifications/pkg-info.rb
+- lib/middleman_extension.rb
+- middleman-deploy-with-notifications.gemspec
+homepage: http://github.com/jm3/middleman-deploy/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Deploy a middleman built site over rsync or via git (e.g. gh-pages on github).
+test_files:
+- features/support/env.rb