capistrano-forwarding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bec3e813b57388649728bfcbdcba6ee4d83863a
+  data.tar.gz: 4f910606fcb18716fe1be7b7fc84b877bba72adc
+SHA512:
+  metadata.gz: 681986122dcc7007eeaeb905c2e56564e5c757fd301dfd23d2227be0f230885292fba24ccb7d50eacb77bdce2b7aa6eb2596aff00e7c1bbd0377f2cc71fed846
+  data.tar.gz: a4f9e44c950851150c5acd34e03585f77654a6f284fe271f1e01a6c6b06a8228bf3eadaefe2ec91858b76a4f9adfc54c16f136ae0c902bc73a34afb957338543

data/README.md

@@ -0,0 +1,42 @@
+# Capistrano SSH Port Forwarding Extension
+
+Provide SSH port forwarding while deploying so that we can call
+local service like [Spitball](https://github.com/freels/spitball) server from remote hosts.
+
+Currently it supports only remote forwarding.
+
+## Installation
+
+Add this line in your Gemfile.
+
+    gem 'capistrano-forwarding'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-forwarding
+
+## Usage
+
+Currently it provides only `remote_forwarding` configuration
+which is forwarding remote ports from remote hosts to local.
+
+Here is an example in your `Capfile` or `config/deploy.rb`.
+
+    require "capistrano/fowarding"
+
+    desc "test task"
+    task "test" do
+      remote_forwarding [
+        [3000, "127.0.0.1", 3000]
+      ] do
+        run "curl http://127.0.0.1:3000/"
+      end
+    end
+
+Before trying this, run something like HTTP server on local port 3000.
+
+    $ ruby -rwebrick -e 'WEBrick::HTTPServer.new(:Port => 3000).start'

data/lib/capistrano/forwarding.rb

@@ -0,0 +1,2 @@
+require "capistrano/forwarding/version"
+require "capistrano/forwarding/remote"

data/lib/capistrano/forwarding/remote.rb

@@ -0,0 +1,147 @@
+module Capistrano
+  # Support SSH remote port forwarding
+  module Forwarding
+    class Remote
+      # See lib/net/ssh/service/forward.rb
+      class Forwarding
+        # See lib/net/ssh/loggable.rb
+        include Net::SSH::Loggable
+
+        attr_reader :forwarding, :session
+
+        def initialize(forwarding, session)
+          @forwarding = forwarding
+          @session    = session
+          @logger     = session.logger
+          raise ArgumentError, "Invalid forwarding" unless valid?
+        end
+
+        def to_s
+          "#{session.host}:#{forwarding.join(":")}"
+        end
+
+        def forward!
+          info { "forwarding remote #{self}" }
+          session.forward.remote(*forwarding)
+        end
+
+        def cancel!
+          info { "cancelling forwarding remote #{self}" }
+          session.forward.cancel_remote(*remote_port_and_host)
+        end
+
+        def ready?
+          session.forward.active_remotes.include?(remote_port_and_host)
+        end
+
+        def gone?
+          !ready?
+        end
+
+        private
+
+        # Default remote host is "127.0.0.1".
+        # See /lib/net/ssh/service/forward.rb.
+        def remote_port_and_host
+          [forwarding[2], forwarding[3] || "127.0.0.1"]
+        end
+
+        def valid?
+          forwarding.size == 3 || forwarding.size == 4
+        end
+      end
+
+      include Processable
+
+      attr_reader :sessions, :forwardings, :options
+
+      def self.forward(forwardings, sessions, options = {}, &block)
+        new(forwardings, sessions, options).forward!(&block)
+      end
+
+      def initialize(forwardings, sessions, options = {})
+        sessions.each{|s| s.logger.level = Logger::INFO}
+
+        @forwardings = sessions.map do |session|
+          forwardings.map do |forwarding|
+            Forwarding.new(forwarding, session)
+          end
+        end.flatten
+        @sessions = sessions
+        @options = options
+      end
+
+      def forward!
+        start(options[:timeout])
+
+        # If we use run or similar command in the block for the connections,
+        # the forwardings are also processed by the loop of these commands.
+        # See lib/capistrano/command.rb and lib/capistrano/processable.rb.
+        yield(sessions) if block_given?
+
+        # Since we may still have channels which are not completely processed by the
+        # loop of these commands, run the loop for taking care of them until
+        # all channels has been gone.
+        loop unless options[:no_wait]
+
+        stop(options[:timeout])
+      end
+
+      private
+
+      def start(timeout = nil)
+        forwardings.each{|f| f.forward!}
+        # Process until all forward requests are ready.
+        loop(timeout){ !ready? }
+      end
+
+      def stop(timeout = nil)
+        forwardings.each{|f| f.cancel!}
+        # Process until all forward cancel requests are accepted.
+        loop(timeout){ !gone? }
+      end
+
+      # Preserve a reference to Kernel#loop
+      alias :loop_forever :loop
+
+      # Process until all channels in sessions are gone or while the block is true.
+      # See /lib/net/ssh/connection/session.rb
+      def loop(timeout = nil, &block)
+        running = block || Proc.new { busy? }
+        loop_forever{ break unless process_iteration(timeout, &running) }
+      end
+
+      def busy?
+        sessions.any?(&:busy?)
+      end
+
+      def ready?
+        forwardings.all?(&:ready?)
+      end
+
+      def gone?
+        forwardings.all?(&:gone?)
+      end
+    end
+  end
+
+  class Configuration
+    # Capistrano configuration example.
+    # Forwarding remote port 3000 to local 3000 and ask remote hosts to HTTP GET
+    # from local HTTP server running on port 3000.
+    #   remote_forwarding [
+    #     [3000, "127.0.0.1", 3000]
+    #   ] do
+    #     run "curl 'http://127.0.0.1:3000/'"
+    #   end
+    def remote_forwarding(fowardings, options = {})
+      options = add_default_command_options(options)
+      execute_on_servers(options) do |servers|
+        targets = servers.map{|s| sessions[s]}
+        Forwarding::Remote.forward(fowardings, targets) do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/forwarding/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Forwarding
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-forwarding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshimasa Niwa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide SSH port forwarding while deploying
+email:
+- niw@niw.at
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/capistrano/forwarding.rb
+- lib/capistrano/forwarding/remote.rb
+- lib/capistrano/forwarding/version.rb
+- README.md
+homepage: https://github.com/niw/capistrano-forwarding
+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: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Provide SSH port forwarding while deploying
+test_files: []