nanowrimo 0.7

data/test/test_cache.rb

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby -w
+
+require 'nanowrimo'
+require 'test/unit'
+
+class TestCache < Test::Unit::TestCase
+  def test_cache_data_exists
+    assert Nanowrimo::Cache.cache_data
+    assert Nanowrimo::Cache.cache_data.instance_of?(Hash)
+  end
+
+  def test_write_cache_to_disk
+    File.delete(Nanowrimo::Cache::CACHE_FILE) if File.exist?(Nanowrimo::Cache::CACHE_FILE)
+    Nanowrimo::Cache.save_cache_to_disk
+    assert File.exist?(Nanowrimo::Cache::CACHE_FILE)
+  end
+
+  def test_add_to_cache
+    type="foo"
+    key="bar"
+    data = [{:uid => "240659", :uname => "hollowedout"}]
+    Nanowrimo::Cache.add_to_cache(type, key, data)
+    assert_equal data, Nanowrimo::Cache.cache_data[type][key][:data]
+  end
+
+  def test_find_data_returns_cached_data
+    type="foo"
+    key="bar"
+    data = [{:uid => "12345", :uname => "foo", :user_wordcount => "123456"}]
+    Nanowrimo::Cache.add_to_cache(type, key, data)
+    actual = Nanowrimo::Cache.find_data(type, key)
+    assert actual
+    assert "12345", actual.first[:uid]
+  end
+
+  def test_find_data_finds_nothing_for_type
+    type="bar"
+    key="foo"
+    actual = Nanowrimo::Cache.find_data(type, key)
+    assert actual.nil?
+  end
+
+  def test_find_data_finds_nothing_for_key
+    type="foo"
+    key="bar"
+    actual = Nanowrimo::Cache.find_data(type,key)
+    assert !actual.nil?
+  end
+end

data/test/test_core.rb

@@ -0,0 +1,16 @@
+#! /usr/bin/env ruby -w
+
+require 'nanowrimo'
+require 'test/unit'
+
+class TestCore < Test::Unit::TestCase
+  # basically we're just making sure that the methods we need are present. the class was
+  # created as a refactor of the common methods in each of the Nanowrimo::* classes.
+  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
+end

data/test/test_genre.rb

@@ -0,0 +1,42 @@
+#! /usr/bin/env ruby -w
+
+require 'nanowrimo'
+require 'test/unit'
+require 'fakeweb'
+
+class TestGenre < Test::Unit::TestCase
+  def setup
+    @genre = Nanowrimo::Genre.new("13")
+  end
+
+  def test_genre_has_appropriate_fields
+    expected = %w[gid gname genre_wordcount max min stddev average count]
+    assert_equal expected, Nanowrimo::Genre::FIELDS
+  end
+
+  def test_genre_has_appropriate_history_fields
+    expected = %w[wc wcdate max min stddev average count]
+    assert_equal expected, Nanowrimo::Genre::HISTORY_FIELDS
+  end
+
+  def test_genre_loads_current_data
+    file = 'test/fixtures/genre_wc.xml'
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcgenre/13", :file => file)
+    @genre.load
+    Nanowrimo::Genre::FIELDS.each do |f|
+      assert @genre.send(:"#{f}")
+    end
+  end
+
+  def test_genre_loads_historical_data
+    file = 'test/fixtures/genre_wc_history.xml'
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcgenrehist/13", :file => file)
+    @genre.load_history
+    assert @genre.history
+    # So...
+    # It looks like the API for the genre history data is borked. I've sent an email to the
+    # nanowrimo peoples, and when they bring it back up properly I'll test more thoroughly.
+    assert_equal 0, @genre.history.size
+    #assert_equal 7, @genre.history.first.size
+  end
+end

data/test/test_nanowrimo.rb

