Retruco-API

HTTP API to bring out shared positions from argumented statements

Retruco is a software fostering argumentative discussion around statements and allowing to bring out shared positions.

Retruco means immediate, precise and firm response in spanish.

More informations

Installation

For the first time only:

npm install

Create the database

su - postgres
createuser -D -P -R -S retruco
  Enter password for new role: retruco
  Enter it again: retruco
createdb -E utf-8 -O retruco retruco
psql retruco
  CREATE EXTENSION IF NOT EXISTS pg_trgm;
  \q

Configure the API server

npm run configure

Launch the API server

npm run start

Launch the daemon that handles pending actions

In another terminal:

npm run process-votes

API

To explore Retruco API, open sample Swagger UI and explore http://localhost:3000/swagger.json.

API usage

API usage for users

Create a user

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --data-binary @- "http://localhost:3000/users"
{
  "name": "Alice",
  "urlName": "alice",
  "email": "[email protected]",
  "password": "secret"
}
EOF

Login to retrieve user API key

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --data-binary @- "http://localhost:3000/login"
{
  "userName": "alice",
  "password": "secret"
}
EOF

Returns:

{
  "apiVersion": "1",
  "data": {
    "apiKey": "HoIw4IqGwymIeP+xRK2MUg",
    "createdAt": "2016-05-03T21:28:34.447Z",
    "name": "Alice",
    "urlName": "alice"
  }
}

Retrieve the API key in field data.apiKey of the response.

API usage for statements

Create statements belonging to this user

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" --data-binary @- "http://localhost:3000/statements"
{
  "type": "PlainStatement",
  "language": "fr",
  "name": "Il faut ouvrir le code source des logiciels du secteur public"
}
EOF

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" --data-binary @- "http://localhost:3000/statements"
{
  "type": "PlainStatement",
  "language": "fr",
  "name": "Ouvrir le code source est préférable à ouvrir les algorithmes"
}
EOF

List all statements

curl --header "Accept: application/json" "http://localhost:3000/statements"

Returns:

{
  "apiVersion": "1",
  "data": [
    {
      "createdAt": "2016-05-05T17:32:23.143Z",
      "id": "1630eafd-e387-44bf-abbb-70c5bf9fdfc8",
      "language": "fr",
      "name": "Il est plus pratique de diffuser le code source que de le communiquer au cas par cas aux citoyens qui en font la demande",
      "type": "PlainStatement"
    },
    {
    {
      "createdAt": "2016-05-03T21:42:48.226Z",
      "id": "c671c17e-a272-4a6a-9bc1-2b82db7c7499",
      "language": "fr",
      "name": "Ouvrir le code source est préférable à ouvrir les algorithmes",
      "type": "PlainStatement"
    },
    {
      "createdAt": "2016-05-03T21:31:18.124Z",
      "id": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
      "language": "fr",
      "name": "Il faut ouvrir le code source des logiciels du secteur public",
      "type": "PlainStatement"
    }
  ]
}

Get a specific statement

curl --header "Accept: application/json" "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979"

Returns:

{
  "apiVersion": "1",
  "data": {
    "createdAt": "2016-05-03T21:31:18.124Z",
    "id": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
    "language": "fr",
    "name": "Il faut ouvrir le code source des logiciels du secteur public",
    "authorName": "alice"
  }
}

Rate a statement

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" --data-binary @- "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/rating"
{
  "rating": 1
}
EOF

Returns:

{
  "apiVersion": "1",
  "data": {
    "rating": 1,
    "statementId": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
    "updatedAt": "2016-05-03T21:33:34.282Z",
    "voterName": "alice"
  }
}

Get an existing statement rating

curl --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/rating"

Returns:

{
  "apiVersion": "1",
  "data": {
    "rating": 1,
    "statementId": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
    "updatedAt": "2016-05-03T21:33:34.282Z",
    "voterName": "alice"
  }
}

Delete an exiting statement rating

curl -X DELETE --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/rating"

Returns:

{
  "apiVersion": "1",
  "data": {
    "rating": 1,
    "statementId": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
    "updatedAt": "2016-05-03T21:33:34.282Z",
    "voterName": "alice"
  }
}

Get a non-existing statement rating

curl --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/rating"

Returns:

{
  "apiVersion": "1",
  "data": {
    "statementId": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
    "voterName": "alice"
  }
}

Delete a non-exiting statement rating

curl -X DELETE --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/rating"

Returns:

{
  "apiVersion": "1",
  "data": {
    "statementId": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
    "voterName": "alice"
  }
}

API usage for arguments

Get a specific argument

curl --header "Accept: application/json" "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/arguments/c671c17e-a272-4a6a-9bc1-2b82db7c7499"

Returns:

{
  "apiVersion": "1",
  "data": {
    "claimId": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
    "createdAt": "2016-05-05T17:41:10.863Z",
    "groundId": "c671c17e-a272-4a6a-9bc1-2b82db7c7499",
    "id": "0d872e6d-6760-442f-aefa-82a0c06f104d",
    "type": "Argument"
  }
}

Rate an argument

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" --data-binary @- "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/arguments/c671c17e-a272-4a6a-9bc1-2b82db7c7499/rating"
{
  "rating": 1
}
EOF

Returns:

{
  "apiVersion": "1",
  "data": {
    "rating": 1,
    "statementId": "0d872e6d-6760-442f-aefa-82a0c06f104d",
    "updatedAt": "2016-05-05T17:43:05.322Z",
    "voterName": "alice"
  }
}

Get the now rated argument

curl --header "Accept: application/json" "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/arguments/c671c17e-a272-4a6a-9bc1-2b82db7c7499"

Returns:

{
  "apiVersion": "1",
  "data": {
    "claimId": "82d4e0ac-c234-45eb-8ba2-02d4d6a41979",
    "createdAt": "2016-05-05T17:41:10.863Z",
    "groundId": "c671c17e-a272-4a6a-9bc1-2b82db7c7499",
    "id": "0d872e6d-6760-442f-aefa-82a0c06f104d",
    "rating": 1,
    "ratingCount": 1,
    "ratingSum": 1,
    "type": "Argument"
  }
}

Rate an argument and its ground statement

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" --data-binary @- "http://localhost:3000/statements/82d4e0ac-c234-45eb-8ba2-02d4d6a41979/arguments/1630eafd-e387-44bf-abbb-70c5bf9fdfc8/rating"
{
  "rating": 1
}
EOF

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" --data-binary @- "http://localhost:3000/statements/1630eafd-e387-44bf-abbb-70c5bf9fdfc8/rating"
{
  "rating": 1
}
EOF

API usage for abuses

Get a specific abuse

curl --header "Accept: application/json" "http://localhost:3000/statements/1630eafd-e387-44bf-abbb-70c5bf9fdfc8/abuse"

Returns:

{
  "apiVersion": "1",
  "data": {
    "createdAt": "2016-05-05T18:51:58.488Z",
    "id": "d342c445-d12e-40b2-81d9-c2b7939fc732",
    "statementId": "1630eafd-e387-44bf-abbb-70c5bf9fdfc8",
    "type": "Abuse"
  }
}

Rate an abuse

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" --data-binary @- "http://localhost:3000/statements/1630eafd-e387-44bf-abbb-70c5bf9fdfc8/abuse/rating"
{
  "rating": 1
}
EOF

Returns:

{
  "apiVersion": "1",
  "data": {
    "rating": 1,
    "statementId": "d342c445-d12e-40b2-81d9-c2b7939fc732",
    "updatedAt": "2016-05-05T18:55:49.961Z",
    "voterName": "alice"
  }
}

Delete an abuse rating

curl -X DELETE --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" "http://localhost:3000/statements/1630eafd-e387-44bf-abbb-70c5bf9fdfc8/abuse/rating"

API usage for tags

Get a specific tag of a statement

curl --header "Accept: application/json" "http://localhost:3000/statements/1630eafd-e387-44bf-abbb-70c5bf9fdfc8/tags/logiciel_libre"

Returns:

{
  "apiVersion": "1",
  "data": {
    "createdAt": "2016-05-05T22:46:54.069Z",
    "id": "dd3fd0ad-206e-495f-be47-3d4952f44a8d",
    "name": "logiciel_libre",
    "statementId": "1630eafd-e387-44bf-abbb-70c5bf9fdfc8",
    "type": "Tag"
  }
}

Rate a tag of a statement

cat <<'EOF' | curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" --header "Retruco-API-Key: HoIw4IqGwymIeP+xRK2MUg" --data-binary @- "http://localhost:3000/statements/1630eafd-e387-44bf-abbb-70c5bf9fdfc8/tags/logiciel_libre/rating"
{
  "rating": 1
}
EOF

Returns:

{
  "apiVersion": "1",
  "data": {
    "rating": 1,
    "statementId": "dd3fd0ad-206e-495f-be47-3d4952f44a8d",
    "updatedAt": "2016-05-05T22:48:58.320Z",
    "voterName": "alice"
  }
}

List the tags of a statement

curl --header "Accept: application/json" "http://localhost:3000/statements/1630eafd-e387-44bf-abbb-70c5bf9fdfc8/tags"

Returns:

{
  "apiVersion": "1",
  "data": [
    {
      "createdAt": "2016-05-05T22:46:54.069Z",
      "id": "dd3fd0ad-206e-495f-be47-3d4952f44a8d",
      "name": "logiciel_libre",
      "rating": 1,
      "ratingCount": 1,
      "ratingSum": 1,
      "statementId": "1630eafd-e387-44bf-abbb-70c5bf9fdfc8",
      "type": "Tag"
    }
  ]
}

Name		Name	Last commit message	Last commit date
Latest commit History 244 Commits
config		config
email-templates		email-templates
forever		forever
scripts		scripts
src		src
.babelrc		.babelrc
.eslintrc		.eslintrc
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE.md		LICENSE.md
README.md		README.md
configure.js		configure.js
index.js		index.js
package.json		package.json
process-actions.js		process-actions.js
regenerate-text-search.js		regenerate-text-search.js

License

codeforeurope/retruco-api

Folders and files

Latest commit

History

Repository files navigation

Retruco-API

More informations

Installation

Create the database

Configure the API server

Launch the API server

Launch the daemon that handles pending actions

API

API usage

API usage for users

Create a user

Login to retrieve user API key

API usage for statements

Create statements belonging to this user

List all statements

Get a specific statement

Rate a statement

Get an existing statement rating

Delete an exiting statement rating

Get a non-existing statement rating

Delete a non-exiting statement rating

API usage for arguments

Get a specific argument

Rate an argument

Get the now rated argument

Rate an argument and its ground statement

API usage for abuses

Get a specific abuse

Rate an abuse

Delete an abuse rating

API usage for tags

Get a specific tag of a statement

Rate a tag of a statement

List the tags of a statement

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages