{"_id":"fire-web","_rev":"5-1937b9c24d08c9d684807f01f81bc637","name":"fire-web","description":"RESTful API and Web Development Expressions for fire.js on top of express.js","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"fire-web","description":"RESTful API and Web Development Expressions for fire.js on top of express.js","version":"0.1.0","author":{"name":"Firebase.co","email":"npm@firebase.co","url":"http://www.firebase.co"},"homepage":"http://firejs.firebase.co","contributors":[{"name":"Johan Hernandez","email":"johan@firebase.co"}],"main":"./index.js","repository":{"type":"git","url":"git://github.com/firejs/fire-web.git"},"bugs":{"email":"firejs@firebase.co","url":"https://github.com/firejs/fire-web/issues"},"keywords":["fire","fire.js","API","REST","RESTful","JSON","ignitable"],"dependencies":{"express":">= 2.4.6","fire":">= 0.1.0","fire-i18n":">= 0.1.0","fire-assert":">= 0.1.0","fire-validations":">= 0.1.0","jade":">= 0.11.0"},"devDependencies":{"vows":">= 0.5.11","request":">= 2.2.5"},"engines":{"node":">=  0.4.5"},"scripts":{"test":"make"},"licenses":[{"type":"MIT","url":"https://github.com/firejs/fire-web/blob/master/LICENSE"}],"_npmUser":{"name":"firebaseco","email":"npm@firebase.co"},"_id":"fire-web@0.1.0","_engineSupported":true,"_npmVersion":"1.0.106","_nodeVersion":"v0.5.10","_defaultsLoaded":true,"dist":{"shasum":"105a2aa6b2d85f17878fa14b701b60201191c546","tarball":"https://registry.npmjs.org/fire-web/-/fire-web-0.1.0.tgz","integrity":"sha512-/dCiT2aAVZo3h6pjLzjoICN/+BVM41z0prM7YsauDf8wrirFtg704Fsdo+hMTOft2qaknl8KTBJ2WpiV4L0GTQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDoE77+UePPyLuGJGbBAywvRmYsox/3MNEnBzoyKfbAcAIgBj5RrSsV5MyvERtjUNPZ1H9kN061banzeUoMBgVQuc0="}]},"maintainers":[{"name":"firebaseco","email":"npm@firebase.co"}]}},"readme":"# fire-web\n[![Build Status](https://secure.travis-ci.org/firejs/fire-web.png)](http://travis-ci.org/firejs/fire-web)\n\nRESTful API and Web Development Expressions for  [fire.js](https://github.com/firejs/fire) and [express.js](http://expressjs.com/)\n\n## How to use\n\nInstall [fire.js](https://github.com/firejs/firejs) globally and run the following JSON file.\n\n    // app.fjson\n\t{\n\t\t\"name\": \"app\",\n\t\t\"json\": {\n\t\t\t\"@Web.Server.Boot\": null\n\t\t}\n    }\n\n    $ fire app.fjson\n\nThis will initialize a fire.js Runtime and run a express.js server in port 3500(for both development and test environments). If you want it to run in port 80(production) you need to run it as superuser and set the environment variable *NODE_ENV=production*.\n\n## Web Expressions\n\nWeb Expressions are regular fire.js expressions especially decorated to be invoked using HTTP. To publish your fire.js expression as web expressions you just need to add a `route` attribute:\n\nExample:\n\n    {\n\t\t\"Web.Endpoint\": \"GET /hello\",\n\t\t\"name\": \"basicService.hello\",\n\t\t\"json\": \"Hello World\"\n\t}\n\nIf some http client invokes /hello it will get the following response:\n\n    {\"response\": \"Hello World\"}\n\n## Protocols\n\nProtocols defines the shape of the API responses, by default `Web.Protocols.Response` is used.\n\nThe protocol can be changed globally if you set `defaultResponseProtocol` in the configurations.\n\nExample:\n\n    {\n\t\t\"modules\": [\"fire-web\"],\n\t\t\"environments\": {\n\t\t\t\"development\": {\n\t\t\t\t\"fire-web\": {\n\t\t\t\t\t\"port\": 3503,\n\t\t\t\t\t\"defaultResponseProtocol\": \"customProtocols.CustomProtocol\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\nSome operation may require a custom protocol, using the `responseProtocol` attribute each expression can define it's own custom protocol.\n\nExample:\n\n    {\n\t\t\"Web.Endpoint\": \"GET /hello\",\n\t\t\"Web.Response.Protocol\": \"customProtocols.CustomOverride\",\n\t\t\"name\": \"useOverride.hello\",\n\t\t\"json\": \"Hello World\"\n\t}\n\n\n### Contributors\n\n* Johan (author). Email: *johan@firebase.co*\n\n## Cloning the Repository\n\n    git clone https://github.com/firejs/fire-web.git\n\n### Tests\n\n    make run-tests\n\n## MIT License\n\nCopyright (c) 2011 Firebase.co and Contributors - http://www.firebase.co\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.","maintainers":[{"name":"firebaseco","email":"npm@firebase.co"}],"time":{"modified":"2022-06-18T01:01:32.249Z","created":"2011-11-23T04:21:16.749Z","0.1.0":"2011-11-23T04:21:19.634Z"},"author":{"name":"Firebase.co","email":"npm@firebase.co","url":"http://www.firebase.co"},"repository":{"type":"git","url":"git://github.com/firejs/fire-web.git"}}