rbupnptools 0.1.0

data/lib/upnp_event.rb

@@ -0,0 +1,86 @@
+require 'nokogiri'
+require 'net/http'
+require_relative 'upnp_xml.rb'
+
+class NotifyRequest < Net::HTTPRequest
+  METHOD = 'NOTIFY'
+  REQUEST_HAS_BODY = true
+  RESPONSE_HAS_BODY = false
+end
+
+class SubscribeRequest < Net::HTTPRequest
+  METHOD = 'SUBSCRIBE'
+  REQUEST_HAS_BODY = false
+  RESPONSE_HAS_BODY = false
+end
+
+class UnsubscribeRequest < Net::HTTPRequest
+  METHOD = 'UNSUBSCRIBE'
+  REQUEST_HAS_BODY = false
+  RESPONSE_HAS_BODY = false
+end
+
+class UPnPEventProperty < Hash
+  def to_xml
+    propertyset = XmlTag.new 'e:propertyset'
+    propertyset.attributes = {
+      'xmlns:e' => "urn:schemas-upnp-org:event-1-0"
+    }
+    self.each do |k,v|
+      prop = propertyset.append XmlTag.new 'e:property'
+      prop.append(XmlTag.new(k)).append(XmlText.new(v))
+    end
+    return propertyset.to_s
+  end
+end
+
+def UPnPEventProperty.to_xml_doc(property)
+  return '<?xml version="1.0" encoding="UTF-8"?>' + "\n#{property.to_xml}"
+end
+
+def UPnPEventProperty.read(xml)
+  props = UPnPEventProperty.new
+  doc = Nokogiri::XML(xml)
+  doc.root.elements.each do |elem|
+    if elem.name == 'property'
+      name = elem.elements.first.name
+      value = elem.elements.first.text
+      props[name] = value
+    end
+  end
+  props
+end
+
+class UPnPEventListener
+  def initialize(on_event_notify = nil)
+    @on_event_notify = on_event_notify
+  end
+
+  def on_event_notify(sid, props)
+    if @on_event_notify
+      @on_event_notify.call sid, props
+    end
+  end
+end
+
+class UPnPEventSubscription
+  def initialize(device, service, sid, timeout, callback_urls = nil)
+    @device = device
+    @service = service
+    @sid = sid
+    @timeout = timeout
+    @reg_date = Process.clock_gettime(Process::CLOCK_MONOTONIC, :second)
+    @callback_urls = callback_urls
+  end
+
+  attr_accessor :device, :service, :sid, :timeout, :callback_urls
+
+  def renew_timeout
+    @reg_date = Process.clock_gettime(Process::CLOCK_MONOTONIC, :second)
+  end
+
+  def expired?
+    now = Process.clock_gettime(Process::CLOCK_MONOTONIC, :second)
+    return (now - @reg_date) >= @tiemout
+  end
+end

data/lib/upnp_model.rb

