capistrano-syncfiles 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14f3dd6c418570a81f704b80c94b67ae9d2657db
-  data.tar.gz: b52c8d0ba32469a41d38300f8350e92f7c9c026a
+  metadata.gz: 1177558c37d50af39fefd640b3fef6b01d5d95b2
+  data.tar.gz: d1616acee6018b4001875964df9a9db4172ba304
 SHA512:
-  metadata.gz: f5b4ae710b0e4483ad71c7fa9dde612d7b92529d98c5f82db5b246b7c48f3717d7c3262f5bf4c93f773a53a83d2856325c578a159131668242e1e30a197372fa
-  data.tar.gz: b6051c8550ea65b4ae978197a3b0a46e97abe54503ecb3c2dcb1bceaa63a5b5bd38a7f08b2b5ecf733efa567e8bc58d7a0ee88af0b4516889b5dfa0552d1a765
+  metadata.gz: 2eb78df5dcfed5fbbcc2966dda1d8e524710f56d764b34c195cb34a493cef5289a5b49f6eb06c1105dc4c4f063d97c0f86fd3c2cc764e5d78297b4224e81dc18
+  data.tar.gz: cb00e0c3907fd997e327ab85c5a19fd21e23cae3c002182e9e44bda464b1b3e9ef0a527f3bb74e481c05c1d24b9954b81c5a6881df29ebfb15adaf705dbdca77

data/README.md

@@ -1,6 +1,8 @@
 # capistrano-syncfiles
 
-This gem provides up and down file syncing with rsync or tar. This could be usefull if you are in a shared hosting environment.
+This gem provides up and down file syncing with rsync, tar or sftp. This could be usefull if you are in a shared hosting environment.
+
+Supports folder excludes.
 
 ## Installation
 First make sure you install the capistrano-syncfiles by adding it to your `Gemfile`:
@@ -17,7 +19,7 @@ Configure your files and folders like these:
 set :syncfiles, {
   'wordpress/wp-content/uploads' => {                     # local path
       remote: 'wordpress/wp-content/uploads',             # remote path
-      exclude: ['fvm', 'ithemes-security', 'wc-logs']     # excluded files
+      exclude: ['fvm', 'ithemes-security', 'wc-logs']     # excluded folders/files, based on local path, works also for remote
   }
 }
 
@@ -26,6 +28,8 @@ set :syncfiles_roles, :all  # roles to run on, default: :all
 set :syncfiles_temp_file    # applies only to tar strategy, default: "/tmp/transfere-#{local_path.hash}.tar.gz"
 
 set :syncfiles_tar_verbose  # applies only to tar strategy, default: true
+
+set :syncfiles_sftp_password # password for sftp connection
 ```
 
 ## Usage
@@ -33,8 +37,12 @@ The following tasks will be added
 ```
 cap syncfiles:rsync:down
 cap syncfiles:rsync:up
+
 cap syncfiles:tar:down
 cap syncfiles:tar:up    
+
+cap syncfiles:sftp:down
+cap syncfiles:sftp:up    
 ```
 
 You can invoke this tasks(Rake) as you do normally: https://github.com/ruby/rake
@@ -45,8 +53,8 @@ Capistrano tasks: http://capistranorb.com/documentation/getting-started/flow/
 The MIT License (MIT)
 
 ### Changelog
+##### 0.2.0
+- add sftp strategy
 
-0.1.0
------
-
+##### 0.1.0
 - Initial release

data/capistrano-syncfiles.gemspec

@@ -3,13 +3,13 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "capistrano-syncfiles"
-  s.version     = "0.1.0"
+  s.version     = "0.2.0"
   s.licenses    = ["MIT"]
   s.authors     = ["Tom Hanoldt"]
   s.email       = ["tom@creative-workflow.berlin"]
   s.homepage    = "https://github.com/creative-workflow/capistrano-syncfiles"
-  s.summary     = %q{This gem provides up and down file syncing with rsync or tar. This could be usefull if you are in a shared hosting environment.}
-  s.description = %q{This gem provides up and down file syncing with rsync or tar. This could be usefull if you are in a shared hosting environment.}
+  s.summary     = %q{This gem provides up and down file syncing with rsync, tar or sftp. This could be usefull if you are in a shared hosting environment.}
+  s.description = %q{This gem provides up and down file syncing with rsync, tar or sftp. This could be usefull if you are in a shared hosting environment.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_dependency "capistrano", "~> 3.0"
+  s.add_dependency 'fun_sftp', '~> 1.1.1'
 end

data/lib/capistrano/tasks/syncfiles/sftp.rake

@@ -0,0 +1,80 @@
+require 'fun_sftp'
+namespace :sftp do
+  def connection(server, username, password)
+    @connection ||= FunSftp::SFTPClient.new(server, username, password)
+  end
+
+  def ensure_directory_exsits_remote(handle, remote_directory)
+    return if handle.has_directory? remote_directory
+
+    parent_directory = ::File.dirname(remote_directory)
+    if !handle.has_directory? parent_directory
+      ensure_directory_exsits_remote(handle, parent_directory)
+    end
+
+    puts "mkdir #{remote_directory}"
+    handle.mkdir!(remote_directory)
+  end
+
+  desc "Synchronise local and remote wp content folders via sftp"
+  task :up do
+    files = fetch(:syncfiles)
+    files.each do |local_path, config|
+      remote_path  = config[:remote]
+      exclude_dir  = Array(config[:exclude])
+      exclude_args = exclude_dir.map { |dir| "! -path '#{dir}/*'"}
+      sync_roles   = fetch(:syncfiles_roles, :all)
+
+      cmd = ["find #{local_path} -type fl ", *exclude_args]
+      puts cmd.join(' ')
+      filtered_files = `#{cmd.join(' ')}`.lines
+
+      on release_roles sync_roles do |role|
+        handle = connection(role.hostname, role.user, fetch(:syncfiles_sftp_password))
+
+        uploads = filtered_files.map do |local_file|
+          local_file.strip!
+
+          remote_file      = local_file.sub(local_path, remote_path)
+
+          remote_directory = ::File.dirname(remote_file)
+
+          ensure_directory_exsits_remote(handle, remote_directory)
+
+          handle.upload!(local_file, remote_file)
+        end
+      end
+    end
+  end
+
+  desc "Synchronise local and remote wp content folders via sftp"
+  task :down do
+    files = fetch(:syncfiles)
+    files.each do |local_path, config|
+      remote_path  = config[:remote]
+      exclude_dir  = Array(config[:exclude])
+      sync_roles   = fetch(:syncfiles_roles, :all)
+
+      on primary sync_roles do |role|
+          handle = connection(role.hostname, role.user, fetch(:syncfiles_sftp_password))
+
+          puts "collecting files in #{remote_path}"
+          handle.glob(remote_path, "**/*").each do |remote_file|
+
+            remote_file = "#{remote_path}/#{remote_file}"
+
+            local_file = remote_file.sub(remote_path, local_path)
+
+            next if exclude_dir.any? do |exclude|
+              local_file.start_with?(exclude)
+            end
+
+            `mkdir -p #{::File.dirname(local_file)}`
+
+            handle.download!(remote_file, local_file)
+          end
+
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-syncfiles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Hanoldt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -24,8 +24,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This gem provides up and down file syncing with rsync or tar. This could
-  be usefull if you are in a shared hosting environment.
+- !ruby/object:Gem::Dependency
+  name: fun_sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+description: This gem provides up and down file syncing with rsync, tar or sftp. This
+  could be usefull if you are in a shared hosting environment.
 email:
 - tom@creative-workflow.berlin
 executables: []
@@ -41,6 +55,7 @@ files:
 - lib/capistrano/syncfiles.rb
 - lib/capistrano/tasks/syncfiles.rake
 - lib/capistrano/tasks/syncfiles/rsync.rake
+- lib/capistrano/tasks/syncfiles/sftp.rake
 - lib/capistrano/tasks/syncfiles/tar.rake
 homepage: https://github.com/creative-workflow/capistrano-syncfiles
 licenses:
@@ -65,6 +80,6 @@ rubyforge_project:
 rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: This gem provides up and down file syncing with rsync or tar. This could
-  be usefull if you are in a shared hosting environment.
+summary: This gem provides up and down file syncing with rsync, tar or sftp. This
+  could be usefull if you are in a shared hosting environment.
 test_files: []