upnp_content_explorer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b4988b418c9159f786046868740f5bec4e30a3b
-  data.tar.gz: 3e0fa7672ef7e7aa4f0b0a1c52ab38ec0806a5ba
+  metadata.gz: 70b8cb6774af6666726032cb2ab87783f2b5c656
+  data.tar.gz: d036b630bbd5e416a5067a6a54573e146734924d
 SHA512:
-  metadata.gz: 4335c1369615a03dea77582c64171a00a8c3b37f7660df50e9e57bc76e766db40361ac6c661637e4e278e75b433ba51913ec73a0710b31e730db427780761cf1
-  data.tar.gz: 4627fbb79b24530685dd49dc0b7d11f61dc8b51cf41045f28a75c26fd4a20f8311ff9a323229eb9f5572e2dd821c8b088deb7f0d271f773b4d5fe2be1dd4edde
+  metadata.gz: 5fd717a10acee244d770c45c7291019feb61a30738e55ed2033ae2f113bba29a77c65f2be736893635fcb16b4090384629f6d7d582584596518c2b4db64d45f4
+  data.tar.gz: 7b7ea40f94d190e3cce26fe15c3b3a3707d7a83f7508cbd738925b4afd4e400983a5ff329da5f492427f515082878b98099c22eee342a18f7e61a19956de35ef

data/README.md

@@ -0,0 +1,88 @@
+# upnp_content_explorer
+A convenience wrapper around an [easy_upnp](https://github.com/sidoh/easy_upnp) service to access content.
+
+## Installing
+
+`upnp_content_explorer` is available on [Rubygems](https://rubygems.org). You can install it with:
+
+```
+$ gem install upnp_content_explorer
+```
+
+You can also add it to your Gemfile:
+
+```
+gem 'upnp_content_explorer'
+```
+
+## What's this for?
+
+This gem makes it easy to explore and navigate content provided by a UPnP media server implementing the `urn:schemas-upnp-org:service:ContentDirectory:1` service. At the moment, it relies on [`easy_upnp`](https://github.com/sidoh/easy_upnp) to interface with the UPnP server.
+
+## Example usage
+
+Given an `easy_upnp` server identified by `service`, you can construct a content explorer as follows:
+
+```ruby
+require 'upnp_content_explorer'
+
+explorer = UpnpContentExplorer::Explorer.new(service)
+```
+
+You can then do the following:
+
+### Get the contents of a directory
+
+```ruby
+node = explorer.node_at('/Movies')
+
+node.children.map(&:title)
+# => ["Comedy", "Horror", "Suspense"]
+
+node.items.map(&:title)
+# => ["Inside Out (2015).mkv"]
+```
+
+### List the children of a directory
+```ruby
+children = explorer.children_of('/Movies')
+
+children.map(&:title)
+# => ["Comedy", "Horror", "Suspense"]
+```
+
+### List the files inside of a directory
+```ruby
+items = explorer.items_of('/Movies')
+
+items.map(&:title)
+# => ["Inside Out (2015).mkv"]
+```
+
+### Recursively scrape all content of a directory
+```ruby
+movies = explorer.scrape('/Movies')
+
+items.map(&:title)
+# => ["Inside Out (2015).mkv", "Exorcist, The (1973).mkv", "Seven (1995).mkv", "Airplane (1980).mkv"]
+```
+
+## Extracting metadata
+
+To extract DIDL Lite metadata for an item, you should generally call `Browse` with the `BrowseFlag` parameter equal to `'BrowseMetadata'`, passing the `ObjectID` of the item in question. For example:
+
+```ruby
+# Choose a random movie
+movie = explorer.scrape('/Movies').sample
+
+movie.title
+# => "Airplane (1980).mkv"
+
+# Get movie metadata
+movie_metadata = service.Browse(
+    ObjectID: movie.id, 
+    BrowseFlag: 'BrowseMetadata', 
+    Filter: '*'
+)[:Result]
+# => ... (Raw DIDL Lite metadata) ...
+```

data/lib/upnp_content_explorer/item.rb

@@ -4,6 +4,10 @@ module UpnpContentExplorer
       @data = data
     end
 
+    def item_class
+      @data[:class]
+    end
+
     def method_missing(key)
       return @data[key] if @data.has_key?(key)
       super

data/lib/upnp_content_explorer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upnp_content_explorer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Christopher Mullins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-12 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nori
@@ -90,6 +90,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
+- README.md
 - Rakefile
 - lib/upnp_content_explorer.rb
 - lib/upnp_content_explorer/explorer.rb