tivohmo 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75d19e33d89ef251caa838694011d40532beb39d
-  data.tar.gz: ba27d1117f29cb07106b90d152452fe93bae97cb
+  metadata.gz: 6513addd49cd73d0c775c59dc61f1b50c1efb335
+  data.tar.gz: f1e455479caff464c3bfd800ca7debd5aa2ed57c
 SHA512:
-  metadata.gz: b0d86c363409dbc0527e802c483cfc439c6d088439a898f32c1288fb56c88fdee8e8a03ce6a51cc8a7efa30ba29e037827ac643e1c04bee08c6ebb5bc53dca78
-  data.tar.gz: 5644691da75bed304c6e862ab4e7660372f6684663bb5d621272259fdb6cb89f00d51b264680ce4a8aa4b7fbcabd1f54d0ca9312364da1e8728818be00acdc1a
+  metadata.gz: 1c53ffcccd988944ebb7e95ce86a722052ec42198ca1b01d41e26ce71f5e0230652b7585244414b8ab8f9575a1fd5d0dc3e25f8fde1466ec12cb6af27f3f8627
+  data.tar.gz: c00d7b88d4551f34fcace28ebd0bd9b714dc8f21926ce3581e918965a77a87d67f5a61f4e1d8bde6e045117bba0044500be3736b58490d56a7f98353f23c3cb1

data/CHANGELOG

@@ -1,3 +1,14 @@
+0.2.0 (11/23/2014)
+------------------
+
+add more metadata from plex <d048373> [Matt Conway]
+add version as option and to normal startup messaging Capture stdout/err to logfile when provided <dd4bae7> [Matt Conway]
+force encoding for detail xml in tivo_header handle negative ItemCount for tivo jump to end of list command <8229e22> [Matt Conway]
+more function launchagent script <51e62de> [Matt Conway]
+refactor plex metadata <76825e7> [Matt Conway]
+unescape filename from plex <0502964> [Matt Conway]
+use forked streamio-ffmpeg (due to lack of maintenance) to allow use with ffmpeg 2.4.x <c7e16e1> [Matt Conway]
+
 0.1.4 (10/12/2014)
 ------------------
 

data/contrib/tivohmo.plist

@@ -3,7 +3,7 @@
 <!--
 Launchd (OS X) configuration for TivoHMO
 Copy to ~/Library/LaunchAgents and edit as desired
-Then to start the server, run: launchd load ~/Library/LaunchAgents/tivohmo.plist
+Then to start the server, run: launchctl load ~/Library/LaunchAgents/tivohmo.plist
 -->
 
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
@@ -13,10 +13,14 @@ Then to start the server, run: launchd load ~/Library/LaunchAgents/tivohmo.plist
         <string>TivoHMO</string>
         <key>ProgramArguments</key>
         <array>
-                <string>tivohmo</string>
-                <string>/usr/local/pytivo/pyTivo.py</string>
+                <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>
         </array>
         <key>RunAtLoad</key>
         <true/>
+        <key>KeepAlive</key>
+        <true/>
 </dict>
 </plist>

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

@@ -19,6 +19,32 @@ module TivoHMO
           self.created_at = Time.at(delegate.added_at.to_i)
         end
 
+        def metadata
+          md = super
+
+          md.original_air_date = Time.parse(delegate.originally_available_at) rescue nil
+
+          rating_name = delegate.content_rating.upcase
+          rating_value = TivoHMO::API::Metadata::TV_RATINGS[rating_name]
+          if rating_value
+            md.tv_rating = {name: rating_name, value: rating_value}
+          end
+
+          md.is_episode = true
+          md.episode_number = "%i%02i" % [delegate.parent_index, delegate.index]
+          md.series_title = delegate.grandparent_title
+          md.episode_title = "%i - %s" % [md.episode_number, title]
+          md.title = "%s - %s" % [delegate.grandparent_title, title]
+
+          # group tv shows under same name if we can extract a seriesId
+          guid = delegate.guid
+          if guid =~ /thetvdb:\/\/(\d+)/
+            md.series_id = "SH#{$1}"
+          end
+
+          md
+        end
+
       end
 
     end

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

@@ -12,6 +12,13 @@ module TivoHMO
           begin
             self.description = item.delegate.summary
             self.duration = (item.delegate.duration.to_i / 1000).to_i
+
+            # plex 0-10 => tivo 1-7 for value, 0-4 in .5 increments for name
+            plex_rating = item.delegate.rating.to_f
+            rating_value = (plex_rating / 10 * 6).round
+            rating_name = [1, 1.5, 2, 2.5, 3, 3.5, 4][rating_value]
+            self.star_rating = {name: rating_name, value: rating_value + 1}
+
           rescue => e
             logger.error "Failed to read plex metadata: #{e}"
           end

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

@@ -19,6 +19,19 @@ module TivoHMO
           self.created_at = Time.at(delegate.added_at.to_i)
         end
 
+        def metadata
+          md = super
+          md.movie_year = Time.parse(delegate.originally_available_at).year rescue nil
+
+          rating_name = delegate.content_rating.upcase
+          rating_value = TivoHMO::API::Metadata::MPAA_RATINGS[rating_name]
+          if rating_value
+            md.mpaa_rating = {name: rating_name, value: rating_value}
+          end
+
+          md
+        end
+
       end
 
     end

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

@@ -9,7 +9,7 @@ module TivoHMO
 
         def initialize(item)
           super(item)
-          self.source_filename = item.delegate.medias.first.parts.first.file
+          self.source_filename = CGI.unescape(item.delegate.medias.first.parts.first.file)
         end
 
       end

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

@@ -35,9 +35,9 @@ module TivoHMO
 
         def transcoder_options(format="video/x-tivo-mpeg")
           opts = {
-              video_max_bitrate: 30000,
+              video_max_bitrate: 30_000_000,
               buffer_size: 4096,
-              audio_bitrate: 448,
+              audio_bitrate: 448_000,
               format: format,
               custom: []
           }
@@ -47,6 +47,7 @@ module TivoHMO
           opts = select_video_codec(opts)
           opts = select_video_bitrate(opts)
           opts = select_audio_codec(opts)
+          opts = select_audio_bitrate(opts)
           opts = select_audio_sample_rate(opts)
           opts = select_container(opts)
 
@@ -96,6 +97,13 @@ module TivoHMO
           opts
         end
 
