tap-aftership

This is a Singer tap that produces JSON-formatted data following the Singer spec.

This tap:

• Pulls raw data from the [aftership API].

• Extracts the following resources:

  • Trackings

  • Couriers

  • CourierConnections

  • ItemReturns

  • ItemTags

  • QueryClaims

  • QueryCoverages

  • Stores

  • Orders

  • Products

  • Fulfillments

  • Memberships

  • Roles

  • ShippingRates

  • ShippingLabels

  • ShippingManifests

  • ShippingCouriers

  • CancelLabels

  • Pickups

  • CancelPickups

  • ShipperAccounts

  • Locations

• Outputs the schema for each resource

• Incrementally pulls data based on the input state

Streams

trackings

• Data Key = trackings
• Primary keys: id
• Replication strategy: INCREMENTAL

couriers

• Data Key = couriers
• Primary keys: ['slug']
• Replication strategy: FULL_TABLE

courier_connections

• Data Key = courier_connections
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

item_returns

• Data Key = returns
• Primary keys: ['id']
• Replication strategy: FULL_TABLE

item_tags

• Data Key = item_tags
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

query_claims

• Data Key = claims
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

query_coverages

• Data Key = coverages
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

stores

• Data Key = stores
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

orders

• Data Key = orders
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

products

• Data Key = products
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

fulfillments

• Primary keys: ['id']
• Replication strategy: INCREMENTAL

memberships

• Data Key = memberships
• Primary keys: ['id']
• Replication strategy: FULL_TABLE

roles

• Data Key = roles
• Primary keys: ['code']
• Replication strategy: FULL_TABLE

shipping_rates

• Data Key = rates
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

shipping_labels

• Data Key = labels
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

shipping_manifests

• Data Key = manifests
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

shipping_couriers

• Data Key = couriers
• Primary keys: ['slug']
• Replication strategy: FULL_TABLE

cancel_labels

• Data Key = cancel_labels
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

pickups

• Data Key = pickups
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

cancel_pickups

• Data Key = cancel_pickups
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

shipper_accounts

• Data Key = shipper_accounts
• Primary keys: ['id']
• Replication strategy: INCREMENTAL

locations

• Data Key = locations
• Primary keys: ['location_id']
• Replication strategy: FULL_TABLE

Authentication

Quick Start

1. Install

   Clone this repository, and then install using setup.py. We recommend using a virtualenv:

   > virtualenv -p python3 venv
   > source venv/bin/activate
   > python setup.py install
   OR
   > cd .../tap-aftership
   > pip install -e .

2. Dependent libraries. The following dependent libraries were installed.

   > pip install singer-python
   > pip install target-stitch
   > pip install target-json
   

   • singer-tools
   • target-stitch

3. Create your tap's config.json file. The tap config file for this tap should include these entries:

   • start_date - the default value to use if no bookmark exists for an endpoint (rfc3339 date string)
   • user_agent (string, optional): Process and email for API logging purposes. Example: tap-aftership <api_user_email@your_company.com>
   • request_timeout (integer, 300): Max time for which request should wait to get a response. Default request_timeout is 300 seconds.

   {
       "start_date": "2019-01-01T00:00:00Z",
       "user_agent": "tap-aftership <api_user_email@your_company.com>",
       "request_timeout": 300
   }
   

   Optionally, also create a state.json file. currently_syncing is an optional attribute used for identifying the last object to be synced in case the job is interrupted mid-stream. The next run would begin where the last job left off.

   {
       "currently_syncing": "dummy_stream1",
       "bookmarks": {
           "dummy_stream1": "2019-09-27T22:34:39.000000Z",
           "dummy_stream2": "2019-09-28T15:30:26.000000Z",
           "dummy_stream3": "2019-09-28T18:23:53Z"
       }
   }

4. Run the Tap in Discovery Mode This creates a catalog.json for selecting objects/fields to integrate:

   tap-aftership --config config.json --discover > catalog.json

   See the Singer docs on discovery mode here.

5. Run the Tap in Sync Mode (with catalog) and write out to state file

   For Sync mode:

   > tap-aftership --config tap_config.json --catalog catalog.json > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   To load to json files to verify outputs:

   > tap-aftership --config tap_config.json --catalog catalog.json | target-json > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   To pseudo-load to Stitch Import API with dry run:

   > tap-aftership --config tap_config.json --catalog catalog.json | target-stitch --config target_config.json --dry-run > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

6. Test the Tap While developing the aftership tap, the following utilities were run in accordance with Singer.io best practices: Pylint to improve code quality:

   > pylint tap_aftership -d missing-docstring -d logging-format-interpolation -d too-many-locals -d too-many-arguments

   Pylint test resulted in the following score:

   Your code has been rated at 9.67/10

   To check the tap and verify working:

   > tap_aftership --config tap_config.json --catalog catalog.json | singer-check-tap > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   Unit Tests

   Unit tests may be run with the following.

   python -m pytest --verbose
   

   Note, you may need to install test dependencies.

   pip install -e .'[dev]'
   

---

Copyright © 2019 Stitch