druzy-upnp 1.0.0 → 2.0.0

data/lib/druzy/upnp/ssdp/listener.rb

@@ -1,36 +0,0 @@
-require_relative 'multicast_connection'
-
-
-class Druzy::Upnp::SSDP::Listener < Druzy::Upnp::SSDP::MulticastConnection
-
-  # @return [EventMachine::Channel] Provides subscribers with notifications
-  #   from devices that have come online (sent +ssdp:alive+ notifications).
-  attr_reader :alive_notifications
-
-  # @return [EventMachine::Channel] Provides subscribers with notifications
-  #   from devices that have gone offline (sent +ssd:byebye+ notifications).
-  attr_reader :byebye_notifications
-
-  # This is the callback called by EventMachine when it receives data on the
-  # socket that's been opened for this connection.  In this case, the method
-  # parses the SSDP notifications into Hashes and adds them to the
-  # appropriate EventMachine::Channel (provided as accessor methods).  This
-  # effectively means that in each Channel, you get a Hash that represents
-  # the headers for each notification that comes in on the socket.
-  #
-  # @param [String] response The data received on this connection's socket.
-  def receive_data(response)
-    ip, port = peer_info
-    parsed_response = parse(response)
-
-    return unless parsed_response.has_key? :nts
-
-    if parsed_response[:nts] == 'ssdp:alive'
-      @alive_notifications << parsed_response
-    elsif parsed_response[:nts] == 'ssdp:byebye'
-      @byebye_notifications << parsed_response
-    else
-      raise "Unknown NTS value: #{parsed_response[:nts]}"
-    end
-  end
-end

data/lib/druzy/upnp/ssdp/multicast_connection.rb

@@ -1,109 +0,0 @@
-require 'core_ext/socket_patch'
-require_relative 'network_constants'
-require_relative 'error'
-require 'ipaddr'
-require 'socket'
-require 'eventmachine'
-require 'em-synchrony'
-
-module Druzy
-  module Upnp
-    class SSDP
-      class MulticastConnection < EventMachine::Connection
-        include Druzy::Upnp::SSDP::NetworkConstants
-  
-        # @param [Fixnum] ttl The TTL value to use when opening the UDP socket
-        #   required for SSDP actions.
-        def initialize(ttl=TTL)
-          @ttl = ttl
-  
-          @discovery_responses = EM::Channel.new
-          @alive_notifications = EM::Channel.new
-          @byebye_notifications = EM::Channel.new
-  
-          setup_multicast_socket
-        end
-  
-        # Gets the IP and port from the peer that just sent data.
-        #
-        # @return [Array<String,Fixnum>] The IP and port.
-        def peer_info
-          peer_bytes = get_peername[2, 6].unpack('nC4')
-          port = peer_bytes.first.to_i
-          ip = peer_bytes[1, 4].join('.')
-  
-          [ip, port]
-        end
-  
-        # Converts the headers to a set of key-value pairs.
-        #
-        # @param [String] data The data to convert.
-        # @return [Hash] The converted data.  Returns an empty Hash if it didn't
-        #   know how to parse.
-        def parse(data)
-          new_data = {}
-  
-          unless data =~ /\n/
-            return new_data
-          end
-  
-          data.each_line do |line|
-            line =~ /(\S+):(.*)/
-  
-            unless $1.nil?
-              key = $1
-              value = $2
-              key = key.gsub('-', '_').downcase.to_sym
-              new_data[key] = value.strip
-            end
-          end
-  
-          new_data
-        end
-  
-        # Sets Socket options to allow for multicasting.  If ENV["RUBY_UPNP_ENV"] is
-        # equal to "testing", then it doesn't turn off multicast looping.
-        def setup_multicast_socket
-          set_membership(IPAddr.new(MULTICAST_IP).hton +
-            IPAddr.new('0.0.0.0').hton)
-          set_multicast_ttl(@ttl)
-          set_ttl(@ttl)
-  
-          unless ENV['RUBY_UPNP_ENV'] == 'testing'
-            switch_multicast_loop :off
-          end
-        end
-  
-        # @param [String] membership The network byte ordered String that represents
-        #   the IP(s) that should join the membership group.
-        def set_membership(membership)
-          set_sock_opt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, membership)
-        end
-  
-        # @param [Fixnum] ttl TTL to set IP_MULTICAST_TTL to.
-        def set_multicast_ttl(ttl)
-          set_sock_opt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL,
-            [ttl].pack('i'))
-        end
-  
-        # @param [Fixnum] ttl TTL to set IP_TTL to.
-        def set_ttl(ttl)
-          set_sock_opt(Socket::IPPROTO_IP, Socket::IP_TTL, [ttl].pack('i'))
-        end
-  
-        # @param [Symbol] on_off Turn on/off multicast looping.  Supply :on or :off.
-        def switch_multicast_loop(on_off)
-          hex_value = case on_off
-          when :on then "\001"
-          when "\001" then "\001"
-          when :off then "\000"
-          when "\000" then "\000"
-          else raise SSDP::Error, "Can't switch IP_MULTICAST_LOOP to '#{on_off}'"
-          end
-  
-          set_sock_opt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_LOOP, hex_value)
-        end
-      end
-    end
-  end
-end

