Class: GooglePlaces::Spot
- Inherits:
-
Object
- Object
- GooglePlaces::Spot
- Defined in:
- lib/google_places/spot.rb
Instance Attribute Summary collapse
-
#address_components ⇒ Object
Returns the value of attribute address_components.
-
#aspects ⇒ Object
Returns the value of attribute aspects.
-
#cid ⇒ Object
Returns the value of attribute cid.
-
#city ⇒ Object
Returns the value of attribute city.
-
#country ⇒ Object
Returns the value of attribute country.
-
#formatted_address ⇒ Object
Returns the value of attribute formatted_address.
-
#formatted_phone_number ⇒ Object
Returns the value of attribute formatted_phone_number.
-
#icon ⇒ Object
Returns the value of attribute icon.
-
#id ⇒ Object
Returns the value of attribute id.
-
#international_phone_number ⇒ Object
Returns the value of attribute international_phone_number.
-
#lat ⇒ Object
Returns the value of attribute lat.
-
#lng ⇒ Object
Returns the value of attribute lng.
-
#name ⇒ Object
Returns the value of attribute name.
-
#nextpagetoken ⇒ Object
Returns the value of attribute nextpagetoken.
-
#opening_hours ⇒ Object
Returns the value of attribute opening_hours.
-
#photos ⇒ Object
Returns the value of attribute photos.
-
#postal_code ⇒ Object
Returns the value of attribute postal_code.
-
#price_level ⇒ Object
Returns the value of attribute price_level.
-
#rating ⇒ Object
Returns the value of attribute rating.
-
#reference ⇒ Object
Returns the value of attribute reference.
-
#region ⇒ Object
Returns the value of attribute region.
-
#review_summary ⇒ Object
Returns the value of attribute review_summary.
-
#reviews ⇒ Object
Returns the value of attribute reviews.
-
#street ⇒ Object
Returns the value of attribute street.
-
#street_number ⇒ Object
Returns the value of attribute street_number.
-
#types ⇒ Object
Returns the value of attribute types.
-
#url ⇒ Object
Returns the value of attribute url.
-
#vicinity ⇒ Object
Returns the value of attribute vicinity.
-
#website ⇒ Object
Returns the value of attribute website.
-
#zagat_reviewed ⇒ Object
Returns the value of attribute zagat_reviewed.
-
#zagat_selected ⇒ Object
Returns the value of attribute zagat_selected.
Class Method Summary collapse
-
.find(reference, api_key, sensor, options = {}) ⇒ Spot
Search for a Spot with a reference key.
-
.list(lat, lng, api_key, sensor, options = {}) ⇒ Array<Spot>
Search for Spots at the provided location.
-
.list_by_pagetoken(pagetoken, api_key, sensor, options = {}) ⇒ Array<Spot>
Search for Spots with a pagetoken.
-
.list_by_query(query, api_key, sensor, options = {}) ⇒ Array<Spot>
Search for Spots with a query.
- .multi_pages_request(method, multipage_request, options) ⇒ Object
- .request(method, multipage_request, exclude, options) ⇒ Object
Instance Method Summary collapse
- #[](key) ⇒ Object
- #address_component(address_component_type, address_component_length) ⇒ Object
- #address_components_of_type(type) ⇒ Object
- #aspects_component(json_aspects) ⇒ Object
-
#initialize(json_result_object) ⇒ Spot
constructor
A newly created spot.
- #photos_component(json_photos) ⇒ Object
- #reviews_component(json_reviews) ⇒ Object
Constructor Details
#initialize(json_result_object) ⇒ Spot
Returns a newly created spot.
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/google_places/spot.rb', line 281 def initialize(json_result_object) @reference = json_result_object['reference'] @vicinity = json_result_object['vicinity'] @lat = json_result_object['geometry']['location']['lat'] @lng = json_result_object['geometry']['location']['lng'] @name = json_result_object['name'] @icon = json_result_object['icon'] @types = json_result_object['types'] @id = json_result_object['id'] @formatted_phone_number = json_result_object['formatted_phone_number'] @international_phone_number = json_result_object['international_phone_number'] @formatted_address = json_result_object['formatted_address'] @address_components = json_result_object['address_components'] @street_number = address_component(:street_number, 'short_name') @street = address_component(:route, 'long_name') @city = address_component(:locality, 'long_name') @region = address_component(:administrative_area_level_1, 'long_name') @postal_code = address_component(:postal_code, 'long_name') @country = address_component(:country, 'long_name') @rating = json_result_object['rating'] @price_level = json_result_object['price_level'] @opening_hours = json_result_object['opening_hours'] @url = json_result_object['url'] @cid = json_result_object['url'].to_i @website = json_result_object['website'] @zagat_reviewed = json_result_object['zagat_reviewed'] @zagat_selected = json_result_object['zagat_selected'] @aspects = aspects_component(json_result_object['aspects']) @review_summary = json_result_object['review_summary'] @photos = photos_component(json_result_object['photos']) @reviews = reviews_component(json_result_object['reviews']) @nextpagetoken = json_result_object['nextpagetoken'] end |
Instance Attribute Details
#address_components ⇒ Object
Returns the value of attribute address_components.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def address_components @address_components end |
#aspects ⇒ Object
Returns the value of attribute aspects.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def aspects @aspects end |
#cid ⇒ Object
Returns the value of attribute cid.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def cid @cid end |
#city ⇒ Object
Returns the value of attribute city.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def city @city end |
#country ⇒ Object
Returns the value of attribute country.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def country @country end |
#formatted_address ⇒ Object
Returns the value of attribute formatted_address.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def formatted_address @formatted_address end |
#formatted_phone_number ⇒ Object
Returns the value of attribute formatted_phone_number.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def formatted_phone_number @formatted_phone_number end |
#icon ⇒ Object
Returns the value of attribute icon.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def icon @icon end |
#id ⇒ Object
Returns the value of attribute id.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def id @id end |
#international_phone_number ⇒ Object
Returns the value of attribute international_phone_number.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def international_phone_number @international_phone_number end |
#lat ⇒ Object
Returns the value of attribute lat.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def lat @lat end |
#lng ⇒ Object
Returns the value of attribute lng.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def lng @lng end |
#name ⇒ Object
Returns the value of attribute name.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def name @name end |
#nextpagetoken ⇒ Object
Returns the value of attribute nextpagetoken.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def nextpagetoken @nextpagetoken end |
#opening_hours ⇒ Object
Returns the value of attribute opening_hours.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def opening_hours @opening_hours end |
#photos ⇒ Object
Returns the value of attribute photos.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def photos @photos end |
#postal_code ⇒ Object
Returns the value of attribute postal_code.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def postal_code @postal_code end |
#price_level ⇒ Object
Returns the value of attribute price_level.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def price_level @price_level end |
#rating ⇒ Object
Returns the value of attribute rating.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def @rating end |
#reference ⇒ Object
Returns the value of attribute reference.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def reference @reference end |
#region ⇒ Object
Returns the value of attribute region.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def region @region end |
#review_summary ⇒ Object
Returns the value of attribute review_summary.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def review_summary @review_summary end |
#reviews ⇒ Object
Returns the value of attribute reviews.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def reviews @reviews end |
#street ⇒ Object
Returns the value of attribute street.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def street @street end |
#street_number ⇒ Object
Returns the value of attribute street_number.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def street_number @street_number end |
#types ⇒ Object
Returns the value of attribute types.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def types @types end |
#url ⇒ Object
Returns the value of attribute url.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def url @url end |
#vicinity ⇒ Object
Returns the value of attribute vicinity.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def vicinity @vicinity end |
#website ⇒ Object
Returns the value of attribute website.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def website @website end |
#zagat_reviewed ⇒ Object
Returns the value of attribute zagat_reviewed.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def zagat_reviewed @zagat_reviewed end |
#zagat_selected ⇒ Object
Returns the value of attribute zagat_selected.
5 6 7 |
# File 'lib/google_places/spot.rb', line 5 def zagat_selected @zagat_selected end |
Class Method Details
.find(reference, api_key, sensor, options = {}) ⇒ Spot
Search for a Spot with a reference key
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/google_places/spot.rb', line 108 def self.find(reference, api_key, sensor, = {}) language = .delete(:language) = .delete(:retry_options) || {} extensions = .delete(:review_summary) ? 'review_summary' : nil response = Request.spot( :reference => reference, :sensor => sensor, :key => api_key, :language => language, :extensions => extensions, :retry_options => ) self.new(response['result']) end |
.list(lat, lng, api_key, sensor, options = {}) ⇒ Array<Spot>
Search for Spots at the provided location
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/google_places/spot.rb', line 53 def self.list(lat, lng, api_key, sensor, = {}) location = Location.new(lat, lng) multipage_request = !!.delete(:multipage) rankby = .delete(:rankby) radius = .delete(:radius) || 1000 if rankby.nil? types = .delete(:types) name = .delete(:name) keyword = .delete(:keyword) language = .delete(:language) exclude = .delete(:exclude) || [] = .delete(:retry_options) || {} zagat_selected = .delete(:zagat_selected) || false exclude = [exclude] unless exclude.is_a?(Array) = { :location => location.format, :radius => radius, :sensor => sensor, :rankby => rankby, :key => api_key, :name => name, :language => language, :keyword => keyword, :retry_options => } [:zagatselected] = zagat_selected if zagat_selected # Accept Types as a string or array if types types = (types.is_a?(Array) ? types.join('|') : types) .merge!(:types => types) end request(:spots, multipage_request, exclude, ) end |
.list_by_pagetoken(pagetoken, api_key, sensor, options = {}) ⇒ Array<Spot>
Search for Spots with a pagetoken
132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/google_places/spot.rb', line 132 def self.list_by_pagetoken(pagetoken, api_key, sensor, = {}) exclude = .delete(:exclude) || [] exclude = [exclude] unless exclude.is_a?(Array) = { :pagetoken => pagetoken, :sensor => sensor, :key => api_key } request(:spots_by_pagetoken, false, exclude, ) end |
.list_by_query(query, api_key, sensor, options = {}) ⇒ Array<Spot>
Search for Spots with a query
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/google_places/spot.rb', line 188 def self.list_by_query(query, api_key, sensor, = {}) if .has_key?(:lat) && .has_key?(:lng) with_location = true else with_location = false end if .has_key?(:radius) with_radius = true else with_radius = false end query = query sensor = sensor multipage_request = !!.delete(:multipage) location = Location.new(.delete(:lat), .delete(:lng)) if with_location radius = .delete(:radius) if with_radius rankby = .delete(:rankby) language = .delete(:language) types = .delete(:types) exclude = .delete(:exclude) || [] = .delete(:retry_options) || {} exclude = [exclude] unless exclude.is_a?(Array) = { :query => query, :sensor => sensor, :key => api_key, :rankby => rankby, :language => language, :retry_options => } [:location] = location.format if with_location [:radius] = radius if with_radius # Accept Types as a string or array if types types = (types.is_a?(Array) ? types.join('|') : types) .merge!(:types => types) end request(:spots_by_query, multipage_request, exclude, ) end |
.multi_pages_request(method, multipage_request, options) ⇒ Object
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/google_places/spot.rb', line 248 def self.multi_pages_request(method, multipage_request, ) begin response = Request.send(method, ) response['results'].each do |result| if !multipage_request && !response["next_page_token"].nil? && result == response['results'].last # add next page token on the last result result.merge!("nextpagetoken" => response["next_page_token"]) end yield(result) end # request the next page if presence of a "next_page" token next_page = false if multipage_request && !response["next_page_token"].nil? = { :pagetoken => response["next_page_token"], :key => [:key], :sensor => [:sensor] } # There is a short delay between when a next_page_token is issued, and when it will become valid. # If requested too early, it will result in InvalidRequestError. # See: https://developers.google.com/places/documentation/search#PlaceSearchPaging sleep(2) next_page = true end end while (next_page) end |
.request(method, multipage_request, exclude, options) ⇒ Object
235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/google_places/spot.rb', line 235 def self.request(method, multipage_request, exclude, ) results = [] self.multi_pages_request(method, multipage_request, ) do |result| # Some places returned by Google do not have a 'types' property. If the user specified 'types', then # this is a non-issue because those places will not be returned. However, if the user did not specify # 'types', then we do not want to filter out places with a missing 'types' property from the results set. results << self.new(result) if result['types'].nil? || (result['types'] & exclude) == [] end results end |
Instance Method Details
#[](key) ⇒ Object
315 316 317 |
# File 'lib/google_places/spot.rb', line 315 def [] (key) send(key) end |
#address_component(address_component_type, address_component_length) ⇒ Object
319 320 321 322 323 |
# File 'lib/google_places/spot.rb', line 319 def address_component(address_component_type, address_component_length) if component = address_components_of_type(address_component_type) component.first[address_component_length] unless component.first.nil? end end |
#address_components_of_type(type) ⇒ Object
325 326 327 |
# File 'lib/google_places/spot.rb', line 325 def address_components_of_type(type) @address_components.select{ |c| c['types'].include?(type.to_s) } unless @address_components.nil? end |
#aspects_component(json_aspects) ⇒ Object
345 346 347 |
# File 'lib/google_places/spot.rb', line 345 def aspects_component(json_aspects) json_aspects.to_a.map{ |r| { :type => r['type'], :rating => r['rating'] } } end |
#photos_component(json_photos) ⇒ Object
349 350 351 |
# File 'lib/google_places/spot.rb', line 349 def photos_component(json_photos) json_photos.to_a.map{ |r| { :width => r['width'], :height => r['height'], :width => r['width'], :photo_reference => r['photo_reference'], :html_attributions => r['html_attributions'] } } end |
#reviews_component(json_reviews) ⇒ Object
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/google_places/spot.rb', line 329 def reviews_component(json_reviews) if json_reviews json_reviews.map { |r| Review.new( r['aspects'].empty? ? nil : r['aspects'][0]['rating'], r['aspects'].empty? ? nil : r['aspects'][0]['type'], r['author_name'], r['author_url'], r['text'], r['time'].to_i ) } else [] end end |