yelp 0.2.1 → 1.0.0

data/{History.txt → CHANGELOG.rdoc}

@@ -1,3 +1,23 @@
+== YELP_20091019_1_0_0
+
+* [shaper] allow specifying multiple categories for review search by
+  passing an array of the category names in the request.
+
+* [shaper] fix tests to gracefully alert user if YWSID is not set in
+  their environment.
+
+* [shaper] updated README to reflect the latest reality.
+
+* [shaper] updated Rakefile to reflect latest hoe usage.
+
+* [shaper] fixed test neighborhood search to reflect add'l info passed
+  along in yelp response.
+
+* [shaper] fixed test json validation to reflect new version of 1.1.1.
+
+* [shaper] fixed neighborhood test to suit new www.yelp.com return
+  url.
+
 == 0.2.1 / 2007-11-24
 
 * [shaper] fixed extra dependencies specified in Rakefile to allow for proper

data/Manifest.txt

@@ -1,7 +1,7 @@
-History.txt
+CHANGELOG.rdoc
 LICENSE.txt
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 TODO.txt
 lib/yelp.rb

data/{README.txt → README.rdoc}

@@ -12,6 +12,8 @@ More detailed information on the underlying Yelp API, error response codes, and
 
 The RubyForge project is hosted at http://rubyforge.org/projects/yelp.  This documentation is available at http://yelp.rubyforge.org.
 
+The latest source code is at http://github.com/shaper/yelp.
+
 == About
 
 Everybody loves Yelp! For those seeking burritos in the Mission District of
@@ -38,15 +40,15 @@ retrieved via their API, documented at http://www.yelp.com/developers/getting_st
 For tests to execute successfully you must have the YWSID set in your
 environment via (shell-dependent, bash example provided):
 
-    % export YWSID='YOUR_ID_HERE'
+ % export YWSID='YOUR_ID_HERE'
 
 == Installing
 
-We recommend installing <tt>yelp</tt> via rubygems[http://rubyforge.org/projects/rubygems/] (see also http://www.rubygems.org).
+Install +rubygems+ if you don't already have it.  See http://rubyforge.org/projects/rubygems/.
 
-Once you have +rubygems+ installed on your system, you can easily install the <tt>yelp</tt> gem by executing:
+Then install the +yelp+ gem by executing:
 
-% gem install --include-dependencies yelp
+ % gem install yelp
 
 == Usage
 
@@ -70,31 +72,39 @@ types.
 
 A few examples:
 
-    # construct a client instance
-    client = Yelp::Client.new
-
-    # perform an address/location-based search for cream puffs nearby
-    request = Yelp::Review::Request::Location.new(
-                :address => '650 Mission St',
-                :city => 'San Francisco',
-                :state => 'CA',
-                :radius => 2,
-                :term => 'cream puffs',
-                :yws_id => 'YOUR_YWSID_HERE')
-    response = client.search(request)
-
-    # perform a neighborhood name lookup for a specific geo-location point
-    request = Yelp::Neighborhood::Request::GeoPoint.new(
-                :latitude => 37.782093,
-                :longitude => -122.483230,
-                :yws_id => 'YOUR_YWSID_HERE')
-    response = client.search(request)
-
-    # perform a business review search based on a business phone number
-    request = Yelp::Phone::Request::Number.new(
-                :phone_number => '4155551212',
-                :yws_id => 'YOUR_YWSID_HERE')
-    response = client.search(request)
+ # construct a client instance
+ client = Yelp::Client.new
+
+ # perform an address/location-based search for cream puffs nearby
+ request = Yelp::Review::Request::Location.new(
+             :address => '650 Mission St',
+             :city => 'San Francisco',
+             :state => 'CA',
+             :radius => 2,
+             :term => 'cream puffs',
+             :yws_id => 'YOUR_YWSID_HERE')
+ response = client.search(request)
+
+ # perform a location-based category search for either ice cream or donut shops in SF
+ request = Yelp::Review::Request::Location.new(
+             :city => 'San Francisco',
+             :state => 'CA',
+             :category => [ 'donuts', 'icecream' ],
+             :yws_id => 'YOUR_YWSID_HERE')
+ response = client.search(request)
+
+ # perform a neighborhood name lookup for a specific geo-location point
+ request = Yelp::Neighborhood::Request::GeoPoint.new(
+             :latitude => 37.782093,
+             :longitude => -122.483230,
+             :yws_id => 'YOUR_YWSID_HERE')
+ response = client.search(request)
+
+ # perform a business review search based on a business phone number
+ request = Yelp::Phone::Request::Number.new(
+             :phone_number => '4155551212',
+             :yws_id => 'YOUR_YWSID_HERE')
+ response = client.search(request)
 
 If you want to convert some addresses to latitude/longitude, or vice
 versa, for testing or what have you -- try http://stevemorse.org/jcal/latlon.php.
@@ -105,4 +115,4 @@ This library is provided via the GNU LGPL license at http://www.gnu.org/licenses
 
 == Authors
 
-Copyright 2007, Walter Korman <shaper@wgks.org>, http://lemurware.blogspot.com
+Copyright 2007 - 2009, Walter Korman <shaper@fatgoose.com>, http://lemurware.blogspot.com

data/Rakefile

@@ -3,14 +3,23 @@ require 'hoe'
 $:.unshift(File.dirname(__FILE__) + "/lib")
 require 'yelp'
 
-Hoe.new('yelp', Yelp::VERSION) do |p|
-  p.rubyforge_name = 'yelp'
-  p.author = 'Walter Korman'
-  p.email = 'shaper@wgks.org'
-  p.extra_deps << [ 'json', '>= 1.1.1' ]
-  p.summary = 'An object-oriented interface to the Yelp Developer API.'
-  p.description = 'An object-oriented interface to the Yelp Developer API.'
-  p.url = 'http://rubyforge.org/projects/yelp'
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.remote_rdoc_dir = '' # Release to root
+Hoe.spec('yelp') do |p|
+  self.version = Yelp::VERSION
+  self.rubyforge_name = 'yelp'
+  self.author = 'Walter Korman'
+  self.email = 'shaper@fatgoose.com'
+  self.extra_deps << [ 'json', '>= 1.1.1' ]
+  self.summary = 'An object-oriented interface to the Yelp Developer API.'
+  self.description = <<EDOC
+The yelp rubygem provides a Ruby object-oriented interface to the Yelp 
+REST API described in detail at:
+
+http://www.yelp.com/developers/getting_started
+EDOC
+  self.url = 'http://rubyforge.org/projects/yelp'
+  self.changes = p.paragraphs_of('CHANGELOG.rdoc', 0..1).join("\n\n")
+  self.remote_rdoc_dir = '' # Release to root
+  self.readme_file = 'README.rdoc'
+  self.history_file = 'CHANGELOG.rdoc'
+  self.extra_rdoc_files = [ 'CHANGELOG.rdoc', 'README.rdoc' ]
 end

data/lib/yelp/client.rb

@@ -94,7 +94,9 @@ class Yelp
         params.each do |key, value|
           next if value.nil?
           url << '&' if (param_count > 0)
-          url << "#{key}=#{CGI.escape(params[key].to_s)}"
+          key_str = (params[key].kind_of?(Array)) ? 
+            params[key].map { |k| CGI.escape(k.to_s) }.join("+") : CGI.escape(params[key].to_s)
+          url << "#{CGI.escape(key.to_s)}=#{key_str}"
           param_count += 1
         end
         url

data/lib/yelp/review/request/base.rb

@@ -12,7 +12,8 @@ class Yelp
         # requested.
         attr_reader :term
 
-        # optionally narrow the results by a category
+        # optionally narrow the results by one or more categories.
+        # may be a single string value, or an Array of multiple values.
         attr_reader :category
 
         def base_url

data/lib/yelp.rb

@@ -12,5 +12,5 @@ require 'yelp/review/request/geo_point'
 require 'yelp/review/request/location'
 
 class Yelp
-  VERSION = '0.2.1'
+  VERSION = '1.0.0'
 end

data/test/test_neighborhood_search.rb

@@ -1,4 +1,3 @@
-require 'pp'
 require 'rubygems'
 require 'test/unit'
 require 'yelp'
@@ -8,14 +7,20 @@ class TestNeighborhoodSearch < Test::Unit::TestCase
   include YelpHelper
 
   def setup
-    @client = Yelp::Client.new
-    @yws_id = ENV['YWSID']
-#    @client.debug = true
+    create_client
   end
 
   GORDO_LAT = 37.782093
   GORDO_LON = -122.483230
-  GORDO_NEIGHBORHOOD = { "city" => "San Francisco", "name" => "Outer Richmond", "url" => "http://yelp.com/search?find_loc=Outer+Richmond%2C+San+Francisco%2C+CA", "state" => "CA" }
+  GORDO_NEIGHBORHOOD = {
+    "city" => "San Francisco",
+    "name" => "Outer Richmond",
+    "country_code" => "US",
+    "country" => "USA",
+    "borough" => "",
+    "url" => "http://www.yelp.com/search?find_loc=Outer+Richmond%2C+San+Francisco%2C+CA%2C+USA", 
+    "state" => "CA",
+    "state_code" => "CA" }
 
   def test_geo_point_search
     request = Yelp::Neighborhood::Request::GeoPoint.new(:latitude => GORDO_LAT,

data/test/test_phone_search.rb

@@ -1,4 +1,3 @@
-require 'pp'
 require 'rubygems'
 require 'test/unit'
 require 'yelp'
@@ -8,9 +7,7 @@ class TestPhoneSearch < Test::Unit::TestCase
   include YelpHelper
 
   def setup
-    @client = Yelp::Client.new
-    @yws_id = ENV['YWSID']
-#    @client.debug = true
+    create_client
   end
 
   GORDO_PHONE_NUMBER = '4155666011'

data/test/test_review_search.rb

@@ -1,4 +1,3 @@
-require 'pp'
 require 'rubygems'
 require 'test/unit'
 require 'yelp'
@@ -8,9 +7,7 @@ class TestReviewSearch < Test::Unit::TestCase
   include YelpHelper
 
   def setup
-    @client = Yelp::Client.new
-    @yws_id = ENV['YWSID']
-#    @client.debug = true
+    create_client
   end
 
   def test_bounding_box
@@ -71,7 +68,6 @@ class TestReviewSearch < Test::Unit::TestCase
                          :category => 'playgrounds',
                          :yws_id => @yws_id)
     narrowed_response = @client.search(narrowed_request)
-    pp narrowed_response
 
     # make sure we got less for the second
     assert(response['businesses'].length > narrowed_response['businesses'].length)
@@ -113,6 +109,51 @@ class TestReviewSearch < Test::Unit::TestCase
     validate_json_to_ruby_response(response)
   end
 
+  def test_multiple_categories
+    # fetch results for only one category
+    params = {
+      :city => 'San Francisco',
+      :state => 'CA',
+      :yws_id => @yws_id,
+      :category => 'donuts'
+    }
+    request = Yelp::Review::Request::Location.new(params)
+    response = @client.search(request)
+
+    # make sure the overall request looks kosher
+    validate_json_to_ruby_response(response)
+
+    # make sure all businesses returned have at least the specified category
+    response['businesses'].each do |b|
+      cat_exists = b['categories'].find { |c| c['category_filter'] == 'donuts' }
+      assert_not_nil(cat_exists)
+    end
+
+    # now fetch for businesses with two categories
+    params[:category] = [ 'donuts', 'icecream' ]
+    request = Yelp::Review::Request::Location.new(params)
+    response = @client.search(request)
+
+    # make sure the overall request looks kosher
+    validate_json_to_ruby_response(response)
+
+    # make sure we have at least one of each specified category, and
+    # that each business has at least one
+    donut_count = 0
+    icecream_count = 0
+    response['businesses'].each do |b|
+      has_donut = b['categories'].find { |c| c['category_filter'] == 'donuts' }
+      has_icecream = b['categories'].find { |c| c['category_filter'] == 'icecream' }
+
+      donut_count += 1 if has_donut
+      icecream_count += 1 if has_icecream
+
+      assert(has_donut || has_icecream)
+    end
+
+    assert((donut_count > 0) && (icecream_count > 0))
+  end
+
   protected
 
     def basic_request (params = nil)

data/test/yelp_helper.rb

@@ -1,8 +1,18 @@
+require 'pp'
+
 module YelpHelper
+  def create_client
+    @client = Yelp::Client.new
+    assert_not_nil(ENV['YWSID'], "Missing YWSID.  Obtain from http://www.yelp.com/developer and " +
+                   "set in your shell environment under 'YWSID'.")
+    @yws_id = ENV['YWSID']
+#    @client.debug = true
+  end
+
   def validate_json_response (response)
     assert_not_nil response
     assert_instance_of String, response
-    assert_match(/^\{"message": \{"text": "OK", "code": 0, "version": 1\.1\}, "(businesses|neighborhoods)": .*?\}$/, response)
+    assert_match(/^\{"message": \{"text": "OK", "code": 0, "version": "1\.1\.1"\}, "(businesses|neighborhoods)": .*?\}$/, response)
   end
 
   def validate_json_to_ruby_response (response)

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: yelp
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-platform: ""
+  version: 1.0.0
+platform: ruby
 authors: 
 - Walter Korman
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2007-11-24 00:00:00 -08:00
+date: 2009-10-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,30 +24,36 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.0
+        version: 2.3.3
     version: 
-description: An object-oriented interface to the Yelp Developer API.
-email: shaper@wgks.org
+description: |
+  The yelp rubygem provides a Ruby object-oriented interface to the Yelp 
+  REST API described in detail at:
+  
+  http://www.yelp.com/developers/getting_started
+
+email: shaper@fatgoose.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
 - LICENSE.txt
 - Manifest.txt
-- README.txt
 - TODO.txt
+- CHANGELOG.rdoc
+- README.rdoc
 files: 
-- History.txt
+- CHANGELOG.rdoc
 - LICENSE.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - TODO.txt
 - lib/yelp.rb
@@ -69,10 +76,12 @@ files:
 - test/yelp_helper.rb
 has_rdoc: true
 homepage: http://rubyforge.org/projects/yelp
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -90,9 +99,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yelp
-rubygems_version: 0.9.5
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: An object-oriented interface to the Yelp Developer API.
 test_files: 
 - test/test_client.rb