Iowa DOT

Fetching data from Iowa DOT with Airbyte and Python.

Description

This Airbyte Connector uses the HTTP API provided by the Iowa DOT in Python. With this connector, data is easily pulled from Iowa DOT and loaded into the ViaWarn Postgres database, and are available in the ViaWarn app.

The connector is built on top of the Airbyte open-source platform, which provides a standardized way of integrating data sources and destinations. It is designed to be simple and easy to use. The required configuration is show in the the sections below.

The pulled resources from the IA 511 API are the following:

Requirements and Installation

Find the requirements and steps to create the connector in the Airbyte documentation.

Customized files

After creating the Airbyte connector template, modify the next files to retrieve data from Iowa DOT .

spec.yaml

Location: source-viawarn-us-ia-dot/spec.yaml

Access API: FREE
In this case, no password is required.

spec.yaml:

				
					documentationUrl: https://data.iowadot.gov/search?q=511&type=feature%20service
connectionSpecification:
  $schema: http://json-schema.org/draft-07/schema#
  title: VIAWARN US IA DOT - Spec
  type: object

config.json

Location: secrets/config.json

This file is ignore by git.

The config file holds an empty directory because this API is FREE and does not require any other parameter.

config.json:

{}

configure_catalog.json

Location: integration_tests/configure_catalog.json

List of Streams that describes the data in the data store that a Source represents. It also declares the sync modes supported by each stream (full refresh or incremental).

configure_catalog.json:

Replace [STREAM_NAME] and replicate the object for each stream.

				
					{ 
"streams": 
    [
    {
        "stream": {
            "name": [STREAM_NAME],
            "json_schema": {},
            "supported_sync_modes": ["full_refresh"] 
            },
        "sync_mode": "full_refresh", "destination_sync_mode": "overwrite" 
        } 
    ]
}

source.py

Location: source-viawarn-us-ia-dot/source.py

class ViawarnUsIaDotStream()

Create a stream to represent the data that will be pull from the API. It contains all the common API functionalities:

next_page_token()

Pagination is not provided by this API.

return None

request_params()

return a None

parse_response()

It is a placeholder to store the request.response object and constructs the appropriate mapping object for each parsed element by each Stream class.

yields an empty dictionary.

class Event()

This method extends the ViawarnUsIaDotStream() method to specified unique behavior for this stream.

url_base

String

primary_key

Unique field required in the stream associate to each output record.

String

path()

subdomain and paramters to pass into the url

return a string

parse_response()

Definition of how a response is parsed.

Set a definition to: primary key and ewkt fields.

return an iterable containing each record in the response.

Create class Work() similar to Event()

class SourceViawarnUsIaDot()

check_connection()

Set up a test to verify the connection between the connector and the API. This test should return two variables: the first one is a boolean that indicates the status of the connection, while the second one shows a log message if the connection fails.

return True, None

streams()

Set up the stream in the source that will be parsed.

return List of streams

[STREAM_NAME].json

Location: source-viawarn-us-ia-dot/schemas/[STREAM_NAME].json

Declare schemas for each stream by adding json files. Each file is a JsonSchema describing the output from that stream.

Streams name: event, work

Resources

LANCER L'APPLI

Support

support@viawarn.com