lxc 0.0.9 → 0.1.0

data/README.md

@@ -8,6 +8,56 @@
 
 An interface for controlling local or remote Linux Containers (LXC).
 
+# EXAMPLES
+
+
+Given the following code:
+
+    require 'lxc'
+
+    lxc = LXC.new(:use_sudo => true)
+    lxc.use_sudo = true
+    lxc.version
+    c = LXC::Container.new(:lxc => lxc, :name => 'test')
+    c.running?
+    c.exists?
+
+Executed via the lxc-console development binary:
+
+    $ be ./bin/lxc-console
+
+    From: /home/zpatten/Dropbox/code/personal/testlab-repo/vendor/checkouts/lxc/bin/lxc-console @ line 12 Object#lxc_console:
+
+         3: def lxc_console
+         4:   require 'pry'
+         5:   require 'lxc'
+         6:
+         7:   ##
+         8:   #
+         9:   # Welcome to the LXC RubyGem console!
+        10:   #
+        11:   ##
+     => 12:   binding.pry
+        13: end
+
+    [1] pry(main)> require 'lxc'
+    => false
+    [2] pry(main)>
+    [3] pry(main)> lxc = LXC.new(:use_sudo => true)
+    => #<LXC use_sudo=true use_ssh=false>
+    [4] pry(main)> lxc.use_sudo = true
+    => true
+    [5] pry(main)> lxc.version
+    => "0.8.0-rc2"
+    [6] pry(main)> c = LXC::Container.new(:lxc => lxc, :name => 'test')
+    => #<LXC::Container name="test">
+    [7] pry(main)> c.running?
+    => false
+    [8] pry(main)> c.exists?
+    => false
+    [9] pry(main)>
+
+
 # RESOURCES
 
 Documentation:

data/lib/lxc/container.rb

@@ -64,12 +64,15 @@ class LXC
     # @return [String] Container name
     attr_reader :name
 
-    def initialize(lxc, name)
-      raise ContainerError, "You must supply a LXC object!" if lxc.nil?
-      raise ContainerError, "You must supply a container name!" if (name.nil? || name.empty?)
-
-      @lxc  = lxc
-      @name = name
+    # @param [Hash] options Options hash.
+    # @option options [LXC] :lxc Our parent LXC class instance.
+    # @option options [String] :name The name of the container.
+    def initialize(options={})
+      @lxc  = options[:lxc]
+      @name = options[:name]
+
+      raise ContainerError, "You must supply a LXC object!" if @lxc.nil?
+      raise ContainerError, "You must supply a container name!" if (@name.nil? || @name.empty?)
     end
 
     # LXC configuration class

data/lib/lxc/version.rb

@@ -2,7 +2,7 @@ class LXC
 
   unless const_defined?(:VERSION)
     # LXC Gem Version
-    VERSION = "0.0.9"
+    VERSION = "0.1.0"
   end
 
 end

data/lib/lxc.rb

@@ -51,6 +51,11 @@ class LXC
   # @see http://www.commandlinefu.com/commands/view/3584/remove-color-codes-special-characters-with-sed CommandLineFu - Remove Color Codes (Special Characters) with SED
   SED_REMOVE_ANSI = %q(sed -r "s/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g")
 
+  # @param [Hash] options Options hash.
+  # @option options [Boolean] :use_sudo (false) Whether or not to prefix all
+  #   commands with 'sudo'.
+  # @option options [Net::SSH,ZTK::SSH,nil] :use_ssh (nil) Whether or not to
+  #   execute all commands remotely via an SSH connection.
   def initialize(options={})
     @ui       = (options[:ui] || ZTK::UI.new)
     @use_sudo = (options[:use_sudo] || false)
@@ -73,7 +78,7 @@ class LXC
   # @param [String] name The container name to initalize.
   # @return [LXC::Container] Returns the container object.
   def container(name)
-    LXC::Container.new(self, name)
+    LXC::Container.new(:lxc => self, :name => name)
   end
 
   # Current containers
@@ -85,7 +90,7 @@ class LXC
   def containers
     container_names = self.ls
     container_names.map do |container_name|
-      LXC::Container.new(self, container_name)
+      LXC::Container.new(:lxc => self, :name => container_name)
     end
   end
 

data/spec/lxc/container_spec.rb

@@ -4,7 +4,7 @@ describe LXC::Container do
 
   TEST_CONTAINER_NAME = "test-container"
 
-  subject { LXC::Container.new(LXC.new, TEST_CONTAINER_NAME) }
+  subject { LXC::Container.new(:lxc => LXC.new, :name => TEST_CONTAINER_NAME) }
 
   describe "class" do
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lxc
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -182,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1034151525174277004
+      hash: 574706320060241310
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1034151525174277004
+      hash: 574706320060241310
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25