easy_upnp 0.1.8 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 017b7021b1d9c35fab09ff9f670a660c96758443
-  data.tar.gz: 793f938414da9e550a12b94aa90a05ba0de81480
+  metadata.gz: ff03da48709a543a35dbfe13a1ece864d9337db6
+  data.tar.gz: 61517d04933afc34e2465de2400c577d001b63fb
 SHA512:
-  metadata.gz: 71e31a046b94b3e99cb6f79d87da6f2ee92fd06f209960ae67d0cb7457864bac839dfda9312ce8205b5fb4d8ac57d6c81f6673643343c6f84f044ff15b4e45ac
-  data.tar.gz: 689804ce65c657638e8098403d7ea33571b0b6ca69bfc2cc16f63488fcc9d74b3639eb03d0da63facf86a1fc11bdfbf8f05871123e81ce048091f970a4ae561b
+  metadata.gz: 4dbf1e5b113b33fe94db16655421b17f22f72eb57f5deb80521a2f5d6c83e4b097384495370ace08124fdce9da5e1fef228d8b960fefa408a3cc15c0aefb83ff
+  data.tar.gz: 50a3d09bd2a1d2fb00f8afab09fca6a95db15c1118a424fdde175e5ab2ddecd537109ef789dc163effac4e1708490c8667342c2c2088a3824dc6474b3c973f75

data/README.md

@@ -53,3 +53,22 @@ service.service_methods
 service.GetSystemUpdateID
 # => {:Id=>"207"}
 ```
+
+## Static client construction
+
+After you've constructed a client (`DeviceControlPoint`), you probably don't want to have to use SSDP to construct it again the next time you use it. `DeviceControlPoint` is equipped with `#to_params` and `#from_params` methods to make this easy.
+
+Say you have a client called `client`. To dump it into a hash, do the following:
+
+```ruby
+params = client.to_params
+#=> {:urn=>"urn:schemas-upnp-org:service:ContentDirectory:1", :service_endpoint=>"http://10.133.8.11:8200/ctl/ContentDir", :definition=>"<?xml version=\"1.0\"?>\r\n<scpd xmlns=\"urn:schemas-upnp-org:service-1-0\">( ... clipped ... )</scpd>", :options=>{}}
+```
+
+We can then reconstruct a client from these params and use it normally:
+
+```ruby
+client = EasyUpnp::DeviceControlPoint.from_params(params)
+client.GetSystemUpdateID
+=> {:Id=>"258"}
+```

data/lib/easy_upnp/device_control_point.rb

@@ -6,22 +6,80 @@ module EasyUpnp
   class DeviceControlPoint
     attr_reader :service_methods
 
-    def initialize(client, service_type, definition_url, options)
-      @client = client
-      @service_type = service_type
+    def initialize(urn, service_endpoint, definition, options)
+      @urn = urn
+      @service_endpoint = service_endpoint
       @options = options
+      @definition = definition
 
-      service_methods = []
-      definition = Nokogiri::XML(open(definition_url))
-      definition.remove_namespaces!
+      @client = Savon.client do |c|
+        c.endpoint service_endpoint
+        c.namespace urn
+
+        # I found this was necessary on some of my UPnP devices (namely, a Sony TV).
+        c.namespaces({:'s:encodingStyle' => "http://schemas.xmlsoap.org/soap/encoding/"})
+
+        # This makes XML tags be like <ObjectID> instead of <objectID>.
+        c.convert_request_keys_to :camelcase
+
+        c.namespace_identifier :u
+        c.env_namespace :s
+      end
 
-      definition.xpath('//actionList/action').map do |action|
+      definition_xml = Nokogiri::XML(definition)
+      definition_xml.remove_namespaces!
+
+      service_methods = []
+      definition_xml.xpath('//actionList/action').map do |action|
         service_methods.push define_action(action)
       end
 
       @service_methods = service_methods
     end
 
+    def to_params
+      {
+        urn: @urn,
+        service_endpoint: @service_endpoint,
+        definition: @definition,
+        options: @options
+      }
+    end
+
+    def self.from_params(params)
+      DeviceControlPoint.new(
+          params[:urn],
+          params[:service_endpoint],
+          params[:definition],
+          params[:options]
+      )
+    end
+
+    def self.from_service_definition(definition, options = {})
+      urn = definition[:st]
+      root_uri = definition[:location]
+
+      xml = Nokogiri::XML(open(root_uri))
+      xml.remove_namespaces!
+
+      service = xml.xpath("//device/serviceList/service[serviceType=\"#{urn}\"]").first
+
+      if service.nil?
+        raise RuntimeError.new "Couldn't find service with urn: #{urn}"
+      else
+        service = Nokogiri::XML(service.to_xml)
+        service_definition_uri = URI.join(root_uri, service.xpath('service/SCPDURL').text).to_s
+        service_definition = open(service_definition_uri) { |f| f.read }
+
+        DeviceControlPoint.new(
+            urn,
+            URI.join(root_uri, service.xpath('service/controlURL').text).to_s,
+            service_definition,
+            options
+        )
+      end
+    end
+
     private
 
     def define_action(action)
@@ -47,9 +105,9 @@ module EasyUpnp
         end
 
         attrs = {
-            soap_action: "#{@service_type}##{action_name}",
+            soap_action: "#{@urn}##{action_name}",
             attributes: {
-                :'xmlns:u' => @service_type
+                :'xmlns:u' => @urn
             },
         }.merge(@options)
 
@@ -86,4 +144,4 @@ module EasyUpnp
           downcase
     end
   end
-end
+end

data/lib/easy_upnp/ssdp_searcher.rb

@@ -63,7 +63,7 @@ module EasyUpnp
       # and create UpnpDevices for them. This wrap the services advertized by the SSDP
       # results.
       parsed_messages.reject { |x| !x[:usn] }.group_by { |x| x[:usn].split('::').first }.map do |k, v|
-        UpnpDevice.new k, v
+        UpnpDevice.from_ssdp_messages(k, v)
       end
     end
 

data/lib/easy_upnp/upnp_device.rb

@@ -9,9 +9,13 @@ module EasyUpnp
   class UpnpDevice
     attr_reader :uuid, :name, :host
 
-    def initialize uuid, messages
+    def initialize(uuid, service_definitions)
       @uuid = uuid
-      @service_definitions = messages.
+      @service_definitions = service_definitions
+    end
+
+    def self.from_ssdp_messages(uuid, messages)
+      service_definitions = messages.
           # Filter out messages that aren't service definitions. These include
           # the root device and the root UUID
           reject { |message| not message[:st].include? ':service:' }.
@@ -26,18 +30,7 @@ module EasyUpnp
             }
           end
 
-      # Download one of the definitions to get the name of this device
-      if @service_definitions.any?
-        service_location = @service_definitions.first[:location]
-
-        xml = Nokogiri::XML(open(service_location))
-        xml.remove_namespaces!
-        @name = xml.xpath('//device/friendlyName').text
-        @host = URI.parse(service_location).host
-      else
-        @name = 'UNKNOWN'
-        @host = 'UNKNOWN'
-      end
+      UpnpDevice.new(uuid, service_definitions)
     end
 
     def all_services
@@ -52,35 +45,7 @@ module EasyUpnp
       definition = service_definition(urn)
 
       if !definition.nil?
-        root_uri = definition[:location]
-        xml = Nokogiri::XML(open(root_uri))
-        xml.remove_namespaces!
-
-        service = xml.xpath("//device/serviceList/service[serviceType=\"#{urn}\"]").first
-
-        if service.nil?
-          raise RuntimeError.new "Couldn't find service with urn: #{urn}"
-        else
-          service = Nokogiri::XML(service.to_xml)
-          wsdl = URI.join(root_uri, service.xpath('service/SCPDURL').text).to_s
-
-          client = Savon.client do |c|
-            c.endpoint URI.join(root_uri, service.xpath('service/controlURL').text).to_s
-
-            c.namespace urn
-
-            # I found this was necessary on some of my UPnP devices (namely, a Sony TV).
-            c.namespaces({:'s:encodingStyle' => "http://schemas.xmlsoap.org/soap/encoding/"})
-
-            # This makes XML tags be like <ObjectID> instead of <objectID>.
-            c.convert_request_keys_to :camelcase
-
-            c.namespace_identifier :u
-            c.env_namespace :s
-          end
-
-          DeviceControlPoint.new client, urn, wsdl, options
-        end
+        DeviceControlPoint.from_service_definition(definition, options)
       end
     end
 
@@ -90,4 +55,4 @@ module EasyUpnp
           first
     end
   end
-end
+end

data/lib/easy_upnp/version.rb

@@ -1,3 +1,3 @@
 module EasyUpnp
-  VERSION = '0.1.8'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: easy_upnp
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.1
 platform: ruby
 authors:
 - Christopher Mullins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.1
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.6.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
 description: 
@@ -86,7 +86,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -105,17 +105,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A super easy to use UPnP control point client