easy_upnp 1.1.12 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: babc894636ff772c95cdc3f7bbc1aa68f921b82a1ce6ffdc08e329f51aa9a115
-  data.tar.gz: 5d2ae887cbc1a98e63b8ddd14cb2c7a33bff2f8556aead0d0e258a0ff2388f49
+  metadata.gz: 6da8d74ad1d393322eabbd9230e30806db4f3d98c7ccbb80444335f8969e1a73
+  data.tar.gz: ca9b39475ba3a8aacb598361ca2d0e56185cd15b84e03ba35921aa4fb2aff9fe
 SHA512:
-  metadata.gz: 2878ae8736a92cc5a9bc32736b5da23f388eeffe30bd9bcd29321802e6858b3dd22819565352904b65260c0c78843af6ea25496fdd42817a1b07c68bb4de1fd8
-  data.tar.gz: d95f475abf525a1aadb83417abdcab789266758ac13bd49778e1707ae92c45dc669fb44816fae0ceb028772a76b3ddd58492a89875d29ee2fae446406467bf9a
+  metadata.gz: 460fae3cfe1f5c2e29420668d45d9a866599aaf959e730129d07af12167bce2409622cc5035e52d2771b18511376d2d7ef977f69174bbc281b7b426120f95aaf
+  data.tar.gz: d64e502edc4b242ecf80262533fe8314cb819dfaa2cfc17324869690198035ef0b209c67fbe191ee6cfdcc8ec58c6fce4557075fcd1309cf78682830ae3534c0

data/README.md

@@ -1,4 +1,5 @@
-# easy_upnp
+# easy_upnp [![Gem Version][shield-gem]][info-gem] [![Build Status][shield-travis]][info-travis]
+
 A super simple UPnP control point client for Ruby
 
 ## Installing
@@ -26,7 +27,7 @@ The `search` method takes one argument -- the "search target". This controls a h
 ```ruby
 require 'easy_upnp'
 
-searcher = EasyUpnp::SsdpSearcher.new 
+searcher = EasyUpnp::SsdpSearcher.new
 devices = searcher.search 'ssdp:all'
 ```
 
@@ -79,8 +80,8 @@ By default, logs will be printed to `$stdout` at the `:error` level. To change t
 
 ```ruby
 service = client.service(
-  'urn:schemas-upnp-org:service:ContentDirectory:1', 
-  log_enabled: true, 
+  'urn:schemas-upnp-org:service:ContentDirectory:1',
+  log_enabled: true,
   log_level: :info
 )
 
@@ -164,7 +165,7 @@ There are two ways you can subscribe to events with easy_upnp:
 1. Registering a custom HTTP endpoint.
 2. Providing a callback `lambda` or `Proc` which is called each time an event is fired.
 
-In the case of (2), easy_upnp behind the scenes starts a WEBrick HTTP server, which calls the provided callback whenever it receives an HTTP `NOTIFY` request. 
+In the case of (2), easy_upnp behind the scenes starts a WEBrick HTTP server, which calls the provided callback whenever it receives an HTTP `NOTIFY` request.
 
 Because event subscriptions expire, easy_upnp starts a background thread to renew the subscription on an interval.
 
@@ -177,7 +178,7 @@ To add a URL to be called on events:
 # URL will be called with HTTP NOTIFY requests from the service.
 manager = service.add_event_callback('http://myserver/path/to/callback')
 
-# The object that's returned allows you to manage the event subscription. To 
+# The object that's returned allows you to manage the event subscription. To
 # cancel the subscription, for example:
 manager.unsubscribe
 
@@ -199,7 +200,7 @@ end
 
 #### Calling ruby code
 
-If you don't want to have to set up an HTTP endpoint to listen to events, you can have easy_upnp do it for you. The `on_event` starts an internal HTTP server on an ephemeral port behind the scenes and triggers the provided callback each time a request is recieved. 
+If you don't want to have to set up an HTTP endpoint to listen to events, you can have easy_upnp do it for you. The `on_event` starts an internal HTTP server on an ephemeral port behind the scenes and triggers the provided callback each time a request is recieved.
 
 ```ruby
 # Parse and print the XML body of the request
@@ -239,8 +240,11 @@ manager = service.on_event(callback) do |c|
   c.configure_http_listener do |l|
     l.listen_port = 8888
     l.bind_address = '192.168.1.100'
+
+    # Don't parse XML body, pass raw contents to callback
+    l.event_parser = EasyUpnp::NoOpEventParser
   end
-  
+
   c.configure_subscription_manager do |m|
     m.requested_timeout = 1800
     m.resubscription_interval_buffer = 60
@@ -249,3 +253,12 @@ manager = service.on_event(callback) do |c|
   end
 end
 ```
+
+[info-gem]:   https://rubygems.org/gems/easy_upnp
+[shield-gem]: https://img.shields.io/gem/v/easy_upnp.svg
+
+[info-travis]:   https://travis-ci.org/sidoh/easy_upnp
+[shield-travis]: https://img.shields.io/travis/sidoh/easy_upnp.svg
+
+[info-coveralls]:   https://coveralls.io/github/sidoh/easy_upnp
+[shield-coveralls]: https://img.shields.io/coveralls/github/sidoh/easy_upnp.svg

data/lib/easy_upnp/events/{event_parser.rb → event_parsers.rb}

@@ -1,7 +1,7 @@
 require 'nokogiri'
 
 module EasyUpnp
-  class EventParser
+  class DefaultEventParser
     def parse(event_xml)
       x = Nokogiri::XML(event_xml)
       prop_changes = x.xpath('//e:propertyset/e:property/*', e: 'urn:schemas-upnp-org:event-1-0').map do |n|
@@ -11,4 +11,10 @@ module EasyUpnp
       Hash[prop_changes]
     end
   end
+
+  class NoOpEventParser
+    def parse(event_xml)
+      event_xml
+    end
+  end
 end

data/lib/easy_upnp/events/http_listener.rb

@@ -1,7 +1,7 @@
 require 'webrick'
 require 'thread'
 
-require 'easy_upnp/events/event_parser'
+require 'easy_upnp/events/event_parsers'
 
 module EasyUpnp
   class HttpListener
@@ -18,7 +18,11 @@ module EasyUpnp
         # By default, event callback just prints the changed state vars
         callback: ->(state_vars) {
           puts state_vars.inspect
-        }
+        },
+
+        # Parses event bodies.  By default parse the XML into a hash.  Use
+        # EasyUpnp::NoOpEventParser to skip parsing
+        event_parser: EasyUpnp::DefaultEventParser
       }
 
       def initialize(options)
@@ -37,7 +41,7 @@ module EasyUpnp
           AccessLog: [],
           BindAddress: @options.bind_address
         )
-        @server.mount('/', NotifyServlet, @options.callback)
+        @server.mount('/', NotifyServlet, @options.callback, @options.event_parser.new)
       end
 
       @listen_thread ||= Thread.new do
@@ -67,9 +71,9 @@ module EasyUpnp
   end
 
   class NotifyServlet < WEBrick::HTTPServlet::AbstractServlet
-    def initialize(_server, block)
+    def initialize(_server, block, parser)
       @callback = block
-      @parser = EasyUpnp::EventParser.new
+      @parser = parser
     end
 
     def do_NOTIFY(request, response)

data/lib/easy_upnp/version.rb

@@ -1,3 +1,3 @@
 module EasyUpnp
-  VERSION = '1.1.12'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_upnp
 version: !ruby/object:Gem::Version
-  version: 1.1.12
+  version: 1.2.0
 platform: ruby
 authors:
 - Christopher Mullins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2017-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,7 +87,7 @@ files:
 - lib/easy_upnp/control_point/service_method.rb
 - lib/easy_upnp/control_point/validator_provider.rb
 - lib/easy_upnp/events/event_client.rb
-- lib/easy_upnp/events/event_parser.rb
+- lib/easy_upnp/events/event_parsers.rb
 - lib/easy_upnp/events/http_listener.rb
 - lib/easy_upnp/events/subscription_manager.rb
 - lib/easy_upnp/options_base.rb
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A super easy to use UPnP control point client