druzy-upnp 1.0.0 → 2.0.0

data/lib/core_ext/socket_patch.rb

@@ -1,16 +0,0 @@
-require 'socket'
-
-# Workaround for missing constants on Windows
-module Socket::Constants
-  IP_ADD_MEMBERSHIP = 12 unless defined? IP_ADD_MEMBERSHIP
-  IP_MULTICAST_LOOP = 11 unless defined? IP_MULTICAST_LOOP
-  IP_MULTICAST_TTL  = 10 unless defined? IP_MULTICAST_TTL
-  IP_TTL            =  4 unless defined? IP_TTL
-end
-
-class Socket
-  IP_ADD_MEMBERSHIP = 12 unless defined? IP_ADD_MEMBERSHIP
-  IP_MULTICAST_LOOP = 11 unless defined? IP_MULTICAST_LOOP
-  IP_MULTICAST_TTL  = 10 unless defined? IP_MULTICAST_TTL
-  IP_TTL            =  4 unless defined? IP_TTL
-end

data/lib/core_ext/to_upnp_s.rb

@@ -1,65 +0,0 @@
-class Hash
-
-  # Converts Hash search targets to SSDP search target String.  Conversions are
-  # as follows:
-  #   uuid: "someUUID"                 # => "uuid:someUUID"
-  #   device_type: "someDeviceType:1"    # => "urn:schemas-upnp-org:device:someDeviceType:1"
-  #   service_type: "someServiceType:2"  # => "urn:schemas-upnp-org:service:someServiceType:2"
-  #
-  # You can use custom UPnP domain names too:
-  #   { device_type: "someDeviceType:3",
-  #   domain_name: "mydomain-com" }    # => "urn:my-domain:device:someDeviceType:3"
-  #   { service_type: "someServiceType:4",
-  #   domain_name: "mydomain-com" }    # => "urn:my-domain:service:someDeviceType:4"
-  #
-  # @return [String] The converted String, according to the UPnP spec.
-  def to_upnp_s
-    if self.has_key? :uuid
-      return "uuid:#{self[:uuid]}"
-    elsif self.has_key? :device_type
-      if self.has_key? :domain_name
-        return "urn:#{self[:domain_name]}:device:#{self[:device_type]}"
-      else
-        return "urn:schemas-upnp-org:device:#{self[:device_type]}"
-      end
-    elsif self.has_key? :service_type
-      if self.has_key? :domain_name
-        return "urn:#{self[:domain_name]}:service:#{self[:service_type]}"
-      else
-        return "urn:schemas-upnp-org:service:#{self[:service_type]}"
-      end
-    else
-      self.to_s
-    end
-  end
-end
-
-
-class Symbol
-
-  # Converts Symbol search targets to SSDP search target String.  Conversions are
-  # as follows:
-  #   :all    # => "ssdp:all"
-  #   :root   # => "upnp:rootdevice"
-  #   "root"  # => "upnp:rootdevice"
-  #
-  # @return [String] The converted String, according to the UPnP spec.
-  def to_upnp_s
-    if self == :all
-      'ssdp:all'
-    elsif self == :root
-      'upnp:rootdevice'
-    else
-      self
-    end
-  end
-end
-
-
-class String
-  # This doesn't do anything to the string; just allows users to call the
-  # method without having to check type first.
-  def to_upnp_s
-    self
-  end
-end

data/lib/druzy/upnp/control_point/base.rb

