yelp 0.1.1

data/lib/yelp/response_format.rb

@@ -0,0 +1,36 @@
+require 'yelp/record'
+
+class Yelp
+  # Describes the available response formats when querying the Yelp web
+  # service for results.
+  #
+  class ResponseFormat < Record
+    # the name of the response format
+    attr_reader :name
+    
+    # whether this response format returns serialized data (and, so, data that
+    # we probably don't want to print to a log file and suchlike)
+    attr_reader :serialized
+
+    # the format specifier to retrieve results as straight JSON content
+    JSON = Yelp::ResponseFormat.new(:name => 'json')
+  
+    # the format specifier to retrieve results as Ruby objects converted
+    # from the returned JSON content via the +json+ rubygem.
+    JSON_TO_RUBY = Yelp::ResponseFormat.new(:name => 'json_to_ruby')
+  
+    # the format specifier to retrieve results as a serialized Python
+    # response.  We're not quite sure why you'd want to use this if
+    # you're calling it from Ruby code, but we like to see completeness
+    # in an API.
+    PICKLE = Yelp::ResponseFormat.new(:name => 'pickle', :serialized => true)
+  
+    # the format specifier to retrieve results as a serialized PHP
+    # response.  We're not quite sure why you'd want to use this if
+    # you're calling it from Ruby code, but we like to see completeness
+    # in an API.
+    PHP = Yelp::ResponseFormat.new(:name => 'php', :serialized => true)
+
+    alias :serialized? :serialized
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'yelp/request'
+
+class Yelp
+  module Review
+    module Request
+      class Base < Yelp::Request
+        # specifies the number of businesses to return in the result set.
+        # default is 10.  minimum value is 1 and maximum value is 20.
+        attr_reader :business_count
+
+        # string representing the name of business or search term being
+        # requested.
+        attr_reader :term
+
+        def base_url
+          'http://api.yelp.com/business_review_search'
+        end
+
+        def to_yelp_params
+          super.merge(:term => term,
+                      :num_biz_requested => business_count)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'yelp/review/request/base'
+
+class Yelp
+  module Review
+    module Request
+      # Describes a request to search for business reviews for businesses
+      # within a geo-point-specific bounding box and radius around
+      # that box.
+      #
+      class BoundingBox < Yelp::Review::Request::Base
+        # bottom right latitude of bounding box
+        attr_reader :bottom_right_latitude
+        
+        # bottom right longitude of bounding box
+        attr_reader :bottom_right_longitude
+        
+        # radius to use while searching around specified geo-point.
+        # default value is 1, maximum value is 25.
+        attr_reader :radius
+        
+        # top left latitude of bounding box
+        attr_reader :top_left_latitude
+        
+        # top left longitude of bounding box
+        attr_reader :top_left_longitude
+
+        def to_yelp_params
+          super.merge(:tl_lat => top_left_latitude,
+                      :tl_long => top_left_longitude,
+                      :br_lat => bottom_right_latitude,
+                      :br_long => bottom_right_longitude,
+                      :radius => radius)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'yelp/review/request/base'
+
+class Yelp
+  module Review
+    module Request
+      # Describes a request to search for business reviews for businesses near
+      # a specific geo-point and radius around that point.
+      #
+      class GeoPoint < Yelp::Review::Request::Base
+        # latitude of geo-point to search near
+        attr_reader :latitude
+
+        # longitude of geo-point to search near
+        attr_reader :longitude
+
+        # radius to use while searching around specified geo-point.
+        # default value is 1, maximum value is 25.
+        attr_reader :radius
+
+        def to_yelp_params
+          super.merge(:lat => latitude,
+                      :long => longitude,
+                      :radius => radius)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require 'yelp/review/request/base'
+
+class Yelp
+  module Review
+    module Request
+      # Describes a request to search for business reviews near a specific
+      # address/location.  You do not need to specify all of the address
+      # attributes -- some subset of the core +address+, +city+,
+      # +neighborhood+, +state+ and +zipcode+ will suffice.
+      #
+      class Location < Yelp::Review::Request::Base
+        # the street address of the location sought
+        attr_reader :address
+
+        # the city of the location sought
+        attr_reader :city
+
+        # the neighborhood of the location sought
+        attr_reader :neighborhood
+        
+        # radius to use while searching around specified geo-point.
+        # default value is 1, maximum value is 25.
+        attr_reader :radius
+
+        # the state of the location sought
+        attr_reader :state
+
+        # the zipcode of the location sought
+        attr_reader :zipcode
+
+        def initialize (params)
+          # we explicitly initialize the location fields since we reference
+          # them later when building a full location string and we want
+          # to know they were initialized properly (and avoid warnings)
+          super({
+            :address => nil,
+            :city => nil,
+            :neighborhood => nil,
+            :state => nil,
+            :zipcode => nil
+            }.merge(params))
+        end
+
+        def to_yelp_params
+          super.merge(:location => build_location_string,
+                      :radius => radius)
+        end
+        
+        protected
+        
+          # Returns the Yelp-compatible concatenated string with the various
+          # possible bits of an address-oriented location.
+          #
+          def build_location_string
+            # per the Yelp documentation, the location string is to be built
+            # as some combination of "address, neighborhood, city, state, or
+            # zip".
+            [ @address, @neighborhood, @city, @state, @zipcode ].compact.join(" ")
+          end
+      end
+    end
+  end
+end

data/test/test_client.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require 'yelp'
+
+class TestClient < Test::Unit::TestCase
+  def test_validation
+    # make sure we can do basic client instantiation
+    assert_nothing_raised do
+      @client = Yelp::Client.new
+    end
+  end
+end

data/test/test_neighborhood_search.rb

@@ -0,0 +1,41 @@
+require 'pp'
+require 'rubygems'
+require 'test/unit'
+require 'yelp'
+require File.dirname(__FILE__) + '/yelp_helper'
+
+class TestNeighborhoodSearch < Test::Unit::TestCase
+  include YelpHelper
+
+  def setup
+    @client = Yelp::Client.new
+    @yws_id = ENV['YWSID']
+#    @client.debug = true
+  end
+
+  GORDO_LAT = 37.782093
+  GORDO_LON = -122.483230
+  GORDO_NEIGHBORHOOD = 'Outer Richmond'
+
+  def test_geo_point_search
+    request = Yelp::Neighborhood::Request::GeoPoint.new(:latitude => GORDO_LAT,
+                                                        :longitude => GORDO_LON,
+                                                        :yws_id => @yws_id)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+    assert_equal response['neighborhoods'].first, GORDO_NEIGHBORHOOD
+  end
+
+  GORDO_ADDRESS = '2252 Clement Street'
+
+  def test_location_search
+    request = Yelp::Neighborhood::Request::Location.new(:address => GORDO_ADDRESS,
+                                                        :city => 'San Francisco',
+                                                        :state => 'CA',
+                                                        :zipcode => 94121,
+                                                        :yws_id => @yws_id)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+    assert_equal response['neighborhoods'].first, GORDO_NEIGHBORHOOD
+  end
+end

data/test/test_phone_search.rb

@@ -0,0 +1,23 @@
+require 'pp'
+require 'rubygems'
+require 'test/unit'
+require 'yelp'
+require File.dirname(__FILE__) + '/yelp_helper'
+
+class TestPhoneSearch < Test::Unit::TestCase
+  include YelpHelper
+
+  def setup
+    @client = Yelp::Client.new
+    @yws_id = ENV['YWSID']
+#    @client.debug = true
+  end
+
+  GORDO_PHONE_NUMBER = '4155666011'
+
+  def test_phone_search
+    request = Yelp::Phone::Request::Number.new(:phone_number => GORDO_PHONE_NUMBER, :yws_id => @yws_id)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+  end
+end

data/test/test_review_search.rb

