{"id":28121081,"url":"https://github.com/edwindj/cspa_rest","last_synced_at":"2026-01-23T06:20:07.123Z","repository":{"id":17006470,"uuid":"19769744","full_name":"edwindj/cspa_rest","owner":"edwindj","description":"Designing a REST interface for CSPA command line services","archived":false,"fork":false,"pushed_at":"2016-03-03T09:28:13.000Z","size":566,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-14T07:51:25.640Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edwindj.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-14T07:03:24.000Z","updated_at":"2018-02-12T12:41:39.000Z","dependencies_parsed_at":"2022-07-26T12:17:30.225Z","dependency_job_id":null,"html_url":"https://github.com/edwindj/cspa_rest","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/edwindj/cspa_rest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwindj%2Fcspa_rest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwindj%2Fcspa_rest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwindj%2Fcspa_rest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwindj%2Fcspa_rest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edwindj","download_url":"https://codeload.github.com/edwindj/cspa_rest/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwindj%2Fcspa_rest/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28682259,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-14T07:42:13.372Z","updated_at":"2026-01-23T06:20:07.069Z","avatar_url":"https://github.com/edwindj.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Designing a REST interface for CSPA command line services\nThis repo contains two services for the common statistical processing architecture.\n\n- Linear Rule Checking (LRC), for checking records for validity\n- Linear Error Localization (LEL), for finding erronuous values in records, given a set of restrictions.\n\nBoth services can be run as command-line tools (CLI) or via a Web API- REST interface. \n\nA generic REST interface for CSPA services is described in [proposal_rest_interface.pdf](./doc/proposal_rest_interface.pdf). Both services implement the proposed interface.\n\n## To install\n\nThere are (at least) three options for installing the services:\n\n- By running a prebuild [docker](http://docker.io)  image (edwindj/cspa-rest).\n- By downloading the repo and installing software on Windows or Linux\n- By using [Vagrant](https://www.vagrantup.com/), which will create an Ubuntu virtualbox VM. \n\n\n### Docker\n- install [docker](http://docker.io)\n- Run\n```\n$ sudo docker run -d -p8080:8080 edwindj/cspa-rest\n```\nThis will start a docker container with both services running that exposes port 8080 to the OS.\nThe docker image is automatically build from the `vagrant/Dockerfile`.\n\n### Complete install\n(for ubuntu 14.04 you can also use [vagrant/bootstrap.sh](install/vagrant/bootstrap.sh) to do the install)\n\n- Install **R** and run\n```S\nR -e \"install.packages('docopt','editrules', 'jsonlite','rspa')\"\n```\nThis will install R packages on which the services depend.\nThe command-line interface should work after this installation.\n\nFor the REST interface:\n- install **[node.js](http://nodejs.org)** and **npm**, see (http://nodejs.org)\n- download this [repo](http://github.com/edwindj/cspa_rest/archive/master.zip)\n- Then goto the \"cspa_rest/\" directory and run\n\n```\n$ npm install\n```\n\nThis will install nodejs dependencies for cspa_rest. (The dependencies are given in file \"./packages.json\")\n\n\n- Run the server:\n\n```\n$ npm start\n```\nor (on Ubuntu)\n```\n$ nodejs server.js\n```\n### Vagrant\nAlternatively you can install a VM image that contains all the software and a running CSPA service that can be tested on `localhost:8080`. \n\nTo install you will need to install [vagrant](http://www.vagrantup.com/) and [virtualbox](https://www.virtualbox.org/).\n\n```\n$ cd vagrant\n$ vagrant up\n```\n\nTo test the service run:\n```\n$ ./LRC/example/post.sh\n```\n\n\n# Testing the service\n\n- Start service\n- Goto [LRC/example](LRC/example) (or [LEL/example](LEL/example), or [LEC/example](LEL/example))\n- execute `post.sh`, this will `POST`  the `job.json` file and create a job (`id = 0`) in the service\n- http://localhost:8080/LRC/job will show a list of current jobs\n- http://localhost:8080/LRC/job/{id} will show job information\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedwindj%2Fcspa_rest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedwindj%2Fcspa_rest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedwindj%2Fcspa_rest/lists"}