geoserver-node-client 0.0.6 → 1.1.0

package/src/workspace.js

@@ -1,4 +1,6 @@
 import fetch from 'node-fetch';
+import { getGeoServerResponseText, GeoServerResponseError } from './util/geoserver.js';
+import AboutClient from './about.js'
 
 /**
  * Client for GeoServer workspaces
@@ -9,64 +11,67 @@ export default class WorkspaceClient {
   /**
    * Creates a GeoServer REST WorkspaceClient instance.
    *
+   * WARNING: For most cases the 'NameSpaceClient' seems to fit better.
+   *
    * @param {String} url The URL of the GeoServer REST API endpoint
-   * @param {String} user The user for the GeoServer REST API
-   * @param {String} password The password for the GeoServer REST API
+   * @param {String} auth The Basic Authentication string
    */
-  constructor (url, user, password) {
-    this.url = url.endsWith('/') ? url : url + '/';
-    this.user = user;
-    this.password = password;
+  constructor (url, auth) {
+    this.url = url;
+    this.auth = auth;
   }
 
   /**
    * Returns all workspaces.
    *
-   * @returns {Object|Boolean} An Object describing the workspaces or 'false'
+   * @throws Error if request fails
+   *
+   * @returns {Object} An Object describing the workspaces
    */
   async getAll () {
-    try {
-      const auth =
-        Buffer.from(this.user + ':' + this.password).toString('base64');
-      const response = await fetch(this.url + 'workspaces.json', {
-        credentials: 'include',
-        method: 'GET',
-        headers: {
-          Authorization: 'Basic ' + auth
-        }
-      });
-      const json = await response.json();
-      return json;
-    } catch (error) {
-      return false;
+    const response = await fetch(this.url + 'workspaces.json', {
+      credentials: 'include',
+      method: 'GET',
+      headers: {
+        Authorization: this.auth
+      }
+    });
+    if (!response.ok) {
+      const geoServerResponse = await getGeoServerResponseText(response);
+      throw new GeoServerResponseError(null, geoServerResponse);
     }
+    return response.json();
   }
 
   /**
    * Returns a workspace.
    *
    * @param {String} name Name of the workspace
-   * @returns {Object|Boolean} An object describing the workspaces or 'false'
+   *
+   * @throws Error if request fails
+   *
+   * @returns {Object} An object describing the workspaces
    */
   async get (name) {
-    try {
-      const auth =
-        Buffer.from(this.user + ':' + this.password).toString('base64');
-      const response = await fetch(this.url + 'workspaces/' + name + '.json', {
-        credentials: 'include',
-        method: 'GET',
-        headers: {
-          Authorization: 'Basic ' + auth
-        }
-      });
-      if (response.status === 200) {
-        return await response.json();
+    const response = await fetch(this.url + 'workspaces/' + name + '.json', {
+      credentials: 'include',
+      method: 'GET',
+      headers: {
+        Authorization: this.auth
+      }
+    });
+    if (!response.ok) {
+      const grc = new AboutClient(this.url, this.auth);
+      if (await grc.exists()) {
+        // GeoServer exists, but requested item does not exist,  we return empty
+        return;
       } else {
-        return false;
+        // There was a general problem with GeoServer
+        const geoServerResponse = await getGeoServerResponseText(response);
+        throw new GeoServerResponseError(null, geoServerResponse);
       }
-    } catch (error) {
-      return false;
     }
+    return response.json();
   }
 
   /**
@@ -74,38 +79,38 @@ export default class WorkspaceClient {
    *
    * @param {String} name Name of the new workspace
    *
-   * @returns {String|Boolean} The name of the created workspace or 'false'
+   * @throws Error if request fails
+   *
+   * @returns {String} The name of the created workspace
    */
   async create (name) {
-    try {
-      const body = {
-        workspace: {
-          name: name
-        }
-      };
-
-      const auth =
-        Buffer.from(this.user + ':' + this.password).toString('base64');
+    const body = {
+      workspace: {
+        name: name
+      }
+    };
 
-      const response = await fetch(this.url + 'workspaces', {
-        credentials: 'include',
-        method: 'POST',
-        headers: {
-          Authorization: 'Basic ' + auth,
-          'Content-Type': 'application/json'
-        },
-        body: JSON.stringify(body)
-      });
+    const response = await fetch(this.url + 'workspaces', {
+      credentials: 'include',
+      method: 'POST',
+      headers: {
+        Authorization: this.auth,
+        'Content-Type': 'application/json'
+      },
+      body: JSON.stringify(body)
+    });
 
-      if (response.status === 201) {
-        const responseText = await response.text();
-        return responseText;
-      } else {
-        return false;
+    if (!response.ok) {
+      const geoServerResponse = await getGeoServerResponseText(response);
+      switch (response.status) {
+        case 409:
+          throw new GeoServerResponseError('Unable to add workspace as it already exists', geoServerResponse);
+        default:
+          throw new GeoServerResponseError(null, geoServerResponse);
       }
-    } catch (error) {
-      return false;
     }
+
+    return response.text();
   }
 
   /**
@@ -114,28 +119,31 @@ export default class WorkspaceClient {
    * @param {String} name Name of the workspace to delete
    * @param {Boolean} recurse Flag to enable recursive deletion
    *
-   * @returns {Boolean} If Deletion was successful
+   * @throws Error if request fails
    */
   async delete (name, recurse) {
-    try {
-      const auth =
-        Buffer.from(this.user + ':' + this.password).toString('base64');
-      const response = await fetch(this.url + 'workspaces/' + name + '?recurse=' + recurse, {
-        credentials: 'include',
-        method: 'DELETE',
-        headers: {
-          Authorization: 'Basic ' + auth
-        }
-      });
+    const response = await fetch(this.url + 'workspaces/' + name + '?recurse=' + recurse, {
+      credentials: 'include',
+      method: 'DELETE',
+      headers: {
+        Authorization: this.auth
+      }
+    });
 
-      // TODO map other HTTP status
-      if (response.status === 200) {
-        return true;
-      } else {
-        return false;
+    if (!response.ok) {
+      const geoServerResponse = await getGeoServerResponseText(response);
+      switch (response.status) {
+        case 400:
+          // the docs say code 403, but apparently it is code 400
+          // https://docs.geoserver.org/latest/en/api/#1.0.0/workspaces.yaml
+          throw new GeoServerResponseError(
+            'Workspace or related Namespace is not empty (and recurse not true)',
+            geoServerResponse);
+        case 404:
+          throw new GeoServerResponseError('Workspace doesn\'t exist', geoServerResponse);
+        default:
+          throw new GeoServerResponseError(null, geoServerResponse);
       }
-    } catch (error) {
-      return false;
     }
   }
 }

package/.eslintrc.json

@@ -1,20 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "es6": true
-    },
-    "extends": [
-        "standard"
-    ],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parserOptions": {
-        "ecmaVersion": 11,
-        "sourceType": "module"
-    },
-    "rules": {
-      "semi": "off"
-    }
-}

package/.github/workflows/ci-geoserver-node-client.yml

@@ -1,54 +0,0 @@
-name: ci-geoserver-node-client
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-jobs:
-  run-tests-maintenance:
-    runs-on: ubuntu-latest
-    env:
-      GEOSERVER_VERSION: 2.19.3
-    steps:
-      - uses: actions/checkout@v2
-
-      # In this step, this action saves a list of existing images,
-      # the cache is created without them in the post run.
-      # It also restores the cache if it exists.
-      - uses: satackey/action-docker-layer-caching@v0.0.11
-      # Ignore the failure of a step and avoid terminating the job.
-        continue-on-error: true
-
-      - run: docker run -d -p 8080:8080 meggsimum/geoserver:${GEOSERVER_VERSION}
-      # finishes when tomcat of GeoServer is running
-      - run: .github/workflows/wait-for.sh "localhost:8080"
-      # we use wget to ensure that GeoServer is running
-      - run: wget http://localhost:8080/geoserver/web
-
-      - run: npm install
-      - run: npm run test
-  
-  run-tests-stable:
-    runs-on: ubuntu-latest
-    env:
-      GEOSERVER_VERSION: 2.20.1
-    steps:
-      - uses: actions/checkout@v2
-
-      # In this step, this action saves a list of existing images,
-      # the cache is created without them in the post run.
-      # It also restores the cache if it exists.
-      - uses: satackey/action-docker-layer-caching@v0.0.11
-      # Ignore the failure of a step and avoid terminating the job.
-        continue-on-error: true
-
-      - run: docker run -d -p 8080:8080 meggsimum/geoserver:${GEOSERVER_VERSION}
-      # finishes when tomcat of GeoServer is running
-      - run: .github/workflows/wait-for.sh "localhost:8080"
-      # we use wget to ensure that GeoServer is running
-      - run: wget http://localhost:8080/geoserver/web
-
-      - run: npm install
-      - run: npm run test

package/.github/workflows/ci-publish-docs.yml

@@ -1,24 +0,0 @@
-name: publish-docs
-on:
-  push:
-    branches:
-      - master
-jobs:
-  build-and-publish-docs:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2.3.1
-
-      - name: Install and Build
-        run: |
-          npm install
-          npm run docs
-          # prevents Jekyll defaults by GitHub
-          touch out/.nojekyll
-
-      - name: Publish docs
-        uses: JamesIves/github-pages-deploy-action@4.0.0
-        with:
-          branch: gh-pages # The branch the action should deploy to.
-          folder: out # The folder the action should deploy.

package/.github/workflows/wait-for.sh

@@ -1,145 +0,0 @@
-#!/bin/sh
-
-# The MIT License (MIT)
-#
-# Copyright (c) 2017 Eficode Oy
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-set -- "$@" -- "$TIMEOUT" "$QUIET" "$HOST" "$PORT" "$result"
-TIMEOUT=15
-QUIET=0
-
-echoerr() {
-  if [ "$QUIET" -ne 1 ]; then printf "%s\n" "$*" 1>&2; fi
-}
-
-usage() {
-  exitcode="$1"
-  cat << USAGE >&2
-Usage:
-  $cmdname host:port [-t timeout] [-- command args]
-  -q | --quiet                        Do not output any status messages
-  -t TIMEOUT | --timeout=timeout      Timeout in seconds, zero for no timeout
-  -- COMMAND ARGS                     Execute command with args after the test finishes
-USAGE
-  exit "$exitcode"
-}
-
-wait_for() {
- if ! command -v nc >/dev/null; then
-    echoerr 'nc command is missing!'
-    exit 1
-  fi
-
-  while :; do
-    nc -z "$HOST" "$PORT" > /dev/null 2>&1
-
-    result=$?
-    if [ $result -eq 0 ] ; then
-      if [ $# -gt 6 ] ; then
-        for result in $(seq $(($# - 6))); do
-          result=$1
-          shift
-          set -- "$@" "$result"
-        done
-
-        TIMEOUT=$2 QUIET=$3 HOST=$4 PORT=$5 result=$6
-        shift 6
-        exec "$@"
-      fi
-      exit 0
-    fi
-
-    if [ "$TIMEOUT" -le 0 ]; then
-      break
-    fi
-    TIMEOUT=$((TIMEOUT - 1))
-
-    sleep 1
-  done
-  echo "Operation timed out" >&2
-  exit 1
-}
-
-while :; do
-  case "$1" in
-    *:* )
-    HOST=$(printf "%s\n" "$1"| cut -d : -f 1)
-    PORT=$(printf "%s\n" "$1"| cut -d : -f 2)
-    shift 1
-    ;;
-    -q | --quiet)
-    QUIET=1
-    shift 1
-    ;;
-    -q-*)
-    QUIET=0
-    echoerr "Unknown option: $1"
-    usage 1
-    ;;
-    -q*)
-    QUIET=1
-    result=$1
-    shift 1
-    set -- -"${result#-q}" "$@"
-    ;;
-    -t | --timeout)
-    TIMEOUT="$2"
-    shift 2
-    ;;
-    -t*)
-    TIMEOUT="${1#-t}"
-    shift 1
-    ;;
-    --timeout=*)
-    TIMEOUT="${1#*=}"
-    shift 1
-    ;;
-    --)
-    shift
-    break
-    ;;
-    --help)
-    usage 0
-    ;;
-    -*)
-    QUIET=0
-    echoerr "Unknown option: $1"
-    usage 1
-    ;;
-    *)
-    QUIET=0
-    echoerr "Unknown argument: $1"
-    usage 1
-    ;;
-  esac
-done
-
-if ! [ "$TIMEOUT" -ge 0 ] 2>/dev/null; then
-  echoerr "Error: invalid timeout '$TIMEOUT'"
-  usage 3
-fi
-
-if [ "$HOST" = "" -o "$PORT" = "" ]; then
-  echoerr "Error: you need to provide a host and port to test."
-  usage 2
-fi
-
-wait_for "$@"

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-    "eslint.enable": false
-}

package/DOCS_HOME.md

@@ -1,26 +0,0 @@
-# GeoServer Node Client
-
-Node.js / JavaScript Client for the [GeoServer REST API](https://docs.geoserver.org/stable/en/user/rest/).
-
-**CAUTION: This is highly bleeding edge, heavily under development and therefore breaking changes can be made at every time!**
-
-### Meta information
-
-Compatible with [GeoServer](https://geoserver.org)
-
-  - v2.20.x
-  - v2.19.x
-  - v2.18.x (no more maintained and officially deprecated)
-  - v2.17.x (no more maintained and officially deprecated)
-
-### Who do I talk to? ###
-
-* meggsimum (Christian Mayer) - info __at## meggsimum ~~dot** de
-
-### Credits
-
-This project was initiated by [meggsimum](https://meggsimum.de) within the [mFund](https://www.bmvi.de/EN/Topics/Digital-Matters/mFund/mFund.html) research project [SAUBER](https://sauber-projekt.de/).
-<p><img src="https://sauber-projekt.de/wp-content/uploads/2018/12/SAG_SAUBER_Logo_Dez3_transparent-1-e1543843688935.png" alt="SAUBER Logo" width="200"/></p>.
-
-<img src="https://sauber-projekt.de/wp-content/uploads/2018/12/mfund-logo-download-e1547545420815-300x77.jpg" alt="mFund Logo" width="300"/>
-<img src="https://sauber-projekt.de/wp-content/uploads/2019/06/BMVI_Fz_2017_Office_Farbe_de_Bundestag-400x402.png" alt="BMVI Logo" height="200"/>