sshez 0.3.0 → 1.0.0

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.5
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.1.1
+  - 1.8.7
+  - ree
+addons:
+  code_climate:
+      repo_token: bea2159f1a186adf8b3477b2e84b2048d8abdc96e5350e42f14cec2774a1e2cc

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-### Unreleased
+### 1.0.0 - 2016-02-09
+
+* enhancements
+  * Added `connect` for ssh connection
+  * Added `sshez add` as default and only way to add aliases (breaking change)
 
 ### 0.3.0 - 2015-12-14
 

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    sshez (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  sshez!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,5 +1,10 @@
 # Sshez
+[![Dependency Status](https://gemnasium.com/GomaaK/sshez.svg)](https://gemnasium.com/GomaaK/sshez)
 [![Gem Version](https://badge.fury.io/rb/sshez.svg)](https://badge.fury.io/rb/sshez)
+[![Code Climate](https://codeclimate.com/github/GomaaK/sshez/badges/gpa.svg)](https://codeclimate.com/github/GomaaK/sshez)
+[![Inline docs](http://inch-ci.org/github/GomaaK/sshez.svg?branch=master)](http://inch-ci.org/github/GomaaK/sshez)
+[![security](https://hakiri.io/github/GomaaK/sshez/master.svg)](https://hakiri.io/github/GomaaK/sshez/master)
+![](http://ruby-gem-downloads-badge.herokuapp.com/sshez?type=total)
 
 If you have multiple servers that you access on daily bases! sshez helps you configure your ssh/config file so you will never need to remember ip or ports again.
 
@@ -8,7 +13,7 @@ If you have multiple servers that you access on daily bases! sshez helps you con
 Add an alias `mw_server`
 
     sshez mw_server root@74.125.224.72 -p 120
-    
+
 you will be able to use
 
     ssh mw_server
@@ -22,18 +27,19 @@ you will be able to use
     sshez -h
 
     Usage:
-        sshez <alias> (role@host|-r) [options]
+        sshez add <alias> (role@host) [options]
+        sshez connect <alias>
         sshez remove <alias>
         sshez list
+        sshez reset
 
     Specific options:
         -p, --port PORT                  Specify a port
         -i, --identity_file [key]        Add identity
-        -r, --remove                     Remove handle
+        -b, --batch_mode                 Batch Mode
         -t, --test                       Writes nothing
 
     Common options:
-        -l, --list                       List aliases
         -v, --version                    Show version
         -h, --help                       Show this message
 
@@ -57,9 +63,3 @@ The gem is available as open source under the terms of the [MIT License](http://
 ## Missing
 
 *   All the other options in [ssh documentation](http://linux.die.net/man/5/ssh_config)
-
-## Credit
-
-Mohamed Osama who gave me this idea
-
-

data/bin/sshez

@@ -3,5 +3,5 @@
 require 'sshez'
 
 
-worker = Sshez::Exec.new  
+worker = Sshez::Runner.new
 worker.process(ARGV)

data/lib/sshez.rb

@@ -1,12 +1,18 @@
-require 'sshez/params'
-require 'sshez/config_file'
+require 'sshez/printing_manager'
+require 'sshez/parser'
+require 'sshez/command'
 require 'sshez/exec'
+require 'sshez/runner'
 require 'sshez/version'
 require 'optparse'
 require 'ostruct'
 
-module Sshez
+#
+# Main gem module
+#
 
+module Sshez
+	# Returns version data
   def self.version
     return Sshez::VERSION
   end

data/lib/sshez/command.rb

@@ -0,0 +1,63 @@
+module Sshez
+  #
+  # Keeps track of the which command the user called
+  #
+  class Command
+    PRINTER = PrintingManager.instance
+    # Exposes the name and arguments
+    attr_reader :name, :args
+    # no one should create a command except from this class!
+    #
+    # name: can only be one of these [add, remove, list]
+    # validator: a proc that returns true only if the input is valid
+    # for the command
+    # args: the args it self!
+    # correct_format: the way the user should run this command
+    # args_processor: (optional) a proc that will process the args
+    # before setting them
+    #
+    def initialize(name, validator, correct_format, args_processor = nil)
+      @name = name
+      @validator = validator
+      @args = []
+      @correct_format = correct_format
+      @args_processor = args_processor
+    end
+    #
+    # a list of all commands
+    #
+    ALL = {
+      'add' => Command.new('add',
+        (proc { |args| (args.length == 2) && (args[1].include?('@')) }),
+        'sshez add <alias> (role@host) [options]',
+        (proc { |alias_name, role_host| [alias_name] + role_host.split('@') })),
+      'remove' => Command.new('remove', (proc { |args| args.length == 1 }),
+        'sshez remove <alias>'),
+      'connect' => Command.new('connect', (proc { |args| args.length == 1 }),
+        'sshez connect <alias>'),
+      'reset' => Command.new('reset', (proc { |args| args.length == 0 }),
+        'sshez reset'),
+      'list' => Command.new('list', (proc { |args| args.empty? }), 'sshez list')
+    }
+    #
+    # processes the value passed if a processor was defined
+    #
+    def args=(value)
+      @args = @args_processor ? @args_processor.call(value) : value
+    end
+    #
+    # validateds the args using the proc previously defined
+    #
+    def valid?(args)
+      @validator.call(args)
+    end
+    #
+    # returns the text that should appear for a user
+    # in case of invalid input for this command
+    #
+    def error
+      "Invalid input `#{args.join(',')}` for #{@name}.\nUsage: #{@correct_format}"
+    end
+
+  end # class Command
+end

data/lib/sshez/exec.rb

@@ -1,42 +1,189 @@
-module Sshez  
+require 'forwardable'
+module Sshez
+  #
+  # handles all the ssh commands and updates to the .ssh/config file
+  #
   class Exec
-    def process(args)
-      # parse the params to get the options
-      if args.length == 0
-        args[0] = '-h'
-      elsif args[0] == 'list'
-        return ConfigFile.list
-      elsif args[0] == 'remove'
-        if args[1]
-          return ConfigFile.remove(args[1])
-        else
-          output %Q|Select an alias to remove `sshez remove alias`.\n Use `sshez list` to list your aliases|
-          puts output
-          return output
+    extend Forwardable
+    FILE_PATH = File.expand_path('~') + '/.ssh/config'
+    PRINTER = PrintingManager.instance
+    #
+    # to create an instance pass any +Struct+(listener) that handles the following methods
+    # *  :argument_error(+Command+)
+    # *  :done_with_no_guarantee
+    # *  :permission_error
+    # *  :finished_successfully
+    #
+    attr_reader :listener
+
+    def_delegators :@listener, :argument_error
+    def_delegators :@listener, :done_with_no_guarantee
+
+    #
+    # Must have the methods mentioned above
+    #
+    def initialize(listener)
+      @listener = listener
+    end
+
+    #
+    # Starts the execution of the +Command+ parsed with its options
+    #
+    def start_exec(command, options)
+      all_args = command.args
+      all_args << options
+      self.send(command.name, *all_args)
+    end
+
+    private
+    #
+    # connects to host using alias
+    #
+    def connect(alias_name, options)
+      file = File.open(FILE_PATH, 'r')
+      servers = all_hosts_in(file)
+      if servers.include?alias_name
+        PRINTER.verbose_print "Connecting to #{alias_name}"
+        exec "ssh #{alias_name}"
+      else
+        PRINTER.print "Could not find host `#{alias_name}`"
+      end
+    end
+
+    #
+    # append an alias for the given user@host with the options passed
+    #
+    def add(alias_name, user, host, options)
+      begin
+        PRINTER.verbose_print "Adding\n"
+        config_append = form(alias_name, user, host, options)
+        PRINTER.verbose_print config_append
+        unless options.test
+          file = File.open(FILE_PATH, 'a+')
+          file.write(config_append)
+          file.close
+
+          # causes a bug in fedore if permission was not updated to 0600
+          File.chmod(0600, FILE_PATH)
+          # system "chmod 600 #{FILE_PATH}"
         end
+      rescue
+        return permission_error
+      end
+      PRINTER.verbose_print "to #{FILE_PATH}"
+      PRINTER.print "Successfully added `#{alias_name}` as an alias for `#{user}@#{host}`"
+      PRINTER.print "Try sshez connect #{alias_name}"
+
+      finish_exec
+    end # add(alias_name, user, host, options)
+
+    #
+    # returns the text that will be added to the config file
+    #
+    def form(alias_name, user, host, options)
+      retuned = "\n"
+      retuned += "Host #{alias_name}\n"
+      retuned += "  HostName #{host}\n"
+      retuned += "  User #{user}\n"
+
+      options.file_content.each_pair do |key, value|
+        retuned += value
       end
+      retuned
 
-      if (args.length < 2 || !args[1].include?("@") || args[0][0] == '-')
-        if args.any? { |x| ['-h', '--help', '-l', '--list'].include?(x) }
-          Params.parse(args)
-          return
-        elsif ['-r', "--remove"].include?(args[1]) 
-          return ConfigFile.remove(args[0])
-        elsif ['-v', '--version'].include?(args[0])
-          puts Sshez.version
-          return Sshez.version
+    end # form(alias_name, user, host, options)
+
+    #
+    # removes an alias from the config file (all its occurrences will be removed too)
+    #
+    def remove(alias_name, options)
+      file = File.open(FILE_PATH, 'r')
+      new_file = File.open(FILE_PATH + 'temp', 'w')
+      remove_alias_name(alias_name, file, new_file)
+
+      File.delete(FILE_PATH)
+      File.rename(FILE_PATH + 'temp', FILE_PATH)
+      # Causes a bug in fedore if permission was not updated to 0600
+      File.chmod(0600, FILE_PATH)
+
+      unless PRINTER.output?
+        PRINTER.print "Could not find host `#{alias_name}`"
+      end
+      finish_exec
+    end # remove(alias_name, options)
+
+    #
+    # copies the content of the file to the new file without
+    # the sections concerning the alias_name
+    #
+    def remove_alias_name(alias_name, file, new_file)
+      started_removing = false
+      file.each do |line|
+        started_removing ||= line.include?("Host #{alias_name}")
+        if started_removing
+          # I will never stop till I find another host that is not the one I'm removing
+          stop_removing = (started_removing && line.include?('Host ') && !(line =~ /\b#{alias_name}\b/))
+          PRINTER.verbose_print line unless stop_removing
+          if stop_removing && started_removing
+            new_file.write(line)
+          end
+          started_removing = !stop_removing
+        else
+          # Everything else should be transfered safely to the other file
+          new_file.write(line)
         end
-        output = %Q|Invalid input. Use -h for help|
-        puts output
-        return output
       end
-      options = Params.parse(args)
+      file.close
+      new_file.close
+    end #remove_alias_name(alias_name, file, new_file)
 
-      unless options.remove
-        user, host = args[1].split("@") 
-        output = ConfigFile.append(args[0], user, host, options)
-        output + "Done!"
+    #
+    # lists the aliases available in the config file
+    #
+    def list(options)
+      file = File.open(FILE_PATH, 'a+')
+      servers = all_hosts_in(file)
+      file.close
+      if servers.empty?
+        PRINTER.print 'No aliases added'
+      else
+        PRINTER.print 'Listing aliases:'
+        servers.each{|x| PRINTER.print "\t- #{x}"}
       end
+      finish_exec
+    end # list(options)
+
+    def reset(options)
+      file = File.open(FILE_PATH, "w")
+      file.close
+    end
+
+    #
+    # Returns all the alias names of in the file
+    #
+    def all_hosts_in(file)
+      servers = []
+      file.each do |line|
+        if line.include?('Host ')
+          servers << line.sub('Host ', '').strip
+        end
+      end
+      servers
+    end
+
+    #
+    # Raises a permission error to the listener
+    #
+    def permission_error
+      listener.permission_error
+    end
+
+    #
+    # finished editing the file successfully
+    #
+    def finish_exec
+      listener.finished_successfully
     end
-  end
+    # private
+  end # class FileManager
 end

data/lib/sshez/parser.rb

@@ -0,0 +1,128 @@
+module Sshez
+  # handles parsing the arguments to meaningful actions
+  #
+  # Parser.new(listener).parse(args)
+  #
+  class Parser
+    PRINTER = PrintingManager.instance
+    #
+    # to create an instance pass any +Struct+ that handles the following methods
+    # *  :start_exec(+Command+, +OpenStruct+(options))
+    # *  :argument_error(+Command+)
+    # *  :done_with_no_guarantee
+    #
+    attr_reader :listener
+
+    #
+    # Must have the methods mentioned above
+    #
+    def initialize(listener)
+      @listener = listener
+    end
+
+    #
+    # Return a structure describing the command and its options.
+    # prints help if no args supplied
+    # command is the first argument passed in the commandline
+    #
+    # The options specified on the command line will be collected in *options*.
+    # options.file_content will contain
+    # what should be added in the next step to the config file
+    def parse(args)
+      args[0] ||= '-h'
+      command = Command::ALL[args.first]
+      options = OpenStruct.new(file_content: OpenStruct.new)
+      init_options_parser(options).parse!(args)
+      args.delete_at(0)
+      return no_command_supplied unless(command && !options.halt)
+      command.args = args
+      return parsing_succeeded(command, options) if command.valid?(args)
+      parsing_failed(command)
+    end  # parse(args)
+
+    #
+    # Initates an OptionParser with all of the possible options
+    # and how to handle them
+    #
+    def init_options_parser(options)
+      OptionParser.new do |opts|
+        opts.banner = "Usage:\n"\
+        "\tsshez add <alias> (role@host) [options]\n"\
+        "\tsshez connect <alias>\n"\
+        "\tsshez remove <alias>\n\tsshez list\n"\
+        "\tsshez reset\n"
+        opts.separator ''
+        opts.separator 'Specific options:'
+        options_for_add(opts, options)
+        # signals that we are in testing mode
+        opts.on('-t', '--test', 'Writes nothing') {options.test = true}
+        common_options(opts, options)
+      end # OptionParser.new
+    end
+
+    #
+    # Returns the options specifice to the add command only
+    #
+    def options_for_add(opts, options)
+      opts.on('-p', '--port PORT',
+              'Specify a port') do |port|
+        options.file_content.port_text = "  Port #{port}\n"
+      end
+
+      opts.on('-i', '--identity_file [key]',
+              'Add identity') do |key_path|
+        options.file_content.identity_file_text =
+          "  IdentityFile #{key_path}\n"
+      end
+
+      opts.on('-b', '--batch_mode', 'Batch Mode') do
+        options.file_content.batch_mode_text = "  BatchMode yes\n"
+      end
+    end
+
+    #
+    # Returns the standard options
+    #
+    def common_options(opts, options)
+      opts.separator ''
+      opts.separator 'Common options:'
+      # Another typical switch to print the version.
+      opts.on('-v', '--version', 'Show version') do
+        PRINTER.print Sshez.version
+        options.halt = true
+      end
+      opts.on('-z', '--verbose', 'Verbose Output') do
+        PRINTER.verbose!
+      end
+      # Prints everything
+      opts.on_tail('-h', '--help', 'Show this message') do
+        PRINTER.print opts
+        options.halt = true
+      end
+    end
+
+    private
+
+    #
+    # Triggers the listener with the +Command+ and options parsed
+    #
+    def parsing_succeeded(command, options)
+      listener.start_exec(command, options)
+    end
+
+    #
+    # Triggers the listener with the failure of the +Command+
+    #
+    def parsing_failed(command)
+      listener.argument_error(command)
+    end
+
+    #
+    # Handles when there is no command (maybe only an option is given)
+    #
+    def no_command_supplied
+      listener.done_with_no_guarantee
+    end
+    # private
+  end  # class Parser
+end