├── .gitattributes ├── LICENSE ├── README.md ├── config.js ├── controladores ├── index.js └── peliculas.js ├── doc ├── movie_fire.png └── movie_fire_details.png ├── package.json ├── publico ├── css │ └── index.css ├── img │ └── black.jpg └── js │ └── index.js ├── server.js └── vistas └── index.jade /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2015 Ulises Gascon 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

:warning: This repository is not longer maintained :warning:

2 | 3 | 4 | # Simple API REST con [Firebase](https://www.firebase.com/) y [OMBD](http://omdbapi.com/) 5 | 6 | Este script está diseñado como contenido académico para el [curso de Node.js](http://www.fictizia.com/formacion/curso_nodejs) de [Fictizia](http://www.fictizia.com/). 7 | 8 | El objetivo de este repositorio es mostrar cómo desarrollar una API Rest sencilla usando [Firebase](https://www.firebase.com/) como base de datos y enriqueciendo los datos con [OMBD](http://omdbapi.com/) 9 | 10 | Este script permite al usuario introducir el nombre completo o solo parte de la película que queramos y Nodejs se encargará de buscar todos los detalles (Nombre completo, director, actores, países, argumento, poster, etc...) y actualizar la base de datos (Firebase) con esta información. 11 | 12 | El script funciona usando un API Rest, lo que nos permite gestionar el contenido independientemente de la interfaz. En este script ya se incluye un cliente listo para que gestionemos todo desde un entorno visual (usando Bootstrap). 13 | 14 | 15 | ### Agradecimientos 16 | 17 | La parte front del proyecto se basa en la evolución del [repositorio](https://github.com/arvindr21/movieFire) de [Arvind Ravulavaru](https://twitter.com/arvindr21), [The Jackal of Javascript](http://thejackalofjavascript.com). Podéis leer el [artículo completo en su blog](http://thejackalofjavascript.com/getting-started-with-firebase/). 18 | 19 | Para el enriquecimiento de datos con la información de las películas, utilizamos [OMBD](http://omdbapi.com/), pero a través de la [librería de Misterhat](https://github.com/misterhat/omdb) 20 | 21 | Para la gestión de los errores, he utilizado [Crier](https://www.npmjs.com/package/crier). 22 | 23 | 24 | ### Dependencias: 25 | 26 | **[v2.0.0 - (Actual)](https://github.com/UlisesGascon/Simple-API-REST-with-Firebase-and-IMBD/releases/tag/v2.0.0)** 27 | - Backend 28 | - [Pillars (0.3.1)](https://www.npmjs.com/package/pillars) 29 | - [Crier (0.4.5)](https://www.npmjs.com/package/crier) 30 | - [Jade (1.11.0)](https://www.npmjs.com/package/jade) 31 | - [Omdb (0.3.1)](https://github.com/misterhat/omdb) 32 | - [Firebase (2.3.1)](https://www.npmjs.com/package/firebase) 33 | - Frontend 34 | - [Firebase Client (1.0.15)](https://www.firebase.com) 35 | - [Jquery (1.11.3)](https://jquery.com) 36 | - [Bootstrap (3.3.5)](http://getbootstrap.com/) 37 | 38 | **[v1.0.0](https://github.com/UlisesGascon/Simple-API-REST-with-Firebase-and-IMBD/releases/tag/v1.0.0)** 39 | - Backend 40 | - [Express (4.13.3)](https://www.npmjs.com/package/express) 41 | - [Body-parser (1.5.1)](https://www.npmjs.com/package/body-parser) 42 | - [Method-override (2.1.2)](https://www.npmjs.com/package/method-override) 43 | - [Jade (1.11.0)](https://www.npmjs.com/package/jade) 44 | - [Omdb (0.3.1)](https://github.com/misterhat/omdb) 45 | - [Firebase (2.3.1)](https://www.npmjs.com/package/firebase) 46 | - [Winston (1.1.0)](https://github.com/winstonjs/winston) 47 | - Frontend 48 | - [Firebase Client (1.0.15)](https://www.firebase.com) 49 | - [Jquery (1.11.3)](https://jquery.com) 50 | - [Bootstrap (3.3.5)](http://getbootstrap.com/) 51 | 52 | 53 | **Instalar dependencias** 54 | 55 | ``` 56 | npm install 57 | ``` 58 | 59 | 60 | ### Front 61 | 62 | Por defecto al desplegar nuestro servidor Express renderiza una página que nos permite interactuar con el API sin salirnos del entorno visual. 63 | 64 | ![Interfaz](/doc/movie_fire.png) 65 | 66 | Además de la lista de las películas presentes en Firebase, que se actualiza en tiempo real gracias al uso de websockets (Nodejs < -(Pillars)-> Cliente directo <- (Web Sockets) Firebase <-(API)-> Nodejs). Podemos ver los detalles de cada película en un Modal. 67 | 68 | ![Interfaz detalles](/doc/movie_fire_details.png) 69 | 70 | Además se incluye la opción de manejar el API desde la consola del navegador usando la función *llamarAPI* 71 | 72 | ```javascript 73 | // Hackers ID: tt0113243 74 | 75 | // Cambiar el nombre de Hackers en la lista (método PUT, datos {nombre: "lo que sea"}) 76 | llamarAPI ("PUT", "tt0113243", "lo que sea" ); 77 | 78 | // Borrar Hackers 79 | llamarAPI ("DELETE", "tt0113243"); 80 | 81 | // Añadir Hackers 82 | llamarAPI ("POST", "" ,"Hackers"); 83 | ``` 84 | 85 | 86 | ### Rutas API 87 | 88 | Imaginemos que nuestro script está funcionando en localhost bajo el puerto 3000. 89 | 90 | **Headers CORS** 91 | 92 | El [CORS](http://www.wikiwand.com/en/Cross-origin_resource_sharing) está habilitado exclusivamente en la ruta del API. Gracias al sistema de enrutado que incorpora pillars, por tanto se pueden hacer peticiones a nuestra API desde otros dominios. 93 | 94 | ```javascript 95 | // CORS 96 | var rutaApiPeliculas = new Route({ 97 | id: "peliculas", 98 | path: "/api/peliculas/*:path", 99 | cors: true 100 | }, 101 | ``` 102 | 103 | **Rutas Front** 104 | 105 | - http://locahost:3000/ -> Renderizará el Index.jade y nos dejará trabajar con el entorno visual. 106 | 107 | **Rutas API** 108 | 109 | - [GET] http://locahost:3000/api/peliculas -> Muestra todas las películas de Firebase en formato .json 110 | - [POST] http://locahost:3000/api/peliculas -> Permite añadir películas 111 | - [GET] http://locahost:3000/api/peliculas/ -> Muestra los detalles de esa película en concreto en formato .json 112 | - [PUT] http://locahost:3000/api/peliculas/ -> Permite actualizar el nombre de la película que se muestra en http://locahost:3000/api/peliculas 113 | - [DELETE] http://locahost:3000/api/peliculas/ -> Borrar la película 114 | 115 | 116 | ### Configuración en Firebase 117 | 118 | **Nota: Existe una nueva versión de Firebase, estoy trabajando en la migración. [Más detalles](https://firebase.google.com/)** 119 | 120 | Este script está pensado para utilizar un [Token](http://www.wikiwand.com/en/Access_token) en la escritura de datos en Firebase. La lectura de los datos no tiene restricciones. Es importante definir [las reglas de seguridad de firebase](https://www.firebase.com/docs/security/guide/securing-data.html) de una manera compatible. 121 | 122 | ```javascript 123 | myFirebaseRef.authWithCustomToken(config.token, function(error, authData) { 124 | if (error) { 125 | logger.error("Error al guardar los datos en Firebase (relacionado con Token).", { 126 | datos: error 127 | }); 128 | } else { 129 | logger.info("Autentificación (via Token) lograda con exito.", { 130 | datos: authData 131 | }); 132 | } 133 | }); 134 | ``` 135 | 136 | Además se recomienda hacer un [indexado a la ruta "details/imbID"](https://www.firebase.com/docs/security/guide/indexing-data.html) que es la que se usa en el front para cargar los detalles de las películas. 137 | 138 | ```json 139 | { 140 | "rules": { 141 | ".read": true, 142 | ".write": true, 143 | "nodemovies": { 144 | ".indexOn": ["details/imdbID"], 145 | ".read": true, 146 | ".write": "auth != null && auth.isAdmin == true" 147 | } 148 | } 149 | } 150 | ``` 151 | 152 | 153 | ### Configuración en Node 154 | 155 | **Puerto e IP** 156 | 157 | El script está listo para funcionar en [c9.io](https://c9.io/), si desea cambiarlo lo más sencillo es convertir *process.env.PORT* en *3000* u otro puerto y *process.env.IP* en *"localhost"*. Este ajuste solo es necesario en *server.js* 158 | 159 | **Token y rutas** 160 | 161 | Por defecto el repositorio incorpora un archivo *config.js* vacio. Es necesario meter los datos correspondientes para que funcione. Es recomendable que la propiedad *token* sea una variable del entorno, sobretodo en entornos de producción. 162 | 163 | Este ajuste solo es necesario en los archivos *config.js* (rutas y token) 164 | ```javascript 165 | var config = { 166 | token: "", 167 | firebaseApp: "", 168 | firebaseAppRuta: "" 169 | }; 170 | ``` 171 | y *publico/js/index.js* (solo rutas) 172 | ```javascript 173 | var myFBAdress = ""; 174 | var serverAdress = ""; // .../api/peliculas/ 175 | ``` 176 | 177 | 178 | ### Notas 179 | 180 | El script descarga en *publico/img/* todos los posters de las películas. Y solo se utilizan esas imágenes o *black.jpg* en su defecto. Ya que la url original provoca un *error 503* al solicitarlas desde un dominio diferente (en localhost funcionan igualmente). 181 | 182 | ```javascript 183 | // Guardar los posters (Método POST) 184 | if (pelicula.poster) { 185 | pelicula.posterSolution = pelicula.imdb.id + ".jpg"; 186 | var file = fs.createWriteStream('./publico/img/' + pelicula.imdbID + '.jpg'); 187 | var request = http.get(pelicula.poster, function(response) { 188 | response.pipe(file); 189 | logger.warn("Poster de la pelicula " + pelicula.imdb.id + " guardado en /publico/img/ como " + pelicula.imdbID + ".jpg"); 190 | }).on('error', function(e) { 191 | pelicula.posterSolution = false; 192 | logger.error("Poster de la película " + pelicula.imdb.id + " no se pudo guardar.", { 193 | datos: e 194 | }); 195 | }); 196 | } else { 197 | pelicula.posterSolution = false; 198 | logger.error("La película " + pelicula.imdb.id + " no tiene poster asociado."); 199 | } 200 | ``` 201 | y elimina los posters cuando ya no son necesarios. 202 | ```javascript 203 | // Elimina los posters (Método DELETE) 204 | fs.unlink('./publico/img/' + req.params.id + '.jpg', function(err) { 205 | if (err) { 206 | if (err.errno == 34) { 207 | logger.error("Error al borrar la imagen /publico/img/" + req.params.id + ".jpg. La imagen no existe", { 208 | datos: err 209 | }); 210 | } else { 211 | logger.error("Error al borrar la imagen /publico/img/" + req.params.id + ".jpg", { 212 | datos: err 213 | }); 214 | } 215 | } else { 216 | logger.info("./publico/img/" + req.params.id + ".jpg - eliminado con exito"); 217 | } 218 | }); 219 | ``` 220 | -------------------------------------------------------------------------------- /config.js: -------------------------------------------------------------------------------- 1 | var config = { 2 | token: "", // Firebase Token 3 | firebaseApp: "", // https://<< --- Firebase APP URL --- >>.firebaseio.com 4 | firebaseAppRuta: "" // https://<< --- Firebase APP URL --- >>.firebaseio.com/<--- Ruta --->/ 5 | }; 6 | 7 | module.exports = config; -------------------------------------------------------------------------------- /controladores/index.js: -------------------------------------------------------------------------------- 1 | //GET - Devolviendo todas las películas 2 | exports.mostrarIndex = function(gw){ 3 | gw.render('./vistas/index.jade'); 4 | }; -------------------------------------------------------------------------------- /controladores/peliculas.js: -------------------------------------------------------------------------------- 1 | var fs = require('fs'), 2 | http = require('http'), 3 | Firebase = require("firebase"), 4 | omdb = require("omdb"), 5 | config = require('../config'), 6 | myFirebaseRef = new Firebase("https://" + config.firebaseApp + ".firebaseio.com/" + config.firebaseAppRuta), 7 | crier = global.crier.addGroup('movieFire'); 8 | 9 | //GET - Devolviendo todas las películas 10 | //Ruta: /api/peliculas 11 | exports.mostrarPeliculas = function(gw) { 12 | myFirebaseRef.once("value", function(snapshot) { 13 | gw.json(snapshot.val(), {deep:10}); 14 | }, function(errorObject) { 15 | if (errorObject) { 16 | gw.error(500); 17 | } 18 | }); 19 | }; 20 | 21 | //GET - Devolviendo una película con ID específico 22 | //Ruta: /api/peliculas/:id 23 | exports.buscarPeliculaID = function(gw) { 24 | //logger.info("Peticion GET en /api/peliculas/" + req.params.id); 25 | myFirebaseRef.orderByChild("details/imdbID").equalTo(gw.pathParams.path).once("value", function(snapshot) { 26 | gw.json(snapshot.val(), {deep:10}); 27 | }, function(errorObject) { 28 | if (errorObject) { 29 | gw.error(500); 30 | } 31 | }); 32 | }; 33 | 34 | //POST - Insertando una nueva película 35 | //Ruta: /api/peliculas 36 | exports.sumarPelicula = function(gw) { 37 | console.log(gw.content.params.nombre); 38 | omdb.get({ 39 | title: gw.content.params.nombre 40 | }, true, function(err, pelicula) { 41 | if (err || !pelicula) { 42 | return gw.error(404); 43 | } 44 | 45 | // Rectificando los valores de OMBD 46 | pelicula.imdbID = pelicula.imdb.id; 47 | pelicula.year = pelicula.year.from || pelicula.year; 48 | 49 | // Guardar los posters 50 | if (pelicula.poster) { 51 | pelicula.posterSolution = pelicula.imdb.id + ".jpg"; 52 | var file = fs.createWriteStream('./publico/img/' + pelicula.imdbID + '.jpg'); 53 | var request = http.get(pelicula.poster, function(response) { 54 | response.pipe(file); 55 | }).on('error', function(e) { 56 | pelicula.posterSolution = false; 57 | }); 58 | } else { 59 | pelicula.posterSolution = false; 60 | } 61 | console.log(pelicula.year) 62 | myFirebaseRef.authWithCustomToken(config.token, function(error, authData) { 63 | if (error) { 64 | crier.error("Error al guardar los datos en Firebase (relacionado con Token).", {datos: error}); 65 | } else { 66 | crier.info("Autentificación (via Token) lograda con exito.", {datos: authData}); 67 | myFirebaseRef.child(pelicula.imdbID).set({ 68 | name: pelicula.title, 69 | details: pelicula 70 | }, function() { 71 | gw.text(pelicula.title + " añadida con exito"); 72 | }); 73 | } 74 | }); 75 | }); 76 | }; 77 | 78 | //PUT - Actualizando una película existente 79 | //Ruta: /api/peliculas:id 80 | exports.actualizarPelicula = function(gw) { 81 | omdb.get({ 82 | imdb: gw.pathParams.path 83 | }, true, function(err, pelicula) { 84 | 85 | if (err || !pelicula) { 86 | return gw.error(404); 87 | } 88 | 89 | // Rectificando los valores de OMBD 90 | pelicula.imdbID = pelicula.imdb.id; 91 | pelicula.year = pelicula.year.from || pelicula.year; 92 | 93 | // Guardar los posters 94 | if (pelicula.poster) { 95 | pelicula.posterSolution = pelicula.imdb.id + ".jpg"; 96 | var file = fs.createWriteStream('./publico/img/' + pelicula.imdbID + '.jpg'); 97 | var request = http.get(pelicula.poster, function(response) { 98 | response.pipe(file); 99 | crier.info("Poster de la pelicula " + pelicula.imdb.id + " guardado en /publico/img/ como " + pelicula.imdbID + ".jpg"); 100 | }).on('error', function(e) { 101 | pelicula.posterSolution = false; 102 | crier.error("Poster de la película " + pelicula.imdb.id + " no se pudo guardar.", {datos: e}); 103 | }); 104 | } else { 105 | pelicula.posterSolution = false; 106 | } 107 | 108 | myFirebaseRef.authWithCustomToken(config.token, function(error, authData) { 109 | if (error) { 110 | crier.error("Error al guardar los datos en Firebase (relacionado con Token).", {datos: error}); 111 | } else { 112 | crier.info("Autentificación (via Token) lograda con exito.", {datos: authData}); 113 | myFirebaseRef.child(pelicula.imdbID).set({ 114 | name: gw.content.params.nombre, 115 | nameOriginal: pelicula.title, 116 | details: pelicula 117 | }, function() { 118 | gw.text(pelicula.title + " - Actualización realizada con exito"); 119 | }); 120 | } 121 | }); 122 | }); 123 | }; 124 | 125 | //DELETE - Borrando una película existente 126 | //Ruta: /api/peliculas:id 127 | exports.borrarPelicula = function(gw) { 128 | myFirebaseRef.authWithCustomToken(config.token, function(error, authData) { 129 | if (error) { 130 | crier.error("Error al guardar los datos en Firebase (relacionado con Token).", {datos: error}); 131 | } else { 132 | crier.info("Autentificación (via Token) lograda con exito.", {datos: authData}); 133 | fs.unlink('./publico/img/' + gw.pathParams.path + '.jpg', function(err) { 134 | if (err) { 135 | if (err.errno == 34) { 136 | crier.error("Error al borrar la imagen /publico/img/" + gw.pathParams.path + ".jpg. La imagen no existe", {datos: err}); 137 | } else { 138 | crier.error("Error al borrar la imagen /publico/img/" + gw.pathParams.path + ".jpg", {datos: err}); 139 | } 140 | } else { 141 | crier.info("./publico/img/" + gw.pathParams.path + ".jpg - eliminado con exito"); 142 | } 143 | }); 144 | 145 | myFirebaseRef.child(gw.pathParams.path).remove(); 146 | gw.text("borrado realizado con exito"); 147 | } 148 | }); 149 | }; -------------------------------------------------------------------------------- /doc/movie_fire.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/UlisesGascon/Simple-API-REST-with-Firebase-and-IMBD/ca392b4fc4c7c285af1e661669dd05cdccbe9074/doc/movie_fire.png -------------------------------------------------------------------------------- /doc/movie_fire_details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/UlisesGascon/Simple-API-REST-with-Firebase-and-IMBD/ca392b4fc4c7c285af1e661669dd05cdccbe9074/doc/movie_fire_details.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "moviefire-api", 3 | "version": "2.0.0", 4 | "description": "Simple API Rest with Firebase and OMBD", 5 | "main": "server.js", 6 | "dependencies": { 7 | "crier": "0.4.5", 8 | "firebase": "2.3.1", 9 | "jade": "1.11.0", 10 | "omdb": "0.3.1", 11 | "pillars": "^0.3.3" 12 | }, 13 | "devDependencies": {}, 14 | "author": "Ulises Gascon", 15 | "license": "GPL-3.0" 16 | } 17 | -------------------------------------------------------------------------------- /publico/css/index.css: -------------------------------------------------------------------------------- 1 | .modal-body{ 2 | min-height: 400px; 3 | } 4 | 5 | .imgPoster { 6 | max-height:370px; 7 | } 8 | 9 | /* Customize container */ 10 | @media (min-width: 768px) { 11 | .container { 12 | max-width: 700px; 13 | } 14 | .input-group { 15 | min-width: 550px; 16 | margin:auto; 17 | } 18 | .botones{ 19 | font-size:9px; 20 | } 21 | } -------------------------------------------------------------------------------- /publico/img/black.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/UlisesGascon/Simple-API-REST-with-Firebase-and-IMBD/ca392b4fc4c7c285af1e661669dd05cdccbe9074/publico/img/black.jpg -------------------------------------------------------------------------------- /publico/js/index.js: -------------------------------------------------------------------------------- 1 | /*global Firebase*/ 2 | 3 | var myFBAdress = "https://experimentos.firebaseio.com/nodemovies"; 4 | var favMovies = new Firebase(myFBAdress); 5 | var serverAdress = "http://pillarsjs.herokuapp.com/api/peliculas/"; 6 | 7 | function saveToList(event) { 8 | if (event.which == 13 || event.keyCode == 13) { 9 | var movieName = document.getElementById('movieName').value.trim(); 10 | if (movieName.length > 0) { 11 | llamarAPI("POST", "", movieName); 12 | } 13 | document.getElementById('movieName').value = ''; 14 | return false; 15 | } 16 | } 17 | 18 | function refreshUI(list) { 19 | var lis = ''; 20 | for (var i = 0; i < list.length; i++) { 21 | lis += '
' + list[i].name; + ''; 22 | lis += '' + genLinks(list[i].key, list[i].name) + '
'; 23 | } 24 | document.getElementById('favMovies').innerHTML = lis; 25 | $('#detallesModal').hide(); 26 | } 27 | 28 | function genLinks(key, mvName) { 29 | var links = ''; 30 | 31 | links += '
'; 32 | links += ''; 33 | links += ''; 34 | links += ''; 35 | links += '
'; 36 | 37 | return links; 38 | } 39 | 40 | function details(key, mvName) { 41 | favMovies.on("value", function(snapshot) { 42 | var data = snapshot.val(); 43 | var imgDetails = ''; 44 | 45 | if (data[key].details.posterSolution) { 46 | imgDetails = ''; 47 | } 48 | var allDetails = '

ID: ' + data[key].details.imdbID + '

'; 49 | 50 | // Verificando el director 51 | if (data[key].details.director) { 52 | allDetails += '

Director: ' + data[key].details.director + '

'; 53 | } 54 | 55 | // Verificando el año 56 | if (data[key].details.year) { 57 | allDetails += '

Year: ' + data[key].details.year + '

'; 58 | } 59 | 60 | // Dividiendo y agrupando actores 61 | if (data[key].details.actors) { 62 | if (data[key].details.actors.length == 1 && data[key].details.actors.length != 0) { 63 | allDetails += '

Actors: ' + data[key].details.actors[0] + '

'; 64 | } else { 65 | allDetails += '

Actors: ' + data[key].details.actors[0]; 66 | for (var i = 1; i < data[key].details.actors.length; i++) { 67 | allDetails += ', ' + data[key].details.actors[i]; 68 | } 69 | allDetails += '

'; 70 | } 71 | } 72 | 73 | // Dividiendo y agrupando generos 74 | if (data[key].details.genres) { 75 | if (data[key].details.genres.length == 1 && data[key].details.genres.length != 0) { 76 | allDetails += '

Genres: ' + data[key].details.genres[0] + '

'; 77 | } else { 78 | allDetails += '

Genres: ' + data[key].details.genres[0]; 79 | for (var i = 1; i < data[key].details.genres.length; i++) { 80 | allDetails += ', ' + data[key].details.genres[i]; 81 | } 82 | allDetails += '

