sshez 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cec6ed214de47ce94ced8d951f0d17d5396b3281
-  data.tar.gz: 340865e6e375fe4389f3a7a2e2e2860e75bcf6e0
+  metadata.gz: 81d4df50a28eadb6dc1d260312afc882db0991c6
+  data.tar.gz: 398b00d1e2b4546b27ff77d24f091c9000c93cf7
 SHA512:
-  metadata.gz: ef73d905d7aad616af3035a4e2efb4c7d391701aaacd1ee02afc813454794598a72faf9236bfe96a0f1fef2ce2aa5dbce40d36231020877b035bd90f9ba0bb61
-  data.tar.gz: 2c4d2dd8e939aecf1cfd5d78ecd331fa2d11fba4f1ad1fbab6be4eb17e5816c518f737f4e19b0aaafc5856b9758a55082feec367a5874488ea92aac08e1cba1b
+  metadata.gz: 08716750ba791d2b50da690f287cf8658f36f8509c9c1abd06bb21d6123b0ec86ae8ef4b1ab02fdb785027c3378a2d8ea1337d9e368575c5e02af286498c5eca
+  data.tar.gz: 99fb3da310dfc3d3187ec5a8ebbfc48e37b059a3600c54b758e92e9d39373a8737d1b567aeab04dfd0d43edfb3a110c5e675a6c7c0fece2a6e3c7ffec141f83d

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+### Unreleased
+
+### 0.3.0 - 2015-12-14
+
+* enhancements
+  * Added `list` for listing aliases
+  * Added `sshez remove` as another way to remove aliases
+
+* bug fixes
+  * Fixed permissions bug for CentOS
+  * Fixed user experience issues
+
+### 0.2.0 - 2015-12-06
+
+* enhancements
+  * Added the `remove` feature
+
+### 0.1.0 - 2015-12-05
+
+* Initial release

data/README.md

@@ -5,43 +5,37 @@ If you have multiple servers that you access on daily bases! sshez helps you con
 
 ### Example
 
+Add an alias `mw_server`
+
     sshez mw_server root@74.125.224.72 -p 120
     
 you will be able to use
 
     ssh mw_server
-    
-
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'sshez'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install sshez
 
 ## Usage
 
-  try sshez -h
+    sshez -h
 
-    Usage: sshez aliase user@ip [options]
+    Usage:
+        sshez <alias> (role@host|-r) [options]
+        sshez remove <alias>
+        sshez list
 
     Specific options:
         -p, --port PORT                  Specify a port
         -i, --identity_file [key]        Add identity
+        -r, --remove                     Remove handle
+        -t, --test                       Writes nothing
 
     Common options:
+        -l, --list                       List aliases
+        -v, --version                    Show version
         -h, --help                       Show this message
-        --version  
 
 ## Development
 
@@ -63,10 +57,9 @@ 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)
-*   Add -r option to remove aliases
 
 ## Credit
 
-Mohamed Ossama who gave me this idea
+Mohamed Osama who gave me this idea
 
 

data/lib/sshez.rb

@@ -1,163 +1,13 @@
-require "sshez/version"
+require 'sshez/params'
+require 'sshez/config_file'
+require 'sshez/exec'
+require 'sshez/version'
 require 'optparse'
 require 'ostruct'
 
 module Sshez
-  # Your code goes here...
-  
-
-  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
-
-      opt_parser = OptionParser.new do |opts|
-        opts.banner = "Usage: sshez alias (role@host|-r) [options]"
-
-        opts.separator ""
-        opts.separator "Specific options:"
-
-        # Mandatory argument.
-        opts.on("-p", "--port PORT",
-                "Specify a port") do |port|
-          options.port = port
-        end
-
-        # Optional argument; multi-line description.
-        opts.on("-i", "--identity_file [key]",
-                "Add identity") do |key_path|
-          options.identity_file = key_path
-        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:"
-
-        # No argument, shows at tail.  This will print an options summary.
-        # Try it and see!
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-        end
-
-        # Another typical switch to print the version.
-        opts.on_tail("--version", "Show version") do
-          puts ::Version.join('.')
-        end
-      end
-
-      opt_parser.parse!(args)
-      options
-    end  # parse()
-
-  end  # class Params
-
-  class ConfigFile
-    def self.append(name, user, host, options)
-      output =  "Adding\n"
-      config_append = form(name, user, host, options)
-      output += "" + config_append
-      unless options.test
-        file_path = File.expand_path('~')+"/.ssh/config"
-        file = File.open(file_path, "a+")
-        file.write(config_append)
-        file.close
-      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"
-      
-      if options.port
-        retuned += "  Port #{options.port}\n"
-      end
-
-      if options.identity_file
-        retuned += "  IdentityFile #{options.identity_file}\n"
-      end
-      retuned
-
-    end
-
-    def self.remove(name)
-      output = ""
-      started_removing = false
-      file_path = File.expand_path('~')+"/.ssh/config"
-      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)
-
-      if output.empty?
-        return "could not find host (#{name})"
-      else
-        return output
-      end
-      
-    end
-    
-
-
-  end
-
-  class Exec
-
-    def process(args)
-      # parse the params to get the options
-      if (args.length < 2 || !args[1].include?("@") || args[0][0] == '-')
-        if args[0] == "-h"
-         Params.parse(args)
-         return nil
-        elsif ['-r', "--remove"].include?(args[1]) 
-          return ConfigFile.remove(args[0])
-        end
-        output = %Q|Invalid input
-        Use -h for help|
-        return output
-      end
-      options = Params.parse(args)
-
-
-      unless options.remove
-        user, host = args[1].split("@") 
-        output = ConfigFile.append(args[0], user, host, options)
-        output + "Done!"
-      end
-
-    end
 
