illuminerdi-nanowrimo 0.5

data/History.txt

@@ -0,0 +1,11 @@
+=== 0.5 / 2009-05-21
+
+* first major release
+* API is fully functional as a wrapper for the Nanowrimo API
+
+=== 0.1 / 2009-05-17
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/nanowrimo.rb
+lib/nanowrimo/genre.rb
+lib/nanowrimo/region.rb
+lib/nanowrimo/site.rb
+lib/nanowrimo/user.rb
+test/test_nanowrimo.rb
+test/test_genre.rb
+test/test_region.rb
+test/test_site.rb
+test/test_user.rb
+test/fixtures/genre_wc.xml
+test/fixtures/genre_wc_history.xml
+test/fixtures/region_wc.xml
+test/fixtures/region_wc_history.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

data/README.txt

@@ -0,0 +1,72 @@
+= nanowrimo
+
+* http://github.com/illuminerdi/nanowrimo
+* http://www.nanowrimo.org
+
+== DESCRIPTION:
+
+A simple API wrapper for Nanowrimo.org. Nanowrimo Word Count API documentation here:
+http://www.nanowrimo.org/eng/wordcount_api
+
+== FEATURES/PROBLEMS:
+
+Features:
+* Simple! Clean! Well-tested!
+* Easy to roll into a Rails application (that's next)
+* Separate APIs for Users, Site, Regions, and Genres
+
+Problems:
+* The Genres API on Nanowrimo.org is a little broken right now, so there's not much data to be loaded.
+
+== SYNOPSIS:
+
+  >> me = Nanowrimo::User.new(240659)
+  => #<Nanowrimo::User:0x105b904 @uid=240659>
+  >> me.load
+  => ["uid", "uname", "user_wordcount"]
+  >> me.user_wordcount
+  => "55415"
+  >> me.winner?
+  => true
+  # YAY!
+  
+  # Want an array of day-by-day progress for yourself?
+  >> me.load_history
+  
+  # Want an array of day-by-day progress for your region?
+  >> my_region = Nanowrimo::Region.new(84)
+  >> my_region.load_history
+
+== REQUIREMENTS:
+
+* ruby 1.8.6
+* nokogiri 1.2.3
+
+== INSTALL:
+
+* Not there yet, just download and package and install. Soon!
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Joshua Clingenpeel
+
+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/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+$: << 'lib'
+require 'rubygems'
+require 'hoe'
+require './lib/nanowrimo.rb'
+
+Hoe.new('nanowrimo', Nanowrimo::VERSION) do |p|
+  # p.rubyforge_name = 'nanowrimox' # if different than lowercase project name
+  p.developer('Joshua Clingenpeel', 'joshua.clingenpeel@gmail.com')
+end
+
+# vim: syntax=Ruby

data/lib/nanowrimo.rb

@@ -0,0 +1,32 @@
+#! /usr/bin/env ruby -w
+
+$: << 'lib'
+require 'rubygems'
+require 'nokogiri'
+require 'open-uri'
+require 'nanowrimo/user'
+require 'nanowrimo/site'
+require 'nanowrimo/region'
+require 'nanowrimo/genre'
+
+module Nanowrimo
+  VERSION = '0.5'
+  API_URI = 'http://www.nanowrimo.org/wordcount_api'
+  GOAL = 50_000
+
+  def self.parse(path, key, attribs)
+    method = path.split('/').first
+    uri = "#{API_URI}/#{method}"
+    uri = "#{uri}/#{key}" unless key.nil?
+    doc = Nokogiri::XML(open(uri))
+    result = []
+    doc.xpath(path).each {|n|
+      node = {}
+      attribs.each {|d|
+        node[d.intern] = n.at(d).content
+      }
+      result << node
+    }
+    result
+  end
+end

data/lib/nanowrimo/genre.rb

@@ -0,0 +1,24 @@
+#! /usr/bin/env ruby -w
+
+module Nanowrimo
+  class Genre
+    FIELDS = %w[gid gname genre_wordcount max min stddev average count]
+    HISTORY_FIELDS = %w[wc wcdate max min stddev average count]
+    attr_accessor(*FIELDS)
+    attr_accessor :history
+    def initialize(gid)
+      @gid = gid
+    end
+
+    def load
+      attribs = Nanowrimo.parse('wcgenre', @gid, FIELDS).first
+      FIELDS.each do |attrib|
+        self.send(:"#{attrib}=", attribs[attrib.intern])
+      end
+    end
+
+    def load_history
+      @history = Nanowrimo.parse('wcgenrehist/wordcounts/wcentry', @gid, HISTORY_FIELDS)
+    end
+  end
+end

data/lib/nanowrimo/region.rb

@@ -0,0 +1,24 @@
+#! /usr/bin/env ruby -w
+
+module Nanowrimo
+  class Region
+    FIELDS = %w[rid rname region_wordcount max min stddev average count donations numdonors]
+    HISTORY_FIELDS = %w[wc wcdate max min stddev average count donations donors]
+    attr_accessor(*FIELDS)
+    attr_accessor :history
+    def initialize(rid)
+      @rid = rid
+    end
+    
+    def load
+      attribs = Nanowrimo.parse('wcregion', @rid, FIELDS).first
+      FIELDS.each do |attrib|
+        self.send(:"#{attrib}=", attribs[attrib.intern])
+      end
+    end
+    
+    def load_history
+      @history = Nanowrimo.parse('wcregionhist/wordcounts/wcentry',@rid,HISTORY_FIELDS)
+    end
+  end
+end

data/lib/nanowrimo/site.rb

@@ -0,0 +1,20 @@
+#! /usr/bin/env ruby -w
+
+module Nanowrimo
+  class Site
+    FIELDS = %w[site_wordcount max min stddev average count]
+    HISTORY_FIELDS = %w[wc wcdate max min stddev average count]
+    attr_accessor(*FIELDS)
+    attr_accessor :history
+    def load
+      attribs = Nanowrimo.parse('wcstatssummary', nil, FIELDS).first
+      FIELDS.each do |attrib|
+        self.send(:"#{attrib}=", attribs[attrib.intern])
+      end
+    end
+    
+    def load_history
+      @history = Nanowrimo.parse('wcstats/wordcounts/wcentry', nil, HISTORY_FIELDS)
+    end
+  end
+end

data/lib/nanowrimo/user.rb

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby -w
+
+module Nanowrimo
+  class User
+    FIELDS = %w[uid uname user_wordcount]
+    HISTORY_FIELDS = %w[wc wcdate]
+    attr_accessor(*FIELDS)
+    attr_accessor :history
+    def initialize uid
+      @uid = uid
+    end
+
+    def load
+      attribs = Nanowrimo.parse('wc', @uid, FIELDS).first
+      FIELDS.each do |attrib|
+        self.send(:"#{attrib}=", attribs[attrib.intern])
+      end
+    end
+
+    def load_history
+      @history = Nanowrimo.parse('wchistory/wordcounts/wcentry', @uid, HISTORY_FIELDS)
+    end
+
+    def winner?
+      self.user_wordcount.to_i >= Nanowrimo::GOAL
+    end
+  end
+end

data/test/fixtures/genre_wc.xml

@@ -0,0 +1,22 @@
+<?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>13</gid>
+<gname>Science Fiction
+<genre_wordcount>0</genre_wordcount>
+<max></max>
+<min></min>
+<stddev></stddev>
+<average></average>
+<count></count>
+</wcgenre>

data/test/fixtures/genre_wc_history.xml

@@ -0,0 +1,23 @@
+<?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>13</gid>
+<gname>Science Fiction
+<genre_wordcount>0</genre_wordcount>
+<wordcounts>
+</wordcounts>
+</wcgenrehist>

data/test/fixtures/region_wc.xml

@@ -0,0 +1,26 @@
+<?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>84</rid>
+<rname>United States :: Washington :: Seattle</rname>
+<region_wordcount>25865208</region_wordcount>
+<max>310458</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>31736</average>
+<count>815</count>
+<donations>7735.00</donations>
+<numdonors>148</numdonors>
+</wcregion>

data/test/fixtures/region_wc_history.xml

@@ -0,0 +1,355 @@
+<?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>84</rid>
+<rname>United States :: Washington :: Seattle</rname>
+<region_wordcount>25865208</region_wordcount>
+<wordcounts>
+<wcentry>
+<wc>71910</wc>
+<wcdate>2008-11-01</wcdate>
+<max>2883</max>
+<min>62</min>
+<stddev>0</stddev>
+<average>1331</average>
+<count>54</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>695248</wc>
+<wcdate>2008-11-02</wcdate>
+<max>11371</max>
+<min>3</min>
+<stddev>0</stddev>
+<average>2653</average>
+<count>262</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>1625778</wc>
+<wcdate>2008-11-03</wcdate>
+<max>27559</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>3908</average>
+<count>416</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>2413589</wc>
+<wcdate>2008-11-04</wcdate>
+<max>31483</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>4723</average>
+<count>511</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>3058448</wc>
+<wcdate>2008-11-05</wcdate>
+<max>39436</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>5510</average>
+<count>555</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>3799629</wc>
+<wcdate>2008-11-06</wcdate>
+<max>44506</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>6364</average>
+<count>597</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>4569130</wc>
+<wcdate>2008-11-07</wcdate>
+<max>50152</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>7287</average>
+<count>627</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>5189194</wc>
+<wcdate>2008-11-08</wcdate>
+<max>50152</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>7971</average>
+<count>651</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>5972666</wc>
+<wcdate>2008-11-09</wcdate>
+<max>52352</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>8901</average>
+<count>671</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>6931977</wc>
+<wcdate>2008-11-10</wcdate>
+<max>52361</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>10149</average>
+<count>683</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>7738454</wc>
+<wcdate>2008-11-11</wcdate>
+<max>52361</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>11054</average>
+<count>700</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>8539085</wc>
+<wcdate>2008-11-12</wcdate>
+<max>57007</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>11976</average>
+<count>713</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>9480351</wc>
+<wcdate>2008-11-13</wcdate>
+<max>66173</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>12916</average>
+<count>734</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>10307820</wc>
+<wcdate>2008-11-14</wcdate>
+<max>70184</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>13891</average>
+<count>742</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>10932630</wc>
+<wcdate>2008-11-15</wcdate>
+<max>73169</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>14635</average>
+<count>747</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>11688373</wc>
+<wcdate>2008-11-16</wcdate>
+<max>80707</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>15481</average>
+<count>755</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>12726851</wc>
+<wcdate>2008-11-17</wcdate>
+<max>123576</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>16658</average>
+<count>764</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>13603369</wc>
+<wcdate>2008-11-18</wcdate>
+<max>123576</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>17643</average>
+<count>771</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>14317821</wc>
+<wcdate>2008-11-19</wcdate>
+<max>123576</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>18546</average>
+<count>772</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>14996255</wc>
+<wcdate>2008-11-20</wcdate>
+<max>123576</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>19275</average>
+<count>778</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>15768048</wc>
+<wcdate>2008-11-21</wcdate>
+<max>123576</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>20112</average>
+<count>784</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>16347455</wc>
+<wcdate>2008-11-22</wcdate>
+<max>123576</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>20719</average>
+<count>789</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>17294403</wc>
+<wcdate>2008-11-23</wcdate>
+<max>123576</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>21836</average>
+<count>792</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>18717055</wc>
+<wcdate>2008-11-24</wcdate>
+<max>297882</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>23484</average>
+<count>797</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>19630108</wc>
+<wcdate>2008-11-25</wcdate>
+<max>297882</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>24537</average>
+<count>800</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>20368005</wc>
+<wcdate>2008-11-26</wcdate>
+<max>297882</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>25428</average>
+<count>801</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>21037606</wc>
+<wcdate>2008-11-27</wcdate>
+<max>297882</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>26166</average>
+<count>804</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>21678457</wc>
+<wcdate>2008-11-28</wcdate>
+<max>297882</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>26896</average>
+<count>806</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>22624700</wc>
+<wcdate>2008-11-29</wcdate>
+<max>297882</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>28035</average>
+<count>807</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+<wcentry>
+<wc>25865208</wc>
+<wcdate>2008-11-30</wcdate>
+<max>310458</max>
+<min>1</min>
+<stddev>0</stddev>
+<average>31736</average>
+<count>815</count>
+<donations>7735.00</donations>
+<donors></donors>
+</wcentry>
+</wordcounts>
+</wcregionhist>