em-sofa 0.1.1

data/lib/em-sofa/tvrage/schedule.rb

@@ -0,0 +1,28 @@
+module EventMachine
+  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
+        Base_Uri = 'services.tvrage.com/feeds'
+
+        extend TVRage
+
+        class << self
+          # Gets the full schedule for country
+          #
+          # @param country [String] The country to query in (US, UK, NL)
+          # @param &block [Block] Called back with result unless fibered
+          # @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, &block)
+            return Request.fibered(method(__method__), country) if defined? Fiber and Fiber.respond_to? :current and not block
+            Request.new(Base_Uri, '/fullschedule.php', block, :return_element => 'schedule', :country => country)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/em-sofa/tvrage/season.rb

@@ -0,0 +1,38 @@
+module EventMachine
+  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 EM:Sofa::Mapping
+        maps(:no => nil)
+
+        # Maps :episode to :episodes
+        # @see EM: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
+end

data/lib/em-sofa/tvrage/show.rb

@@ -0,0 +1,193 @@
+module EventMachine
+  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
+        Base_Uri = 'services.tvrage.com'
+
+        extend TVRage
+
+        class << self
+          # Gets the info for a Show.
+          #
+          # @param sid [String] The show's id
+          # @param &block [Block] Called back with the parsed XML when successful unless fibered
+          # @return [EM:TVRage::Request] TVRage request object or result hash if fibered
+          # @see http://services.tvrage.com/feeds/showinfo.php?sid=15614 Chuck's Show Info
+          def info(sid, &block)
+            return fibered_async(__method__, sid, options) if defined? Fiber and Fiber.respond_to? :current and not block
+            raise ArgumentError, "No block given for completion callback" unless block
+            Request.new(Base_Uri, '/feeds/showinfo.php', block, :return_element => 'Showinfo', :sid => sid)
+          end
+
+          # Gets the full show info (info + season list + episode list) for a Show.
+          #
+          # @param sid [String] The show's id
+          # @param &block [Block] Called back with the parsed XML when successful unless fibered
+          # @return [EM:TVRage::Request] TVRage request object or result hash if fibered
+          # @see http://services.tvrage.com/feeds/full_show_info.php?sid=15614 Chuck's Full Show Info
+          def full_info(sid, &block)
+            return fibered_async(__method__, sid, options) if defined? Fiber and Fiber.respond_to? :current and not block
+            raise ArgumentError, "No block given for completion callback" unless block
+            Request.new(Base_Uri, '/feeds/full_show_info.php', block, :return_element => 'Show', :sid => sid)
+          end
+
+          # Gets the episode list for a Show.
+          #
+          # @param sid [String] The show's id
+          # @param &block [Block] Called back with the parsed XML when successful unless fibered
+          # @return [EM:TVRage::Request] TVRage request object or result hash if fibered
+          # @see http://services.tvrage.com/feeds/episode_list.php?sid=15614 Chuck's Episode List
+          def episode_list(sid, &block)
+            return Request.fibered(method(__method__), sid) if defined? Fiber and Fiber.respond_to? :current and not block
+            raise ArgumentError, "No block given for completion callback" unless block
+            Request.new(Base_Uri, '/feeds/episode_list.php', block, :return_element => 'Show', :sid => sid)
+          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
+          # @param &block [Block] Called back with the show with id parsed from the Quickinfo search unless fibered
+          # @return [EM:TVRage::Request] TVRage request object or result Show object if fibered
+          # @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 = {}, &block)
+            return Request.fibered(method(__method__), name, options) if defined? Fiber and Fiber.respond_to? :current and not block
+            raise ArgumentError, "No block given for completion callback" unless block
+            Request.new(Base_Uri, '/tools/quickinfo.php', block, :parse_element => 'pre', :show => name) do |request, xml|
+              options[:info] = parsed_quickinfo(xml)
+              Show.new(options[:info]['showid'], options) {|show| request.succeed show }
+            end
+          end
+
+          def parsed_quickinfo(raw_info)
+            info = Hash[raw_info.split(/\n/).collect {|line| k, v = line.split /@/; [k.gsub(' ', '').downcase, v] }]
+            info['showlink'] = info.delete('showurl')
+            info.each_key do |key|
+              case key.to_sym
+                when :latestepisode, :nextepisode
+                  info[key] = Hash[[:number, :name, :date].zip(info[key].split /\^/)]
+                  info[key][:date] = Date.parse(info[key][:date])
+                when :genres
+                  info[key] = info[key].split ' | '
+              end
+            end
+          end
+        end
+
+        include Mapping
+
+        # @see EM: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,
+          :latestepisode  => :latest_episode,
+          :nextepisode    => :next_episode
+        )
+        maps(:genres => nil) #{ |value| value["genre"] }
+        maps(:akas => nil) { |value| value["aka"] }
+
+        # Maps :Episodelist to :season_list
+        # @see EM: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
+        # @param &block [Block] Called back with the show with parsed info unless fibered
+        def initialize(id, options = {}, &block)
+          raise RuntimeError.new("id is required") unless (@show_id = id)
+          return TVRage::Request.fibered(method(__method__), id, options) if defined? Fiber and Fiber.respond_to? :current and not block
+          raise ArgumentError, "No block given for completion callback" unless block
+          klass = self.class
+          if options[:greedy]
+            return block.call(self) if @greedy
+            klass.full_info(@show_id) do |full_info|
+              next block.call(nil) unless full_info
+              update_with_mapping(@greedy = full_info)
+              block.call(self)
+            end
+          elsif options[:info]
+            update_with_mapping(options[:info])
+            block.call(self)
+          else
+            klass.info(@show_id) do |info|
+              next block.call(nil) unless info
+              update_with_mapping(info)
+              block.call(self)
+            end
+          end
+        end
+
+        # @param &block [Block] Called back with the list of seasons
+        def season_list(&block)
+          if defined? Fiber and Fiber.respond_to? :current and not block
+            f = Fiber.current
+            method(__method__).call {|data| f.resume(data) }
+            return Fiber.yield
+          end
+          raise ArgumentError, "No block given for completion callback" unless block
+          puts "@season_list = #@season_list" if @season_list
+          return block.call(@season_list) if @season_list
+          self.class.episode_list(@show_id) do |episode_list|
+            update_with_mapping(episode_list)
+            block.call(@season_list)
+          end
+          true
+        end
+
+        # @param &block [Block] Called back with the list of episodes
+        def episode_list(&block)
+          if defined? Fiber and Fiber.respond_to? :current and not block
+            f = Fiber.current
+            method(__method__).call {|data| f.resume(data) }
+            return Fiber.yield
+          end
+          raise ArgumentError, "No block given for completion callback" unless block
+          season_list do |seasons|
+            block.call(seasons.collect { |season| season.episodes }.flatten)
+          end
+          true
+        end
+
+        class NotFound < RuntimeError
+        end
+      end
+    end
+  end
+end

data/lib/em-sofa/version.rb

@@ -0,0 +1,10 @@
+module EventMachine
+  module Sofa
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  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>