stale_fish 1.3.0.pre → 1.3.0.pre1

data/README.rdoc

@@ -1,42 +1,41 @@
 = Stale Fish
 
-This gem provides a method for keeping your fixtures in sync with their sources. This will prevent the scenario where your build is broken in production, but CI has a green build to do outdated fixture data. StaleFish also allows for FakeWeb integration and URI management.
+StaleFish is a utility for storing web requests as fixtures, faking web requests, and ensuring fixtures stay fresh by checking request at periodic intervals.
+It works at a global level, without modifying code or writing extensive stubs.
 
 == NOTICE
 
-1.3.x is a complete rewrite of the StaleFish utility. The API is based on: http://gist.github.com/308260
-
-The information below has not been corrected or updated.
+1.3.x is a complete rewrite of the StaleFish utility. It is incompatible with previous versions of StaleFish.
 
 == Features
 
-* Fixture update frequency uses the ActiveSupport relative time DSL
-* Versioned configuration file & fixtures means fixtures are only updated once per project.
-* Manage FakeWeb stubbed URI's through StaleFish
-* Automatic detection for Rails & Rack apps (default configuration locations)
+* Manage FakeWeb through StaleFish
+* Fixtures are updated based on a per-fixture update interval
+* Fixture update interval supports the ActiveSupport relative time DSL (ex. '30.minutes', '2.days', '1.year')
+* Configuration file and fixture data is version control friendly
+* Specify which fixtures are checked for freshness using :all, :only, & :except arguement options
+* Force update of all fixtures regardless of freshness (bypass freshness check)
 * Test Framework agnostic (tested with Test::Unit & RSpec)
-* Update all fixtures, specified fixtures, or forced update are all supported through the StaleFish.update_stale(*args) method
-* Fixtures are ONLY updated when a valid HTTP request is made, if server returns anything other than 200, an error is thrown failing the tests.
 
 == How To
 
-Simply drop in a YAML file in your application (default location: {test/spec}/stale_fish.yml; overwrite by setting StaleFish::Utility.config_path) and issue the following commands.
+Simply drop in a YAML file in your application (recommended location: {test/spec}/fixtures/stale_fish.yml) and issue the following commands.
 
 A sample YAML file:
 
   stale:
-    configuration:
-      use_fakeweb: true
-    yahoo: 
-      file_path: RAILS_ROOT + '/spec/fixtures/yahoo.html'
-      source_url: http://www.yahoo.com
-      last_updated_at: 
-      update_frequency: 1.day
-    google: 
-      file_path:  RAILS_ROOT + '/spec/fixtures/github_commit.json'
-      source_url: http://api.github.com/post_commit/
-      last_updated_at: 
-      update_frequency: 2.weeks
+    twitter:                                          # fixture name (this must be unique)
+      file: 'timeline.json'                           # fixture save location
+      update_interval: 30.days                        # update interval
+      check_against: http://twitter.com/api/timeline  # data to update fixture with when stale
+      request_type: POST                              # request type to use when updating: GET, POST
+      last_updated_at:                                # timestamp of last fixture update (can be left blank)
+    gh_commits:
+      file: 'commits.xml'
+      update_interval: 3.days
+      check_against: http://api.github.com/commits.xml
+      request_type: GET
+      last_updated_at:
 
 Specify one block for every fixture you would like to update. The frequency field takes any relative date included in the ActiveSupport library.
 
@@ -46,7 +45,7 @@ For a single test add it to a before block
 
   describe UsersController do
     before do
-      StaleFish.update_stale("facebook", "yahoo")
+      StaleFish.update_stale
     end
     ....
   end
@@ -57,7 +56,7 @@ For all tests add the following to spec_helper.rb
 
   Spec::Runner.configure do |config|
     ...
-    config.before do
+    config.before :suite do
       StaleFish.update_stale
     end
     ....
@@ -68,9 +67,6 @@ For all tests add the following to spec_helper.rb
 For all tests add the following to test_helper.rb
 
   class Test::Unit::TestCase
-    ...
-    self.use_transactional_fixtures = true
-    self.use_instantiated_fixtures  = false
     ...
     setup do
       StaleFish.update_stale
@@ -78,14 +74,15 @@ For all tests add the following to test_helper.rb
     ...
   end
 
+
 == More Info
 
 View the wiki: http://wiki.github.com/jsmestad/stale_fish
 
 == Thanks
 
-Paul Sadauskas for his work on Resourceful (used by StaleFish to provide accurate http handling when updating fixtures)
+This utility uses FakeWeb, thanks to those contributors for there excellent work.
 
 == Copyright
 
-Copyright (c) 2009 Justin Smestad. See LICENSE for details.
+Copyright (c) 2009-2010 Justin Smestad. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.3.0.pre
+1.3.0.pre1

data/lib/stale_fish/fixture.rb

@@ -10,7 +10,7 @@ module StaleFish
     end
 
     def is_stale?
-      if (last_updated_at + update_interval) < Time.now
+      if last_updated_at.nil? || (last_updated_at + update_interval) < Time.now
         return true
       else
         return false
@@ -19,14 +19,14 @@ module StaleFish
 
     def update!
       uri, type = URI.parse(check_against), request_type.downcase.to_sym
-      Net::HTTP.start(uri.host) { |http|
+      Net::HTTP.start(uri.host) do |http|
         response = if type == :post
-                 http.post(uri.path, uri.query)
-               else
-                 http.get(uri.path)
-               end
+                     http.post(uri.path)
+                   else
+                     http.get(uri.path)
+                   end
         write_response_to_file(response.body)
-      }
+      end
 
       self.last_updated_at = Time.now
     end

data/lib/stale_fish.rb

@@ -9,6 +9,13 @@ module StaleFish
   # no one likes stale fish.
   class << self
 
+    def setup(config_location=nil)
+      self.configuration = config_location
+      load
+      register_fixtures
+      block_requests
+    end
+
     def configuration=(config)
       @configuration = config
     end
@@ -22,12 +29,16 @@ module StaleFish
     end
 
     def update_stale(options={})
+      reset_fixtures = false
+      
       allow_requests
       fixtures(options).each do |fixture|
         if fixture.is_stale?
           fixture.update!
+          reset_fixtures = true
         end
       end
+      register_fixtures if reset_fixtures
       block_requests
       write
     end
@@ -37,6 +48,7 @@ module StaleFish
       fixtures(options).each do |fixture|
         fixture.update!
       end
+      register_fixtures
       block_requests
       write
     end
@@ -81,5 +93,12 @@ module StaleFish
       def block_requests
         FakeWeb.allow_net_connect = false
       end
+
+      def register_fixtures
+        FakeWeb.clean_registry
+        fixtures.each do |fixture|
+          fixture.register_lock!
+        end
+      end
   end
 end

data/spec/unit/fixture_spec.rb

@@ -37,6 +37,11 @@ describe StaleFish::Fixture do
     it "should return false when fresh" do
       @fresh_fixture.is_stale?.should == false
     end
+    
+    it "should return true when last_updated_at is empty" do
+      @stale_fixture.last_updated_at = nil
+      @stale_fixture.is_stale?.should == true
+    end
   end
 
   context "#update!" do

data/spec/unit/stale_fish_spec.rb

@@ -3,9 +3,22 @@ require File.join(File.dirname(__FILE__), *%w[.. spec_helper])
 describe StaleFish do
   before do
     @stale_fixture = StaleFish::Fixture.new(:last_updated_at => 1.week.ago,
-                                            :update_interval => 1.day)
+                                            :update_interval => 1.day,
+                                            :request_type => 'GET',
+                                            :check_against => 'http://google.com/index.html')
     @fresh_fixture = StaleFish::Fixture.new(:last_updated_at => 1.day.from_now,
-                                            :update_interval => 1.day)
+                                            :update_interval => 1.day,
+                                            :request_type => 'GET',
+                                            :check_against => 'http://google.com/index.html')
+  end
+
+  context ".setup" do
+    it "should call appropriate functions" do
+      StaleFish.should_receive(:load)
+      StaleFish.should_receive(:register_fixtures)
+      StaleFish.should_receive(:block_requests)
+      StaleFish.setup
+    end
   end
 
   context ".configuration" do
@@ -121,4 +134,8 @@ describe StaleFish do
       StaleFish.send(:block_requests).should == false
     end
   end
+  
+  context ".register_fixtures" do
+    
+  end
 end

data/stale_fish.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stale_fish}
-  s.version = "1.3.0.pre"
+  s.version = "1.3.0.pre1"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Smestad"]
@@ -24,12 +24,6 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/stale_fish.rb",
      "lib/stale_fish/fixture.rb",
-     "spec/fixtures/deprecated_yaml.yml",
-     "spec/fixtures/google.html",
-     "spec/fixtures/malformed_stale_fish.yml",
-     "spec/fixtures/stale_fish.yml",
-     "spec/fixtures/stale_fish_fakeweb.yml",
-     "spec/fixtures/yahoo.html",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/support/stale_fish.yml",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stale_fish
 version: !ruby/object:Gem::Version 
-  version: 1.3.0.pre
+  version: 1.3.0.pre1
 platform: ruby
 authors: 
 - Justin Smestad
@@ -50,12 +50,6 @@ files:
 - VERSION
 - lib/stale_fish.rb
 - lib/stale_fish/fixture.rb
-- spec/fixtures/deprecated_yaml.yml
-- spec/fixtures/google.html
-- spec/fixtures/malformed_stale_fish.yml
-- spec/fixtures/stale_fish.yml
-- spec/fixtures/stale_fish_fakeweb.yml
-- spec/fixtures/yahoo.html
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/stale_fish.yml

data/spec/fixtures/deprecated_yaml.yml

@@ -1,12 +0,0 @@
---- 
-stale: 
-  yahoo: 
-    filepath: ./tmp/yahoo.html
-    source: http://www.yahoo.com/
-    updated: 
-    frequency: 1.day
-  google: 
-    filepath: ./tmp/google.html
-    source: http://www.google.com/
-    updated: 
-    frequency: 2.weeks

data/spec/fixtures/malformed_stale_fish.yml

@@ -1,5 +0,0 @@
-stale:
-  google:
-    file_path: google.html
-  yahoo:
-    update_frequency: 2.weeks.ago

data/spec/fixtures/stale_fish.yml

@@ -1,11 +0,0 @@
-stale: 
-  yahoo: 
-    file_path: ./tmp/yahoo.html
-    source_url: http://www.yahoo.com/
-    last_updated_at: 
-    update_frequency: 1.day
-  google: 
-    file_path: ./tmp/google.html
-    source_url: http://www.google.com/
-    last_updated_at: 
-    update_frequency: 2.weeks

data/spec/fixtures/stale_fish_fakeweb.yml

@@ -1,13 +0,0 @@
-stale:
-  configuration:
-    use_fakeweb: true
-  yahoo:
-    file_path: ./tmp/yahoo.html
-    source_url: http://www.yahoo.com/
-    update_frequency: 1.day
-    last_updated_at: 2009-11-30T18:26:20-07:00
-  google:
-    file_path: ./tmp/google.html
-    source_url: http://www.google.com/
-    update_frequency: 2.weeks
-    last_updated_at: 2009-11-30T18:26:20-07:00