bbc-programmes 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+coverage
+.yardoc
+doc

data/README.md

@@ -0,0 +1,11 @@
+# Ruby client library for the BBC Programmes website
+
+    require 'rubygems'
+    require 'bbc/programmes'
+    
+    episode = BBC::Programmes::Episode.fetch('b00jnwnv')
+    puts "PID: #{episode.pid}"
+    puts "Title: #{episode.title}"
+    puts "Short Synopsis: #{episode.short_synopsis}"
+    puts "Medium Synopsis: #{episode.medium_synopsis}"
+    puts "Long Synopsis: #{episode.long_synopsis}"

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'yard'
+
+begin
+  gem 'jeweler'
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "bbc-programmes"
+    gemspec.summary = "Ruby client library for the BBC Programmes website."
+    gemspec.email = "njh@aelius.com.com"
+    gemspec.homepage = "http://github.com/njh/bbc-programmes-ruby"
+    gemspec.authors = ["Nicholas J Humfrey"]
+    gemspec.add_dependency('rdf', '>= 0.2.2')
+    gemspec.add_dependency('nokogiri', '>= 1.3.3')
+    gemspec.add_development_dependency('rspec')
+    gemspec.add_development_dependency('yard')
+    gemspec.extra_rdoc_files     = %w(README.md)
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/*.spec'
+  spec.spec_opts = ["-c"]
+end
+
+desc "Run specs through RCov"
+Spec::Rake::SpecTask.new("spec:rcov") do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/*.spec'
+  spec.rcov = true
+  spec.rcov_opts = ['-x', '/Library', '-x', '/System/Library', '-x', 'spec']
+end
+
+desc "Generate HTML report specs"
+Spec::Rake::SpecTask.new("doc:spec") do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/*.spec']
+  spec.spec_opts = ["--format", "html:doc/spec.html"]
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = %w(lib/**/*.rb)
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/basic.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+# Basic example of getting the title and synopsis for an episode
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'rubygems'
+require 'bbc/programmes'
+
+Spira.add_repository(:default, RDF::Repository)
+
+
+episode = BBC::Programmes::Episode.fetch('b00jnwnv')
+puts "PID: #{episode.pid}"
+puts "Title: #{episode.title}"
+puts "Short Synopsis: #{episode.short_synopsis}"
+puts "Medium Synopsis: #{episode.medium_synopsis}"
+puts "Long Synopsis: #{episode.long_synopsis}"

data/examples/broadcasts.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+# Example of listing all the broadcasts for episode
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'rubygems'
+require 'bbc/programmes'
+
+Spira.add_repository(:default, RDF::Repository)
+
+episode = BBC::Programmes::Episode.fetch('b00jnwnv')
+puts "#{episode.pid}: #{episode.title}"
+
+version = episode.versions.first.fetch!
+version.broadcasts.each do |broadcast|
+  puts "#{broadcast.start} - #{broadcast.end}  #{broadcast.service}"
+end

data/examples/search.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+#
+# Example of searching for programmes by title
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'rubygems'
+require 'bbc/programmes'
+
+Spira.add_repository(:default, RDF::Repository)
+
+programmes = BBC::Programmes.search('The Wire').each do |programme|
+  puts "#{programme.pid}: #{programme.title}"
+end

data/examples/tracklist.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+#
+# Example of listing all the broadcasts for episode
+#
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'rubygems'
+require 'bbc/programmes'
+
+Spira.add_repository(:default, RDF::Repository)
+
+episode = BBC::Programmes::Episode.fetch('b00sk7q2')
+puts "Episode: #{episode.title}"
+puts
+
+version = episode.versions.first.fetch!
+version.segments.each do |segment|
+  puts segment
+end

data/lib/bbc/programmes/base.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Base
+    include Spira::Resource
+
+    base_uri BBC::Programmes::BASE_URI
+    default_vocabulary RDF::PO
+
+    property :pid, :type => String
+
+    def self.fetch(identifier)
+      programme = self.for(identifier)
+      programme.fetch!
+      programme
+    end
+
+    def fetch!
+      BBC::Programmes.fetch(subject)
+      self.reload
+      self
+    end
+
+    def pid
+      pid = attribute_get(:pid)
+      if pid.nil?
+        subject.to_s =~ /(\w+)\#(\w+)$/
+        pid = $1
+      end
+      pid
+    end
+
+    def self.subclasses
+      subclasses = []
+      ObjectSpace.each_object(Class) do |klass|
+        if klass.ancestors.include?(self)
+          subclasses << klass
+        end
+      end
+      subclasses
+    end
+
+  end
+
+end

data/lib/bbc/programmes/brand.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Brand < Programme
+    type RDF::PO.Brand
+  
+    has_many :series, :predicate => RDF::PO.series, :type => 'BBC_Programmes_Series'
+    has_many :episodes, :predicate => RDF::PO.episode, :type => 'BBC_Programmes_Episode'
+  end
+
+end

data/lib/bbc/programmes/broadcast.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Broadcast < Base
+    type RDF::PO.Broadcast
+
+    default_vocabulary RDF::PO
+    property :time, :predicate => RDF::URI('http://purl.org/NET/c4dm/event.owl#time'), :type => 'BBC_Programmes_TimeInterval'
+    property :schedule_date, :type => String # Date
+    property :broadcast_of, :type => 'BBC_Programmes_Version'
+    property :broadcast_on, :type => 'BBC_Programmes_Service'
+
+    def start
+      time.nil? ? nil : time.start
+    end
+
+    def end
+      time.nil? ? nil : time.end
+    end
+
+    def service
+      broadcast_on
+    end
+
+    def version
+      broadcast_of
+    end
+
+  end
+end

data/lib/bbc/programmes/episode.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Episode < Programme
+    type RDF::PO.Episode
+  
+    default_vocabulary RDF::PO
+    property :position, :type => Integer
+    has_many :versions, :predicate => RDF::PO.version, :type => 'BBC_Programmes_Version'
+  end
+  
+end

data/lib/bbc/programmes/programme.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Programme < Base
+    default_vocabulary RDF::PO
+    type RDF::PO.Programme
+
+    property :title, :predicate => DC11.title, :type => String
+    property :short_synopsis, :type => String
+    property :medium_synopsis, :type => String
+    property :long_synopsis, :type => String
+    property :image, :predicate => FOAF.depiction, :type => RDF::URI
+
+    # FIXME: this should be of type service
+    property :masterbrand, :type => RDF::URI
+
+    # FIXME: implement this
+    #has_many :genres
+    #has_many :formats
+
+    def self.id_for(identifier)
+      if identifier.is_a?(::String)
+        super(
+          RDF::URI("#{base_uri}/#{identifier}#programme")
+        )
+      else
+        super(identifier)
+      end
+    end
+  end
+
+end

data/lib/bbc/programmes/segment.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Segment < Base
+    type RDF::PO.Segment
+
+    default_vocabulary RDF::PO
+    property :label, :predicate => RDF::RDFS.label, :type => String
+    
+    def to_s
+      label
+    end
+    
+    # FIXME: add support for fetching full details of a segment
+  end
+
+end

data/lib/bbc/programmes/series.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Series < Programme
+    type RDF::PO.Series
+      
+    default_vocabulary RDF::PO
+    property :position, :type => Integer
+    has_many :series, :predicate => RDF::PO.series, :type => 'BBC_Programmes_Series'
+    has_many :episodes, :predicate => RDF::PO.episode, :type => 'BBC_Programmes_Episode'
+  end
+    
+end

data/lib/bbc/programmes/service.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Service < Base
+    type RDF::PO.Service
+
+    default_vocabulary RDF::PO
+    property :label, :predicate => RDF::RDFS.label, :type => String
+    property :parent, :predicate => RDF::PO.parent_service, :type => 'BBC_Programmes_Service'
+
+    def to_s
+      label.to_s
+    end
+  end
+
+end

data/lib/bbc/programmes/time_interval.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class TimeInterval
+    include Spira::Resource
+
+    type RDF::TimeLine.Interval
+    property :start, :predicate => RDF::TimeLine.start, :type => Any
+    property :end, :predicate => RDF::TimeLine.end, :type => Any
+    property :duration, :predicate => RDF::TimeLine.end, :type => String # Duration
+    property :position, :predicate => RDF::PO.position, :type => Integer
+    property :timeline, :predicate => RDF::TimeLine.timeline, :type => 'BBC_Programmes_TimeLine'
+  end
+
+end

data/lib/bbc/programmes/time_line.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class TimeLine
+    include Spira::Resource
+    type RDF::TimeLine.TimeLine
+  end
+
+end

data/lib/bbc/programmes/version.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+module BBC::Programmes
+
+  class Version < Base
+    type RDF::PO.Version
+
+    default_vocabulary RDF::PO
+    property :aspect_ratio, :type => String
+    property :sound_format, :type => String
+    property :duration, :type => Integer
+    property :time, :predicate => RDF::PO.time, :type => 'BBC_Programmes_TimeInterval'
+
+    def self.id_for(identifier)
+      if identifier.is_a?(::String)
+        super(
+          RDF::URI("#{base_uri}/#{identifier}#programme")
+        )
+      else
+        super(identifier)
+      end
+    end
+
+    def broadcasts
+      # FIXME: can this be done using inverse properties?
+      Broadcast.repository.query([nil, RDF::PO.broadcast_of, subject]).map do |b|
+        b.subject.as(Broadcast)
+      end
+    end
+
+    def timeline
+      time.nil? ? nil : time.timeline
+    end
+
+    def intervals
+      TimeInterval.repository.query([nil, RDF::TimeLine.timeline, timeline.subject]).map do |b|
+        b.subject.as(TimeInterval)
+      end
+    end
+
+    def segments
+      intervals = self.intervals.select {|i| !i.position.nil?}
+      intervals.sort! {|a,b| (a.position.to_i||0) <=> (b.position.to_i||0)}
+      intervals.map do |interval|
+        segment = Segment.repository.first_subject([nil, RDF::PO.time, interval.subject])
+        segment.nil? ? nil : segment.as(Segment)
+      end
+    end
+  end
+
+end

data/lib/bbc/programmes.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+require 'rdf'
+require 'rdf/raptor'
+require 'rdf/po'
+require 'rdf/time_line'
+require 'net/http'
+require 'addressable/uri'
+require 'spira'
+
+
+module BBC
+  module Programmes
+    BASE_URI = 'http://www.bbc.co.uk/programmes'
+    USER_AGENT = "bbc-programmes-ruby/0.1"
+
+    require 'bbc/programmes/base'
+    require 'bbc/programmes/programme'
+    require 'bbc/programmes/brand'
+    require 'bbc/programmes/episode'
+    require 'bbc/programmes/series'
+    require 'bbc/programmes/version'
+    require 'bbc/programmes/service'
+    require 'bbc/programmes/broadcast'
+    require 'bbc/programmes/segment'
+
+    require 'bbc/programmes/time_interval'
+    require 'bbc/programmes/time_line'
+
+    def self.search(keywords)
+      encoded = Addressable::URI.encode(keywords)
+      graph = http_get_graph("#{BASE_URI}/a-z/by/#{encoded}/all.rdf")
+
+      # FIXME: push graph into the repository?
+
+      programmes = []
+      graph.query([nil, RDF.type, RDF::PO.Programme]) do |s|
+        programme = Programme.for(s.subject)
+        programme.title = graph.first_literal([s.subject, RDF::DC11.title, nil])
+        programmes << programme
+      end
+      programmes
+    end
+
+    # Fetches and returns a Graph for an identifier
+    def self.http_get_graph(uri)
+      uri = RDF::URI(uri) unless uri.is_a?(RDF::URI)
+
+      # FIXME: support other HTTP libraries too
+      res = Net::HTTP.start(uri.host, uri.port) do |http|
+        http.get(uri.request_uri, {
+          'User-Agent' => USER_AGENT,
+          'Accept' => 'application/rdf+xml'
+        })
+      end
+
+      # Throw an exception if it failed
+      res.value
+
+      # Find a reader for the content type returned
+      reader_class = RDF::Reader.for(:content_type => res.content_type)
+      raise "No reader found for parsing: #{res.content_type}" if reader_class.nil?
+
+      # Parse the RDF
+      RDF::Graph.new(uri) do |graph|
+        reader_class.new(res.body, :base_uri => uri) do |reader|
+          reader.each_statement do |statement|
+            graph << statement
+          end
+        end
+      end
+    end
+
+    # Load a subject into the local repository
+    def self.fetch(identifier)
+      unless identifier.is_a?(RDF::URI)
+        identifier = RDF::URI("#{BASE_URI}/#{identifier}")
+      end
+
+      graph = self.http_get_graph(identifier)
+
+      type = graph.first_object([identifier, RDF.type, nil])
+      raise "No type found for #{identifier}" if type.nil?
+
+      klass = BBC::Programmes::Base.subclasses.find { |k| k.type == type }
+      raise "No class found for #{identifier} of type #{type}" if klass.nil?
+
+      # Add the graph to the repository of the type
+      graph.each_statement do |s|
+        klass.repository << s
+      end
+
+      klass.for(identifier)
+    end
+
+  end
+end
+
+
+# FIXME: hack for Spira not supporting namespaced resources
+BBC_Programmes_Programme = BBC::Programmes::Programme
+BBC_Programmes_Brand = BBC::Programmes::Brand
+BBC_Programmes_Episode = BBC::Programmes::Episode
+BBC_Programmes_Series = BBC::Programmes::Series
+BBC_Programmes_Version = BBC::Programmes::Version
+BBC_Programmes_Service = BBC::Programmes::Service
+BBC_Programmes_Broadcast = BBC::Programmes::Broadcast
+BBC_Programmes_Segment = BBC::Programmes::Segment
+BBC_Programmes_TimeInterval = BBC::Programmes::TimeInterval
+BBC_Programmes_TimeLine = BBC::Programmes::TimeLine

data/lib/rdf/po.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+module RDF
+
+  ##
+  # Programmes Ontology vocabulary.
+  #
+  # @see http://purl.org/ontology/po/
+  class PO < RDF::Vocabulary('http://purl.org/ontology/po/')
+    property :Brand
+    property :Series
+    property :Episode
+    property :Programme
+    property :Version
+  end
+
+end

data/lib/rdf/time_line.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+module RDF
+
+  ##
+  # Timeline vocabulary.
+  #
+  # @see http://purl.org/NET/c4dm/timeline.owl
+  class TimeLine < RDF::Vocabulary('http://purl.org/NET/c4dm/timeline.owl#')
+  end
+
+end

data/spec/bbc-programmes.spec

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + "/spec_helper.rb"
+
+describe BBC::Programmes do
+  before :each do
+    @repo = RDF::Repository.new
+    Spira.add_repository(:default, @repo)
+  end
+
+  context "performing an HTTP get for a URI" do
+    before :each do
+      mock_http('www.bbc.co.uk', 'b00jnwlc.rdf')
+      @uri = RDF::URI('http://www.bbc.co.uk/programmes/b00jnwlc#programme')
+      @graph = BBC::Programmes.http_get_graph(@uri)
+    end
+
+    it "should return an object of type RDF::Graph" do
+      @graph.should be_a RDF::Graph
+    end
+
+    it "should return a graph with more than 10 statements" do
+      @graph.size.should > 10
+    end
+
+    it "should return multiple statements about the URI looked up" do
+      @graph.query([@uri, nil, nil]).count.should > 2
+    end
+
+    it "should return a triple stating that the programme is of type Brand" do
+      @graph.should have_triple([@uri, RDF.type, RDF::PO.Brand])
+    end
+  end
+
+  context "searching for a keyword" do
+    before :each do
+      mock_http('www.bbc.co.uk', 'the_wire.rdf')
+      @programmes = BBC::Programmes.search("The Wire")
+    end
+
+    it "should return an array" do
+      @programmes.should be_a Array
+    end
+
+    it "should have three items in the array" do
+      @programmes.size.should == 3
+    end
+
+    it "should have items of type Programme in the array" do
+      @programmes.first.should be_a BBC::Programmes::Programme
+    end
+  end
+
+  context "fetching an episode" do
+    before :each do
+      mock_http('www.bbc.co.uk', 'b00jnwnv.rdf')
+      @episode = BBC::Programmes.fetch('b00jnwnv#programme')
+    end
+
+    it "should have a type URI defined" do
+      @episode.type.should == RDF::URI('http://purl.org/ontology/po/Episode')
+    end
+
+    it "should have a correct URI" do
+      @episode.subject.should == RDF::URI('http://www.bbc.co.uk/programmes/b00jnwnv#programme')
+    end
+
+    it "should have the title 'The Target'" do
+      @episode.title.should == 'The Target'
+    end
+  end
+
+end