canals 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e283a22a7f6c82810b5d6882f43261d52049c43
-  data.tar.gz: 3241f8e7db64722f49d194fcd7913e9c03d3276a
+SHA256:
+  metadata.gz: 9bc1163849df66d22bad8690d09e21a9bce8a69b25b1b433f76129cfe3e540b2
+  data.tar.gz: 2b7df31c017d857e1eef4e85e92e3be608729020e953ed750d82c1cee57ee7f0
 SHA512:
-  metadata.gz: 70c882e0a9523ac94c4f4fc752952e00250234c6ab41fa437c942e7ec01fcef08f7ddfb441c2d04fa1a6a91aab4f62c73a56bd1bde751145be44d0f2aef597d6
-  data.tar.gz: fdaf278face0c256fac3f38db681f4fdaef3bd30161d59037acf1c6c59dceaf8c3b0e256c8eeb8b406bb6e7a2a401d5b853c19aa803cebc1739e5600e015dc92
+  metadata.gz: b936391c6d89a681e3e80090e15f5daf0c76a0968aa1b3bd7aac79a6cf259ad688d85ddbf5cee8823e35d182cf0218a6d9f616c2a0bd1ec69d6053f08f5f4243
+  data.tar.gz: c5ab2225ca01e9c6473d35090c06713ae7696630d3c118f34ffabf5ed8b9140b5999bf3dc2ab890ac3062f9b688abdbfb048a444cab7fcdd3d3a20d5012faaa1

data/assets/canals.sh

@@ -10,7 +10,7 @@ _canal_complete() {
   # Setup the base level (everything after "canal")
   if [ $COMP_CWORD -eq 1 ]; then
     COMPREPLY=( $(compgen \
-                  -W "adhoc create environment help repo restart session setup start stop update" \
+                  -W "adhoc create environment help repo restart session setup socks start stop update" \
                   -- $cur) )
     return 0
   fi

data/canals.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
   s.require_path          = "lib"
   s.license               = "MIT"
 
-  s.add_dependency        'thor', '~> 0.19.1'
-  s.add_dependency        'terminal-table', '~> 1.5'
+  s.add_dependency        'thor', '~> 0.20.3'
+  s.add_dependency        'terminal-table', '~> 1.8'
 
   s.add_development_dependency 'rspec', '~> 3.4'
 end

data/lib/canals/cli.rb

@@ -32,7 +32,7 @@ module Canals
       method_option :user,         :type => :string, :desc => "The user for the ssh proxy host"
       method_option :bind_address, :type => :string, :desc => "The bind address to connect to"
       def create(name, remote_host, remote_port, local_port=nil)
-        opts = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => local_port}.merge(options)
+        opts = {name: name, remote_host: remote_host, remote_port: remote_port, local_port: local_port}.merge(options)
         opts = Canals::CanalOptions.new(opts)
         Canals.create_tunnel(opts)
         say "Tunnel #{name.inspect} created.", :green
@@ -40,13 +40,13 @@ module Canals
 
       desc 'delete NAME', "Delete an existing tunnel; if tunnel is active, stop it first"
       def delete(name)
-        tunnel = Canals.repository.get(name)
+        tunnel = Canals.repository.get(name.to_sym)
         if tunnel.nil?
           say "couldn't find tunnel #{name.inspect}. try using 'create' instead", :red
           return
         end
         tstop(name, silent: true)
-        Canals.repository.delete(name)
+        Canals.repository.delete(name.to_sym)
         say "Tunnel #{name.inspect} deleted.", :green
       end
 
@@ -59,7 +59,7 @@ module Canals
       method_option :user,         :type => :string, :desc => "The user for the ssh proxy host"
       method_option :bind_address, :type => :string, :desc => "The bind address to connect to"
       def update(name)
-        tunnel = Canals.repository.get(name)
+        tunnel = Canals.repository.get(name.to_sym)
         if tunnel.nil?
           say "couldn't find tunnel #{name.inspect}. try using 'create' instead", :red
           return
@@ -136,6 +136,21 @@ module Canals
         tstart(opts)
       end
 
+
+      desc "socks LOCAL_PORT", "Create and run a socks connection"
+      method_option :name,         :type => :string, :desc => "The name to use for the socks tunnel, if not supplied a template will be generated"
+      method_option :env,          :type => :string, :desc => "The proxy environment to use"
+      method_option :hostname,     :type => :string, :desc => "The proxy host we will use to connect through"
+      method_option :user,         :type => :string, :desc => "The user for the ssh socks host"
+      method_option :bind_address, :type => :string, :desc => "The bind address to connect to"
+      def socks(local_port)
+        opts = {"adhoc" => true, "socks" => true, "local_port" => local_port}.merge(options)
+        opts["name"] ||= "__SOCKS__"
+        opts = Canals::CanalOptions.new(opts)
+        opts.name = "SOCKS-adhoc-#{opts.hostname}-#{local_port}" if opts.name == "__SOCKS__"
+        tstart(opts)
+      end
+
       desc "environment SUBCOMMAND", "Environment related command (use 'canal environment help' to find out more)"
       subcommand "environment", Canals::Cli::Environment
 

data/lib/canals/cli/environment.rb

@@ -3,7 +3,6 @@ require 'canals/options'
 require 'canals/environment'
 require 'thor'
 
-
 module Canals
   module Cli
     class Environment < Thor
@@ -19,8 +18,8 @@ module Canals
           host = hostname
           user = nil
         end
-        opts = {"name" => name, "hostname" => host}.merge(options)
-        opts["user"] = user if !user.nil?
+        opts = {name: name, hostname: host}.merge(options)
+        opts[:user] = user if !user.nil?
         env = Canals::Environment.new(opts)
         Canals.repository.add_environment(env)
       end

data/lib/canals/cli/helpers.rb

@@ -6,11 +6,11 @@ module Canals
   module Cli
     module Helpers
 
-      def tstop(tunnel_opts, silent: false)
+      def tstop(tunnel_opts, remove_from_session: true, silent: false)
         if tunnel_opts.instance_of? String
           tunnel_opts = tunnel_options(tunnel_opts)
         end
-        Canals.stop(tunnel_opts)
+        Canals.stop(tunnel_opts, remove_from_session: remove_from_session)
         say "Tunnel #{tunnel_opts.name.inspect} stopped." unless silent
       end
 

data/lib/canals/cli/session.rb

@@ -42,13 +42,20 @@ module Canals
         end
       end
 
-      desc "stop", "Stop the current session"
+      desc "stop", "Stop the current session (stops and removes from session)"
       def stop
         on_all_canals_in_session(:stop) do |canal|
           tstop(canal)
         end
       end
 
+      desc "suspend", "Suspend the current session (stops and doesn't remove from session)"
+      def suspend
+        on_all_canals_in_session(:suspend) do |canal|
+          tstop(canal, remove_from_session: false)
+        end
+      end
+
       no_commands do
         def on_all_canals_in_session(command, &block)
           return if session_empty?

data/lib/canals/cli/setup.rb

@@ -19,7 +19,6 @@ module Canals
       desc "completion", "Setup bash completion"
       def completion
         install_completion
-        say "Bash completion script upgraded, use `source #{Canals::Tools::Completion.cmp_file}` to reload it", :red
       end
 
       desc "bind-address", "Setup a global bind address (defaults to 127.0.0.1)"
@@ -32,7 +31,7 @@ module Canals
         def setup_first_environment
           say "We'll start by setting up your first environment", :green
           say "An 'environment' is the server you connect your tunnels through. you can have many environments."
-          say "The first environment is the default one used for new connections (but you can always change this default in the future"
+          say "The first environment is the default one used for new connections (but you can always change this default in the future)"
           say ""
           return unless yes? "Wait, should we setup your first environment?", :green
           opts = {}
@@ -82,8 +81,9 @@ module Canals
         end
 
         def install_completion
-          Canals::Tools::Completion.install_completion
-          say "Shell completion installed.", :green
+          first_time = Canals::Tools::Completion.install_completion
+          say "Shell completion installed.", :green if first_time
+          say "Bash completion script #{first_time ? "installed" : "upgraded"}, use `source #{Canals::Tools::Completion.cmp_file}` to reload it", :red
         end
 
         def check(check_result, message)

data/lib/canals/config.rb

@@ -1,6 +1,7 @@
-require 'psych'
 require 'pathname'
+require 'fileutils'
 require 'forwardable'
+require 'canals/tools/yaml'
 
 module Canals
   class Config
@@ -16,14 +17,12 @@ module Canals
     def load_config(config_file)
       valid_file = config_file && config_file.exist? && !config_file.size.zero?
       return {} if !valid_file
-      return Psych.load_file(config_file)
+      return Canals::Tools::YAML.load_file(config_file)
     end
 
     def save!
       FileUtils.mkdir_p(global_config_file.dirname)
-      File.open(global_config_file, 'w') do |file|
-        file.write(Psych.dump(@config))
-      end
+      Canals::Tools::YAML.dump_file(global_config_file, @config)
     end
 
     private

data/lib/canals/core.rb

@@ -1,4 +1,5 @@
 require 'open3'
+require 'fileutils'
 
 module Canals
 
@@ -23,7 +24,7 @@ module Canals
       pid.to_i
     end
 
-    def stop(tunnel_opts)
+    def stop(tunnel_opts, remove_from_session: true)
       if tunnel_opts.instance_of? String
         if (Canals.repository.has?(tunnel_opts))
           tunnel_opts = Canals.repository.get(tunnel_opts)
@@ -32,7 +33,7 @@ module Canals
         end
       end
       tunnel_close(tunnel_opts)
-      Canals.session.del(tunnel_opts.name)
+      Canals.session.del(tunnel_opts.name) if remove_from_session
     end
 
     def restart(tunnel_opts)
@@ -59,7 +60,11 @@ module Canals
 
     def tunnel_start(tunnel_opts)
       FileUtils.mkdir_p("/tmp/canals")
-      cmd = "ssh -M -S #{socket_file(tunnel_opts)} -o 'ExitOnForwardFailure yes' -fnNT -L #{tunnel_opts.bind_address}:#{tunnel_opts.local_port}:#{tunnel_opts.remote_host}:#{tunnel_opts.remote_port} #{tunnel_opts.proxy}"
+      if (tunnel_opts.socks)
+        cmd = "ssh -M -S #{socket_file(tunnel_opts)} -o 'ExitOnForwardFailure=yes' -fnNT -D \"#{tunnel_opts.bind_address}:#{tunnel_opts.local_port}\" #{tunnel_opts.proxy}"
+      else
+        cmd = "ssh -M -S #{socket_file(tunnel_opts)} -o 'ExitOnForwardFailure=yes' -fnNT -L #{tunnel_opts.bind_address}:#{tunnel_opts.local_port}:#{tunnel_opts.remote_host}:#{tunnel_opts.remote_port} #{tunnel_opts.proxy}"
+      end
       system(cmd)
       $?
     end

data/lib/canals/environment.rb

@@ -1,4 +1,4 @@
-require 'psych'
+require 'canals/tools/yaml'
 
 module Canals
   class CanalEnvironmentError < StandardError; end
@@ -28,7 +28,7 @@ module Canals
     end
 
     def to_yaml
-      Psych.dump(@args)
+      Canals::Tools::YAML.to_yaml(@args)
     end
 
     def to_hash

data/lib/canals/options.rb

@@ -1,14 +1,14 @@
-require 'psych'
+require 'canals/tools/yaml'
 
 module Canals
   CanalOptionError = Class.new StandardError
 
   class CanalOptions
     BIND_ADDRESS = "127.0.0.1"
-    attr_reader :name, :remote_host, :remote_port, :local_port, :env_name, :env, :adhoc
+    attr_reader :name, :remote_host, :remote_port, :local_port, :env_name, :env, :adhoc, :socks
 
     # define setters
-    [:name, :local_port, :adhoc].each do |attribute|
+    [:name, :local_port, :adhoc, :socks].each do |attribute|
       define_method :"#{attribute}=" do |value|
         @args[attribute] = value
         self.instance_variable_set(:"@#{attribute}", value)
@@ -23,6 +23,7 @@ module Canals
       @remote_port = @args[:remote_port]
       @local_port = @args[:local_port]
       @adhoc = @args[:adhoc] || false
+      @socks = @args[:socks] || false
       @env_name = @args[:env]
       @env = Canals.repository.environment(@env_name)
     end
@@ -57,7 +58,7 @@ module Canals
     end
 
     def to_yaml
-      Psych.dump(@args)
+      Canals::Tools::YAML.to_yaml(@args)
     end
 
     def to_hash(mode=:basic)
@@ -67,7 +68,7 @@ module Canals
     end
 
     def exploded_options
-      {bind_address: bind_address, hostname: hostname, user: user, pem: pem, proxy: proxy, adhoc: adhoc}
+      {bind_address: bind_address, hostname: hostname, user: user, pem: pem, proxy: proxy, adhoc: adhoc, socks: socks}
     end
 
     private
@@ -75,8 +76,13 @@ module Canals
     def validate?(args)
       vargs = args.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
       raise CanalOptionError.new("Missing option: \"name\" in canal creation") if vargs[:name].nil?
-      raise CanalOptionError.new("Missing option: \"remote_host\" in canal creation") if vargs[:remote_host].nil?
-      raise CanalOptionError.new("Missing option: \"remote_port\" in canal creation") if vargs[:remote_port].nil?
+      if vargs[:socks]
+        raise CanalOptionError.new("Missing option: \"local_port\" in canal creation") if vargs[:local_port].nil?
+      else
+        raise CanalOptionError.new("Missing option: \"remote_host\" in canal creation") if vargs[:remote_host].nil?
+        raise CanalOptionError.new("Missing option: \"remote_port\" in canal creation") if vargs[:remote_port].nil?
+      end
+
       vargs[:remote_port] = vargs[:remote_port].to_i
       if vargs[:local_port].nil?
         vargs[:local_port] = vargs[:remote_port]

data/lib/canals/repository.rb

@@ -1,7 +1,8 @@
-require 'psych'
 require 'pathname'
+require 'fileutils'
 require 'forwardable'
 require 'canals/environment'
+require 'canals/tools/yaml'
 
 module Canals
   class Repository
@@ -27,9 +28,9 @@ module Canals
     end
 
     def add(options, save=true)
-      @repo[TUNNELS][options.name] = options.to_hash
+      @repo[TUNNELS][options.name.to_sym] = options.to_hash
       if options.env_name.nil? && !options.env.nil? && options.env.is_default?
-        @repo[TUNNELS][options.name][:env] = options.env.name
+        @repo[TUNNELS][options.name.to_sym][:env] = options.env.name
       end
       save! if save
     end
@@ -40,37 +41,36 @@ module Canals
     end
 
     def get(name)
+      name = name.to_sym
       return nil if !@repo[:tunnels].has_key? name
       CanalOptions.new(@repo[:tunnels][name])
     end
 
     def has?(name)
-      return @repo[:tunnels].has_key? name
+      return @repo[:tunnels].has_key? name.to_sym
     end
 
     def add_environment(environment, save=true)
       if environment.is_default?
-        @repo[ENVIRONMENTS].each { |name, env| env.delete("default") }
+        @repo[ENVIRONMENTS].each { |name, env| env.delete(:default) }
       end
       if @repo[ENVIRONMENTS].empty?
         environment.default = true
       end
-      @repo[ENVIRONMENTS][environment.name] = environment.to_hash
+      @repo[ENVIRONMENTS][environment.name.to_sym] = environment.to_hash
       save! if save
     end
 
     def save!
       FileUtils.mkdir_p(repo_file.dirname)
-      File.open(repo_file, 'w') do |file|
-        file.write(Psych.dump(@repo))
-      end
+      Canals::Tools::YAML.dump_file(repo_file, @repo)
     end
 
     def environment(name=nil)
       if name.nil?
-        args = @repo[ENVIRONMENTS].select{ |n,e| e["default"] }.values[0]
+        args = @repo[ENVIRONMENTS].select{ |n,e| e[:default] }.values[0]
       else
-        args = @repo[ENVIRONMENTS][name]
+        args = @repo[ENVIRONMENTS][name.to_sym]
       end
       Canals::Environment.new(args) if !args.nil?
     end
@@ -89,7 +89,7 @@ module Canals
     def load_repository(repository_file)
       valid_file = repository_file && repository_file.exist? && !repository_file.size.zero?
       return { ENVIRONMENTS => {}, TUNNELS => {} } if !valid_file
-      return Psych.load_file(repository_file)
+      return Canals::Tools::YAML.load_file(repository_file)
     end
 
   end

data/lib/canals/session.rb

@@ -1,6 +1,7 @@
-require 'psych'
 require 'pathname'
+require 'fileutils'
 require 'forwardable'
+require 'canals/tools/yaml'
 
 module Canals
   class Session
@@ -65,9 +66,7 @@ module Canals
 
     def save!
       FileUtils.mkdir_p(session_file.dirname)
-      File.open(session_file, 'w') do |file|
-        file.write(Psych.dump(@session))
-      end
+      Canals::Tools::YAML.dump_file(session_file, @session)
     end
 
     private
@@ -80,7 +79,7 @@ module Canals
     def load_session(_session_file)
       valid_file = _session_file && _session_file.exist? && !_session_file.size.zero?
       return [] if !valid_file
-      return Psych.load_file(_session_file)
+      Canals::Tools::YAML.load_file(_session_file)
     end
 
     def basic?(sess)

data/lib/canals/tools/completion.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'canals'
 require 'canals/tools/assets'
 
@@ -20,8 +21,9 @@ module Canals
         source = "source " << cmp_file
 
         rcfile = File.expand_path('.bashrc', ENV['HOME'])
-        return if File.read(rcfile).include? source
+        return false if File.read(rcfile).include? source
         File.open(rcfile, 'a') { |f| f.puts("", "# added by canals gem", "[ -f #{cmp_file} ] && #{source}") }
+        true
       end
 
       def update_completion

data/lib/canals/tools/yaml.rb

@@ -0,0 +1,28 @@
+require 'psych'
+
+module Canals
+  module Tools
+    module YAML
+
+      def self.load(content)
+        Psych.load(content, symbolize_names: true)
+      end
+
+      def self.load_file(filename)
+        File.open(filename, 'r:bom|utf-8') { |f|
+          Psych.load(f, filename, fallback: false, symbolize_names: true)
+        }
+      end
+
+      def self.dump_file(filename, content)
+        File.open(filename, 'w') do |f|
+          f.write(self.to_yaml(content))
+        end
+      end
+
+      def self.to_yaml(content)
+        Psych.dump(content)
+      end
+    end
+  end
+end

data/lib/canals/version.rb

@@ -1,6 +1,6 @@
 module Canals
 
   # Canals gem current version
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 
 end

data/spec/canals/options_spec.rb

@@ -1,5 +1,5 @@
 require 'canals/options'
-require 'psych'
+require 'canals/tools/yaml'
 
 describe Canals::CanalOptions do
 
@@ -13,6 +13,7 @@ describe Canals::CanalOptions do
   let(:user)  { "user" }
   let(:pem)  { "/tmp/file.pem" }
   let(:adhoc)  { true }
+  let(:socks)  { true }
 
   describe "name" do
     it "contains 'name'" do
@@ -95,6 +96,25 @@ describe Canals::CanalOptions do
     end
   end
 
+  describe "socks" do
+    it "returns 'socks' if 'socks' is availble" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => local_port, "hostname" => hostname, "socks" => socks}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.socks).to eq socks
+    end
+
+    it "returns 'false' for 'socks' if 'socks' isn't given" do
+      args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => local_port, "hostname" => hostname}
+      opt = Canals::CanalOptions.new(args)
+      expect(opt.socks).to eq false
+    end
+
+    it "raises error when 'socks' is true and 'local_port' is not availble" do
+      args = {"name" => name, "hostname" => hostname, "socks" => socks}
+      expect{Canals::CanalOptions.new(args)}.to raise_error(Canals::CanalOptionError)
+    end
+  end
+
   describe "bind_address" do
     it "returns 'bind_address' if 'bind_address' is availble" do
       allow(Canals.config).to receive(:[]).with(:bind_address).and_return(global_bind_address)
@@ -210,7 +230,7 @@ describe Canals::CanalOptions do
     it "dumps remote_port as int" do
       args = {"name" => name, "remote_host" => remote_host, "remote_port" => '1234'}
       yaml = Canals::CanalOptions.new(args).to_yaml
-      reparsed = Psych.load(yaml)
+      reparsed = Canals::Tools::YAML.load(yaml)
       expect(reparsed[:remote_port]).to eq 1234
       expect(reparsed[:local_port]).to eq 1234
     end
@@ -218,7 +238,7 @@ describe Canals::CanalOptions do
     it "dumps local_port as int" do
       args = {"name" => name, "remote_host" => remote_host, "remote_port" => remote_port, "local_port" => "4321"}
       yaml = Canals::CanalOptions.new(args).to_yaml
-      reparsed = Psych.load(yaml)
+      reparsed = Canals::Tools::YAML.load(yaml)
       expect(reparsed[:local_port]).to eq 4321
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canals
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Ido Abramovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2018-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.3
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - lib/canals/session.rb
 - lib/canals/tools/assets.rb
 - lib/canals/tools/completion.rb
+- lib/canals/tools/yaml.rb
 - lib/canals/version.rb
 - spec/canals/environment_spec.rb
 - spec/canals/options_spec.rb
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: canals
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Eases the process of creating and managing SSH tunnels