@@ -0,0 +1,109 @@
+#! /usr/bin/env ruby -w
+
+require 'nanowrimo'
+require 'test/unit'
+require 'fakeweb'
+
+class TestNanowrimo < Test::Unit::TestCase
+  # the purpose for this test class is to make sure that Nanowrimo has a method to
+  # open an xml document and parse it given a set of fields and a search string.
+  # It's going to be a loose wrapper around Nokogiri which should keep the api DRY.
+
+  def setup
+    FakeWeb.allow_net_connect = false
+    FakeWeb.clean_registry
+  end
+
+  def test_nanowrimo_has_parse_method
+    assert Nanowrimo.respond_to?(:parse)
+  end
+
+  def test_nanowrimo_has_data_loading_methods
+    assert Nanowrimo.respond_to?(:data_from_cache)
+    assert Nanowrimo.respond_to?(:data_from_internets)
+  end
+
+  def test_nanowrimo_data_load_from_internets_returns_hash_with_data
+    attribs = %w[uid uname user_wordcount]
+    path = "wc"
+    key = 240659
+    file = "test/fixtures/user_wc.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wc/#{key}", :file => file)
+    actual = Nanowrimo.data_from_internets(path, key, attribs).first
+    expected = {
+      :uid => "240659",
+      :uname => "hollowedout",
+      :user_wordcount => "55415"
+    }
+    assert_equal expected, actual
+  end
+
+  def test_nanowrimo_parse_does_the_same_as_data_from_internets
+    attribs = %w[uid uname user_wordcount]
+    path = "wc"
+    key = 240659
+    file = "test/fixtures/user_wc.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wc/#{key}", :file => file)
+    actual = Nanowrimo.parse(path, key, attribs).first
+    expected = {
+      :uid => "240659",
+      :uname => "hollowedout",
+      :user_wordcount => "55415"
+    }
+    assert_equal expected, actual
+  end
+
+  def test_nanowrimo_data_from_cache_returns_hash_with_data
+    attribs = %w[uid uname user_wordcount]
+    path = "wc"
+    key = 240659
+    file = "test/fixtures/user_wc.xml"
+    File.delete(Nanowrimo::Cache::CACHE_FILE) if File.exist?(Nanowrimo::Cache::CACHE_FILE)
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wc/#{key}", :file => file)
+    Nanowrimo.data_from_internets(path, key, attribs)
+    FakeWeb.clean_registry
+    actual = Nanowrimo.data_from_cache(path, key).first
+    expected = {
+      :uid => "240659",
+      :uname => "hollowedout",
+      :user_wordcount => "55415"
+    }
+    assert_equal expected, actual
+  end
+
+  def test_nanowrimo_parse_uses_cache_after_loading_from_internets_the_first_time
+    attribs = %w[uid uname user_wordcount]
+    path = "wc"
+    key = 240659
+    file = "test/fixtures/user_wc.xml"
+    File.delete(Nanowrimo::Cache::CACHE_FILE) if File.exist?(Nanowrimo::Cache::CACHE_FILE)
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wc/#{key}", :file => file)
+    Nanowrimo.parse(path, key, attribs)
+    FakeWeb.clean_registry
+    actual = {}
+    assert_nothing_raised do
+      actual = Nanowrimo.parse(path, key, attribs).first
+    end
+    expected = {
+      :uid => "240659",
+      :uname => "hollowedout",
+      :user_wordcount => "55415"
+    }
+    assert_equal expected, actual
+  end
+
+  def test_nanowrimo_parse_history_returns_array_of_hashes_with_data
+    attribs = %w[wc wcdate]
+    path = "wchistory/wordcounts/wcentry"
+    key = 240659
+    file = "test/fixtures/user_wc_history.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wchistory/#{key}", :file => file)
+    data = Nanowrimo.parse(path, key, attribs)
+    assert_equal 30, data.size
+    data.each do |d|
+      assert_equal 2, d.keys.size
+    end
+    expected = {:wc => "0", :wcdate => "2008-11-01"}
+    assert_equal expected, data.first
+  end
+end

data/test/test_region.rb

@@ -0,0 +1,39 @@
+#! /usr/bin/env ruby -w
+
+require 'nanowrimo'
+require 'test/unit'
+require 'fakeweb'
+
+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)
+    @region.load
+    Nanowrimo::Region::FIELDS.each do |f|
+      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)
+    @region.load_history
+    assert @region.history
+    assert_equal 9, @region.history.first.size
+    assert_equal 30, @region.history.size
+  end
+end

data/test/test_site.rb

@@ -0,0 +1,39 @@
+#! /usr/bin/env ruby -w
+
+require 'nanowrimo'
+require 'test/unit'
+require 'fakeweb'
+
+class TestSite < Test::Unit::TestCase
+  def setup
+    @site = Nanowrimo::Site.new
+  end
+
+  def test_site_has_appropriate_fields
+    expected = %w[site_wordcount max min stddev average count]
+    assert_equal expected, Nanowrimo::Site::FIELDS
+  end
+
+  def test_site_has_appropriate_history_fields
+    expected = %w[wc wcdate max min stddev average count]
+    assert_equal expected, Nanowrimo::Site::HISTORY_FIELDS
+  end
+
+  def test_site_loads_data
+    file = 'test/fixtures/site_wc.xml'
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcstatssummary", :file => file)
+    @site.load
+    Nanowrimo::Site::FIELDS.each do |f|
+      assert @site.send(:"#{f}"), "Failed on #{f}"
+    end
+  end
+
+  def test_site_loads_historical_data
+    file = 'test/fixtures/site_wc_history.xml'
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wcstats", :file => file)
+    @site.load_history
+    assert @site.history
+    assert_equal 30, @site.history.size
+    assert_equal 7, @site.history.first.keys.size
+  end
+end

data/test/test_user.rb

@@ -0,0 +1,99 @@
+#! /usr/bin/env ruby -w
+
+require 'nanowrimo'
+require 'test/unit'
+require 'fakeweb'
+
+class TestUser < Test::Unit::TestCase
+  def setup
+    @user = Nanowrimo::User.new("240659")
+  end
+
+  def test_user_has_appropriate_fields
+    expected = %w[uid uname user_wordcount]
+    assert_equal expected, Nanowrimo::User::FIELDS
+  end
+
+  def test_user_has_appropriate_historical_fields
+    expected = %w[wc wcdate]
+    assert_equal expected, Nanowrimo::User::HISTORY_FIELDS
+  end
+
+  def test_user_has_uid
+    assert_equal "240659", @user.uid
+  end
+
+  def test_user_gets_data
+    file = "test/fixtures/user_wc.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wc/240659", :file => file)
+    @user.load
+    assert @user.uname
+    assert_equal "hollowedout", @user.uname
+    assert @user.user_wordcount
+    assert_equal "55415", @user.user_wordcount
+  end
+
+  def test_user_loads_history_data
+    file = "test/fixtures/user_wc_history.xml"
+    FakeWeb.register_uri("#{Nanowrimo::API_URI}/wchistory/240659", :file => file)
+    @user.load_history
+    assert @user.history
+    assert_equal 30, @user.history.size
+  end
+
+  def test_user_is_a_winner
+    @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
+    assert @user.profile_data.instance_of?(WWW::Mechanize::Page)
+    assert_match(/<div id="tcontent3"/, @user.profile_data.body)
+  end
+
+  def test_find_users_region
+    profile_uri_setup
+    @user.parse_profile
+    assert_equal "84", @user.rid
+  end
+
+  def test_find_users_novel_title
+    profile_uri_setup
+    @user.parse_profile
+    assert_equal "Interpolis", @user.novel[:title]
+  end
+
+  def test_find_users_genre
+    profile_uri_setup
+    @user.parse_profile
+    assert_equal "Science Fiction", @user.genre[:name]
+  end
+
+  def test_find_users_buddies
+    profile_uri_setup
+    @user.parse_profile
+    assert @user.buddies.instance_of?(Array)
+    assert_equal 11, @user.buddies.size
+  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
+    # discussion started at http://groups.google.com/group/fakeweb-users/browse_thread/thread/e01b6280e720ae6f
+    file = File.read("test/fixtures/user_page.htm")
+    FakeWeb.register_uri("http://www.nanowrimo.org/eng/user/240659", :response => file)
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: nanowrimo
+version: !ruby/object:Gem::Version 
+  version: "0.7"
+platform: ruby
+authors: 
+- Joshua Clingenpeel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: |-
+  A simple API wrapper for Nanowrimo.org. Nanowrimo Word Count API documentation here:
+  http://www.nanowrimo.org/eng/wordcount_api
+email: 
+- joshua.clingenpeel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/nanowrimo.rb
+- lib/nanowrimo/cache.rb
+- lib/nanowrimo/core.rb
+- lib/nanowrimo/genre.rb
+- lib/nanowrimo/region.rb
+- lib/nanowrimo/site.rb
+- lib/nanowrimo/user.rb
+- test/test_cache.rb
+- test/test_core.rb
+- test/test_genre.rb
+- test/test_nanowrimo.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
+has_rdoc: true
+homepage: http://nanowrimo.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: nanowrimo
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: A simple API wrapper for Nanowrimo.org
+test_files: 
+- test/test_cache.rb
+- test/test_core.rb
+- test/test_genre.rb
+- test/test_nanowrimo.rb
+- test/test_region.rb
+- test/test_site.rb
+- test/test_user.rb