singer-io/tap-recharge

tap-recharge

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

This tap:

• Pulls raw data from the ReCharge Payments API
• Extracts the following resources:
  • Addresses
  • Charges
  • Collections
  • Customers
  • Discounts
  • Metafields for Store, Customers, Subscriptions
  • One-time Products
  • Orders
  • Products
  • Store
  • Subscriptions
• Outputs the schema for each resource
• Incrementally pulls data based on the input state

Streams

addresses

• Endpoint: https://api.rechargeapps.com/addresses
• Primary keys: id
• Foreign keys: customer_id (customers), discount_id (discounts)
• Replication strategy: Incremental (query filtered)
  • Bookmark query parameter: updated_at_min
  • Bookmark: updated_at (date-time)
• Transformations: None

charges

• Endpoint: https://api.rechargeapps.com/charges
• Primary keys: id
• Foreign keys: address_id (addresses), customer_id (customers), subscription_id (subscriptions), shopify_product_id, shopify_variant_id, transaction_id
• Replication strategy: Incremental (query filtered)
  • Bookmark query parameter: updated_at_min
  • Bookmark: updated_at (date-time)
• Transformations: None

collections

• Endpoint: https://api.rechargeapps.com/collections
• Primary keys: id
• Foreign keys: None
• Replication strategy: Incremental (query all, filter results)
  • Bookmark: updated_at (date-time)
• Transformations: None

customers

• Endpoint: https://api.rechargeapps.com/customers
• Primary keys: id
• Foreign keys: shopify_customer_id
• Replication strategy: Incremental (query filtered)
  • Bookmark query parameter: updated_at_min
  • Bookmark: updated_at (date-time)
• Transformations: None

discounts

• Endpoint: https://api.rechargeapps.com/discounts
• Primary keys: id
• Foreign keys: applies_to_id
• Replication strategy: Incremental (query filtered)
  • Bookmark query parameter: updated_at_min
  • Bookmark: updated_at (date-time)
• Transformations: None

metafields_customer

• Endpoint: https://api.rechargeapps.com/metafields
• Primary keys: id
• Foreign keys: owner_id
• Replication strategy: Incremental (query all, filter results)
  • Filter: owner_resource = customer
  • Bookmark: updated_at (date-time)
• Transformations: None

metafields_store

• Endpoint: https://api.rechargeapps.com/metafields
• Primary keys: id
• Foreign keys: owner_id
• Replication strategy: Incremental (query all, filter results)
  • Filter: owner_resource = store
  • Bookmark: updated_at (date-time)
• Transformations: None

metafields_subscription

• Endpoint: https://api.rechargeapps.com/metafields
• Primary keys: id
• Foreign keys: owner_id
• Replication strategy: Incremental (query all, filter results)
  • Filter: owner_resource = subscription
  • Bookmark: updated_at (date-time)
• Transformations: None

onetimes

• Endpoint: https://api.rechargeapps.com/onetimes
• Primary keys: id
• Foreign keys: address_id (addresses), customer_id (customers), recharge_product_id (products), shopify_product_id, shopify_variant_id
• Replication strategy: Incremental (query filtered)
  • Bookmark query parameter: updated_at_min
  • Bookmark: updated_at (date-time)
• Transformations: None

orders

• Endpoint: https://api.rechargeapps.com/orders
• Primary keys: id
• Foreign keys: address_id (addresses), charge_id (charges), customer_id (customers), subscription_id (subscriptions), shopify_product_id, shopify_variant_id, shopify_order_id, shopify_id, shopify_customer_id, transaction_id
• Replication strategy: Incremental (query filtered)
  • Bookmark query parameter: updated_at_min
  • Bookmark: updated_at (date-time)
• Transformations: None

products

• Endpoint: https://api.rechargeapps.com/products
• Primary keys: id
• Foreign keys: collection_id (collections), shopify_product_id
• Replication strategy: Incremental (query all, filter results)
  • Bookmark: updated_at (date-time)
• Transformations: None

store

• Endpoint: https://api.rechargeapps.com/store
• Primary keys: id
• Foreign keys: None
• Replication strategy: Full table
• Transformations: None

subscriptions

• Endpoint: https://api.rechargeapps.com/subscriptions
• Primary keys: id
• Foreign keys: address_id (addresses), customer_id (customers), recharge_product_id (products), shopify_product_id, shopify_variant_id
• Replication strategy: Incremental (query filtered)
  • Bookmark query parameter: updated_at_min
  • Bookmark: updated_at (date-time)
• Transformations: None

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-recharge
   > pip install .

2. Dependent libraries The following dependent libraries were installed.

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

   • singer-tools
   • target-stitch

3. Create your tap's config.json file which should look like the following:

   {
       "access_token": "YOUR_ACCESS_TOKEN",
       "start_date": "2019-01-01T00:00:00Z",
       "user_agent": "tap-recharge <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. The request_timeout is an optional parameter to set a timeout for requests. Default: 300 seconds

   {
       "currently_syncing": "users",
       "bookmarks": {
           "addresses": "2019-06-11T13:37:55Z",
           "charges": "2019-06-19T19:48:42Z",
           "collections": "2019-06-18T18:23:58Z",
           "customers": "2019-06-20T00:52:46Z",
           "discounts": "2019-06-19T19:48:44Z",
           "metafields_store": "2019-06-11T13:37:55Z",
           "metafields_customers": "2019-06-19T19:48:42Z",
           "metafields_subscriptions": "2019-06-18T18:23:58Z",
           "onetimes": "2019-06-20T00:52:46",
           "orders": "2019-06-19T19:48:44Z",
           "products": "2019-06-11T13:37:55Z",
           "subscriptions": "2019-06-18T18:23:58Z"
       }
   }

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

   tap-recharge --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-recharge --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-recharge --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-recharge --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 ReCharge tap, the following utilities were run in accordance with Singer.io best practices: Pylint to improve code quality:

   > pylint tap_recharge -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.78/10

   To check the tap and verify working:

   > tap-recharge --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

   Check tap resulted in the following:

   The output is valid.
   It contained 75 messages for 13 streams.
   
       13 schema messages
       24 record messages
       38 state messages
   
   Details by stream:
   +-------------------------+---------+---------+
   | stream                  | records | schemas |
   +-------------------------+---------+---------+
   | discounts               | 1       | 1       |
   | metafields_subscription | 0       | 1       |
   | addresses               | 4       | 1       |
   | store                   | 1       | 1       |
   | charges                 | 4       | 1       |
   | products                | 4       | 1       |
   | onetimes                | 0       | 1       |
   | orders                  | 4       | 1       |
   | collections             | 1       | 1       |
   | metafields_store        | 0       | 1       |
   | metafields_customer     | 0       | 1       |
   | subscriptions           | 4       | 1       |
   | customers               | 1       | 1       |
   +-------------------------+---------+---------+
   

---

Copyright © 2020 Stitch