tivohmo 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b98cf908b70108f96047411d32f7e1b7fe4b86
-  data.tar.gz: d78429acd344c4df742e8e849600a71ad5ccbb91
+  metadata.gz: bf38e58ce80df9b5a177019960ace75cee1214cd
+  data.tar.gz: 84358dcbc8cc552c560a34b67cd3bec1f40d7d62
 SHA512:
-  metadata.gz: e1d414df9691878b936744d0ce977806df8b820078876e763b3b116d13167b8fabd71b46c1618c30426ae898152f0105d5b17785b1ff2b8a3642dcbffd925c48
-  data.tar.gz: 31eb7b4f97bc01856f0148f9483ebf1746129dfc9f9f552ecf837a8f02d9923222f0a9f1f823e4e339706c9c1f10eb3095aff035fcd49bcf6323c0e9feb08af9
+  metadata.gz: 1643360b023aa69207324541bfd041b25ce3d07e7211aa57bc7a3b33ab6b497c6063a560ba26ebe0f577e18a4fc8361838de7778b5758b5250b06f59996e62be
+  data.tar.gz: 807c936f1152bb55a0a62ddcb6c933aaa0c03d19c44cf407fde517f283ca16c8e3ccb6fb2d84744090f3cb90885077fbde392fc831ac75540d59ab85af34fee0

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 2.1.3
 
 before_script:
-  - sudo add-apt-repository ppa:djcj/vlc-stable -y
+  - sudo add-apt-repository ppa:archivematica/externals -y
   - sudo apt-get update
   - sudo apt-get install -y ffmpeg
 

data/CHANGELOG

@@ -1,3 +1,33 @@
+0.3.0 (03/01/2015)
+------------------
+
+Use a group for subtitles+original <a552478> [Matt Conway]
+add ability to optionally hardcode subtitles when present <df079f8> [Matt Conway]
+add ability to skip sorting by setting presorted flag <5148bcf> [Matt Conway]
+add reset to defaults <71f12ce> [Matt Conway]
+add settings mechanism and app to control it from tivo ui <8fce56c> [Matt Conway]
+add todo <e7b0f6b> [Matt Conway]
+allow implementations to not have to load children to show a count <40464c6> [Matt Conway]
+allow reading cli config from file <f208616> [Matt Conway]
+allow video fixture with vcr <09a792e> [Matt Conway]
+app for changing runtime settings <4f1cd05> [Matt Conway]
+beacon seems to work better on linux if I create a new socket for each broadcast <879573a> [Matt Conway]
+better title for subs <1755a82> [Matt Conway]
+change ffmpeg ppa <11c96c0> [Matt Conway]
+cli install templates <e9ec91f> [Matt Conway]
+config tests <0c3b23e> [Matt Conway]
+config working <57f7fc8> [Matt Conway]
+fix performance issue with subtitles, allow for embedded subtitles (e.g. mkv) <6da6aa3> [Matt Conway]
+fix plex cache updating <5f45b69> [Matt Conway]
+more metadata <8608b5c> [Matt Conway]
+move webmock to gemfile to prevent auto require <3f19631> [Matt Conway]
+new vcr fixtures <1dfa166> [Matt Conway]
+partial <951dada> [Matt Conway]
+redo plex tests with vcr <5da4030> [Matt Conway]
+refactor to make item have a file, refactor subtitles and transcoding, misc tests <70a8f37> [Matt Conway]
+update readme <2338cff> [Matt Conway]
+work with rvm <ecff585> [Matt Conway]
+
 0.2.3 (11/29/2014)
 ------------------
 

data/Gemfile

@@ -5,3 +5,5 @@ gemspec
 
 # for code coverage during travis-ci test runs
 gem 'coveralls', :require => false
+gem 'webmock', require: false
+#gem 'vcr', require: false

data/README.md

@@ -21,14 +21,11 @@ Install the gem:
 
     $ gem install tivohmo
 
-Or to use this gem in your own ruby project, add this line to your application's Gemfile:
+then install as a daemon with default configuration:
 
-    gem 'tivohmo'
-
-And then execute:
-
-    $ bundle
+    $ tivohmo --install
 
+Optionally edit the installed configuration file mentioned when the install command executes, and restart the daemon.
 
 ## Usage
 
@@ -36,6 +33,7 @@ Run the 'tivohmo' binary for usage:
 
     tivohmo --help
 
+
 ## Developing
 
 Use the classes in TivoHMO::API to create your tree of data (Application -> Container(s) -> Items), then serve them with TivoHMO::Server.  See TivoHMO::Adapters::Filesystem for a sample implementation based on folders/files/ffmpeg

data/TODO

@@ -0,0 +1 @@
+fix back after watching movie (anchor)

data/contrib/tivohmo.conf

@@ -9,7 +9,7 @@ stop on runlevel [!2345]
 
 respawn
 respawn limit 10 5
-setuid user
+setuid root
 umask 022
 
-exec tivohmo --preload --port 9033 -a TivoHMO::Adapters::Filesystem::Application -i /My/Video -t Video -a TivoHMO::Adapters::Plex::Application -i localhost -t "Plex Video"
+exec bash -l -c "tivohmo --configuration /etc/tivohmo.yml"

data/contrib/tivohmo.plist

@@ -16,7 +16,7 @@ Then to start the server, run: launchctl load ~/Library/LaunchAgents/tivohmo.pli
                 <string>bash</string>
                 <string>-l</string>
                 <string>-c</string>
-                <string>tivohmo -p 9033 -l ~/Library/Logs/tivohmo.log -a TivoHMO::Adapters::Plex::Application -i localhost -t 'Plex Videos'</string>
+                <string>tivohmo --configuration <%= File.expand_path(config[:configuration]) %></string>
         </array>
         <key>RunAtLoad</key>
         <true/>

data/contrib/tivohmo.yml

@@ -0,0 +1,60 @@
+# The network port to listen to tivo requests on
+port: 9033
+
+# Run with debug logging enabled
+debug: false
+
+# Walk the application trees to preload all data for quicker browsing at
+# the expense of slower startup
+preload: false
+
+# The file to record tivohmo logs in
+logfile: <%= config[:logfile] %>
+
+# The runtime settings file for saving config changes made using the
+# Settings app.  Must be writable by the tivohmo process
+settings: <%= config[:settings] %>
+
+# The limit:interval for broadcasting beacon signals to the network
+# -1 as the limit means infinite
+beacon: "-1:10"
+
+# The applications to enable
+applications:
+  # The Settings app for editing runtime changeable settings
+  TivoHMO Settings:
+    application: TivoHMO::Adapters::Settings::Application
+    identifier: settings
+  # The Plex app for sharing video from a plex media server.  This currently
+  # only works if the plex server is running on the same host as tivohmo
+  TivoHMO Plex Videos:
+    application: TivoHMO::Adapters::Plex::Application
+    identifier: localhost
+# # The filesystem app for sharing video from a directory
+# TivoHMO Filesystem Videos:
+#    application: TivoHMO::Adapters::Filesystem::Application
+#    identifier: /My/Video
+
+
+# BEGIN RUNTIME EDITABLE SETTINGS
+#
+
+# These settings are all editable from the TivoHMO Settings app, and will
+# get saved to the file specified in the 'settings' config above, thereby
+# overriding any settings configured below.
+
+# Detect subtitles for videos and include them as a choice when browsing
+# Runtime editable from Settings app
+enable_subtitles: true
+
+# Force groups/folders regardless of parameters supplied by the tivo request
+# Runtime editable from Settings app
+force_grouping: true
+
+# Use zap2it ID for grouping episodes (Gives thumbnail in My Shows, but can
+# cause problems)
+# Runtime editable from Settings app
+group_with_zap2it: true
+
+#
+# END RUNTIME EDITABLE SETTINGS

data/lib/tivohmo/adapters/filesystem/file_item.rb

@@ -9,14 +9,13 @@ module TivoHMO
         include TivoHMO::API::Item
         include GemLogger::LoggerSupport
 
-        attr_reader :full_path
-
         def initialize(identifier)
-          @full_path = File.expand_path(identifier)
+          full_path = File.expand_path(identifier)
           raise ArgumentError, "Must provide an existing file" unless File.file?(full_path)
 
           super(full_path)
 
+          self.file = full_path
           self.title = File.basename(self.identifier)
           self.modified_at = File.mtime(self.identifier)
           self.created_at = File.ctime(self.identifier)

data/lib/tivohmo/adapters/plex/category.rb

@@ -6,15 +6,20 @@ module TivoHMO
         include TivoHMO::API::Container
         include GemLogger::LoggerSupport
         include MonitorMixin
+        include TivoHMO::Config::Mixin
 
         attr_reader :delegate
         attr_accessor :category_type, :category_value
 
-        def initialize(delegate, category_type, category_value=nil)
+        config_register(:enable_subtitles, true,
+                        "For items that have subtitles, adds entries that will transcode with those subtitles hardcoded")
+
+        def initialize(delegate, category_type, category_value=nil, presorted=false)
           # delegate is a Plex::Section
           @delegate = delegate
 
           super(delegate.key)
+          self.presorted = presorted
 
           self.category_type = category_type
           self.category_value = category_value
@@ -27,20 +32,33 @@ module TivoHMO
 
           self.modified_at = Time.at(delegate.updated_at.to_i)
           self.created_at = Time.now
+          @subtitles = config_get(:enable_subtitles)
+        end
+
+        alias_method :super_children, :children
+
+        def child_count
+          super_children.size
         end
 
         def children
           synchronize do
 
-            delegate.refresh
-            new_modified_at = delegate.updated_at.to_i
+            # updated_at doesn't get updated for automatic updates, only
+            # for updating from within plex media server web ui
+            section_id = delegate.key.split('/').last
+            new_delegate = delegate.library.section!(section_id)
+            new_modified_at = new_delegate.updated_at.to_i
             if new_modified_at > modified_at.to_i
               logger.info "Plex section was updated, refreshing"
+              @delegate = new_delegate
               self.modified_at = Time.at(new_modified_at)
               super.clear
             end
 
-            if super.blank?
+            if super.blank? || @subtitles != config_get(:enable_subtitles)
+              super.clear
+              @subtitles = config_get(:enable_subtitles)
 
               if category_value
                 listing = delegate.send(category_type, category_value[:key])
@@ -50,9 +68,9 @@ module TivoHMO
 
               Array(listing).each do |media|
                 if media.is_a?(::Plex::Movie)
-                  add_child(Movie.new(media))
+                  add_grouped(Movie, media)
                 elsif media.is_a?(::Plex::Episode)
-                  add_child(Episode.new(media))
+                  add_grouped(Episode, media)
                 elsif media.is_a?(::Plex::Show)
                   add_child(Show.new(media))
                 else
@@ -65,6 +83,69 @@ module TivoHMO
           super
         end
 
+        def add_grouped(item_class, item_delegate)
+          primary = item_class.new(item_delegate)
+
+          if config_get(:enable_subtitles)
+            subs = find_subtitles(item_delegate)
+
+            if subs.size > 0
+              group = Group.new(primary.identifier, primary.title)
+              add_child(group)
+              group.add_child(primary)
+              subs.each {|s| group.add_child(item_class.new(item_delegate, s)) }
+            else
+              add_child(primary)
+            end
+          else
+            add_child(primary)
+          end
+        end
+
+        def find_subtitles(item_delegate)
+          subs = []
+
+          source_filename = CGI.unescape(item_delegate.medias.first.parts.first.file)
+
+          item_delegate.medias.each do |media|
+            media.parts.each do |part|
+              prev_stream_count = 0
+              part.streams.each do |stream|
+
+                # stream.stream_type 3=subs, 1=video, 2=audio
+                # stream.key.present? means file based srt
+                # stream.index and no key, means embedded
+                if stream.stream_type.to_i == 3
+                  if %w[key language language_code].all? {|m| stream.respond_to?(m) && stream.send(m).present? }
+                    st = TivoHMO::API::Subtitle.new
+                    st.language = stream.language
+                    st.language_code = stream.language_code
+                    st.format = stream.codec
+                    st.type = :file
+                    st.location = source_filename.chomp(File.extname(source_filename))
+                    subs << st
+                  elsif stream.respond_to?(:index) && stream.index.present?
+                    st = TivoHMO::API::Subtitle.new
+                    st.language = stream.respond_to?(:language) && stream.language || "Embedded"
+                    st.language_code = stream.respond_to?(:language_code) && stream.language_code || "???"
+                    st.format = stream.codec
+                    st.type = :embedded
+                    # subtitle index should be the index amongst just the embedded subtitle streams
+                    st.location = stream.index.to_i - prev_stream_count
+                    subs << st
+                  else
+                    logger.warn "Unrecognized subtitle for #{item_delegate.title}"
+                  end
+                end
+
+                prev_stream_count += 1
+              end
+            end
+          end
+
+          subs
+        end
+
       end
 
     end

data/lib/tivohmo/adapters/plex/episode.rb

@@ -7,16 +7,25 @@ module TivoHMO
       class Episode
         include TivoHMO::API::Item
         include GemLogger::LoggerSupport
+        include TivoHMO::Config::Mixin
 
-        attr_reader :delegate
+        attr_reader :delegate, :subtitle
 
-        def initialize(delegate)
+        config_register(:group_with_zap2it, true,
+                        "Use zap2it ID for grouping episodes (Gives thumbnail in My Shows, but can cause problems)")
+
+        def initialize(delegate, subtitle=nil)
           # delegate is a Plex::Episode
           @delegate = delegate
 
           super(delegate.key)
 
+          self.file = CGI.unescape(delegate.medias.first.parts.first.file)
+          self.subtitle = subtitle
+
           self.title = delegate.title
+          self.title = "[#{subtitle.language_code} sub] #{self.title}" if subtitle
+
           self.modified_at = Time.at(delegate.updated_at.to_i)
           self.created_at = Time.parse(delegate.originally_available_at) rescue nil
           self.created_at ||= Time.at(delegate.added_at.to_i)
@@ -29,7 +38,7 @@ module TivoHMO
 
             md.original_air_date = Time.parse(delegate.originally_available_at) rescue nil
 
-            rating_name = delegate.content_rating.upcase
+            rating_name = delegate.content_rating.upcase rescue nil
             rating_value = TivoHMO::API::Metadata::TV_RATINGS[rating_name]
             if rating_value
               md.tv_rating = {name: rating_name, value: rating_value}
@@ -43,6 +52,13 @@ module TivoHMO
 
             md.series_id = lookup_series_id
 
+            md.actors = delegate.roles.collect(&:tag) rescue nil
+            md.series_genres = delegate.genres.collect(&:tag) rescue nil
+
+            %w[writers directors producers].each do |md_name|
+              md.send("#{md_name}=", delegate.send(md_name).collect(&:tag)) rescue nil
+            end
+
           rescue => e
             logger.log_exception e, "Failed to read plex metadata for #{self}"
           end
@@ -52,20 +68,23 @@ module TivoHMO
 
         # groups tv shows under same name if we can extract a seriesId
         def lookup_series_id
-          series_id = nil
+          series_id = "SH%08i" % delegate.season.show.key.scan(/\d+/).first.to_i
 
           guid = delegate.guid
           if guid =~ /thetvdb:\/\/(\d+)/
             # zap2it ids allow tivo to show a relevant thumbnail image for the
             # series in the My Shows UI.
             tvdb_series_id = $1
