sofa 0.1.1 → 0.1.2

data/lib/sofa/tvrage.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+
+module Sofa
+  module TVRage
+    autoload :Schedule, 'sofa/tvrage/schedule'
+    autoload :Show, 'sofa/tvrage/show'
+    autoload :Season, 'sofa/tvrage/season'
+    autoload :Episode, 'sofa/tvrage/episode'
+  end
+end

data/lib/sofa/tvrage/episode.rb

@@ -0,0 +1,56 @@
+module Sofa
+  module TVRage
+    # This class holds the XML information of a single episode as per the TVRage API.
+    #
+    # @see http://services.tvrage.com/index.php?page=public TVRage API : Episode List
+    class Episode
+      include Mapping
+
+      include HTTParty
+      format :xml
+      base_uri 'services.tvrage.com'
+
+      class << self
+        # Gets the info for a Episode.
+        #
+        # @param sid [String] The show's id
+        # @return [Hash] The parsed XML
+        # @see http://services.tvrage.com/feeds/episodeinfo.php?sid=2930&ep=2x04
+        def info(sid, season_no, ep_num)
+          xml = get('/feeds/episodeinfo.php', :query => {:sid => sid, :ep => "#{season_no}x#{ep_num}"})
+          xml["show"]
+        end
+      end
+
+
+      # @see Sofa::Mapping
+      maps(
+        :epnum     => :num,
+        :seasonnum => :num_in_season,
+        :prodnum   => :prod_num,
+        :airdate   => :air_date,
+        :link      => nil,
+        :title     => nil
+      )
+
+      # The season number of the Season this Episode belongs to.
+      # Not actually a part of the TVRage API, but it's used to inject
+      # the +season_num+ when looping through Episodes in a Season.
+      attr_reader :season_num
+
+      # Returns a new instance of Episode, mapping info from the TVRage API
+      #
+      # @param info [Hash<Symbol, Object>] Info to initialize with
+      # @option info [String] :epnum The episode number in the context of all episodes
+      # @option info [String] :seasonnum The episode number in the context of its season
+      # @option info [String] :prodnum
+      # @option info [String] :airdate The date the episode airs
+      # @option info [String] :link The TVRage page for this Episode
+      # @option info [String] :title The title of this Episode
+      # @option info [String] :season_num The season number of the Season this Episode belongs to
+      def initialize(info)
+        update_with_mapping(info)
+      end
+    end
+  end
+end

data/lib/sofa/tvrage/schedule.rb

@@ -0,0 +1,25 @@
+module Sofa
+  module TVRage
+    # This class will hold the full/quick schedule information as per the TVRage API.
+    #
+    # @see http://services.tvrage.com/index.php?page=public&go=fullschedule TVRage API : Full Schedule
+    # @see http://services.tvrage.com/index.php?page=public&go=quickschedule TV Rage API : Quick Schedule
+    class Schedule
+      include HTTParty
+      format :xml
+      base_uri 'services.tvrage.com/feeds'
+
+      class << self
+        # Gets the full schedule for country
+        #
+        # @param country [String] The country to query in (US, UK, NL)
+        # @return [Hash] The parsed XML of schedule information
+        # @see http://services.tvrage.com/feeds/fullschedule.php?country=US US's Full Schedule
+        def full(country)
+          xml = get("/fullschedule.php", :query => {:country => country})
+          xml["schedule"]
+        end
+      end
+    end
+  end
+end

data/lib/sofa/tvrage/season.rb

@@ -0,0 +1,36 @@
+module Sofa
+  module TVRage
+    # This class holds the XML information of a single season as per the TVRage API.
+    #
+    # @see http://services.tvrage.com/index.php?page=public TVRage API : Episode List
+    class Season
+      include Mapping
+
+      # Maps :no to itself
+      # @see Sofa::Mapping
+      maps(:no => nil)
+      
+      # Maps :episode to :episodes
+      # @see Sofa::Mapping
+      # @yieldparam value [Hash, Array] A Hash of info if there's only one. An Array of info if there's multiple
+      # @yieldreturn [Array] A list of episodes initialized with value
+      maps(:episode => :episodes) do |value|
+        case value
+        when Hash
+          [Episode.new(value)]
+        when Array
+          value.map { |info| Episode.new(info) }
+        end
+      end
+
+      # Returns a new instance of Season, mapping info from the TVRage API
+      #
+      # @param info [Hash<Symbol, Object>] Info to initialize with
+      # @option info [String] :no The season number
+      # @option info [String] :episode The collection of episodes
+      def initialize(info)
+        update_with_mapping(info)
+      end
+    end
+  end
+end

data/lib/sofa/tvrage/show.rb

@@ -0,0 +1,132 @@
+module Sofa
+  module TVRage
+    # This class holds the XML information of a single Show as per the TVRage API.
+    # It's also the root point for communicating with the API.
+    #
+    # @see http://services.tvrage.com/index.php?page=public TVRage API
+    class Show
+      include HTTParty
+      format :xml
+      base_uri 'services.tvrage.com'
+
+      class << self
+        # Gets the info for a Show.
+        #
+        # @param sid [String] The show's id
+        # @return [Hash] The parsed XML
+        # @see http://services.tvrage.com/feeds/showinfo.php?sid=15614 Chuck's Show Info
+        def info(sid)
+          xml = get('/feeds/showinfo.php', :query => {:sid => sid})
+          xml["Showinfo"]
+        end
+
+        # Gets the full show info (info + season list + episode list) for a Show.
+        #
+        # @param sid [String] The show's id
+        # @return [Hash] The parsed XML
+        # @see http://services.tvrage.com/feeds/full_show_info.php?sid=15614 Chuck's Full Show Info
+        def full_info(sid)
+          xml = get('/feeds/full_show_info.php', :query => {:sid => sid})
+          xml["Show"]
+        end
+
+        # Gets the episode list for a Show.
+        #
+        # @param sid [String] The show's id
+        # @return [Hash] The parsed XML
+        # @see http://services.tvrage.com/feeds/episode_list.php?sid=15614 Chuck's Episode List
+        def episode_list(sid)
+          xml = get('/feeds/episode_list.php', :query => {:sid => sid})
+          xml["Show"]
+        end
+
+        # Finds the Show by name using TVRage's Quickinfo API.
+        #
+        # @param name [String] The name of the show to search for
+        # @option options [Boolean] :greedy Whether or not to eager load the Season and Episode info
+        # @return [Show] The show with id parsed from the Quickinfo search
+        # @see http://services.tvrage.com/index.php?page=public&go=quickinfo TVRage Quickinfo API
+        # @see http://services.tvrage.com/tools/quickinfo.php?show=Chuck Chuck's Quickinfo
+        def by_name(name, options = {})
+          html = get('/tools/quickinfo.php', :query => {:show => name}, :format => :html)
+          show_info = Crack::XML.parse(html)["pre"]
+          raise ShowNotFound unless show_info
+          id = show_info.split("\n").first.gsub(%r{^Show ID@}, '').strip
+          Show.new(id, options)
+        end        
+      end
+
+      include Mapping
+
+      # @see Sofa::Mapping
+      maps(
+        :ended          => nil,
+        :showid         => :show_id,
+        :showname       => :name,
+        :name           => nil,
+        :showlink       => :show_link,
+        :seasons        => nil,
+        :started        => nil,
+        :startdate      => :start_date,
+        :ended          => nil,
+        :origin_country => nil,
+        :status         => nil,
+        :classification => nil,
+        :runtime        => :run_time,
+        :network        => nil,
+        :airtime        => :air_time,
+        :airday         => :air_day,
+        :timezone       => :time_zone
+      )
+      maps(:genres => nil) { |value| value["genre"] }
+      maps(:akas => nil) { |value| value["aka"] }
+
+      # Maps :Episodelist to :season_list
+      # @see Sofa::Mapping
+      # @yieldparam value [Hash, Array] A Hash of info if there's only one. An Array of info if there's multiple
+      # @yieldreturn [Array] A list of seasons initialized with value
+      maps(:Episodelist => :season_list) do |value|
+        case seasons = value["Season"]
+        when Hash
+          [Season.new(seasons)]
+        when Array
+          seasons.map { |info| Season.new(info) }
+        end
+      end
+
+      # Stores all the info that was greedy-loaded
+      #
+      # @return [Hash] The full show info (including seasons and episodes)
+      # @see Show.full_info
+      attr_accessor :greedy
+
+      # Returns a new instance of Show, loading and then mapping info from the TVRage API.
+      #
+      # @param id [String] The show_id as per the TVRage API
+      # @option options [Boolean] :greedy Whether or not to eager load the Season and Episode info
+      def initialize(id, options = {})
+        raise RuntimeError.new("id is required") unless (@show_id = id)
+        klass = self.class
+        if options[:greedy]
+          update_with_mapping(@greedy = klass.full_info(@show_id))
+        else
+          update_with_mapping(klass.info(@show_id))
+        end
+      end
+
+      # @return [Array] The list of seasons
+      def season_list
+        update_with_mapping(self.class.episode_list(@show_id)) unless @season_list
+        @season_list
+      end
+
+      # @return [Array] The list of episodes
+      def episode_list
+        season_list.map { |season| season.episodes }.flatten
+      end
+
+      class ShowNotFound < RuntimeError #:nodoc:
+      end
+    end
+  end
+end

data/lib/sofa/version.rb

@@ -0,0 +1,8 @@
+module Sofa
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 2
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/sofa.gemspec

@@ -0,0 +1,113 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sofa"
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Henry Hsu"]
+  s.date = "2013-01-22"
+  s.description = "A simple Ruby library for the TVRage API."
+  s.email = "henry@qlane.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".yardopts",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "doc/Sofa.html",
+    "doc/Sofa/Mapping.html",
+    "doc/Sofa/Mapping/ClassMethods.html",
+    "doc/Sofa/Mapping/InstanceMethods.html",
+    "doc/Sofa/TVRage.html",
+    "doc/Sofa/TVRage/Episode.html",
+    "doc/Sofa/TVRage/Schedule.html",
+    "doc/Sofa/TVRage/Season.html",
+    "doc/Sofa/TVRage/Show.html",
+    "doc/Sofa/TVRage/Show/ShowNotFound.html",
+    "doc/Sofa/Version.html",
+    "doc/_index.html",
+    "doc/class_list.html",
+    "doc/css/common.css",
+    "doc/css/full_list.css",
+    "doc/css/style.css",
+    "doc/file.README.html",
+    "doc/file_list.html",
+    "doc/index.html",
+    "doc/js/app.js",
+    "doc/js/full_list.js",
+    "doc/js/jquery.js",
+    "doc/method_list.html",
+    "doc/top-level-namespace.html",
+    "lib/sofa.rb",
+    "lib/sofa/mapping.rb",
+    "lib/sofa/tvrage.rb",
+    "lib/sofa/tvrage/episode.rb",
+    "lib/sofa/tvrage/schedule.rb",
+    "lib/sofa/tvrage/season.rb",
+    "lib/sofa/tvrage/show.rb",
+    "lib/sofa/version.rb",
+    "sofa.gemspec",
+    "spec/fixtures/tvrage/cases/castle.xml",
+    "spec/fixtures/tvrage/cases/community.xml",
+    "spec/fixtures/tvrage/cases/live_with_regis_and_kelly.xml",
+    "spec/fixtures/tvrage/episode_info.xml",
+    "spec/fixtures/tvrage/episode_list.xml",
+    "spec/fixtures/tvrage/episode_list_one_season.xml",
+    "spec/fixtures/tvrage/episode_list_two_episodes.xml",
+    "spec/fixtures/tvrage/full_schedule.xml",
+    "spec/fixtures/tvrage/full_show_info.xml",
+    "spec/fixtures/tvrage/quickinfo.html",
+    "spec/fixtures/tvrage/quickinfo_missing.html",
+    "spec/fixtures/tvrage/search.xml",
+    "spec/fixtures/tvrage/show_info.xml",
+    "spec/fixtures/tvrage/show_info_blank.xml",
+    "spec/fixtures/tvrage/single_episode.xml",
+    "spec/sofa/mapping_spec.rb",
+    "spec/sofa/tvrage/cases_spec.rb",
+    "spec/sofa/tvrage/episode_spec.rb",
+    "spec/sofa/tvrage/schedule_spec.rb",
+    "spec/sofa/tvrage/season_spec.rb",
+    "spec/sofa/tvrage/show_spec.rb",
+    "spec/sofa/version_spec.rb",
+    "spec/sofa_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/hsume2/sofa"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A Ruby library for the TVRage API."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/spec/fixtures/tvrage/cases/castle.xml

