upnp_content_explorer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b4988b418c9159f786046868740f5bec4e30a3b
+  data.tar.gz: 3e0fa7672ef7e7aa4f0b0a1c52ab38ec0806a5ba
+SHA512:
+  metadata.gz: 4335c1369615a03dea77582c64171a00a8c3b37f7660df50e9e57bc76e766db40361ac6c661637e4e278e75b433ba51913ec73a0710b31e730db427780761cf1
+  data.tar.gz: 4627fbb79b24530685dd49dc0b7d11f61dc8b51cf41045f28a75c26fd4a20f8311ff9a323229eb9f5572e2dd821c8b088deb7f0d271f773b4d5fe2be1dd4edde

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christopher
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/upnp_content_explorer.rb

@@ -0,0 +1,2 @@
+require 'upnp_content_explorer/explorer'
+require 'upnp_content_explorer/version'

data/lib/upnp_content_explorer/explorer.rb

@@ -0,0 +1,100 @@
+require 'nokogiri'
+require 'nori'
+
+require 'upnp_content_explorer/node'
+require 'upnp_content_explorer/item'
+
+module UpnpContentExplorer
+  class PathNotFoundError < StandardError; end
+
+  class Explorer
+    def initialize(service)
+      @service = service
+      @root = Node.new({title: 'Root', id: 0})
+    end
+
+    def node_at(path)
+      find_terminal_node(prepare_path(path))
+    end
+
+    def children_of(path)
+      node_at(path).children
+    end
+
+    def items_of(path)
+      node_at(path).items
+    end
+
+    def scrape(path)
+      node = find_terminal_node(prepare_path(path))
+
+      child_items = node.children.map do |child|
+        scrape("#{path}/#{child.title}")
+      end
+
+      all_items = []
+      all_items += node.items
+      all_items += child_items.flatten
+    end
+
+    private
+      def prepare_path(path)
+        path = Pathname.new(path)
+        path.each_filename.to_a
+      end
+
+      def find_terminal_node(path, node = @root, traversed_path = '')
+        node.load!(get_node(node.id)) unless node.loaded?
+
+        return node if path.empty?
+
+        next_node = path.shift
+        next_traversed_path = "#{traversed_path}/#{next_node}"
+        child = node.child(next_node)
+
+        raise PathNotFoundError, "Path doesn't exist: #{next_traversed_path}" if child.nil?
+
+        find_terminal_node(path, child, next_traversed_path)
+      end
+
+      def get_node(node_id)
+        response = @service.Browse(
+            ObjectID: node_id,
+            BrowseFlag: 'BrowseDirectChildren',
+            Filter: '*',
+            StartingIndex: '0',
+            RequestedCount: '0'
+        )
+
+        # Some UPnP servers (i.e., MediaTomb) screw up the namespacing
+        node_data = response[:Result].gsub('xmlns=', 'xmlns:didl=')
+        content   = Nokogiri::XML(node_data)
+
+        children = content.xpath('/DIDL-Lite/container').map do |child|
+          node_data = parse_nori_node(child)
+          Node.new(node_data)
+        end
+
+        items = content.xpath('/DIDL-Lite/item').map do |item|
+          item_data = parse_nori_node(item)
+          Item.new(item_data)
+        end
+
+        children = Hash[ children.map { |x| [x.title, x] } ]
+        items = Hash[ items.map { |x| [x.title, x] } ]
+
+        { children: children, items: items }
+      end
+
+      def parse_nori_node(node)
+        raw_map = Nori.new(:strip_namespaces => true).parse(node.to_xml)
+        raw_map = raw_map[raw_map.keys.first]
+
+        Hash[
+            raw_map.map do |k,v|
+              [k.gsub('@', '').to_sym, v]
+            end
+        ]
+      end
+  end
+end

data/lib/upnp_content_explorer/item.rb

@@ -0,0 +1,12 @@
+module UpnpContentExplorer
+  class Item
+    def initialize(data)
+      @data = data
+    end
+
+    def method_missing(key)
+      return @data[key] if @data.has_key?(key)
+      super
+    end
+  end
+end

data/lib/upnp_content_explorer/node.rb

@@ -0,0 +1,40 @@
+module UpnpContentExplorer
+  class Node
+    def initialize(data)
+      @data = data
+    end
+
+    def loaded?
+      return false if @data[:loaded?].nil?
+      @data[:loaded?]
+    end
+
+    def method_missing(key)
+      return @data[key] if @data.has_key?(key)
+      super
+    end
+
+    def load!(data)
+      merged_data = @data.merge(data)
+      merged_data[:loaded?] = true
+
+      @data = merged_data
+    end
+
+    def children
+      @data[:children].values || []
+    end
+
+    def items
+      @data[:items].values || []
+    end
+
+    def child(key)
+      @data[:children][key]
+    end
+
+    def item(key)
+      @data[:items][key]
+    end
+  end
+end

data/lib/upnp_content_explorer/version.rb

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

data/upnp_content_explorer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'upnp_content_explorer'
+
+Gem::Specification.new do |spec|
+  spec.name          = "upnp_content_explorer"
+  spec.version       = UpnpContentExplorer::VERSION
+  spec.authors       = ["Christopher Mullins"]
+  spec.email         = ["chris@sidoh.org"]
+
+  spec.summary       = %q{Provides a convenient way to explore and access content provided by a UPnP media server.}
+  spec.homepage      = "http://www.github.com/sidoh/upnp_content_explorer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nori", "~> 2.6"
+  spec.add_dependency "easy_upnp", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: upnp_content_explorer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Mullins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: easy_upnp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- chris@sidoh.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- lib/upnp_content_explorer.rb
+- lib/upnp_content_explorer/explorer.rb
+- lib/upnp_content_explorer/item.rb
+- lib/upnp_content_explorer/node.rb
+- lib/upnp_content_explorer/version.rb
+- upnp_content_explorer.gemspec
+homepage: http://www.github.com/sidoh/upnp_content_explorer
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Provides a convenient way to explore and access content provided by a UPnP
+  media server.
+test_files: []