'; 83 | } 84 | } 85 | 86 | // Dividiendo y agrupando paises 87 | if (data[key].details.countries) { 88 | if (data[key].details.countries.length == 1 && data[key].details.countries.length != 0) { 89 | allDetails += '

Countries: ' + data[key].details.countries[0] + '

'; 90 | } else { 91 | allDetails += '

Countries: ' + data[key].details.countries[0]; 92 | for (var i = 1; i < data[key].details.countries.length; i++) { 93 | allDetails += ', ' + data[key].details.countries[i]; 94 | } 95 | allDetails += '

'; 96 | } 97 | } 98 | 99 | // Dividiendo y agrupando la descripción 100 | if (data[key].details.plot) { 101 | if (data[key].details.plot.length >= 250) { 102 | allDetails += '

Plot: ' + data[key].details.plot.substring(0, 250) + '...

'; 103 | } else { 104 | allDetails += '

Plot: ' + data[key].details.plot + '

'; 105 | } 106 | } 107 | 108 | $('#detallesModalLabel').html(data[key].details.title); 109 | $('#imagenDetalles').html(imgDetails); 110 | $('#textoDetalles').html(allDetails); 111 | $('#detallesModal').modal('show') 112 | }); 113 | } 114 | 115 | function edit(key, mvName) { 116 | var movieName = prompt("Update the movie name", mvName); 117 | if (movieName && movieName.length > 0) { 118 | llamarAPI("PUT", key, movieName); 119 | } 120 | } 121 | 122 | function del(key, mvName) { 123 | var response = confirm("Are certain about removing \"" + mvName + "\" from the list?"); 124 | if (response === true) { 125 | llamarAPI("DELETE", key); 126 | } 127 | } 128 | 129 | function llamarAPI(tipo, ruta, datos) { 130 | var settings = { 131 | "async": true, 132 | "crossDomain": true, 133 | "url": serverAdress + ruta || "", 134 | "method": tipo, 135 | "headers": { 136 | "cache-control": "no-cache", 137 | "content-type": "application/x-www-form-urlencoded" 138 | }, 139 | "data": { 140 | "nombre": datos || "" 141 | } 142 | }; 143 | $.ajax(settings).done(function(response) { 144 | $('#detallesModal').hide(); 145 | }); 146 | } 147 | 148 | favMovies.on("value", function(snapshot) { 149 | var data = snapshot.val(); 150 | var list = []; 151 | for (var key in data) { 152 | if (data.hasOwnProperty(key)) { 153 | var name = data[key].name ? data[key].name : ''; 154 | if (name.trim().length > 0) { 155 | list.push({ 156 | name: name, 157 | key: key 158 | }); 159 | } 160 | } 161 | } 162 | refreshUI(list); 163 | }); -------------------------------------------------------------------------------- /server.js: -------------------------------------------------------------------------------- 1 | var project = require('pillars'), 2 | path = require('path'), 3 | jade = require('jade'); 4 | 5 | // Starting the project 6 | project.services.get('http').configure({ 7 | port: process.env.PORT || 3000 8 | }).start(); 9 | 10 | // Vistas y plantillas 11 | var templated = global.templated; 12 | templated.addEngine('jade', function compiler(source, path) { 13 | return jade.compile(source, { 14 | filename: path, 15 | pretty: false, 16 | debug: false, 17 | compileDebug: false 18 | }); 19 | }); 20 | 21 | // Controladores 22 | var controlIndex = require('./controladores/index'); 23 | var controlPeliculas = require('./controladores/peliculas'); 24 | 25 | // Rutas API 26 | var rutaApi = new Route({ 27 | id: "api", 28 | path: "/api" 29 | }, 30 | function(gw) { 31 | gw.redirect("/"); 32 | }); 33 | 34 | 35 | 36 | var rutaApiPeliculas = new Route({ 37 | id: "peliculas", 38 | path: "/api/peliculas/*:path", 39 | cors: true 40 | }, 41 | function(gw) { 42 | console.log(gw) 43 | console.log("gw.method:" +gw.method) 44 | if (gw.pathParams.path === "") { 45 | if (gw.method === "POST") { 46 | 47 | controlPeliculas.sumarPelicula(gw); 48 | } else if (gw.method === "GET"){ 49 | controlPeliculas.mostrarPeliculas(gw); 50 | } else { 51 | gw.error(405); 52 | } 53 | } else { 54 | if (gw.method === "GET") { 55 | controlPeliculas.buscarPeliculaID(gw); 56 | } else if (gw.method === "PUT") { 57 | controlPeliculas.actualizarPelicula(gw); 58 | } else if (gw.method === "DELETE") { 59 | controlPeliculas.borrarPelicula(gw); 60 | } else { 61 | gw.error(405); 62 | } 63 | } 64 | 65 | }); 66 | 67 | // Rutas FRONT 68 | var rutaFront = new Route({ 69 | id: "index", 70 | path: "/" 71 | }, 72 | function(gw) { 73 | controlIndex.mostrarIndex(gw); 74 | }); 75 | 76 | var rutaEstaticos = new Route({ 77 | id: 'estaticos', 78 | path: '/*:path', 79 | directory: { 80 | path: './publico', 81 | listing: true 82 | } 83 | }); 84 | 85 | // Rutas 86 | project.routes.add(rutaApiPeliculas); 87 | project.routes.add(rutaApi); 88 | project.routes.add(rutaFront); 89 | project.routes.add(rutaEstaticos); -------------------------------------------------------------------------------- /vistas/index.jade: -------------------------------------------------------------------------------- 1 | doctype html 2 | html 3 | head 4 | meta(charset='utf-8') 5 | meta(http-equiv='X-UA-Compatible', content='IE=edge') 6 | meta(name='viewport', content='width=device-width, initial-scale=1') 7 | title Movie Fire 8 | link(rel='stylesheet', href='//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css') 9 | link(rel='stylesheet', type='text/css', href='css/index.css') 10 | body 11 | .container 12 | .text-center 13 | h1 14 | span.glyphicon.glyphicon-film(aria-hidden='true') 15 | | Movie Fire 16 | h3 Guarda tus peliculas favoritas con todo detalle 17 | hr 18 | .input-group 19 | input#movieName.form-control(type='text', placeholder='Escribe el nombre de una pelicula', onkeypress='return saveToList(event)') 20 | hr 21 | #favMovies Cargando.. 22 | #movieDetails 23 | // Modal 24 | #detallesModal.modal.fade(tabindex='-1', role='dialog', aria-labelledby='detallesModalLabel') 25 | .modal-dialog(role='document') 26 | .modal-content 27 | .modal-header 28 | button.close(type='button', data-dismiss='modal', aria-label='Close') 29 | span(aria-hidden='true') × 30 | h4#detallesModalLabel.modal-title 31 | .modal-body 32 | #imagenDetalles.col-md-6 33 | #textoDetalles.col-md-6 34 | .modal-footer 35 | button.btn.btn-default(type='button', data-dismiss='modal') Cerrar 36 | script(type='text/javascript', src='https://cdn.firebase.com/js/client/1.0.15/firebase.js') 37 | script(src='//ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js') 38 | script(src='//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js') 39 | script(type='text/javascript', src='js/index.js') 40 | --------------------------------------------------------------------------------