@@ -0,0 +1,102 @@
+require 'pp'
+require 'rubygems'
+require 'test/unit'
+require 'yelp'
+require File.dirname(__FILE__) + '/yelp_helper'
+
+class TestReviewSearch < Test::Unit::TestCase
+  include YelpHelper
+
+  def setup
+    @client = Yelp::Client.new
+    @yws_id = ENV['YWSID']
+#    @client.debug = true
+  end
+
+  def test_bounding_box
+    request = Yelp::Review::Request::BoundingBox.new(
+                :bottom_right_latitude => 37.788022,
+                :bottom_right_longitude => -122.399797,
+                :top_left_latitude => 37.9,
+                :top_left_longitude => -122.5,
+#                :radius => 1,
+#                :business_count => 3,
+                :term => 'yelp',
+                :yws_id => @yws_id)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+  end
+
+  def test_geo_point
+    request = Yelp::Review::Request::GeoPoint.new(
+                :latitude => 37.78022,
+                :longitude => -122.399797,
+                :radius => 2,
+#                :business_count => 5,
+                :term => 'yelp',
+                :yws_id => @yws_id)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+  end
+  
+  def test_location
+    request = Yelp::Review::Request::Location.new(
+                :address => '650 Mission St',
+                :city => 'San Francisco',
+                :state => 'CA',
+                :radius => 2,
+#                :business_count => 5,
+                :term => 'cream puffs',
+                :yws_id => @yws_id)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+  end
+
+  def test_json_response_format
+    request = basic_request(:response_format => Yelp::ResponseFormat::JSON)
+    response = @client.search(request)
+    validate_json_response(response)
+  end
+
+  def test_json_to_ruby_response_format
+    request = basic_request(:response_format => Yelp::ResponseFormat::JSON_TO_RUBY)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+  end
+
+  def test_pickle_response_format
+    request = basic_request(:response_format => Yelp::ResponseFormat::PICKLE)
+    @client.search(request)
+    # TODO: validation
+  end
+
+  def test_php_response_format
+    request = basic_request(:response_format => Yelp::ResponseFormat::PHP)
+    response = @client.search(request)
+    # TODO: validation
+  end
+
+  def test_compressed_response
+    request = basic_request(:compress_response => true)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+  end
+
+  def test_uncompressed_response
+    request = basic_request(:compress_response => false)
+    response = @client.search(request)
+    validate_json_to_ruby_response(response)
+  end
+
+  protected
+
+    def basic_request (params = nil)
+      default_params = {
+        :city => 'San Francisco',
+        :state => 'CA',
+        :term => 'gordo',
+        :yws_id => @yws_id
+      }
+      Yelp::Review::Request::Location.new(default_params.merge(params))
+    end
+end

data/test/yelp_helper.rb

@@ -0,0 +1,35 @@
+module YelpHelper
+  def validate_json_response (response)
+    assert_not_nil response
+    assert_instance_of String, response
+    assert_match(/^\{"message": \{"text": "OK", "code": 0, "version": 1\.0\}, "(businesses|neighborhoods)": .*?\}$/, response)
+  end
+
+  def validate_json_to_ruby_response (response)
+    assert_not_nil response
+    assert_instance_of Hash, response
+    assert_not_nil response['message']
+    assert(response['message']['code'] == 0)
+    assert(response['message']['text'] == 'OK')
+    assert_not_nil((response['businesses'] || response['neighborhoods']))
+    if response['businesses']
+      response['businesses'].each { |b| validate_json_to_ruby_business(b) }
+    end
+  end
+
+  YELP_BIZ_ID_LENGTH = 22
+
+  def validate_json_to_ruby_business (business)
+    # rudimentary checks to make sure it looks like a typical yelp business
+    # result converted to a ruby hash
+    assert business['id'].length == YELP_BIZ_ID_LENGTH
+    assert_valid_url business['url']
+  end
+
+  # just a rudimentary check will serve us fine
+  VALID_URL_REGEXP = /^https?:\/\/[a-z0-9]/i
+
+  def assert_valid_url (url)
+    assert_match VALID_URL_REGEXP, url
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: yelp
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+date: 2007-08-06 00:00:00 -07:00
+summary: An object-oriented interface to the Yelp Developer API.
+require_paths: 
+- lib
+email: shaper@wgks.org
+homepage: http://www.samskivert.com/shaper/yelp
+rubyforge_project: yelp
+description: An object-oriented interface to the Yelp Developer API.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Walter Korman
+files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO.txt
+- lib/yelp.rb
+- lib/yelp/client.rb
+- lib/yelp/record.rb
+- lib/yelp/response_format.rb
+- lib/yelp/request.rb
+- lib/yelp/neighborhood/request/base.rb
+- lib/yelp/neighborhood/request/geo_point.rb
+- lib/yelp/neighborhood/request/location.rb
+- lib/yelp/phone/request/number.rb
+- lib/yelp/review/request/base.rb
+- lib/yelp/review/request/bounding_box.rb
+- lib/yelp/review/request/geo_point.rb
+- lib/yelp/review/request/location.rb
+- test/test_client.rb
+- test/test_neighborhood_search.rb
+- test/test_phone_search.rb
+- test/test_review_search.rb
+- test/yelp_helper.rb
+test_files: 
+- test/test_client.rb
+- test/test_neighborhood_search.rb
+- test/test_phone_search.rb
+- test/test_review_search.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- TODO.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: