coffeerest-api/test/model.coffee

Api scaffolding from a model specification in few lines of coffeescript OH MY

module.exports = {
  host: "localhost:4040"
  doc:
    version: 1
    projectname: "Foo"
    logo: "https://github.com/coderofsalvation/coffeerest-api/raw/master/coffeerest.png"
    host: "http://mydomain.com"
    homepage: "http://mydomain.com/about"
    security: "Requests are authorized by adding a 'X-FOO-TOKEN: YOURTOKEN' http header"
    description: "Welcome to the Core API Documentation. The Core API is the heart of Project foo and should never be confused with the public api."
    request: 
      curl: "curl -X {{method}} -H 'Content-Type: application/json' -H 'X-FOO-TOKEN: YOURTOKEN' '{{url}}' --data '{{payload}}' "
      jquery: "jQuery.ajax({ url: '{{url}}', method: {{method}}, data: {{payload}} }).done(function(res){ alert(res); });"
      php: "$client->{{method}}('{{url}}', '{{payload}}');"
      coffeescript: "request.{{method}}\n\theaders: {'X-FOO-TOKEN': apikey }\n\turl: '{{url}}'\n\tjson: true\n\tbody: {{payload}}\n,(error,reponse,body) ->\n\tok = !error and response.statusCode == 200 and response.body"
      nodejs: "request.post({\n\theaders: {\n\t\t'X-FOO-TOKEN': apikey\n\t},\n\turl: '{{url}}',\n\tjson:true,\n\tbody: {{payload}}\n}, function(error, reponse, body) {\n\tvar ok;\n\treturn ok = !error && response.statusCode === 200 && response.body;\n});"
      php: "$json = '{{payload}}';\n$ch = curl_init( '{{url}}' );\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, strtoupper('{{method}}') );\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $json);\ncurl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array(\n\t'Content-Type: application/json',\n\t'Content-Length: ' . strlen($json))\n);\n$result = curl_exec($ch);\n// HINT: use a REST client like https://github.com/bproctor/rest\n//       or install one using composer: http://getcomposer.org"
      python: "import requests, json\nurl = '{{url}}'\ndata = json.dumps( {{payload}} )\nr = requests.post( url, data, auth=('user', '*****'))\nprint r.json"

  #oauth:
  #  provider1:
  #    'key': '...'
  #    'secret': '...'
  #    'scope': [
  #      'scope1'
  #      'scope2'
  #    ]
  #    'callback': '/provider1/callback'

  security:
    header_token: "X-Foo-Token"

  query_params: [
    {
      id: "#/query_params/populate"
      description: "adds relational data to the result"
      type:"array"
      items:[{type:"string"}]
    },{
      id: "#/query_params/populate2"
      description: "adds relational data to the result"
      type:"array"
      items:[{type:"string"}]
    },{
      id: "#/query_params/populate3"
      description: "adds relational data to the result"
      type:"array"
      items:[{type:"string"}]
    }
  ]

  db: 
    config:
      connections:
        default:
          adapter: 'memory'
        memory: 
          adapter: 'memory'
        #myLocalDisk: 
        #  adapter: 'disk'
        #myLocalMySql:
        #  adapter: 'mysql'
        #  host: 'localhost'
        #  database: 'foobar'
      defaults: 
        migrate: 'alter'  

    resources:
      article:
        connection: 'memory'
        schema:
          authenticate: true
          description: "this foo bar"
          taggable: true
          owner: "user"
          required: ['title','content']
          payload:
            title: 
              type: "string"
              default: "title not set"
              minLength: 2
              maxLength: 40
              index: true
            content:
              type: "string"
              default: "Lorem ipsum"
            date:
              type: "string"
              default: "2012-02-02"

      user:
        connection: 'memory'
        schema:
          authenticate: true
          taggable: true
          description: "author"
          requiretag: ["is user","can update user","cannot update user email"]
          required: ['email','apikey']
          payload:
            email:   { type: "string", default: 'John Doe', pattern: "[@\.]" }
            apikey:  { type: "string", default: "john@doe.com", index:true }

  resources:
    '/ping':
      get:
        description: 'earth to api'
        function: (req, res, next,lib, reply) ->
          lib[ req.params.action ]() if lib[ req.params.action ]?
          return reply 
  
    '/book/:id':
      get:
        description: "show book"
        function: (req, res, next,lib, reply) ->
          reply.data = [1,2,3]
          return reply 
      post:
        description: 'adds a book'
        notes: 'duplicates are not allowed'
        query_params: 
          populate:  { param: {"$ref": "#/query_params/populate"}, values: ["authors","tags"] }
          populate2: { param: {"$ref": "#/query_params/populate2"}, values: ["authors","tags"] }
          populate3: { param: {"$ref": "#/query_params/populate3"}, values: ["authors","tags"] }
        required: ['foo']
        payload:
          foo: { type: "string", minLength: 5, default: "bar" }
        function: (req, res, next,lib, reply) ->
          reply.data = [1,2,3]
          return reply 
          
  replyschema:
    type: 'object'
    required: ['code','message','kind','data']
    messages:
      0: 'feeling groovy'
      1: 'unknown error'
      2: 'your payload is invalid (is object? content-type is application/json?)'
      3: 'data error'
      4: 'access denied'
    payload:
      code:       { type: 'integer', default: 0 }
      message:    { type: 'string',  default: 'feeling groovy' }
      kind:       { type: 'string',  default: 'default', enum: ['book','default'] }
      data:       { type: 'object',  default: {} }
      errors:     { type: 'object',  default: [] }

}