steveoscar / ramble_map

RambleMap

Interactive map for visualizing international trends.

Author: Steven Olson

Live Version: http://www.ramblemap.com/

Overview

This application, built in Ruby on Rails, is designed to allow users to explore world-wide patterns and trends for exchange rate, expenses, and other datasets. It was built with long-term travelers and expats in mind, people who are interested in getting a bird's-eye view of a region's financial situation.

Internal datasets were built from World Bank and IEP data, while up-to-date and historical exchange rates are pulled from the OpenExchangeRates API. The mapping library is jVectorMap, which acts as a local JavaScript API. The Twitter API and Twitter-Omniauth allow for sign-in and tweeting of maps.

The application is deployed on Heroku with a Postgres database. Performance is increased through low and high-level caching, and a background rake task to fill the most popular API call caches nightly.

Main Application Page

Dependencies

To run this application locally, you would need to obtain API keys from OpenExchangeRates and Twitter.

Gem dependencies can be found in the Gemfile.

Setup

If you wish to download the project and set it up locally, run the following commands:

1. git clone https://github.com/SteveOscar/ramble_map.git
2. bundle
3. bundle exec figaro install - This sets up figaro on your local machine. You will need to obtain the keys mentioned in the above section and save them in your application.yml file.
4. rake db:setup to seed the db with countries and datasets

Test Suite

The application is tested with Minitest, using Capybara for feature tests, and VCR for API call stubbing. SimpleCov is used to provide basic test coverage results.

The test suite can be run from the main directory of the project by running the command rake test. The project has test coverage at the following levels: model, service, controller, and integration.

ramble_map's Issues

Add South American Functionality

Add missing PPP data

add contact info

Add North American Functionality

Add African Functionality

Add European Functionality

add support for Firefox browser

controller testing

rework expense range/colors

Add Asian Functionality

fill in missing african countries

optimize with caching

test data factory more

reports option after search

update expense hover wording

send tweet using ajax

View relative expense for any country

As a user,
I should be able to fill in the welcome form to view relative expenses with any country as a base country,
and the map should be different for each country

add peace rankings

View any currency's trend

As a user,
I can fill in the welcome form with any base country to see currency trends,
and the trends are different for each country

Integration testing

add integration testing for existing paths

add tweeting of map

View relative expenses to USD

As a user,
I can fill in the welcome form to view relative expenses with a United States base,
and I should see the data on the map.

Tokenize API

Twitter login

As a user,
I can login with twitter on the welcome screen

model tests

add model tests for existing methods

more info on country hover

custom search option

Add Oceana Functionality

refactor for n+1 and other DB calls

add omniauth login

add map keys

label data should change for diff years

right now, the data from the first year displayed always remains

Viewing USD currency change

As a user,
I can visit the welcome page and fill in the form for 1-yr currency change for the United States,
and I should see a map with the data

add happiness rankings