yelp 1.0.0 → 2.0.0

data/TODO.txt

@@ -1,6 +0,0 @@
-* look into rails partials inability to properly enumerate the response
-  business records with the :collection param.
-* think about how to gracefully report errors
-* should we use "require 'json/add/rails'" for json for rails happiness?
-* use SAX-based XML parsing rather than DOM
-* consider supporting keep-alive for high volume requests

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

@@ -1,13 +0,0 @@
-require 'yelp/request'
-
-class Yelp
-  module Neighborhood
-    module Request
-      class Base < Yelp::Request
-        def base_url
-          'http://api.yelp.com/neighborhood_search'
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-require 'yelp/neighborhood/request/base'
-
-class Yelp
-  module Neighborhood
-    module Request
-      # Describes a request to search for the name of a neighborhood at a
-      # specific geo-point location.
-      #
-      class GeoPoint < Yelp::Neighborhood::Request::Base
-        # latitude of geo-point for which a neighborhood name is desired
-        attr_reader :latitude
-
-        # longitude of geo-point for which a neighborhood name is desired
-        attr_reader :longitude
-
-        def to_yelp_params
-          super.merge(:lat => latitude,
-                      :long => longitude)
-        end
-      end
-    end
-  end
-end

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

@@ -1,53 +0,0 @@
-require 'yelp/neighborhood/request/base'
-
-class Yelp
-  module Neighborhood
-    module Request
-      # Describes a request to search for a neighborhood name for a specific
-      # address/location.  You do not need to specify all of the address
-      # attributes -- some subset of the core +address+, +city+,
-      # +state+ and +zipcode+ will suffice.
-      #
-      class Location < Yelp::Neighborhood::Request::Base
-        # the street address of the location sought
-        attr_reader :address
-
-        # the city of the location sought
-        attr_reader :city
-
-        # 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,
-            :state => nil,
-            :zipcode => nil
-            }.merge(params))
-        end
-
-        def to_yelp_params
-          super.merge(:location => build_location_string)
-        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, city, state, or zip".
-            [ @address, @city, @state, @zipcode ].compact.join(" ")
-          end
-      end
-    end
-  end
-end

data/lib/yelp/phone/request/number.rb

@@ -1,24 +0,0 @@
-require 'yelp/request'
-
-class Yelp
-  module Phone
-    module Request
-      # Describes a request to search for a business review for the business
-      # associated with a specific phone number.
-      #
-      class Number < Yelp::Request
-        # the phone number of the business to search for, formatted as
-        # '1112223333'.  Make sure you don't have any hyphens or parentheses.
-        attr_reader :phone_number
-
-        def base_url
-          'http://api.yelp.com/phone_search'
-        end
-
-        def to_yelp_params
-          super.merge(:phone => phone_number)
-        end
-      end
-    end
-  end
-end

data/lib/yelp/record.rb

@@ -1,16 +0,0 @@
-class Yelp
-  # General-purpose record that allows passing a hash with parameters
-  # to populate object attributes defined via methods like
-  # +attr_reader+ or +attr_accessor+.
-  #
-  class Record
-    def initialize (params)
-      if !params.nil?
-        params.each do |key, value| 
-          name = key.to_s
-          instance_variable_set("@#{name}", value) if respond_to?(name)
-        end
-      end
-    end
-  end
-end

data/lib/yelp/request.rb

@@ -1,44 +0,0 @@
-require 'yelp/record'
-
-class Yelp
-  class Request < Yelp::Record
-    # specifies whether the response content should be transmitted
-    # over the wire compressed, defaulting to true.
-    attr_reader :compress_response
-
-    # one of the Yelp::ResponseFormat format specifiers detailing the
-    # desired format of the search results, defaulting to
-    # Yelp::ResponseFormat::JSON_TO_RUBY.
-    attr_reader :response_format
-
-    # the Yelp Web Services ID to be passed with the request for
-    # authentication purposes.  See http://www.yelp.com/developers/getting_started/api_access
-    # to get your own.
-    attr_reader :yws_id
-
-    alias :compress_response? :compress_response
-
-    def initialize (params)
-      default_params = {
-        :compress_response => true,
-        :response_format => Yelp::ResponseFormat::JSON_TO_RUBY
-        }
-      super(default_params.merge(params))
-    end
-
-    def to_yelp_params
-      params = {
-        :ywsid => yws_id
-      }
-
-      # if they specified anything other than a json variant, we
-      # need to tell yelp what we're looking for
-      case @response_format
-      when Yelp::ResponseFormat::PICKLE: params[:output] = 'pickle'
-      when Yelp::ResponseFormat::PHP: params[:output] = 'php'
-      end
-
-      params
-    end
-  end
-end

data/lib/yelp/response_format.rb

@@ -1,36 +0,0 @@
-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

@@ -1,31 +0,0 @@
-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
-
-        # 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
-          'http://api.yelp.com/business_review_search'
-        end
-
-        def to_yelp_params
-          super.merge(:term => term,
-                      :num_biz_requested => business_count,
-                      :category => category)
-        end
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-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

@@ -1,28 +0,0 @@
-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

@@ -1,63 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,46 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'yelp'
-require File.dirname(__FILE__) + '/yelp_helper'
-
-class TestNeighborhoodSearch < Test::Unit::TestCase
-  include YelpHelper
-
-  def setup
-    create_client
-  end
-
-  GORDO_LAT = 37.782093
-  GORDO_LON = -122.483230
-  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,
-                                                        :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