/cloudco-insurance-catalog

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Cloud Insurance Co. - Catalog

master Build Status
dev Build Status

This service is part of the larger Cloud Insurance Co. project.

Overview

A Node.js app that serves as an API into the policy database for the Cloud Insurance Co.. To store the insurance policies, we use a Cloudant NoSQL DB and then utilize Watson Tradeoff Analytics to evaluate comparisons between the them.

In order to deploy the full set of microservices involved, check out the insurance-toolchain repo. Otherwise, you can deploy just the app by following the steps here.

Running the app on Bluemix

  1. If you do not already have a Bluemix account, sign up here

  2. Download and install the Cloud Foundry CLI tool

  3. Clone the app to your local environment from your terminal using the following command:

git clone https://github.com/IBM-Bluemix/insurance-catalog.git

  1. cd into this newly created directory

  2. Open the manifest.yml file and change the host value to something unique.

The host you choose will determinate the subdomain of your application's URL: <host>.mybluemix.net

  1. Connect to Bluemix in the command line tool and follow the prompts to log in
cf login -a https://api.ng.bluemix.net
  1. Create the Cloudant service in Bluemix
cf create-service cloudantNoSQLDB Lite insurance-policy-db
  1. Create the Tradeoff Analytics service in Bluemix
cf create-service tradeoff_analytics standard insurance-tradeoff-analytics
  1. Push the app to Bluemix
cf push

And voila! You now have your very own instance of the Insurance Catalog API running on Bluemix.

Run the app locally

  1. If you do not already have a Bluemix account, sign up here

  2. If you have not already, download Node.js and install it on your local machine.

  3. Clone the app to your local environment from your terminal using the following command:

git clone https://github.com/IBM-Bluemix/insurance-catalog.git

  1. cd into this newly created directory

  2. Create a Cloudant service named insurance-policy-db using your Bluemix account and replace the corresponding credentials in your vcap-local.json file - using vcap-local.template.json as template file.

  3. Create a Tradeoff Analytics service named insurance-tradeoff-analytics using your Bluemix account and replace the corresponding credentials in your vcap-local.json file

  4. Install the required npm packages using the following command

npm install
  1. Start your app locally with the following command
npm start

This command will start your Node.js web server and print the address where it is listening to requests in the console: server starting on http://localhost:6034.

API documentation

POST /tradeoff: Takes input criteria for a prospective trip and returns eligible policies and their Tradeoff Analytics results.

params
tripDuration* (int) - The length of the trip in days
tripCost* (int) - The estimated cost of the trip
addTravelers (int[ ]) - Age of each additional traveler, not including policy owner
refund (int) - The percentage of policy eligible for a refund upon cancellation
reviews (int) - The average star rating that the policy has received from previous customers
policyCost (int) - The maximum amount that the user desires to spend on the policy

results
columns* (object[ ]) - Conditions used to evaluate the tradeoff between eligible policies
policies* (policy[ ]) - Policies deemed as the best options, ordered alphabetically by name
map (object) - The two-dimensional positioning of each option on the map polygon displayed by the Tradeoff Analytics visualization.

Note: Asterisks ( * ) mark required field

Insurance Policies

The insurance-catalog app serves as the API to the Cloud Insurance Co. repository of insurance policies. When the app is initialized it checks for the existence of a policies DB in the Cloudant datastore. If it does not exist, it creates the DB and populates it with the initial policy docs from the routes/starter_docs/policies.json file. Subsequently, policies in the DB can be manipulated through the API.

Policy Fields

name: Policy short name
desc: Longer description of the policy
baseCost: Cost of the policy at the minimum number of days and without additional travelers
perAddTraveler*: Percentage increase to the base policy per additional traveler
cancelRefund: The percentage of the policy cost refunded upon cancellation before the start of the trip
minDays: The minimum number of days for a trip to qualify
perAddDay*: Percentage increase to the base policy per additional day after the minimum number of days
levelCare: Tier of care provided by the policy
amount: Multiplier to determine coverage amount relative to policy cost
review: Average star rating given to the policy by previous customers

* Cost compounded on each addition

Note: When updating the default policies in routes/db.js, make sure to delete the policies DB before the app is re-deployed so that the new policies are uploaded.

Contribute

If you find a bug, please report it via the Issues section or even better, fork the project and submit a pull request with your fix! We are more than happy to accept external contributions to this project if they address something noted in an existing issue. In order to be considered, pull requests must pass the initial Travis CI build and/or add substantial value to the sample application.

Troubleshooting

The primary source of debugging information for your Bluemix app is the logs. To see them, run the following command using the Cloud Foundry CLI:

$ cf logs insurance-catalog --recent

For more detailed information on troubleshooting your application, see the Troubleshooting section in the Bluemix documentation.

License

See License.txt for license information.

Privacy Notice

This application is configured to track deployments to IBM Bluemix and other Cloud Foundry platforms. The following information is sent to a Deployment Tracker service on each deployment:

  • Node.js package version
  • Node.js repository URL
  • Application Name (application_name)
  • Space ID (space_id)
  • Application Version (application_version)
  • Application URIs (application_uris)
  • Labels of bound services
  • Number of instances for each bound service and associated plan information

This data is collected from the package.json file in the application and the VCAP_APPLICATION and VCAP_SERVICES environment variables in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked.

Disabling Deployment Tracking

Deployment tracking can be disabled by removing require("cf-deployment-tracker-client").track(); from the beginning of the app.js file.