guard-autoupload 0.3.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e16faa42eba0a9ffb386ddb02c5139554cba0ad
+  data.tar.gz: 89652a63835b3d2869b979423c512e0248bfcecd
+SHA512:
+  metadata.gz: a8206ff9cddcb9bc16e0651362d11aa95ff8501eaf8a06a7319b330e0a9f320c77923596967a45c9dbeebbcd0e392360fce7c74968d9576f6b9f869d88844afa
+  data.tar.gz: 71655bc8a80248a5fafe4aa7011e14de66d88c01f7fad686d0635a5b4d54c32364d7e4b38911795defcdbb5f0361bda9bbe682ae25cea769a91f12f313b2b0ae

data/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -0,0 +1,166 @@
+#################
+## Eclipse
+#################
+
+*.pydevproject
+.project
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# PDT-specific
+.buildpath
+
+
+#################
+## Visual Studio
+#################
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.sln.docstates
+
+# Build results
+[Dd]ebug/
+[Rr]elease/
+*_i.c
+*_p.c
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.vspscc
+.builds
+*.dotCover
+
+## TODO: If you have NuGet Package Restore enabled, uncomment this
+#packages/
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+
+# Visual Studio profiler
+*.psess
+*.vsp
+
+# ReSharper is a .NET coding add-in
+_ReSharper*
+
+# Installshield output folder
+[Ee]xpress
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish
+
+# Others
+[Bb]in
+[Oo]bj
+sql
+TestResults
+*.Cache
+ClientBin
+stylecop.*
+~$*
+*.dbmdl
+Generated_Code #added for RIA/Silverlight projects
+
+# Backup & report files from converting an old project file to a newer
+# Visual Studio version. Backup files are not needed, because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+
+
+
+############
+## Windows
+############
+
+# Windows image file caches
+Thumbs.db
+
+# Folder config file
+Desktop.ini
+
+
+#############
+## Python
+#############
+
+*.py[co]
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+
+#Translations
+*.mo
+
+#Mr Developer
+.mr.developer.cfg
+
+# Mac crap
+.DS_Store
+
+# Ignore built gems
+*.gem

data/README.md

@@ -0,0 +1,56 @@
+guard-autoupload
+================
+
+Autoupload plugin used for uploading all local changes to remote host.
+Uses either SFTP or FTP.
+
+Usage
+-----
+
+Sample guardfile:
+
+    opts = {
+        :protocol => :scp,        # Protocol used to connect to remote host.
+                                  # Possible values are :scp, :sftp and :ftp.
+                                  # Of these :scp is the preferred one for
+                                  # its stability.
+        :host => "remote_host",
+        :user => "username",
+        :password => "password",
+        :remote => "remote_path",
+        :verbose => false,        # if true you get all outputs
+        :quiet => false           # if true outputs only on exceptions.
+    }
+
+    guard :autoupload, opts do
+        watch(/^((?!Guardfile$).)*$/)
+        # Matches every other file but Guardfile. This way we don't
+        # accidentally upload the credentials.
+    end
+
+Dependencies
+------------
+
+ - guard
+ - Net::SFTP
+ - Net::SSH::Simple
+
+Installation
+------------
+
+For now you need to install `guard-autoupload` by building the gem manually
+and installing from that:
+
+    gem build guard-autoupload.gemspec
+    gem install guard-autoupload-0.3.4.gem
+
+Author
+------
+
+This guard plugin was written by Jyrki Lilja and is used at FocusFlow.
+The code is hevily based on [vincenthu's guard-flopbox][gsftp] and
+[bgarret's guard-ftpsync][gftp].
+
+[gsftp]: https://github.com/vincentchu/guard-flopbox
+[gftp]: https://github.com/bgarret/guard-ftpsync
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/guard-autoupload.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+    s.name        = "guard-autoupload"
+    s.version     = "0.3.4"
+    s.authors     = ["Jyrki Lilja"]
+    s.email       = ["jyrki dot lilja at outlook dot com"]
+    s.homepage    = "https://github.com/jyrkij/guard-autosync"
+    s.summary     = %q{Autoupload plugin - uploads local changes to remote host.}
+    s.description = %q{Uses either SFTP or FTP.}
+
+    s.rubyforge_project = "guard-autoupload"
+
+    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"]
+
+    s.add_dependency('guard')
+    s.add_dependency('net-sftp')
+    s.add_dependency('net-ssh-simple')
+end

data/lib/guard/autoupload/ftpsession.rb

@@ -0,0 +1,45 @@
+require 'net/ftp'
+
+class FTPSession
+    RESPAWN_INTERVAL = 60 # in seconds
+
+    def initialize(host, user, password)
+        @session = Net::FTP.new
+        @host = host
+        @user = user
+        @password = password
+        @last_timestamp = Time.new(0)
+        @session.connect(@host)
+        @session.login(@user, @password)
+    end
+
+    def upload!(local, remote)
+        remote { @session.putbinaryfile(local, remote) }
+    end
+
+    def mkdir!(dir)
+        remote { @session.mkdir(dir) }
+    end
+
+    def remove!(remote)
+        remote { @session.delete(remote) }
+    end
+
+    def rmdir!(dir)
+        remote { @session.rmdir(dir) }
+    end
+
+    private
+
+    def remote
+        command_start_timestamp = Time.now
+        if (command_start_timestamp - @last_timestamp > RESPAWN_INTERVAL)
+            @session.close unless @session.last_response == nil
+            @session.connect(@host)
+            @session.login(@user, @password)
+        end
+        ret = yield
+        @last_timestamp = Time.now
+        ret
+    end
+end

data/lib/guard/autoupload/scpsession.rb

@@ -0,0 +1,108 @@
+require 'net/ssh/simple'
+
+class SCPSession
+    def initialize(host, user, password, caller_ref)
+        @host = host
+        @user = user
+        @password = password.clone
+        @caller = caller_ref
+        @retry_count = 0
+        @max_retries = 1
+    end
+
+    def ss
+        Thread.current[:simplessh] ||= Net::SSH::Simple.new({:user => @user, :password => @password.clone})
+    end
+
+    def upload!(local, remote)
+        begin
+            ss.scp_put "#{@host}", "#{local}", "#{remote}"
+            # This shouldn't be run if we get an exception
+            @retry_count = 0
+        rescue Net::SSH::Simple::Error => e
+            case e.wrapped
+            when Errno::ECONNRESET, Net::SSH::Disconnect
+                raise e if @retry_count >= @max_retries
+                @retry_count += 1
+                @caller.log "Failed uploading and will try again."
+                @caller.log "The reason was #{e}" unless @caller.quiet?
+                close
+                retry
+            else
+                raise e
+            end
+        end
+    end
+
+    def mkdir!(dir)
+        begin
+            check_exists = ss.ssh "#{@host}", "ls -ld #{dir}"
+            ss.ssh "#{@host}", "mkdir #{dir}" if check_exists.exit_code
+            # This shouldn't be run if we get an exception
+            @retry_count = 0
+        rescue Net::SSH::Simple::Error => e
+            case e.wrapped
+            when Errno::ECONNRESET, Net::SSH::Disconnect
+                raise e if @retry_count >= @max_retries
+                @retry_count += 1
+                @caller.log "Failed making directory and will try again."
+                @caller.log "The reason was #{e}" unless @caller.quiet?
+                close
+                retry
+            else
+                raise e
+            end
+        end
+    end
+
+    def remove!(remote)
+        begin
+            ss.ssh @host, "rm #{remote}"
+            # This shouldn't be run if we get an exception
+            @retry_count = 0
+        rescue Net::SSH::Simple::Error => e
+            case e.wrapped
+            when Errno::ECONNRESET, Net::SSH::Disconnect
+                raise e if @retry_count >= @max_retries
+                @retry_count += 1
+                @caller.log "Failed removing file and will try again."
+                @caller.log "The reason was #{e}" unless @caller.quiet?
+                close
+                retry
+            else
+                raise e
+            end
+        end
+    end
+
+    def rmdir!(dir)
+        throw NotImplementedError
+    end
+
+    def ls!(dir)
+        begin
+            ss.ssh @host, "ls #{dir}"
+            # This shouldn't be run if we get an exception
+            @retry_count = 0
+        rescue Net::SSH::Simple::Error => e
+            case e.wrapped
+            when Errno::ECONNRESET, Net::SSH::Disconnect
+                raise e if @retry_count >= @max_retries
+                puts @password
+                exit
+                @retry_count += 1
+                @caller.log "Failed listing directory contents and will try again."
+                @caller.log "The reason was #{e}" unless @caller.quiet?
+                close
+                retry
+            else
+                raise e
+            end
+        end
+    end
+
+    def close
+        ss.close
+        Thread.current[:simplessh] = nil
+    end
+end

data/lib/guard/autoupload/sftpsession.rb

@@ -0,0 +1,61 @@
+require 'net/sftp'
+
+class SFTPSession
+    def initialize(host, user, password, caller_ref)
+        @host = host
+        @user = user
+        @password = password
+        @session = Net::SFTP.start(
+            @host,
+            @user,
+            :password => @password
+        )
+        @caller = caller_ref
+    end
+
+    def upload!(local, remote)
+        remote { @session.upload!(local, remote) }
+    end
+
+    def mkdir!(dir)
+        begin
+            remote { @session.lstat!(dir) }
+            exists = true
+        rescue Net::SFTP::StatusException
+            exists = false
+        end
+        remote { @session.mkdir!(dir) } unless exists
+    end
+
+    def remove!(remote)
+        stat = remote { @session.lstat!(remote) }
+        remote { @session.remove!(remote) } if stat.file?
+        remote { @session.rmdir!(remote) } if stat.directory?
+    end
+
+    def rmdir!(dir)
+        remote { @session.rmdir!(dir) }
+    end
+
+    private
+
+    def remote
+        begin
+            ret = yield
+        rescue => e
+            case e
+            when Errno::ECONNRESET
+                @caller.log "Connection resetted by remote. Reconnecting." unless @caller.quiet?
+                @session = Net::SFTP.start(
+                    @host,
+                    @user,
+                    :password => @password
+                )
+                ret = yield
+            else
+                raise
+            end
+        end
+        ret
+    end
+end

data/lib/guard/autoupload/templates/Guardfile

@@ -0,0 +1,20 @@
+# Configuartion Options for guard-autoupload
+
+opts = {
+    :protocol => :scp,        # Protocol used to connect to remote host.
+                              # Possible values are :scp, :sftp and :ftp.
+                              # Of these :scp is the preferred one for
+                              # its stability.
+    :host => "remote_host",
+    :user => "username",
+    :password => "password",
+    :remote => "remote_path",
+    :verbose => false,        # if true you get all outputs
+    :quiet => false           # if true outputs only on exceptions.
+}
+
+guard :autoupload, opts do
+    watch(/^((?!Guardfile$).)*$/)
+    # Matches every other file but Guardfile. This way we don't
+    # accidentally upload the credentials.
+end

data/lib/guard/autoupload.rb

@@ -0,0 +1,133 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'guard'
+require 'guard/guard'
+require 'autoupload/scpsession.rb'
+require 'autoupload/sftpsession.rb'
+require 'autoupload/ftpsession.rb'
+
+module Guard
+    class Autoupload < Guard
+        def initialize(watchers = [], options = {})
+            super
+
+            @instance = self
+            if options[:protocol] == :scp
+                @session = SCPSession.new(
+                    options[:host],
+                    options[:user],
+                    options[:password],
+                    self
+                )
+            elsif options[:protocol] == :sftp
+                @session = SFTPSession.new(
+                    options[:host],
+                    options[:user],
+                    options[:password],
+                    @instance
+                )
+            elsif options[:protocol] == :ftp
+                @session = FTPSession.new(
+                    options[:host],
+                    options[:user],
+                    options[:password]
+                )
+            else
+                throw :task_has_failed
+            end
+
+            @remote = options[:remote]
+            @local = Dir.pwd
+            @verbose = options[:verbose]
+            @quiet = options[:quiet] unless verbose?
+
+            options[:password].gsub!(/./, '*') if options.include? :password
+            log "Initialized with watchers #{watchers.inspect}" if verbose?
+            log "Initialized with options #{options.inspect}" unless quiet?
+        end
+
+        def run_on_change(paths)
+            paths.each do |path|
+                local_file = File.join(@local, path)
+                remote_file = File.join(@remote, path)
+
+                attempts = 0
+
+                begin
+                    log "Upload #{local_file} => #{remote_file}" if verbose?
+                    @session.upload!(local_file, remote_file)
+                    log "Uploaded #{path}" unless quiet?
+                rescue => ex
+                    log "Exception on uploading #{path}\n#{ex.inspect}"
+                    log ex.backtrace.join("\n") if verbose?
+                    attempts += 1
+                    remote_dir = File.dirname(remote_file)
+                    recursively_create_dirs(remote_dir)
+                    retry if attempts < 3
+                    log "Exceeded 3 attempts to upload #{path}"
+                    throw :task_has_failed
+                end
+            end
+
+            msg = "Uploaded:\n#{paths.join("\n")}"
+            ::Guard::Notifier.notify msg, :title => "Uploaded"
+        end
+
+        def run_on_removals(paths)
+            paths.each do |path|
+                remote_file = File.join(@remote, path)
+
+                begin
+                    log "Delete #{remote_file}" if verbose?
+                    @session.remove!(remote_file)
+                rescue => ex
+                    log "Exception on deleting #{path}\n#{ex.inspect}"
+                    log ex.backtrace.join("\n") if verbose?
+                end
+
+                log "Deleted #{path}" unless quiet?
+            end
+
+            msg = "Deleted:\n#{paths.join("\n")}"
+            ::Guard::Notifier.notify msg, :title => "Deleted"
+        end
+
+        def verbose?
+            @verbose || false
+        end
+
+        def quiet?
+            @quiet || false
+        end
+
+        def log(message)
+            puts "[#{Time.now}] #{message}"
+        end
+
+        def stop
+            log "Tearing down connections" unless quiet?
+            if @session.is_a? SCPSession
+                @session.close
+            end
+        end
+
+        private
+
+        def recursively_create_dirs(remote_dir)
+            new_dir = @remote
+            remote_dir.gsub(@remote, "").split("/").each do |dir|
+                new_dir = File.join(new_dir, dir)
+
+                begin
+                    log "Creating #{new_dir}" if verbose?
+                    @session.mkdir!(new_dir)
+                rescue => ex
+                    log "Cannot create directory #{new_dir}\n#{ex.inspect}"
+                    log ex.backtrace.join("\n") if verbose?
+                end
+            end
+
+            log "Created directory #{remote_dir}" unless quiet?
+        end
+    end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: guard-autoupload
+version: !ruby/object:Gem::Version
+  version: 0.3.4
+platform: ruby
+authors:
+- Jyrki Lilja
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: net-sftp
+  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: net-ssh-simple
+  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: Uses either SFTP or FTP.
+email:
+- jyrki dot lilja at outlook dot com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- guard-autoupload.gemspec
+- lib/guard/autoupload.rb
+- lib/guard/autoupload/ftpsession.rb
+- lib/guard/autoupload/scpsession.rb
+- lib/guard/autoupload/sftpsession.rb
+- lib/guard/autoupload/templates/Guardfile
+homepage: https://github.com/jyrkij/guard-autosync
+licenses: []
+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: guard-autoupload
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Autoupload plugin - uploads local changes to remote host.
+test_files: []