nickludlam-ruby-mythtv 0.2.0 → 0.3.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.3.0 (2009-02-18)
+
+* Replaced old database code with one based on ActiveRecord, which is now a dependency
+* Changed test code
+
 == 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

data/Rakefile

@@ -1,32 +1,37 @@
 require 'rubygems'
-Gem::manage_gems
 require 'rake/gempackagetask'
 require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
-  s.name = %q{ruby-mythtv}
-  s.version = "0.2.0"
+  s.name = 'ruby-mythtv'
+  s.version = '0.3.0'
  
   s.specification_version = 2 if s.respond_to? :specification_version=
  
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Nick Ludlam"]
-  s.date = %q{2008-07-27}
-  s.description = %q{Ruby implementation of the MythTV communication protocol}
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.date = %q{2009-02-18}
+  s.description = %q{Ruby implementation of the MythTV communication protocol, and interface to the MythTV database}
+  s.authors = [ 'Nick Ludlam' ]
   s.email = %q{nick@recoil.org}
-  s.extra_rdoc_files = ["History.txt", "License.txt", "README.txt"]
-  s.files = ["History.txt", "License.txt", "README.txt", "Rakefile", "lib/ruby-mythtv.rb", "lib/mythtv/backend.rb", "lib/mythtv/channel.rb", "lib/mythtv/database.rb", "lib/mythtv/program.rb", "lib/mythtv/protocol.rb", "lib/mythtv/recording.rb", "lib/mythtv/recording_schedule.rb", "lib/mythtv/utils.rb", "test/test_backend.rb", "test/test_db.rb", "test/test_helper.rb"]
+  s.extra_rdoc_files = [ 'History.txt', 'License.txt', 'README.txt', 'Todo.txt' ]
+  s.files = [ 'History.txt', 'License.txt', 'README.txt', 'Rakefile', 'Todo.txt' ] + Dir["lib/*.rb"] + Dir["lib/mythtv/*.rb"] + Dir["test/*.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/nickludlam/ruby-mythtv/}
-  s.rdoc_options = ["--main", "README.txt"]
-  s.require_paths = ["lib"]
+  s.rdoc_options = ['--main', 'README.txt']
+  s.require_paths = ['lib']
   s.rubyforge_project = %q{ruby-mythtv}
-  s.rubygems_version = %q{0.2.0}
+  s.rubygems_version = %q{0.3.0}
+  
+  s.add_dependency('mysql')
+  s.add_dependency('activerecord')
+  s.add_dependency('composite_primary_keys')
+  
   s.summary = %q{Ruby implementation of the MythTV backend protocol}
-  s.test_files = ["test/test_backend.rb", "test/test_helper.rb"]
+  s.test_files = Dir["test/*.rb"]
 end
 
 Rake::GemPackageTask.new(spec) do |pkg| 
+  pkg.need_zip = true
   pkg.need_tar = true 
 end 
 
@@ -35,18 +40,22 @@ task :build => "pkg/#{spec.name}-#{spec.version}.gem" do
 end
 
 desc "Run basic unit tests"
-Rake::TestTask.new("test_units") do |t|
+Rake::TestTask.new("test") do |t|
   t.pattern = ENV["TESTFILES"] || ['test/test_backend.rb', 'test/test_db.rb']
   t.verbose = true
   t.warning = true
 end
 
-task :test => :test_units
-
-Rake::TestTask.new('test_db') do |t|
+Rake::TestTask.new('test:db') do |t|
   t.pattern = ['test/test_db.rb']
   t.verbose = true
 end
+
+Rake::TestTask.new('test:backend') do |t|
+  t.pattern = ['test/test_backend.rb']
+  t.verbose = true
+end
+
   
 desc "Run unit tests as default"
-task :default => :test_units
+task :default => :test

data/Todo.txt

@@ -1,6 +1,7 @@
-- Implement the Recorder class, and associated functions (see existing MythTV Python module)
-- 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
-- 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
+== Todo
+
+* Implement the Recorder class, and associated functions (see existing MythTV Python module)
+* 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
+* Make use of the ENUMS placed in RecordingSchedule to help with validation of various columns

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nickludlam-ruby-mythtv
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nick Ludlam
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-29 00:00:00 -07:00
+date: 2009-02-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mysql
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,7 +22,27 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: Ruby implementation of the MythTV communication protocol
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: composite_primary_keys
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby implementation of the MythTV communication protocol, and interface to the MythTV database
 email: nick@recoil.org
 executables: []
 
@@ -31,24 +52,12 @@ extra_rdoc_files:
 - History.txt
 - License.txt
 - README.txt
+- Todo.txt
 files: 
 - History.txt
 - License.txt
 - README.txt
 - Rakefile
-- lib/ruby-mythtv.rb
-- mythtv/backend.rb
-- mythtv/channel.rb
-- mythtv/database.rb
-- mythtv/program.rb
-- mythtv/protocol.rb
-- mythtv/recording.rb
-- mythtv/recording_schedule.rb
-- mythtv/utils.rb
-- test/test_backend.rb
-- test/test_db.rb
-- test/test_helper.rb
-- test_stream.rb
 - Todo.txt
 has_rdoc: true
 homepage: http://github.com/nickludlam/ruby-mythtv/
@@ -77,7 +86,5 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Ruby implementation of the MythTV backend protocol
-test_files: 
-- test/test_helper.rb
-- test/test_backend.rb
-- test/test_db.rb
+test_files: []
+

data/lib/ruby-mythtv.rb

@@ -1,52 +0,0 @@
-# The MIT License
-# 
-# Copyright (c) 2008 Nick Ludlam
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-module MythTV
-  VERSION = '0.2.0'
-  
-  def self.connect(options)
-    backend = connect_backend(options)
-    database = connect_database(options)
-    
-    [backend, database]
-  end
-  
-  def self.connect_backend(options)
-    Backend.new(options)
-  end
-  
-  def self.connect_database(options)
-    Database.new(options)
-  end
-  
-end
-
-$:.unshift(File.dirname(__FILE__))
-
-require 'mythtv/channel.rb'
-require 'mythtv/program.rb'
-require 'mythtv/protocol.rb'
-require 'mythtv/recording.rb'
-require 'mythtv/recording_schedule.rb'
-require 'mythtv/utils.rb'
-require 'mythtv/database.rb'
-require 'mythtv/backend.rb'

data/test/test_backend.rb

@@ -1,63 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class TestBackend < Test::Unit::TestCase
-  def setup
-    abort("\n\tERROR: You must set the environment variable MYTHTV_BACKEND to the name of your MythTV backend server\n\n") unless ENV['MYTHTV_BACKEND']
-    @backend = MythTV.connect_backend(:host => ENV['MYTHTV_BACKEND'])
-  end
-  
-  def teardown
-    @backend.close
-  end
-  
-  # Assuming the system is up for more than 0 seconds!
-  def test_connection
-    uptime = @backend.query_uptime
-    assert uptime > 0
-  end
-  
-  # Assuming there is at least one recording on the test server
-  def test_get_recordings
-    recordings = @backend.query_recordings
-    assert recordings.length > 0
-    assert_kind_of MythTV::Recording, recordings[0]
-  end
-
-  # Assuming there is at least one scheduled recording on the test server
-  def test_get_scheduled
-    scheduled = @backend.query_scheduled
-    assert scheduled.length > 0
-    assert_kind_of MythTV::Recording, scheduled[0]
-  end
-  
-  # Test the generation of a preview image
-  def test_make_preview_image
-    recordings = @backend.query_recordings
-    
-    recording = recordings[0]
-    test_image = @backend.preview_image(recording, :secs_in => 1)
-    assert test_image.length > 0
-    
-    # Define an array of the decimal values of the PNG magic number
-    png_sig = [137, 80, 78, 71, 13, 10, 26, 10]
-    test_image_sig = (0..7).collect { |i| test_image[i] }
-    
-    assert_equal test_image_sig, png_sig
-  end
-  
-  # def test_process_guide_xml
-  #   guide_data = @backend.get_program_guide
-  #   
-  #   channels = MythTV::Backend.process_guide_xml(guide_data)
-  # end
-  
-  # Don't run this by default as it takes a while. Possibly limit to 100kB?
-  #def test_download
-  #  recordings = @backend.query_recordings
-  #  
-  #  recording = recordings[-2]
-  #  @backend.download(recording)
-  #end
-  
-  
-end

data/test/test_db.rb

@@ -1,134 +0,0 @@
-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_password => ENV['MYTHTV_PW'],
-                                  :log_level => Logger::DEBUG)
-  end
-  
-  def teardown
-    @db.close
-  end
-  
-  # Check the DBSchemaVer key in the settings table as our first check
-  # It should always be present
-  def test_get_setting
-    schema_version = @db.get_setting('DBSchemaVer')
-    assert schema_version.to_i > 0
-  end
-
-  # Check the DBSchemaVer, once queried, is in the setting cache
-  def test_get_setting_cache
-    schema_version = @db.get_setting('DBSchemaVer')
-    assert @db.setting_cache['DBSchemaVer_'].to_i > 0
-  end
-
-  def test_list_channels
-    channels = @db.list_channels
-    
-    assert_kind_of Array, channels 
-    assert channels.length > 0
-    assert_kind_of MythTV::Channel, channels[0] 
-    assert channels[0].chanid > 0
-  end
-  
-  # Test we can pull back a single channel when
-  # specifying a :chanid
-  def test_list_single_chanid
-    first_channel_list = @db.list_channels
-    wanted_chanid = first_channel_list[0].chanid
-
-    second_channel_list = @db.list_channels(:chanid => wanted_chanid)
-    assert_equal 1, second_channel_list.length
-
-    channel = second_channel_list[0]
-    assert_kind_of MythTV::Channel, channel
-    assert_equal channel.chanid, wanted_chanid
-  end
-  
-  def test_list_multiple_chanids
-    first_channel_list = @db.list_channels
-    first_five = first_channel_list.slice(0..4)
-    wanted_chanids = first_five.map { |x| x.chanid }
-
-    second_channel_list = @db.list_channels(:chanid => wanted_chanids)
-    assert_equal 5, second_channel_list.length
-    second_channel_list
-  end
-  
-  def test_list_programs
-    programs = @db.list_programs(:limit => 10)
-    
-    assert_equal 10, programs.length
-  end
-  
-  def test_list_programs_with_search
-    programs = @db.list_programs(:conditions => ['title LIKE ?', "%"],
-                                 :limit => 5)
-    assert programs.length > 0
-  end
-  
-  def test_list_programs_with_starttime_range
-    # Programs in the next two hours
-    programs = @db.list_programs(:conditions => ['starttime BETWEEN ? AND ?', Time.now, Time.now + 7200],
-                                 :limit => 1)
-    
-    assert_equal 1, programs.length
-  end
-  
-  def test_program_links_to_channel
-    programs = @db.list_programs(:conditions => ['title LIKE ?', "%"], :limit => 1)
-    program_channel = programs[0].channel
-    assert_kind_of MythTV::Channel, program_channel
-  end
-
-  def test_new_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
-    
-    # Get new list
-    new_num_schedules = @db.list_recording_schedules
-    # Assert that we now have one more schedule
-    assert_equal num_schedules.length + 1, new_num_schedules.length
-    
-    assert new_schedule.recordid > 0
-    
-    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,3 +0,0 @@
-require 'test/unit'
-require 'logger'
-require File.dirname(__FILE__) + '/../lib/ruby-mythtv'