simple_pvr 1.0.0 → 1.1.0

data/spec/simple_pvr/programme_icon_fetcher_spec.rb

@@ -0,0 +1,25 @@
+require 'simple_pvr'
+
+module SimplePvr
+  describe ProgrammeIconFetcher do
+    before do
+      @recording_dir = File.dirname(__FILE__) + '/../resources/recordings'
+      FileUtils.rm_rf(@recording_dir) if Dir.exists?(@recording_dir)
+      FileUtils.mkdir_p(@recording_dir)
+    end
+    
+    it 'fetches image and stores it in specified location' do
+      destination_file = "#{@recording_dir}/dummyImage.png"
+
+      # We're using open-uri, which unfortunately does not understand file://, which would be perfect for
+      # this unit test. However, URLs starting with / are apparently interpreted as normal files.
+      source_url = "#{File.dirname(__FILE__)}/../resources/dummyImage.png"
+
+      Thread.should_receive(:new).and_yield
+      
+      ProgrammeIconFetcher.fetch(source_url, destination_file)
+      
+      File.read(destination_file).should == 'This is not really a PNG file...'
+    end
+  end
+end

data/spec/simple_pvr/pvr_initializer_spec.rb

@@ -1,50 +1,52 @@
 require 'simple_pvr'
 
-describe SimplePvr::PvrInitializer do
-  before do
-    SimplePvr::Model::DatabaseInitializer.stub(:setup)
-    
-    @scheduler = double('Scheduler')
-    SimplePvr::Scheduler.stub(new: @scheduler)
-    
-    @hdhomerun = double('HDHomeRun')
-    SimplePvr::HDHomeRun.stub(new: @hdhomerun)
-    
-    @recording_manager = double('RecordingManager')
-    SimplePvr::RecordingManager.stub(new: @recording_manager)
-  end
-  
-  it 'starts the scheduler' do
-    SimplePvr::Model::Channel.stub(all: [1, 2, 3, 4, 5])
-    @scheduler.should_receive(:start)
-
-    SimplePvr::PvrInitializer.setup
-  end
-  
-  context 'when scheduler is started' do
+module SimplePvr
+  describe PvrInitializer do
     before do
-      @scheduler.stub(:start)
+      Model::DatabaseInitializer.stub(:setup)
+      
+      @scheduler = double('Scheduler')
+      Scheduler.stub(new: @scheduler)
+      
+      @hdhomerun = double('HDHomeRun')
+      HDHomeRun.stub(new: @hdhomerun)
+      
+      @recording_manager = double('RecordingManager')
+      RecordingManager.stub(new: @recording_manager)
     end
-  
-    it 'runs a channel scan if channels are missing' do
-      SimplePvr::Model::Channel.stub(all: [])
-      @hdhomerun.should_receive(:scan_for_channels)
     
-      SimplePvr::PvrInitializer.setup
-    end
+    it 'starts the scheduler' do
+      Model::Channel.stub(all: [1, 2, 3, 4, 5])
+      @scheduler.should_receive(:start)
   
-    it 'does nothing if channels.txt is present' do
-      SimplePvr::Model::Channel.stub(all: [1])
-
-      SimplePvr::PvrInitializer.setup
+      PvrInitializer.setup
     end
+    
+    context 'when scheduler is started' do
+      before do
+        @scheduler.stub(:start)
+      end
+    
+      it 'runs a channel scan if channels are missing' do
+        Model::Channel.stub(all: [])
+        @hdhomerun.should_receive(:scan_for_channels)
+      
+        PvrInitializer.setup
+      end
+    
+      it 'does nothing if channels.txt is present' do
+        Model::Channel.stub(all: [1])
   
-    it 'initializes a HDHomeRun and RecordingManager instance' do
-      SimplePvr::Model::Channel.stub(all: [1])
+        PvrInitializer.setup
+      end
     
-      SimplePvr::PvrInitializer.setup
-      SimplePvr::PvrInitializer.hdhomerun.should == @hdhomerun
-      SimplePvr::PvrInitializer.recording_manager.should == @recording_manager
+      it 'initializes a HDHomeRun and RecordingManager instance' do
+        Model::Channel.stub(all: [1])
+      
+        PvrInitializer.setup
+        PvrInitializer.hdhomerun.should == @hdhomerun
+        PvrInitializer.recording_manager.should == @recording_manager
+      end
     end
   end
 end

data/spec/simple_pvr/recorder_spec.rb

@@ -1,32 +1,43 @@
 require 'simple_pvr'
 
-describe SimplePvr::Recorder do
-  before do
-    @channel = SimplePvr::Model::Channel.new(frequency: 282000000, channel_id: 1098)
-    @recording = SimplePvr::Model::Recording.new(@channel, 'Star Trek', 'start time', 'duration')
-
-    @hdhomerun = double('HDHomeRun')
-    SimplePvr::PvrInitializer.stub(hdhomerun: @hdhomerun)
-
-    @recording_manager = double('RecordingManager')
-    @recording_manager.stub(:create_directory_for_recording).with(@recording).and_return('recording directory')  
-    SimplePvr::PvrInitializer.stub(recording_manager: @recording_manager)
-    
-    @recorder = SimplePvr::Recorder.new(1, @recording)
-  end
-  
-  it 'can start recording' do
-    @hdhomerun.should_receive(:start_recording).with(1, 282000000, 1098, 'recording directory')
-  
-    @recorder.start!
-  end
+module SimplePvr
+  describe Recorder do
+    before do
+      @programme = Model::Programme.new
+      @channel = Model::Channel.new(frequency: 282000000, channel_id: 1098)
+      @recording = Model::Recording.new(@channel, 'Star Trek', 'start time', 'duration', @programme)
   
-  it 'can stop recording as well, and creates a thumbnail' do
-    @hdhomerun.stub(:start_recording)
-    @hdhomerun.should_receive(:stop_recording).with(1)
-    SimplePvr::Ffmpeg.should_receive(:create_thumbnail_for).with('recording directory')
+      @hdhomerun = double('HDHomeRun')
+      PvrInitializer.stub(hdhomerun: @hdhomerun)
   
-    @recorder.start!
-    @recorder.stop!
+      @recording_manager = double('RecordingManager')
+      @recording_manager.stub(:create_directory_for_recording).with(@recording).and_return('recording directory')  
+      PvrInitializer.stub(recording_manager: @recording_manager)
+      
+      @recorder = Recorder.new(1, @recording)
+    end
+    
+    it 'can start recording' do
+      @hdhomerun.should_receive(:start_recording).with(1, 282000000, 1098, 'recording directory')
+    
+      @recorder.start!
+    end
+    
+    it 'starts fetching programme icon when recording starts' do
+      @programme.icon_url = 'http://tv-images.com/myImage.png'
+      ProgrammeIconFetcher.should_receive(:fetch).with('http://tv-images.com/myImage.png', 'recording directory/icon')
+      @hdhomerun.should_receive(:start_recording)
+      
+      @recorder.start!
+    end
+    
+    it 'can stop recording as well, and creates a thumbnail' do
+      @hdhomerun.stub(:start_recording)
+      @hdhomerun.should_receive(:stop_recording).with(1)
+      Ffmpeg.should_receive(:create_thumbnail_for).with('recording directory')
+    
+      @recorder.start!
+      @recorder.stop!
+    end
   end
 end

data/spec/simple_pvr/recording_manager_spec.rb

@@ -1,158 +1,185 @@
 require 'simple_pvr'
 require 'yaml'
 
-describe SimplePvr::RecordingManager do
-  before do
-    @recording_dir = File.dirname(__FILE__) + '/../resources/recordings'
-    FileUtils.rm_rf(@recording_dir) if Dir.exists?(@recording_dir)
-    FileUtils.mkdir_p(@recording_dir + "/series 1/1")
-    FileUtils.mkdir_p(@recording_dir + "/series 1/3")
-    FileUtils.mkdir_p(@recording_dir + "/Another series/10")
-    
-    @manager = SimplePvr::RecordingManager.new(@recording_dir)
-  end
-  
-  it 'knows which shows are recorded' do
-    @manager.shows.should == ['Another series', 'series 1']
-  end
-  
-  it 'can delete all episodes of a given show' do
-    @manager.delete_show('series 1')
-    File.exists?(@recording_dir + '/series 1').should be_false
-  end
-  
-  it 'knows which episodes of a given show exists' do
-    episodes = @manager.episodes_of('series 1')
+module SimplePvr
+  describe RecordingManager do
+    before do
+      @recording_dir = File.dirname(__FILE__) + '/../resources/recordings'
+      FileUtils.rm_rf(@recording_dir) if Dir.exists?(@recording_dir)
+      FileUtils.mkdir_p(@recording_dir + "/series 1/1")
+      FileUtils.mkdir_p(@recording_dir + "/series 1/3")
+      FileUtils.mkdir_p(@recording_dir + "/Another series/10")
+      
+      @manager = RecordingManager.new(@recording_dir)
+    end
     
-    episodes.length.should == 2
-    episodes[0].episode.should == '1'
-    episodes[1].episode.should == '3'
-  end
-  
-  it 'reads metadata for recordings if present' do
-    start_time = Time.now
-    metadata = {
-      channel: 'Channel 4',
-      subtitle: 'A subtitle',
-      description: 'A description',
-      start_time: start_time,
-      duration: 10.minutes
-    }
-    File.open(@recording_dir + '/series 1/3/metadata.yml', 'w') {|f| f.write(metadata.to_yaml) }
+    it 'knows which shows are recorded' do
+      @manager.shows.size.should == 2
+      @manager.shows.should include('Another series', 'series 1')
+    end
     
-    episodes = @manager.episodes_of('series 1')
+    it 'can delete all recordings of a given show' do
+      @manager.delete_show('series 1')
+      File.exists?(@recording_dir + '/series 1').should be_false
+    end
     
-    episodes.length.should == 2
-
-    episodes[0].show_name.should == 'series 1'
-    episodes[0].episode.should == '1'
+    it 'knows which recordings of a given show exists' do
+      recordings = @manager.recordings_of('series 1')
+      
+      recordings.length.should == 2
+      recordings[0].id.should == '1'
+      recordings[1].id.should == '3'
+    end
     
-    episodes[1].show_name.should == 'series 1'
-    episodes[1].episode.should == '3'
-    episodes[1].channel.should == 'Channel 4'
-    episodes[1].subtitle.should == 'A subtitle'
-    episodes[1].description.should == 'A description'
-    episodes[1].start_time.should == start_time
-    episodes[1].duration == 10.minutes
-  end
-  
-  it 'knows when no thumbnail exists' do
-    episodes = @manager.episodes_of('series 1')
-
-    episodes[0].has_thumbnail.should == false
-  end
-
-  it 'knows when thumbnail exists' do
-    FileUtils.touch(@recording_dir + "/series 1/1/thumbnail.png")
-    episodes = @manager.episodes_of('series 1')
-
-    episodes[0].has_thumbnail.should == true
-  end
-
-  it 'knows when no webm file exists' do
-    episodes = @manager.episodes_of('series 1')
-
-    episodes[0].has_webm.should == false
-  end
-
-  it 'knows when a webm file exists' do
-    FileUtils.touch(@recording_dir + "/series 1/1/stream.webm")
-    episodes = @manager.episodes_of('series 1')
-
-    episodes[0].has_webm.should == true
-  end
-
-  it 'can delete an episode of a given show' do
-    @manager.delete_show_episode('series 1', '3')
-    File.exists?(@recording_dir + '/series 1/3').should be_false
-  end
+    it 'reads metadata for recordings if present' do
+      start_time = Time.now
+      metadata = {
+        channel: 'Channel 4',
+        subtitle: 'A subtitle',
+        description: 'A description',
+        start_time: start_time,
+        duration: 10.minutes
+      }
+      File.open(@recording_dir + '/series 1/3/metadata.yml', 'w') {|f| f.write(metadata.to_yaml) }
+      
+      recordings = @manager.recordings_of('series 1')
+      
+      recordings.length.should == 2
   
-  context 'when creating recording directories' do
-    before do
-      @start_time = Time.local(2012, 7, 23, 15, 30, 15)
-      @recording = SimplePvr::Model::Recording.new(double(name: 'Channel 4'), 'Star Trek', @start_time, 50.minutes)
+      recordings[0].id.should == '1'
+      recordings[0].show_name.should == 'series 1'
+      
+      recordings[1].id.should == '3'
+      recordings[1].show_name.should == 'series 1'
+      recordings[1].channel.should == 'Channel 4'
+      recordings[1].subtitle.should == 'A subtitle'
+      recordings[1].description.should == 'A description'
+      recordings[1].start_time.to_i.should == start_time.to_i
+      recordings[1].duration == 10.minutes
     end
     
-    it 'records to directory with number 1 if nothing exists' do
-      @manager.create_directory_for_recording(@recording)
-    
-      File.exists?(@recording_dir + '/Star Trek/1').should be_true
+    it 'knows when no icon exists' do
+      recordings = @manager.recordings_of('series 1')
+  
+      recordings[0].has_icon.should be_false
     end
     
-    it 'removes some potentially harmful characters from directory name' do
-      @recording.show_name = "Some... harmful/irritating\\ characters in: '*title\""
-      @manager.create_directory_for_recording(@recording)
+    it 'knows when icon exists' do
+      FileUtils.touch(@recording_dir + "/series 1/1/icon")
+      recordings = @manager.recordings_of('series 1')
+  
+      recordings[0].has_icon.should be_true
+    end
     
-      File.exists?(@recording_dir + '/Some harmfulirritating characters in title/1').should be_true
+    it 'knows when no thumbnail exists' do
+      recordings = @manager.recordings_of('series 1')
+  
+      recordings[0].has_thumbnail.should be_false
     end
   
-    it 'finds a directory name for titles which would otherwise get an empty directory name' do
-      @recording.show_name = '/.'
-      @manager.create_directory_for_recording(@recording)
-    
-      File.exists?(@recording_dir + '/Unnamed/1').should be_true
+    it 'knows when thumbnail exists' do
+      FileUtils.touch(@recording_dir + "/series 1/1/thumbnail.png")
+      recordings = @manager.recordings_of('series 1')
+  
+      recordings[0].has_thumbnail.should be_true
     end
   
-    it 'finds next number in sequence for new directory' do
-      FileUtils.mkdir_p(@recording_dir + "/Star Trek/1")
-      FileUtils.mkdir_p(@recording_dir + "/Star Trek/2")
-      FileUtils.mkdir_p(@recording_dir + "/Star Trek/3")
-      @manager.create_directory_for_recording(@recording)
-    
-      File.exists?(@recording_dir + '/Star Trek/4').should be_true
+    it 'knows when no webm file exists' do
+      recordings = @manager.recordings_of('series 1')
+  
+      recordings[0].has_webm.should be_false
     end
   
-    it 'ignores random directories which are not sequence numbers' do
-      FileUtils.mkdir_p(@recording_dir + "/Star Trek/4")
-      FileUtils.mkdir_p(@recording_dir + "/Star Trek/random directory name")
-      @manager.create_directory_for_recording(@recording)
-    
-      File.exists?(@recording_dir + '/Star Trek/5').should be_true
+    it 'knows when a webm file exists' do
+      FileUtils.touch(@recording_dir + "/series 1/1/stream.webm")
+      recordings = @manager.recordings_of('series 1')
+  
+      recordings[0].has_webm.should be_true
     end
-    
-    it 'stores simple metadata if no programme information exists' do
-      @manager.create_directory_for_recording(@recording)
-    
-      metadata = YAML.load_file(@recording_dir + '/Star Trek/1/metadata.yml')
-      metadata[:title].should == 'Star Trek'
-      metadata[:channel].should == 'Channel 4'
-      metadata[:start_time].should == @start_time
-      metadata[:duration].should == 50.minutes
+  
+    it 'can delete a recording of a given show' do
+      @manager.delete_show_recording('series 1', '3')
+      File.exists?(@recording_dir + '/series 1/3').should be_false
     end
     
-    it 'stores extensive metadata if programme information exists' do
-      start_time = Time.local(2012, 7, 23, 15, 30, 15)
-      recording = SimplePvr::Model::Recording.new(double(name: 'Channel 4'), 'Extensive Metadata', start_time, 50.minutes)
-      recording.programme = SimplePvr::Model::Programme.new(subtitle: 'A subtitle', description: "A description,\nspanning several lines")
-      @manager.create_directory_for_recording(recording)
-    
-      metadata = YAML.load_file(@recording_dir + '/Extensive Metadata/1/metadata.yml')
-      metadata[:title].should == 'Extensive Metadata'
-      metadata[:channel].should == 'Channel 4'
-      metadata[:start_time].should == start_time
-      metadata[:duration].should == 50.minutes
-      metadata[:subtitle].should == 'A subtitle'
-      metadata[:description].should == "A description,\nspanning several lines"
+    context 'when creating recording directories' do
+      before do
+        @start_time = Time.local(2012, 7, 23, 15, 30, 15)
+        @start_time_millis = @start_time.to_i
+        @recording = Model::Recording.new(double(name: 'Channel 4'), 'Star Trek', @start_time, 50.minutes)
+      end
+      
+      it 'records to directory with record start time if it does not already exist' do
+        @manager.create_directory_for_recording(@recording)
+      
+        File.exists?("#{@recording_dir}/Star Trek/#{@start_time_millis}").should be_true
+      end
+  
+      it 'appends sequence number to start time if time stamp is already used' do
+        FileUtils.mkdir_p("#{@recording_dir}/Star Trek/#{@start_time_millis}")
+        @manager.create_directory_for_recording(@recording)
+      
+        File.exists?("#{@recording_dir}/Star Trek/#{@start_time_millis}-1").should be_true
+      end
+    
+      it 'finds next number in sequence for new directory if time stamp is already used' do
+        FileUtils.mkdir_p("#{@recording_dir}/Star Trek/#{@start_time_millis}")
+        FileUtils.mkdir_p("#{@recording_dir}/Star Trek/#{@start_time_millis}-1")
+        FileUtils.mkdir_p("#{@recording_dir}/Star Trek/#{@start_time_millis}-2")
+        @manager.create_directory_for_recording(@recording)
+      
+        File.exists?("#{@recording_dir}/Star Trek/#{@start_time_millis}-3").should be_true
+      end
+  
+      it 'removes some potentially harmful characters from directory name' do
+        @recording.show_name = "Some... harmful/irritating\\ characters in: '*title\""
+        @manager.create_directory_for_recording(@recording)
+      
+        File.exists?("#{@recording_dir}/Some harmfulirritating characters in title/#{@start_time_millis}").should be_true
+      end
+    
+      it 'finds a directory name for titles which would otherwise get an empty directory name' do
+        @recording.show_name = '/.'
+        @manager.create_directory_for_recording(@recording)
+      
+        File.exists?("#{@recording_dir}/Unnamed/#{@start_time_millis}").should be_true
+      end
+    
+      it 'stores simple metadata if no programme information exists' do
+        @manager.create_directory_for_recording(@recording)
+      
+        metadata = YAML.load_file("#{@recording_dir}/Star Trek/#{@start_time_millis}/metadata.yml")
+        metadata[:title].should == 'Star Trek'
+        metadata[:channel].should == 'Channel 4'
+        metadata[:start_time].should == @start_time
+        metadata[:duration].should == 50.minutes
+      end
+      
+      it 'stores extensive metadata if programme information exists' do
+        start_time = Time.local(2012, 7, 23, 15, 30, 15)
+        start_time_millis = start_time.to_i
+        recording = Model::Recording.new(double(name: 'Channel 4'), 'Extensive Metadata', start_time, 50.minutes)
+        recording.programme = Model::Programme.new(subtitle: 'A subtitle', description: "A description,\nspanning several lines")
+        recording.programme.categories.new(name: 'series')
+        recording.programme.categories.new(name: 'children')
+        recording.programme.directors.new(name: 'The director')
+        recording.programme.presenters.new(name: 'The presenter')
+        recording.programme.actors.new(role_name: 'First role', actor_name: 'First actor')
+        recording.programme.actors.new(role_name: 'Second role', actor_name: 'Second actor')
+        @manager.create_directory_for_recording(recording)
+      
+        metadata = YAML.load_file("#{@recording_dir}/Extensive Metadata/#{start_time_millis}/metadata.yml")
+        metadata[:title].should == 'Extensive Metadata'
+        metadata[:channel].should == 'Channel 4'
+        metadata[:start_time].should == start_time
+        metadata[:duration].should == 50.minutes
+        metadata[:subtitle].should == 'A subtitle'
+        metadata[:description].should == "A description,\nspanning several lines"
+        metadata[:categories].should == ['series', 'children']
+        metadata[:directors].should == ['The director']
+        metadata[:presenters].should == ['The presenter']
+        metadata[:actors].should == [{role_name: 'First role', actor_name: 'First actor'}, {role_name: 'Second role', actor_name: 'Second actor'}]
+      end
     end
   end
 end