straw-hat-labs / straw_hat_map

Map Information and Addresses Management

StrawHat.Map

Map and addresses management.

Configuration

Important

StrawHat.Map requires an Ecto repository with Geo.PostGIS.Extension extension enabled.

You need to create or extend your current PostgreSQL types:

Postgrex.Types.define(
  MyApp.PostgresTypes,
  [Geo.PostGIS.Extension] ++ Ecto.Adapters.Postgres.extensions()
)

Then make sure that you add the types to your repository connection.

# In your config files

config :my_app, MyApp.Repo,
  # ...
  types: MyApp.PostgresTypes

Use cases

All the APIs are contain in the business use cases are under Use Cases documentation section. Check the available modules and the public API.

You should be able to comprehend the API by reading the type spec and the function name. Please open an issue or even better make pull request about the documation if you have any issues with it.

Migrations

Since this library does not have any repository, it does not run any migration. You will need to handle the migrations on your application that contains the repository.

The migrations directory contains a series of migrations that should cover the common use cases.

Note

Each migration module has a Created at timestamp, this information is useful to decide when and the order on which the migrations should be run.

Using migrations

After creating an Ecto migration in your project you could call one of the migrations from your change callback in your module.

defmodule MyApp.Repo.Migrations.CreateCountriesTable do
  use Ecto.Migration

  def change do
    StrawHat.Map.Migrations.CreateCountriesTable.change()
  end
end

straw_hat_map's Issues

Add Postgres Extension for Geolocation of Location table

• Elixir Package: https://github.com/bryanjos/geo
• Elixir Package: https://github.com/bryanjos/geo_postgis
• Postgres Extension: http://postgis.net/

Preferiblemente que todo las respuestas sean GeoJSON: http://www.postgis.net/docs/ST_AsGeoJSON.html

Add Address completion

• It should allow to plug in search engines
• Add https://developers.google.com/maps/documentation/javascript/examples/places-searchbox compatibility

Fix scrievener

Do not use repo.pagination but instead, call Scrivener directly

   config = %Scrivener.Config{
        module: Scrivener.Ecto.Repo,
        page_number: 2,
        page_size: 4,
        options: [total_entries: 130]
      }
      page =
        Post
        |> Post.published
        |> Scrivener.paginate(config)

Future Features

Addresses

• Verify that each address is valid and complete.

• Convert addresses into proper USPS address format

• Geolocation returned for each valid address

• ZIP Code lookup

• Autocomplete address

• Extract address from texts

• https://smartystreets.com/products

• https://pe.usps.com/text/pub28/welcome.htm

• https://github.com/infinitered/ups

Data

We need to find a way to load the database in a clean way. Some people care about specific countries and others the full database.

We need to find a trustful source that this import becomes a single command.

https://github.com/mledoze/countries
https://timezonedb.com/download

Add World Map data

We need to find a way to load the database in a clean way. Some people care about specific countries and others the full database.

We need to find a trustful source that this import becomes a single command.

https://github.com/mledoze/countries
https://timezonedb.com/download

Validate postal code

• The postal code should be either numbers and/or letters
• Countries define the postal code matching expression. Example: ####-####

Check

• https://en.wikipedia.org/wiki/Postal_code

Validate Addresses

This is a really huge task for tackle right now. I will need support on this one because it's hard to know all the rules around it.

• Read https://pe.usps.com/text/pub28/welcome.htm
• Check https://github.com/infinitered/ups

Add timestamp() to Location

It is useful to know when the location was inserted and the last update.

• Add timestamps() to the migration
• Add timestamps() to Schema
• Add documentations for the schema keys