yelped 0.1.1

data/lib/yelped/v1/review/request/bounding_box.rb

@@ -0,0 +1,39 @@
+require 'yelped/v1/review/request/base'
+
+class Yelp
+  module V1
+	  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::V1::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
+end

data/lib/yelped/v1/review/request/geo_point.rb

@@ -0,0 +1,30 @@
+require 'yelped/v1/review/request/base'
+
+class Yelp
+  module V1
+	  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::V1::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
+end

data/lib/yelped/v1/review/request/location.rb

@@ -0,0 +1,65 @@
+require 'yelped/v1/review/request/base'
+
+class Yelp
+  module V1
+	  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::V1::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
+end

data/lib/yelped/v2/business/request/id.rb

@@ -0,0 +1,19 @@
+require 'yelped/v2/request'
+
+class Yelp
+	module V2
+		module Business
+			module Request
+				class Id < Yelp::V2::Request
+          # the alphanumeric id of the business to search for as provided by yelp, 
+          # eg: 'pjb2WMwa0AfK3L-dWimO8w'
+  				attr_reader :yelp_business_id
+				
+  				def base_url
+  				  'http://api.yelp.com/v2/business/'+yelp_business_id
+  				end
+				end
+			end
+		end
+	end
+end

data/lib/yelped/v2/request.rb

@@ -0,0 +1,56 @@
+require 'yelped/record'
+require 'oauth'
+
+class Yelp
+  module V2
+	  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 consumer_key, consumer_secret, token, token_secret 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 :consumer_key
+		attr_reader :consumer_secret
+		attr_reader :token
+		attr_reader :token_secret
+
+		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 = {}
+		  
+		  # 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
+		
+		def pull_results (url, http_params)
+		  consumer = OAuth::Consumer.new(consumer_key, consumer_secret, {:site => "http://api.yelp.com"})
+		  access_token = OAuth::AccessToken.new(consumer, token, token_secret)
+		  access_token.get(url).body
+		end
+	  end
+   end
+end

data/lib/yelped/v2/search/request/base.rb

@@ -0,0 +1,68 @@
+require 'yelped/v2/request'
+
+class Yelp
+  module V2
+	  module Search
+  		module Request
+  		  class Base < Yelp::V2::Request
+    			#------------------------General Search Params -----------------
+    			# string representing the name of business or search term being
+          #requested.
+    			attr_reader :term
+
+          # integer representing number of business results to return
+    			attr_reader :limit
+			
+    			# integer representing number of results to skip (for pagination)
+    			attr_reader :offset
+			
+    			# integer for specifying how to sort results
+    			# Sort Mode:  
+    			#     0 = Best matched (default)
+    			#     1 = Distance
+    			#     2 = Highest rated
+    			# see www.yelp.com/developers/documentation/v2/search_api for more info
+    			attr_reader :sort
+			
+    			# string specifying which business category to search in
+    			# see www.yelp.com/developers/documentation/category_list for list of 
+    			# categories
+    			attr_reader :category_filter
+			
+    			# integer specifying the search radius in meters
+     			attr_reader :radius_filter
+			
+    			# boolean representing if business has claimed location
+    			# not implemented by yelp as of 13-8-2011
+    			attr_reader :claimed_filter
+    			#---------------------------------------------------------------
+
+    			#--------------------------- Locale Params ---------------------
+    			# string representing default country to use while parsing location field
+    			attr_reader :cc
+			
+    			# string representing which language of reviews to return 
+    			attr_reader :lang
+    			#---------------------------------------------------------------
+			
+    			def base_url
+    			  'http://api.yelp.com/v2/search'
+    			end
+
+    			def to_yelp_params
+    				super.merge(:term 	=> term,
+    							:limit 	=> limit,
+    							:offset => offset,
+    							:sort 	=> sort,
+    							:category_filter => category_filter,
+    							:radius_filter 	=> radius_filter,
+    							:claimed_filter => claimed_filter,
+
+    							:cc 	=> cc,
+    							:lang 	=> lang)
+    			end
+    		end
+      end
+    end
+  end
+end

data/lib/yelped/v2/search/request/bounding_box.rb

@@ -0,0 +1,30 @@
+require 'yelped/v2/search/request/base'
+
+class Yelp
+  module V2
+	  module Search
+  		module Request
+  		  # Describes a request to search for businesses
+  		  # within a geo-point-specific bounding box 
+  		  #
+  		  class BoundingBox < Yelp::V2::Search::Request::Base
+    			# REQUIRED - double, bottom right latitude of bounding box (SOUTH-WEST LAT)
+    			attr_reader :sw_latitude
+		
+    			# REQUIRED - double, bottom right longitude of bounding box (SOUTH-WEST LONG)
+    			attr_reader :sw_longitude
+			
+    			# REQUIRED - double, top left latitude of bounding box (NORTH-EAST LAT)
+    			attr_reader :ne_latitude
+			
+    			# REQUIRED - double, top left longitude of bounding box (NORTH-EAST LONG)
+    			attr_reader :ne_longitude
+
+    			def to_yelp_params
+    			  super.merge(:bounds => "#{sw_latitude},#{sw_longitude}|#{ne_latitude},#{ne_longitude}")
+    			end
+    		end
+      end
+    end
+  end
+end

data/lib/yelped/v2/search/request/geo_point.rb

@@ -0,0 +1,54 @@
+require 'yelped/v2/search/request/base'
+
+class Yelp
+  module V2
+	  module Search
+  		module Request
+  		  # Describes a request to search for the name of a neighborhood at a
+  		  # specific geo-point location.
+  		  #
+  		  class GeoPoint < Yelp::V2::Search::Request::Base
+    			# REQUIRED - double, latitude of geo-point to search
+    			attr_reader :latitude
+
+    			# REQUIRED - double, longitude of geo-point to search
+    			attr_reader :longitude
+			
+    			# OPTIONAL - double, accuracy of latitude and longitude of geo-point to search
+    			attr_reader :accuracy
+			
+    			# OPTIONAL - double, altitude of geo-point to search
+    			attr_reader :altitude
+			
+    			# OPTIONAL - double, accuracy of altitude geo-point to search
+    			attr_reader :altitude_accuracy
+
+    			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)
+    				# 50 and -100 default values are provided as they lie within yelp API's geo-location range
+    				super({
+    				:latitude	=> 50.0,
+    				:longitude	=> -100.0,
+    				:accuracy	=> nil,
+    				:altitude	=> nil,
+    				:altitude_accuracy => nil
+    				}.merge(params))
+    			end
+			
+    			def to_yelp_params
+    			  super.merge(:ll => build_geo_loc_string)
+    			end
+			
+    			# Returns the Yelp-compatible concatenated string with the various
+    			# possible bits of an address-oriented location.
+    			#
+    			def build_geo_loc_string
+    				[ @latitude, @longitude, @accuracy, @altitude, @altitude_accuracy ].compact.join(",")
+    			end
+    		end
+      end
+    end
+  end
+end

data/lib/yelped/v2/search/request/location.rb

@@ -0,0 +1,76 @@
+require 'yelped/v2/search/request/base'
+
+class Yelp
+  module V2
+	  module Search
+    		module Request
+    		  # Describes a request to search for a businesses by a 
+    		  # address/location.  You do not need to specify all of the address
+    		  # attributes -- some subset of the core 
+    		  # 			address, neighborhood, city, state or zip, optional country
+    		  #
+    		  class Location < Yelp::V2::Search::Request::Base
+    		    # NOTE: At least one of address, neighborhood, city, state, 
+    		    # zipcode or country must be specified
+
+      			# string representing the street address of the location sought
+      			attr_reader :address
+			
+      			# string representing the neighborhood of the location sought
+      			attr_reader :neighborhood
+
+      			# string representing the city of the location sought
+      			attr_reader :city
+
+      			# string representing the state of the location sought
+      			attr_reader :state
+
+      			# string representing the zipcode of the location sought
+      			attr_reader :zipcode
+			
+      			# string representing the country of the location sought
+      			attr_reader :country
+			
+      			# additional attributes that can be specified = latitude + longitude
+      			attr_reader :latitude
+      			attr_reader :longitude
+
+      			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,
+        				      :neighborhood => nil,
+        				      :city 			  => nil,
+        				      :state 			  => nil,
+        				      :zipcode 		  => nil,
+        				      :country 		  => nil,
+        				      :latitude 	  => nil,
+        				      :longitude 	  => nil
+        			}.merge(params))
+      			end
+
+      			def to_yelp_params
+      			  super.merge(:location => build_location_string,
+      						        :cll		  => build_geo_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, neighborhood, city, state, or zip, country".
+      				[ @address, @neighborhood, @city, @state, @zipcode, @country ].compact.join(" ")
+      			end
+			
+      			def build_geo_location_string
+      				[ @latitude, @longitude ].collect{|var| var || 0}.join(",")
+      			end
+    		end
+      end
+    end
+  end
+end