Server and algorithms implemented in JavaScript and node.js for harvesting and processing metadata from CSV, ISO.xml, Atom.xml and FGDC.xml sources and serving out metadata in ISO.xml, Atom.xml, JSON and GeoJSON formats.
MongoDB should be running at this point. Connnection to Mongo is set up in mongo-config.js.
Default is:
config = {dbHost: 'localhost', dbPort: '27071', dbName: 'cinergi'};
Note that this expects a database named 'cinergi'.
$ git clone https://github.com/usgin/mongo-metadata-server.git
$ cd mongo-metadata-server
SMR note 2018-08-28. Running Windows 10, had to install new vbBuild.exe, in power shell as admin:
npm install --global --production windows-build-tools
then
$ npm install
By default, the metadata server will run on localhost port 3000.
$ cd mongo-metadata-server
$ node server.js
By default, the tests will run on localhost port 3030. Run the tests with
mocha. Install mocha with npm install --global mocha (as admin) if necessary:
$ cd mongo-metadata-server
$ mocha test
Built on top of the expressjs web application framework. Have a look at the tests for actual code samples and example data.
Harvest csv, iso.xml, fgdc.xml or atom.xml documents into MongoDB. Raw harvest
documents get stored in the harvest collection and get stored in the record
collection after successfully passing through algorithms which standardize the
data according to our schema.
User story: I want to harvest one or more hosted metadata documents into MongoDB.
Request:
{
"inputFormat": "csv"|"iso.xml"|"fgdc.xml"|"atom.xml",
"recordUrl": "http://localhost:3030/path-to-document"
}
Response:
- 200 if harvested documents are successfully harvested, processed and stored in MongoDB.
- 500 for any kind of error.
Transform and return a single JSON metadata document derived from an XML document into our minimalistic vanilla internal JSON schema.
User story: I'm at the CINERGI meeting this week and want a proof-of-concept!
Request:
{
"data": "JSON string"
}
Response:
- 200 if document is successfully transformed, stored and returned.
- 500 for any kind of error.
Create a single, schema-compliant metadata document from a hosted JSON source.
The document will be stored in the record collection if it passes schema
validation.
User story: I have a single JSON metadata document that I want to store in MongoDB.
Request:
{
"url": 'http://localhost:3030/my-metadata-doc.json'
"json": true
}
Response:
- 200 if document passes schema validation and gets stored in MongoDB.
- 500 for any kind of error.
Return a JSON array of MongoDB ObjectIDs for every document in a collection.
User story: I want to know what documents are in my database.
Request:
resourceType: "record" or "harvest" (name of collection you wish to query)
Response:
- 200 if server successfully queries MongoDB and builds an array of ObjectIDs.
- 500 for any kind of error.
Return a single metadata document in JSON format from any collection in MongoDB.
User story: I want a single metadata document in the format that MongoDB stores the data.
Request:
resourceType: "record" or "harvest" (name of collection you wish to query)
resourceId: alphanumeric MongoDB ObjectId
Response:
- 200 if server successfully queries MongoDB and can return the document in JSON format.
- 500 for any kind of error.
Return a single metadata document from the record collection in a specific
output format. Output formats other than the default (JSON) which are
currently supported are ISO.xml, Atom.xml and GeoJSON.
User story: I harvested my data into the database as CSV, but now I want to access it as GeoJSON.
Request:
resourceId: alphanumeric MongoDB ObjectId and format (*.iso.xml|*.atom.xml|*.geojson)
Response:
- 200 if server successfully queries MongoDB, transforms and serializes the requested document.
- 500 for any kind of error.
Delete a single metadata document from a specified MongoDB collection.
User story: I want to delete one metadata document.
Resquest:
resourceType: "record" or "harvest" (name of collection you wish to query)
resourceId: alphanumeric MongoDB ObjectId
Response:
- 200 if server successfully queries MongoDB and deletes document.
- 500 for any kind of error.
Delete and entire MongoDB collection.
User story: I want to delete a collection of documents
Request:
resourceType: "record" or "harvest" (name of collection you wish to query)
Response:
- 200 if MongoDB collection is successfully deleted.
- 500 for any kind of error.