nanowrimo 0.7.5 → 0.7.7

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.7.7 / 2009-06-11
+
+* 2 minor enhancements
+
+  * Nanowrimo::Cache::clear_cache - empties out the cache currently in memory.
+  * More caching goodness - Nanowrimo::Core#load and Nanowrimo::Core#load_history now support an options hash, the only option available being the ability to bypass any cached data for a given load and pull from WCAPI instead.
+
 === 0.7.5 / 2009-06-02
 
 * 1 minor enhancement

data/README.txt

@@ -18,11 +18,13 @@ Features:
 * 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
+* Caching is somewhat smart, with the ability to bypass it if there's a problem with cached data, and also the ability to completely clear all current cached data.
+* Errors from the WCAPI are handled gracefully.
 
 Problems:
 * The Genres API on Nanowrimo.org is a little broken right now, so there's not much data to be loaded.
 * Page scraping is dumb and costly. And the data I get is minimal. Submitted request for new API features with Nanowrimo.org crew.
-* Caching is still fairly immature in this package. Need to tune it further before November hits.
+* Caching is still fairly immature in this package, but getting bettar.
 
 == SYNOPSIS:
 

data/lib/nanowrimo.rb

@@ -23,7 +23,7 @@ require 'nanowrimo/cache'
 
 module Nanowrimo
   # Current API version
-  VERSION = '0.7.5'
+  VERSION = '0.7.7'
   # Current static root WCAPI uri
   API_URI = 'http://www.nanowrimo.org/wordcount_api'
   # Current individual user word count goal. For fun!
@@ -31,8 +31,8 @@ module Nanowrimo
   Nanowrimo::Cache.load_cache if Nanowrimo::Cache.cache_data == {}
 
   # Pull requested data from cache or from the WCAPI
-  def self.parse(path, key, attribs)
-    result = data_from_cache(path, key) ||
+  def self.parse(path, key, attribs, options={:force => false})
+    result = options[:force] == true ? data_from_internets(path, key, attribs) : data_from_cache(path, key) ||
       data_from_internets(path, key, attribs)
   end
 

data/lib/nanowrimo/cache.rb

@@ -48,5 +48,10 @@ module Nanowrimo
         @@cache_data["#{type}"] = {"#{key}" => Hash[:data, data, :created_at, Time.now]}
       }
     end
+
+    # Clears all cache from memory, will of course write that out to disk
+    def self.clear_cache
+      @@cache_data.clear
+    end
   end
 end

data/lib/nanowrimo/core.rb

@@ -7,8 +7,13 @@ module Nanowrimo
     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
+    #
+    # Options:
+    #
+    # * :force - if set to true, will force Nanowrimo data to be pulled from the WCAPI and ignore cache data. not really recommended for bandwidth reasons.
+    def load(options={})
+
+      attribs = Nanowrimo.parse(load_field,id,self.class::FIELDS,options).first
       self.error = attribs[:error]
       self.class::FIELDS.each do |attrib|
         self.send(:"#{attrib}=", attribs[attrib.intern])
@@ -16,8 +21,12 @@ module Nanowrimo
     end
 
     # 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)
+    #
+    # Options:
+    #
+    # * :force - if set to true, will force Nanowrimo data to be pulled from the WCAPI and ignore cache data. not really recommended for bandwidth reasons.
+    def load_history(options={})
+      self.history = Nanowrimo.parse(load_history_field,id,self.class::HISTORY_FIELDS,options)
       if maybe_error = self.history.first
         self.error = maybe_error[:error]
       end

data/test/test_cache.rb

@@ -41,9 +41,15 @@ class TestCache < Test::Unit::TestCase
   end
 
   def test_find_data_finds_nothing_for_key
-    type="foo"
-    key="bar"
+    type="foo2"
+    key="bar2"
     actual = Nanowrimo::Cache.find_data(type,key)
-    assert !actual.nil?
+    assert actual.nil?
+  end
+
+  def test_clear_cache_clears_cache
+    assert Nanowrimo::Cache.find_data("foo","bar")
+    Nanowrimo::Cache.clear_cache
+    assert Nanowrimo::Cache.cache_data.empty?
   end
 end

data/test/test_nanowrimo.rb

@@ -119,4 +119,17 @@ class TestNanowrimo < Test::Unit::TestCase
     }
     assert_equal expected, actual
   end
+
+  def test_nanowrimo_parse_handles_forced_internet_data
+    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)
+    data = Nanowrimo.parse(path, key, attribs)
+    FakeWeb.clean_registry
+    assert_raise FakeWeb::NetConnectNotAllowedError do
+      Nanowrimo.parse(path, key, attribs, {:force => true})
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nanowrimo
 version: !ruby/object:Gem::Version 
-  version: 0.7.5
+  version: 0.7.7
 platform: ruby
 authors: 
 - Joshua Clingenpeel
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-02 00:00:00 -07:00
+date: 2009-06-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency