quixoten-craigler 1.1.0 → 1.2.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:minor: 1
+:minor: 2
 :patch: 0

data/craigler.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{craigler}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Devin Christensen"]

data/lib/craigler.rb

@@ -13,7 +13,8 @@ module Craigler
   class << self
     # Interface to Search that may or may not be more readable
     def search(category, options = {})
-      results = Search.new(options[:for], :in => (options[:in] || :anywhere), :only => category).results()
+      options = { :only => category }.merge(options)
+      results = Search.new(options.delete(:for), options).results()
       results.each {|result| yield(result) } if block_given?
       results
     end

data/lib/craigler/search.rb

@@ -4,7 +4,7 @@ module Craigler
   class Search
     include ERB::Util
     
-    attr_reader :search_term, :categories, :locations
+    attr_reader :search_term, :categories, :locations, :page_limit
     
     # Creates a wrapper object for a craigslist search
     #
@@ -13,32 +13,39 @@ module Craigler
     #   Specifies the location(s) to search in. Defaults to <tt>:anywhere</tt>.
     # [:only]
     #   Specifies the category or categories to search in. Defaults to <tt>:all_for_sale_or_wanted</tt>
+    # [:page_limit]
+    #   Maximum number of pages to fetch results from. Defaults to <tt>4</tt>.
+    #   <b>Note:</b> A location may, and often does, have more than one searchable
+    #   url assciated with it, e.g., {California}[http://geo.craigslist.org/iso/us/ca]. Because
+    #   <tt>:page_limit</tt> is applied seperately to each url within the location, searching <tt>:in => :california</tt>
+    #   with a <tt>:page_limit => 4</tt> could potentially make up to 100 page requests.</em>
     def initialize(search_term, options = {})
       raise InvalidSearchTerm if search_term.nil? || search_term == ''
       
-      @search_term = search_term
-      @results     = nil
-      _parse_options(options)
+      options       = {:in => :anywhere, :only => :all_for_sale_or_wanted, :page_limit => 4}.merge(options)
+      options[:in]  = LOCATIONS.keys if options[:in] == :anywhere
+      @locations    = (options[:in].is_a?(Array) ? options[:in] : [options[:in]]).collect(&:to_sym)
+      @categories   = (options[:only].is_a?(Array) ? options[:only] : [options[:only]]).collect(&:to_sym)
+      @page_limit   = options[:page_limit]
+      @search_term  = search_term
+      @results      = nil
+      
+      _validate_locations()
+      _validate_categories()
     end
     
     # Returns the results of the search. If this is the first time
     # calling #results then they will be fetched over the internet and cached in the search object.
     #
     # === Options
-    # [:page_limit]
-    #   Maximum number of pages to fetch results from. Defaults to <tt>4</tt>.
-    #   <b>Note:</b> A location may, and often does, have more than one searchable
-    #   url assciated with it, e.g., {California}[http://geo.craigslist.org/iso/us/ca]. Because
-    #   <tt>:page_limit</tt> is applied seperately to each url within the location, searching <tt>:in => :california</tt>
-    #   with a <tt>:page_limit => 4</tt> could potentially make up to 100 page requests.</em>
     # [:refresh]
     #   Set to <tt>true</tt> to force an update across the internet.
     def results(options = {})
-      options = { :page_limit => 4, :refresh => false }.merge(options)
+      options = { :refresh => false }.merge(options)
       return @results unless @results.nil? || options[:refresh]
       
       @results  = []
-      last_page = options[:page_limit] - 1 # pages start at 0
+      last_page = @page_limit - 1 # pages start at 0
       
       _for_each_locations_search_url() do |location, url|
         (0..last_page).each do |page|
@@ -51,18 +58,17 @@ module Craigler
       results
     end
     
-    private
-    def _parse_options(options)
-      options     = {:in => LOCATIONS.keys, :only => :all_for_sale_or_wanted}.merge(options)
-      @locations  = options[:in].is_a?(Array) ? options[:in] : [options[:in]]
-      @categories = options[:only].is_a?(Array) ? options[:only] : [options[:only]] 
-      
+    protected
+    def _validate_locations
       @locations.each() do |location|
-        raise InvalidLocation unless location == :anywhere || LOCATIONS.key?(location)
+        raise InvalidLocation.new(":anywhere not expected as part of an array") if location == :anywhere
+        raise InvalidLocation.new(":#{location} is not a valid location") unless LOCATIONS.key?(location)
       end
-      
+    end
+    
+    def _validate_categories
       @categories.each() do |category|
-        raise InvalidCategory unless category == :all_for_sale_or_wanted || CATEGORIES.key?(category)
+        raise InvalidCategory unless CATEGORIES.key?(category)
       end
     end
     

data/test/craigler_search_test.rb

@@ -47,6 +47,12 @@ class CraiglerSearchTest < Test::Unit::TestCase
         Craigler::Search.new('Suzuki Boulevard M50', :in => [:utah, :nevada])
       end
     end
+    
+    should "allow us to limit the number of pages searched" do
+      one_page_count  = Craigler::Search.new('Honda', :in => :utah, :page_limit => 1).results.size
+      two_page_count  = Craigler::Search.new('Honda', :in => :utah, :page_limit => 2).results.size
+      assert(one_page_count < two_page_count, "#{one_page_count} is not less than #{two_page_count}")
+    end
   end
   
   context "fetching search results" do
@@ -60,11 +66,5 @@ class CraiglerSearchTest < Test::Unit::TestCase
       assert(results.size > 0, "No results were returned")
       assert(results.inject(true) {|t,r| t && r.is_a?(Hash)})
     end
-    
-    should "allow us to limit the number of pages searched" do
-      one_page_count  = @search.results(:page_limit => 1).size
-      two_page_count  = @search.results(:page_limit => 2, :refresh => true).size
-      assert(one_page_count < two_page_count, "#{one_page_count} is not less than #{two_page_count}")
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: quixoten-craigler
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Devin Christensen