@@ -0,0 +1,228 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Show>
+  <name>Castle (2009)</name>
+  <totalseasons>2</totalseasons>
+  <showid>19267</showid>
+  <showlink>http://tvrage.com/Castle</showlink>
+  <started>Mar/09/2009</started>
+  <ended/>
+  <image>http://images.tvrage.com/shows/20/19267.jpg</image>
+  <origin_country>US</origin_country>
+  <status>Returning Series</status>
+  <classification>Scripted</classification>
+  <genres>
+    <genre>Crime</genre>
+    <genre>Drama</genre>
+    <genre>Mystery</genre>
+  </genres>
+  <runtime>60</runtime>
+  <network country="US">ABC</network>
+  <airtime>22:00</airtime>
+  <airday>Monday</airday>
+  <timezone>GMT-5 -DST</timezone>
+  <Episodelist>
+    <Season no="1">
+      <episode>
+        <epnum>1</epnum>
+        <seasonnum>01</seasonnum>
+        <prodnum>101</prodnum>
+        <airdate>2009-03-09</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/703445</link>
+        <title>Flowers for Your Grave</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/703445.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>2</epnum>
+        <seasonnum>02</seasonnum>
+        <prodnum>102</prodnum>
+        <airdate>2009-03-16</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781859</link>
+        <title>Nanny McDead</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/781859.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>3</epnum>
+        <seasonnum>03</seasonnum>
+        <prodnum>103</prodnum>
+        <airdate>2009-03-23</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781860</link>
+        <title>Hedge Fund Homeboys</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/781860.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>4</epnum>
+        <seasonnum>04</seasonnum>
+        <prodnum>104</prodnum>
+        <airdate>2009-03-30</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781861</link>
+        <title>Hell Hath No Fury</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/781861.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>5</epnum>
+        <seasonnum>05</seasonnum>
+        <prodnum>105</prodnum>
+        <airdate>2009-04-06</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781862</link>
+        <title>A Chill Goes Through Her Veins</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/781862.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>6</epnum>
+        <seasonnum>06</seasonnum>
+        <prodnum>106</prodnum>
+        <airdate>2009-04-13</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781864</link>
+        <title>Always Buy Retail</title>
+      </episode>
+      <episode>
+        <epnum>7</epnum>
+        <seasonnum>07</seasonnum>
+        <prodnum>107</prodnum>
+        <airdate>2009-04-20</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781863</link>
+        <title>Home Is Where the Heart Stops</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/781863.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>8</epnum>
+        <seasonnum>08</seasonnum>
+        <prodnum>108</prodnum>
+        <airdate>2009-04-27</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781865</link>
+        <title>Ghosts</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/781865.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>9</epnum>
+        <seasonnum>09</seasonnum>
+        <prodnum>109</prodnum>
+        <airdate>2009-05-04</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781866</link>
+        <title>Little Girl Lost</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/781866.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>10</epnum>
+        <seasonnum>10</seasonnum>
+        <prodnum>110</prodnum>
+        <airdate>2009-05-11</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/781867</link>
+        <title>A Death in the Family</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/781867.jpg</screencap>
+      </episode>
+    </Season>
+    <Season no="2">
+      <episode>
+        <epnum>11</epnum>
+        <seasonnum>01</seasonnum>
+        <prodnum>201</prodnum>
+        <airdate>2009-09-21</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064812069</link>
+        <title>Deep in Death</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/1064812069.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>12</epnum>
+        <seasonnum>02</seasonnum>
+        <prodnum>202</prodnum>
+        <airdate>2009-09-28</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064824888</link>
+        <title>The Double Down</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/1064824888.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>13</epnum>
+        <seasonnum>03</seasonnum>
+        <prodnum>203</prodnum>
+        <airdate>2009-10-05</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064824889</link>
+        <title>Inventing the Girl</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/1064824889.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>14</epnum>
+        <seasonnum>04</seasonnum>
+        <prodnum>204</prodnum>
+        <airdate>2009-10-12</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064824890</link>
+        <title>Fool Me Once</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/1064824890.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>15</epnum>
+        <seasonnum>05</seasonnum>
+        <prodnum>205</prodnum>
+        <airdate>2009-10-19</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842856</link>
+        <title>When the Bough Breaks</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/1064842856.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>16</epnum>
+        <seasonnum>06</seasonnum>
+        <prodnum>206</prodnum>
+        <airdate>2009-10-26</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842857</link>
+        <title>Vampire Weekend</title>
+        <screencap>http://images.tvrage.com/screencaps/97/19267/1064842857.jpg</screencap>
+      </episode>
+      <episode>
+        <epnum>17</epnum>
+        <seasonnum>07</seasonnum>
+        <prodnum>207</prodnum>
+        <airdate>2009-11-02</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842858</link>
+        <title>Famous Last Words</title>
+      </episode>
+      <episode>
+        <epnum>18</epnum>
+        <seasonnum>08</seasonnum>
+        <prodnum>208</prodnum>
+        <airdate>2009-11-09</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842859</link>
+        <title>Kill the Messenger</title>
+      </episode>
+      <episode>
+        <epnum>19</epnum>
+        <seasonnum>09</seasonnum>
+        <prodnum>209</prodnum>
+        <airdate>2009-11-16</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842860</link>
+        <title>Love Me Dead</title>
+      </episode>
+      <episode>
+        <epnum>20</epnum>
+        <seasonnum>10</seasonnum>
+        <prodnum>210</prodnum>
+        <airdate>2009-11-23</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842861</link>
+        <title>One Man's Treasure</title>
+      </episode>
+      <episode>
+        <epnum>21</epnum>
+        <seasonnum>11</seasonnum>
+        <prodnum>211</prodnum>
+        <airdate>2009-11-30</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842862</link>
+        <title>The Fifth Bullet</title>
+      </episode>
+      <episode>
+        <epnum>22</epnum>
+        <seasonnum>12</seasonnum>
+        <prodnum>212</prodnum>
+        <airdate>0000-00-00</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842863</link>
+        <title>Season 2, Episode 12</title>
+      </episode>
+      <episode>
+        <epnum>23</epnum>
+        <seasonnum>13</seasonnum>
+        <prodnum>213</prodnum>
+        <airdate>0000-00-00</airdate>
+        <link>http://www.tvrage.com/Castle/episodes/1064842864</link>
+        <title>Season 2, Episode 13</title>
+      </episode>
+    </Season>
+  </Episodelist>
+</Show>