Skip to content

Latest commit

 

History

History
436 lines (346 loc) · 13.4 KB

README.rst

File metadata and controls

436 lines (346 loc) · 13.4 KB
Raw

DataONE Bookkeeper Service

Bookkeeper is a RESTful service that is part of the DataONE Coordinating Node infrastructure. It is used to manage products, customers, orders, and quotas related to the DataONE Plus and Hosted Repositories services. See the docs for more details.

Installation via Helm

The bookkeeper app is packaged as a Helm chart and can be deployed on a Kubernetes cluster with a release name of bookkeeper using helm. First, one manual step is to edit ./helm/config/bookkeeper.yml and set the proper database password. Then install via help with:

$ helm upgrade --install -n bookkeeper bookkeeper ./helm

Note that the helm install is not currently putting the database in place, and so some of the steps below need to be performed manually to get the database set up. These will all be migrated to helm with time.

Installation

  1. Download Bookkeeper and expand the archive
$ curl -LO "https://github.com/DataONEorg/bookkeeper/archive/master.zip" && \
  unzip master.zip
  1. Install PostgreSQL 9+. See the homebrew installation instructions.
$ brew install postgresql
# Configure PostgreSQL appropriately to connect (pg_hba.conf, etc.)
  1. Create a database and user
$ sudo su - postgres -c "createdb -O bookkeeper bookkeeper"
$ sudo su - postgres -c "createuser bookkeeper -P"
  1. Install FlywayDB

Flyway is used to manage the SQL database schema.

Note: Adjust the values in db/flyway.conf to your database and password
$ flyway migrate -configFiles=bookkeeper-master/src/main/resources/db

The database schema should be created, and you're ready to start the application.

  1. Compile and start bookkeeper
$ cd  bookkeeper-master && mvn package
$ java -jar target/bookkeeper-1.0-SNAPSHOT.jar server bookkeeper.yml

Getting Started

The following example uses bash and curl to demonstrate client connections.

Interacting with the service requires authentication for most REST method calls using a JSON Web Token. Log in at https://search.daataone.org to get a token (in My Profile > Settings > Authentication Token). All messages are transferred as JSON.

  1. Set your token
$ token="<paste-your-token-here>"
  1. Get a list of Products that can be ordered. The /products endpoint is one that doesn't require authentication so pricing pages can be built.
$ curl -H "Accept: application/json" "http://localhost:8080/bookkeeper/v1/products"

This returns a ProductList:

{
    "products": [
        {
            "id": 1,
            "object": "product",
            "active": true,
            "amount": 32000,
            "caption": "Faculty or research lab",
            "currency": "USD",
            "created": 1579898043,
            "description": "Create a customized portal for your work and projects.   Help others understand and access your data.",
            "interval": "year",
            "name": "Individual",
            "statementDescriptor": "DataONE Subscription Plan - Individual",
            "type": "service",
            "unitLabel": "membership",
            "url": "https://products.dataone.org/plus",
            "metadata": {
                "features": [
                    {
                        "name": "branded_portal",
                        "label": "Branded Portals",
                        "description": "Showcase your research, data, results, and usage metrics by building a custom web portal.",
                        "quota": {
                            "object": "quota",
                            "name": "portal",
                            "softLimit": "1",
                            "hardLimit": "1",
                            "unit": "portal"
                        }
                    },
                    {
                        "name": "custom_search_filters",
                        "label": "Custom Search Filters",
                        "description": "Create custom search filters in your portal to allow   scientists to search your holdings using filters appropriate to your field of science."
                    },
                    {
                        "name": "fair_data_assessment",
                        "label": "FAIR Data Assessments",
                        "description": "Access quality metric reports using the FAIR data suite of checks."
                    },
                    {
                        "name": "custom_quality_service",
                        "label": "Custom Quality Metrics",
                        "description": "Create a suite of custom quality metadata checks specific to your datasets."
                    },
                    {
                        "name": "aggregated_metrics",
                        "label": "Aggregated Metrics",
                        "description": "Access and share reports on aggregated usage metrics such as dataset views, data downloads, and dataset citations."
                    },
                    {
                        "name": "dataone_voting_member",
                        "label": "DataONE Voting Member",
                        "description": "Vote on the direction and priorities at DataONE Community meetings."
                    }
                ]
            }
        },
        ...
    ]
}
  1. Create a Customer with the given name, surname, and ORCID of the logged in user (saved as customer.json):
{
    "object": "customer",
    "givenName": "Christopher",
    "surName": "Jones",
    "email": "[email protected]",
    "subject": "http://orcid.org/0000-0002-8121-2343"
}

