Connecticut DOT
Fetching data from Connecticut DOT with Airbyte and Python.
Description
This Airbyte Connector uses the HTTP API provided by the Connecticut DOT in Python. With this connector, data is easily pulled from Connecticut 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 CT DOT API are the following:
Requirements and Installation
Customized files
After creating the Airbyte connector template, modify the next files to retrieve data from Connecticut DOT .
spec.yaml
In this case, the connector password is specified in the spec file.
documentationUrl: https://ctroads.org/developers/help
connectionSpecification:
$schema: http://json-schema.org/draft-07/schema#
title: VIAWARN USA CT DOT - Spec
type: object
required:
- developer_api_key
properties:
developer_api_key:
type: string
airbyte_secret: true
description: Developer API Key obtained from https://ctroads.org/developers/help
config.json
{
"developer_api_key":"[key]"
...
}
configure_catalog.json
{
"streams": [
{
"stream": {
"name": "event",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "rest",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "sign",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
}
]
}
source.py
Location: source-viawarn-us-ct-dot/source.py
class ViawarnUsCtDotStream()
- url_base
This field is the common part of the URL for all streams, if it does not exist, add it in each stream method.
String
- next_page_token()
Pagination is not provided by this API.
return None
- request_params()
Some streams do not require any parameter.
return an empty dictionary
- 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()
- primary_key
Unique field required in the stream associate to each output record.
String
- __init__()
This is a constructor method used to initialize the class in case the stream require parameters. It uses the ‘config’ object to define the ‘developer_api_key’ attribute.
return config[]
- next_page_token()
Pagination is not provided by this API.
return None
- path()
subdomain and parameters 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 classes Sign() and Rest() similar to Event()
class SourceViawarnUsCtDot()
- 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()
