Mongoid Address Models

This repository is about the core data models used in the Theodolite and Distiller Open Addresses projects, part of the solution we deployed for the Alpha stage of our services. Learn more about Open Addresses in general here.

Addresses are made up of the following components:

• PAO (String)
• SAO (String)
• Street (An instance of Street)
• Locality (An instance of Locality)
• Town (An instance of Town)
• Postcode (An instance of Postcode)

Installation

In a Rails project

This Gem is packaged as a Rails engine, so you can use it in a Rails project by adding it to your Gemfile like so:

gem "mongoid_address_models", github: "OpenAddressesUK/mongoid_address_models"

And running bundle install

In a vanilla Ruby project

Add the gem to your Gemfile and bundle install as above, but made sure to require in your project:

require 'mongoid_address_models/require_all'

Licence

This code is open source under the MIT license. See the LICENSE.md file for full details.