libvirt-ruby 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -6,18 +6,37 @@ Rails gem to map functions from libvirt's library to ruby.
 
 gem install libvirt-ruby
 
+== Dependencies
+
+This gem has as a dependencie the libvirt package. Google it and u will find how to install it on your distro.
+
 == Usage
 
 You should one of the classes defined and call method dispatcher passing parameters:
- first -> the method just like the one from Libvirt in C as a string
+ first -> the method just like the one from Libvirt in C as a string except the vir and the name of the Class just like 'Close' from 'virConnectClose'
  second -> the args of the function in C in the same order
 
 Your second parameter must be an array where the last value is a symbol of what the function should return.
 
 == Experimental
 
-This Gem still experimental, so if you have somre problem, feel free to create a new issue.
+This Gem still experimental, so if you have some problem, feel free to create a new issue.
+
+== Tests
+
+The test have been made only on Debian Squeeze. When it got a bit larger, i will test it for another distros.
+Give it a try in another distro and let me know if it works.
 
 == Future
 
-Add Support for a ton of thigs. =D
+Add Support for a ton of thigs. =D
+Improve a lot of things:
+ * Use method missing and deprecate dispatcher.
+ * Find a way to make the test suit pass without the lib. By now it only works if u have it installed.
+ * Create more Exceptions for another type of errors.
+ * Create pages on Wiki teaching how to isntall libvirt on each distro.
+ ...
+
+== Contribute
+
+Fork the project and send me a Pull Request. =D

data/lib/libvirt-ruby.rb

@@ -1,16 +1,14 @@
-require "ffi"
 require "libvirt-ruby/version"
+require "ffi"
 
 module Libvirt
   module Ruby
-
-    extend FFI::Library
-    ffi_lib "libvirt"
-
     autoload :Connect, 'libvirt-ruby/connect'
     autoload :Domain, 'libvirt-ruby/domain'
+    autoload :Exceptions, 'libvirt-ruby/exceptions'
     autoload :Network, 'libvirt-ruby/network'
     autoload :StoragePool, 'libvirt-ruby/storage_pool'
     autoload :StorageVol, 'libvirt-ruby/storage_vol'
+    autoload :Util, 'libvirt-ruby/util'
   end
 end

data/lib/libvirt-ruby/connect.rb

@@ -1,10 +1,17 @@
 module Libvirt
   module Ruby
     module Connect
-      def self.dispatcher(method, args = [])
-        return_type = args.delete(args.last)
-        attach_function ("virConnect" + method.to_s), ("virConnect" + method.to_s), args, return_type
-        send(("virConnect" + method.to_s), args)
+      extend Libvirt::Ruby::Util
+      extend FFI::Library
+
+      begin
+        ffi_lib "libvirt.so.0"
+      rescue LoadError
+        raise Libvirt::Ruby::Exceptions::MissingLib
+      end
+
+      def self.klass
+        "virConnect"
       end
     end
   end

data/lib/libvirt-ruby/domain.rb

@@ -1,10 +1,17 @@
 module Libvirt
   module Ruby
     module Domain
-      def self.dispatcher(method, args = [])
-        return_type = args.delete(args.last)
-        attach_function ("virDomain" + method.to_s), ("virDomain" + method.to_s), args, return_type
-        send(("virDomain" + method.to_s), args)
+      extend Libvirt::Ruby::Util
+      extend FFI::Library
+
+      begin
+        ffi_lib "libvirt.so.0"
+      rescue LoadError
+        raise Libvirt::Ruby::Exceptions::MissingLib
+      end
+
+      def self.klass
+        "virDomain"
       end
     end
   end

data/lib/libvirt-ruby/exceptions.rb

@@ -0,0 +1,8 @@
+module Libvirt
+  module Ruby
+    module Exceptions
+      autoload :MissingLib, 'libvirt-ruby/exceptions/missing_lib'
+      autoload :InvalidFunction, 'libvirt-ruby/exceptions/invalid_function'
+    end
+  end
+end

data/lib/libvirt-ruby/exceptions/invalid_function.rb

@@ -0,0 +1,11 @@
+module Libvirt
+  module Ruby
+    module Exceptions
+      class InvalidFunction < StandardError
+        def initialize(function)
+          super("The function '#{function}' could not be found. Is it correct?")
+        end
+      end
+    end
+  end
+end

data/lib/libvirt-ruby/exceptions/missing_lib.rb

@@ -0,0 +1,11 @@
+module Libvirt
+  module Ruby
+    module Exceptions
+      class MissingLib < StandardError
+        def initialize
+          super("The libvirt C library could not be loaded. Is it properly installed?")
+        end
+      end
+    end
+  end
+end

data/lib/libvirt-ruby/network.rb

@@ -1,10 +1,17 @@
 module Libvirt
   module Ruby
     module Network
-      def self.dispatcher(method, args = [])
-        return_type = args.delete(args.last)
-        attach_function ("virNetwork" + method.to_s), ("virNetwork" + method.to_s), args, return_type
-        send(("virNetwork" + method.to_s), args)
+      extend Libvirt::Ruby::Util
+      extend FFI::Library
+
+      begin
+        ffi_lib "libvirt.so.0"
+      rescue LoadError
+        raise Libvirt::Ruby::Exceptions::MissingLib
+      end
+
+      def self.klass
+        "virNetwork"
       end
     end
   end

data/lib/libvirt-ruby/storage_pool.rb

@@ -1,10 +1,17 @@
 module Libvirt
   module Ruby
     module StoragePool
-      def self.dispatcher(method, args = [])
-        return_type = args.delete(args.last)
-        attach_function ("virStoragePool" + method.to_s), ("virStoragePool" + method.to_s), args, return_type
-        send(("virStoragePool" + method.to_s), args)
+      extend Libvirt::Ruby::Util
+      extend FFI::Library
+
+      begin
+        ffi_lib "libvirt.so.0"
+      rescue LoadError
+        raise Libvirt::Ruby::Exceptions::MissingLib
+      end
+
+      def self.klass
+        "virStoragePool"
       end
     end
   end

data/lib/libvirt-ruby/storage_vol.rb

@@ -1,10 +1,17 @@
 module Libvirt
   module Ruby
     module StorageVol
-      def self.dispatcher(method, args = [])
-        return_type = args.delete(args.last)
-        attach_function ("virStorageVol" + method.to_s), ("virStorageVol" + method.to_s), args, return_type
-        send(("virStorageVol" + method.to_s), args)
+      extend Libvirt::Ruby::Util
+      extend FFI::Library
+
+      begin
+        ffi_lib "libvirt.so.0"
+      rescue LoadError
+        raise Libvirt::Ruby::Exceptions::MissingLib
+      end
+
+      def self.klass
+        "virStorageVol"
       end
     end
   end

data/lib/libvirt-ruby/util.rb

@@ -0,0 +1,15 @@
+module Libvirt
+  module Ruby
+    module Util
+      def dispatcher(method, args = [])
+        begin
+          return_type = args.delete(args.last)
+          attach_function (self.klass + method.to_s), (self.klass + method.to_s), args, return_type
+          send((self.klass + method.to_s), args)
+        rescue FFI::NotFoundError
+          raise Libvirt::Ruby::Exceptions::InvalidFunction.new(self.klass + method.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/libvirt-ruby/version.rb

@@ -1,5 +1,5 @@
 module Libvirt
   module Ruby
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/libvirt-ruby.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "ffi"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "fakefs"
 end

data/spec/libvirt-ruby/connect_spec.rb

@@ -4,21 +4,29 @@ describe Libvirt::Ruby::Connect do
   let(:connect) { Libvirt::Ruby::Connect }
 
   context "when calling method #dispatcher" do
-    before :each do
-      connect.stub(:attach_function).with("virConnectClose", "virConnectClose", [], :int).and_return(true)
-      connect.stub(:send).with("virConnectClose", [])
-    end
+    context "with a valid libvirt function" do
+      before :each do
+        connect.stub(:attach_function).with("virConnectClose", "virConnectClose", [], :int).and_return(true)
+        connect.stub(:send).with("virConnectClose", [])
+      end
 
-    after :each do
-      connect.dispatcher('Close', [:int])
-    end
+      after :each do
+        connect.dispatcher('Close', [:int])
+      end
+
+      it "should attach it as a binding for C's function" do
+        connect.should_receive(:attach_function).with("virConnectClose", "virConnectClose", [], :int).and_return(true)
+      end
 
-    it "should attach it as a binding for C's function" do
-      connect.should_receive(:attach_function).with("virConnectClose", "virConnectClose", [], :int).and_return(true)
+      it "should call the new attached method" do
+        connect.should_receive(:send).with("virConnectClose", [])
+      end
     end
 
-    it "should call the new attached method" do
-      connect.should_receive(:send).with("virConnectClose", [])
+    context "with an invalid libvirt function" do
+      it "should return an invalid function message" do
+        lambda { connect.dispatcher('Abc', [:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+      end
     end
   end
 end

data/spec/libvirt-ruby/domain_spec.rb

@@ -4,21 +4,29 @@ describe Libvirt::Ruby::Domain do
   let(:domain) { Libvirt::Ruby::Domain }
 
   context "when calling method #dispatcher" do
-    before :each do
-      domain.stub(:attach_function).with("virDomainCreate", "virDomainCreate", [], :int).and_return(true)
-      domain.stub(:send).with("virDomainCreate", [])
-    end
+    context "with a valid libvirt function" do
+      before :each do
+        domain.stub(:attach_function).with("virDomainCreate", "virDomainCreate", [], :int).and_return(true)
+        domain.stub(:send).with("virDomainCreate", [])
+      end
 
-    after :each do
-      domain.dispatcher('Create', [:int])
-    end
+      after :each do
+        domain.dispatcher('Create', [:int])
+      end
+
+      it "should attach it as a binding for C's function" do
+        domain.should_receive(:attach_function).with("virDomainCreate", "virDomainCreate", [], :int).and_return(true)
+      end
 
-    it "should attach it as a binding for C's function" do
-      domain.should_receive(:attach_function).with("virDomainCreate", "virDomainCreate", [], :int).and_return(true)
+      it "should call the new attached method" do
+        domain.should_receive(:send).with("virDomainCreate", [])
+      end
     end
 
-    it "should call the new attached method" do
-      domain.should_receive(:send).with("virDomainCreate", [])
+    context "with an invalid libvirt function" do
+      it "should return an invalid function message" do
+        lambda { domain.dispatcher('Abc', [:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+      end
     end
   end
 end

data/spec/libvirt-ruby/network_spec.rb

@@ -4,21 +4,29 @@ describe Libvirt::Ruby::Network do
   let(:network) { Libvirt::Ruby::Network }
 
   context "when calling method #dispatcher" do
-    before :each do
-      network.stub(:attach_function).with("virNetworkRef", "virNetworkRef", [], :int).and_return(true)
-      network.stub(:send).with("virNetworkRef", [])
-    end
+    context "with a valid libvirt function" do
+      before :each do
+        network.stub(:attach_function).with("virNetworkRef", "virNetworkRef", [], :int).and_return(true)
+        network.stub(:send).with("virNetworkRef", [])
+      end
 
-    after :each do
-      network.dispatcher('Ref', [:int])
-    end
+      after :each do
+        network.dispatcher('Ref', [:int])
+      end
+
+      it "should attach it as a binding for C's function" do
+        network.should_receive(:attach_function).with("virNetworkRef", "virNetworkRef", [], :int).and_return(true)
+      end
 
-    it "should attach it as a binding for C's function" do
-      network.should_receive(:attach_function).with("virNetworkRef", "virNetworkRef", [], :int).and_return(true)
+      it "should call the new attached method" do
+        network.should_receive(:send).with("virNetworkRef", [])
+      end
     end
 
-    it "should call the new attached method" do
-      network.should_receive(:send).with("virNetworkRef", [])
+    context "with an invalid libvirt function" do
+      it "should return an invalid function message" do
+        lambda { network.dispatcher('Abc', [:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+      end
     end
   end
 end

data/spec/libvirt-ruby/storage_pool_spec.rb

@@ -4,21 +4,29 @@ describe Libvirt::Ruby::StoragePool do
   let(:storage_pool) { Libvirt::Ruby::StoragePool }
 
   context "when calling method #dispatcher" do
-    before :each do
-      storage_pool.stub(:attach_function).with("virStoragePoolRefresh", "virStoragePoolRefresh", [], :int).and_return(true)
-      storage_pool.stub(:send).with("virStoragePoolRefresh", [])
-    end
+    context "with a valid libvirt function" do
+      before :each do
+        storage_pool.stub(:attach_function).with("virStoragePoolRefresh", "virStoragePoolRefresh", [], :int).and_return(true)
+        storage_pool.stub(:send).with("virStoragePoolRefresh", [])
+      end
 
-    after :each do
-      storage_pool.dispatcher('Refresh', [:int])
-    end
+      after :each do
+        storage_pool.dispatcher('Refresh', [:int])
+      end
+
+      it "should attach it as a binding for C's function" do
+        storage_pool.should_receive(:attach_function).with("virStoragePoolRefresh", "virStoragePoolRefresh", [], :int).and_return(true)
+      end
 
-    it "should attach it as a binding for C's function" do
-      storage_pool.should_receive(:attach_function).with("virStoragePoolRefresh", "virStoragePoolRefresh", [], :int).and_return(true)
+      it "should call the new attached method" do
+        storage_pool.should_receive(:send).with("virStoragePoolRefresh", [])
+      end
     end
 
-    it "should call the new attached method" do
-      storage_pool.should_receive(:send).with("virStoragePoolRefresh", [])
+    context "with an invalid libvirt function" do
+      it "should return an invalid function message" do
+        lambda { storage_pool.dispatcher('Abc', [:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+      end
     end
   end
 end

data/spec/libvirt-ruby/storage_vol_spec.rb

@@ -4,21 +4,29 @@ describe Libvirt::Ruby::StorageVol do
   let(:storage_vol) { Libvirt::Ruby::StorageVol }
 
   context "when calling method #dispatcher" do
-    before :each do
-      storage_vol.stub(:attach_function).with("virStorageVolResize", "virStorageVolResize", [], :int).and_return(true)
-      storage_vol.stub(:send).with("virStorageVolResize", [])
-    end
+    context "with a valid libvirt function" do
+      before :each do
+        storage_vol.stub(:attach_function).with("virStorageVolResize", "virStorageVolResize", [], :int).and_return(true)
+        storage_vol.stub(:send).with("virStorageVolResize", [])
+      end
 
-    after :each do
-      storage_vol.dispatcher('Resize', [:int])
-    end
+      after :each do
+        storage_vol.dispatcher('Resize', [:int])
+      end
+
+      it "should attach it as a binding for C's function" do
+        storage_vol.should_receive(:attach_function).with("virStorageVolResize", "virStorageVolResize", [], :int).and_return(true)
+      end
 
-    it "should attach it as a binding for C's function" do
-      storage_vol.should_receive(:attach_function).with("virStorageVolResize", "virStorageVolResize", [], :int).and_return(true)
+      it "should call the new attached method" do
+        storage_vol.should_receive(:send).with("virStorageVolResize", [])
+      end
     end
 
-    it "should call the new attached method" do
-      storage_vol.should_receive(:send).with("virStorageVolResize", [])
+    context "with an invalid libvirt function" do
+      it "should return an invalid function message" do
+        lambda { storage_vol.dispatcher('Abc', [:int]) }.should raise_error(Libvirt::Ruby::Exceptions::InvalidFunction)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "rubygems"
 require "rspec"
+require "ffi"
 
-Dir.glob(File.dirname(__FILE__) + "/../lib/libvirt-ruby/**/*.rb").each { |file| require file }
+require File.dirname(__FILE__) + "/../lib/libvirt-ruby.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libvirt-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
+date: 2012-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &10883940 !ruby/object:Gem::Requirement
+  requirement: &12651960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10883940
+  version_requirements: *12651960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10898920 !ruby/object:Gem::Requirement
+  requirement: &12651440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10898920
+  version_requirements: *12651440
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10895140 !ruby/object:Gem::Requirement
+  requirement: &12650440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10895140
+  version_requirements: *12650440
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &12649920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12649920
 description: Access Libvirt's C Library through ruby classes and methods
 email: plribeiro3000@gmail.com
 executables: []
@@ -54,14 +65,19 @@ files:
 - .rspec
 - .rvmrc
 - Gemfile
+- LICENSE
 - README.rdoc
 - Rakefile
 - lib/libvirt-ruby.rb
 - lib/libvirt-ruby/connect.rb
 - lib/libvirt-ruby/domain.rb
+- lib/libvirt-ruby/exceptions.rb
+- lib/libvirt-ruby/exceptions/invalid_function.rb
+- lib/libvirt-ruby/exceptions/missing_lib.rb
 - lib/libvirt-ruby/network.rb
 - lib/libvirt-ruby/storage_pool.rb
 - lib/libvirt-ruby/storage_vol.rb
+- lib/libvirt-ruby/util.rb
 - lib/libvirt-ruby/version.rb
 - libvirt-ruby.gemspec
 - spec/libvirt-ruby/connect_spec.rb