Then POST it to the /customers endpoint:

curl -X POST \
    -H "Authorization: Bearer ${token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d "@customer.json" \
    "http://localhost:8080/bookkeeper/v1/customers"

The customer object is returned with an id attribute which is used to create an Order.

{
    "id": 1,
    "object": "customer",
    "givenName": "Christopher",
    "surName": "Jones",
    "email": "[email protected]",
    "subject": "http://orcid.org/0000-0002-8121-2343"
}
  1. Create an Order (order.json), and update it as many times as needed. POST the order to the /orders endpoint, and PUT it to /orders/:id for updates.
{
    "object": "order",
    "customer": 1,
    "status": "created",
    "amount": 32000,
    "items": [{
        "object": "order_item",
        "type": "sku",
        "parent": 1,
        "quantity": 1
        }]
}

Then POST it to the /orders endpoint:

curl -X POST \
    -H "Authorization: Bearer ${token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d "@order.json" \
    "http://localhost:8080/bookkeeper/v1/orders"

This returns:

{
    "id": 1,
    "object": "order",
    "amount": 32000,
    "amountReturned": 0,
    "charge": {},
    "created": 1579986378,
    "customer": 1,
    "items": [
        {
            "object": "order_item",
            "amount": 32000,
            "currency": "USD",
            "description": "DataONE Subscription Plan - Individual",
            "parent": 1,
            "quantity": 1,
            "type": "sku"
        }
    ],
    "metadata": {},
    "status": "created",
    "statusTransitions": {},
    "updated": 0,
    "totalAmount": 32000
}
  1. Confirm the Order. Confirming currently sets a trial period rather than paying for the order. Payments will be added into this workflow later.
curl -X POST \
    -H "Authorization: Bearer ${token}" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    "http://localhost:8080/bookkeeper/v1/orders/1/pay"
  1. You have confirmed the order, and it is in the paid state. This returns:
{
    "id": 1,
    "object": "order",
    "amount": 32000,
    "amountReturned": 0,
    "charge": {},
    "created": 1579986378,
    "customer": 1,
    "items": [{
        "object": "order_item",
        "amount": 32000,
        "currency": "USD",
        "description": "DataONE Subscription Plan - Individual",
        "parent": 1,
        "quantity": 1,
        "type": "sku"
        }],
        "metadata": {},
        "status": "paid",
        "statusTransitions": {},
        "updated": 1579992719,
        "totalAmount": 32000
    }
}
  1. View your quotas. Once the order is paid, your quotas are set.
curl \
    -H "Authorization: Bearer ${token}" \
    -H "Accept: application/json" \
    "http://localhost:8080/bookkeeper/v1/quotas"

This returns a QuotaList:

{
    "quotas": [{
        "id": 4,
        "object": "quota",
        "name": "portal",
        "softLimit": 1.0,
        "hardLimit": 1.0,
        "usage": 0.0,
        "unit": "portal",
        "orderId": 1,
        "subject": "http://orcid.org/0000-0002-8121-2341"
    }]
}

Creating an object

Once quotas are established through an order, the quotas are enforced by participating repositories. The following diagram shows the sequence of calls made when a portal document is uploaded to a repository.

docs/images/create-portal.png