-            begin
-              tvdb_series = TVDBHelper.instance.find_by_id(tvdb_series_id)
-              series_id = tvdb_series.zap2it_id
-              series_id = series_id.sub(/^EP/, 'SH')
-              logger.debug "Using zap2it series id: #{series_id}"
-            rescue => e
-              logger.log_exception e, "Failed to get zap2it series id", level: :warn
+
+            if config_get(:group_with_zap2it)
+              begin
+                tvdb_series = TVDBHelper.instance.find_by_id(tvdb_series_id)
+                series_id = tvdb_series.zap2it_id
+                series_id = series_id.sub(/^EP/, 'SH')
+                logger.debug "Using zap2it series id: #{series_id}"
+              rescue => e
+                logger.log_exception e, "Failed to get zap2it series id", level: :warn
+              end
             end
 
             series_id ||= "SH#{tvdb_series_id}"

data/lib/tivohmo/adapters/plex/group.rb

@@ -0,0 +1,20 @@
+module TivoHMO
+  module Adapters
+    module Plex
+
+      class Group
+        include TivoHMO::API::Container
+        include GemLogger::LoggerSupport
+
+        def initialize(ident, title)
+          super(ident)
+
+          self.presorted = true
+          self.title = title
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tivohmo/adapters/plex/movie.rb

@@ -6,15 +6,20 @@ module TivoHMO
         include TivoHMO::API::Item
         include GemLogger::LoggerSupport
 
-        attr_reader :delegate
+        attr_reader :delegate, :subtitle
 
-        def initialize(delegate)
+        def initialize(delegate, subtitle=nil)
           # delegate is a Plex::Movie
           @delegate = delegate
 
           super(delegate.key)
 
+          self.file = CGI.unescape(delegate.medias.first.parts.first.file)
+          self.subtitle = subtitle
+
           self.title = delegate.title
+          self.title = "[#{subtitle.language_code} sub] #{self.title}" if subtitle
+
           self.modified_at = Time.at(delegate.updated_at.to_i)
           self.created_at = Time.parse(delegate.originally_available_at) rescue nil
           self.created_at ||= Time.at(delegate.added_at.to_i)
@@ -27,12 +32,19 @@ module TivoHMO
 
             md.movie_year = Time.parse(delegate.originally_available_at).year rescue nil
 
-            rating_name = delegate.content_rating.upcase
+            rating_name = delegate.content_rating.upcase rescue nil
             rating_value = TivoHMO::API::Metadata::MPAA_RATINGS[rating_name]
             if rating_value
               md.mpaa_rating = {name: rating_name, value: rating_value}
             end
 
+            md.actors = delegate.roles.collect(&:tag) rescue nil
+            md.program_genres = delegate.genres.collect(&:tag) rescue nil
+
+            %w[writers directors producers].each do |md_name|
+              md.send("#{md_name}=", delegate.send(md_name).collect(&:tag)) rescue nil
+            end
+
           rescue => e
             logger.log_exception e, "Failed to read plex metadata for #{self}"
           end

data/lib/tivohmo/adapters/plex/qualified_category.rb

@@ -15,6 +15,7 @@ module TivoHMO
           @delegate = delegate
 
           super(delegate.key)
+          self.presorted = true
 
           self.category_type = category_type
           self.category_qualifier = category_qualifier
@@ -23,13 +24,23 @@ module TivoHMO
           self.created_at = Time.now
         end
 
+        alias_method :super_children, :children
+
+        def child_count
+          super_children.size
+        end
+
         def children
           synchronize do
 
-            delegate.refresh
-            new_modified_at = delegate.updated_at.to_i
+            # updated_at doesn't get updated for automatic updates, only
+            # for updating from within plex media server web ui
+            section_id = delegate.key.split('/').last
+            new_delegate = delegate.library.section!(section_id)
+            new_modified_at = new_delegate.updated_at.to_i
             if new_modified_at > modified_at.to_i
               logger.info "Plex section was updated, refreshing"
+              @delegate = new_delegate
               self.modified_at = Time.at(new_modified_at)
               super.clear
             end
@@ -39,7 +50,7 @@ module TivoHMO
               # Sort by title descending so that creation times are
               # correct for tivo sort of newest first (Time.now for
               # created_at in Category)
-              qualified = qualified.sort_by{|c| c[:title] }.reverse
+              qualified = qualified.sort_by{|c| c[:title] }
               qualified.each do |category_value|
                 add_child(Category.new(delegate, category_type, category_value))
               end

data/lib/tivohmo/adapters/plex/season.rb

@@ -16,8 +16,8 @@ module TivoHMO
           super(delegate.key)
 
           self.title = delegate.title
-#          self.modified_at = Time.at(delegate.updated_at.to_i)
-#          self.created_at = Time.at(delegate.added_at.to_i)
+          self.modified_at = Time.at(delegate.updated_at.to_i) rescue nil
+          self.created_at = Time.at(delegate.added_at.to_i) rescue nil
         end
 
         def children

data/lib/tivohmo/adapters/plex/section.rb

@@ -34,11 +34,11 @@ module TivoHMO
               add_child(QualifiedCategory.new(delegate, :by_first_character, :first_characters))
 
               #add_child(Category.new(delegate, :unwatched))
-              add_child(Category.new(delegate, :on_deck))
-              add_child(Category.new(delegate, :newest))
-              add_child(Category.new(delegate, :recently_viewed))
-              add_child(Category.new(delegate, :recently_added))
-              add_child(Category.new(delegate, :all))
+              add_child(Category.new(delegate, :on_deck, nil, true))
+              add_child(Category.new(delegate, :newest, nil, true))
+              add_child(Category.new(delegate, :recently_viewed, nil, true))
+              add_child(Category.new(delegate, :recently_added, nil, true))
+              add_child(Category.new(delegate, :all, nil, true))
             end
           end
 

data/lib/tivohmo/adapters/plex/transcoder.rb

@@ -9,7 +9,11 @@ module TivoHMO
 
         def initialize(item)
           super(item)
-          self.source_filename = CGI.unescape(item.delegate.medias.first.parts.first.file)
+        end
+
+        def transcode(writeable_io, format="video/x-tivo-mpeg")
+          # TODO: mark as watched in plex
+          super
         end
 
       end

data/lib/tivohmo/adapters/plex.rb

@@ -1,6 +1,7 @@
 require 'plex-ruby'
 require_relative 'plex/movie'
 require_relative 'plex/episode'
+require_relative 'plex/group'
 require_relative 'plex/season'
 require_relative 'plex/show'
 require_relative 'plex/category'

data/lib/tivohmo/adapters/settings/application.rb

@@ -0,0 +1,37 @@
+module TivoHMO
+  module Adapters
+    module Settings
+
+      # An Application for live modification of settings
+      class Application
+        include TivoHMO::API::Application
+        include GemLogger::LoggerSupport
+        include MonitorMixin
+
+        def initialize(identifier)
+          super("Settings")
+
+          self.metadata_class = TivoHMO::Adapters::Settings::Metadata
+          self.transcoder_class = TivoHMO::Adapters::Settings::Transcoder
+          self.title = self.identifier
+          self.presorted = true
+        end
+
+        def children
+          synchronize do
+            if super.blank?
+              Config.instance.known_config.keys.sort.each do |k|
+                add_child(KeyContainer.new(k))
+              end
+              add_child(ResetDefaultsItem.new)
+            end
+          end
+
+          super
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tivohmo/adapters/settings/display_item.rb

@@ -0,0 +1,35 @@
+require 'active_support/core_ext/string/inflections'
+require 'listen'
+
+module TivoHMO
+  module Adapters
+    module Settings
+
+      # An Item for displaying a string
+      class DisplayItem
+        include TivoHMO::API::Item
+        include GemLogger::LoggerSupport
+        include MonitorMixin
+
+        def initialize(name, description=nil)
+          super(name)
+          @description = description
+        end
+
+        def metadata
+          md = super
+
+          if @description.nil?
+            md.description = "Nothing to do here, hit back to return"
+          else
+            md.description = @description + ".  Nothing to do here, hit back to return"
+          end
+
+          md
+        end
+
+      end
+
+    end
+  end
+end