net-openvpn 0.2.1 → 0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2RiMDYyMjdiOWYxMzkzZWQyNjRjNTIzMTk4Y2UzZjVhMmM5OGNmMg==
-  data.tar.gz: !binary |-
-    NTU4NTI4MGM4MjBkZTI4ZjMxNzMzNGE5YWFiNmQ2ZWJkZGY4MTA1Zg==
+SHA1:
+  metadata.gz: 31c5a0e4bcf580d2b27834d191891a01215ac82d
+  data.tar.gz: dc9bcbea63aa3f265560fac744ab085115a1968f
 SHA512:
-  metadata.gz: !binary |-
-    MjFhZTcwODYzNzQxYjA2ODlkN2Q2OTFjZDU5ZTM4MTgyYjRhMTkxYTE3NzFk
-    N2Y4Y2E2OGJlNDNmOTA4OWQwOTIxMmJhYzdhZTFkOGMxNjVkODAxMTE5NWFj
-    NzdiYTYxOGM5MTRhZWJlMDFlZGM5YTgzZGMzMTkzMjYwMWE3M2Q=
-  data.tar.gz: !binary |-
-    Mzk1NTE5OWUyZjM2NmQwOWQxM2U5OGM4MzExMmJlMTE0M2VlYTQxMWQwZTll
-    MjM2NzNiMzFhZGZmMmFmOTcxODkxYjY5YzRjZWFmM2RjYjM1NzdmMTRiZjRi
-    NThlZTcxMDljNzgwMzIxYjk5ODY0YzE0OThmNzMzMTA3ZDEwOGM=
+  metadata.gz: 74270037b4c6b1bf017b85571609861321413f526e8b91677b42451e432ceca2bbc073ea63e196cc9ea04f5c59b9adeb80a59f1d4f5283b3f3644b9e65903185
+  data.tar.gz: 5c69397a66ae1086a7686074f3a19f495f10f366ca604b7059cee9807fdfa78550f277aeb8a3696f64e2e3383141df65d13495209c0f846556886943129858ff

data/.gitignore

@@ -0,0 +1 @@
+/pkg

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    net-openvpn (0.2.1)
+    net-openvpn (0.3)
 
 GEM
   remote: https://rubygems.org/
@@ -17,6 +17,7 @@ GEM
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.5)
+    serialport (1.3.0)
 
 PLATFORMS
   ruby
@@ -27,3 +28,4 @@ DEPENDENCIES
   net-openvpn!
   rake
   rspec
+  serialport

data/README.md

@@ -16,6 +16,8 @@ server.save
 
 ### Host Configuration (read: client-config-directive)
 
+**Technically this is a client**, and I should have named it `Client` instead of `Host`, but I don't want to break existing apps using this gem.  So I aliased `Net::Openvpn::Client` to `Net::Openvpn::Host` so you can use the former.  However, objects returned by initialization will still be of the type `Net::Openvpn::Host`.
+
 This is how you set the IP address of a VPN host with the hostname `optimus`:
 
 ```ruby
@@ -25,6 +27,12 @@ host.network = 10.8.0.0
 host.save
 ```
 
+You can also use a ActiveModel kind of initialization to allow you to create a host in one fell swoop:
+
+```ruby
+Net::Openvpn::Host.new("optimus", ip: "10.8.0.10", network: "10.8.0.0").save
+```
+
 This would create a file at `/etc/openvpn/ccd/optimus` containing the following:
 
 ```
@@ -33,6 +41,17 @@ ifconfig-push 10.8.0.24 10.8.0.0
 
 So that any host connecting to the VPN with a hostname of `optimus` get assigned `10.8.0.24`.
 
+There are also some other handy methods on the host object:
+
+```ruby
+host.file     # where is the file kept?
+host.remove   # get rid of the host (delete the file)
+host.exist?   # does the file exist?
+host.new?     # has it been saved yet?
+host.ip       # what is the ip of this host
+host.network  # what is the network of this host
+```
+
 ## Rails Permissions
 
 If you are running rails and you want to give the rails user access, you could do it like this:

data/Rakefile

@@ -6,3 +6,20 @@ RSpec::Core::RakeTask.new
 
 task :default => :spec
 task :test => :spec
+
+task :console do
+  begin
+    # use Pry if it exists
+    require 'pry'
+    require 'net/openvpn'
+    Pry.start
+  rescue LoadError
+    require 'irb'
+    require 'irb/completion'
+    require 'net/openvpn'
+    ARGV.clear
+    IRB.start
+  end
+end
+
+task :c => :console

data/lib/net/openvpn/client_config.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Net
   module Openvpn
     class ClientConfig
@@ -36,8 +38,8 @@ module Net
       end
 
       def remove
-        return true if File.exist? path
-        File.delete path
+        return true if !File.exist? path
+        FileUtils.rm path
       end
 
       def save

data/lib/net/openvpn/host.rb

@@ -2,9 +2,17 @@ module Net
   module Openvpn
     class Host
 
-      def initialize(hostname)
+      attr_accessor :ip, :network
+      attr_reader :hostname
+      alias_method :name, :hostname
+
+      def initialize(hostname, **params)
         @hostname = hostname
         @config = Net::Openvpn::ClientConfig.new(@hostname)
+
+        params.each do |key, value|
+          self.send("#{key}=".to_sym, value)
+        end
       end
 
       def generate_key
@@ -15,15 +23,17 @@ module Net
 
       end
 
-      def ip=(ip)
-        @config.ip = ip
+      def file
+        @config.path
       end
 
-      def network=(network)
-        @config.network = network
+      def path
+        @config.path
       end
 
       def save
+        @config.ip = ip
+        @config.network = network
         @config.save
       end
 
@@ -35,6 +45,12 @@ module Net
         !@config.exists?
       end
 
+      def exist?
+        @config.exists?
+      end
+
     end
   end
-end
+end
+
+Net::Openvpn::Client = Net::Openvpn::Host

data/lib/net/openvpn/version.rb

@@ -1,5 +1,5 @@
 module Net
   module Openvpn
-    VERSION = "0.2.1"
+    VERSION = "0.3"
   end
 end

data/net-openvpn.gemspec

@@ -20,5 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "serialport"
+
 end
 

data/spec/lib/net/openvpn/host_spec.rb

@@ -2,54 +2,81 @@ require 'spec_helper'
 require 'fileutils'
 
 describe Net::Openvpn::Host, fakefs: true do
-
-  let(:network) { "10.8.0.0" }
-  let(:ip)      { "10.8.0.10" }
+  let(:hostname) { "test" }
+  let(:network)  { "10.8.0.0" }
+  let(:ip)       { "10.8.0.10" }
+  subject(:host) { Net::Openvpn::Host.new(hostname, ip: ip, network: network) }
 
   before(:each) do
     FileUtils.mkdir_p("/etc/openvpn/ccd")
   end
 
-  def create_a_host
-    host = Net::Openvpn.host("test")
-    host.ip = ip
-    host.network = network
+  it "should create a host client configuration" do
+    expect(host).to_not exist
     host.save
-    host
+    expect(host).to exist
   end
 
-  it "should create a host client configuration" do
-    create_a_host
+  it "should remove a host client configuration" do
+    host.save
+    expect(host).to exist
+    host.remove
+    expect(host).to_not exist
+  end
 
-    expect(File.exist?("/etc/openvpn/ccd/test")).to be_true
+  it "should have the correct info in the CCD file" do
+    host.save
+    expect(File.read host.file).to include ip
+    expect(File.read host.file).to include network
   end
 
-  it "should remove a host client configuration" do
-    host = create_a_host
+  it "should be new when it hasn't been saved" do
+    expect(host).to be_new
+  end
 
-    host.remove
-    expect(File.exist?("/etc/openvpn/ccd/test")).to be_false
+  it "should not be new when it has been saved" do
+    host.save
+    expect(host).to_not be_new
   end
 
-  it "should have the correct info in the CCD file" do
-    host = create_a_host
+  it "should assign the ip" do
+    ip = "10.10.0.10"
+    host.ip = ip
+    expect(host.ip).to eq ip
+  end
 
-    expect(File.read("/etc/openvpn/ccd/test")).to include ip
-    expect(File.read("/etc/openvpn/ccd/test")).to include network
+  it "should assign the network" do
+    network = "10.10.0.0"
+    host.network = network
+    expect(host.network).to eq network
   end
 
-  it "should be new when it hasn't been saved" do
-    host = Net::Openvpn.host("test")
+  it "should save the ip to the file" do
+    host.save
+    ip = "10.10.0.10"
     host.ip = ip
+    host.save
+    expect(File.read host.file).to include ip
+  end
+
+  it "should save the network to the file" do
+    host.save
+    network = "10.10.0.0"
     host.network = network
+    host.save
+    expect(File.read host.file).to include network
+  end
 
-    expect(host.new?).to be_true
+  it "should return the name of the host" do
+    expect(host.name).to eq hostname
   end
 
-  it "should not be new when it has been saved" do
-    host = create_a_host
+  it "should return the ip of the host" do
+    expect(host.ip).to eq ip
+  end
 
-    expect(host.new?).to be_false
+  it "should return the network of the host" do
+    expect(host.network).to eq network
   end
 
 end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: net-openvpn
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - Robert McLeod
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-04 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Net-Openvpn is an openvpn library for configuring a local OpenVPN service
@@ -73,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -96,17 +111,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Local OpenVPN configurator