+        def select_audio_bitrate(opts)
+          # transcode assumes unit of Kbit, whilst video_info has unit of bit
+          opts[:audio_bitrate] = (opts[:audio_bitrate] / 1000).to_i
+
+          opts
+        end
+
         def select_audio_codec(opts)
           if video_info[:audio_codec]
             if AUDIO_CODECS.any? { |ac| video_info[:audio_codec] =~ /#{ac}/ }
@@ -111,18 +119,24 @@ module TivoHMO
         end
 
         def select_video_bitrate(opts)
-
           vbr = video_info[:video_bitrate]
+          default_vbr = 16_384_000
 
           if vbr && vbr > 0
             if vbr >= opts[:video_max_bitrate]
-              opts[:video_bitrate] = (video_info[:video_max_bitrate] * 0.95).to_i
-            else
+              opts[:video_bitrate] = (opts[:video_max_bitrate] * 0.95).to_i
+            elsif vbr > default_vbr
               opts[:video_bitrate] = vbr
+            else
+              opts[:video_bitrate] = default_vbr
             end
           end
 
-          opts[:video_bitrate] ||= 16384
+          opts[:video_bitrate] ||= default_vbr
+
+          # transcode assumes unit of Kbit, whilst video_info has unit of bit
+          opts[:video_bitrate] = (opts[:video_bitrate] / 1000).to_i
+          opts[:video_max_bitrate] = (opts[:video_max_bitrate] / 1000).to_i
 
           opts
         end
@@ -141,7 +155,6 @@ module TivoHMO
         end
 
         def select_video_dimensions(opts)
-          preserve_aspect = nil
           video_width = video_info[:width].to_i
           VIDEO_WIDTHS.each do |w|
             w = w.to_i
@@ -163,34 +176,37 @@ module TivoHMO
             end
           end
           video_height = VIDEO_HEIGHTS.last.to_i unless video_height
+
           opts[:resolution] = "#{video_width}x#{video_height}"
-          opts[:preserve_aspect_ratio] = :height unless opts[:preserve_aspect_ratio]
+          opts[:preserve_aspect_ratio] ||= :height
           opts
         end
 
         def select_video_frame_rate(opts)
 
-          frame_rate = video_info[:frame_rate].to_f
-          VIDEO_FRAME_RATES.each do |r|
-            if frame_rate >= r.to_f
-              opts[:frame_rate] = r
-              break
-            end
+          frame_rate = video_info[:frame_rate]
+          if frame_rate =~ /\A[0-9\.]+\Z/
+            frame_rate = frame_rate.to_f
+          elsif frame_rate =~ /\A\((\d+)\/(\d+)\)\Z/
+            frame_rate = $1.to_f / $2.to_f
           end
 
-          opts[:frame_rate] ||= 29.97
+          VIDEO_FRAME_RATES.each do |r|
+            opts[:frame_rate] = r
+            break if frame_rate >= r.to_f
+          end
 
           opts
         end
 
         def run_transcode(output_filename, format)
 
-          logger.debug "Movie Info: " +
+          logger.info "Movie Info: " +
                           video_info.collect {|k, v| "#{k}=#{v.inspect}"}.join(' ')
 
           opts = transcoder_options(format)
 
-          logger.debug "Transcoding options: " +
+          logger.info "Transcoding options: " +
                            opts.collect {|k, v| "#{k}='#{v}'"}.join(' ')
 
 

data/lib/tivohmo/api/metadata.rb

@@ -6,6 +6,21 @@ module TivoHMO
       extend ActiveSupport::Concern
       include GemLogger::LoggerSupport
 
+      MPAA_RATINGS = {
+          'G' => 1, 'PG' => 2, 'PG-13' => 3, 'PG13' => 3, 'R' => 4, 'X' => 5,
+          'NC-17' => 6, 'NC17' => 6, 'NR' => 8, 'UNRATED' => 8, 'G1' => 1,
+          'P2' => 2, 'P3' => 3, 'R4' => 4, 'X5' => 5, 'N6' => 6, 'N8' => 8
+      }
+
+      TV_RATINGS = {
+          'TV-Y7' => 1, 'TV-Y' => 2, 'TV-G' => 3, 'TV-PG' => 4, 'TV-14' => 5,
+          'TV-MA' => 6, 'TV-NR' => 7, 'TVY7' => 1, 'TVY' => 2, 'TVG' => 3,
+          'TVPG' => 4, 'TV14' => 5, 'TVMA' => 6, 'TVNR' => 7, 'Y7' => 1,
+          'Y' => 2, 'G' => 3, 'PG' => 4, '14' => 5, 'MA' => 6, 'NR' => 7,
+          'UNRATED' => 7, 'X1' => 1, 'X2' => 2, 'X3' => 3, 'X4' => 4, 'X5' => 5,
+          'X6' => 6, 'X7' => 7
+      }
+
       attr_accessor :item,
 
                     :title,

data/lib/tivohmo/cli.rb

@@ -42,6 +42,10 @@ module TivoHMO
            :flag, "debug output\n",
            default: false
 
+    option ["-v", "--version"],
+           :flag, "print version and exit\n",
+           default: false
+
     option ["-r", "--preload"],
            :flag, "Preloads all lazy container listings\n",
            default: false
@@ -83,8 +87,15 @@ module TivoHMO
            "LIMIT:INTERVAL", "configure beacon limit and/or interval\n"
 
     def execute
+      if version?
+        puts "TivoHMO Version #{TivoHMO::VERSION}"
+        return
+      end
+
       setup_logging
 
+      logger.info "TivoHMO #{TivoHMO::VERSION} starting up"
+
       if configuration
         config = YAML.load_file(configuration)
 
@@ -146,12 +157,21 @@ module TivoHMO
       Logging.logger.root.level = :debug if debug?
 
       if logfile.present?
-        Logging.logger.root.appenders = Logging.appenders.file(
+        appender = Logging.appenders.rolling_file(
             logfile,
+            truncate: true,
+            age: 'daily',
+            keep: 3,
             layout: Logging.layouts.pattern(
                 pattern: Logging.appenders.stdout.layout.pattern
             )
         )
+
+        # hack to assign stdout/err to logfile if logging to file
+        io = appender.instance_variable_get(:@io)
+        $stdout = $stderr = io
+
+        Logging.logger.root.appenders = appender
       end
     end
 

data/lib/tivohmo/server.rb

@@ -147,6 +147,8 @@ module TivoHMO
         end
 
         item_details_xml = builder :item_details, layout: true, locals: {item: item}
+        item_details_xml.force_encoding('ascii-8bit')
+
         ld = item_details_xml.bytesize
         chunk = item_details_xml + '\0' * (pad(ld, 4) + 4)
         lc = chunk.bytesize
@@ -233,6 +235,11 @@ module TivoHMO
             else
               logger.warn "Anchor not found: #{anchor_item}"
             end
+          else
+            if item_count < 0
+              locals[:item_start] = children.size + item_count
+              locals[:item_count] = - item_count
+            end
           end
 
           if container.root?

data/lib/tivohmo/version.rb

@@ -1,3 +1,3 @@
 module TivoHMO
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/spec/adapters/plex/episode_spec.rb

@@ -3,7 +3,13 @@ require 'tivohmo/adapters/plex'
 
 describe TivoHMO::Adapters::Plex::Episode do
 
-  let(:plex_delegate) { plex_stub(::Plex::Episode) }
+  let(:plex_delegate) { plex_stub(::Plex::Episode,
+                                  content_rating: 'G',
+                                  index: 2,
+                                  parent_index: 1,
+                                  grandparent_title: 'ShowTitle',
+                                  guid: "com.plexapp.agents.thetvdb://269650/1/2?lang=en",
+                                  originally_available_at: "2014-06-04") }
 
   describe "#initialize" do
 
@@ -19,4 +25,22 @@ describe TivoHMO::Adapters::Plex::Episode do
 
   end
 
+  describe "#metadata" do
+
+    it "should populate metadata" do
+      episode = described_class.new(plex_delegate)
+      episode.app = TivoHMO::Adapters::Plex::Application.new('localhost')
+      md = episode.metadata
+      expect(md.original_air_date).to eq(Time.parse(plex_delegate.originally_available_at))
+      expect(md.tv_rating).to eq({name: 'G', value: 3})
+      expect(md.is_episode).to eq(true)
+      expect(md.episode_number).to eq("102")
+      expect(md.series_title).to eq("ShowTitle")
+      expect(md.episode_title).to eq("102 - Title")
+      expect(md.title).to eq("ShowTitle - Title")
+      expect(md.series_id).to eq("SH269650")
+    end
+
+  end
+
 end

data/spec/adapters/plex/metadata_spec.rb

@@ -5,7 +5,8 @@ describe TivoHMO::Adapters::Plex::Metadata do
 
   let(:plex_delegate) { plex_stub(::Plex::Movie,
                                   summary: 'Summary',
-                                  duration: 10000) }
+                                  duration: 10000,
+                                  rating: 10) }
 
   let(:item) { double('item', delegate: plex_delegate)}
 
