capistrano-transfer_progress 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use @transferp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-transfer_progress.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nikos Dimitrakopoulos
+
+MIT License
+
+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/README.md

@@ -0,0 +1,29 @@
+# Capistrano::TransferProgress
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-transfer_progress'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-transfer_progress
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-transfer_progress.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-transfer_progress/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-transfer_progress"
+  gem.version       = Capistrano::TransferProgress::VERSION
+  gem.authors       = ["Eric Cohen", "Nikos Dimitrakopoulos"]
+  gem.email         = ["eirc.eirc@gmail.com", "nospam@nikosd.com"]
+  gem.description   = %q{Progress bars for capistrano transfers}
+  gem.summary       = %q{Hooks on capistrano transfers and provides a callback that displays a progressbar with current transfer progress}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'capistrano', '~> 2.0'
+  gem.add_runtime_dependency 'progressbar'
+end

data/lib/capistrano-transfer_progress.rb

@@ -0,0 +1,97 @@
+require "capistrano-transfer_progress/version"
+
+require 'progressbar'
+
+module Capistrano
+  # Hooks on capistrano transfers and provides a callback that displays a progressbar with current transfer progress
+  #
+  # Can handle:
+  # * Simultaneous transfers
+  # * SCP and SFTP
+  # * Multiple files (recursive)
+  # * Uploads & Downloads
+  #
+  # Cannot handle:
+  # * SFTP Downloads as they do not report the total file size
+  module TransferProgress
+    def transfer(*args)
+      if block_given?
+        super(*args)
+      else
+        # Here we hook the tracking on our own by default if no progress block given to the transfer method
+        super(*args) { |*a| track(*a) }
+      end
+    end
+
+    # Tracks SCP or SFTP tranfer progress
+    def track(*args)
+      if args[0].is_a?(Symbol) && args[1].is_a?(Net::SFTP::Operations::Upload)
+        track_sftp_transfer(*args)
+      elsif args[0].is_a?(Net::SSH::Connection::Channel)
+        track_scp_transfer(*args)
+      end
+    end
+
+    #######
+    private
+    #######
+
+    def track_sftp_transfer(event, options, *others)
+      key = "#{options.class}-#{options.sftp.object_id}:#{others[0].local}:#{others[0].remote}" if [:open, :put, :close].include? event
+
+      case event
+        when :open
+          update_session key, 0, others[0].size
+        when :put
+          update_session key, others[1]
+        when :close
+          end_session key
+      end
+    end
+
+    def track_scp_transfer(channel, name, sent, total)
+      update_session("#{channel.class}-#{channel.object_id}:#{name}", sent, total)
+    end
+
+    def update_session(key, sent, total = nil)
+      @bar ||= ProgressBar.new("Transfering", 1)
+
+      @active_sessions ||= {}
+      @active_sessions[key] ||= {}
+      @active_sessions[key].merge!(:sent => sent)
+
+      unless total.nil?
+        @active_sessions[key].merge!(:total => total)
+        update_bar_total
+      end
+
+      update_bar_progress
+
+      end_session(key) if sent == total
+    end
+
+    def end_session(key)
+      @active_sessions.delete key
+      update_bar_total
+      update_bar_progress
+      if @active_sessions.empty?
+        @bar.finish
+        @bar = nil
+      end
+    end
+
+    def update_bar_total
+      new_total = @active_sessions.inject(0) { |sum, (k, v)| sum + v[:total] }
+      @bar.instance_eval { @total = new_total }
+    end
+
+    def update_bar_progress
+      @bar.set @active_sessions.inject(0) { |sum, (k, v)| sum + v[:sent] }
+    end
+  end
+end
+
+# Inject transfer progress tracking in current capistrano configuration instance
+class Capistrano::Configuration
+  include Capistrano::TransferProgress
+end

data/lib/capistrano-transfer_progress/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module TransferProgress
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-transfer_progress
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric Cohen
+- Nikos Dimitrakopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  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: Progress bars for capistrano transfers
+email:
+- eirc.eirc@gmail.com
+- nospam@nikosd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-transfer_progress.gemspec
+- lib/capistrano-transfer_progress.rb
+- lib/capistrano-transfer_progress/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Hooks on capistrano transfers and provides a callback that displays a progressbar
+  with current transfer progress
+test_files: []