data/lib/druzy/upnp/ssdp/network_constants.rb

@@ -1,19 +0,0 @@
-module Druzy
-  module Upnp
-    class SSDP
-      module NetworkConstants
-  
-        BROADCAST_IP = '255.255.255.255'
-  
-        # Default multicast IP address
-        MULTICAST_IP = '239.255.255.250'
-  
-        # Default multicast port
-        MULTICAST_PORT = 1900
-  
-        # Default TTL
-        TTL = 4
-      end
-    end
-  end
-end

data/lib/druzy/upnp/ssdp/notifier.rb

@@ -1,39 +0,0 @@
-require_relative 'multicast_connection'
-
-
-class Druzy::Upnp::SSDP::Notifier < Druzy::Upnp::SSDP::MulticastConnection
-
-  def initialize(nt, usn, ddf_url, valid_for_duration)
-    @os = RbConfig::CONFIG['host_vendor'].capitalize + '/' +
-      RbConfig::CONFIG['host_os']
-    @upnp_version = '1.0'
-    @notification = notification(nt, usn, ddf_url, valid_for_duration)
-  end
-
-  def post_init
-    if send_datagram(@notification, MULTICAST_IP, MULTICAST_PORT) > 0
-
-    end
-  end
-
-  # @param [String] nt "Notification Type"; a potential search target.  Used in
-  #   +NT+ header.
-  # @param [String] usn "Unique Service Name"; a composite identifier for the
-  #   advertisement.  Used in +USN+ header.
-  # @param [String] ddf_url Device Description File URL for the root device.
-  # @param [Fixnum] valid_for_duration Duration in seconds for which the
-  #   advertisement is valid.  Used in +CACHE-CONTROL+ header.
-  def notification(nt, usn, ddf_url, valid_for_duration)
-    <<-NOTIFICATION
-NOTIFY * HTTP/1.1\r
-HOST: #{MULTICAST_IP}:#{MULTICAST_PORT}\r
-CACHE-CONTROL: max-age=#{valid_for_duration}\r
-LOCATION: #{ddf_url}\r
-NT: #{nt}\r
-NTS: ssdp:alive\r
-SERVER: #{@os} UPnP/#{@upnp_version} Playful/#{Playful::VERSION}\r
-USN: #{usn}\r
-\r
-    NOTIFICATION
-  end
-end

data/lib/druzy/upnp/ssdp/searcher.rb

@@ -1,85 +0,0 @@
-require_relative 'multicast_connection'
-
-module Druzy
-  module Upnp
-  
-    # A subclass of an EventMachine::Connection, this handles doing M-SEARCHes.
-    #
-    # Search types:
-    #   ssdp:all
-    #   upnp:rootdevice
-    #   uuid:[device-uuid]
-    #   urn:schemas-upnp-org:device:[deviceType-version]
-    #   urn:schemas-upnp-org:service:[serviceType-version]
-    #   urn:[custom-schema]:device:[deviceType-version]
-    #   urn:[custom-schema]:service:[serviceType-version]
-    class SSDP::Searcher < SSDP::MulticastConnection
-  
-      DEFAULT_RESPONSE_WAIT_TIME = 5
-      DEFAULT_M_SEARCH_COUNT = 2
-  
-      # @return [EventMachine::Channel] Provides subscribers with responses from
-      #   their search request.
-      attr_reader :discovery_responses
-  
-      # @param [String] search_target
-      # @param [Hash] options
-      # @option options [Fixnum] response_wait_time
-      # @option options [Fixnum] ttl
-      # @option options [Fixnum] m_search_count The number of times to send the
-      #   M-SEARCH.  UPnP 1.0 suggests to send the request more than once.
-      def initialize(search_target, options = {})
-        options[:ttl] ||= TTL
-        options[:response_wait_time] ||= DEFAULT_RESPONSE_WAIT_TIME
-        @m_search_count = options[:m_search_count] ||= DEFAULT_M_SEARCH_COUNT
-  
-        @search = m_search(search_target, options[:response_wait_time])
-  
-        super options[:ttl]
-      end
-  
-      # This is the callback called by EventMachine when it receives data on the
-      # socket that's been opened for this connection.  In this case, the method
-      # parses the SSDP responses/notifications into Hashes and adds them to the
-      # appropriate EventMachine::Channel (provided as accessor methods).  This
-      # effectively means that in each Channel, you get a Hash that represents
-      # the headers for each response/notification that comes in on the socket.
-      #
-      # @param [String] response The data received on this connection's socket.
-      def receive_data(response)
-        ip, port = peer_info
-        parsed_response = parse(response)
-  
-        return if parsed_response.has_key? :nts
-        return if parsed_response[:man] &&
-          parsed_response[:man] =~ /ssdp:discover/
-  
-        @discovery_responses << parsed_response
-      end
-  
-      # Sends the M-SEARCH that was built during init.  Logs what was sent if the
-      # send was successful.
-      def post_init
-        @m_search_count.times do
-          send_datagram(@search, MULTICAST_IP, MULTICAST_PORT)
-          
-        end
-      end
-  
-      # Builds the M-SEARCH request string.
-      #
-      # @param [String] search_target
-      # @param [Fixnum] response_wait_time
-      def m_search(search_target, response_wait_time)
-        <<-MSEARCH
-M-SEARCH * HTTP/1.1\r
-HOST: #{MULTICAST_IP}:#{MULTICAST_PORT}\r
-MAN: "ssdp:discover"\r
-MX: #{response_wait_time}\r
-ST: #{search_target}\r
-\r
-        MSEARCH
-      end
-    end
-  end
-end

data/lib/rack/upnp_control_point.rb

@@ -1,70 +0,0 @@
-require 'rack'
-require 'druzy/upnp/control_point'
-
-module Rack
-
-  # Middleware that allows your Rack app to keep tabs on devices that the
-  # {Playful::ControlPoint} has found.  UPnP devices that match the +search_type+
-  # are discovered and added to the list, then removed as those devices send out
-  # +ssdp:byebye+ notifications.  All of this depends on +EventMachine::Channel+s,
-  # and thus requires that an EventMachine reactor is running.  If you don't
-  # have one running, the {Playful::ControlPoint} will start one for you.
-  #
-  # @example Control all root devices
-  #
-  #   Thin::Server.start('0.0.0.0', 3000) do
-  #     use Rack::UPnPControlPoint, search_type: :root
-  #
-  #     map "/devices" do
-  #       run lambda { |env|
-  #         devices = env['upnp.devices']
-  #         friendly_names = devices.map(&:friendly_name).join("\n")
-  #         [200, {'Content-Type' => 'text/plain'}, [friendly_names]]
-  #       }
-  #     end
-  #   end
-  #
-  class UPnPControlPoint
-
-    # @param [Rack::Builder] app Your Rack application.
-    # @param [Hash] options Options to pass to the Playful::SSDP::Searcher.
-    # @see Playful::SSDP::Searcher
-    def initialize(app, options = {})
-      @app = app
-      @devices = []
-      options[:search_type] ||= :root
-      EM.next_tick { start_control_point(options[:search_type], options) }
-    end
-
-    # Creates and starts the {Playful::ControlPoint}, then manages the list of
-    # devices using the +EventMachine::Channel+ objects yielded in.
-    #
-    # @param [Symbol,String] search_type The device(s) you want to search for
-    #   and control.
-    # @param [Hash] options Options to pass to the Playful::SSDP::Searcher.
-    # @see Playful::SSDP::Searcher
-    def start_control_point(search_type, options)
-      @cp = ::Playful::ControlPoint.new(search_type, options)
-
-      @cp.start do |new_device_channel, old_device_channel|
-        new_device_channel.subscribe do |notification|
-          @devices << notification
-        end
-
-        old_device_channel.subscribe do |old_device|
-          @devices.reject! { |d| d.usn == old_device[:usn] }
-        end
-      end
-
-    end
-
-    # Adds the whole list of devices to <tt>env['upnp.devices']</tt> so that
-    # that list can be accessed from within your app.
-    #
-    # @param [Hash] env The Rack environment.
-    def call(env)
-      env['upnp.devices'] = @devices
-      @app.call(env)
-    end
-  end
-end