tivohmo 0.1.0

data/spec/server_spec.rb

@@ -0,0 +1,458 @@
+require_relative "spec_helper"
+require 'rack/test'
+require 'nokogiri'
+
+Sinatra::Base.set :environment, :test
+
+describe TivoHMO::Server do
+  include Rack::Test::Methods
+
+  let(:application) do
+    a = TestAPI::Application.new('a1')
+    a.metadata_class = TestAPI::Metadata
+    a.transcoder_class = TestAPI::Transcoder
+    a
+  end
+
+  let(:server) do
+    s = TivoHMO::API::Server.new
+    s.add_child(application)
+    s
+  end
+
+  # for Rack::Test
+  let(:app) { TivoHMO::Server.new(server) }
+
+  before(:each) do
+    make_api_tree(application, c1: ['i1'])
+  end
+
+  let(:container) { server.find('/a1/c1') }
+  let(:item) { server.find('/a1/c1/i1') }
+  let(:helpers) { (Class.new { include TivoHMO::Server::Helpers }).new }
+
+  describe "helpers" do
+
+    include Rack::Utils
+
+    describe "#item_url" do
+
+      it "uses title_path as url" do
+        expect(helpers.item_url(item)).to eq item.title_path
+      end
+
+    end
+
+    describe "#container_url" do
+
+      it "generates a url" do
+        url = helpers.container_url(container)
+        uri = URI(url)
+        expect(uri.path).to eq("/TiVoConnect")
+        expect(parse_query(uri.query)).to eq('Command' => 'QueryContainer',
+                                             'Container' => container.title_path)
+      end
+
+    end
+
+    describe "#item_detail_url" do
+
+      it "generates a url" do
+        url = helpers.item_detail_url(item)
+        uri = URI(url)
+        expect(uri.path).to eq("/TiVoConnect")
+        expect(parse_query(uri.query)).to eq('Command' => 'TVBusQuery',
+                                             'Container' => 'a1',
+                                             'File' => 'c1/i1')
+      end
+
+    end
+
+    describe "#format_uuid" do
+
+      it "uses crc to format" do
+        uuid = SecureRandom.uuid
+        expect(helpers.format_uuid(uuid)).to eq(Zlib.crc32(uuid))
+      end
+
+    end
+
+    describe "#format_date" do
+
+      it "produces date as hex" do
+        date = Time.now
+        expect(helpers.format_date(date)).to eq("0x#{date.to_i.to_s(16)}")
+      end
+
+    end
+
+    describe "#format_iso_date" do
+
+      it "is empty string for nil" do
+        date = nil
+        expect(helpers.format_iso_date(date)).to eq("")
+      end
+
+      it "is formatted for real date" do
+        date = Time.now
+        expect(helpers.format_iso_date(date)).to eq(date.utc.strftime("%FT%T.%6N"))
+      end
+
+    end
+
+    describe "#format_iso_duration" do
+
+      it "is empty string for nil" do
+        expect(helpers.format_iso_duration(nil)).to eq("")
+      end
+
+      it "produces iso formatted string" do
+        duration = (1 * 86400) + (1 * 3600) + (1 * 60) + 1
+        expect(helpers.format_iso_duration(duration)).to eq('P1DT1H1M1S')
+      end
+
+    end
+
+    describe "#tivo_header" do
+
+      it "determines pad length" do
+        expect(helpers.pad(7, 4)).to eq(1)
+      end
+
+      it "tivo_header" do
+        expect(helpers).to receive(:builder).
+                               with(:item_details, layout: true, locals: {item: item}).
+                               and_return("<TvBusMarshalledStruct/>")
+        expect(helpers.tivo_header(item, 'video/x-tivo-mpeg')).to include('TvBusMarshalledStruct')
+      end
+
+    end
+
+  end
+
+  describe "TivoConnect" do
+
+    it "should fail for no command" do
+      get '/TiVoConnect'
+      expect(last_response.status).to eq(404)
+    end
+
+    it "should have a stub response for ResetServer" do
+      get '/TiVoConnect?Command=ResetServer'
+      expect(last_response.status).to eq(200)
+    end
+
+    it "should have a stub response for FlushServer" do
+      get '/TiVoConnect?Command=FlushServer'
+      expect(last_response.status).to eq(200)
+    end
+
+    it "should have a stub response for QueryItem" do
+      get '/TiVoConnect?Command=QueryItem'
+      expect(last_response.status).to eq(200)
+    end
+
+    it "should have a response for QueryServer" do
+      get '/TiVoConnect?Command=QueryServer'
+      expect(last_response.status).to eq(200)
+      doc = Nokogiri::XML(last_response.body)
+      name = doc.at_xpath('/TiVoServer/InternalName').content
+      expect(name).to eq('TivoHMO')
+
+    end
+
+    describe "QueryFormats" do
+
+      it "should have an error for QueryFormats with video" do
+        get '/TiVoConnect?Command=QueryFormats'
+        expect(last_response.status).to eq(404)
+      end
+
+      it "should have a response for QueryFormats" do
+        get '/TiVoConnect?Command=QueryFormats&SourceFormat=video%2Fx-tivo-mpeg'
+        expect(last_response.status).to eq(200)
+        doc = Nokogiri::XML(last_response.body)
+        cts = doc.xpath('/TiVoFormats/Format/ContentType')
+        expect(cts.collect(&:content)).to eq(['video/x-tivo-mpeg', 'video/x-tivo-mpeg-ts'])
+      end
+
+    end
+
+    describe "TVBusQuery" do
+
+      it "fails if it doesn't have params" do
+        get "/TiVoConnect?Command=TVBusQuery"
+        expect(last_response.status).to eq(404)
+      end
+
+      it "fails if it doesn't exist" do
+        get "/TiVoConnect?Command=TVBusQuery&Container=Foo&File=Bar"
+        expect(last_response.status).to eq(404)
+      end
+
+      it "provides item details" do
+        get "/TiVoConnect?Command=TVBusQuery&Container=a1&File=c1/i1"
+        expect(last_response.status).to eq(200)
+        doc = Nokogiri::XML(last_response.body)
+        expect(doc).to_not be_nil
+      end
+
+    end
+
+    describe "QueryContainer" do
+
+      it "displays root if it doesn't have params" do
+        get "/TiVoConnect?Command=QueryContainer"
+        expect(last_response.status).to eq(200)
+        doc = Nokogiri::XML(last_response.body)
+        title = doc.at_xpath("/TiVoContainer/Details/Title").content
+        expect(title).to eq(server.title)
+      end
+
+      it "uses server as root" do
+        get "/TiVoConnect?Command=QueryContainer&Container=/"
+        expect(last_response.status).to eq(200)
+        doc = Nokogiri::XML(last_response.body)
+        title = doc.at_xpath("/TiVoContainer/Details/Title").content
+        expect(title).to eq(server.title)
+      end
+
+      it "renders a container" do
+        container.add_child(TestAPI::Container.new("c2"))
+
+        get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1"
+        expect(last_response.status).to eq(200)
+        doc = Nokogiri::XML(last_response.body)
+        expect(doc.at_xpath("/TiVoContainer/ItemStart").content).to eq("0")
+        expect(doc.at_xpath("/TiVoContainer/ItemCount").content).to eq("2")
+
+        expect(doc.at_xpath("/TiVoContainer/Details/TotalItems").content).to eq("2")
+        expect(doc.at_xpath("/TiVoContainer/Details/Title").content).to eq(container.title_path)
+        expect(doc.at_xpath("/TiVoContainer/Details/ContentType").content).to eq("x-tivo-container/folder")
+        expect(doc.at_xpath("/TiVoContainer/Details/SourceFormat").content).to eq("x-tivo-container/folder")
+        expect(doc.at_xpath("/TiVoContainer/Details/UniqueId").content).to eq(helpers.format_uuid(container.uuid).to_s)
+
+        expect(doc.xpath("/TiVoContainer/Item").size).to eq (2)
+
+        child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+        expect(child_titles).to match_array(["c2", "i1"])
+      end
+
+      it "shows details for child item" do
+        get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1"
+        expect(last_response.status).to eq(200)
+        doc = Nokogiri::XML(last_response.body)
+
+        xml_item = doc.at_xpath("/TiVoContainer/Item")
+        expect(xml_item.at_xpath("Details/Title").content).to eq("i1")
+        expect(xml_item.at_xpath("Details/ContentType").content).to eq(item.content_type)
+        expect(xml_item.at_xpath("Details/SourceFormat").content).to eq(item.source_format)
+        expect(xml_item.at_xpath("Details/CaptureDate").content).to eq(helpers.format_date(item.created_at))
+        expect(xml_item.at_xpath("Details/UniqueId")).to be_nil
+        expect(xml_item.at_xpath("Details/TotalItems")).to be_nil
+        expect(xml_item.at_xpath("Details/LastCaptureDate")).to be_nil
+
+        # if metadata present
+        expect(xml_item.at_xpath("Details/SourceSize").content).to_not be_nil
+
+        xml_details = xml_item.at_xpath("Links/Content")
+        expect(xml_details.at_xpath("Url").content).to eq(helpers.item_url(item))
+        expect(xml_details.at_xpath("ContentType").content).to eq(item.content_type)
+
+        expect(xml_item.at_xpath("Links/CustomIcon").content).to_not be_nil
+
+        expect(xml_item.at_xpath("Links/TiVoVideoDetails/Url").content).to eq(helpers.item_detail_url(item))
+      end
+
+      it "shows details for child container" do
+        c2 = application.add_child(TestAPI::Container.new("c2"))
+        c3 = c2.add_child(TestAPI::Container.new("c3"))
+        c3 << TestAPI::Item.new('i2')
+        c3 << TestAPI::Item.new('i3')
+
+        get "/TiVoConnect?Command=QueryContainer&Container=/a1/c2"
+        expect(last_response.status).to eq(200)
+        doc = Nokogiri::XML(last_response.body)
+
+        xml_item = doc.at_xpath("/TiVoContainer/Item")
+        expect(xml_item.at_xpath("Details/Title").content).to eq("c3")
+        expect(xml_item.at_xpath("Details/ContentType").content).to eq(c3.content_type)
+        expect(xml_item.at_xpath("Details/SourceFormat").content).to eq(c3.source_format)
+        expect(xml_item.at_xpath("Details/UniqueId").content).to eq(helpers.format_uuid(c3.uuid).to_s)
+        expect(xml_item.at_xpath("Details/TotalItems").content).to eq("2")
+        expect(xml_item.at_xpath("Details/LastCaptureDate").content).to eq(helpers.format_date(c3.created_at))
+
+        xml_details = xml_item.at_xpath("Links/Content")
+        expect(xml_details.at_xpath("Url").content).to eq(helpers.container_url(c3))
+        expect(xml_details.at_xpath("ContentType").content).to eq("x-tivo-container/folder")
+
+      end
+
+      describe "sorting" do
+
+        before(:each) do
+          3.times do |i|
+            container.add_child(TestAPI::Item.new("i#{i + 2}"))
+          end
+        end
+
+        it "displays sorted by title" do
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&SortOrder=Title"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to eq(["i1", "i2", "i3", "i4"])
+        end
+
+        it "displays sorted by date" do
+          server.find("/a1/c1/i4").created_at = 4.hours.ago
+          server.find("/a1/c1/i3").created_at = 3.hours.ago
+          server.find("/a1/c1/i2").created_at = 2.hours.ago
+          server.find("/a1/c1/i1").created_at = 1.hour.ago
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&SortOrder=CaptureDate"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to eq(["i4", "i3", "i2", "i1"])
+        end
+
+        it "honors direction" do
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&SortOrder=!Title"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to eq(["i4", "i3", "i2", "i1"])
+        end
+
+      end
+
+      describe "pagination" do
+
+        before(:each) do
+          19.times do |i|
+            container.add_child(TestAPI::Item.new("i#{i + 2}"))
+          end
+        end
+
+        it "displays first page" do
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          expect(doc.at_xpath("/TiVoContainer/ItemStart").content).to eq("0")
+          expect(doc.at_xpath("/TiVoContainer/ItemCount").content).to eq("8")
+
+          expect(doc.at_xpath("/TiVoContainer/Details/TotalItems").content).to eq("20")
+
+          expect(doc.xpath("/TiVoContainer/Item").size).to eq (8)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to match_array(["i1", "i2", "i3", "i4", "i5", "i6", "i7", "i8"])
+        end
+
+        it "honors ItemStart" do
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&ItemStart=3"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          expect(doc.at_xpath("/TiVoContainer/ItemStart").content).to eq("3")
+          expect(doc.at_xpath("/TiVoContainer/ItemCount").content).to eq("8")
+
+          expect(doc.at_xpath("/TiVoContainer/Details/TotalItems").content).to eq("20")
+
+          expect(doc.xpath("/TiVoContainer/Item").size).to eq (8)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to match_array(["i4", "i5", "i6", "i7", "i8", "i9", "i10", "i11"])
+        end
+
+        it "honors ItemCount" 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("0")
+          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(["i1", "i2", "i3"])
+        end
+
+        it "displays page 2" do
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&ItemStart=7"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          expect(doc.at_xpath("/TiVoContainer/ItemStart").content).to eq("7")
+          expect(doc.at_xpath("/TiVoContainer/ItemCount").content).to eq("8")
+
+          expect(doc.at_xpath("/TiVoContainer/Details/TotalItems").content).to eq("20")
+
+          expect(doc.xpath("/TiVoContainer/Item").size).to eq (8)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to match_array(["i8", "i9", "i10", "i11", "i12", "i13", "i14", "i15"])
+        end
+
+        it "displays page using anchors" do
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&AnchorItem=/a1/c1/i8&AnchorOffset=-1"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          expect(doc.at_xpath("/TiVoContainer/ItemStart").content).to eq("7")
+          expect(doc.at_xpath("/TiVoContainer/ItemCount").content).to eq("8")
+
+          expect(doc.at_xpath("/TiVoContainer/Details/TotalItems").content).to eq("20")
+
+          expect(doc.xpath("/TiVoContainer/Item").size).to eq (8)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to match_array(["i8", "i9", "i10", "i11", "i12", "i13", "i14", "i15"])
+        end
+
+        it "honors anchor offset when displaying page using anchors" do
+          get "/TiVoConnect?Command=QueryContainer&Container=/a1/c1&AnchorItem=/a1/c1/i8&AnchorOffset=-8"
+          expect(last_response.status).to eq(200)
+          doc = Nokogiri::XML(last_response.body)
+
+          expect(doc.at_xpath("/TiVoContainer/ItemStart").content).to eq("0")
+          expect(doc.at_xpath("/TiVoContainer/ItemCount").content).to eq("8")
+
+          expect(doc.at_xpath("/TiVoContainer/Details/TotalItems").content).to eq("20")
+
+          expect(doc.xpath("/TiVoContainer/Item").size).to eq (8)
+
+          child_titles = doc.xpath("/TiVoContainer/Item/Details/Title").collect(&:content)
+          expect(child_titles).to match_array(["i1", "i2", "i3", "i4", "i5", "i6", "i7", "i8"])
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "transcode" do
+
+    it "fails if it doesn't exist" do
+      get "/this/is/not/here"
+      expect(last_response.status).to eq(404)
+    end
+
+    it "sends transcoded data" do
+      get "/a1/c1/i1?Format=?video/x-tivo-mpeg"
+      expect(last_response.status).to eq(206)
+      expect(last_response.body).to include("/A1/C1/I1")
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,123 @@
+
+require 'rspec'
+RSpec.configure do |config|
+end
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'tivohmo/logging'
+Logging.logger.root.level = :error
+
+require 'tivohmo'
+require 'open-uri'
+
+def video_fixture(name)
+  fixture_names = {
+      tiny: 'MPEG4 by philips.mp4',
+      with_audio: 'test_qcif_200_aac_64.mp4'
+  }
+
+  file_name = fixture_names[name]
+  raise ArgumentError, "No fixture for :#{name}" unless file_name
+
+  base_url = 'http://samples.mplayerhq.hu/MPEG-4'
+  video_url = "#{base_url}/#{URI.escape(file_name)}"
+
+  cache_dir = '/tmp/video_fixtures'
+  video_file = "#{cache_dir}/#{file_name}"
+
+  if ! File.exist?(video_file)
+    puts "Downloading video fixture #{name} from #{video_url}"
+    FileUtils.mkdir_p(cache_dir)
+    File.write(video_file, open(video_url).read)
+  end
+
+  video_file
+end
+
+module TestAPI
+
+  class Application
+    include TivoHMO::API::Application
+  end
+
+  class Container
+    include TivoHMO::API::Container
+  end
+
+  class Item
+    include TivoHMO::API::Item
+  end
+
+  class Metadata
+    include TivoHMO::API::Metadata
+  end
+
+  class Transcoder
+    include TivoHMO::API::Transcoder
+    def transcoder_options; {}; end
+    def transcode(io, format); io << item.title_path.upcase; end
+  end
+end
+
+def make_api_tree(parent, *items)
+  parent = TivoHMO::API::Server.new unless parent
+  if parent.is_a?(TivoHMO::API::Server)
+    parent = parent.add_child(TestAPI::Application.new('a'))
+  end
+
+  items.each do |item|
+    if item.is_a?(Hash)
+      item.each do |name, child_items|
+        c = parent.add_child(TestAPI::Container.new(name.to_s))
+        make_api_tree(c, *child_items)
+      end
+    elsif item.is_a?(Enumerable)
+      make_api_tree(parent, *item)
+    else
+      parent.add_child(TestAPI::Item.new(item.to_s))
+    end
+  end
+
+  parent
+end
+
+def mktree(path, items)
+  items.each do |item|
+    if item.is_a?(Hash)
+      item.each do |dir, contents|
+        p = "#{path}/#{dir}"
+        FileUtils.mkdir p
+        mktree(p, contents)
+      end
+    else
+      p = "#{path}/#{item}"
+      FileUtils.touch p
+    end
+  end
+end
+
+def with_file_tree(*tree)
+  Dir.mktmpdir('tivohmo_test') do |dir|
+    mktree(dir, tree)
+    yield dir
+  end
+end
+
+def plex_stub(clazz, method_stubs={})
+  default_stubs = {
+    key: '/some/key',
+    title: 'Title',
+    updated_at: Time.now.to_i,
+    added_at: Time.now.to_i,
+    refresh: nil
+  }
+  d = double(clazz, default_stubs.merge(method_stubs))
+
+  allow(d).to receive(:is_a?) do |arg|
+    arg == clazz
+  end
+
+  d
+end

data/tivohmo.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tivohmo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tivohmo"
+  spec.version       = TivoHMO::VERSION
+  spec.authors       = ["Matt Conway"]
+  spec.email         = ["matt@conwaysplace.com"]
+  spec.summary       = %q{Ruby SDK for Tivo Home Media Option}
+  spec.description   = %q{Allows one to author Tivo HMO applications using ruby}
+  spec.homepage      = ""
+  spec.license       = "LGPL"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "nokogiri"
+
+  # core dependencies
+  spec.add_dependency "activesupport"
+  spec.add_dependency "gem_logger"
+  spec.add_dependency "logging"
+  spec.add_dependency "sigdump"
+  spec.add_dependency "clamp"
+  spec.add_dependency "sinatra"
+  spec.add_dependency "builder"
+  spec.add_dependency "puma"
+
+  # filesystem adapter dependencies, make optional?
+  spec.add_dependency "listen"
+  spec.add_dependency "streamio-ffmpeg"
+
+  # plex adapter dependencies, make optional?
+  spec.add_dependency "plex-ruby"
+end