RubyGems - sofa - Versions diffs - 0.1.0 - Mend

sofa 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (64) hide show

data/.document +5 -0
data/.gitignore +22 -0
data/.yardopts +6 -0
data/LICENSE +20 -0
data/README.md +72 -0
data/Rakefile +76 -0
data/doc/Sofa.html +85 -0
data/doc/Sofa/Mapping.html +168 -0
data/doc/Sofa/Mapping/ClassMethods.html +314 -0
data/doc/Sofa/Mapping/InstanceMethods.html +358 -0
data/doc/Sofa/TVRage.html +85 -0
data/doc/Sofa/TVRage/Episode.html +358 -0
data/doc/Sofa/TVRage/Schedule.html +207 -0
data/doc/Sofa/TVRage/Season.html +236 -0
data/doc/Sofa/TVRage/Show.html +904 -0
data/doc/Sofa/TVRage/Show/ShowNotFound.html +92 -0
data/doc/Sofa/Version.html +100 -0
data/doc/_index.html +206 -0
data/doc/class_list.html +137 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +23 -0
data/doc/css/style.css +261 -0
data/doc/file.README.html +120 -0
data/doc/file_list.html +29 -0
data/doc/index.html +120 -0
data/doc/js/app.js +91 -0
data/doc/js/full_list.js +39 -0
data/doc/js/jquery.js +19 -0
data/doc/method_list.html +192 -0
data/doc/top-level-namespace.html +80 -0
data/lib/sofa.rb +5 -0
data/lib/sofa/mapping.rb +108 -0
data/lib/sofa/tvrage.rb +10 -0
data/lib/sofa/tvrage/episode.rb +39 -0
data/lib/sofa/tvrage/schedule.rb +25 -0
data/lib/sofa/tvrage/season.rb +36 -0
data/lib/sofa/tvrage/show.rb +132 -0
data/lib/sofa/version.rb +8 -0
data/sofa.gemspec +126 -0
data/spec/fixtures/tvrage/cases/castle.xml +228 -0
data/spec/fixtures/tvrage/cases/community.xml +109 -0
data/spec/fixtures/tvrage/cases/live_with_regis_and_kelly.xml +56237 -0
data/spec/fixtures/tvrage/episode_list.xml +1183 -0
data/spec/fixtures/tvrage/episode_list_one_season.xml +17 -0
data/spec/fixtures/tvrage/episode_list_two_episodes.xml +25 -0
data/spec/fixtures/tvrage/full_schedule.xml +4731 -0
data/spec/fixtures/tvrage/full_show_info.xml +1291 -0
data/spec/fixtures/tvrage/quickinfo.html +17 -0
data/spec/fixtures/tvrage/quickinfo_missing.html +1 -0
data/spec/fixtures/tvrage/search.xml +151 -0
data/spec/fixtures/tvrage/show_info.xml +42 -0
data/spec/fixtures/tvrage/show_info_blank.xml +3 -0
data/spec/fixtures/tvrage/single_episode.xml +8 -0
data/spec/sofa/mapping_spec.rb +82 -0
data/spec/sofa/tvrage/cases_spec.rb +29 -0
data/spec/sofa/tvrage/episode_spec.rb +45 -0
data/spec/sofa/tvrage/schedule_spec.rb +17 -0
data/spec/sofa/tvrage/season_spec.rb +61 -0
data/spec/sofa/tvrage/show_spec.rb +162 -0
data/spec/sofa/version_spec.rb +11 -0
data/spec/sofa_spec.rb +5 -0
data/spec/spec.opts +1 -0
data/spec/spec_helper.rb +14 -0
metadata +175 -0

data/doc/Sofa/TVRage.html ADDED

@@ -0,0 +1,85 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=UTF-8" />
+<title>Module: Sofa::TVRage</title>
+<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '..';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../_index.html">Index (T)</a> &raquo;
+    <a title="Sofa" href="../Sofa.html">Sofa</a>
+     &raquo;
+    <span class="title">TVRage</span>
+</div>
+      <div id="search">
+  <a id="class_list_link" href="#">Namespace List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Module: Sofa::TVRage
+</h1>
+<dl class="box">
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/sofa/tvrage.rb<span class="defines">,<br />
+  lib/sofa/tvrage/show.rb,<br /> lib/sofa/tvrage/season.rb,<br /> lib/sofa/tvrage/episode.rb,<br /> lib/sofa/tvrage/schedule.rb</span>
+</dd>
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <a title="Episode" href="TVRage/Episode.html">Episode</a>, <a title="Schedule" href="TVRage/Schedule.html">Schedule</a>, <a title="Season" href="TVRage/Season.html">Season</a>, <a title="Show" href="TVRage/Show.html">Show</a>
+</p>
+</div>
+    <div id="footer">
+  Generated on Sat Nov 21 20:13:52 2009 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+  0.4.0 (ruby-1.8.7).
+</div>
+  </body>
+</html>

data/doc/Sofa/TVRage/Episode.html ADDED

@@ -0,0 +1,358 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=UTF-8" />
+<title>Class: Sofa::TVRage::Episode</title>
+<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '../..';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../../_index.html">Index (E)</a> &raquo;
+    <a title="Sofa" href="../../Sofa.html">Sofa</a> &raquo; <a title="TVRage" href="../TVRage.html">TVRage</a>
+     &raquo;
+    <span class="title">Episode</span>
+</div>
+      <div id="search">
+  <a id="class_list_link" href="#">Namespace List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: Sofa::TVRage::Episode
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><a title="Sofa::Mapping" href="../Mapping.html">Sofa::Mapping</a></dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/sofa/tvrage/episode.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class holds the XML information of a single episode as per the TVRage API.</p>
+  </div>
+</div>
+<div class="tags">
+  <h3>See Also:</h3>
+  <ul class="see">
+      <li><a title="TVRage API : Episode List" href="http://services.tvrage.com/index.php?page=public">TVRage API : Episode List</a></li>
+  </ul>
+</div>
+  <h2>Attribute Summary</h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature"><a title="#season_num (instance method)" href="#season_num-instance_method">- (Object) <strong>season_num</strong> </a>
+  </span>
+    <span class="note title readonly">readonly</span>
+    <span class="summary_desc">The season number of the Season this Episode belongs to.</span>
+</li>
+  </ul>
+  <h2>Method Summary</h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature"><a title="#initialize (instance method)" href="#initialize-instance_method">- (Episode) <strong>initialize</strong>(info) </a>
+  </span>
+    <span class="summary_desc">Returns a new instance of Episode, mapping info from the TVRage API.</span>
+</li>
+  </ul>
+  <h3 class="inherited">Methods included from <a title="Sofa::Mapping" href="../Mapping.html">Sofa::Mapping</a></h3>
+  <p class="inherited"><a title="included" href="../Mapping.html#included-class_method">included</a></p>
+<div id="constructor_details">
+  <h2>Constructor Details</h2>
+    <div class="method_details first">
+  <p class="signature first" id="initialize-instance_method">
+    - (<tt><a title="Episode" href="">Episode</a></tt>) <strong>initialize</strong>(info)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>Returns a new instance of Episode, mapping info from the TVRage API</p>
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+    <li>
+        <span class='type'>(<tt>Hash&lt;Symbol, Object&gt;</tt>)</span>
+        <span class='name'>info</span>
+        &mdash;
+        Info to initialize with
+    </li>
+</ul>
+    <h3>Options Hash (<tt>info</tt>):</h3>
+    <ul class="option">
+        <li>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:epnum</span>
+          <span class="default">
+              <span class="na">N/A</span>
+          </span>
+          &mdash;The episode number in the context of all episodes
+        </tr>
+        <li>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:seasonnum</span>
+          <span class="default">
+              <span class="na">N/A</span>
+          </span>
+          &mdash;The episode number in the context of its season
+        </tr>
+        <li>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:prodnum</span>
+          <span class="default">
+              <span class="na">N/A</span>
+          </span>
+        </tr>
+        <li>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:airdate</span>
+          <span class="default">
+              <span class="na">N/A</span>
+          </span>
+          &mdash;The date the episode airs
+        </tr>
+        <li>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:link</span>
+          <span class="default">
+              <span class="na">N/A</span>
+          </span>
+          &mdash;The TVRage page for this Episode
+        </tr>
+        <li>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:title</span>
+          <span class="default">
+              <span class="na">N/A</span>
+          </span>
+          &mdash;The title of this Episode
+        </tr>
+        <li>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:season_num</span>
+          <span class="default">
+              <span class="na">N/A</span>
+          </span>
+          &mdash;The season number of the Season this Episode belongs to
+        </tr>
+    </ul>
+<h3>Returns:</h3>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt><a title="Episode" href="">Episode</a></tt>)</span>
+        &mdash;
+        a new instance of +Episode+
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+34
+35
+36</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/sofa/tvrage/episode.rb', line 34</span>
+def initialize(info)
+  update_with_mapping(info)
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+  <div id="attr_details">
+    <h2>Attribute Details</h2>
+      <span id=""></span>
+      <span id="season_num-instance_method"></span>
+      <div class="method_details first">
+  <p class="signature first" id="season_num-instance_method">
+    - (<tt>Object</tt>) <strong>season_num</strong>  <span class="extras">(readonly)</span>
+</p><div class="docstring">
+  <div class="discussion">
+    <p>The season number of the Season this Episode belongs to. Not actually a part of the TVRage API, but it&#8217;s used to inject the +season_num+ when looping through Episodes in a Season.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+22
+23
+24</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/sofa/tvrage/episode.rb', line 22</span>
+def season_num
+  @season_num
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Sat Nov 21 20:13:53 2009 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+  0.4.0 (ruby-1.8.7).
+</div>
+  </body>
+</html>

data/doc/Sofa/TVRage/Schedule.html ADDED

@@ -0,0 +1,207 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=UTF-8" />
+<title>Class: Sofa::TVRage::Schedule</title>
+<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '../..';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="../../_index.html">Index (S)</a> &raquo;
+    <a title="Sofa" href="../../Sofa.html">Sofa</a> &raquo; <a title="TVRage" href="../TVRage.html">TVRage</a>
+     &raquo;
+    <span class="title">Schedule</span>
+</div>
+      <div id="search">
+  <a id="class_list_link" href="#">Namespace List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Class: Sofa::TVRage::Schedule
+</h1>
+<dl class="box">
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      </dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2">HTTParty</dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/sofa/tvrage/schedule.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>This class will hold the full/quick schedule information as per the TVRage API.</p>
+  </div>
+</div>
+<div class="tags">
+  <h3>See Also:</h3>
+  <ul class="see">
+      <li><a title="TVRage API : Full Schedule" href="http://services.tvrage.com/index.php?page=public&go=fullschedule">TVRage API : Full Schedule</a></li>
+      <li><a title="TV Rage API : Quick Schedule" href="http://services.tvrage.com/index.php?page=public&go=quickschedule">TV Rage API : Quick Schedule</a></li>
+  </ul>
+</div>
+  <h2>Method Summary</h2>
+  <ul class="summary">
+      <li class="public ">
+  <span class="summary_signature"><a title="full (class method)" href="#full-class_method">+ (Hash) <strong>full</strong>(country) </a>
+  </span>
+    <span class="summary_desc">Gets the full schedule for country.</span>
+</li>
+  </ul>
+  <div id="method_details">
+    <h2>Method Details</h2>
+      <div class="method_details first">
+  <p class="signature first" id="full-class_method">
+    + (<tt>Hash</tt>) <strong>full</strong>(country)
+</p><div class="docstring">
+  <div class="discussion">
+    <p>Gets the full schedule for country</p>
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+    <li>
+        <span class='type'>(<tt>String</tt>)</span>
+        <span class='name'>country</span>
+        &mdash;
+        The country to query in (US, UK, NL)
+    </li>
+</ul>
+<h3>Returns:</h3>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Hash</tt>)</span>
+        &mdash;
+        The parsed XML of schedule information
+    </li>
+</ul>
+  <h3>See Also:</h3>
+  <ul class="see">
+      <li><a title="US's Full Schedule" href="http://services.tvrage.com/feeds/fullschedule.php?country=US">US's Full Schedule</a></li>
+  </ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+18
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/sofa/tvrage/schedule.rb', line 18</span>
+def full(country)
+  xml = get("/fullschedule.php", :query => {:country => country})
+  xml["schedule"]
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Sat Nov 21 20:13:53 2009 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+  0.4.0 (ruby-1.8.7).
+</div>
+  </body>
+</html>