+  def self.version
+    return Sshez::VERSION
   end
-
 end

data/lib/sshez/config_file.rb

@@ -0,0 +1,83 @@
+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/exec.rb

@@ -0,0 +1,42 @@
+module Sshez  
+  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
+        end
+      end
+
+      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
+        output = %Q|Invalid input. Use -h for help|
+        puts output
+        return output
+      end
+      options = Params.parse(args)
+
+      unless options.remove
+        user, host = args[1].split("@") 
+        output = ConfigFile.append(args[0], user, host, options)
+        output + "Done!"
+      end
+    end
+  end
+end

data/lib/sshez/params.rb

@@ -0,0 +1,64 @@
+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

data/lib/sshez/version.rb

@@ -1,3 +1,3 @@
 module Sshez
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sshez'

data/spec/sshez_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Sshez do
+
+  subject { Sshez::Exec.new }
+  it 'has a version number' do
+    expect(Sshez::VERSION).not_to be nil
+  end
+
+  describe '#process' do
+    let(:input) { 'google root@74.125.224.72 -p 80 -t' }
+    let(:output) { subject.process(input.split(" ")) }
+
+    it 'begins with what it does' do
+      expect(output).to start_with "Adding"
+    end
+
+    it 'prints what it appends' do
+      expect(output).to match /Host google/i
+      expect(output).to match /HostName 74.125.224.72/i
+      expect(output).to match /Port 80/i
+    end
+
+    it 'always appends "Done" if succeeds' do
+      expect(output).to end_with 'Done!'
+    end
+  end
+
+  describe "fails" do
+    let(:input) { 'root@74.125.224.72' }
+    let(:output) { subject.process(input.split(" ")) }
+
+    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'
+    end
+
+  end
+
+  describe "help works" do
+    let(:input) { '-h' }
+    let(:output) { subject.process(input.split(" ")) }
+
+    it 'prints but outputs nothing' do
+      expect(output).to eq nil
+    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(" ")) }
+
+    it 'ends with 30' do
+      expect(output).to end_with "30\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}) }
+
+    it 'contains added alias' do
+      expect(output).to end_with "google\n"
+    end
+  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}"
+    end
+  end
+end

data/sshez.gemspec

@@ -6,22 +6,21 @@ require 'sshez/version'
 Gem::Specification.new do |spec|
   spec.name          = "sshez"
   spec.version       = Sshez::VERSION
-  spec.authors       = ["Immortal Friday"]
-  spec.email         = ["khaled.gomaa.90@gmail.com"]
+  spec.authors       = ["Immortal Friday", "Oss"]
+  spec.email         = ["khaled.gomaa.90@gmail.com", "mohamed.o.alnagdy@gmail.com"]
 
   spec.summary       = %q{Easy ssh config handling}
-  spec.description   = %q{will interface your ssh config file
-    Allowing you to add aliases to your server and do a lot of cool stuff}
+  spec.description   = %q{No more remembering ips users or ports! Sshez interfaces your ssh config file
+    Allowing you to add aliases for your ssh connections to easily access them.}
   spec.homepage      = "https://github.com/GomaaK/sshez"
   spec.license       = "MIT"
 
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables   = ["sshez"] 
+  spec.test_files    = Dir["spec/**/*"]
   spec.require_paths = ["lib"]
+  spec.executables   = ["sshez"] 
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-
+  spec.add_development_dependency "rspec", "~> 3.4"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sshez
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Immortal Friday
+- Oss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-06 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,21 +43,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 description: |-
-  will interface your ssh config file
-      Allowing you to add aliases to your server and do a lot of cool stuff
+  No more remembering ips users or ports! Sshez interfaces your ssh config file
+      Allowing you to add aliases for your ssh connections to easily access them.
 email:
 - khaled.gomaa.90@gmail.com
+- mohamed.o.alnagdy@gmail.com
 executables:
 - sshez
 extensions: []
@@ -65,6 +67,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -75,7 +78,12 @@ files:
 - bin/setup
 - bin/sshez
 - lib/sshez.rb
+- lib/sshez/config_file.rb
+- lib/sshez/exec.rb
+- lib/sshez/params.rb
 - lib/sshez/version.rb
+- spec/spec_helper.rb
+- spec/sshez_spec.rb
 - sshez.gemspec
 - tasks/rspec.rake
 homepage: https://github.com/GomaaK/sshez
@@ -102,4 +110,6 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easy ssh config handling
-test_files: []
+test_files:
+- spec/sshez_spec.rb
+- spec/spec_helper.rb