simple_upnp 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -3,11 +3,21 @@ PATH
   specs:
     simple_upnp (0.0.2)
       nori (~> 2.0.0)
+      rspec (~> 2.12.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    nori (2.0.0)
+    diff-lcs (1.1.3)
+    nori (2.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -25,7 +25,11 @@ Or install it yourself as:
 
 ## Usage
 
-The below code (which can be triggered with the included rake task: "rake simple_upnp:discover"):
+You may either:
+  * search for a configurable number of seconds and return all unique devices that have responded.
+  * attempt to find a specific device and exit early once found
+
+The following example shows search (which can be triggered with the included rake task: "rake simple_upnp:search"):
 ```
 include_location_details = true
 devices = SimpleUpnp::Discovery.search()
@@ -36,7 +40,32 @@ devices.each do |device|
 end
 ```
 
-Should produce output similar to the following:
+The following example shows find (which can be triggered with the included rake task: "rake simple_upnp:find_hue"):
+```
+include_location_details = true
+hue_device = nil
+SimpleUpnp::Discovery.find do |device|
+  device_json = device.to_json(include_location_details)
+  if device_json['root']
+    if device_json['root']['device']
+      if device_json['root']['device']['friendlyName']
+        friendlyName = device_json['root']['device']['friendlyName']
+        if friendlyName =~ /Philips hue/
+          hue_device = device 
+          break
+        end
+      end
+    end
+  end
+end
+if hue_device
+  puts 'Device Found: '
+  puts hue_device.to_json(include_location_details)
+  puts ''
+end
+```
+
+Search should produce output similar to the following:
 ```
 Searching for devices...
 Device Found: 

data/Rakefile

@@ -3,8 +3,15 @@ require "bundler/gem_tasks"
 $LOAD_PATH.unshift File.expand_path("#{File.dirname(__FILE__)}/lib")
 require 'simple_upnp'
 
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default  => :spec
+
 namespace :simple_upnp do
-  task :discover do
+  task :search do
     puts "Searching for devices...\n"
     include_location_details = true
     devices = SimpleUpnp::Discovery.search()
@@ -14,4 +21,29 @@ namespace :simple_upnp do
       puts ''
     end
   end
+
+  task :find_hue do
+    puts "Searching for Phillips Hue...\n"
+    include_location_details = true
+    hue_device = nil
+    SimpleUpnp::Discovery.find do |device|
+      device_json = device.to_json(include_location_details)
+      if device_json['root']
+        if device_json['root']['device']
+          if device_json['root']['device']['friendlyName']
+            friendlyName = device_json['root']['device']['friendlyName']
+            if friendlyName =~ /Philips hue/
+              hue_device = device 
+              break
+            end
+          end
+        end
+      end
+    end
+    if hue_device
+      puts 'Device Found: '
+      puts hue_device.to_json(include_location_details)
+      puts ''
+    end
+  end
 end

data/lib/simple_upnp/discovery.rb

@@ -11,42 +11,54 @@ module SimpleUpnp
 
     # 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)
+      devices = []
+      open_socket do |socket|
+        process_messages(socket, seconds_to_listen) do |message|
+          device = SimpleUpnp::Device.new(message)
+          index = devices.index { |x| x.usn == device.usn }
+          devices << device if index.nil?
+        end
+      end
+      devices
+    end
+
+    # Signal the uPnP Multicast address and wait for responses, which can be processed by an input block accepting a SimpleUpnp::Device
+    # Use break to exit the block once you have found the device being looked for
+    def self.find(seconds_to_listen=5, &block)
+      open_socket do |socket|
+        process_messages(socket, seconds_to_listen) do |message|
+          device = SimpleUpnp::Device.new(message)
+          yield device
+        end
+      end
     end
 
     private
 
-    # Read responses from the socket until the Timout triggers
-    def self.receive_messages(socket, seconds_to_listen)
-      messages = []
+    def self.open_socket(&block)
+      begin
+        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)
+        yield socket
+      ensure
+        socket.close
+      end
+    end
+
+    def self.process_messages(socket, seconds_to_listen, &block)
       begin
         Timeout::timeout(seconds_to_listen) do
           while true
             message, sender = socket.recvfrom(MAX_RECEIVE_LENGTH)
-            messages << message
+            yield 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
+end

data/lib/simple_upnp/version.rb

@@ -1,3 +1,3 @@
 module SimpleUpnp
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/simple_upnp.gemspec

@@ -16,5 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = SimpleUpnp::VERSION
 
   gem.add_dependency "nori",  '~> 2.0.0'
+  gem.add_dependency "rspec", '~> 2.12.0'
 
 end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'simple_upnp'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.dirname(__FILE__)+"/support/**/*.rb"].each  do |f|
+  require f
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_upnp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-27 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nori
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
 description: Simple library to perform basic UPnP network discovery.
 email:
 - dennis.kuczynski@gmail.com
@@ -45,6 +61,7 @@ files:
 - lib/simple_upnp/discovery.rb
 - lib/simple_upnp/version.rb
 - simple_upnp.gemspec
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -69,5 +86,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple library to perform basic UPnP network discovery.
-test_files: []
+test_files:
+- spec/spec_helper.rb
 has_rdoc: