moov/metro2 repository overview

Project Documentation⁠ · API Endpoints⁠ · Community⁠ · Blog⁠

⁠moov-io/metro2

Moov's mission is to give developers an easy way to create and integrate bank processing into their own software products. Our open source projects are each focused on solving a single responsibility in financial services and designed around performance, scalability, and ease-of-use.

Metro2 implements a reader, writer, and validator for consumer credit history reports in an HTTP server and Go library. The HTTP server is available in a Docker image⁠ and the Go package github.com/moov-io/metro2 is available.

⁠Table of Contents

• Project Status
• Usage
  • Docker
  • Google Cloud
  • Data Persistence
• Learn About Metro 2
• Getting Help
• Supported and Tested Platforms
• Contributing
• Related Projects

⁠Project Status

Moov Metro2 is actively used in multiple production environments. Please star the project if you are interested in its progress. If you have layers above Metro2 to simplify tasks, perform business operations, or found bugs we would appreciate an issue or pull request. Thanks!

⁠Usage

The Metro2 project implements an HTTP server and Go library⁠ for creating and modifying files in Metro 2 format, which is used for consumer credit history reporting by U.S. credit bureaus.

⁠Docker

We publish a public Docker image moov/metro2⁠ on Docker Hub with each tagged release of Metro2. No configuration is required to serve on :8080. We also have Docker images for OpenShift⁠ published as quay.io/moov/metro2.

Pull & start the Docker image:

docker pull moov/metro2:latest
docker run -p 8080:8080 moov/metro2:latest

Upload a file and validate it:

curl -X POST --form "file=@./test/testdata/packed_file.json" http://localhost:8080/validator

valid file

Convert a file from JSON to raw Metro format:

curl -X POST --form "file=@./test/testdata/packed_file.json" --form "format=metro" http://localhost:8080/convert

0480HEADER                           555555555508202002051019990510199905101999YOUR BUSINESS NAME HERE                 LINE ONE OF YOUR ADDRESS LINE TWO OF YOUR ADDRESS LINE THERE OF YOUR ADDRESS                    1234567890
...

Convert a file from raw Metro format to JSON:

curl -X POST --form "file=@./test/testdata/packed_file.dat" --form "format=json" http://localhost:8080/convert

{"header": {"blockDescriptorWord": 370,"recordDescriptorWord": 366,"recordIdentifier": "HEADER","transUnionProgramIdentifier": "5555555555","activityDate": "2002-08-20T00:00:00Z", ...

⁠Google Cloud Run

To get started in a hosted environment you can deploy this project to the Google Cloud Platform.

From your Google Cloud dashboard⁠ create a new project and call it:

moov-metro2-demo

Enable the Container Registry⁠ API for your project and associate a billing account⁠ if needed. Then, open the Cloud Shell terminal and run the following Docker commands, substituting your unique project ID:

docker pull moov/metro2
docker tag moov/metro2 gcr.io/<PROJECT-ID>/metro2
docker push gcr.io/<PROJECT-ID>/metro2

Deploy the container to Cloud Run:

gcloud run deploy --image gcr.io/<PROJECT-ID>/metro2 --port 8080

Select your target platform to 1, service name to metro2, and region to the one closest to you (enable Google API service if a prompt appears). Upon a successful build you will be given a URL where the API has been deployed:

https://YOUR-METRO2-APP-URL.a.run.app

Now you can complete a health check:

curl https://YOUR-METRO2-APP-URL.a.run.app/health

You should get this response:

{"health":true}

⁠Data Persistence

By design, Metro2 does not persist (save) any data about the files or entry details created. The only storage occurs in memory of the process and upon restart Metro2 will have no files or data saved. Also, no in-memory encryption of the data is performed.

⁠Learn About Metro 2

• Intro to Metro 2⁠
• Metro 2 File Structure⁠

⁠Getting Help

⁠Supported and Tested Platforms

• 64-bit Linux (Ubuntu, Debian), macOS, and Windows

⁠Contributing

Yes please! Please review our Contributing guide⁠ and Code of Conduct⁠ to get started!

This project uses Go Modules⁠ and uses Go v1.14 or higher. See Golang's install instructions⁠ for help setting up Go. You can download the source code and we offer tagged and released versions⁠ as well. We highly recommend you use a tagged release for production.

⁠Releasing

To make a release of metro2 simply open a pull request with CHANGELOG.md and version.go updated with the next version number and details. You'll also need to push the tag (i.e. git push origin v1.0.0) to origin in order for CI to make the release.

⁠Testing

We maintain a comprehensive suite of unit tests and recommend table-driven testing when a particular function warrants several very similar test cases. To run all test files in the current directory, use go test. Current overall coverage can be found on Codecov⁠.

⁠Fuzzing

We currently run fuzzing over Metro2 in the form of a moov/metro2⁠ Docker image. You can read more⁠ or run the image and report crasher examples to [email protected]⁠. Thanks!

⁠Related Projects

As part of Moov's initiative to offer open source fintech infrastructure, we have a large collection of active projects you may find useful:

• Moov Watchman⁠ offers search functions over numerous trade sanction lists from the United States and European Union.

• Moov Fed⁠ implements utility services for searching the United States Federal Reserve System such as ABA routing numbers, financial institution name lookup, and FedACH and Fedwire routing information.

• Moov Wire⁠ implements an interface to write files for the Fedwire Funds Service, a real-time gross settlement funds transfer system operated by the United States Federal Reserve Banks.

• Moov ACH⁠ provides ACH file generation and parsing, supporting all Standard Entry Codes for the primary method of money movement throughout the United States.

• Moov Image Cash Letter⁠ implements Image Cash Letter (ICL) files used for Check21, X.9 or check truncation files for exchange and remote deposit in the U.S.

⁠License

Apache License 2.0 - See LICENSE⁠ for details.