@@ -17,6 +18,7 @@ describe TivoHMO::Adapters::Plex::Metadata do
       expect(md).to be_a TivoHMO::API::Metadata
       expect(md.duration).to eq(plex_delegate.duration / 1000)
       expect(md.description).to eq plex_delegate.summary
+      expect(md.star_rating).to eq({name: 4, value: 7})
     end
 
   end

data/spec/adapters/plex/movie_spec.rb

@@ -3,7 +3,9 @@ require 'tivohmo/adapters/plex'
 
 describe TivoHMO::Adapters::Plex::Movie do
 
-  let(:plex_delegate) { plex_stub(::Plex::Movie) }
+  let(:plex_delegate) { plex_stub(::Plex::Movie,
+                                  originally_available_at: "2013-01-02",
+                                  content_rating: 'G') }
 
   describe "#initialize" do
 
@@ -19,4 +21,16 @@ describe TivoHMO::Adapters::Plex::Movie do
 
   end
 
+  describe "#metadata" do
+
+    it "should populate metadata" do
+      movie = described_class.new(plex_delegate)
+      movie.app = TivoHMO::Adapters::Plex::Application.new('localhost')
+      md = movie.metadata
+      expect(md.movie_year).to eq(2013)
+      expect(md.mpaa_rating).to eq({name: 'G', value: 1})
+    end
+
+  end
+
 end

