frisky 0.1.0

data/lib/frisky/ssdp/network_constants.rb

@@ -0,0 +1,17 @@
+module Frisky
+  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

data/lib/frisky/ssdp/notifier.rb

@@ -0,0 +1,41 @@
+require_relative '../logger'
+require_relative 'multicast_connection'
+
+
+class Frisky::SSDP::Notifier < Frisky::SSDP::MulticastConnection
+  include LogSwitch
+
+  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
+      log "Sent notification:\n#{@notification}"
+    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} Frisky/#{Frisky::VERSION}\r
+USN: #{usn}\r
+\r
+    NOTIFICATION
+  end
+end

data/lib/frisky/ssdp/searcher.rb

@@ -0,0 +1,87 @@
+require_relative '../logger'
+require_relative 'multicast_connection'
+
+module Frisky
+
+  # 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
+    include LogSwitch
+
+    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
+      log "Response from #{ip}:#{port}:\n#{response}\n"
+      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
+        if send_datagram(@search, MULTICAST_IP, MULTICAST_PORT) > 0
+          log "Sent datagram search:\n#{@search}"
+        end
+      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

data/lib/frisky/version.rb

@@ -0,0 +1,3 @@
+module Frisky
+  VERSION = '0.1.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+
+SimpleCov.start
+
+require 'coveralls'
+Coveralls.wear!
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |file| require file }
+
+ENV['RUBY_UPNP_ENV'] = 'testing'
+
+RSpec.configure do |config|
+  #config.raise_errors_for_deprecations!
+end
+
+require_relative "../lib/frisky/logger"

data/spec/support/search_responses.rb

@@ -0,0 +1,134 @@
+SSDP_SEARCH_RESPONSES_PARSED = {
+  root_device1: {
+    cache_control: 'max-age=1200',
+    date: 'Mon, 26 Sep 2011 06:40:19 GMT',
+    location: 'http://192.168.10.3:5001/description/fetch',
+    server: 'Linux-i386-2.6.38-10-generic-pae, UPnP/1.0, PMS/1.25.1',
+    st: 'upnp:rootdevice',
+    ext: nil,
+    usn: 'uuid:3c202906-992d-3f0f-b94c-90e1902a136d::upnp:rootdevice',
+    content_length: 0
+  },
+  root_device2: {
+    cache_control: 'max-age=1200',
+    date: 'Mon, 26 Sep 2011 06:40:20 GMT',
+    location: 'http://192.168.10.4:5001/description/fetch',
+    server: 'Linux-i386-2.6.38-10-generic-pae, UPnP/1.0, PMS/1.25.1',
+    st: 'upnp:rootdevice',
+    ext: nil,
+    usn: 'uuid:3c202906-992d-3f0f-b94c-90e1902a136e::upnp:rootdevice',
+    content_length: 0
+  },
+  media_server: {
+    cache_control: 'max-age=1200',
+    date: 'Mon, 26 Sep 2011 06:40:21 GMT',
+    location: 'http://192.168.10.3:5001/description/fetch',
+    server: 'Linux-i386-2.6.38-10-generic-pae, UPnP/1.0, PMS/1.25.1',
+    st: 'urn:schemas-upnp-org:device:MediaServer:1',
+    ext: nil,
+    usn: 'uuid:3c202906-992d-3f0f-b94c-90e1902a136d::urn:schemas-upnp-org:device:MediaServer:1',
+    content_length: 0
+  }
+}
+
+SSDP_DESCRIPTIONS = {
+  root_device1: {
+    'root' => {
+      'specVersion' => {
+        'major' => '1',
+        'minor' => '0'
+      },
+      'URLBase' => 'http://192.168.10.3:5001/',
+      'device' => {
+        'dlna:X_DLNADOC' => %w[DMS-1.50 M-DMS-1.50],
+        'deviceType' => 'urn:schemas-upnp-org:device:MediaServer:1',
+        'friendlyName' => 'PS3 Media Server [gutenberg]',
+        'manufacturer' => 'PMS',
+        'manufacturerURL' => 'http://ps3mediaserver.blogspot.com',
+        'modelDescription' => 'UPnP/AV 1.0 Compliant Media Server',
+        'modelName' => 'PMS',
+        'modelNumber' => '01',
+        'modelURL' => 'http://ps3mediaserver.blogspot.com',
+        'serialNumber' => nil,
+        'UPC' => nil,
+        'UDN' => 'uuid:3c202906-992d-3f0f-b94c-90e1902a136d',
+        'iconList' => {
+          'icon' => {
+            'mimetype' => 'image/jpeg',
+            'width' => '120',
+            'height' => '120',
+            'depth' => '24',
+            'url' => '/images/icon-256.png'
+          }
+        },
+        'presentationURL' => 'http://192.168.10.3:5001/console/index.html',
+        'serviceList' => {
+          'service' => [
+            {
+              'serviceType' => 'urn:schemas-upnp-org:service:ContentDirectory:1',
+              'serviceId' => 'urn:upnp-org:serviceId:ContentDirectory',
+              'SCPDURL' => '/UPnP_AV_ContentDirectory_1.0.xml',
+              'controlURL' => '/upnp/control/content_directory',
+              'eventSubURL' => '/upnp/event/content_directory'
+            },
+              {
+                'serviceType' => 'urn:schemas-upnp-org:service:ConnectionManager:1',
+                'serviceId' => 'urn:upnp-org:serviceId:ConnectionManager',
+                'SCPDURL' => '/UPnP_AV_ConnectionManager_1.0.xml',
+                'controlURL' => '/upnp/control/connection_manager',
+                'eventSubURL' => '/upnp/event/connection_manager'
+              }
+          ]
+        }
+      },
+      '@xmlns:dlna' => 'urn:schemas-dlna-org:device-1-0',
+      '@xmlns' => 'urn:schemas-upnp-org:device-1-0'
+    }
+  }
+}
+
+ROOT_DEVICE1 = <<-RD
+HTTP/1.1 200 OK
+CACHE-CONTROL: max-age=1200
+DATE: Mon, 26 Sep 2011 06:40:19 GMT
+LOCATION: http://1.2.3.4:5678/description/fetch
+SERVER: Linux-i386-2.6.38-10-generic-pae, UPnP/1.0, PMS/1.25.1
+ST: upnp:rootdevice
+EXT:
+USN: uuid:3c202906-992d-3f0f-b94c-90e1902a136d::upnp:rootdevice
+Content-Length: 0
+
+RD
+
+ROOT_DEVICE2 = <<-RD
+HTTP/1.1 200 OK
+CACHE-CONTROL: max-age=1200
+DATE: Mon, 26 Sep 2011 06:40:20 GMT
+LOCATION: http://1.2.3.4:5678/description/fetch
+SERVER: Linux-i386-2.6.38-10-generic-pae, UPnP/1.0, PMS/1.25.1
+ST: upnp:rootdevice
+EXT:
+USN: uuid:3c202906-992d-3f0f-b94c-90e1902a136e::upnp:rootdevice
+Content-Length: 0
+
+RD
+
+MEDIA_SERVER = <<-MD
+HTTP/1.1 200 OK
+CACHE-CONTROL: max-age=1200
+DATE: Mon, 26 Sep 2011 06:40:21 GMT
+LOCATION: http://1.2.3.4:5678/description/fetch
+SERVER: Linux-i386-2.6.38-10-generic-pae, UPnP/1.0, PMS/1.25.1
+ST: urn:schemas-upnp-org:device:MediaServer:1
+EXT:
+USN: uuid:3c202906-992d-3f0f-b94c-90e1902a136d::urn:schemas-upnp-org:device:MediaServer:
+Content-Length: 0
+
+MD
+
+RESPONSES = {
+  root_device1: ROOT_DEVICE1,
+  root_device2: ROOT_DEVICE2,
+  media_server: MEDIA_SERVER
+}
+

