yelpster 1.1.1

data/test/test_review_search.rb

@@ -0,0 +1,168 @@
+require 'rubygems'
+require 'test/unit'
+require 'yelpster'
+require File.dirname(__FILE__) + '/yelp_helper'
+
+class TestReviewSearch < Test::Unit::TestCase
+  include YelpHelper
+
+  def setup
+    create_client YelpHelper::API_V1
+  end
+
+  def test_bounding_box
+    request = Yelp::V1::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::V1::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::V1::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_category
+    # perform a basic search of businesses near SOMA
+    request = Yelp::V1::Review::Request::GeoPoint.new(
+                :latitude => 37.78022,
+                :longitude => -122.399797,
+                :radius => 5,
+                :term => 'yelp',
+                :yws_id => @yws_id)
+    response = @client.search(request)
+
+    # perform the same search focusing only on playgrounds
+    narrowed_request = Yelp::V1::Review::Request::GeoPoint.new(
+                         :latitude => 37.78022,
+                         :longitude => -122.399797,
+                         :radius => 5,
+                         :term => 'yelp',
+                         :category => 'playgrounds',
+                         :yws_id => @yws_id)
+    narrowed_response = @client.search(narrowed_request)
+
+    # make sure we got less for the second
+    assert(response['businesses'].length > narrowed_response['businesses'].length)
+  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
+
+  def test_multiple_categories
+    # fetch results for only one category
+    params = {
+      :city => 'San Francisco',
+      :state => 'CA',
+      :yws_id => @yws_id,
+      :category => 'donuts'
+    }
+    request = Yelp::V1::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::V1::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)
+      default_params = {
+        :city => 'San Francisco',
+        :state => 'CA',
+        :term => 'gordo',
+        :yws_id => @yws_id
+      }
+      Yelp::V1::Review::Request::Location.new(default_params.merge(params))
+    end
+end

data/test/yelp_helper.rb

@@ -0,0 +1,74 @@
+require 'pp'
+
+module YelpHelper
+  API_V1 = 'v1'
+  API_V2 = 'v2'
+  
+  def create_client(api_ver)
+    @client = Yelp::Client.new
+    @api_ver = api_ver
+
+    case @api_ver
+    when API_V1
+      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']
+    when API_V2
+      assert_not_nil(ENV['CONSUMER_KEY'], "Missing CONSUMER_KEY.  Obtain from http://www.yelp.com/developer and " +
+                     "set in your shell environment under 'CONSUMER_KEY'.")
+      @consumer_key = ENV['CONSUMER_KEY']
+      assert_not_nil(ENV['CONSUMER_SECRET'], "Missing CONSUMER_SECRET.  Obtain from http://www.yelp.com/developer and " +
+                     "set in your shell environment under 'CONSUMER_SECRET'.")
+      @consumer_secret = ENV['CONSUMER_SECRET']
+      assert_not_nil(ENV['TOKEN'], "Missing TOKEN.  Obtain from http://www.yelp.com/developer and " +
+                     "set in your shell environment under 'TOKEN'.")
+      @token = ENV['TOKEN']
+      assert_not_nil(ENV['TOKEN_SECRET'], "Missing TOKEN_SECRET.  Obtain from http://www.yelp.com/developer and " +
+                     "set in your shell environment under 'TOKEN_SECRET'.")
+      @token_secret = ENV['TOKEN_SECRET']
+    else
+      assert_false("No api version specified in test case; cannot continue")
+    end
+    
+#    @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\.1\"\},\"(businesses|neighborhoods)\":.*?\}$/, response)
+  end
+
+  def validate_json_to_ruby_response (response)
+    assert_not_nil response
+    assert_instance_of Hash, response
+    case @api_ver
+    when API_V1
+      assert_not_nil response['message']
+      assert(response['message']['code'] == 0)
+      assert(response['message']['text'] == 'OK')
+    when API_V2
+      # v2 responses do not have a message field
+    end
+    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 > 0
+    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

