em-sofa 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.md
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.yardoc

data/.yardopts

@@ -0,0 +1,6 @@
+--readme          README.md
+--markup          markdown
+--markup-provider maruku
+--protected
+--no-highlight
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 DeFirence
+
+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.

data/README.md

@@ -0,0 +1,110 @@
+# EM-Sofa
+
+A simple fiber-aware EventMachine based Ruby library for the TVRage API (viewable [here](http://services.tvrage.com/index.php?page=public)).  
+A fork of the origional sofa library by Henry Hsu (available at [http://github.com/hsume2/sofa](http://github.com/hsume2/sofa)).
+
+## Shows
+
+    EventMachine.run do
+      EM::Sofa::TVRage::Show.by_name("Chuck") do |show|
+        show # => #<EventMachine::Sofa::TVRage::Show:0x101360d38 @name="Chuck", @show_id="15614", ...>
+      end.errback do |ex|
+        puts "An error occurred while processing the request. Reason: #{ex.message}"
+      end
+      # OR
+      EM::Sofa::TVRage::Show.new("15614") do |show|
+        show # => #<EventMachine::Sofa::TVRage::Show:0x101360d38 @name="Chuck", @show_id="15614", ...>
+      end.errback do |ex|
+        puts "An error occurred while processing the request. Reason: #{ex.message}"
+      end
+
+      # OR (using EM-Synchrony)
+      EM.synchrony do
+        begin
+          show = EM::Sofa::TVRage::Show.by_name("Chuck")
+          show # => #<EventMachine::Sofa::TVRage::Show:0x7f9f838 @name="Chuck", @show_id="15614", ...>
+        rescue EM::Sofa::TVRage::Show::NotFound => ex
+          puts "An error occurred while processing the request. Reason: #{ex.message}"
+        rescue EM::Sofa::TVRage::HttpError => ex
+          puts "A HTTP error occured while processing the request. Reason: #{ex.message}"
+        end
+      end
+    end
+
+#### Eager loading Season and Episode info
+
+    EM::Sofa::TVRage::Show.by_name("Chuck", :greedy => true) do |show|
+      show # => #<EventMachine::Sofa::TVRage::Show:0x4f97868 @name="Chuck", @show_id="15614", ...>
+    end
+    EM::Sofa::TVRage::Show.new("15614", :greedy => true) do |show|
+      show # => #<EventMachine::Sofa::TVRage::Show:0x4ea5000 @name="Chuck", @show_id="15614", ...>
+    end
+
+#### Attributes
+
+    show.show_id              # => "15614"
+    show.name                 # => "Chuck"
+    show.show_link            # => "http://tvrage.com/Chuck"
+    show.started              # => "2007"
+    show.network              # => "NBC"
+    show.air_time             # => "20:00"
+    show.time_zone            # => "GMT-5 -DST"
+    show.run_time             # => "60"
+    show.origin_country       # => "US"
+    show.air_day              # => "Monday"
+    show.ended                # => nil
+    show.classification       # => "Scripted"
+    show.seasons              # => "3"
+    show.start_date           # => "Sep/24/2007"
+    show.status               # => "Returning Series"
+    show.genres               # => ["Action", "Comedy", "Drama"]
+    show.akas                 # => "Chuck"
+    show.latest_episode       # => { :date => #<Date>, :name => "Chuck Versus the Ring: Part 2", :number => "03x19" }
+    show.next_episode         # => { :date => #<Date>, :name => "Chuck Versus the Anniversary", :number=>"04x01" }
+
+## Seasons
+
+    show.season_list do |season_list|
+      season_list             # => [#<EventMachine::Sofa::TVRage::Season:0x1022d0f98 @no="1", @episodes=[...]>,
+                                    #<EventMachine::Sofa::TVRage::Season:0x1022c88c0 @no="2", @episodes=[...]>,
+                                    ...]
+      season_list.first       # => #<EventMachine::Sofa::TVRage::Season:0x1022d0f98 @no="1", @episodes=[...]>
+    end
+
+    # OR (using EM-Synchrony)
+    EM.synchrony do
+      show.season_list.first  # => #<EventMachine::Sofa::TVRage::Season:0x1022d0f98 @no="1", @episodes=[...]>
+    end
+
+#### Attributes
+
+    season.episodes           # => [#<EventMachine::Sofa::TVRage::Episode:0x1022d07a0 @title="Pilot", ...>,
+                                    #<EventMachine::Sofa::TVRage::Episode:0x1022cf148 @title="Chuck Versus the Helicopter", ...>,
+                                    ...]
+    season.no                 # => "1"
+
+## Episodes
+
+    show.episode_list do |episode_list|
+      episode_list            # => [#<EventMachine::Sofa::TVRage::Episode:0x1022d07a0 @title="Pilot", ...>,
+                                    #<EventMachine::Sofa::TVRage::Episode:0x1022cf148 @title="Chuck Versus the Helicopter", ...>,
+                                    ...]
+      show.episode_list.first # => #<EventMachine::Sofa::TVRage::Episode:0x1022d07a0 @title="Pilot", ...>
+    end
+
+#### Attributes
+
+    episode.title             # => "Pilot"
+    episode.air_date          # => "2007-09-24"
+    episode.num_in_season     # => "01"
+    episode.num               # => "1"
+    episode.prod_num          # => "101"
+    episode.link              # => "http://www.tvrage.com/Chuck/episodes/579282"
+
+## Contributing
+ 
+* Feel free to send feature/pull requests.
+
+## Copyright
+
+Copyright (c) 2010 DeFirence. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,75 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  require './lib/em-sofa/version'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "em-sofa"
+    gem.version = EventMachine::Sofa::Version::STRING
+    gem.summary = %Q{An EventMachine based Ruby library for the TVRage API.}
+    gem.description = %Q{A simple EventMachine based Ruby library for the TVRage API.}
+    gem.email = "defirence@defirence.za.net"
+    gem.homepage = "http://github.com/DeFirence/em-sofa"
+    gem.authors = ["DeFirence", "Henry Hsu"]
+    gem.add_dependency "em-http-request"
+    gem.add_dependency "crack"
+    gem.add_development_dependency "fakeweb"
+    gem.add_development_dependency "mocha"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) 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.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = %w{--exclude spec/*,gems/*}
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/doc/Em-sofa/Mapping.html

@@ -0,0 +1,168 @@
+<!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::Mapping</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 (M)</a> &raquo; 
+    <a title="Sofa" href="../Sofa.html">Sofa</a>
+     &raquo; 
+    <span class="title">Mapping</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::Mapping 
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/sofa/mapping.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+   
+    
+      <strong class="modules">Modules:</strong> <a title="ClassMethods" href="Mapping/ClassMethods.html">ClassMethods</a>, <a title="InstanceMethods" href="Mapping/InstanceMethods.html">InstanceMethods</a>
+    
+   
+    
+  
+</p>
+
+
+
+  <h2>Method Summary</h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature"><a title="included (class method)" href="#included-class_method">+ (Object) <strong>included</strong>(base) </a>
+  
+  </span>
+  
+  
+  
+  
+
+  
+    <span class="summary_desc">This method is automatically called when <tt><a title="Mapping" href="">Mapping</a></tt> is included in a module.</span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+  <div id="method_details">
+    <h2>Method Details</h2>
+    
+      <div class="method_details first">
+  <p class="signature first" id="included-class_method">
+  
+    + (<tt>Object</tt>) <strong>included</strong>(base) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>This method is automatically called when <tt><a title="Mapping" href="">Mapping</a></tt> is included in a module. It automatically adds <tt><a title="InstanceMethods" href="Mapping/InstanceMethods.html">InstanceMethods</a></tt>, <tt><a title="ClassMethods" href="Mapping/ClassMethods.html">ClassMethods</a></tt> and initializes @mappings and @mappings_procs to empty Hashes.</p>
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='type'>(<tt>Module</tt>, <tt>Class</tt>)</span>
+      
+      
+        <span class='name'>base</span>
+      
+      
+      
+        &mdash;
+        The module that this is included in
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+8
+9
+10
+11
+12
+13</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/sofa/mapping.rb', line 8</span>
+
+def self.included(base)
+  base.send(:include, InstanceMethods)
+  base.extend(ClassMethods)
+  base.instance_variable_set("@mappings", {})
+  base.instance_variable_set("@mappings_procs", {})
+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/Em-sofa/Mapping/ClassMethods.html

@@ -0,0 +1,314 @@
+<!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::Mapping::ClassMethods</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 (C)</a> &raquo; 
+    <a title="Sofa" href="../../Sofa.html">Sofa</a> &raquo; <a title="Mapping" href="../Mapping.html">Mapping</a>
+     &raquo; 
+    <span class="title">ClassMethods</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::Mapping::ClassMethods 
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/sofa/mapping.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+  <h2>Method Summary</h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature"><a title="#mappings (instance method)" href="#mappings-instance_method">- (Hash&lt;Symbol, Symbol&gt;) <strong>mappings</strong> </a>
+  
+  </span>
+  
+  
+  
+  
+
+  
+    <span class="summary_desc">Mapping of symbols to attribute names.</span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature"><a title="#mappings_procs (instance method)" href="#mappings_procs-instance_method">- (Hash&lt;Symbol, Proc&gt;) <strong>mappings_procs</strong> </a>
+  
+  </span>
+  
+  
+  
+  
+
+  
+    <span class="summary_desc">Mapping of attribute names to a Proc filter.</span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature"><a title="#maps (instance method)" href="#maps-instance_method">- (Object) <strong>maps</strong>(hash = {}, &amp;block) </a>
+  
+  </span>
+  
+  
+  
+  
+
+  
+    <span class="summary_desc">Class method to define mappings.</span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+  <div id="method_details">
+    <h2>Method Details</h2>
+    
+      <div class="method_details first">
+  <p class="signature first" id="mappings-instance_method">
+  
+    - (<tt>Hash&lt;Symbol, Symbol&gt;</tt>) <strong>mappings</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>Mapping of symbols to attribute names</p>
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+        <span class='type'>(<tt>Hash&lt;Symbol, Symbol&gt;</tt>)</span>
+      
+      
+      
+      
+        &mdash;
+        Mapping of symbols to attribute names
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+96
+97
+98</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/sofa/mapping.rb', line 96</span>
+
+def mappings 
+  @mappings
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="mappings_procs-instance_method">
+  
+    - (<tt>Hash&lt;Symbol, Proc&gt;</tt>) <strong>mappings_procs</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>Mapping of attribute names to a Proc filter.</p>
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+        <span class='type'>(<tt>Hash&lt;Symbol, Proc&gt;</tt>)</span>
+      
+      
+      
+      
+        &mdash;
+        Mapping of attribute names to a Proc filter.
+      
+    </li>
+  
+</ul>
+
+  <h3>See Also:</h3>
+  <ul class="see">
+    
+      <li><a title="#maps" href="#maps-instance_method">#maps</a></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+103
+104
+105</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/sofa/mapping.rb', line 103</span>
+
+def mappings_procs 
+  @mappings_procs
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="maps-instance_method">
+  
+    - (<tt>Object</tt>) <strong>maps</strong>(hash = {}, &amp;block) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>Class method to define mappings.</p>
+
+  </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4>Maps :examplename to :name and :link to itself.</h4>
+      <pre class="example code">  class Example1
+    include Sofa::Mapping
+    maps(
+      :examplename => :name,
+      :link        => nil
+    )
+  end
+  example1 = Example1.new.update_with_mapping(:epnum => "1", :link => "http://google.com")
+  example1.name       # => "1"
+  example1.link       # => "http://google.com"
+  example1.attributes # => {:name => "1", :link => "http://google.com"}</pre>
+    
+      <h4>Maps :airdate to :air_date and stores the block.</h4>
+      <pre class="example code">  class Example2
+    include Sofa::Mapping
+
+    maps(:airdate => :air_date) do |value|
+      Date.parse(value)
+    end
+  end
+  example2 = Example2.new.update_with_mapping(:airdate => "2007-07-04")
+  example2.attributes # => {:air_date => Wed, 04 Jul 2007}</pre>
+    
+  </div>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+85
+86
+87
+88
+89
+90
+91
+92</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/sofa/mapping.rb', line 85</span>
+
+def maps(hash = {}, &block)
+  hash.each do |from, to|
+    method = to || from
+    @mappings[from.to_sym] = method
+    attr_reader method
+    @mappings_procs[method] = block
+  end
+end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</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>