This application was created by Beth Secor, Steve Pentler, and Toni Rib for the Turing School of Software & Design.
TrafficSpy is an application that works similar to Google Analytics, tracking data for registered applications. The data from this applications is sent to our server using the curl command from the terminal (see below). The user can then view analytical data for a registered application via our website.
Clone the project by running the following command from the terminal:
git clone https://github.com/ToniRib/traffic-spy.git
Navigate into the project directory and run the command bundle.
Run the following commands to set up the database and the test database:
rake db:create
rake db:migrate
rake db:test:prepare
Applications are registered through the terminal using the curl command in the following format:
curl -i -d 'identifier=turing&rootUrl=http://turing.io' http://localhost:9393/sources
The identifier chosen will be used to reference that application through the site. If either the identifier or the rootUrl parameters are missing, an error will be thrown. In addition, an application can only be registered once.
In order to mimic data being sent to our server, you can again use the terminal curl command in the following format to send a payload:
curl -i -d 'payload={"url":"http://turing.io/blog","requestedAt":"2013-02-16 21:38:28 -0700","respondedIn":37,"referredBy":"http://turing.io","requestType":"GET","parameters":[],"eventName":"socialLogin","userAgent":"Mozilla/5.0 (Macintosh%3B Intel Mac OS X 10_8_2) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/24.0.1309.0 Safari/537.17","resolutionWidth":"1920","resolutionHeight":"1280","ip":"63.29.38.211"}' http://localhost:9393/sources/turing/data
Payloads can only be sent one time, but the entire contents of the payload must be identical in order for it to be rejected as a duplicate. Payloads cannot be sent to unregistered applications.
Once applications have been registered and payload data sent, the server is started by running the shotgun command from the terminal. The main application page can then be found by visiting http://localhost:9393/ in the browser of your choice.
The following are possible pages you can visit:
Located at: http://localhost:9393/sources
Has a list of all of the registered applications, each of which is a link to the corresponding applications details page.
Located at: http://localhost:9393/sources/APPIDENTIFIER
Displays the following information for an individual application:
- Most requested URLS to least requested URLS (url)
- Web browser breakdown across all requests (userAgent)
- OS breakdown across all requests (userAgent)
- Screen Resolution across all requests (resolutionWidth x resolutionHeight)
- Longest, average response time per URL to shortest, average response time per URL
- Hyperlinks of each url to view url specific data
- Hyperlink to view aggregate event data
Also includes a link to the event index page.
Located at: http://localhost:9393/sources/APPIDENTIFIER/urls/RELATIVEPATH
Displays the following information for an individual application and specific path:
- Longest response time (ms)
- Shortest response time (ms)
- Average response time (ms)
- HTTP verbs
- Most popular referrers
- Most popular operating systems
- Most popular browsers
Located at: http://localhost:9393/sources/APPIDENTIFIER/events
Has a list of all of the received events for a specific application, each of which is a link to the corresponding event details page.
Located at: http://localhost:9393/sources/APPIDENTIFIER/events/EVENTNAME
Displays the total number of requests for that event and an hour by hour breakdown of when the requests were received.
The test suite can be run from the terminal by running the command rake test from the project's base directory.
The following ruby gems are used in this project:
- sinatra
- pg
- activerecord
- sinatra-activerecord
- rake
- haml
- shotgun
- minitest
- tux
- capybara
- launchy
- rack-test
- database_cleaner
- json
- useragent
- uri