node-wdw-services

Note: This project is no longer maintained and is presented as a time capsule of early Node.js development. The public-facing TouringPlans.com API is also deprecated and no longer maintained. I may explore building a newer take on this using the cubehouse/themeparks repository in the future with a modern-day stack.

A Node.js + express web application that provided data about Walt Disney World attractions via RESTful JSON endpoints.

Data was pulled dynamically from the TouringPlans.com API, which did not support JSONP, and caches it in a simple SQLite table.

This service provided a great (and fun) foundation for exploring JavaScript MVC frameworks, including AngularJS and Backbone.js.

If you don't plan on bootstrapping with server-side data via EJS views, you can place static HTML in the public folder, using index.html as an entry point.

Prerequisites

Node.js

npm

SQLite3

jasmine-node

Grunt

Running the web server

Before running, ensure that you have grunt and jasmine-node installed:

npm install -g grunt-cli jasmine-node

For the first run, clone this project, then:

$ cd node-wdw-services
$ npm install
$ grunt server

Use grunt server to run the app any time after. grunt server will restart the web server each time it detects a file change; use Ctrl-C to stop.

NOTE: If you have previously cloned this repository, be sure to remove app.db before running grunt server.

Endpoints

GET: /locations - lists the type of locations in Walt Disney World.

[
  {
    "permalink": "parks",
    "name": "Theme Parks"
  },
  {
    "permalink": "hotels",
    "name": "Hotels"
  },
  {
    "permalink": "dining",
    "name": "Dining"
  }
]

GET: /locations/parks - lists the Theme Parks available.

{
  "location": {
    "permalink": "parks",
    "name": "Theme Parks"
  },
  "parks": [
    {
      "permalink": "magic-kingdom",
      "name": "Magic Kingdom"
    },
    {
      "permalink": "epcot",
      "name": "Epcot"
    },
    {
      "permalink": "hollywood-studios",
      "name": "Disney's Hollywood Studios"
    },
    {
      "permalink": "animal-kingdom",
      "name": "Disney's Animal Kingdom"
    }
  ]
}

Note: Hotels and Dining are not yet implemented.

GET: /locations/parks/:parkPermaLink - lists the attractions in a Theme Park.

{
  "park": {
    "permalink": "magic-kingdom",
    "name": "Magic Kingdom"
  },
  "attractions": [
    {
      "permalink": "ariels-grotto",
      "name": "Ariel's Grotto",
      "short_name": "Ariel's Grotto"
    },
    {
      "permalink": "astro-orbiter",
      "name": "Astro Orbiter",
      "short_name": "Astro Orbiter"
    }
  ]
}

GET: /locations/parks/:parkPermaLink/:attractionPermaLink - lists an attraction's details.

{
  "park": {
    "permalink": "magic-kingdom",
    "name": "Magic Kingdom"
  },
  "attraction": {
	...
    "name": "Ariel's Grotto",
    "scope_and_scale_code": "minor_attraction",
    "intense": false
	...
    "comments": [
      {
        "email": "example@example.com",
        "score": 5,
        "details": "this is a comment"
      }
    ]
  }
}

POST: /locations/parks/:parkPermaLink/:attractionPermaLink/comment - add a new comment on a specific attraction posting JSON data. Be sure to specify Content-Type: application/json in the HTTP header of your POST request.

{
    "email": "example@example.com",
    "score": 5,
    "details": "this is a comment"
}

GET: /locations/hotels - lists the Hotels available.

[
  [
    "Deluxe",
    [
      ...
      {
        "permalink": "disneys-contemporary-resort",
        "name": "Disney's Contemporary Resort"
      }
      ...
  ],
  [
    "Moderate",
    [
      {
        "permalink": "disneys-caribbean-beach-resort",
        "name": "Disney's Caribbean Beach Resort"
      }
      ...
    ]
  ],
  [
    "Value",
    [
      ...
      {
        "permalink": "disneys-pop-century-resort",
        "name": "Disney's Pop Century Resort"
      }
    ]
  ]
]

GET: /locations/parks/:hotelPermalink - lists a hotel's details.

{
  "water_sports": true,
  "permalink": "disneys-contemporary-resort",
  "num_rooms": 655,
  "name": "Disney's Contemporary Resort",
  "theme": "Future as perceived by past, present generations",
  "overall_rating": 4.5,
  "tennis": false,
  "room_rating": 93,
  "category_code": "deluxe",
  "room_service": true,
  ...
}

Running the tests

Jasmine spec tests are located in the spec folder. Tests require installing jasmine-node globally via NPM.

To run tests once jasmine-node is installed:

$ grunt

Note that there is no need to start the app before running the tests.