UMTS MicroservicesEngine

About

This is a gem / engine designed to provide simplistic inter-service communication between various UMTS (UMass Transportation Services) microservices. Not designed to be used in an independent environment outside of the UMTS office, but you are welcome to try.

See our RubyGems page here

Setup

Require the gem

In your Gemfile, add the following line

gem 'umts-microservices-engine'

Installing the gem

Once you add the gem to your Gemfile, you need to run this command in the directory of your Rails app

DISABLE_ROUTER_CHECKIN=true rails generate install microservices-engine

Prepending DISABLE_ROUTER_CHECKIN=true to your command allows you to execute any rails command when there isn't already a reachable instance of umts/microservices-router running.

This will generate two files, config/mse_router_info.yml and config/initializers/microservices_engine.rb.

Setting up the configuration

You need not worry about config/initializers/microservices_engine.rb, however you must edit config/mse_router_info.yml or your application will now fail to launch as the initializer requires data from this file.

# UMass Transit Microservices Engine
# Router API Data Endpoint Configuration

# REQUIRED field
# The name of the microservice
name: ''

# REQUIRED field
# The URI for the site hosting the microservice
# NOTE: Do not attach the /v1/data to this.
uri: ''

# REQUIRED field
# Verification token
security_token: ''

# REQUIRED Field
# Endpoint of Microservices router
router_uri: ''

# OPTIONAL field (leave blank if not applicable)
# The models that the service can give info on
accessible_models: []

• The name of your application can be anything you desire.
• The uri is the base link for the website this is being hosted on. For example, http://potatoes.com/. Do NOT attach the router's respective endpoint to this link. So do NOT do this: http://potatoes.com/v1/data/.
• The security_token is a local token that should be set to something extremely confidential. To change this, you must contact the administrator of the microservices-router portion so that they can modify your token. Once the token is set, there is no way to change it. Attempting to change it will cause an exception during setup.
• The router_uri is just the endpoint that the engine will send data to. Contact the router's administrator to find out this value.
• The accessible_models field is optional. In here you will put a list of strings corresponding to the "models" you want other engines to be able to access. This assumes you have an API endpoint / documentation for these models on your application.

Finish

You should now be able to run your server. If anything goes wrong, the console should alert you. To run your server without checking in with the router, run

$ DISABLE_ROUTER_CHECKIN=true rails server