simple_pvr 0.0.1

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in simple_pvr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    simple_pvr (0.0.1)
+      activesupport (~> 3.2)
+      data_mapper (~> 1.2)
+      dm-sqlite-adapter (~> 1.2)
+      nokogiri (~> 1.5)
+      sinatra (~> 1.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.8)
+    bcrypt-ruby (3.0.1)
+    builder (3.1.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.5)
+      ffi (~> 1.0, >= 1.0.6)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    data_mapper (1.2.0)
+      dm-aggregates (~> 1.2.0)
+      dm-constraints (~> 1.2.0)
+      dm-core (~> 1.2.0)
+      dm-migrations (~> 1.2.0)
+      dm-serializer (~> 1.2.0)
+      dm-timestamps (~> 1.2.0)
+      dm-transactions (~> 1.2.0)
+      dm-types (~> 1.2.0)
+      dm-validations (~> 1.2.0)
+    data_objects (0.10.8)
+      addressable (~> 2.1)
+    diff-lcs (1.1.3)
+    dm-aggregates (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-constraints (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-core (1.2.0)
+      addressable (~> 2.2.6)
+    dm-do-adapter (1.2.0)
+      data_objects (~> 0.10.6)
+      dm-core (~> 1.2.0)
+    dm-migrations (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-serializer (1.2.2)
+      dm-core (~> 1.2.0)
+      fastercsv (~> 1.5)
+      json (~> 1.6)
+      json_pure (~> 1.6)
+      multi_json (~> 1.0)
+    dm-sqlite-adapter (1.2.0)
+      dm-do-adapter (~> 1.2.0)
+      do_sqlite3 (~> 0.10.6)
+    dm-timestamps (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-transactions (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-types (1.2.2)
+      bcrypt-ruby (~> 3.0)
+      dm-core (~> 1.2.0)
+      fastercsv (~> 1.5)
+      json (~> 1.6)
+      multi_json (~> 1.0)
+      stringex (~> 1.4)
+      uuidtools (~> 2.1)
+    dm-validations (1.2.0)
+      dm-core (~> 1.2.0)
+    do_sqlite3 (0.10.8)
+      data_objects (= 0.10.8)
+    fastercsv (1.5.5)
+    ffi (1.1.5)
+    gherkin (2.11.2)
+      json (>= 1.4.6)
+    i18n (0.6.1)
+    json (1.7.5)
+    json_pure (1.7.5)
+    libwebsocket (0.1.5)
+      addressable
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (10.0.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    stringex (1.4.0)
+    tilt (1.3.3)
+    uuidtools (2.1.3)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (~> 1.1)
+  cucumber (~> 1.2)
+  rake (>= 10.0.0)
+  rspec (~> 2.11)
+  simple_pvr!

data/LICENSE.txt

@@ -0,0 +1,13 @@
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,169 @@
+What?
+=====
+A really, really simple PVR (Personal Video Recorder) system which only supports the
+[HDHomeRun network tuners](http://www.silicondust.com/). It's written in Ruby and is highly hackable. If
+you don't want to hack it, but just want a solid PVR system, no worries: It's dead-simple to use.
+
+SimplePVR does not contain its own player, but currently provides an XBMC plug-in and some half-hearted
+browser playback. Apart from that, all recordings are stored in a simple directory structure (see below
+for an explanation), so that you can just point your favorite player to the recordings.
+
+Why?
+====
+MythTV stopped working for me and my HDHomeRun box in the 0.25 release. And even though MythTV has loads
+of merits, I just have no idea what to do when it stops working - I am not in control of my media center.
+
+During the last couple of years, I have spent a substantial amount of time on bugs that suddenly appeared
+in MythTV and suddenly went away. I really don't like using systems this brittle.
+
+So I wanted to create a really simple PVR in Ruby, making it possible for others to hack away and have
+fun while recording TV shows for the rest of the family.
+
+It's based on the HDHomeRun command-line utility, which means it's:
+
+* built on something that's officially supported by SiliconDust (the makers of HDHomeRun).
+* really simple.
+* limited to supporting HDHomeRun tuners.
+
+Installation
+============
+First of all, you need a computer and an HDHomeRun tuner box. On your computer, you need to have the
+"hdhomerun_config" tool on the path.
+
+You need Ruby 1.9.2 or newer (1.9.0 or newer is probably enough).
+
+        gem install simple_pvr
+
+It might not always be completely straightforward... simple_pvr uses DataMapper, which in turn relies on
+bcrypt-ruby, which compiles some native stuff. So on MacOS, you need to install XCode and its command-line
+utilities, or get "make" in some other way. On Linux, it should just work. Don't know about Windows.
+
+If you'd like thumbnails for the recorded shows and ability to transcode recordings to WebM (so you can view
+them directly in your browser), you need FFMPEG on the command-line. Install it using MacPorts, Homebrew,
+"apt-get", or whatever.
+
+Starting the server
+===================
+Run
+
+        pvr_server
+
+...and go to [http://localhost:4567](http://localhost:4567). If you want to expose this URL to the outside
+world, you'd better supply a username and password:
+
+        username=me password=secret pvr_server
+
+This will secure the application with Basic HTTP Authentication.
+
+XMLTV
+=====
+First you must specify in a YAML file how the channel IDs in your XMLTV file relates to the channel names
+that the HDHomeRun has found for you. Create a file called e.g. "channel_mappings.yaml", with lines like this:
+
+        www.ontv.dk/tv/1: DR 1
+		www.ontv.dk/tv/2: DR 2
+
+Then read your XMLTV file and the mappings file:
+
+        pvr_xmltv programmes.xmltv channel_mappings.yaml
+
+...and wait a little. You can tell the webserver to update its schedules without restarting the server. This is
+done by POST'ing to /api/schedules/reload on the server, e.g.:
+
+        curl -d "" localhost:4567/api/schedules/reload
+
+Or, if you've secured your web server with Basic HTTP Authentication like I told you to, specify username and password:
+
+        curl -d "" -u me:secret localhost:4567/api/schedules/reload
+
+Recordings
+==========
+The recordings are laid out like this, from the directory where you ran pvr_server:
+
+* recordings/
+  * Borgias/
+     * 1/
+     * 2/
+  * Sports news/
+     * 1/
+     * 2/
+     * 3/
+  * ...
+
+Inside the numbered directories are these files:
+
+* stream.ts: The actual stream. Let VLC or another media player show these for you.
+* hdhomerun_save.log: The output from the actual recording command.
+* metadata.yml: Recording time, title, channel, etc.
+
+...and a few other files (thumbnails, transcoded version of the recording, etc.).
+
+XBMC Plug-In
+============
+There's a very simple XBMC plug-in for SimplePVR. See [the home page](https://github.com/olefriis/simplepvr)
+for more information.
+
+Future?
+=======
+This projects needs to be a nice, readable, hackable, tested system. No pull requests are
+accepted that violate this.
+
+For version 1 of SimplePVR, I'd like to finish the following:
+
+* "Gemify" the stuff, so installation becomes a breeze.
+* More schedule editing, e.g.:
+  * "Start early" and "end late" (currently 2 and 5 minutes).
+  * Which time of day the schedule should be active (e.g. only the afternoon, ignoring all the
+    re-runs earlier in the day).
+* Removal of outdated schedules (the "Record single programme" and "Don't record this specific
+  programme").
+
+There is lots of stuff I'd like to do after that, but I have no deadline - which means that pull
+requests are the only means you have for speeding things up. This includes:
+
+* Web interface:
+  * "Dashboard" giving "the big picture" of the status of the system (next 5 upcoming recordings,
+    last 5 recorded programmes, current status, last couple of errors, whether there are any
+    upcoming conflicts, etc.).
+  * Better overview of recordings (a flat view).
+  * Better overview pages, e.g. "all children programmes", "all movies this week", "tonight's
+    programmes", ...
+* Setting up schedules defined by a channel, a start time, and a duration (and a name,
+  probably), so that the web GUI is usable even without XMLTV.
+* Schedule editing: Show which programmes match the edited schedule, to make it easier to create
+  a schedule which exactly matches your needs.
+* XMLTV import:
+  * Let SimplePVR itself fetch XMLTV URLs at specified times of day.
+  * Set-up of matching XMLTV IDs to channels could make good use of a GUI.
+  * Parse and make use of programme icons etc.
+* Searching for tuners and scanning for channels would be nice through a GUI.
+* Saving with the hdhomerun_config command is done through a shell script, so we can shut it down properly. I'd
+  like a simpler solution, but haven't found anything that works both on OS X and Linux.
+  [Bluepill](https://github.com/arya/bluepill) seems to do the job, but seems like too big a hammer...
+
+Some features would be cool to have, but I don't have a personal need for them, so they will only
+happen if *you* implement them and send me a pull request. Besides, some of them I have no clue how
+to implement...
+
+* Some kind of live TV.
+* Create metadata for XBMC and Serviio.
+* Duplication detection.
+* Commercial detection.
+* Record multiple programmes on same multiplex, so we are not restricted to only recording two
+  programmes at once.
+
+Development
+===========
+Run the specs and features like this:
+
+        rake test
+
+Run the JavaScript tests by first calling
+
+        test/scripts/test-server.sh
+
+then opening a browser on the shown URL. Capture the browser in strict mode. After this, you can run
+
+        test/scripts/test.sh
+
+any number of times. However, the test-server needs to be restarted from time to time.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+directory 'output'
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:spec)
+  Cucumber::Rake::Task.new(:features)
+end
+  
+desc 'Run specs and features'
+task :test => ['test:spec', 'test:features']
+
+task :default => ['test']

data/bin/pvr_server

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'rack'
+require 'simple_pvr'
+
+Rack::Server.start(
+  :config => SimplePvr::PvrInitializer.rackup_file_path,
+  :Port => 4567
+  #:server => 'sinatra'
+)

data/bin/pvr_xmltv

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'simple_pvr'
+require 'yaml'
+require 'open-uri'
+
+if ARGV.length != 2
+  puts "Requires two arguments: The XMLTV file name, and the channel mapping file name"
+  exit 1
+end
+
+SimplePvr::PvrInitializer.setup
+
+xmltv_file = File.new(ARGV[0])
+mapping_to_channels = YAML.load_file(ARGV[1])
+
+reader = SimplePvr::XmltvReader.new(mapping_to_channels)
+reader.read(xmltv_file)

data/features/channel_overview.feature

@@ -0,0 +1,48 @@
+Feature: Channel overview
+  In order to find what's on TV
+  As a user
+  I want a good channel overview
+
+Background:
+  Given the following channels:
+    | name      |
+    | Channel 1 |
+    | Channel 2 |
+    | Animals   |
+  And the following programmes:
+    | title           | subtitle                        | channel   | day |
+	| Blast from past | Prehistoric documentary         | Channel 1 |  -1 |
+    | Bonderøven      | Danish documentary              | Channel 1 |   0 |
+    | Blood and Bone  | American action movie from 2009 | Channel 1 |   0 |
+    | Noddy           | Children's programme            | Channel 2 |   0 |
+
+Scenario: Channel overview shows channel names
+  Given I am on the channel overview page
+  Then I should see "Channel 1"
+  And I should see "Channel 2"
+  And I should see "Animals"
+
+Scenario: Channel overview shows upcoming programmes
+  Given I am on the channel overview page
+  Then I should see "Bonderøven"
+  But I should not see "Blast from past"
+
+Scenario: Clicking on an upcoming programme reveals more programme information
+  Given I am on the channel overview page
+  And I follow "Bonderøven"
+  Then I should see "Danish documentary"
+
+Scenario: Channel filtering
+  Given I am on the channel overview page
+  And I fill in "channel_filter" with "channel"
+  Then I should see "Channel 1"
+  And I should see "Channel 2"
+  But I should not see "Animals"
+
+Scenario: I can go to a week overview for a given channel
+  Given I am on the channel overview page
+  And I fill in "channel_filter" with "Channel 1"
+  And I follow "..."
+  Then I should see "Bonderøven"
+  And I should see "Blood and Bone"
+  But I should not see "Noddy"

data/features/programme_search.feature

@@ -0,0 +1,20 @@
+Feature: Programme search
+  In order to find interesting programmes
+  As a user
+  I want to search through all programmes
+
+Background:
+  Given the following programmes:
+    | title          | subtitle                        |
+    | Bonderøven     | Danish documentary              |
+    | Blood and Bone | American action movie from 2009 |
+    | Noddy          | Children's programme            |
+  And I am on the schedules page
+
+Scenario: Autocomplete in programme search
+  Given I enter "Bon" in the programme search field
+  Then I should see the programme title suggestion "Bonderøven"
+
+Scenario: Searching for a text reveals summary of programmes with matching titles
+  Given I search for programmes with title "Bon"
+  Then I should see "Danish documentary" in the page contents

data/features/scheduling.feature

@@ -0,0 +1,112 @@
+Feature: Scheduling
+  In order to record programmes
+  As a user
+  I want to set up recording schedules
+
+Background:
+  Given the following programmes:
+    | title          | subtitle             | channel   | day |
+    | News right now | Just the news...     | Channel 1 |   0 |
+    | Bonderøven     | Danish documentary   | Channel 1 |   1 |
+    | Bonderøven     | Danish documentary   | Channel 2 |   1 |
+    | Bonderøven     | Danish documentary   | Channel 1 |   3 |
+    | Noddy          | Children's programme | Channel 1 |   1 |
+
+Scenario: Nothing is scheduled by default
+  Given I am on the schedules page
+  Then there should be 0 upcoming recordings
+
+Scenario: Schedule by title for a single channel
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record the programme on this channel
+  And I am on the schedules page
+  Then I should see the schedule "Bonderøven on Channel 1"
+  And there should be 2 upcoming recordings
+
+Scenario: Schedule by title for all channels
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record the programme on any channel
+  And I am on the schedules page
+  Then I should see the schedule "Bonderøven"
+  But I should not see the schedule "Bonderøven on Channel 1"
+  And there should be 3 upcoming recordings
+
+Scenario: Schedule a specific programme
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record just this programme
+  And I am on the schedules page
+  Then I should see the timed schedule "Bonderøven on Channel 1"
+  And there should be 1 upcoming recordings
+
+Scenario: Set up schedule manually
+  Given I am on the schedules page
+  And I fill in "Name" with "Bonderøven"
+  And I select "Channel 1" from "Channel"
+  And I press "Create schedule"
+  Then I should see the schedule "Bonderøven on Channel 1"
+  And there should be 2 upcoming recordings
+
+Scenario: Scheduling the current programme starts recording immediately
+  Given I am on the status page
+  Then I should see "Idle"
+  When I have navigated to the programme page for "News right now" on channel "Channel 1"
+  And I choose to record the programme on this channel
+  And I wait 2 seconds
+  When I am on the status page
+  Then I should see "Recording 'News right now' on channel 'Channel 1'"
+
+Scenario: Remove schedule
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record the programme on this channel
+  And I am on the schedules page
+  And I follow "Delete"
+  Then I should not see the schedule "Bonderøven on Channel 1"
+  And there should be 0 upcoming recordings
+
+Scenario: Defining conflicting schedules
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record the programme on any channel
+  And I have navigated to the programme page for "Noddy" on channel "Channel 1"
+  And I choose to record the programme on this channel
+  When I am on the schedules page
+  Then there should be a conflict
+
+Scenario: Fixing conflicts by removing a schedule
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record the programme on any channel
+  And I have navigated to the programme page for "Noddy" on channel "Channel 1"
+  And I choose to record the programme on this channel
+  When I am on the schedules page
+  And I follow "Delete"
+  Then there should be no conflicts
+
+Scenario: Removing a specific recording from a schedule
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record the programme on any channel
+  And I am on the schedules page
+  Then there should be 3 upcoming recordings
+  When I follow "Do not record this specific show"
+  Then there should be 2 upcoming recordings
+  And I should see "Exception: Bonderøven"
+
+Scenario: Editing a schedule
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record the programme on any channel
+  And I am on the schedules page
+  And I follow "Edit"
+  And I fill in "Name of show" with "Noddy"
+  And I press "Update"
+  Then there should be 1 upcoming recording
+  And I should not see "Bonderøven"
+
+Scenario: Editing a schedule so that only some weekdays are allowed
+  Given I have navigated to the programme page for "Bonderøven" on channel "Channel 1"
+  And I choose to record the programme on any channel
+  And I am on the schedules page
+  And I follow "Edit"
+  And I check "Filter by weekday"
+  And I check "Record Mondays"
+  And I check "Record Wednesdays"
+  And I check "Record Sundays"
+  And I press "Update"
+  Then I should see "(Mondays, Wednesdays, and Sundays)"

data/features/step_definitions/pvr_steps.rb

@@ -0,0 +1,104 @@
+require 'timeout'
+
+Given /the following programmes\:/ do |programme_table|
+  programme_table.hashes.each do |programme|
+    channel = find_or_create_channel_with_name(programme['channel'] || 'Channel 1')
+    air_time = Time.now.advance(days: (programme['day'] || '0').to_i)
+    SimplePvr::Model::Programme.add(channel, programme['title'] || '', programme['subtitle'] || '',
+      programme['description'] || '', air_time, 60.minutes, ' .23/40. ')
+  end
+end
+
+Given /the following channels\:/ do |channel_table|
+  channel_table.hashes.each do |channel|
+    find_or_create_channel_with_name(channel['name'])
+  end
+end
+
+Given /I have navigated to the week overview for channel "(.*)"/ do |channel|
+  visit path_to('the channel overview page')
+  fill_in('channel_filter', :with => channel)
+  click_link('...')
+end
+
+Given /I have navigated to the programme page for "(.*)" on channel "(.*)"/ do |title, channel|
+  visit path_to('the channel overview page')
+  fill_in('channel_filter', :with => channel)
+  click_link('...')
+  click_link(title)
+end
+
+Given /I choose to record just this programme/ do
+  choose_to_record('Record just this programme')
+end
+
+Given /I choose to record the programme on this channel/ do
+  choose_to_record('Record on this channel')
+end
+
+Given /I choose to record the programme on any channel/ do
+  choose_to_record('Record on any channel')
+end
+
+When /I enter "(.*)" in the programme search field/ do |query|
+  fill_in('programme-search-query', :with => query)
+end
+
+When /I search for programmes with title "(.*)"/ do |query|
+  fill_in('programme-search-query', :with => query)
+  click_button('Search')
+end
+
+Then /I should see the programme title suggestion "(.*)"/ do |suggestion|
+  page.wait_until { page.text.include? suggestion }
+end
+
+Then /I should see "(.*)" in the page contents/ do |text|
+  within('#contents') do
+    page.wait_until { page.text.include? text }
+  end
+end
+
+Then /I should see the schedule "(.*)"/ do |text|
+  within('#schedules') do
+    page.wait_until { page.text.include? text }
+  end
+end
+
+Then /I should see the timed schedule "(.*)"/ do |text|
+  within('#schedules') do
+    page.wait_until { page.text =~ /#{text} .* \d+, \d{4} at \d?\d:\d\d/ }
+  end
+end
+
+Then /I should not see the schedule "(.*)"/ do |text|
+  within('#schedules') do
+    page.wait_until { !(page.text.include? text) }
+  end
+end
+
+Then /there should be (\d*) upcoming recordings?/ do |upcoming_recordings|
+  page.wait_until { find('#upcoming_recordings').all('h2').length == upcoming_recordings.to_i }
+end
+
+Then /^there should be a conflict$/ do
+  page.wait_until { page.text.include? '(Conflicting)' }
+end
+
+Then /^there should be no conflicts$/ do
+  page.wait_until { !(page.text.include? '(Conflicting)') }
+end
+
+Then /I wait (\d*) seconds/ do |seconds|
+  sleep seconds.to_i
+end
+
+def find_or_create_channel_with_name(name)
+  channel = SimplePvr::Model::Channel.first(name: name)
+  channel ? channel : SimplePvr::Model::Channel.add(name, 0, 0)
+end
+
+def choose_to_record(button_text)
+  click_button(button_text)
+  page.wait_until { page.text.include? 'This programme is being recorded' }
+end