simple_upnp 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+doc
+*.gem
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_upnp.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    simple_upnp (0.0.1)
+      nori (~> 1.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    nori (1.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  simple_upnp!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dennis Kuczynski
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# simple_upnp
+
+A few libraries already exist for working with Universal Plug and Play (UPnP) devices.
+
+This library tries to provide a minimal implementation for discovery with a small amount of code and library dependencies.
+
+For more info on uPnP, see:
+http://www.upnp-hacks.org/upnp.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_upnp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_upnp
+
+## Usage
+
+The below code (which can be triggered with the included rake task: "rake simple_upnp:discover"):
+```
+include_location_details = true
+devices = SimpleUpnp::Discovery.search()
+devices.each do |device|
+  puts 'Device Found: '
+  puts device.to_json(include_location_details)
+  puts ''
+end
+```
+
+Should produce output similar to the following:
+```
+Searching for devices...
+Device Found: 
+{:st=>"upnp:rootdevice", :server=>"Darwin 11.4.2 CyberLinkC/2.3 UPnP/1.0 DLNADOC/1.50", :usn=>"uuid:7DD8D98F-6577-582D-AF37-38B92EB830A4", :location=>"http://10.10.10.3:38400/description.xml", "root"=>{"specVersion"=>{"major"=>"1", "minor"=>"0"}, "device"=>{"deviceType"=>"urn:dmc-samsung-com:device:SyncServer:1", "friendlyName"=>"Adam’s MacBook Pro", "manufacturer"=>"Samsung-Electronics", "manufacturerURL"=>"http://www.samsung.com", "modelDescription"=>"Kies Sync Server", "modelName"=>"Kies Sync Server", "modelNumber"=>"1.0", "modelURL"=>"http://www.samsung.com", "UDN"=>"uuid:7DD8D98F-6577-582D-AF37-38B92EB830A4", "serviceList"=>{"service"=>{"serviceType"=>"urn:dmc-samsung-com:service:SyncManager:1", "serviceId"=>"urn:dmc-samsung-com:serviceId:SyncManager", "controlURL"=>"/KiesControll", "eventSubURL"=>"/KiesEventSub", "SCPDURL"=>"/KiesService_SCPD.xml"}}}, "URLBase"=>"http://10.10.10.3:38400", "@xmlns"=>"urn:schemas-upnp-org:device-1-0"}}
+
+Device Found: 
+{:st=>"upnp:rootdevice", :server=>"FreeRTOS/6.0.5, UPnP/1.0, IpBridge/0.1", :usn=>"uuid:2f402f80-da50-11e1-9b23-001788092b7e", :location=>"http://10.10.10.104:80/description.xml", "root"=>{"specVersion"=>{"major"=>"1", "minor"=>"0"}, "URLBase"=>"http://10.10.10.104:80/", "device"=>{"deviceType"=>"urn:schemas-upnp-org:device:Basic:1", "friendlyName"=>"Philips hue (10.10.10.104)", "manufacturer"=>"Royal Philips Electronics", "manufacturerURL"=>"http://www.philips.com", "modelDescription"=>"Philips hue Personal Wireless Lighting", "modelName"=>"Philips hue bridge 2012", "modelNumber"=>"929000242503", "modelURL"=>"http://www.meethue.com", "serialNumber"=>"001788542b7e", "UDN"=>"uuid:2f402f80-da50-11e1-9b23-001788092b7e", "serviceList"=>{"service"=>{"serviceType"=>"(null)", "serviceId"=>"(null)", "controlURL"=>"(null)", "eventSubURL"=>"(null)", "SCPDURL"=>"(null)"}}, "presentationURL"=>"index.html", "iconList"=>{"icon"=>[{"mimetype"=>"image/png", "height"=>"48", "width"=>"48", "depth"=>"24", "url"=>"hue_logo_0.png"}, {"mimetype"=>"image/png", "height"=>"120", "width"=>"120", "depth"=>"24", "url"=>"hue_logo_3.png"}]}}, "@xmlns"=>"urn:schemas-upnp-org:device-1-0"}}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+$LOAD_PATH.unshift File.expand_path("#{File.dirname(__FILE__)}/lib")
+require 'simple_upnp'
+
+namespace :simple_upnp do
+  task :discover do
+    puts "Searching for devices...\n"
+    include_location_details = true
+    devices = SimpleUpnp::Discovery.search()
+    devices.each do |device|
+      puts 'Device Found: '
+      puts device.to_json(include_location_details)
+      puts ''
+    end
+  end
+end

data/lib/simple_upnp/device.rb

@@ -0,0 +1,54 @@
+require 'net/http'
+
+module SimpleUpnp
+  class Device
+
+    attr_reader :st, :server, :usn, :location
+
+    def initialize(message)
+      lines = message.split(/\r?\n/)
+      lines.each do |line|
+        if line =~ /^ST:/i
+          @st = parse_token(line.split(': '))
+        elsif line =~ /^SERVER:/i
+          @server = parse_token(line.split(': '))
+        elsif line =~ /^USN:/i
+          @usn = parse_token(line.split(': '))
+          # Trim off data after ::
+          # For example, we don't want upnp:rootdevice from uuid:7DD8D98F-6577-582D-AF37-38B92EB830A4::upnp:rootdevice
+          @usn = @usn.split('::').first
+        elsif line =~ /^LOCATION:/i
+          @location = parse_token(line.split(': '))
+        end
+      end
+    end
+
+    def to_json(include_location_details = false)
+      h = {
+        :st => st,
+        :server => server,
+        :usn => usn,
+        :location => location
+      }
+      h.merge!(retrieve_location_details) if include_location_details and location
+      h
+    end
+    
+    private
+    
+    def parse_token(tokens)
+      value = nil
+      value = tokens[1] if tokens.length >= 2
+      value
+    end
+    
+    def retrieve_location_details
+      url = URI.parse(location)
+      req = Net::HTTP::Get.new(url.path)
+      res = Net::HTTP.start(url.host, url.port) {|http| http.request(req) }
+      parser = Nori.new()
+      parser.parse(res.body)
+    end
+
+  end
+end

data/lib/simple_upnp/discovery.rb

@@ -0,0 +1,52 @@
+require 'socket'
+require 'timeout'
+
+module SimpleUpnp
+  class Discovery
+
+    SSDP_ADDR = '239.255.255.250'
+    SSDP_PORT = 1900
+    M_SEARCH = "M-SEARCH * HTTP/1.1\r\nHOST: #{SSDP_ADDR}:#{SSDP_PORT}\r\nMAN: \"ssdp:discover\"\r\nMX: 2\r\nST: ssdp:all\r\n\r\n"
+    MAX_RECEIVE_LENGTH = 65536
+
+    # Signal the uPnP Multicast address and wait for responses, returning an array of SimpleUpnp::Devices
+    def self.search(seconds_to_listen=5)
+      socket = UDPSocket.new
+      socket.bind('', SSDP_PORT)
+      socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, [1].pack('i'))
+      socket.send(M_SEARCH, 0, SSDP_ADDR, SSDP_PORT)
+      messages = receive_messages(socket, seconds_to_listen)
+      devices = process_messages(messages)
+    end
+
+    private
+
+    # Read responses from the socket until the Timout triggers
+    def self.receive_messages(socket, seconds_to_listen)
+      messages = []
+      begin
+        Timeout::timeout(seconds_to_listen) do
+          while true
+            message, sender = socket.recvfrom(MAX_RECEIVE_LENGTH)
+            messages << message
+          end
+        end
+      rescue Timeout::Error => e
+        # Finished Listening
+      end
+      messages
+    end
+
+    # Convert messages to a unique array of Devices
+    def self.process_messages(messages)
+      devices = []
+      messages.each do |message|
+        device = SimpleUpnp::Device.new(message)
+        index = devices.index { |x| x.usn == device.usn }
+        devices << device if index.nil?
+      end
+      devices
+    end
+
+  end
+end

data/lib/simple_upnp/version.rb

@@ -0,0 +1,3 @@
+module SimpleUpnp
+  VERSION = "0.0.1"
+end

data/lib/simple_upnp.rb

@@ -0,0 +1,9 @@
+require 'nori'
+
+require "simple_upnp/version"
+require "simple_upnp/device"
+require 'simple_upnp/discovery'
+
+module SimpleUpnp
+  # Your code goes here...
+end

data/simple_upnp.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/simple_upnp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dennis Kuczynski"]
+  gem.email         = ["dennis.kuczynski@gmail.com"]
+  gem.description   = %q{Simple library to perform basic UPnP network discovery.}
+  gem.summary       = %q{Simple library to perform basic UPnP network discovery.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "simple_upnp"
+  gem.require_paths = ["lib"]
+  gem.version       = SimpleUpnp::VERSION
+
+  gem.add_dependency "nori",  '~> 1.1.3'
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: simple_upnp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dennis Kuczynski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+description: Simple library to perform basic UPnP network discovery.
+email:
+- dennis.kuczynski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/simple_upnp.rb
+- lib/simple_upnp/device.rb
+- lib/simple_upnp/discovery.rb
+- lib/simple_upnp/version.rb
+- simple_upnp.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple library to perform basic UPnP network discovery.
+test_files: []
+has_rdoc: