networkmanager-dbus 0.0.1 → 0.1.0

data/Guardfile

@@ -2,5 +2,9 @@
 # More info at https://github.com/guard/guard#readme
 
 guard 'shell' do
-  watch(%r{^*.(rb|yml|file)$}) { `rake spec:remote` }
+  watch(%r{^*.(rb|yml|file)$}) do
+    #`rake spec:remote`
+    ENV['RSPEC_FORMAT'] = 'growl'
+    `rspec`
+  end
 end

data/README.md

@@ -1,7 +1,18 @@
+THIS IS ALPHA STUFF :)
+
+see [TODOs](TODO.md)
+
+[![Travis-CI Build Status](https://secure.travis-ci.org/dpree/networkmanager-dbus.png)](https://secure.travis-ci.org/dpree/networkmanager-dbus)
+
 # NetworkManager-Ruby
 
 This library provides a Ruby API to NetworkManager using its DBus Interface.
 
+Written using the NetworkManager DBus API Documentation v0.9
+
+  * [General API](http://projects.gnome.org/NetworkManager/developers/api/09/spec.html)
+  * [Details](http://projects.gnome.org/NetworkManager/developers/api/09/ref-settings.html)
+
 ## Installation
 
 Please make sure that you have `dbus` and `networkmanager` installed on the machine
@@ -22,7 +33,7 @@ please have a look at the `examples` folder and the `specs`.
 
 Development currently happens from my OSX machine where no dbus/networkmanager
 is running. Therefore, i hacked some scripts together to be able to run rspec
-over the wire
+over the wire.
 
 On the remote-machine (linux, dbus, networkmanager)
 
@@ -32,6 +43,13 @@ On the local-machine (osx)
 
     `guard`
 
+# Thanks
+
+to the guys from IRC channel #nm at irc.freenode.net
+
+   * dbcw
+   * jklimes
+
 # License
 
-Please see file `MIT-LICENSE`. Copyright 2011 Jens Bissinger.
+Copyright 2011 Jens Bissinger. All rights reserved. [MIT-LICENSE](MIT-LICENSE)

data/Rakefile

@@ -1,5 +1,8 @@
 require "bundler/gem_tasks"
 
+require 'bundler'
+Bundler.require :development
+
 def pump_dumps(dumps)
   dumps.each do |obj|
     case obj['action']
@@ -40,7 +43,7 @@ namespace :spec do
   desc 'run specs on a remote server (script/spec_server)'
   task :remote do
     begin
-      client = MarilynRPC::NativeClient.connect_tcp('192.168.56.101', 8483)
+      client = ::MarilynRPC::NativeClient.connect_tcp('192.168.56.101', 8483)
       runner = client.for :rspec
       json = runner.run
       begin
@@ -63,3 +66,12 @@ namespace :spec do
   end
 end
 
+require 'rspec/core/rake_task'
+desc 'Default: run specs.'
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+task :default => :spec
+

data/TODO.md

@@ -1,9 +1,9 @@
 # TODOs
 
 * more specs :)
-* make the specs run without actual dbus connection
- * mock networkmanager dbus api
- * maybe travisci
+* cleanup specs
+ * better mocking
+ * refactor integration specs
 * add missing interfaces
  * different device types
  * vpn

data/examples/change_ip.rb

@@ -0,0 +1,17 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), '../lib/network_manager')
+
+# the first setting (hopefully a eth0 default foo)
+con = NetworkManager::DBus::Settings.connections.first
+
+# new ip4 config
+# ip + netmask + gateway
+ip4 = NetworkManager::Ip4Config.from_dot_notation '192.168.10.100', '255.255.255.0', '192.168.10.1'
+
+# change the settings obj
+con.ip4_manual = ip4
+
+# take minor important device no.2 :)
+dev = NetworkManager.devices[1]
+
+# apply the settings obj to the dev
+NetworkManager::DBus::Root.activate_connection con, dev

data/examples/connectivity.rb

@@ -3,5 +3,5 @@ require File.join(File.expand_path(File.dirname(__FILE__)), '../lib/network_mana
 puts "Internet Connection: #{NetworkManager.internet_connection? ? 'yes' : 'no'}"
 
 puts "States are described as NM_STATE_... in NetworkManager::DBus::Root"
-puts "State is == #{NetworkManager::DBus::Root.instance.object.state}"
+puts "State is == #{NetworkManager::DBus::Root.instance.call('state'}"
  

data/lib/dbus_interface.rb

@@ -1,21 +1,30 @@
 module DBusInterface
+  class UnavailableError < StandardError; end
+  
+  class Configuration
+    attr_accessor :interface
+  end
+
   require 'dbus'
+  require File.join(File.dirname(__FILE__), 'dbus_interface/connection')
   require File.join(File.dirname(__FILE__), 'dbus_interface/class')
   require File.join(File.dirname(__FILE__), 'dbus_interface/object')
   
   def self.system_bus
     ::DBus::SystemBus.instance
+  rescue Errno::ENOENT => e
+    raise UnavailableError.new "DBus SystemBus not available! (#{e})"
   end
   
   def self.service
-    @@service
+    @@service ||= system_bus.service config.interface
   end
   
-  def self.service=(s)
-    @@service = system_bus.service s
+  def self.configure(&block)
+    yield config
   end
   
-  def self.configure(&block)
-    yield self
+  def self.config
+    @@config ||= Configuration.new
   end
 end

data/lib/dbus_interface/class.rb

@@ -2,14 +2,22 @@ module DBusInterface::Class
   def map_dbus(conf)
     @dbus ||= begin
       # ensure hash
-      raise ArgumentError.new "adapt_dbus must receive a hash instead of"\
+      raise ArgumentError.new "map_dbus must receive a Hash instead of "\
                               "#{conf.class}" unless conf.is_a? Hash
       # ensure :default_iface is set
-      raise ArgumentError.new "adapt_dbus must specify at least :default_iface"\
+      raise ArgumentError.new "map_dbus must specify at least :default_iface"\
                               unless conf.has_key? :default_iface
       conf
     end
   end
+  
+  def no_properties!
+    @no_properties = true
+  end
+  
+  def no_properties?
+    defined?(@no_properties) && @no_properties ? true : false
+  end
 
   def default_iface
     dbus[:default_iface]
@@ -23,10 +31,26 @@ module DBusInterface::Class
   def instance
     @instance ||= new
   end
-
+  
+  def property(name, type = :string)
+    underscored = underscore(name)
+    define_method underscored do self[name] end
+    if type == :boolean
+      define_method "#{underscored}?" do self[name] ? true : false end
+    end
+  end
+    
 private
 
   def dbus
     @dbus
   end
-end
+  
+  def underscore(camel_cased_word)
+    camel_cased_word.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+   end
+end

data/lib/dbus_interface/connection.rb

@@ -0,0 +1,58 @@
+class DBusInterface::Connection
+  attr_reader :default_iface, :object_path
+  
+  def initialize(default_iface, object_path)
+    @default_iface = default_iface
+    @object_path = object_path
+  end
+  
+  def self.clear!
+    connections.clear
+  end
+  
+  def self.connections
+    @@connections ||= {}
+  end
+  
+  def self.add_connection(con)
+    @@connections[con.key] = con
+  end
+  
+  def self.instance_for(default_iface, object_path)
+    con_key = connection_key(default_iface, object_path)
+    if connections[con_key]
+      connections[con_key]
+    else
+      new_con = new(default_iface, object_path)
+      add_connection(new_con)
+    end
+  end
+  
+  def self.connection_key(default_iface, object_path)
+    [default_iface,object_path].join
+  end
+  
+  def key
+    self.class.connection_key(default_iface, object_path)
+  end
+  
+  def self.call(default_iface, object_path, method, *args)
+    con = instance_for(default_iface, object_path)
+    con.call(method, *args)
+  end
+  
+  def call(method, *args)
+    dbus.send(method, *args)
+  end
+
+private
+  
+  def dbus
+    @dbus ||= begin
+      d = DBusInterface.service.object(object_path)
+      d.default_iface = default_iface
+      d.introspect
+      d
+    end
+  end
+end

data/lib/dbus_interface/object.rb

@@ -3,17 +3,20 @@ module DBusInterface::Object
     some_base.extend(DBusInterface::Class)
   end
   
-  def object
-    @object ||= begin
-      object = DBusInterface.service.object(object_path)
-      object.default_iface = self.class.default_iface
-      object.introspect
-      object
+  def call(method, *args)
+    if object_path == nil || object_path == '/'
+      nil
+    else
+      DBusInterface::Connection.call(self.class.default_iface, object_path, method, *args)
     end
   end
   
   def properties
-    object.all_properties
+    if self.class.no_properties?
+      nil
+    else
+      call('all_properties')
+    end
   end
   
   def initialize(object_path = nil)
@@ -32,4 +35,9 @@ module DBusInterface::Object
   def [](key)
     properties[key]
   end
+  
+  def to_s
+    "#{self.class} #{properties}"
+  end
+
 end

data/lib/network_manager.rb

@@ -1,5 +1,6 @@
 # This Library provides an API based on the specs for network manager dbus api
 # found here: http://projects.gnome.org/NetworkManager/developers/api/09/spec.html
+require 'ipaddress'
 module NetworkManager  
   # generic dbus api
   require File.join(File.dirname(__FILE__), 'dbus_interface')
@@ -8,7 +9,7 @@ module NetworkManager
   require File.join(File.dirname(__FILE__), 'network_manager/version')
   
   # helper
-  require File.join(File.dirname(__FILE__), 'network_manager/ip4_helper')
+  require File.join(File.dirname(__FILE__), 'network_manager/ip4_config')
   
   # network manager dbus api
   require File.join(File.dirname(__FILE__), 'network_manager/dbus')
@@ -23,6 +24,6 @@ module NetworkManager
   end
   
   DBusInterface.configure do |config|
-    config.service = 'org.freedesktop.NetworkManager'
+    config.interface = 'org.freedesktop.NetworkManager'
   end
 end

data/lib/network_manager/dbus.rb

@@ -1,4 +1,6 @@
 module NetworkManager::DBus
+  NULL_OBJECT = '/'
+  
   # require all .rb files from lib/network_manager/dbus
   Dir.glob(File.join(File.dirname(__FILE__), "dbus/*.rb")).each do |p|
     require p

data/lib/network_manager/dbus/device.rb

@@ -24,26 +24,28 @@ class NetworkManager::DBus::Device
   # or LTE standards to access a cellular or wireline data network.
   NM_DEVICE_TYPE_MODEM     = 8
   
-  def to_s
-    "#{self.class} #{properties}"
-  end
-  
   def ip4_address
     @ip_addr ||= begin
       ip4_int = self['Ip4Address']
-      NetworkManager::Ip4Helper.ip4_integer_to_dot_decimal ip4_int
+      i = NetworkManager::Ip4Config.from_nm_au ip4_int
+      i.address
     end
   end
   
   # @return [NetworkManager::DBus::Ip4Config] conf
   def ip4_config
-    @ip4_config ||= NetworkManager::DBus::Ip4Config.new properties['Ip4Config']
+    @ip4_config ||= NetworkManager::DBus::Ip4Config.new self['Ip4Config']
+  end
+  
+  # @return [NetworkManager::DBus::Ip4Config] conf
+  def dhcp4_config
+    @dhcp4_config ||= NetworkManager::DBus::Dhcp4Config.new self['Dhcp4Config']
   end
   
   # @return [NetworkManager::DBus::ActiveConnection] con
   def active_connection
     @active_connection ||=
-      NetworkManager::DBus::ActiveConnection.new properties['ActiveConnection']
+      NetworkManager::DBus::ActiveConnection.new self['ActiveConnection']
   end
   
   #

data/lib/network_manager/dbus/root.rb

@@ -2,7 +2,7 @@ class NetworkManager::DBus::Root
   include DBusInterface::Object
   map_dbus :default_iface => 'org.freedesktop.NetworkManager',
            :object_path => '/org/freedesktop/NetworkManager'
-
+  
   # Networking state is unknown.
   NM_STATE_UNKNOWN          = 0
   # Networking is inactive and all devices are disabled.
@@ -22,20 +22,24 @@ class NetworkManager::DBus::Root
   
   # @return [Array<NetworkManager::DBus::Device>]] devices
   def self.devices
-    instance.object.GetDevices.map do |list|
+    instance.call('GetDevices').map do |list|
       list.map do |object_path|
         new_device(object_path)
       end
     end.flatten
   end
   
+  def self.activate_connection(con, dev, optional = NetworkManager::DBus::NULL_OBJECT)
+    instance.call('ActivateConnection', con.object_path, dev.object_path, optional)
+  end
+  
   def self.device_by_interface(interface)
-    paths = instance.object.GetDeviceByIpIface(interface)
+    paths = instance.call('GetDeviceByIpIface', interface)
     paths.empty? ? nil : new_device(paths.first)
   end
   
   def self.internet_connection?
-    instance.object.state.first == NM_STATE_CONNECTED_GLOBAL
+    instance.call('state').first == NM_STATE_CONNECTED_GLOBAL
   end
 
 private

data/lib/network_manager/dbus/settings.rb

@@ -3,19 +3,32 @@ class NetworkManager::DBus::Settings
   map_dbus :default_iface => 'org.freedesktop.NetworkManager.Settings',
              :object_path => '/org/freedesktop/NetworkManager/Settings'
   
+  # TODO methods
+  # GetConnectionByUuid
+  
+  # TODO signals
+  # PropertiesChanged
+  
+  property 'Hostname'
+  property 'CanModify', :boolean
+  
   def self.connections
-    instance.object.ListConnections.map do |list|
+    instance.connections
+  end
+  
+  def connections
+    call('ListConnections').map do |list|
       list.map do |object_path|
         ::NetworkManager::DBus::SettingsConnection.new(object_path)
       end
     end.flatten
   end
   
-  def hostname=(new_name)
-    object.SaveHostname(new_name)
+  def add_connection(connection_hash)
+    call('AddConnection', connection_hash)
   end
   
-  def hostname
-    properties['Hostname']
+  def hostname=(new_name)
+    call('SaveHostname', new_name)
   end
 end