data/spec/adapters/plex/transcoder_spec.rb

@@ -9,7 +9,7 @@ describe TivoHMO::Adapters::Plex::Transcoder do
                                   duration: 10000,
                                   medias: [double('media',
                                                  parts: [double('part',
-                                                                file: '/foo')])])}
+                                                                file: '/foo%20bar')])])}
 
   let(:item) { double('item', identifier: plex_delegate.key, delegate: plex_delegate)}
 
@@ -19,7 +19,7 @@ describe TivoHMO::Adapters::Plex::Transcoder do
       trans = described_class.new(item)
       expect(trans).to be_a described_class
       expect(trans).to be_a TivoHMO::API::Transcoder
-      expect(trans.source_filename).to eq '/foo'
+      expect(trans.source_filename).to eq '/foo bar'
     end
 
   end

data/spec/cli_spec.rb

@@ -39,6 +39,16 @@ describe TivoHMO::CLI do
 
   end
 
+  describe "--version" do
+
+    it "produces version text under standard width" do
+      expect(cli).to receive(:setup_logging).never
+      expect($stdout).to receive(:puts).with(/#{TivoHMO::VERSION}/)
+      cli.run(["--version"])
+    end
+
+  end
+
   describe "--debug" do
 
     it "defaults to info log level" do

data/spec/server_spec.rb

@@ -385,6 +385,22 @@ describe TivoHMO::Server do
           expect(child_titles).to match_array(["i1", "i2", "i3"])
         end
 
+        it "honors negative ItemCount (jump to last page)" do
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&ItemCount=-3"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          expect(doc.at_xpath("/TiVoContainer/ItemStart").content).to eq("17")
+          expect(doc.at_xpath("/TiVoContainer/ItemCount").content).to eq("3")
+
+          expect(doc.at_xpath("/TiVoContainer/Details/TotalItems").content).to eq("20")
+
+          expect(doc.xpath("/TiVoContainer/Item").size).to eq (3)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to match_array(["i18", "i19", "i20"])
+        end
+
         it "displays page 2" do
           get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&ItemStart=7"
           expect(last_response.status).to eq(200)

data/spec/spec_helper.rb

@@ -109,6 +109,9 @@ def plex_stub(clazz, method_stubs={})
   default_stubs = {
     key: '/some/key',
     title: 'Title',
+    summary: 'Summary',
+    duration: 100,
+    rating: 1,
     updated_at: Time.now.to_i,
     added_at: Time.now.to_i,
     refresh: nil

data/tivohmo.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
 
   # filesystem adapter dependencies, make optional?
   spec.add_dependency "listen"
-  spec.add_dependency "streamio-ffmpeg"
+  spec.add_dependency "tivohmo-streamio-ffmpeg"
 
   # plex adapter dependencies, make optional?
   spec.add_dependency "plex-ruby"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tivohmo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Conway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -249,7 +249,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: streamio-ffmpeg
+  name: tivohmo-streamio-ffmpeg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -415,3 +415,4 @@ test_files:
 - spec/cli_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
+has_rdoc: