/seethecity-server

SeetheCity Server is a Ruby on Rails backend for a city tour guide demo application that showcases the use of the Twitter public API, GNIP and Fabric.
  1. Ruby 98.8%
  2. HTML 1.2%
Ruby HTML

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP
Find file
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
lib
public
test
vendor/assets
.DS_Store
.gitignore
.sample.env
Gemfile
Gemfile.lock
LICENSE
Procfile
README.md
Rakefile
config.ru
screenshot.png

README.md

SeetheCity Server

SeetheCity Server is a Ruby on Rails backend for the demo SeetheCity iOS tour guide app. It uses Twitter's public APIs to calculate tweet volumes to determine popular city attractions. The GNIP Audience API is used to analyze an attraction's Twitter followers to determine a set of audience interests.

Getting Started

  1. Create a Twitter App

  2. Clone the repository:

     git clone [email protected]:twitterdev/seethecity-server.git

  3. Install Rails

     gem install rails

  4. Download and run PostgreSQL from http://postgresapp.com/ or http://www.postgresql.org/download/macosx/

  5. Run the self-setup script:

     cd seethecity-server
 ./bin/setup

  6. Run rake secret and add the secret to .env

  7. Add your Twitter API credentials to .env

  8. Start the server

     rails s

  9. Verify that the app is up and running.

API Endpoints

GET /api/cities

Returns a list of supported cities.

Parameters

None

Response

Field Type Description
id String City ID
name String City Name

GET /api/cities/:city_id/ranked_attractions

Returns a list of the top 10 city attractions, ranked by attraction tweet mentions volume over the past 7 days.

Parameters

Field Type Description
city_id String City ID

Response

Field Type Description
id string Attraction ID
name string Attraction name
handle string Attraction handle
centroid_lat number Attraction centroid latitude coordinate
centroid_long number Attraction centroid longitude coordinate
tweets_count number Number of tweets mentioning the attraction over the past 7 days

GET /api/attractions/:attraction_id/daily_tweet_count

Returns the number of attraction tweet mentions for each day of the week.

Parameters

Field Type Description
attraction_id String Attraction ID

Response

Field Type Description
tweets_count string Number of tweets mentioning the attraction on each day of the week
day_of_week string Day of the week

GET /api/attractions/:attraction_id/top_interests

Returns the top audience interests for an attraction.

Parameters

Field Type Description
attraction_id String Attraction ID

Response

Field Type Description
percentage number Percentage of the audience with the interest
interest string Interest name

License

Copyright 2016 Twitter, Inc.

Licensed under the Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0