resourceserver's Introduction

Resourceserver

TODO:

Add validation
Add pre/post hooks

Implements an in-memory (or persistent via redis) resource oriented HTTP server, provding 5 basic operations (shown in curl_tests.sh). Edit redis connection config in config.coffee.

POST /:collection

Create a new resource.

curl -vX POST http://localhost:3002/people \
  -H 'content-type: application/json' -d '{"name": "Liam", "age": 29}'

{
  "name": "Liam",
  "age": 29,
  "id": 2
}

curl -vX POST http://localhost:3002/people \
  -H 'content-type: application/json' -d '{"name": "Noah", "age": 1}'

{
  "name": "Noah",
  "age": 1,
  "id": 2
}

GET /:collection/:id

Retrieve the :collection resource with id :id.

curl -v http://localhost:3002/people/1

{
  "name": "Liam",
  "age": 29,
  "id": 1
}

GET /:collection

Retrieve an array of all :collection resources.

curl -v http://localhost:3002/people

[
  {
    "name": "Liam",
    "age": 29,
    "id": 1
  },
  {
    "name": "Noah",
    "age": 1,
    "id": 2
  }
]

PUT /:collection/:id

Override the :collection resource with id :id.

curl -vX PUT http://localhost:3002/people/1 \
  -H 'content-type: application/json' -d '{"name": "LiamO", "age": 30}'

{
  "name": "LiamO",
  "age": 30,
  "id": "1"
}

DELETE /:collection/:id

Delete the :collection resource with id :id.

curl -vX DELETE http://localhost:3002/people/1

It uses the CORS headers to allow cross-origin requests.

Usage

Clone the repository
Install node.js
Install the dependencies with npm install
Start the server with npm start
[Optional] Run tests with cd test && ./curl_tests.sh

resourceserver's People

Contributors

Stargazers

Watchers

resourceserver's Issues

I'm interested to see what you do here

I've been exploring tighter backbone integration with node. At the moment i'm rendering the same templates server and client side. And i've thinking about how I can better unify the routes, instead of having to declare them twice (once serverside and once client side).

Another possibility i've been thinking about is pushing templates down the wire when they change.

OPTIONS method failed to respond.

When I create an object, XHR's default behavior issue an OPTIONS method first, then issue POST metHod, the first one failed, however, chrome ignore that, and continue issue PUT method call. But firefox will fail all together if the first one fail. I think you should change to respond to OPTIONS query.

CoffeeScript compilation

As indicated in my PR, I don't know node.js scarcely at all. When starting up my resourceserver, I had to first manually compile the config.coffee and logger.coffee files to js by installing coffee-script as a global package in node, and then compiling each file individually. Should that be part of the startup script, or did I just miss a step in setting up node somewhere?

(PS, thanks for your PluralSight video Liam, it helped me present on Backbone in a lunch&learn today. :) )

Recommend Projects

liammclennan / resourceserver Goto Github PK