Module: Foursquare2::Venues
- Included in:
- Client
- Defined in:
- lib/foursquare2/venues.rb
Instance Method Summary collapse
-
#add_venue(options = {}) ⇒ Object
Add a venue.
-
#edit_venue(venue_id, options = {}) ⇒ Object
Make changes to a venue.
-
#explore_venues(options = {}) ⇒ Object
Explore venues.
-
#flag_venue(venue_id, options = {}) ⇒ Object
Flag a venue as having a problem.
-
#herenow(venue_id, options = {}) ⇒ Object
Returns a list of users that are currently checked into a venue.
-
#managed_venue_stats(venue_id, options = {}) ⇒ Object
Get venue stats over a given time range.
-
#managed_venues(options = {}) ⇒ Object
Returns a list of venues managed.
-
#mark_venue_todo(venue_id, options = {}) ⇒ Object
Mark a venue as todo for the authenticated user.
-
#propose_venue_edit(venue_id, options = {}) ⇒ Object
Propose a venue edit.
-
#search_venues(options = {}) ⇒ Object
Search for venues.
-
#search_venues_by_tip(options = {}) ⇒ Object
Search for venues by tip.
-
#suggest_completion_venues(options = {}) ⇒ Object
Suggest venue completions.
-
#trending_venues(ll, options = {}) ⇒ Object
Search for trending venues.
-
#venue(venue_id, options = {}) ⇒ Object
Retrieve information about a venue.
-
#venue_categories(options = {}) ⇒ Object
Retrieve information about all venue categories.
-
#venue_events(venue_id, options = {}) ⇒ Object
Get the events currently taking place at a venue.
-
#venue_hours(venue_id, options = {}) ⇒ Object
Get venue hours information.
-
#venue_likes(venue_id, options = {}) ⇒ Object
Returns friends and a total count of users who have liked this venue.
-
#venue_links(venue_id, options = {}) ⇒ Object
Retrieve links for a venue.
-
#venue_listed(venue_id, options = {}) ⇒ Object
Returns the lists that this venue appears on.
-
#venue_menus(venue_id, options = {}) ⇒ Object
Retrieve menus for a venue.
-
#venue_nextvenues(venue_id, options = {}) ⇒ Object
Returns venues that people often check in to after the current venue.
-
#venue_similar(venue_id, options = {}) ⇒ Object
Returns a list of venues similar to the specified venue.
-
#venues_timeseries(options = {}) ⇒ Object
Get daily venue stats for a list of venues over a time range.
Instance Method Details
#add_venue(options = {}) ⇒ Object
Add a venue
98 99 100 101 102 103 |
# File 'lib/foursquare2/venues.rb', line 98 def add_venue(={}) response = connection.post do |req| req.url "venues/add", end return_error_or_body(response, response.body.response.venue) end |
#edit_venue(venue_id, options = {}) ⇒ Object
Make changes to a venue
169 170 171 172 173 174 175 |
# File 'lib/foursquare2/venues.rb', line 169 def edit_venue(venue_id, ={}) response = connection.post do |req| req.body = req.url "venues/#{venue_id}/proposeedit" end return_error_or_body(response, response.body.response) end |
#explore_venues(options = {}) ⇒ Object
Explore venues
191 192 193 194 195 196 |
# File 'lib/foursquare2/venues.rb', line 191 def explore_venues(={}) response = connection.get do |req| req.url "venues/explore", end return_error_or_body(response, response.body.response) end |
#flag_venue(venue_id, options = {}) ⇒ Object
Flag a venue as having a problem
124 125 126 127 128 129 |
# File 'lib/foursquare2/venues.rb', line 124 def flag_venue(venue_id, ={}) response = connection.post do |req| req.url "venues/#{venue_id}/flag", end return_error_or_body(response, response.body.response) end |
#herenow(venue_id, options = {}) ⇒ Object
Returns a list of users that are currently checked into a venue
param [String] venue_id The ID of the venue managed by the current user
234 235 236 237 238 239 |
# File 'lib/foursquare2/venues.rb', line 234 def herenow(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/herenow", end return_error_or_body(response, response.body.response) end |
#managed_venue_stats(venue_id, options = {}) ⇒ Object
Get venue stats over a given time range. Client instance should represent an OAuth user who is the venue owner. Note: returns more detailed statistics than the basic stats returned when calling venue(venue_id)
param [String] venue_id The ID of the venue managed by the current user
260 261 262 263 264 265 |
# File 'lib/foursquare2/venues.rb', line 260 def managed_venue_stats(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/stats", end return_error_or_body(response, response.body.response) end |
#managed_venues(options = {}) ⇒ Object
Returns a list of venues managed
245 246 247 248 249 250 |
# File 'lib/foursquare2/venues.rb', line 245 def managed_venues(={}) response = connection.get do |req| req.url "venues/managed", end return_error_or_body(response, response.body.response.venues) end |
#mark_venue_todo(venue_id, options = {}) ⇒ Object
Mark a venue as todo for the authenticated user
111 112 113 114 115 116 |
# File 'lib/foursquare2/venues.rb', line 111 def mark_venue_todo(venue_id, ={}) response = connection.post do |req| req.url "venues/#{venue_id}/marktodo", end return_error_or_body(response, response.body.response) end |
#propose_venue_edit(venue_id, options = {}) ⇒ Object
Propose a venue edit
144 145 146 147 148 149 |
# File 'lib/foursquare2/venues.rb', line 144 def propose_venue_edit(venue_id, ={}) response = connection.post do |req| req.url "venues/#{venue_id}/proposeedit", end return_error_or_body(response, response.body.response) end |
#search_venues(options = {}) ⇒ Object
Search for venues
26 27 28 29 30 31 |
# File 'lib/foursquare2/venues.rb', line 26 def search_venues(={}) response = connection.get do |req| req.url "venues/search", end return_error_or_body(response, response.body.response) end |
#search_venues_by_tip(options = {}) ⇒ Object
Search for venues by tip
57 58 59 60 61 62 63 64 |
# File 'lib/foursquare2/venues.rb', line 57 def search_venues_by_tip(={}) tips = search_tips() venues = [] tips.each do |tip| venues << tip['venue'] end venues end |
#suggest_completion_venues(options = {}) ⇒ Object
Suggest venue completions. Returns a list of mini-venues partially matching the search term, near the location.
208 209 210 211 212 213 |
# File 'lib/foursquare2/venues.rb', line 208 def suggest_completion_venues(={}) response = connection.get do |req| req.url "venues/suggestCompletion", end return_error_or_body(response, response.body.response) end |
#trending_venues(ll, options = {}) ⇒ Object
Search for trending venues
40 41 42 43 44 45 46 |
# File 'lib/foursquare2/venues.rb', line 40 def trending_venues(ll, ={}) [:ll] = ll response = connection.get do |req| req.url "venues/trending", end return_error_or_body(response, response.body.response) end |
#venue(venue_id, options = {}) ⇒ Object
Retrieve information about a venue
param [String] venue_id The ID of the venue
8 9 10 11 12 13 |
# File 'lib/foursquare2/venues.rb', line 8 def venue(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}", end return_error_or_body(response, response.body.response.venue) end |
#venue_categories(options = {}) ⇒ Object
Retrieve information about all venue categories.
68 69 70 71 72 73 |
# File 'lib/foursquare2/venues.rb', line 68 def venue_categories(={}) response = connection.get do |req| req.url "venues/categories", end return_error_or_body(response, response.body.response.categories) end |
#venue_events(venue_id, options = {}) ⇒ Object
Get the events currently taking place at a venue.
param [String] venue_id The ID of the venue
299 300 301 302 303 304 |
# File 'lib/foursquare2/venues.rb', line 299 def venue_events(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/events", end return_error_or_body(response, response.body.response) end |
#venue_hours(venue_id, options = {}) ⇒ Object
Get venue hours information.
param [String] venue_id The ID of the venue
288 289 290 291 292 293 |
# File 'lib/foursquare2/venues.rb', line 288 def venue_hours(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/hours", end return_error_or_body(response, response.body.response) end |
#venue_likes(venue_id, options = {}) ⇒ Object
Returns friends and a total count of users who have liked this venue.
param [String] venue_id The ID of the venue to get likes for
310 311 312 313 314 315 |
# File 'lib/foursquare2/venues.rb', line 310 def venue_likes(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/likes", end return_error_or_body(response, response.body.response) end |
#venue_links(venue_id, options = {}) ⇒ Object
Retrieve links for a venue.
param [String] venue_id The ID of the venue
79 80 81 82 83 84 |
# File 'lib/foursquare2/venues.rb', line 79 def venue_links(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/links", end return_error_or_body(response, response.body.response.links) end |
#venue_listed(venue_id, options = {}) ⇒ Object
Returns the lists that this venue appears on.
param [String] venue_id ID of a venue to get lists for.
324 325 326 327 328 329 |
# File 'lib/foursquare2/venues.rb', line 324 def venue_listed(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/listed", end return_error_or_body(response, response.body.response) end |
#venue_menus(venue_id, options = {}) ⇒ Object
Retrieve menus for a venue.
param [String] venue_id The ID of the venue
219 220 221 222 223 224 |
# File 'lib/foursquare2/venues.rb', line 219 def (venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/menu", end return_error_or_body(response, response.body.response) end |
#venue_nextvenues(venue_id, options = {}) ⇒ Object
Returns venues that people often check in to after the current venue. Up to 5 venues are returned in each query, and results are sorted by how many people have visited that venue after the current one. Homes are never returned in results.
param [String] venue_id Required. ID of the venue you want to see next venue information about
335 336 337 338 339 340 |
# File 'lib/foursquare2/venues.rb', line 335 def venue_nextvenues(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/nextvenues", end return_error_or_body(response, response.body.response) end |
#venue_similar(venue_id, options = {}) ⇒ Object
Returns a list of venues similar to the specified venue.
param [String] venue_id The venue you want similar venues for.
346 347 348 349 350 351 |
# File 'lib/foursquare2/venues.rb', line 346 def venue_similar(venue_id, ={}) response = connection.get do |req| req.url "venues/#{venue_id}/similar", end return_error_or_body(response, response.body.response) end |
#venues_timeseries(options = {}) ⇒ Object
Get daily venue stats for a list of venues over a time range. Client instance should represent an OAuth user who is the venues owner.
276 277 278 279 280 281 282 |
# File 'lib/foursquare2/venues.rb', line 276 def venues_timeseries(={}) [:venueId] = [:venueId].join(',') # Transforms the array into a 'comma-separated list' of ids. response = connection.get do |req| req.url "venues/timeseries", end return_error_or_body(response, response.body.response) end |