data/yelpster.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "yelpster"
+  s.version = "1.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Naveed Siddiqui"]
+  s.date = "2011-10-13"
+  s.description = "Extension of Korman's Ruby wrapper to interface with Yelp's REST API described in detail at:\n\nhttp://www.yelp.com/developers/getting_started\n"
+  s.email = "naveed@10eighteen.com"
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "LICENSE.txt", "README.rdoc", "TODO.txt", "lib/yelpster.rb", "lib/yelpster/client.rb", "lib/yelpster/record.rb", "lib/yelpster/response_format.rb", "lib/yelpster/v1/neighborhood/request/base.rb", "lib/yelpster/v1/neighborhood/request/geo_point.rb", "lib/yelpster/v1/neighborhood/request/location.rb", "lib/yelpster/v1/phone/request/number.rb", "lib/yelpster/v1/request.rb", "lib/yelpster/v1/review/request/base.rb", "lib/yelpster/v1/review/request/bounding_box.rb", "lib/yelpster/v1/review/request/geo_point.rb", "lib/yelpster/v1/review/request/location.rb", "lib/yelpster/v2/business/request/id.rb", "lib/yelpster/v2/request.rb", "lib/yelpster/v2/search/request/base.rb", "lib/yelpster/v2/search/request/bounding_box.rb", "lib/yelpster/v2/search/request/geo_point.rb", "lib/yelpster/v2/search/request/location.rb"]
+  s.files = ["CHANGELOG.rdoc", "LICENSE.txt", "Manifest", "README.rdoc", "Rakefile", "TODO.txt", "lib/yelpster.rb", "lib/yelpster/client.rb", "lib/yelpster/record.rb", "lib/yelpster/response_format.rb", "lib/yelpster/v1/neighborhood/request/base.rb", "lib/yelpster/v1/neighborhood/request/geo_point.rb", "lib/yelpster/v1/neighborhood/request/location.rb", "lib/yelpster/v1/phone/request/number.rb", "lib/yelpster/v1/request.rb", "lib/yelpster/v1/review/request/base.rb", "lib/yelpster/v1/review/request/bounding_box.rb", "lib/yelpster/v1/review/request/geo_point.rb", "lib/yelpster/v1/review/request/location.rb", "lib/yelpster/v2/business/request/id.rb", "lib/yelpster/v2/request.rb", "lib/yelpster/v2/search/request/base.rb", "lib/yelpster/v2/search/request/bounding_box.rb", "lib/yelpster/v2/search/request/geo_point.rb", "lib/yelpster/v2/search/request/location.rb", "test/test_business_retrieve.rb", "test/test_business_search.rb", "test/test_client.rb", "test/test_neighborhood_search.rb", "test/test_phone_search.rb", "test/test_review_search.rb", "test/yelp_helper.rb", "yelpster.gemspec"]
+  s.homepage = "https://github.com/nvd/yelpster"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Yelpster", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "yelpster"
+  s.rubygems_version = "1.8.11"
+  s.summary = "An object-oriented interface to the Yelp Developer API."
+  s.test_files = ["test/test_business_retrieve.rb", "test/test_business_search.rb", "test/test_client.rb", "test/test_neighborhood_search.rb", "test/test_phone_search.rb", "test/test_review_search.rb"]
+  s.signing_key = '/Users/naveed/Desktop/dev/Certificates/yelpster/gem-private_key.pem'
+  s.cert_chain  = ['gem-public_cert.pem']
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 1.1.1"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0.4.5"])
+    else
+      s.add_dependency(%q<json>, [">= 1.1.1"])
+      s.add_dependency(%q<oauth>, [">= 0.4.5"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 1.1.1"])
+    s.add_dependency(%q<oauth>, [">= 0.4.5"])
+  end
+end

data.tar.gz.sig

@@ -0,0 +1,3 @@
+���*㲣�=�ׁkJ���6��S$Q��2ғ����Rz�d{M� -W�_�.��f�-]@b�Q΄�W�=7S�V��ʢ�`Kx��X�u@	��m����	�u���{�&h���	�eU|,+[�.�+���>C��s�W
��Y�!����m�
+F��G�H��k��'�~v
%£k>�M;�?쓞����>�����mq��VP�st*mԃE5o�5RP

+��2W��9�<Ÿ9�.�@n��^�u)�

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: yelpster
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.1.1
+platform: ruby
+authors: 
+- Naveed Siddiqui
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDODCCAiCgAwIBAgIBADANBgkqhkiG9w0BAQUFADBCMQ8wDQYDVQQDDAZuYXZl
+  ZWQxGjAYBgoJkiaJk/IsZAEZFgoxMGVpZ2h0ZWVuMRMwEQYKCZImiZPyLGQBGRYD
+  Y29tMB4XDTExMTAxMzE0MTg0NloXDTEyMTAxMjE0MTg0NlowQjEPMA0GA1UEAwwG
+  bmF2ZWVkMRowGAYKCZImiZPyLGQBGRYKMTBlaWdodGVlbjETMBEGCgmSJomT8ixk
+  ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM/MW7owmvsy
+  BlEVc5yDWxLMWQvK6igewl4YBienALpPzcVnLEcYVS9gQIGbx4weiw3gNMm+6keY
+  lFYFOzu29KvYQrmc8QqSfLq8r8hRe/3Lcx4fQdZHQuoPtvZ7YOZSAGRIQuBont9W
+  8VVgbF8KjDj1IUFi/YI+VfMXD4xypyXC8mzaEaHFpquM9GKh46++s382IBOv2sZV
+  UNVBRvmHYkV+8ysGiH6vgwkNTTHC9+oHhXQYPQ51A+I1CI1jnMs5LRgwKiZ/L93G
+  V8NbvR/CdKKbAtOs20QT60CMVOF5UsF9XTynu3+HRNYQ7eQirukp8275R5I3Geh8
+  2XtRv8hzO+MCAwEAAaM5MDcwCQYDVR0TBAIwADAdBgNVHQ4EFgQUGgYrXrTHBcRx
+  IGkT4AgsUqHCPUIwCwYDVR0PBAQDAgSwMA0GCSqGSIb3DQEBBQUAA4IBAQDLI4Li
+  SDEmqnyONx7uFK9vDnzr1crqRyK5F3HkFYLudCrtgpPz2PSHxg9z421rWp34n18Z
+  E9mWA8SrBVAFmqH9zuj5TSmXKrO72157MdNy2MIIych8auu3CATZTVCFdGVkcYXx
+  HyAiuqfHI73U1D0BWRz7ZzOnE2QqVBekmDLmEGZyiJUoQPSAFb1Zr7h8hKyPkHev
+  0iXzgNY1VjcdDGmhcbg86mk3sWk0AnVk3oLwxo+6r8lc+AuRT59edeRkxN7HA3zb
+  ahJOnBb3+Ql5b9v2KMN1rct+SqTnjD+zEkVeGz9gW5zsRWvx1sbNCxgD6zQJ9SXH
+  zztOQ91rVpCrfFhH
+  -----END CERTIFICATE-----
+
+date: 2011-10-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+  type: :runtime
+  version_requirements: *id002
+description: |
+  Extension of Korman's Ruby wrapper to interface with Yelp's REST API described in detail at:
+  
+  http://www.yelp.com/developers/getting_started
+
+email: naveed@10eighteen.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- LICENSE.txt
+- README.rdoc
+- TODO.txt
+- lib/yelpster.rb
+- lib/yelpster/client.rb
+- lib/yelpster/record.rb
+- lib/yelpster/response_format.rb
+- lib/yelpster/v1/neighborhood/request/base.rb
+- lib/yelpster/v1/neighborhood/request/geo_point.rb
+- lib/yelpster/v1/neighborhood/request/location.rb
+- lib/yelpster/v1/phone/request/number.rb
+- lib/yelpster/v1/request.rb
+- lib/yelpster/v1/review/request/base.rb
+- lib/yelpster/v1/review/request/bounding_box.rb
+- lib/yelpster/v1/review/request/geo_point.rb
+- lib/yelpster/v1/review/request/location.rb
+- lib/yelpster/v2/business/request/id.rb
+- lib/yelpster/v2/request.rb
+- lib/yelpster/v2/search/request/base.rb
+- lib/yelpster/v2/search/request/bounding_box.rb
+- lib/yelpster/v2/search/request/geo_point.rb
+- lib/yelpster/v2/search/request/location.rb
+files: 
+- CHANGELOG.rdoc
+- LICENSE.txt
+- Manifest
+- README.rdoc
+- Rakefile
+- TODO.txt
+- lib/yelpster.rb
+- lib/yelpster/client.rb
+- lib/yelpster/record.rb
+- lib/yelpster/response_format.rb
+- lib/yelpster/v1/neighborhood/request/base.rb
+- lib/yelpster/v1/neighborhood/request/geo_point.rb
+- lib/yelpster/v1/neighborhood/request/location.rb
+- lib/yelpster/v1/phone/request/number.rb
+- lib/yelpster/v1/request.rb
+- lib/yelpster/v1/review/request/base.rb
+- lib/yelpster/v1/review/request/bounding_box.rb
+- lib/yelpster/v1/review/request/geo_point.rb
+- lib/yelpster/v1/review/request/location.rb
+- lib/yelpster/v2/business/request/id.rb
+- lib/yelpster/v2/request.rb
+- lib/yelpster/v2/search/request/base.rb
+- lib/yelpster/v2/search/request/bounding_box.rb
+- lib/yelpster/v2/search/request/geo_point.rb
+- lib/yelpster/v2/search/request/location.rb
+- test/test_business_retrieve.rb
+- test/test_business_search.rb
+- test/test_client.rb
+- test/test_neighborhood_search.rb
+- test/test_phone_search.rb
+- test/test_review_search.rb
+- test/yelp_helper.rb
+- yelpster.gemspec
+homepage: https://github.com/nvd/yelpster
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Yelpster
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+requirements: []
+
+rubyforge_project: yelpster
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: An object-oriented interface to the Yelp Developer API.
+test_files: 
+- test/test_business_retrieve.rb
+- test/test_business_search.rb
+- test/test_client.rb
+- test/test_neighborhood_search.rb
+- test/test_phone_search.rb
+- test/test_review_search.rb