Skip to main content

Directory Layout

The backend code is located in the vets-api repo. The majority of the code can be found in the /modules/mobile/ directory. The module is laid out much like the root of a standard rails project, for instance, it has app/controllers and app/models directories. With that knowledge, you can usually navigate to the code you want fairly easily.

Controllers Directory​

/modules/mobile/app/controllers

Versioning of controllers happens when there is an incompatibility with schema changes from upstream. This does not include new fields additions.

Models Directory​

/modules/mobile/app/models

The models directory contains several specific types of classes.

Standard Models​

Even though ActiveRecord is not in use, there are files here that still define the representations of data.

Adapters​

Adapters are used whenever we need to massage data from one schema to another. For instance, if we're upgrading to a new upstream endpoint and the data from the new endpoint changed names and/or is in a different format, we use adapters so that the new data is backwards compatible.

Contracts​

Used for validating params in controllers

Policies​

/modules/mobile/app/policies

Authorization policies used to verify access to routes and resources

Serializers​

/modules/mobile/app/serializers

Definitions of how different models should be serialized. These all conform to the JSON API standard.

Services​

/modules/mobile/app/services

Objects used for communicating with upstream service objects. These can be a mixture of services we've written directly, or proxy objects we've written that communicate with other teams' objects. Usually objects here inherit from Common::Client::Base or are related to configuration for such objects.

Workers​

/modules/mobile/app/workers

View information about vackground workers

Helpers​

/modules/mobile/app/helpers

Not traditional rails helpers because this is a pure api without views. These are just POROs. Some do make requests to upstream services and, as such, are indistinguishable from our proxies

Testing​

The various paths for testing are as follows

# Specs
/modules/mobile/spec/

# VCR Cassettes
/spec/support/vcr_cassettes/mobile/

Docs​

/modules/mobile/docs

Misc​

Lib​

/modules/mobile/lib

Traditionally, lib contains code that is not specific to the rails app. our contains:

  • Validation errors classes
  • Engines
  • Scripts

Config​

/modules/mobile/config

Standard rails config, such as routes

DB​

/modules/mobile/db

Data migrations, though we seldom used because we rarely have db backed models