easy_upnp 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: e9f368715acba835a38294efd1ec026e8e53400e
-  data.tar.gz: 309a486292c2ce750fe1a25bb3b5bb6af30cba06
+  metadata.gz: a6b753752916257d2f95d32a468f79b71c99b6ad
+  data.tar.gz: 31fcf01b8d619b31d001771fe337334b8bed124f
 !binary "U0hBNTEy":
-  metadata.gz: 312b61519e68d976d089b7195fe2aad9dd57d5d5f35bcf5bfd9c615c3bb4049ba37edbba3baae0d10e8e4db69536fe5f0da1cd5dc38de322a571fcb912686efa
-  data.tar.gz: 8d1cdd7f049db09b24f29cfb49b3f2f79c9d5378550ecc86649f8394b625a3d2d405eebb0216c6eed685dbd798cf14512ce1083d52f03dc4b044bf84e6845b5e
+  metadata.gz: 385b3a0aa8a1bbc401947f4f7cb491b0f94a28cbb7652519b011ba8a564890bb6b2de125cb4679034905bcdd68ba4cad5b18eaeff2df99d52f4cd1ed3ca6bdbd
+  data.tar.gz: 1362a9139d300698126102ec55d27064236211d4e398357a6d0b41d437c9bb33aeded088c71784c36668d67b47811cf5abfa75f6599d6710b3ab97b2901a6e08

data/README.md

@@ -14,3 +14,42 @@ You can also add it to your Gemfile:
 ```
 gem 'easy_upnp'
 ```
+
+## Example usage
+
+#### Find devices with SSDP
+
+[Simple Service Discovery Protocol](http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf) (SSDP) is a simple UDP protocol used to discover services on a network. It's the entry point to create control points in easy_upnp.
+
+The `search` method takes one argument -- the "search target". This controls a header sent in the SSDP packet which affects the devices that respond to the search query. You can use `'ssdp:all'` to specify that all devices should respond.
+
+```ruby
+require 'easy_upnp/ssdp_searcher'
+
+searcher = EasyUpnp::SsdpSearcher.new 
+devices = searcher.search 'ssdp:all'
+```
+
+This will return a list of `EasyUpnp::UpnpDevice` objects. You'll use these to interact with devices on your network.
+
+#### Interacting with a specific device
+
+Once you have a `EasyUpnp::UpnpDevice`, you can start interacting with the services it advertizes. To get a list of all services a device supports:
+
+```ruby
+device = devices.first
+device.all_services
+# => ["urn:schemas-upnp-org:service:ContentDirectory:1", "urn:schemas-upnp-org:service:ConnectionManager:1", "urn:microsoft.com:service:X_MS_MediaReceiverRegistrar:1"]
+```
+
+You can then create a service client and make calls to the service:
+
+```ruby
+service = service = device.service 'urn:schemas-upnp-org:service:ContentDirectory:1'
+
+service.service_methods
+# => ["GetSearchCapabilities", "GetSortCapabilities", "GetSystemUpdateID", "Browse", "Search"]
+
+service.GetSystemUpdateID
+# => {:Id=>"207"}
+```

data/lib/easy_upnp/upnp_device.rb

@@ -74,7 +74,7 @@ module EasyUpnp
 
     def service_definition(urn)
       @service_definitions.
-          reject { |s| s[:st] == urn }.
+          reject { |s| s[:st] != urn }.
           first
     end
   end

data/lib/easy_upnp/version.rb

@@ -1,3 +1,3 @@
 module EasyUpnp
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_upnp
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Christopher Mullins