@@ -1,70 +0,0 @@
-require 'nori'
-require 'em-http-request'
-require_relative 'error'
-require_relative '../../upnp'
-
-module Druzy
-  module Upnp
-    class ControlPoint
-      class Base
-  
-        protected
-  
-        def get_description(location, description_getter)
-          http = EM::HttpRequest.new(location).aget
-  
-          t = EM::Timer.new(30) do
-            http.fail(:timeout)
-          end
-  
-          http.errback do |error|
-            if error == :timeout
-              http = EM::HttpRequest.new(location).get
-            else
-              description_getter.set_deferred_status(:failed)
-  
-              if ControlPoint.raise_on_remote_error
-                raise ControlPoint::Error, "Unable to retrieve DDF from #{location}"
-              end
-            end
-          end
-  
-          http.callback {
-            if http.response_header.status != 200
-              description_getter.set_deferred_status(:failed)
-            else
-              response = xml_parser.parse(http.response)
-              description_getter.set_deferred_status(:succeeded, response)
-            end
-          }
-        end
-  
-        def build_url(url_base, rest_of_url)
-          if url_base.end_with?('/') && rest_of_url.start_with?('/')
-            rest_of_url.sub!('/', '')
-          end
-  
-          url_base + rest_of_url
-        end
-  
-        # @return [Nori::Parser]
-        def xml_parser
-          @xml_parser if @xml_parser
-  
-          options = {
-            convert_tags_to: lambda { |tag| tag.to_sym }
-          }
-  
-          begin
-            require 'nokogiri'
-            options.merge! parser: :nokogiri
-          rescue LoadError
-            warn "Tried loading nokogiri for XML couldn't.  This is OK, just letting you know."
-          end
-  
-          @xml_parser = Nori.new(options)
-        end
-      end
-    end
-  end
-end

data/lib/druzy/upnp/control_point/device.rb

@@ -1,465 +0,0 @@
-require_relative 'base'
-require_relative 'service'
-require_relative 'error'
-require 'uri'
-require 'eventmachine'
-require 'time'
-
-module Druzy
-  module Upnp
-    class ControlPoint
-      class Device < Base
-        include EM::Deferrable
-  
-        attr_reader :ssdp_notification
-  
-        #vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
-        # Passed in as part of +device_info+; given by the SSDP search response.
-        #
-        attr_reader :cache_control
-        attr_reader :date
-        attr_reader :ext
-        attr_reader :location
-        attr_reader :server
-        attr_reader :st
-        attr_reader :usn
-        #
-        # DONE +device_info+
-        #^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-  
-        # @return [Hash] The whole parsed description... just in case.
-        attr_reader :description
-  
-        attr_reader :expiration
-  
-        #vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
-        # Determined by device description file.
-        #
-  
-        #------- <root> elements -------
-  
-        # @return [String] The xmlns attribute of the device from the description file.
-        attr_reader :xmlns
-  
-        # @return [Hash] :major and :minor revisions of the UPnP spec this device adheres to.
-        attr_reader :spec_version
-  
-        # @return [String] URLBase from the device's description file.
-        attr_reader :url_base
-  
-        #------- <root><device> elements -------
-  
-        # @return [String] The type of UPnP device (URN) from the description file.
-        attr_reader :device_type
-  
-        # @return [String] Short device description for the end user.
-        attr_reader :friendly_name
-  
-        # @return [String] Manufacturer's name.
-        attr_reader :manufacturer
-  
-        # @return [String] Manufacturer's web site.
-        attr_reader :manufacturer_url
-  
-        # @return [String] Long model description for the end user, from the description file.
-        attr_reader :model_description
-  
-        # @return [String] Model name of this device from the description file.
-        attr_reader :model_name
-  
-        # @return [String] Model number of this device from the description file.
-        attr_reader :model_number
-  
-        # @return [String] Web site for model of this device.
-        attr_reader :model_url
-  
-        # @return [String] The serial number from the description file.
-        attr_reader :serial_number
-  
-        # @return [String] The UDN for the device, from the description file.
-        attr_reader :udn
-  
-        # @return [String] The UPC of the device from the description file.
-        attr_reader :upc
-  
-        # @return [Array<Hash>] An Array where each element is a Hash that describes an icon.
-        attr_reader :icon_list
-  
-        # Services provided directly by this device.
-        attr_reader :service_list
-  
-        # Devices embedded directly into this device.
-        attr_reader :device_list
-  
-        # @return [String] URL for device control via a browser.
-        attr_reader :presentation_url
-  
-        #
-        # DONE description file
-        #^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-  
-        # @param [Hash] device_info
-        # @option device_info [Hash] ssdp_notification
-        # @option device_info [Hash] device_description
-        # @option device_info [Hash] parent_base_url
-        def initialize(device_info)
-          super()
-  
-          @device_info = device_info
-          @device_list = []
-          @service_list = []
-          @icon_list = []
-          @xmlns = ''
-          @done_creating_devices = false
-          @done_creating_services = false
-        end
-  
-        def fetch
-          description_getter = EventMachine::DefaultDeferrable.new
-  
-          description_getter.errback do
-            msg = 'Failed getting description.'
-            @done_creating_devices = true
-            @done_creating_services = true
-            set_deferred_status(:failed, msg)
-  
-            if ControlPoint.raise_on_remote_error
-              raise ControlPoint::Error, msg
-            end
-          end
-  
-          if @device_info.has_key? :ssdp_notification
-            extract_from_ssdp_notification(description_getter)
-          elsif @device_info.has_key? :device_description
-            description_getter.set_deferred_success @device_info[:device_description]
-          else
-            description_getter.set_deferred_failure
-          end
-  
-          description_getter.callback do |description|
-            @description = description
-  
-            if @description.nil?
-              set_deferred_status(:failed, 'Got back an empty description...')
-              return
-            end
-  
-            extract_spec_version
-  
-            @url_base = extract_url_base
-  
-            if @device_info[:ssdp_notification]
-              @xmlns = @description[:root][:@xmlns]
-              extract_description(@description[:root][:device])
-            elsif @device_info.has_key? :device_description
-              extract_description(@description)
-            end
-          end
-  
-          tickloop = EM.tick_loop do
-            if @done_creating_devices && @done_creating_services
-              :stop
-            end
-          end
-  
-          tickloop.on_stop { set_deferred_status :succeeded, self }
-        end
-  
-        def extract_from_ssdp_notification(callback)
-          @ssdp_notification = @device_info[:ssdp_notification]
-  
-          @cache_control = @ssdp_notification[:cache_control]
-          @location = ssdp_notification[:location]
-          @server = ssdp_notification[:server]
-          @st = ssdp_notification[:st] || ssdp_notification[:nt]
-          @ext = ssdp_notification.has_key?(:ext) ? true : false
-          @usn = ssdp_notification[:usn]
-          @date = ssdp_notification[:date] || ''
-          @expiration = if @date.empty?
-            Time.now + @cache_control.match(/\d+/)[0].to_i
-          else
-            Time.at(Time.parse(@date).to_i + @cache_control.match(/\d+/)[0].to_i)
-          end
-  
-          if @location
-            get_description(@location, callback)
-          else
-            message = 'M-SEARCH response is either missing the Location header or has an empty value.'
-            message << "Response: #{@ssdp_notification}"
-  
-            if ControlPoint.raise_on_remote_error
-              raise ControlPoint::Error, message
-            end
-          end
-        end
-  
-        def extract_url_base
-          if @description[:root] && @description[:root][:URLBase]
-            @description[:root][:URLBase]
-          elsif @device_info[:parent_base_url]
-            @device_info[:parent_base_url]
-          else
-            tmp_uri = URI(@location)
-            "#{tmp_uri.scheme}://#{tmp_uri.host}:#{tmp_uri.port}/"
-          end
-        end
-  
-        # True if the device hasn't received an alive notification since it last
-        # told its max age.
-        def expired?
-          Time.now > @expiration if @expiration
-        end
-  
-        def has_devices?
-          !@device_list.empty?
-        end
-  
-        def has_services?
-          !@service_list.empty?
-        end
-  
-        def extract_description(ddf)
-  
-          @device_type = ddf[:deviceType] || ''
-          @friendly_name = ddf[:friendlyName] || ''
-          @manufacturer = ddf[:manufacturer] || ''
-          @manufacturer_url = ddf[:manufacturerURL] || ''
-          @model_description = ddf[:modelDescription] || ''
-          @model_name = ddf[:modelName] || ''
-          @model_number = ddf[:modelNumber] || ''
-          @model_url = ddf[:modelURL] || ''
-          @serial_number = ddf[:serialNumber] || ''
-          @udn = ddf[:UDN] || ''
-          @upc = ddf[:UPC] || ''
-          @icon_list = extract_icons(ddf[:iconList])
-          @presentation_url = ddf[:presentationURL] || ''
-  
-          start_device_extraction
-          start_service_extraction
-        end
-  
-        def extract_spec_version
-          if @description[:root]
-            "#{@description[:root][:specVersion][:major]}.#{@description[:root][:specVersion][:minor]}"
-          end
-        end
-  
-        def start_service_extraction
-          services_extractor = EventMachine::DefaultDeferrable.new
-  
-          if @description[:serviceList]
-            extract_services(@description[:serviceList], services_extractor)
-          elsif @description[:root][:device][:serviceList]
-            extract_services(@description[:root][:device][:serviceList], services_extractor)
-          end
-  
-          services_extractor.errback do
-            msg = 'Failed extracting services.'
-            @done_creating_services = true
-  
-            if ControlPoint.raise_on_remote_error
-              raise ControlPoint::Error, msg
-            end
-          end
-  
-          services_extractor.callback do |services|
-            @service_list = services
-  
-            @done_creating_services = true
-          end
-        end
-  
-        def start_device_extraction
-          device_extractor = EventMachine::DefaultDeferrable.new
-          extract_devices(device_extractor)
-  
-          device_extractor.errback do
-            msg = 'Failed extracting device.'
-            @done_creating_devices = true
-  
-            if ControlPoint.raise_on_remote_error
-              raise ControlPoint::Error, msg
-            end
-          end
-  
-          device_extractor.callback do |device|
-            if device
-              @device_list << device
-            end
-  
-            @done_creating_devices = true
-          end
-        end
-  
-        # @return [Array<Hash>]
-        def extract_icons(ddf_icon_list)
-          return [] unless ddf_icon_list
-  
-          if ddf_icon_list[:icon].is_a? Array
-            ddf_icon_list[:icon].map do |values|
-              values[:url] = build_url(@url_base, values[:url])
-              values
-            end
-          else
-            [{
-              mimetype: ddf_icon_list[:icon][:mimetype],
-              width: ddf_icon_list[:icon][:width],
-              height: ddf_icon_list[:icon][:height],
-              depth: ddf_icon_list[:icon][:depth],
-              url: build_url(@url_base, ddf_icon_list[:icon][:url])
-            }]
-          end
-        end
-  
-        def extract_devices(group_device_extractor)
-  
-          device_list_hash = if @description.has_key? :root
-  
-            if @description[:root][:device][:deviceList]
-              @description[:root][:device][:deviceList][:device]
-            else
-              group_device_extractor.set_deferred_status(:succeeded)
-            end
-          elsif @description[:deviceList]
-            @description[:deviceList][:device]
-          else
-            group_device_extractor.set_deferred_status(:succeeded)
-          end
-  
-          if device_list_hash.nil? || device_list_hash.empty?
-            group_device_extractor.set_deferred_status(:succeeded)
-            return
-          end
-  
-          if device_list_hash.is_a? Array
-            EM::Iterator.new(device_list_hash, device_list_hash.count).map(
-              proc do |device, iter|
-                single_device_extractor = EventMachine::DefaultDeferrable.new
-  
-                single_device_extractor.errback do
-                  msg = 'Failed extracting device.'
-  
-                  if ControlPoint.raise_on_remote_error
-                    raise ControlPoint::Error, msg
-                  end
-                end
-  
-                single_device_extractor.callback do |d|
-                  iter.return(d)
-                end
-  
-                extract_device(device, single_device_extractor)
-              end,
-              proc do |found_devices|
-                group_device_extractor.set_deferred_status(:succeeded, found_devices)
-              end
-            )
-          else
-            single_device_extractor = EventMachine::DefaultDeferrable.new
-  
-            single_device_extractor.errback do
-              msg = 'Failed extracting device.'
-              group_device_extractor.set_deferred_status(:failed, msg)
-  
-              if ControlPoint.raise_on_remote_error
-                raise ControlPoint::Error, msg
-              end
-            end
-  
-            single_device_extractor.callback do |device|
-              group_device_extractor.set_deferred_status(:succeeded, [device])
-            end
-  
-            extract_device(device_list_hash, group_device_extractor)
-          end
-        end
-  
-        def extract_device(device, device_extractor)
-          deferred_device = Device.new(device_description: device, parent_base_url: @url_base)
-  
-          deferred_device.errback do
-            msg = "Couldn't build device!"
-            device_extractor.set_deferred_status(:failed, msg)
-  
-            if ControlPoint.raise_on_remote_error
-              raise ControlPoint::Error, msg
-            end
-          end
-  
-          deferred_device.callback do |built_device|
-            device_extractor.set_deferred_status(:succeeded, built_device)
-          end
-  
-          deferred_device.fetch
-        end
-  
-        def extract_services(service_list, group_service_extractor)
-          return if service_list.nil?
-  
-          service_list.each_value do |service|
-            if service.is_a? Array
-              EM::Iterator.new(service, service.count).map(
-                proc do |s, iter|
-                  single_service_extractor = EventMachine::DefaultDeferrable.new
-  
-                  single_service_extractor.errback do
-                    msg = 'Failed to create service.'
-  
-                    if ControlPoint.raise_on_remote_error
-                      raise ControlPoint::Error, msg
-                    end
-                  end
-  
-                  single_service_extractor.callback do |serv|
-                    iter.return(serv)
-                  end
-  
-                  extract_service(s, single_service_extractor)
-                end,
-                proc do |found_services|
-                  group_service_extractor.set_deferred_status(:succeeded, found_services)
-                end
-              )
-            else
-              single_service_extractor = EventMachine::DefaultDeferrable.new
-  
-              single_service_extractor.errback do
-                msg = 'Failed to create service.'
-                group_service_extractor.set_deferred_status :failed, msg
-  
-                if ControlPoint.raise_on_remote_error
-                  raise ControlPoint::Error, msg
-                end
-              end
-  
-              single_service_extractor.callback do |s|
-                group_service_extractor.set_deferred_status :succeeded, [s]
-              end
-  
-              extract_service(service, single_service_extractor)
-            end
-          end
-        end
-  
-        def extract_service(service, single_service_extractor)
-          service_getter = Service.new(@url_base, service)
-  
-          service_getter.errback do |message|
-            msg = "Couldn't build service with info: #{service}"
-            single_service_extractor.set_deferred_status(:failed, msg)
-  
-            if ControlPoint.raise_on_remote_error
-              raise ControlPoint::Error, message
-            end
-          end
-  
-          service_getter.callback do |built_service|
-            single_service_extractor.set_deferred_status(:succeeded, built_service)
-          end
-  
-          service_getter.fetch
-        end
-      end
-    end
-  end
-end

data/lib/druzy/upnp/control_point/error.rb

@@ -1,15 +0,0 @@
-module Druzy
-  module Upnp
-    class ControlPoint
-      class Error < StandardError
-        #
-      end
-  
-      # Indicates an error occurred when performing a UPnP action while controlling
-      # a device.  See section 3.2 of the UPnP spec.
-      class ActionError < StandardError
-        #
-      end
-    end
-  end
-end