quixoten-craigler 1.2.0 → 1.2.1

data/README.rdoc

@@ -19,21 +19,23 @@ or
     puts item.time
   end
 
-You can also create a search object to fetch the results later. When no location or category is given Craigler searches <tt>:all_for_sale_or_wanted</tt> in <tt>:anywhere</tt>
+You can also create a search object to fetch the results later. When no location or category is given Craigler searches <tt>:all_for_sale_or_wanted</tt> <tt>:in => :anywhere</tt>
 
   search = Craigler::Search.new('Yamaha')
-  search.results(:page_limit => 1)
+  search.results()
   
 Note that additional calls to <tt>search.results()</tt> will always return the same result set unless refresh is forced
   search.results(:refresh => true)
 
+See Craigler::Search for a list of all available options
+
 === Supported Categories
 <tt>:all_for_sale_or_wanted</tt>, <tt>:art_and_crafts</tt>, <tt>:auto_parts</tt>, <tt>:baby_and_kid_stuff</tt>, <tt>:barter</tt>, <tt>:bicycles</tt>, <tt>:boats</tt>, <tt>:books</tt>, <tt>:business</tt>, <tt>:cars_and_trucks</tt>, <tt>:clothing</tt>, <tt>:collectibles</tt>, <tt>:community</tt>, <tt>:computers_and_tech</tt>, <tt>:electronics</tt>, <tt>:event</tt>, <tt>:farm_and_garden</tt>, <tt>:free_stuff</tt>, <tt>:furniture</tt>, <tt>:games_and_toys</tt>, <tt>:garage_sales</tt>, <tt>:general</tt>, <tt>:gigs</tt>, <tt>:household</tt>, <tt>:housing</tt>, <tt>:items_wanted</tt>, <tt>:jewelry</tt>, <tt>:jobs</tt>, <tt>:materials</tt>, <tt>:media</tt>, <tt>:motorcycles</tt>, <tt>:musical_instruments</tt>, <tt>:personals</tt>, <tt>:photo_and_video</tt>, <tt>:recreational_vehicles</tt>, <tt>:resume</tt>, <tt>:services_offered</tt>, <tt>:sporting_goods</tt>, <tt>:tickets</tt>, <tt>:tools</tt>
 
 === Supported Locations
 <tt>:alaska</tt>, <tt>:arizona</tt>, <tt>:arkansas</tt>, <tt>:california</tt>, <tt>:colorado</tt>, <tt>:connecticut</tt>, <tt>:delaware</tt>, <tt>:dc</tt>, <tt>:florida</tt>, <tt>:georgia</tt>, <tt>:hawaii</tt>, <tt>:idaho</tt>, <tt>:illinois</tt>, <tt>:indiana</tt>, <tt>:iowa</tt>, <tt>:kansas</tt>, <tt>:kentucky</tt>, <tt>:louisiana</tt>, <tt>:maine</tt>, <tt>:maryland</tt>, <tt>:mass</tt>, <tt>:michigan</tt>, <tt>:minnesota</tt>, <tt>:mississippi</tt>, <tt>:missouri</tt>, <tt>:montana</tt>, <tt>:nebraska</tt>, <tt>:nevada</tt>, <tt>:n_hampshire</tt>, <tt>:new_jersey</tt>, <tt>:new_mexico</tt>, <tt>:new_york</tt>, <tt>:n_carolina</tt>, <tt>:north_dakota</tt>, <tt>:ohio</tt>, <tt>:oklahoma</tt>, <tt>:oregon</tt>, <tt>:pennsylvania</tt>, <tt>:rhode_island</tt>, <tt>:s_carolina</tt>, <tt>:south_dakota</tt>, <tt>:tennessee</tt>, <tt>:texas</tt>, <tt>:utah</tt>, <tt>:vermont</tt>, <tt>:virginia</tt>, <tt>:washington</tt>, <tt>:west_virginia</tt> <tt>:wisconsin</tt>, <tt>:wyoming</tt>
 
-Or use <tt>:anywhere</tt> to search all supported locations.
+Or use <tt>:in => :anywhere</tt> to search all supported locations.
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -50,7 +50,8 @@ Rake::RDocTask.new do |rdoc|
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "Craigler #{version}"
-  rdoc.rdoc_files.include('README.rdoc', 'LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('README.rdoc', 'LICENSE')
+  rdoc.main = 'README.rdoc'
 end
 

data/VERSION.yml

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

data/craigler.gemspec

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

data/lib/craigler.rb

@@ -5,15 +5,20 @@ require 'craigler/constants'
 require 'craigler/search'
 
 module Craigler
+  
+  # :stopdoc:
   class CraiglerError < StandardError; end
   class InvalidCategory < CraiglerError; end
   class InvalidSearchTerm < CraiglerError; end
   class InvalidLocation < CraiglerError; end
+  # :startdoc:
   
   class << self
     # Interface to Search that may or may not be more readable
+    #
+    # Supports all options of Search#new except <tt>:only</tt>, as it's supplied through the <tt>category</tt> parameter
     def search(category, options = {})
-      options = { :only => category }.merge(options)
+      options = options.merge({ :only => category })
       results = Search.new(options.delete(:for), options).results()
       results.each {|result| yield(result) } if block_given?
       results

data/lib/craigler/constants.rb

@@ -1,5 +1,7 @@
 module Craigler
-  RESULTS_PER_PAGE = 25 # :nodoc:
+  
+  # :stopdoc:
+  RESULTS_PER_PAGE = 25
   
   LOCATIONS = {
     :alabama => ['http://auburn.craigslist.org/','http://bham.craigslist.org/','http://columbusga.craigslist.org/','http://dothan.craigslist.org/','http://shoals.craigslist.org/','http://gadsden.craigslist.org/','http://huntsville.craigslist.org/','http://mobile.craigslist.org/','http://montgomery.craigslist.org/','http://tuscaloosa.craigslist.org/'],
@@ -53,7 +55,7 @@ module Craigler
     :west_virginia => ['http://charlestonwv.craigslist.org/','http://huntington.craigslist.org/','http://martinsburg.craigslist.org/','http://morgantown.craigslist.org/','http://parkersburg.craigslist.org/','http://wv.craigslist.org/','http://wheeling.craigslist.org/'],
     :wisconsin => ['http://appleton.craigslist.org/','http://duluth.craigslist.org/','http://eauclaire.craigslist.org/','http://greenbay.craigslist.org/','http://janesville.craigslist.org/','http://racine.craigslist.org/','http://lacrosse.craigslist.org/','http://madison.craigslist.org/','http://milwaukee.craigslist.org/','http://sheboygan.craigslist.org/','http://wausau.craigslist.org/'],
     :wyoming => ['http://wyoming.craigslist.org/']
-  } # :nodoc:
+  }
 
   CATEGORIES = {
     :community => 'ccc',
@@ -96,5 +98,7 @@ module Craigler
     :personals => 'ppp',
     :resume => 'res',
     :services_offered => 'bbb'
-  } # :nodoc:
+  }
+  
+  # :startdoc:
 end

data/lib/craigler/search.rb

@@ -18,7 +18,7 @@ module Craigler
     #   <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>
+    #   with a <tt>:page_limit => 4</tt> could potentially make up to 100 page requests.
     def initialize(search_term, options = {})
       raise InvalidSearchTerm if search_term.nil? || search_term == ''
       
@@ -59,20 +59,20 @@ module Craigler
     end
     
     protected
-    def _validate_locations
+    def _validate_locations # :nodoc:
       @locations.each() do |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
+    def _validate_categories # :nodoc:
       @categories.each() do |category|
         raise InvalidCategory unless CATEGORIES.key?(category)
       end
     end
     
-    def _for_each_locations_search_url()
+    def _for_each_locations_search_url # :nodoc:
       @locations.each do |location|
         LOCATIONS[location].each do |url|
           @categories.each do |category|
@@ -82,7 +82,7 @@ module Craigler
       end
     end
     
-    def _extract_items_from_url(location, url)
+    def _extract_items_from_url(location, url) # :nodoc:
       (Hpricot(open(url))/'item').collect { |item| {
         :url          => item['rdf:about'],
         :title        => (item%'title').inner_text,

metadata

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