sshez 0.3.0 → 1.0.0

data/lib/sshez/printing_manager.rb

@@ -0,0 +1,52 @@
+require 'singleton'
+
+module Sshez
+  # Just a printing service that keeps track by all its output
+  # Mainly used for testing purposes
+  class PrintingManager
+    include Singleton
+    # An attribute reader to store printing logs
+    attr_reader :output
+
+    def initialize
+      @output = ''
+      @verbose = false
+    end
+
+    # adds to output then prints
+    def print(text)
+      @output += %(#{text}\n)
+      puts text
+    end # print(text)
+
+    #
+    # prints only if verbose set to true
+    #
+    def verbose_print(text)
+      @output += %(#{text}\n)
+      puts text if @verbose
+    end
+
+    #
+    # Did we print anything?
+    #
+    def output?
+      !@output.empty?
+    end
+
+    #
+    # Let the flooding begin!
+    #
+    def verbose!
+      @verbose = true
+    end
+
+    #
+    # Resets the printer for testing purposes
+    #
+    def clear!
+      @output = ''
+      @verbose = false
+    end
+  end # PrintingManager
+end

data/lib/sshez/runner.rb

@@ -0,0 +1,60 @@
+module Sshez
+  #
+  # Our main class
+  # This will #process the command of the user
+  #
+  # Sshez::Runner.new.process(ARGV)
+  #
+  # Acts as the listener that the +Exec+ needs
+  # *  :argument_error(+Command+)
+  # *  :done_with_no_guarantee
+  # *  :permission_error
+  # *  :finished_successfully
+  #
+  #
+  #
+  class Runner
+    PRINTER = PrintingManager.instance
+
+    #
+    # Main method of the application
+    # takes un processed ARGS and pass it to our parser to start our processing
+    #
+    def process(args)
+      parser = Parser.new(Exec.new(self))
+      parser.parse(args)
+      PRINTER.output
+    end
+
+    #
+    # We've finished everything successfully
+    #
+    def finished_successfully
+      PRINTER.print 'Terminated Successfully!'
+    end
+
+    #
+    # Handles when the config file could not be accessed due to a problem in permissions
+    #
+    def permission_error
+      PRINTER.print "Premission denied!\nPlease check your ~/.ssh/config permissions then try again."
+    end
+
+    #
+    # Returns the appropriate error messages to the given command
+    #
+    def argument_error(command)
+      PRINTER.print(command.error)
+    end
+
+    #
+    # When no valid command was supplied (maybe only an option)
+    #
+    def done_with_no_guarantee
+      unless PRINTER.output?
+        PRINTER.print('Invalid input. Use -h for help')
+      end
+    end
+
+  end # class Runner
+end

data/lib/sshez/version.rb

@@ -1,3 +1,6 @@
 module Sshez
-  VERSION = "0.3.0"
+	#
+	# Returns version
+	#
+  VERSION = "1.0.0"
 end

data/spec/sshez_spec.rb

@@ -2,14 +2,14 @@ require 'spec_helper'
 
 describe Sshez do
 
-  subject { Sshez::Exec.new }
-  it 'has a version number' do
-    expect(Sshez::VERSION).not_to be nil
-  end
+  subject { Sshez::Runner.new }
 
   describe '#process' do
-    let(:input) { 'google root@74.125.224.72 -p 80 -t' }
-    let(:output) { subject.process(input.split(" ")) }
+    let(:input) { %w{add google root@74.125.224.72 -p 80 -t -b} }
+    let(:output) do
+      Sshez::PrintingManager.instance.clear!
+      subject.process(input)
+    end
 
     it 'begins with what it does' do
       expect(output).to start_with "Adding"
@@ -21,61 +21,108 @@ describe Sshez do
       expect(output).to match /Port 80/i
     end
 
+    it 'adds batch mode option' do
+      expect(output).to match /BatchMode yes/i
+    end
+
     it 'always appends "Done" if succeeds' do
-      expect(output).to end_with 'Done!'
+      expect(output).to end_with "Terminated Successfully!\n"
     end
   end
 
   describe "fails" do
-    let(:input) { 'root@74.125.224.72' }
-    let(:output) { subject.process(input.split(" ")) }
+    let(:input) { %w{root@74.125.224.72} }
+    let(:output) do
+      Sshez::PrintingManager.instance.clear!
+      subject.process(input)
+    end
 
     it 'and printes start' do
       expect(output).to start_with "Invalid input"
     end
 
     it 'and then asks for help at the end' do
-      expect(output).to end_with 'Use -h for help'
+      expect(output).to end_with "Use -h for help\n"
     end
 
   end
 
   describe "help works" do
     let(:input) { '-h' }
-    let(:output) { subject.process(input.split(" ")) }
+    let(:output) do
+      Sshez::PrintingManager.instance.clear!
+      subject.process([input])
+    end
 
-    it 'prints but outputs nothing' do
-      expect(output).to eq nil
+    it 'prints but ending with this message' do
+      expect(output).to end_with "Show this message\n\n"
     end
   end
 
   describe "remove" do
-    before { subject.process(%w{google root@74.12.32.42 -p 30}) }
-    let(:input) { "google -r" }
-    let(:output) { subject.process(input.split(" ")) }
+    before { subject.process(%w{add google root@74.12.32.42 -p 30}) }
+    let(:input) { %w{remove google} }
+    let(:output) do
+      Sshez::PrintingManager.instance.clear!
+      subject.process(input)
+    end
 
     it 'ends with 30' do
-      expect(output).to end_with "30\n"
+      expect(output).to end_with "30\n\nTerminated Successfully!\n"
+    end
+  end
+
+  describe "remove and try to connect" do
+    before do
+      subject.process(%w{add google root@74.12.32.42 -p 30})
+      subject.process(%w{remove google})
+    end
+
+    let(:input) { %w{connect google} }
+
+    let(:output) do
+      Sshez::PrintingManager.instance.clear!
+      subject.process(input)
+    end
+
+    it 'fails to connect to removed host' do
+      expect(output).to end_with "Could not find host `google`\n"
     end
   end
 
   describe "list works" do
-    before { subject.process(%w{google root@74.12.32.42 -p 30}) }
-    let(:input) { "list" }
-    let(:output) { subject.process(input.split(" ")) }
-    after { subject.process(%w{google -r}) }
+    before { subject.process(%w{add google root@74.12.32.42 -p 30}) }
+    let(:input) { %w{list} }
+    let(:output) do
+      Sshez::PrintingManager.instance.clear!
+      subject.process(input)
+    end
+    after { subject.process(%w{remove google}) }
 
     it 'contains added alias' do
-      expect(output).to end_with "google\n"
+      expect(output).to end_with "google\nTerminated Successfully!\n"
     end
   end
 
+  describe "printer works" do
+    before { Sshez::PrintingManager.instance.clear! }
+
+    let(:printer) { Sshez::PrintingManager.instance }
+    let(:output) { printer.print("this is it"); printer.output }
+
+    it 'should be printed and kept' do
+      expect(output).to end_with "this is it\n"
+    end
+
+    after { Sshez::PrintingManager.instance.clear! }
+  end
+
   describe "version works" do
     let(:input) { "-v" }
     let(:output) { subject.process(input.split(" ")) }
 
     it 'matches gem version' do
-      expect(output).to end_with "#{Sshez.version}"
+      expect(output).to end_with "#{Sshez.version}\n"
     end
   end
 end

data/sshez.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.test_files    = Dir["spec/**/*"]
   spec.require_paths = ["lib"]
-  spec.executables   = ["sshez"] 
+  spec.executables   = ["sshez"]
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshez
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Immortal Friday
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,12 +64,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - LICENSE.txt
 - README.md
@@ -78,9 +81,11 @@ files:
 - bin/setup
 - bin/sshez
 - lib/sshez.rb
-- lib/sshez/config_file.rb
+- lib/sshez/command.rb
 - lib/sshez/exec.rb
-- lib/sshez/params.rb
+- lib/sshez/parser.rb
+- lib/sshez/printing_manager.rb
+- lib/sshez/runner.rb
 - lib/sshez/version.rb
 - spec/spec_helper.rb
 - spec/sshez_spec.rb
@@ -106,10 +111,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Easy ssh config handling
 test_files:
-- spec/sshez_spec.rb
 - spec/spec_helper.rb
+- spec/sshez_spec.rb

data/lib/sshez/config_file.rb

@@ -1,83 +0,0 @@
-module Sshez  
-  class ConfigFile
-    FILE_PATH = File.expand_path('~') + "/.ssh/config"
-
-    def self.append(name, user, host, options)
-      output =  "Adding\n"
-      config_append = form(name, user, host, options)
-      output += config_append
-      unless options.test
-        file = File.open(FILE_PATH, "a+")
-        file.write(config_append)
-        file.close
-        puts "Successfully added `#{name}` as an alias for `#{user}@#{host}`"
-        system "chmod 600 #{FILE_PATH}"
-      end
-      output += "to #{FILE_PATH}\n"
-      output += "try ssh #{name} \n"
-      
-      output
-    end
-
-    def self.form(name, user, host, options)
-      retuned = "\n"
-      retuned += "Host #{name}\n"
-      retuned += "  HostName #{host}\n"
-      retuned += "  User #{user}\n"
-      
-      options.file_content.each_pair do |key, value|
-        retuned += value
-      end
-      retuned
-
-    end
-
-    def self.remove(name)
-      output = ""
-      started_removing = false
-      file = File.open(FILE_PATH, "r")
-      new_file = File.open(FILE_PATH+"temp", "w")
-      file.each do |line|
-        if line.include?("Host #{name}")|| started_removing
-          if started_removing && line.include?("Host ") && !line.include?(name)
-            started_removing = false
-          else
-            output += line
-            started_removing = true
-          end
-        else
-          new_file.write(line)
-        end
-      end
-      file.close
-      new_file.close
-      File.delete(FILE_PATH)
-      File.rename(FILE_PATH + "temp", FILE_PATH)
-      system "chmod 600 #{FILE_PATH}"
-
-      if output.empty?
-        return "could not find host (#{name})"
-      else
-        return output
-      end
-    end
-
-    def self.list
-      file = File.open(FILE_PATH, "r")
-      servers = []
-      file.each do |line|
-        if line.include?("Host ")
-          servers << line.sub('Host', '')
-        end
-      end
-      file.close
-      if servers.empty?
-        puts "No aliases added"
-      else
-        puts "Listing aliases:"
-        servers.each{|x| puts "\t- #{x}"}
-      end
-      return servers.join(',')
-    end
-  end
-end

data/lib/sshez/params.rb

@@ -1,64 +0,0 @@
-module Sshez  
-  class Params
-    #
-    # Return a structure describing the options.
-    #
-    def self.parse(args)
-      # The options specified on the command line will be collected in *options*.
-      # We set default values here.
-      options = OpenStruct.new
-      options.file_content = OpenStruct.new
-
-      opt_parser = OptionParser.new do |opts|
-        opts.banner = "Usage:\n\tsshez <alias> (role@host|-r) [options]\n\tsshez remove <alias>\n\tsshez list"
-
-        opts.separator ""
-        opts.separator "Specific options:"
-
-        # Mandatory argument.
-        opts.on("-p", "--port PORT",
-                "Specify a port") do |port|
-          options.port = port
-          options.file_content.port_text = "  Port #{options.port}\n"
-        end
-
-        # Optional argument; multi-line description.
-        opts.on("-i", "--identity_file [key]",
-                "Add identity") do |key_path|
-          options.identity_file = key_path
-          options.file_content.identity_file_text = "  IdentityFile #{options.identity_file}\n"
-        end
-
-        opts.on("-r", "--remove", "Remove handle") do
-          options.remove = true
-        end
-
-        opts.on("-t", "--test", "Writes nothing") do
-          options.test = true
-        end
-
-        opts.separator ""
-        opts.separator "Common options:"
-
-        opts.on("-l", "--list", "List aliases") do
-          Sshez::ConfigFile.list
-          return
-        end
-
-        # Another typical switch to print the version.
-        opts.on("-v", "--version", "Show version") do
-          puts Sshez.version
-          return
-        end
-
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          puts "\n"
-        end
-      end
-
-      opt_parser.parse!(args)
-      options
-    end  # parse()
-  end  # class Params
-end