openvpn_management 0.9.0.pre → 0.9.4.pre

data/README.rdoc

@@ -6,43 +6,78 @@ Ruby gem for openVPN (server) management interface interaction.
 
 Please keep in mind that this software is in alpha development stage.
 
-== Installation
+= Installation
 
-=== Via Github, for development
+== Via Github, for development
 
     ~# git clone git://github.com/dguerri/openvpn_management.git
     ~# cd openvpn_management
     ~# bundle install
     ~# rake install
 
-=== Via Rubygems
+== Via Rubygems
 
     ~# gem install openvpn_management --pre
 
-== Usage
-
-=== Receiving data from an exporter (with eventmachine)
-
-   require 'Rubygems'
-   require 'openvpn_management'
-
-   s = OpenvpnManagement.new :host => "localhost", :port => 1234, :timeout => 10,  :password => "password"
-   s.version
-   s.status
-   s.stats
-   s.destroy
-
-== Contributing to openvpn_management
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
+= Usage
+
+== Sample code
+
+    require 'Rubygems'
+    require 'openvpn_management'
+    require 'pp'
+
+    # Assuming you've a VPN server with management interface on TCP port 1194 protected with
+    # password 'mypassword'
+    vpn1 = OpenvpnManagement.new :host => 'localhost', :port => 1194, :password => 'mypassword'
+    pp vpn1.version
+    pp vpn1.stats
+    pp vpn1.status
+
+    pp vpn1.status[:clients].keys
+    pp vpn1.status[:routes].keys
+
+    vpn1.destroy
+
+== Sample output
+
+    # vpn1.version
+    "OpenVPN Version: OpenVPN 2.x-master x86_64-unknown-linux-gnu [SSL] [LZO2] [EPOLL] [eurephia] [MH] [PF_INET6] [IPv6 payload 20110522-1 (2.2.0)] built on Sep 15 2011\nManagement Version: 1\nEND\n"
+    # vpn1.stats
+    {:clients=>1, :bytes_input=>1335293, :bytes_output=>140845}
+    # vpn1.status
+    {:clients=>
+     {"l2vpn_client_1_1_1"=>
+       [{:real_address=>"217.72.97.51:37698",
+         :bytes_received=>"1438510",
+         :bytes_sent=>"1456452",
+         :connected_since=>"Mon Mar  5 16:52:40 2012"}]},
+    :routes=>
+     {"e4:ce:8f:26:5f:8e"=>
+       {:real_address=>"217.72.97.51:37698",
+        :last_ref=>"Tue Mar  6 09:51:18 2012",
+        :common_name=>"l2vpn_client_1_1_1"},
+      "dc:2b:61:29:d2:d0"=>
+       {:real_address=>"217.72.97.51:37698",
+        :last_ref=>"Tue Mar  6 09:51:33 2012",
+        :common_name=>"l2vpn_client_1_1_1"}}}
+       # vpn1.status[:clients].keys
+       ["l2vpn_client_1_1_1"]
+       # vpn1.status[:routes].keys
+       ["e4:ce:8f:00:11:22", "dc:2b:61:aa:bb:cc"]
+
+= Note
+
+OpenVPN management interface isn't multi-client so destroy the OpenvpnManagement object as soon as you've finish using it.
+
+= Acknowledgements
+
+Thanks go to the following people who have contributed to this project:
+* Antonio Davoli
+* Alessandro Celestini
+* Ryan Huber (rawdigits) 
+
+= Copyright
 
 Copyright (C) 2012 Davide Guerri <davide.guerri@gmail.com>. See LICENSE.txt for further details.
 

data/lib/openvpn_management/version.rb

@@ -19,7 +19,7 @@ class OpenvpnManagement
   module Version
     MAJOR = 0
     MINOR = 9
-    PATCH = 0
+    PATCH = 4
     BUILD = 'pre'
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/openvpn_management.rb

@@ -58,14 +58,14 @@ class OpenvpnManagement
     routes = {}
 
     c = issue_command "status"
-    c.each do |l|
+    c.split("\n").each do |l|
 
       # End Information Markers
-      if l == "ROUTING TABLE\n"
+      if l == "ROUTING TABLE"
         client_list_flag = 0
       end
 
-      if l == "GLOBAL STATS\n"
+      if l == "GLOBAL STATS"
         routing_list_flag = 0
       end
 
@@ -85,16 +85,17 @@ class OpenvpnManagement
       # Update Routing Info List
       # Virtual Address,Common Name,Real Address,Last Ref
       if routing_list_flag == 1
+        route = []
         route << l.split(',')
         routes[route[0]] = { :common_name => route[1], :real_address=> route[2], :last_ref => route[3] }
       end
 
       # Start Information Markers
-      if l == "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since\n"
+      if l == "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since"
         client_list_flag = 1
       end
 
-      if l == "Virtual Address,Common Name,Real Address,Last Ref\n"
+      if l == "Virtual Address,Common Name,Real Address,Last Ref"
         routing_list_flag = 1
       end
     end
@@ -106,9 +107,9 @@ class OpenvpnManagement
   def stats
     stats_info = issue_command("load-stats").split(',')
     {
-        :clients => stats_info[0].gsub("SUCCESS: nclients=", "").to_i,
-        :bytes_input => stats_info[1].gsub("bytesin=", "").to_i,
-        :bytes_output => stats_info[2].chop!.gsub("bytesout=", "").to_i
+        :clients => stats_info[0].gsub("nclients=", "").to_i,
+        :bytes_download => stats_info[1].gsub("bytesin=", "").to_i,
+        :bytes_upload => stats_info[2].chop!.gsub("bytesout=", "").to_i
     }
   end
 

data/openvpn_management.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "openvpn_management"
+  s.version = "0.9.4.pre"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Davide Guerri"]
+  s.date = "2013-05-03"
+  s.description = "openvpn_management is a ruby gem for openVPN (server) management interface interaction."
+  s.email = "davide.guerri@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "GPLv3.txt",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "lib/openvpn_management.rb",
+    "lib/openvpn_management/version.rb",
+    "openvpn_management.gemspec"
+  ]
+  s.homepage = "https://github.com/dguerri/openvpn_management"
+  s.licenses = ["GPLv3"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "openvpn_management a ruby gem for openVPN management interface interaction."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 2.4.2"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+  end
+end
+

metadata

@@ -1,109 +1,105 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: openvpn_management
-version: !ruby/object:Gem::Version 
-  hash: 961915916
+version: !ruby/object:Gem::Version
+  version: 0.9.4.pre
   prerelease: 6
-  segments: 
-  - 0
-  - 9
-  - 0
-  - pre
-  version: 0.9.0.pre
 platform: ruby
-authors: 
+authors:
 - Davide Guerri
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id001
+date: 2013-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: shoulda
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
-  version_requirements: *id002
-  name: bundler
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 6
-        - 4
-        version: 1.6.4
-  version_requirements: *id003
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: jeweler
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  version_requirements: *id004
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
   name: rcov
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 4
-        - 2
-        version: 2.4.2
-  version_requirements: *id005
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rdoc
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.2
   type: :development
-description: openvpn_management is a ruby gem for openVPN (server) management interface interaction.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+description: openvpn_management is a ruby gem for openVPN (server) management interface
+  interaction.
 email: davide.guerri@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - GPLv3.txt
 - Gemfile
 - Gemfile.lock
@@ -112,40 +108,33 @@ files:
 - Rakefile
 - lib/openvpn_management.rb
 - lib/openvpn_management/version.rb
+- openvpn_management.gemspec
 homepage: https://github.com/dguerri/openvpn_management
-licenses: 
+licenses:
 - GPLv3
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1301214139549345267
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: openvpn_management a ruby gem for openVPN management interface interaction.
 test_files: []
-