@@ -0,0 +1,419 @@
+require 'nokogiri'
+require 'securerandom'
+require_relative 'upnp_xml.rb'
+
+
+class UPnPModel < Hash
+  def self.to_method_name(name)
+    return name.gsub(/([a-z])([A-Z]+)/, '\1_\2').downcase
+  end
+  
+  def self.define_xml_attr(*names)
+    names.each do |name|
+      name = "#{name}"
+      define_method "#{to_method_name(name)}" do
+        self[name]
+      end
+      define_method "#{to_method_name(name)}=" do |v|
+        self[name] = v
+      end
+    end
+  end
+end
+
+class UPnPSpecVersion
+
+  attr_accessor :major, :minor
+
+  def to_s
+    "UPnPSpecVersion -- 'major: #{@major}, minor: #{minor}'"
+  end
+
+  def to_xml
+    spec_version = XmlTag.new('specVersion')
+    spec_version.append(XmlTag.new('major')).append(XmlText.new(@major))
+    spec_version.append(XmlTag.new('minor')).append(XmlText.new(@minor))
+    return spec_version.to_s
+  end
+  
+end
+
+def UPnPSpecVersion.read_xml_node(node)
+  spec_version = UPnPSpecVersion.new
+  node.elements.each { |elem|
+    if elem.name == 'major'
+      spec_version.major = elem.text
+    elsif elem.name == 'minor'
+      spec_version.minor = elem.text
+    end
+  }
+  return spec_version
+end
+
+
+class UPnPDevice < UPnPModel
+  def initialize
+    @child_devices = []
+    @services = []
+  end
+
+  attr_accessor :base_url
+  attr_accessor :child_devices
+  attr_accessor :services
+
+  define_xml_attr :deviceType, :UDN, :friendlyName, :manufacturer, :manufacturerURL,
+                  :modelDescription, :modelName, :modelNumber, :modelURL, :serialNumber
+
+  def usn
+    return udn + '::' + device_type
+  end
+  
+  def all_usn
+    usn_list = []
+    usn_list << usn
+    @services.each do |service|
+      usn_list << udn + '::' + service.service_type
+    end
+    @child_devices.each do |device|
+      usn_list += device.all_usn
+    end
+    return usn_list
+  end
+
+  def get_device(type)
+    all_devices.each do |device|
+      if device.device_type == type
+        return device
+      end
+    end
+    nil
+  end
+
+  def get_service(type)
+    all_services.each do |service|
+      if service.service_type == type
+        return service
+      end
+    end
+    nil
+  end
+
+  def all_devices
+    devices = []
+    devices << self
+    @child_devices.each do |device|
+      devices += device.all_devices
+    end
+    return devices
+  end
+
+  def all_services
+    services = @services
+    @child_devices.each do |device|
+      services += device.all_services
+    end
+    return services
+  end
+
+  def to_s
+    "UPnPDevice -- '#{friendly_name}' (#{udn})"
+  end
+
+  def to_xml
+    device = XmlTag.new 'device'
+    self.each { |k,v|
+      device.append(XmlTag.new(k)).append(XmlText.new(v))
+    }
+
+    if @services.any?
+      serviceList = device.append XmlTag.new('serviceList')
+      @services.each { |service|
+        serviceList.append service.to_xml
+      }
+    end
+    
+    if @child_devices.any?
+      deviceList = device.append XmlTag.new('deviceList')
+      @child_devices.each { |device|
+        deviceList.append device.to_xml
+      }
+    end
+    return device.to_s
+  end
+end
+
+def UPnPDevice.to_xml_doc(device)
+  root = XmlTag.new 'root'
+  root.attributes['xmlns'] = 'urn:schemas-upnp-org:device-1-0'
+
+  specVersion = root.append(XmlTag.new('specVersion'))
+  specVersion.append(XmlTag.new('major')).append(XmlText.new(1))
+  specVersion.append(XmlTag.new('major')).append(XmlText.new(0))
+  
+  root.append device.to_xml
+  return '<?xml version="1.0" encoding="UTF-8"?>' + "\n#{root}"
+end
+
+def UPnPDevice.read(xml)
+  doc = Nokogiri::XML(xml)
+  doc.root.elements.each do |elem|
+    if elem.name == 'specVersion'
+      spec_version = UPnPSpecVersion.read_xml_node elem
+    elsif elem.name == 'device'
+      return UPnPDevice.read_xml_node elem
+    end
+  end
+  nil
+end
+
+def UPnPDevice.read_xml_node(node)
+  device = UPnPDevice.new 
+  node.elements.each do |elem|
+    if elem.elements.empty?
+      device[elem.name] = elem.text
+    elsif elem.name == 'deviceList'
+      elem.elements.each do |device_node|
+        if device_node.name == 'device'
+          device.child_devices << UPnPDevice.read_xml_node(device_node)
+        end
+      end
+    elsif elem.name == 'serviceList'
+      elem.elements.each do |service_node|
+        if service_node.name == 'service'
+          device.services << UPnPService.read_xml_node(service_node)
+        end
+      end
+    end
+  end
+  device
+end
+
+
+class UPnPService < UPnPModel 
+  attr_accessor :scpd
+
+  define_xml_attr :serviceId, :serviceType, :SCPDURL, :controlURL, :eventSubURL
+
+  def to_xml
+    service = XmlTag.new 'service'
+    self.each { |k,v|
+      service.append(XmlTag.new(k)).append(XmlText.new(v))
+    }
+    return service.to_s
+  end
+end
+
+def UPnPService.read_xml_node(node)
+  service = UPnPService.new
+  node.elements.each do |elem|
+    if elem.elements.empty?
+      service[elem.name] = elem.text
+    end
+  end
+  service
+end
+
+
+class UPnPScpd < UPnPModel
+
+  def initialize
+    @actions = []
+    @state_variables = []
+  end
+  
+  attr_accessor :spec_version, :actions, :state_variables
+
+  def to_xml
+    scpd = XmlTag.new 'scpd'
+    scpd.attributes['xmlns'] = 'urn:schemas-upnp-org:service-1-0'
+    
+    spec_version = scpd.append XmlTag.new('specVersion')
+    spec_version.append(XmlTag.new('major')).append(XmlText.new(1))
+    spec_version.append(XmlTag.new('minor')).append(XmlText.new(0))
+
+    action_list = scpd.append XmlTag.new('actionList')
+    @actions.each { |action|
+      action_list.append action.to_xml
+    }
+
+    service_state_table = scpd.append XmlTag.new('serviceStateTable');
+    @state_variables.each { |state_variable|
+      service_state_table.append state_variable.to_xml
+    }
+    return scpd.to_s
+    
+  end
+end
+
+def UPnPScpd.to_xml_doc(scpd)
+  return '<?xml version="1.0" encoding="UTF-8"?>' + "\n#{scpd.to_xml}"
+end
+
+def UPnPScpd.read(xml)
+  scpd = UPnPScpd.new
+  doc = Nokogiri::XML(xml)
+  doc.root.elements.each do |elem|
+    case elem.name
+    when 'specVersion'
+      scpd.spec_version = [1,0]
+    when 'actionList'
+      elem.elements.each { |action_node|
+        if action_node.name == 'action'
+          action = UPnPAction.read_xml_node(action_node)
+          scpd.actions << action
+        end
+      }
+    when 'serviceStateTable'
+      elem.elements.each { |state_variable_node|
+        if state_variable_node.name == 'stateVariable'
+          state_variable = UPnPStateVariable.read_xml_node(state_variable_node)
+          scpd.state_variables << state_variable
+        end
+      }
+    end
+  end
+  return scpd
+end
+
+
+class UPnPAction < UPnPModel
+  def initialize
+    @arguments = []
+  end
+
+  attr_accessor :name
+  attr_accessor :arguments
+
+  def get_argument(name)
+    @arguments.each { |argument|
+      if argument.name == name
+        return argument
+      end
+    }
+    nil
+  end
+
+  def in_arguments
+    @arguments.select { |argument| argument.direction == 'in' }
+  end
+
+  def out_arguments
+    @arguments.select { |argument| argument.direction == 'out' }
+  end
+
+  def to_s
+    "UPnPAction -- #{@name}"
+  end
+
+  def to_xml
+    action = XmlTag.new 'action'
+    
+    prop = action.append XmlTag.new 'name'
+    prop.append XmlText.new @name
+
+    argument_list = action.append XmlTag.new 'argumentList'
+    @arguments.each { |argument|
+      argument_list.append argument.to_xml
+    }
+
+    return action.to_s
+  end
+end
+
+def UPnPAction.read_xml_node(node)
+  action = UPnPAction.new
+  node.elements.each do |elem|
+    if elem.name == 'name'
+      action.name = elem.text
+    elsif elem.name == 'argumentList'
+      elem.elements.each { |argument_node|
+        if argument_node.name == 'argument'
+          action.arguments << UPnPActionArgument.read_xml_node(argument_node)
+        end
+      }
+    end
+  end
+  return action
+end
+
+
+class UPnPActionArgument < UPnPModel
+  attr_accessor :name, :direction, :related_state_variable
+
+  def to_s
+    "UPnPActionArgument -- #{@name} (direction: '#{@direction}' related state variable: '#{@related_state_variable}')"
+  end
+
+  def to_xml
+    argument = XmlTag.new 'argument'
+
+    prop = argument.append XmlTag.new 'name'
+    prop.append XmlText.new @name
+
+    prop = argument.append XmlTag.new 'direction'
+    prop.append XmlText.new @direction
+
+    prop = argument.append XmlTag.new 'relatedStateVariable'
+    prop.append XmlText.new @related_state_variable
+
+    return argument.to_s
+  end
+end
+
+def UPnPActionArgument.read_xml_node(node)
+  argument = UPnPActionArgument.new
+  node.elements.each do |elem|
+    case elem.name
+    when 'name'
+      argument.name = elem.text
+    when 'direction'
+      argument.direction = elem.text
+    when 'relatedStateVariable'
+      argument.related_state_variable = elem.text
+    end
+  end
+  return argument
+end
+
+
+class UPnPStateVariable < UPnPModel
+  attr_accessor :name, :data_type, :send_events, :multicast
+
+  def to_s
+    "State Variable -- #{@name} (data type: '#{@data_type}' send events? '#{@send_events}' multicast? '#{@multicast}')"
+  end
+
+  def to_xml
+    state_variable = XmlTag.new 'stateVariable'
+    if @send_events != nil
+      state_variable.attributes['sendEvents'] = @send_events
+    end
+
+    if @multicast != nil
+      state_variable.attributes['multicast'] = @multicast
+    end
+    
+    prop = state_variable.append XmlTag.new 'name'
+    prop.append XmlText.new @name
+
+    prop = state_variable.append XmlTag.new 'dataType'
+    prop.append XmlText.new @data_type
+    
+    return state_variable.to_s
+  end
+end
+
+def UPnPStateVariable.read_xml_node(node)
+  state_variable = UPnPStateVariable.new
+  state_variable.send_events = node.attribute('sendEvents')
+  state_variable.multicast = node.attribute('multicast')
+  node.elements.each do |elem|
+    case elem.name
+    when 'name'
+      state_variable.name = elem.text
+    when 'dataType'
+      state_variable.data_type = elem.text
+    end
+  end
+  return state_variable
+end