data/spec/unit/core_ext/to_upnp_s_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'core_ext/to_upnp_s'
+
+
+describe Hash do
+  describe '#to_upnp_s' do
+    context ':uuid as key' do
+      it "returns a String like 'uuid:[Hash value]'" do
+        expect({ uuid: '12345' }.to_upnp_s).to eq 'uuid:12345'
+      end
+
+      it "doesn't check if the Hash value is legit" do
+        expect({ uuid: '' }.to_upnp_s).to eq 'uuid:'
+      end
+    end
+
+    context ':device_type as key' do
+      context 'domain name not given' do
+        it "returns a String like 'urn:schemas-upnp-org:device:[device type]'" do
+          expect({ device_type: '12345' }.to_upnp_s).
+            to eq 'urn:schemas-upnp-org:device:12345'
+        end
+
+        it "doesn't check if the Hash value is legit" do
+          expect({ device_type: '' }.to_upnp_s).to eq 'urn:schemas-upnp-org:device:'
+        end
+      end
+
+      context 'domain name given' do
+        it "returns a String like 'urn:[domain name]:device:[device type]'" do
+          expect({ device_type: '12345', domain_name: 'my-domain' }.to_upnp_s).
+            to eq 'urn:my-domain:device:12345'
+        end
+
+        it "doesn't check if the Hash value is legit" do
+          expect({ device_type: '', domain_name: 'stuff' }.to_upnp_s).
+            to eq 'urn:stuff:device:'
+        end
+      end
+    end
+
+    context ':service_type as key' do
+      context 'domain name not given' do
+        it "returns a String like 'urn:schemas-upnp-org:service:[service type]'" do
+          expect({ service_type: '12345' }.to_upnp_s).
+            to eq 'urn:schemas-upnp-org:service:12345'
+        end
+
+        it "doesn't check if the Hash value is legit" do
+          expect({ service_type: '' }.to_upnp_s).to eq 'urn:schemas-upnp-org:service:'
+        end
+      end
+
+      context 'domain name given' do
+        it "returns a String like 'urn:[domain name]:service:[service type]'" do
+          expect({ service_type: '12345', domain_name: 'my-domain' }.to_upnp_s).
+            to eq 'urn:my-domain:service:12345'
+        end
+
+        it "doesn't check if the Hash value is legit" do
+          expect({ service_type: '', domain_name: 'my-domain' }.to_upnp_s).
+            to eq 'urn:my-domain:service:'
+        end
+      end
+    end
+
+    context 'some other Hash key' do
+      context 'domain name not given' do
+        it 'returns self.to_s' do
+          expect({ firestorm: 12345 }.to_upnp_s).to eq '{:firestorm=>12345}'
+        end
+      end
+    end
+  end
+end
+
+describe Symbol do
+  context ':all' do
+    describe '#to_upnp_s' do
+      it "returns 'ssdp:all'" do
+        expect(:all.to_upnp_s).to eq 'ssdp:all'
+      end
+    end
+  end
+
+  context ':root' do
+    describe '#to_upnp_s' do
+      it "returns 'upnp:rootdevice'" do
+        expect(:root.to_upnp_s).to eq 'upnp:rootdevice'
+      end
+    end
+  end
+
+  it "returns itself if one of the defined shortcuts wasn't given" do
+    expect(:firestorm.to_upnp_s).to eq :firestorm
+  end
+end
+
+describe String do
+  it 'returns itself' do
+    expect('Stuff and things'.to_upnp_s).to eq 'Stuff and things'
+  end
+end
+
+

data/spec/unit/frisky/ssdp/listener_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'frisky/ssdp/listener'
+
+
+describe Frisky::SSDP::Listener do
+  around(:each) do |example|
+    EM.synchrony do
+      example.run
+      EM.stop
+    end
+  end
+
+  before do
+    allow_any_instance_of(Frisky::SSDP::Listener).to receive(:setup_multicast_socket)
+  end
+
+  subject { Frisky::SSDP::Listener.new(1) }
+
+  describe '#receive_data' do
+    it 'logs the IP and port from which the request came from' do
+      expect(subject).to receive(:peer_info).and_return %w[ip port]
+      expect(subject).to receive(:log).
+        with("Response from ip:port:\nmessage\n")
+      allow(subject).to receive(:parse).and_return({})
+
+      subject.receive_data('message')
+    end
+  end
+end

data/spec/unit/frisky/ssdp/multicast_connection_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+require 'frisky/ssdp/multicast_connection'
+
+
+describe Frisky::SSDP::MulticastConnection do
+  around(:each) do |example|
+    EM.synchrony do
+      example.run
+      EM.stop
+    end
+  end
+
+  subject { Frisky::SSDP::MulticastConnection.new(1) }
+
+  before do
+    Frisky.logging_enabled = false
+  end
+
+  describe '#peer_info' do
+    before do
+      allow_any_instance_of(Frisky::SSDP::MulticastConnection).to receive(:setup_multicast_socket)
+      subject.stub_chain(:get_peername, :[], :unpack).
+          and_return(%w[1234 1 2 3 4])
+    end
+
+    it 'returns an Array with IP and port' do
+      expect(subject.peer_info).to eq ['1.2.3.4', 1234]
+    end
+
+    it 'returns IP as a String' do
+      expect(subject.peer_info.first).to be_a String
+    end
+
+    it 'returns port as a Fixnum' do
+      expect(subject.peer_info.last).to be_a Fixnum
+    end
+  end
+
+  describe '#parse' do
+    before do
+      allow_any_instance_of(Frisky::SSDP::MulticastConnection).to receive(:setup_multicast_socket)
+    end
+
+    it 'turns headers into Hash keys' do
+      result = subject.parse ROOT_DEVICE1
+      expect(result).to have_key :cache_control
+      expect(result).to have_key :date
+      expect(result).to have_key :location
+      expect(result).to have_key :server
+      expect(result).to have_key :st
+      expect(result).to have_key :ext
+      expect(result).to have_key :usn
+      expect(result).to have_key :content_length
+    end
+
+    it 'turns header values into Hash values' do
+      result = subject.parse ROOT_DEVICE1
+      expect(result[:cache_control]).to eq 'max-age=1200'
+      expect(result[:date]).to eq 'Mon, 26 Sep 2011 06:40:19 GMT'
+      expect(result[:location]).to eq 'http://1.2.3.4:5678/description/fetch'
+      expect(result[:server]).to eq 'Linux-i386-2.6.38-10-generic-pae, UPnP/1.0, PMS/1.25.1'
+      expect(result[:st]).to eq 'upnp:rootdevice'
+      expect(result[:ext]).to be_empty
+      expect(result[:usn]).to eq 'uuid:3c202906-992d-3f0f-b94c-90e1902a136d::upnp:rootdevice'
+      expect(result[:content_length]).to eq '0'
+    end
+
+    context 'single line String as response data' do
+      before { @data = ROOT_DEVICE1.gsub("\n", ' ') }
+
+      it 'returns an empty Hash' do
+        expect(subject.parse(@data)).to eq({ })
+      end
+
+      it "logs the 'bad' response" do
+        subject.should_receive(:log).twice
+        subject.parse @data
+      end
+    end
+  end
+
+  describe '#setup_multicast_socket' do
+    before do
+      allow_any_instance_of(Frisky::SSDP::MulticastConnection).to receive(:set_membership)
+      allow_any_instance_of(Frisky::SSDP::MulticastConnection).to receive(:switch_multicast_loop)
+      allow_any_instance_of(Frisky::SSDP::MulticastConnection).to receive(:set_multicast_ttl)
+      allow_any_instance_of(Frisky::SSDP::MulticastConnection).to receive(:set_ttl)
+    end
+
+    it 'adds 0.0.0.0 and 239.255.255.250 to the membership group' do
+      expect(subject).to receive(:set_membership).with(
+        IPAddr.new('239.255.255.250').hton + IPAddr.new('0.0.0.0').hton
+      )
+      subject.setup_multicast_socket
+    end
+
+    it 'sets multicast TTL to 4' do
+      expect(subject).to receive(:set_multicast_ttl).with(4)
+      subject.setup_multicast_socket
+    end
+
+    it 'sets TTL to 4' do
+      expect(subject).to receive(:set_ttl).with(4)
+      subject.setup_multicast_socket
+    end
+
+    context "ENV['RUBY_UPNP_ENV'] != testing" do
+      after { ENV['RUBY_UPNP_ENV'] = 'testing' }
+
+      it 'turns multicast loop off' do
+        ENV['RUBY_UPNP_ENV'] = 'development'
+        expect(subject).to receive(:switch_multicast_loop).with(:off)
+        subject.setup_multicast_socket
+      end
+    end
+  end
+
+  describe '#switch_multicast_loop' do
+    before do
+      allow_any_instance_of(Frisky::SSDP::MulticastConnection).to receive(:setup_multicast_socket)
+    end
+
+    it "passes '\\001' to the socket option call when param == :on" do
+      expect(subject).to receive(:set_sock_opt).with(
+        Socket::IPPROTO_IP, Socket::IP_MULTICAST_LOOP, "\001"
+      )
+      subject.switch_multicast_loop :on
+    end
+
+    it "passes '\\001' to the socket option call when param == '\\001'" do
+      expect(subject).to receive(:set_sock_opt).with(
+       Socket::IPPROTO_IP, Socket::IP_MULTICAST_LOOP, "\001"
+      )
+      subject.switch_multicast_loop "\001"
+    end
+
+    it "passes '\\000' to the socket option call when param == :off" do
+      expect(subject).to receive(:set_sock_opt).with(
+        Socket::IPPROTO_IP, Socket::IP_MULTICAST_LOOP, "\000"
+      )
+      subject.switch_multicast_loop :off
+    end
+
+    it "passes '\\000' to the socket option call when param == '\\000'" do
+      expect(subject).to receive(:set_sock_opt).with(
+        Socket::IPPROTO_IP, Socket::IP_MULTICAST_LOOP, "\000"
+      )
+      subject.switch_multicast_loop "\000"
+    end
+
+    it "raises when not :on, :off, '\\000', or '\\001'" do
+      expect { subject.switch_multicast_loop 12312312 }.
+        to raise_error(Frisky::SSDP::Error)
+    end
+  end
+end
+