jsmestad-stale_fish 1.1.1 → 1.1.2

data/README.rdoc

@@ -1,6 +1,16 @@
 = 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.
+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.
+
+== 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)
+* 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
 
@@ -67,6 +77,10 @@ For all tests add the following to test_helper.rb
 
 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)
+
 == Copyright
 
 Copyright (c) 2009 Justin Smestad. See LICENSE for details.

data/Rakefile

@@ -5,14 +5,14 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "stale_fish"
-    gem.summary = %Q{keeps fixtures synchronized with sources to prevent outdated fixtures going undetected. }
+    gem.summary = %Q{ keeps fixtures synchronized with sources to prevent outdated fixtures going undetected. }
     gem.email = "justin.smestad@gmail.com"
     gem.homepage = "http://github.com/jsmestad/stale_fish"
     gem.authors = ["Justin Smestad"]
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
 
     gem.add_dependency "fakeweb", ">= 1.2.4"
-    gem.add_dependency "rio", ">= 0.4.2"
+    gem.add_dependency "resourceful", "~> 0.6.1"
     gem.add_dependency "activesupport", ">= 2.1.2"
   end
 

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

data/lib/stale_fish.rb

@@ -3,7 +3,7 @@ require 'ftools'
 require 'yaml'
 require 'rubygems'
 require 'activesupport' # only used for time helpers
-require 'rio'
+require 'resourceful'
 begin
   require "fakeweb"
 rescue LoadError
@@ -13,23 +13,27 @@ end
 module StaleFish
   # no one likes stale fish.
 
+  class FixtureUpdateFailure < StandardError; end
+  class MalformedSourceURL < StandardError;  end
+
   class << self
     attr_accessor :use_fakeweb
     attr_accessor :config_path
     attr_accessor :yaml
     attr_accessor :configuration
+    attr_accessor :http
   end
 
   self.use_fakeweb = false
+  self.http = Resourceful::HttpAccessor.new
 
   def self.valid_path?
-    return false if config_path.nil?
-    File.exist?(config_path)
+    !config_path.nil? ? File.exist?(config_path) : false
   end
 
   def self.update_stale(*args)
     # check each file for update
-    load_yaml #if self.yaml.nil?
+    load_yaml if self.yaml.nil?
     stale = flag_stale(args)
     process(stale)
     write_yaml
@@ -37,28 +41,22 @@ module StaleFish
   end
 
   def self.register_uri(source_uri, response)
-    if use_fakeweb && !FakeWeb.registered_uri?(source_uri)
-      FakeWeb.register_uri(:any, source_uri, :body => response)
-    end
+    FakeWeb.register_uri(:any, source_uri, :body => response) if use_fakeweb && !FakeWeb.registered_uri?(source_uri)
   end
 
   def self.load_yaml
-    if valid_path?
-      self.yaml = YAML.load_file(config_path)
-      raise YAML::Error, 'missing stale root element' unless self.yaml['stale']
-
-      # Grab Configuration from YAML
-      configuration = self.yaml['stale'].delete('configuration')
-      use_fakeweb = (@configuration['use_fakeweb'] || false) unless configuration.nil?
-
-      # Process remaining nodes as items
-      self.yaml['stale'].each do |key, value|
-        %w{ filepath frequency source }.each do |field|
-          raise YAML::Error, "missing #{field} node for #{key}" unless self.yaml['stale'][key][field]
-        end
-      end
-    else
-      raise Errno::ENOENT, 'invalid path, please set StaleFish.config_path than ensure StaleFish.valid_path? is true'
+    raise Errno::ENOENT, 'invalid path, please set StaleFish.config_path than ensure StaleFish.valid_path? is true' unless valid_path?
+
+    self.yaml = YAML.load_file(config_path)
+    raise YAML::Error, 'missing stale root element' unless self.yaml['stale']
+
+    # Grab Configuration from YAML
+    self.configuration = self.yaml['stale'].delete('configuration')
+    use_fakeweb = (configuration['use_fakeweb'] || false) unless configuration.nil?
+
+    # Process remaining nodes as items
+    self.yaml['stale'].each do |key, value|
+      %w{ filepath frequency source }.each { |field| raise YAML::Error, "missing #{field} node for #{key}" unless value[field] }
     end
   end
 
@@ -69,27 +67,27 @@ protected
     stale, scope = {}, self.yaml['stale']
     scope.each do |key, value|
       if args.empty?
-        if scope[key]['updated'].blank?
-          stale.merge!({key => scope[key]})
+        if value['updated'].blank?
+          stale.merge!({key => value})
         else
-          last_modified = scope[key]['updated']
-          update_on = DateTime.now + eval(scope[key]['frequency'])
+          last_modified = value['updated']
+          update_on = DateTime.now + eval(value['frequency'])
           if last_modified > update_on
-            stale.merge!({key => scope[key]})
+            stale.merge!({key => value})
           else
-            register_uri(scope[key]['source'], scope[key]['filepath'])
+            register_uri(value['source'], value['filepath'])
           end
         end
       else
-        last_modified = scope[key]['updated']
-        update_on = DateTime.now + eval(scope[key]['frequency'])
+        last_modified = value['updated']
+        update_on = DateTime.now + eval(value['frequency'])
         if force == true
-          stale.merge!({key => scope[key]}) if args.include?(key)
+          stale.merge!({key => value}) if args.include?(key)
         else
-          if args.include?(key) && (scope[key]['updated'].blank? || last_modified > update_on)
-            stale.merge!({key => scope[key]})
+          if args.include?(key) && (value['updated'].blank? || last_modified > update_on)
+            stale.merge!({key => value})
           else
-            register_uri(scope[key]['source'], scope[key]['filepath'])
+            register_uri(value['source'], value['filepath'])
           end
         end
       end
@@ -101,9 +99,17 @@ protected
     FakeWeb.allow_net_connect = true if use_fakeweb
 
     fixtures.each do |key, value|
-      rio(fixtures[key]['source']) > rio(fixtures[key]['filepath'])
-      register_uri(fixtures[key]['source'], fixtures[key]['filepath'])
-      update_fixture(key)
+      begin
+        @response = http.resource(value['source']).get
+        File.open(value['filepath'], 'w') { |f| f.write @response.body.to_s }
+
+        update_fixture(key)
+      rescue Resourceful::UnsuccessfulHttpRequestError
+        raise FixtureUpdateFailure, "#{key}'s source: #{value['source']} returned unsuccessfully."
+      rescue ArgumentError
+        raise MalformedSourceURL, "#{key}'s source: #{value['source']} is not a valid URL path. Most likely it's missing a trailing slash."
+      end
+      register_uri(value['source'], value['filepath'])
     end
 
     FakeWeb.allow_net_connect = false if use_fakeweb

data/spec/fixtures/stale_fish.yml

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

data/spec/fixtures/stale_fish_fakeweb.yml

@@ -3,10 +3,10 @@ stale:
   yahoo: 
     filepath: ./tmp/yahoo.html
     frequency: 1.day
-    updated: 2009-09-14 00:47:54 -06:00
-    source: http://www.yahoo.com
+    updated: 2009-09-15T11:58:51-06:00
+    source: http://www.yahoo.com/
   google: 
     filepath: ./tmp/google.html
     frequency: 2.weeks
-    updated: 2009-09-14 00:47:54 -06:00
-    source: http://www.google.com
+    updated: 2009-09-15T11:58:51-06:00
+    source: http://www.google.com/

data/stale_fish.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stale_fish}
-  s.version = "1.1.1"
+  s.version = "1.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Smestad"]
@@ -49,16 +49,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<fakeweb>, [">= 1.2.4"])
-      s.add_runtime_dependency(%q<rio>, [">= 0.4.2"])
+      s.add_runtime_dependency(%q<resourceful>, ["~> 0.6.1"])
       s.add_runtime_dependency(%q<activesupport>, [">= 2.1.2"])
     else
       s.add_dependency(%q<fakeweb>, [">= 1.2.4"])
-      s.add_dependency(%q<rio>, [">= 0.4.2"])
+      s.add_dependency(%q<resourceful>, ["~> 0.6.1"])
       s.add_dependency(%q<activesupport>, [">= 2.1.2"])
     end
   else
     s.add_dependency(%q<fakeweb>, [">= 1.2.4"])
-    s.add_dependency(%q<rio>, [">= 0.4.2"])
+    s.add_dependency(%q<resourceful>, ["~> 0.6.1"])
     s.add_dependency(%q<activesupport>, [">= 2.1.2"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsmestad-stale_fish
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - Justin Smestad
@@ -23,14 +23,14 @@ dependencies:
         version: 1.2.4
     version: 
 - !ruby/object:Gem::Dependency 
-  name: rio
+  name: resourceful
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.4.2
+        version: 0.6.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: activesupport