vpn 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72d2274111b70ff5980f5f47840ac98a9d3d7fc1
-  data.tar.gz: 0dd193d0bc4782d6cd9a3ed85942f1ca30099d40
+  metadata.gz: a3b30e5e0698a20cfbd6cae0492c65cafe1e7f3b
+  data.tar.gz: 351e5f0f442a281c53e2309258a17b44c07b3c82
 SHA512:
-  metadata.gz: d0ddbacbdfb8f4b2e59a7f88ebc1be413a4e3b924bea7412f6b073a560adaa1db2a264ff23238e5b36bfb1809775b0c17f8d1c83bf963eaa90ebc1eeae04cbed
-  data.tar.gz: aa062ba4023e93ba67b5d87f2692e97603e14c4d990609bc8b22a52fe86207655348ac397dcdda7cca66dcefe51a09287dd46ecfda012fed89a410516d052b79
+  metadata.gz: 0fd83ca2d47d794c70039313d3943f1386b6feeb44c3b8aec7353aa3dfadebda1619701589b583628ec856eda8076fc4c9493beaa3d7bb004a92d23391756db0
+  data.tar.gz: f3d03676cb0f25cefa1b048dd53efb5b924c3de4d61b3000a6e6bcdab72dfc6a4a9855d5f221acad424b1a150bda84f72aa79588dcfc62e98685f51c86de3ae3

data/.gitignore

@@ -1 +1,3 @@
 *.gem
+/coverage/
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -1,14 +1,18 @@
 # vpn
 [![Gem Version](https://badge.fury.io/rb/vpn.png)](http://badge.fury.io/rb/vpn)
+[![Build Status](https://travis-ci.org/ronen/vpn.svg?branch=master)](https://travis-ci.org/ronen/vpn)
 
 A shell command for making vpn connections.  It's a convenience wrapper around [openconnect](http://www.infradead.org/openconnect/), in which you set up a configuration file with connection details, then just "vpn up" to connect.
 
+Requires ruby version >= 2.1.0
+
 ## Usage
 
 ```sh
 $ vpn up [site]
 $ vpn down
 $ vpn reset # if your lan connection glitches
+$ vpn status # tells you if vpn is up or down
 ```
 
 The script will prompt for your vpn password on the site as well as for the sudo password on your machine (if needed).
@@ -42,6 +46,14 @@ mycompany:
 
 Each entry must specify a `server`. All other fields get passed as options to openconnect -- see `$ man openconnect` to find out what they are.  Options that don't take values can be specified using the value `true`.
 
+## History
+
+* 0.2.0 - add 
+* 0.1.0 - Initial release
+
+## Last but not least...
+
+Comments, suggestions, and pull requests are all welcome!
 
 
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/vpn

@@ -1,55 +1,107 @@
 #!/usr/bin/env ruby
 
 require 'pathname'
+require 'shellwords'
 require 'yaml'
 
 CONFIG_FILENAME = "~/.vpn"
 PIDFILE = "/tmp/openconnect.pid"
 
-defaults = {
-    "background" => true,
-    "passwd-on-stdin" => true,
-    "pid-file" => PIDFILE,
-    "quiet" => true,
-}
+class Vpn
 
-def pid
-    File.read(PIDFILE).to_i
-end
+    DEFAULTS = {
+        "background" => true,
+        "passwd-on-stdin" => true,
+        "pid-file" => PIDFILE,
+        "quiet" => true,
+    }
+
+    def up(config)
+        abort "vpn is already up" if connected?
+        opts = DEFAULTS.merge config.opts
+        server = opts.delete("server") or abort "#{config.site} in #{config.filename} must specify a server"
+        args = opts.map{ |key, val| val == true ? "--#{key}" : "--#{key}=#{Shellwords.escape val}"}.join(' ')
+        sudo "openconnect #{args} #{server} <<< #{Shellwords.escape (passwd config.site)}"
+    end
+
+    def down
+        abort "vpn is already down" unless connected?
+        kill(:HUP)
+    end
+
+    def reset
+        abort "vpn is not up" unless connected?
+        kill(:USR2)
+    end
+
+    def connected?
+        !!pid
+    end
+
+    private
+
+    def pid
+        @pid ||= begin
+                     pid = File.read(PIDFILE).to_i # get process id
+                     Process.kill 0, pid # probe process
+                     pid
+                 rescue Errno::ENOENT # no PIDFILE
+                     nil
+                 rescue Errno::EPERM # process exists but no permission (because of sudo)
+                     pid
+                 rescue SystemCallError => e # no process
+                     nil
+                 end
+    end
+
+    def sudo(cmd)
+        system "sudo -p 'sudo password: ' #{cmd}"
+    end
+
+    def kill(signal)
+        sudo "kill -s #{signal} #{pid}"
+    end
+
+    def passwd(site)
+        $stdout.write "#{site} vpn password: "
+        $stdout.flush
+        begin
+            system "stty -echo"
+            @password = $stdin.gets.chomp
+        ensure
+            puts "\n"
+            system "stty echo"
+        end
+    end
 
-def passwd(site)
-    STDOUT.write "#{site} vpn password: "
-    STDOUT.flush
-     begin
-       system "stty -echo"
-       @password = STDIN.gets.chomp
-     ensure
-       system "stty echo"
-     end
-end
 
-def sudo(cmd)
-    system "sudo -p 'sudo password: ' #{cmd}"
 end
 
-def load_config
-    begin
-        YAML.load Pathname(CONFIG_FILENAME).expand_path.read
-    rescue Errno::ENOENT => e
-        abort "Could not open config file #{e.message.sub(".* - ", '')}"
+class ConfigData
+    attr_reader :site, :opts, :filename
+    def initialize(site)
+        @filename = CONFIG_FILENAME
+        begin
+            @config = YAML.load Pathname(@filename).expand_path.read
+        rescue Errno::ENOENT => e
+            abort "Could not open config file #{@filename}"
+        end
+        @site = site || @config.keys.first
+        @config.include? @site or abort "#{@site} not listed in #{CONFIG_FILENAME}"
+        @opts = @config[@site]
     end
+
 end
+        
+if __FILE__ == $0
 
-case ARGV.shift
-when "up" then
-    config = load_config
-    site = ARGV.shift || config.keys.first
-    config.include? site or abort "#{site} not listed in #{CONFIG_FILENAME}"
-    opts = defaults.merge config[site]
-    server = opts.delete("server") or abort "#{CONFIG_FILENAME} must specify a server"
-    args = opts.map{ |key, val| val == true ? "--#{key}" : "--#{key}=#{val}"}.join(' ')
-    sudo "openconnect #{args} #{server} <<< #{passwd site}"
-when "down" then sudo "kill -s HUP #{pid}"
-when "reset" then sudo "kill -s USR2 #{pid}"
-else abort "usage: #{$0} up [site]|down|reset"
+    vpn = Vpn.new
+
+    case ARGV.shift
+    when "up" then vpn.up ConfigData.new(ARGV.shift)
+    when "down" then vpn.down
+    when "reset" then vpn.reset
+    when "status" then puts "vpn is #{vpn.connected? ? "up" : "down" }"
+    else abort "usage: #{File.basename $0} up [site]|down|reset|status"
+    end
 end

data/vpn.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "vpn"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["ronen barzel"]
   spec.email         = ["ronen@barzel.org"]
 
@@ -15,6 +15,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "simplecov", "~> 0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vpn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: Lets you set up one or more vpn configurations, then connect via `vpn
   up` and `vpn down`.
 email:
@@ -48,6 +76,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile