easy_upnp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 58750344e60c3c1ccba0ec054ea0a8e1707b70b1
+  data.tar.gz: d73392dec5230c617f2f1cca4596e9950fd67a79
+!binary "U0hBNTEy":
+  metadata.gz: c9f9def01cb5147d365b7edebe1cb1f27efc55c3f039f2e17111417f6ecfbab1e6104e05cbebf4f63dfa4f0ade3785874669a1751f9e29ce0c581daba6011648
+  data.tar.gz: e2ae7f65a0616476d9e8c593eb753d5b766372e62a03e18309f4f30de87b7d361940b1ab62c09c0e86ac65a61edad6c689ce9f3bb7fbafedc6a2fe4d019fc234

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'savon', '~> 2.11.1'
+gem 'nori', '~> 2.6.0'
+gem 'nokogiri', '~> 1.6.6.2'

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Mullins
+
+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,2 @@
+# easy-upnp
+A super simple UPnP control point client for Ruby

data/easy_upnp.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require "easy_upnp/version"
+
+Gem::Specification.new do |gem|
+  gem.name    = 'easy_upnp'
+  gem.version = EasyUpnp::VERSION
+
+  gem.summary = "A super easy to use UPnP control point client"
+
+  gem.authors  = ['Christopher Mullins']
+  gem.email    = 'chris@sidoh.org'
+  gem.homepage = 'http://github.com/sidoh/easy-upnp'
+
+  gem.add_dependency 'rake' 
+  gem.add_dependency 'savon', '~> 2.11.1'
+  gem.add_dependency 'nori', '~> 2.6.0'
+  gem.add_dependency 'nokogiri', '~> 1.6.6.2'
+
+  gem.add_development_dependency('rspec', [">= 2.0.0"])
+
+  ignores  = File.readlines(".gitignore").grep(/\S+/).map(&:chomp)
+  dotfiles = %w[.gitignore]
+
+  all_files_without_ignores = Dir["**/*"].reject { |f|
+    File.directory?(f) || ignores.any? { |i| File.fnmatch(i, f) }
+  }
+
+  gem.files = (all_files_without_ignores + dotfiles).sort
+
+  gem.require_path = "lib" 
+end

data/lib/easy_upnp/device_control_point.rb

@@ -0,0 +1,78 @@
+require 'nokogiri'
+require 'open-uri'
+require 'nori'
+
+module EasyUpnp
+  class DeviceControlPoint
+    def initialize client, service_type, definition_url
+      @client = client
+      @service_type = service_type
+
+      definition = Nokogiri::XML(open(definition_url))
+      definition.remove_namespaces!
+
+      definition.xpath('//actionList/action').map do |action|
+        define_action action
+      end
+    end
+
+    private
+
+    def define_action action
+      action = Nori.new.parse(action.to_xml)['action']
+      action_name = action['name']
+      args = action['argumentList']['argument']
+      args = [args] unless args.is_a? Array
+
+      input_args = args.
+          reject { |x| x['direction'] != 'in' }.
+          map { |x| x['name'].to_sym }
+      output_args = args.
+          reject { |x| x['direction'] != 'out' }.
+          map { |x| x['name'].to_sym }
+
+      define_singleton_method(action['name']) do |args_hash|
+        if (args_hash.keys - input_args).any?
+          raise RuntimeError.new "Unsupported arguments: #{(args_hash.keys - input_args)}." <<
+                                     " Supported args: #{input_args}"
+        end
+
+        attrs = {
+            soap_action: "#{@service_type}##{action_name}",
+            attributes: {
+                :'xmlns:u' => @service_type
+            }
+        }
+
+        response = @client.call action['name'], attrs do
+          message(args_hash)
+        end
+
+        # Response is usually wrapped in <#{ActionName}Response></>. For example:
+        # <BrowseResponse>...</BrowseResponse>. Extract the body since consumers
+        # won't care about wrapper stuff.
+        if response.body.keys.count > 1
+          raise RuntimeError.new "Unexpected keys in response body: #{response.body.keys}"
+        end
+        result = response.body.first[1]
+        output = {}
+
+        # Keys returned by savon are underscore style. Convert them to camelcase.
+        output_args.map do |arg|
+          output[arg] = result[underscore(arg.to_s).to_sym]
+        end
+
+        output
+      end
+    end
+
+    # This is included in ActiveSupport, but don't want to pull that in for just this method...
+    def underscore s
+      s.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+          gsub(/([a-z\d])([A-Z])/, '\1_\2').
+          tr("-", "_").
+          downcase
+    end
+  end
+end

data/lib/easy_upnp/ssdp_searcher.rb

@@ -0,0 +1,127 @@
+require 'socket'
+require 'ipaddr'
+require 'timeout'
+require_relative 'upnp_device'
+
+module EasyUpnp
+  class SsdpSearcher
+    # These are dictated by the SSDP protocol and cannot be changed
+    MULTICAST_ADDR = '239.255.255.250'
+    MULTICAST_PORT = 1900
+
+    DEFAULT_OPTIONS = {
+        :bind_addr => '0.0.0.0',
+
+        # Number of seconds to wait for responses
+        :timeout => 2,
+
+        # Part of the SSDP protocol. Servers should delay a random amount of time between 0 and N
+        # seconds before sending the response.
+        :mx => 1,
+
+        # Sometimes recommended to send repeat M-SEARCH queries. Control that here.
+        :repeat_queries => 1
+    }
+
+    def initialize(options = {})
+      unsupported_args = options.keys.reject { |x| DEFAULT_OPTIONS[x] }
+      raise RuntimeError.new "Unsupported arguments: #{unsupported_args}" if unsupported_args.any?
+
+      @options = DEFAULT_OPTIONS.merge options
+    end
+
+    def option key
+      @options[key]
+    end
+
+    def search urn
+      listen_socket = build_listen_socket
+      send_socket = build_send_socket
+      packet = construct_msearch_packet(urn)
+
+      # Send M-SEARCH packet over UDP socket
+      option(:repeat_queries).times do
+        send_socket.send packet, 0, MULTICAST_ADDR, MULTICAST_PORT
+      end
+
+      raw_messages = []
+
+      # Wait for responses. Timeout after a specified number of seconds
+      begin
+        Timeout::timeout(option :timeout) do
+          loop do
+            raw_messages.push send_socket.recv(4196)
+          end
+        end
+      rescue Timeout::Error
+        # This is expected
+      ensure
+        send_socket.close
+        listen_socket.close
+      end
+
+      # Parse messages (extract HTTP headers)
+      parsed_messages = raw_messages.map { |x| parse_message x }
+
+      # Group messages by device they come from (identified by a UUID in the 'USN' header),
+      # 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
+      end
+    end
+
+    def construct_msearch_packet(urn)
+      <<-MSEARCH
+M-SEARCH * HTTP/1.1\r
+HOST: #{MULTICAST_ADDR}:#{MULTICAST_PORT}\r
+MAN: "ssdp:discover"\r
+MX: #{option :mx}\r
+ST: #{urn}\r
+\r
+      MSEARCH
+    end
+
+    def parse_message message
+      lines = message.split "\r\n"
+      headers = lines[1...-1].map do |line|
+        header, value = line.match(/([^:]+):\s?(.*)/i).captures
+
+        key = header.
+            downcase.
+            gsub('-', '_').
+            to_sym
+
+        [key, value]
+      end
+      Hash[headers]
+    end
+
+    private
+
+    def build_listen_socket
+      socket = UDPSocket.new
+      socket.do_not_reverse_lookup = true
+
+      membership = IPAddr.new(MULTICAST_ADDR).hton + IPAddr.new(option :bind_addr).hton
+
+      socket.setsockopt(:IPPROTO_IP, :IP_ADD_MEMBERSHIP, membership)
+      socket.setsockopt(:SOL_SOCKET, :SO_REUSEADDR, true)
+      socket.setsockopt(:IPPROTO_IP, :IP_TTL, 1)
+
+      socket.bind(option(:bind_addr), MULTICAST_PORT)
+
+      socket
+    end
+
+    def build_send_socket
+      socket = UDPSocket.open
+      socket.do_not_reverse_lookup = true
+
+      socket.setsockopt(:IPPROTO_IP, :IP_MULTICAST_TTL, true)
+      socket.setsockopt(:SOL_SOCKET, :SO_REUSEADDR, true)
+
+      socket
+    end
+  end
+  end

data/lib/easy_upnp/upnp_device.rb

@@ -0,0 +1,77 @@
+require 'uri'
+require 'nokogiri'
+require 'open-uri'
+require 'savon'
+
+require_relative 'device_control_point'
+
+module EasyUpnp
+  class UpnpDevice
+    attr_reader :uuid
+
+    def initialize uuid, messages
+      @uuid = uuid
+
+      @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:' }.
+          # Distinct by ST header -- might have repeats if we sent multiple
+          # M-SEARCH packets
+          group_by { |message| message[:st] }.
+          map { |_, matching_messages| matching_messages.first }.
+          map do |message|
+        {
+            :location => message[:location],
+            :st => message[:st]
+        }
+      end
+    end
+
+    def has_service?(urn)
+      !service_definition(urn).nil?
+    end
+
+    def service(urn)
+      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
+        end
+      end
+    end
+
+    def service_definition(urn)
+      @service_definitions.
+          reject { |s| s[:st] == urn }.
+          first
+    end
+  end
+end

data/lib/easy_upnp/version.rb

@@ -0,0 +1,3 @@
+module EasyUpnp
+  VERSION = '0.1.0'
+end

data/lib/easy_upnp.rb

@@ -0,0 +1,3 @@
+module EasyUpnp
+  require 'easy_upnp'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: easy_upnp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Mullins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-26 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: 
+email: chris@sidoh.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- easy_upnp.gemspec
+- lib/easy_upnp.rb
+- lib/easy_upnp/device_control_point.rb
+- lib/easy_upnp/ssdp_searcher.rb
+- lib/easy_upnp/upnp_device.rb
+- lib/easy_upnp/version.rb
+homepage: http://github.com/sidoh/easy-upnp
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.0.preview3.1
+signing_key: 
+specification_version: 4
+summary: A super easy to use UPnP control point client
+test_files: []