Integrate subscriptions

[Jesus89]

Related to #1055, https://github.com/CartoDB/data-observatory/issues/144

We have a final proposal for the subscriptions (formerly purchases (formerly licenses)).

Explore subscriptions

API

Endpoint

GET /do/subscriptions

Params

• type: 'dataset' / 'geography' (optional)
• order: 'project' / 'dataset' / 'table' / 'id' / 'type' (optional)
• order_direction: 'asc' / 'desc' (optional)

Response

{
 "subscriptions": [
   {
     "project": "carto",
     "dataset": "bbva",
     "table": "financial_spain_2019",
     "id": "carto.bbva.financial_spain_2019",
     "type": "dataset"
   },
   ...
 ]
}

Library

subscriptions = Catalog().subscriptions(credentials)
subscriptions.datasets
subscriptions.geographies

Note: since we have an instance of the Catalog, maybe we can pass the credentials to the constructor subscriptions = Catalog(credentials).subscriptions()

Get subscription info

Endpoint

GET /do/subscription_info

Params

• id: string
• type: 'dataset' / 'geography'

Response

   {
     "id": "",
     "estimated_delivery_days": 0,
     "subscription_list_price": 0,
     "tos": "",
     "tos_link": "",
     "licenses": "",
     "licenses_link": "",
     "rights": ""
   }

Errors

• Wrong id
• Wrong type

Library

Dataset.get(id).subscription_info(credentials) ?
Geographies.get(id).subscription_info(credentials) ?

Note: these methods must use get_default_credentials if no credentials param is passed.

Subscribe

Endpoint

POST /do/subscriptions

Params

• id: string
• type: string

Response

{ ... }

Errors

• Wrong id
• Wrong type
• Already subscribed

Library

Dataset.get(id).subscribe(credentials) 
# /do/subscription_info -> Y/N -> /do/subscribe

Geographies.get(id).subscribe(credentials) 
# /do/subscription_info -> Y/N -> /do/subscribe

Note: these methods must use get_default_credentials if no credentials param is passed.

[Jesus89]

@cmongut do you have the texts and format of the subscription info and the license?

>>> Dataset.get('id').subscribe(credentials)
[ Subscription info ]
[ Do you want to continue ] (Y/N)
[ License info ]
[ Do you want to buy it ] (Y/N)
[ Final message (success, warning, error) ]