nickludlam-ruby-mythtv 0.1.2 → 0.2.0

data/History.txt

@@ -1,3 +1,12 @@
+== 0.2.0 (2008-09-29)
+
+* Bumped to version 0.2 as we now support proper editing of recording schedules, and speaking multiple versions of the database schema
+
+== 0.1.2 (2008-09-24)
+
+* Added support for talking to the MythTV MySQL database, to allow queries on the EPG, and interacting with recording schedules
+* Removed the XML program guide as it is superceded by the database
+
 == 0.1.1 (2008-07-27)
 
 * Updated documentation

data/README.txt

@@ -1,18 +1,24 @@
-= Ruby-mythtv
+= ruby-mythtv
   
 == Description
 
-A pure Ruby implementation of the MythTV Backend protocol to allow interaction with a MythTV server. Features include browsing and streaming of recordings, and thumbnail generation. See http://github.com/nickludlam/ruby-mythtv for more details.
+A pure Ruby implementation of the MythTV Backend protocol, and a MySQL database wrapper to allow interaction with a MythTV server. Features include browsing and streaming of recordings, thumbnail generation, listing channels and programs, and recording schedule editing. Currently the most complicated use of the gem is from the tests in the test/ subdirectory. See http://github.com/nickludlam/ruby-mythtv for more details. 
 
 == Requirements
 
-This gem does not yet support multiple protocol versions, so it requires an up-to-date installation of MythTV v0.21, and specifically implements protocol version 40. For more information on the history of the MythTV protocol, see http://www.mythtv.org/wiki/index.php/Protocol
+This gem relies on the 'mysql' gem, and obviously requires a MythTV server to talk to. The Gem is version independent, and currently knows how to speak the backend protocol versions 31 and 40. It can also cope with different versions of the MySQL database schema.
 
 == Install
 
+To install from RubyForge:
+
+  $ gem install ruby-mythtv
+
+To install from GitHub:
+
   $ gem sources -a http://gems.github.com/ (only required once)
   $ gem install nickludlam-ruby-mythtv
-  
+
 == Source
 
 The ruby-mythtv source is available on GitHub at
@@ -25,10 +31,13 @@ and can be cloned from
   
 == Basic usage
 
+If you want to enumerate the current recordings, select one and stream it to disk, then it would
+look something like this.
+
   require 'ruby-mythtv'
   
   # Connect to the server
-  mythbackend, mythdb = MythTV.connect(:host => 'mythtv.localdomain')
+  mythbackend = MythTV.connect_backend(:host => 'mythtv.localdomain')
   
   # Get an array of recordings
   recordings = mythbackend.query_recordings
@@ -45,6 +54,38 @@ and can be cloned from
   preview_thumbnail = mythbackend.preview_image(recordings[0], :secs_in => 60)
   File.open('preview_thumbnail.png', 'w') { |f| f.write(preview_thumbnail) }
 
+== Advanced usage
+
+If you wanted to search for a particular program name, and set up a schedule
+
+  require 'ruby-mythtv'
+
+  # Connect to the server
+  mythbackend, mythdb = MythTV.connect(:host => 'mythtv.localdomain',
+                                       :database_password => 'password')
+
+  # Find matches on our search term, and limit the results to 5 matches
+  programs = mythdb.list_programs(:conditions => ['title LIKE ?', "%SEARCH TERM%"],
+                                  :limit => 5)
+  
+  # Take the first program match, and convert it to a recording schedule
+  new_schedule = MythTV::RecordingSchedule.new(programs[0], mythdb)
+  new_schedule.save
+  
+  # Signal the backend of recording changes for our recording schedule entry
+  mythbackend.reschedule_recordings(new_schedule.recordid)
+  
+  # Let the backend resolve matches
+  sleep(5)
+
+  # Enumerate the list of pending recordings, find ours, and check for any conflicts
+  pending_recordings = mythbackend.query_pending
+  conflicts = pending_recordings.find { |p| p.recordid == new_schedule.recordid &&
+                                            p.recstatus_sym == :rsConflict }
+  
+  # If conflicts is empty, then all is good. If it is populated, then action needs
+  # to be taken, such as bumping the priority, or removing the clashes....
+
 == Author
 
 Written in 2008 by Nick Ludlam <nick@recoil.org>

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
   s.name = %q{ruby-mythtv}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
  
   s.specification_version = 2 if s.respond_to? :specification_version=
  
@@ -21,7 +21,7 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ruby-mythtv}
-  s.rubygems_version = %q{0.1.2}
+  s.rubygems_version = %q{0.2.0}
   s.summary = %q{Ruby implementation of the MythTV backend protocol}
   s.test_files = ["test/test_backend.rb", "test/test_helper.rb"]
 end

data/Todo.txt

@@ -2,4 +2,5 @@
 - Look at how we obtain the channel icon by streaming a backend file (see existing MythTV Perl module)
 - Support Ruby 1.9
 - Support seeking with the MythTV::Backend#stream() method
-- Work out method to remove and add database columns for Channel/Program/RecordingSchedule, as we do for the PROTOCOL mapping system. It seems the database can change without the Protocol version being bumped, so they are independent.
+- Look at how we need to pass the DB instance to each constructor for Channel, Program and RecordingSchedule. Automate the link back to db instance?
+- Make use of the ENUMS placed in RecordingSchedule to help with validation of various columns

data/lib/ruby-mythtv.rb

@@ -21,7 +21,7 @@
 # THE SOFTWARE.
 
 module MythTV
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
   
   def self.connect(options)
     backend = connect_backend(options)

data/test/test_db.rb

@@ -3,10 +3,10 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 class TestDatabase < Test::Unit::TestCase
   def setup
     abort("\n\tmyERROR: You must set the environment variable MYTHTV_DB to the name of your MythTV database server\n\n") unless ENV['MYTHTV_DB']
+    abort("\n\tmyERROR: You must set the environment variable MYTHTV_PW to the name of your MythTV database server\n\n") unless ENV['MYTHTV_PW']
     @db = MythTV.connect_database(:host => ENV['MYTHTV_DB'],
-                                  :database_user => 'mythtv',
-                                  :database_password => '4c6UUCJp',
-                                  :log_level => Logger::WARN)
+                                  :database_password => ENV['MYTHTV_PW'],
+                                  :log_level => Logger::DEBUG)
   end
   
   def teardown
@@ -102,7 +102,32 @@ class TestDatabase < Test::Unit::TestCase
     
     assert new_schedule.recordid > 0
     
-    assert new_schedule.destroy()
+    destroy_result = new_schedule.destroy()
+    assert destroy_result
+  end
+  
+  def test_new_and_modify_schedule
+    # Get list of schedules for later reference
+    num_schedules = @db.list_recording_schedules
+    programs = @db.list_programs(:conditions => ['starttime BETWEEN ? AND ?', Time.now + 3600, Time.now + 7200],
+                                 :limit => 1)
+    
+    # Convert our first program selected into a recording schedule
+    new_schedule = MythTV::RecordingSchedule.new(programs[0], @db)
+    new_schedule.save
+    
+    new_schedule.type = 4
+    new_schedule.save
+
+    test_query = @db.list_recording_schedules(:conditions => ['recordid = ?', new_schedule.recordid])
+    assert_equal 1, test_query.length
+    
+    test_retrieval = test_query[0]
+    
+    assert_equal 4, test_retrieval.type
+
+    destroy_result = new_schedule.destroy()
+    assert destroy_result
   end
   
 end

data/test/test_helper.rb

@@ -1,2 +1,3 @@
 require 'test/unit'
+require 'logger'
 require File.dirname(__FILE__) + '/../lib/ruby-mythtv'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nickludlam-ruby-mythtv
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Nick Ludlam
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-24 00:00:00 -07:00
+date: 2008-09-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency