nanowrimo 0.7 → 0.7.5

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.7.5 / 2009-06-02
+
+* 1 minor enhancement
+
+  * Handling errors generated by the Nanowrimo.org WCAPI.
+
 === 0.7 / 2009-05-29
 
 * Refactored many similar methods into a Nanowrimo::Core class per a suggestion from ZenSpider.

data/Manifest.txt

@@ -17,11 +17,17 @@ test/test_region.rb
 test/test_site.rb
 test/test_user.rb
 test/fixtures/genre_wc.xml
+test/fixtures/genre_wc_error.xml
 test/fixtures/genre_wc_history.xml
+test/fixtures/genre_wc_history_error.xml
 test/fixtures/region_wc.xml
+test/fixtures/region_wc_error.xml
 test/fixtures/region_wc_history.xml
+test/fixtures/region_wc_history_error.xml
 test/fixtures/site_wc.xml
 test/fixtures/site_wc_history.xml
 test/fixtures/user_page.htm
 test/fixtures/user_wc.xml
-test/fixtures/user_wc_history.xml
+test/fixtures/user_wc_error.xml
+test/fixtures/user_wc_history.xml
+test/fixtures/user_wc_history_error.xml

data/README.txt

@@ -15,6 +15,7 @@ Features:
 * Simple! Clean! Well-tested!
 * Easy to roll into a Rails application (that's next)
 * Separate APIs for Users, Site, Regions, and Genres
+* API handles generated error messages from the WCAPI
 * Page scraping place for basic user data from the profile page
 * Caches data to avoid November bandwidth issues
 
@@ -34,7 +35,7 @@ Problems:
   >> me.winner?
   => true
   # YAY!
-  
+
   # Want to get a list of your writing buddies?
   >> me.parse_profile
   >> me.buddies

data/lib/nanowrimo.rb

@@ -23,7 +23,7 @@ require 'nanowrimo/cache'
 
 module Nanowrimo
   # Current API version
-  VERSION = '0.7'
+  VERSION = '0.7.5'
   # Current static root WCAPI uri
   API_URI = 'http://www.nanowrimo.org/wordcount_api'
   # Current individual user word count goal. For fun!
@@ -51,10 +51,14 @@ module Nanowrimo
     begin
       timeout(2) {
         doc = Nokogiri::XML(open(uri))
+        doc.xpath("#{type}/error").each {|e|
+          result << {:error => e.content}
+        }
+        return result unless result.empty?
         doc.xpath(path).each {|n|
           node = {}
           attribs.each {|d|
-            node[d.intern] = n.at(d).content
+            node[d.intern] = n.at(d).content unless n.at(d).nil?
           }
           result << node
         }

data/lib/nanowrimo/core.rb

@@ -3,9 +3,13 @@
 module Nanowrimo
   # Core load methods
   class Core
+    # attribute for storing error message returned by WCAPI on any response.
+    attr_accessor :error
+
     # Returns the values for all attributes for a given WCAPI type
     def load
       attribs = Nanowrimo.parse(load_field,id,self.class::FIELDS).first
+      self.error = attribs[:error]
       self.class::FIELDS.each do |attrib|
         self.send(:"#{attrib}=", attribs[attrib.intern])
       end
@@ -14,6 +18,14 @@ module Nanowrimo
     # Returns the values for all attributes for a given WCAPI type's history
     def load_history
       self.history = Nanowrimo.parse(load_history_field,id,self.class::HISTORY_FIELDS)
+      if maybe_error = self.history.first
+        self.error = maybe_error[:error]
+      end
+    end
+
+    # Tells us if the current object has any errors from the WCAPI
+    def has_error?
+      !error.nil?
     end
   end
 end

data/test/fixtures/genre_wc_error.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" standalone="yes"?><!DOCTYPE wcgenre [
+	<!ELEMENT wcgenre (gid, error, gname, genre_wordcount, max, min, stddev, average, count)>
+	<!ELEMENT gid (#PCDATA)>
+	<!ELEMENT error (#PCDATA)>
+	<!ELEMENT gname (#PCDATA)>
+	<!ELEMENT genre_wordcount (#PCDATA)>
+	<!ELEMENT max (#PCDATA)>
+	<!ELEMENT min (#PCDATA)>
+	<!ELEMENT stddev (#PCDATA)>
+	<!ELEMENT average (#PCDATA)>
+	<!ELEMENT count (#PCDATA)>
+]>
+<wcgenre>
+<gid>999999</gid>
+<error>genre not found</error>
+</wcgenre>

data/test/fixtures/genre_wc_history_error.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" standalone="yes"?><!DOCTYPE wcgenrehist [
+	<!ELEMENT wcgenrehist (gid, error, gname, genre_wordcount, wordcounts)>
+	<!ELEMENT gid (#PCDATA)>
+	<!ELEMENT error (#PCDATA)>
+	<!ELEMENT gname (#PCDATA)>
+	<!ELEMENT genre_wordcount (#PCDATA)>
+	<!ELEMENT wordcounts (wcentry+)>
+	<!ELEMENT wcentry (wc, wcdate, max, min, stddev, average, count)>
+	<!ELEMENT wc (#PCDATA)>
+	<!ELEMENT wcdate (#PCDATA)>
+	<!ELEMENT max (#PCDATA)>
+	<!ELEMENT min (#PCDATA)>
+	<!ELEMENT stddev (#PCDATA)>
+	<!ELEMENT average (#PCDATA)>
+	<!ELEMENT count (#PCDATA)>
+]>
+<wcgenrehist>
+<gid>999999</gid>
+<error>genre not found</error>
+</wcgenrehist>

data/test/fixtures/region_wc_error.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" standalone="yes"?><!DOCTYPE wcregion [
+	<!ELEMENT wcregion (rid, error, rname, region_wordcount, max, min, stddev, average, count, donations, numdonors)>
+	<!ELEMENT rid (#PCDATA)>
+	<!ELEMENT error (#PCDATA)>
+	<!ELEMENT rname (#PCDATA)>
+	<!ELEMENT region_wordcount (#PCDATA)>
+	<!ELEMENT max (#PCDATA)>
+	<!ELEMENT min (#PCDATA)>
+	<!ELEMENT stddev (#PCDATA)>
+	<!ELEMENT average (#PCDATA)>
+	<!ELEMENT count (#PCDATA)>
+	<!ELEMENT donations (#PCDATA)>
+	<!ELEMENT numdonors (#PCDATA)>
+]>
+<wcregion>
+<rid>999999</rid>
+<error>region not found</error>
+</wcregion>

data/test/fixtures/region_wc_history_error.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" standalone="yes"?><!DOCTYPE wcregionhist [
+	<!ELEMENT wcregionhist (rid, error, rname, region_wordcount, wordcounts)>
+	<!ELEMENT rid (#PCDATA)>
+	<!ELEMENT error (#PCDATA)>
+	<!ELEMENT rname (#PCDATA)>
+	<!ELEMENT region_wordcount (#PCDATA)>
+	<!ELEMENT wordcounts (wcentry+)>
+	<!ELEMENT wcentry (wc, wcdate, max, min, stddev, average, count, donations, numdonors)>
+	<!ELEMENT wc (#PCDATA)>
+	<!ELEMENT wcdate (#PCDATA)>
+	<!ELEMENT max (#PCDATA)>
+	<!ELEMENT min (#PCDATA)>
+	<!ELEMENT stddev (#PCDATA)>
+	<!ELEMENT average (#PCDATA)>
+	<!ELEMENT count (#PCDATA)>
+	<!ELEMENT donations (#PCDATA)>
+	<!ELEMENT numdonors (#PCDATA)>
+]>
+<wcregionhist>
+<rid>999999</rid>
+<error>region not found</error>
+</wcregionhist>

data/test/fixtures/user_wc_error.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" standalone="yes"?><!DOCTYPE wc [
+	<!ELEMENT wc (uid, error, uname, user_wordcount)>
+	<!ELEMENT uid (#PCDATA)>
+	<!ELEMENT error (#PCDATA)>
+	<!ELEMENT uname (#PCDATA)>
+	<!ELEMENT user_wordcount (#PCDATA)>
+]>
+<wc>
+<uid>999999</uid>
+<error>user not found or is inactive</error>
+</wc>

data/test/fixtures/user_wc_history_error.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" standalone="yes"?><!DOCTYPE wchistory [
+	<!ELEMENT wchistory (uid, error, uname, user_wordcount, wordcounts)>
+	<!ELEMENT uid (#PCDATA)>
+	<!ELEMENT error (#PCDATA)>
+	<!ELEMENT uname (#PCDATA)>
+	<!ELEMENT user_wordcount (#PCDATA)>
+	<!ELEMENT wordcounts (wcentry+)>
+	<!ELEMENT wcentry (wc,wcdate)>
+	<!ELEMENT wc (#PCDATA)>
+	<!ELEMENT wcdate (#PCDATA)>
+]>
+<wchistory>
+<uid>999999</uid>
+<error>user not found or is inactive</error>
+</wchistory>

data/test/test_core.rb

@@ -9,8 +9,20 @@ class TestCore < Test::Unit::TestCase
   def test_core_has_load_method
     assert Nanowrimo::Core.new.respond_to?(:load)
   end
-  
+
   def test_core_has_load_history_method
     assert Nanowrimo::Core.new.respond_to?(:load_history)
   end
+
+  def test_core_has_error_attribute
+    assert Nanowrimo::Core.new.respond_to?(:error)
+    assert Nanowrimo::Core.new.respond_to?(:error=)
+  end
+
+  def test_core_has_error_works
+    actual = Nanowrimo::Core.new
+    assert actual.respond_to?(:has_error?)
+    actual.error = "Foo"
+    assert actual.has_error?
+  end
 end

data/test/test_genre.rb

@@ -39,4 +39,22 @@ class TestGenre < Test::Unit::TestCase
     assert_equal 0, @genre.history.size
     #assert_equal 7, @genre.history.first.size
   end
+
+  def test_unknown_genre_produces_error_data
+   bad_genre = Nanowrimo::Genre.new("999999")
+   file = "test/fixtures/genre_wc_error.xml"
+   FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcgenre/999999", :file => file)
+   bad_genre.load
+   assert bad_genre.has_error?
+   assert_equal "genre not found", bad_genre.error
+  end
+
+  def test_unknown_genre_produces_historical_error_data
+    bad_genre = Nanowrimo::Genre.new("999999")
+    file = "test/fixtures/genre_wc_history_error.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcgenrehist/999999", :file => file)
+    bad_genre.load_history
+    assert bad_genre.has_error?
+    assert_equal "genre not found", bad_genre.error
+  end
 end

data/test/test_nanowrimo.rb

@@ -106,4 +106,17 @@ class TestNanowrimo < Test::Unit::TestCase
     expected = {:wc => "0", :wcdate => "2008-11-01"}
     assert_equal expected, data.first
   end
+
+  def test_nanowrimo_parse_handles_wcapi_error_message
+    attribs = %w[uid uname user_wordcount]
+    path = "wc"
+    key = 999999
+    file = "test/fixtures/user_wc_error.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wc/#{key}", :file => file)
+    actual = Nanowrimo.data_from_internets(path, key, attribs).first
+    expected = {
+      :error => "user not found or is inactive"
+    }
+    assert_equal expected, actual
+  end
 end

data/test/test_region.rb

@@ -8,17 +8,17 @@ class TestRegion < Test::Unit::TestCase
   def setup
     @region = Nanowrimo::Region.new("84")
   end
-  
+
   def test_regions_has_appropriate_fields
     expected = %w[rid rname region_wordcount max min stddev average count donations numdonors]
     assert_equal expected, Nanowrimo::Region::FIELDS
   end
-  
+
   def test_regions_has_appropriate_history_fields
     expected = %w[wc wcdate max min stddev average count donations donors]
     assert_equal expected, Nanowrimo::Region::HISTORY_FIELDS
   end
-  
+
   def test_region_loads_current_data
     file = 'test/fixtures/region_wc.xml'
     FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcregion/84", :file => file)
@@ -27,7 +27,7 @@ class TestRegion < Test::Unit::TestCase
       assert @region.send(:"#{f}")
     end
   end
-  
+
   def test_region_loads_historical_data
     file = 'test/fixtures/region_wc_history.xml'
     FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcregionhist/84", :file => file)
@@ -36,4 +36,22 @@ class TestRegion < Test::Unit::TestCase
     assert_equal 9, @region.history.first.size
     assert_equal 30, @region.history.size
   end
+
+  def test_unknown_region_produces_error_data
+   bad_region = Nanowrimo::Region.new("999999")
+   file = "test/fixtures/region_wc_error.xml"
+   FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcregion/999999", :file => file)
+   bad_region.load
+   assert bad_region.has_error?
+   assert_equal "region not found", bad_region.error
+  end
+
+  def test_unknown_region_produces_historical_error_data
+    bad_region = Nanowrimo::Region.new("999999")
+    file = "test/fixtures/region_wc_history_error.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcregionhist/999999", :file => file)
+    bad_region.load_history
+    assert bad_region.has_error?
+    assert_equal "region not found", bad_region.error
+  end
 end

data/test/test_user.rb

@@ -7,6 +7,7 @@ require 'fakeweb'
 class TestUser < Test::Unit::TestCase
   def setup
     @user = Nanowrimo::User.new("240659")
+    FakeWeb.allow_net_connect = false
   end
 
   def test_user_has_appropriate_fields
@@ -45,18 +46,18 @@ class TestUser < Test::Unit::TestCase
     @user.load
     assert @user.winner?
   end
-  
+
   def test_user_has_profile_fields
     expected = %w[rid novel genre buddies]
     assert_equal expected, Nanowrimo::User::USER_FIELDS
   end
-  
+
   def test_profile_fields_default_properly
     assert @user.novel.instance_of?(Hash)
     assert @user.genre.instance_of?(Hash)
     assert @user.buddies.instance_of?(Array)
   end
-  
+
   def test_user_load_profile_data
     profile_uri_setup
     @user.load_profile_data
@@ -88,7 +89,25 @@ class TestUser < Test::Unit::TestCase
     assert @user.buddies.instance_of?(Array)
     assert_equal 11, @user.buddies.size
   end
-  
+
+  def test_unknown_user_produces_error_data
+   bad_user = Nanowrimo::User.new("999999")
+   file = "test/fixtures/user_wc_error.xml"
+   FakeWeb.register_uri("#{Nanowrimo::API_URI}/wc/999999", :file => file)
+   bad_user.load
+   assert bad_user.has_error?
+   assert_equal "user not found or is inactive", bad_user.error
+  end
+
+  def test_unknown_user_produces_historical_error_data
+    bad_user = Nanowrimo::User.new("999999")
+    file = "test/fixtures/user_wc_history_error.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wchistory/999999", :file => file)
+    bad_user.load_history
+    assert bad_user.has_error?
+    assert_equal "user not found or is inactive", bad_user.error
+  end
+
   def profile_uri_setup
     # this was a bit of weirdness - I had to curl -is the url in order to grab the headers, and
     # even then it would register the file from FakeWeb as WWW::Mechanize::File, not WWW::Mechanize::Page

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nanowrimo
 version: !ruby/object:Gem::Version 
-  version: "0.7"
+  version: 0.7.5
 platform: ruby
 authors: 
 - Joshua Clingenpeel
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-29 00:00:00 -07:00
+date: 2009-06-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,14 +55,20 @@ files:
 - test/test_site.rb
 - test/test_user.rb
 - test/fixtures/genre_wc.xml
+- test/fixtures/genre_wc_error.xml
 - test/fixtures/genre_wc_history.xml
+- test/fixtures/genre_wc_history_error.xml
 - test/fixtures/region_wc.xml
+- test/fixtures/region_wc_error.xml
 - test/fixtures/region_wc_history.xml
+- test/fixtures/region_wc_history_error.xml
 - test/fixtures/site_wc.xml
 - test/fixtures/site_wc_history.xml
 - test/fixtures/user_page.htm
 - test/fixtures/user_wc.xml
+- test/fixtures/user_wc_error.xml
 - test/fixtures/user_wc_history.xml
+- test/fixtures/user_wc_history_error.xml
 has_rdoc: true
 homepage: http://nanowrimo.rubyforge.org
 licenses: []