insitu-js 0.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,110 @@
+# Changelog
+
+Todos los cambios relevantes de este framework se documentan en este archivo.
+El versionado sigue SemVer (MAJOR.MINOR.PATCH).
+
+---
+
+## [1.0.1] - 2026-02-13
+
+### Refactorización DRY y Mejoras en el WAF - Insitu Framework
+
+#### Archivo Nuevo: `lib/utils/executeMiddleware.js`
+- Creación del módulo centralizado `executeMiddleware` para la ejecución de middlewares
+- Implementación del método reutilizable `executeMiddleware(middleware, req, res, nextFn = null)` con manejo de promesas
+
+#### Archivos Modificados:
+- `lib/core/server.js`
+- `lib/loader/routeLoader.js`
+- `lib/core/router.js`
+- `lib/security/globalWAFStats.js`
+- `lib/security/firewall.js`
+- `lib/admin/modules/WAFModule.js`
+
+#### Implementación de Método Centralizado executeMiddleware
+- Eliminación de múltiples instancias de código repetido para ejecución de middlewares
+- Reemplazo de lógica local con importación y uso del módulo centralizado
+- Actualización del método `use` en el router para usar el método centralizado
+- Implementación de definición dinámica de métodos HTTP en el router
+
+#### Implementación de Funcionalidades de Log y Monitor en el WAF
+- Añadida propiedad `monitoredRequests` al objeto global de estadísticas del WAF
+- Implementación completa de la acción "monitor" en el middleware de firewall
+- Almacenamiento de solicitudes monitoreadas en el mapa global `monitoredRequests`
+- Añadido comando `waf-monitored` al módulo de administración WAF
+- Implementación del método `showMonitoredRequests()` para mostrar solicitudes monitoreadas
+- Actualización del comando `waf-logs` para mostrar solicitudes registradas con acción "log"
+
+#### Aplicación del Principio DRY (Don't Repeat Yourself)
+- Creación del método `createAuthenticatedHandler()` para manejar lógica de autenticación
+- Implementación de métodos para respuestas HTTP comunes (`sendJsonResponse()`, `sendForbiddenResponse()`, `sendNotFoundResponse()`, `sendRequestTooLargeResponse()`)
+- Uso del método reutilizable `handleError()` en lugar de llamar directamente a ErrorHandler.handle()
+
+#### Mejoras en el Manejo de Errores y Configuración
+- Centralización del manejo de errores con el método `handleError()`
+- Creación del método `isJsonRequest()` para verificar tipo de contenido
+- Implementación del método `setStaticFileHeaders()` para configurar headers de archivos estáticos
+
+#### Optimizaciones de Estadísticas y Hooks
+- Método `setupResponseCapture()` para capturar datos de respuesta para estadísticas
+- Método `updateRequestProcessingStats()` para actualizar estadísticas de procesamiento
+- Método `registerRouteAndEndpointStats()` para registrar estadísticas de acceso
+- Métodos para manejar eventos de hooks de solicitud (`handleRouteMatched()`, `handleMiddlewareResponseFinished()`)
+
+#### Mejoras en Verificaciones y Validaciones
+- Método `isMiddlewareFunction()` para verificar si un middleware es una función
+- Método `isAsyncFunction()` para verificar si una función es asíncrona
+
+#### Beneficios Obtenidos
+- Eliminación significativa de código duplicado
+- Mejor mantenibilidad: cambios en lógica común solo se realizan en un lugar
+- Mayor consistencia en el manejo de operaciones repetitivas
+- Funcionalidad completa de las acciones "log" y "monitor" en el WAF
+- Almacenamiento eficiente de solicitudes registradas y monitoreadas
+- Visibilidad mejorada a través de comandos específicos (`waf-logs`, `waf-monitored`)
+- Reducción de posibles errores por inconsistencias
+- Claridad mejorada del código
+
+---
+
+## [1.0.0] - 2026-02-12
+
+### Consolidated Release - Insitu Framework
+
+#### Framework Renaming
+- Cambio de nombre del framework de "JERK Framework" a "Insitu Framework"
+- Actualización de todos los nombres de paquetes, referencias y documentación
+- Renombrado de archivos y directorios relacionados con el antiguo nombre
+
+#### Version Standardization
+- Consolidación de todas las versiones anteriores a la versión única 1.0.0
+- Actualización de todos los números de versión en comentarios, documentación y código
+- Unificación de la numeración de versiones en todos los componentes
+
+#### Architecture & Core Features
+- Sistema de enrutamiento avanzado con soporte para rutas estáticas y parametrizadas
+- Arquitectura modular con componentes desacoplados
+- Sistema de hooks y filters para extensibilidad
+- Motor de vistas con soporte para includes, variables y filtros
+- Sistema de modelos con soporte para diferentes adaptadores (memoria, MariaDB, SQLite)
+
+#### Security & Performance
+- Firewall WAF integrado con reglas configurables
+- Sistema de autenticación con múltiples estrategias (JWT, API Keys, Sesiones)
+- Sistema de sesiones con cookies seguras
+- Optimizaciones de rendimiento con índices y caché
+- Protección contra ataques XSS y SQL Injection
+
+#### Administration & Monitoring
+- Extensión de administración con servidor TCP local
+- Módulos de administración para gestión de rutas, vistas y estadísticas
+- Sistema de colas con soporte para múltiples colas concurrentes
+- Monitorización en tiempo real de métricas del servidor
+
+#### Development Experience
+- CLI de administración con autocompletado
+- Generador interactivo de controladores
+- Carga de rutas desde archivos JSON o programáticamente
+- Documentación completa y ejemplos de uso
+
+---

package/CREACION_DE_CONTROLADORES_INSITU.md

@@ -0,0 +1,383 @@
+# Guía para Crear Controladores en el Framework Insitu
+
+## Introducción
+
+Los controladores en el framework Insitu son componentes fundamentales que forman parte del patrón MVC (Modelo-Vista-Controlador). Son responsables de manejar las solicitudes HTTP, interactuar con los modelos para obtener o manipular datos, y devolver respuestas apropiadas al cliente.
+
+## Estructura Básica de un Controlador
+
+Un controlador en Insitu debe extender la clase `ControllerBase` que proporciona funcionalidades comunes como:
+
+- Manejo de vistas y motores de plantillas
+- Acceso a datos de solicitud (query, body, params)
+- Métodos para respuesta (JSON, vistas, redirecciones)
+- Carga y manejo de modelos
+
+### Ejemplo Básico de Controlador
+
+```javascript
+const { ControllerBase } = require('insitu');
+
+class EjemploController extends ControllerBase {
+  constructor() {
+    super();
+  }
+
+  // Método para manejar una solicitud GET
+  async index(req, res) {
+    // Establecer variables para la vista
+    this.set('titulo', 'Página de Inicio');
+    this.set('mensaje', '¡Bienvenido al framework Insitu!');
+
+    // Renderizar una vista
+    this.render(res, 'inicio', {
+      usuario: 'Desarrollador',
+      fecha: new Date().toISOString()
+    });
+  }
+
+  // Método para manejar una solicitud POST
+  async crear(req, res) {
+    const datos = req.body;
+    
+    // Aquí iría la lógica para crear un recurso
+    // Por ejemplo, usando un modelo
+    
+    this.json(res, {
+      success: true,
+      message: 'Recurso creado exitosamente',
+      data: datos
+    });
+  }
+}
+
+module.exports = EjemploController;
+```
+
+## Componentes Importantes
+
+### ControllerBase
+
+La clase base `ControllerBase` proporciona varios métodos útiles:
+
+- `set(key, value)` - Establece variables para la vista
+- `view(viewName, data, options)` - Renderiza una vista sin enviarla como respuesta
+- `render(res, viewName, data, options)` - Renderiza una vista y la envía como respuesta HTTP
+- `partial(viewName, data)` - Renderiza una vista parcial (sin layout)
+- `redirect(res, url)` - Redirecciona a otra URL
+- `json(res, data, statusCode)` - Envía una respuesta JSON
+- `input(key, defaultValue)` - Obtiene un valor de la solicitud (query, body o params)
+- `loadModel(modelName, options)` - Carga un modelo para su uso en el controlador
+
+### Interacción con Modelos
+
+Los controladores pueden interactuar con modelos para gestionar datos:
+
+```javascript
+const { ControllerBase } = require('insitu');
+
+class UsuarioController extends ControllerBase {
+  constructor() {
+    super();
+  }
+
+  async listar(req, res) {
+    try {
+      // Cargar el modelo de usuario
+      const userModel = this.loadModel('User');
+      
+      // Obtener todos los usuarios
+      const usuarios = await userModel.find({});
+      
+      // Pasar los usuarios a la vista
+      this.set('usuarios', usuarios);
+      this.render(res, 'usuarios/lista');
+    } catch (error) {
+      this.json(res, { error: error.message }, 500);
+    }
+  }
+
+  async crear(req, res) {
+    try {
+      const userData = req.body;
+      
+      // Cargar el modelo de usuario
+      const userModel = this.loadModel('User');
+      
+      // Crear un nuevo usuario
+      const nuevoUsuario = await userModel.create(userData);
+      
+      this.json(res, {
+        success: true,
+        data: nuevoUsuario
+      }, 201);
+    } catch (error) {
+      this.json(res, { error: error.message }, 500);
+    }
+  }
+}
+
+module.exports = UsuarioController;
+```
+
+## Definición de Rutas
+
+Para conectar tus controladores con rutas, puedes usar el sistema de enrutamiento de Insitu:
+
+### En un archivo de rutas (por ejemplo, routes.json):
+
+```json
+{
+  "routes": [
+    {
+      "method": "GET",
+      "path": "/usuarios",
+      "handler": "./controllers/UsuarioController.listar"
+    },
+    {
+      "method": "POST",
+      "path": "/usuarios",
+      "handler": "./controllers/UsuarioController.crear"
+    },
+    {
+      "method": "GET",
+      "path": "/usuarios/:id",
+      "handler": "./controllers/UsuarioController.obtenerPorId"
+    }
+  ]
+}
+```
+
+### O directamente en tu código de inicialización:
+
+```javascript
+const { Insitu, Router } = require('insitu');
+const UsuarioController = require('./controllers/UsuarioController');
+
+const app = new Insitu();
+const router = new Router();
+
+const usuarioController = new UsuarioController();
+
+router.get('/usuarios', (req, res) => {
+  usuarioController.listar(req, res);
+});
+
+router.post('/usuarios', (req, res) => {
+  usuarioController.crear(req, res);
+});
+
+app.use(router);
+
+app.listen(3000, () => {
+  console.log('Servidor corriendo en puerto 3000');
+});
+```
+
+### Importante: Manejo de Contexto de los Métodos
+
+Cuando se exportan métodos de un controlador para ser usados como handlers de rutas, es crítico mantener el contexto `this` correcto. Si no se hace correctamente, métodos como `this.json()`, `this.set()`, `this.input()`, etc., no funcionarán.
+
+**Forma Incorrecta:**
+```javascript
+// Esto causará un error "Cannot read property 'json' of undefined"
+module.exports = new UsuarioController();
+```
+
+**Forma Correcta:**
+```javascript
+// Crear una instancia del controlador
+const usuarioController = new UsuarioController();
+
+// Asegurar que todos los métodos tengan el contexto correcto
+module.exports = {
+  listar: usuarioController.listar.bind(usuarioController),
+  crear: usuarioController.crear.bind(usuarioController),
+  obtenerPorId: usuarioController.obtenerPorId.bind(usuarioController)
+};
+```
+
+Esto es necesario porque cuando el cargador de rutas obtiene una función específica de un objeto y la llama directamente, pierde el contexto `this`. Usando `.bind()`, nos aseguramos de que `this` siempre se refiera a la instancia correcta del controlador.
+```
+
+## Buenas Prácticas
+
+### 1. Organización de Archivos
+
+Organiza tus controladores en una estructura de directorios clara:
+
+```
+proyecto/
+├── controllers/
+│   ├── UsuarioController.js
+│   ├── ProductoController.js
+│   └── HomeController.js
+├── models/
+│   ├── User.js
+│   └── Product.js
+├── views/
+│   ├── home/
+│   │   └── index.html
+│   └── usuarios/
+│       ├── lista.html
+│       └── detalle.html
+└── routes/
+    └── routes.json
+```
+
+### 2. Manejo de Errores
+
+Siempre implementa manejo de errores adecuado:
+
+```javascript
+async listar(req, res) {
+  try {
+    const modelo = this.loadModel('MiModelo');
+    const datos = await modelo.find({});
+    this.json(res, { success: true, data: datos });
+  } catch (error) {
+    console.error('Error en listar:', error);
+    this.json(res, { 
+      success: false, 
+      error: 'Ocurrió un error al procesar la solicitud' 
+    }, 500);
+  }
+}
+```
+
+### 3. Validación de Datos
+
+Utiliza el middleware de validación de Insitu para validar entradas:
+
+```javascript
+const { Validator } = require('insitu');
+
+// En tu archivo de rutas
+router.post('/usuarios', 
+  Validator.validate({
+    body: {
+      nombre: { type: 'string', required: true, minLength: 2 },
+      email: { type: 'string', required: true, format: 'email' },
+      edad: { type: 'number', min: 0, max: 120 }
+    }
+  }),
+  (req, res) => {
+    usuarioController.crear(req, res);
+  }
+);
+```
+
+### 4. Uso de Métodos HTTP Apropiados
+
+Sigue las convenciones REST para el uso de métodos HTTP:
+
+- `GET` - Obtener recursos
+- `POST` - Crear nuevos recursos
+- `PUT/PATCH` - Actualizar recursos existentes
+- `DELETE` - Eliminar recursos
+
+## Ejemplo Completo
+
+Aquí tienes un ejemplo completo de un controlador para gestionar productos:
+
+```javascript
+const { ControllerBase } = require('insitu');
+
+class ProductoController extends ControllerBase {
+  constructor() {
+    super();
+  }
+
+  // Obtener todos los productos
+  async listar(req, res) {
+    try {
+      const productoModel = this.loadModel('Producto');
+      const productos = await productoModel.find({});
+      
+      this.set('productos', productos);
+      this.set('titulo', 'Lista de Productos');
+      this.render(res, 'productos/lista');
+    } catch (error) {
+      this.json(res, { error: error.message }, 500);
+    }
+  }
+
+  // Obtener un producto por ID
+  async obtenerPorId(req, res) {
+    try {
+      const id = this.input('id');
+      const productoModel = this.loadModel('Producto');
+      const producto = await productoModel.findOne({ id: parseInt(id) });
+      
+      if (!producto) {
+        res.writeHead(404, { 'Content-Type': 'application/json' });
+        res.end(JSON.stringify({ error: 'Producto no encontrado' }));
+        return;
+      }
+      
+      this.json(res, { success: true, data: producto });
+    } catch (error) {
+      this.json(res, { error: error.message }, 500);
+    }
+  }
+
+  // Crear un nuevo producto
+  async crear(req, res) {
+    try {
+      const productoData = this.allInput();
+      const productoModel = this.loadModel('Producto');
+      const nuevoProducto = await productoModel.create(productoData);
+      
+      this.json(res, { 
+        success: true, 
+        data: nuevoProducto 
+      }, 201);
+    } catch (error) {
+      this.json(res, { error: error.message }, 500);
+    }
+  }
+
+  // Actualizar un producto
+  async actualizar(req, res) {
+    try {
+      const id = this.input('id');
+      const productoData = this.allInput();
+      const productoModel = this.loadModel('Producto');
+      
+      const resultado = await productoModel.update({ id: parseInt(id) }, productoData);
+      
+      this.json(res, { 
+        success: true, 
+        message: 'Producto actualizado',
+        affectedRows: resultado
+      });
+    } catch (error) {
+      this.json(res, { error: error.message }, 500);
+    }
+  }
+
+  // Eliminar un producto
+  async eliminar(req, res) {
+    try {
+      const id = this.input('id');
+      const productoModel = this.loadModel('Producto');
+      
+      const resultado = await productoModel.delete({ id: parseInt(id) });
+      
+      this.json(res, { 
+        success: true, 
+        message: 'Producto eliminado',
+        deletedRows: resultado
+      });
+    } catch (error) {
+      this.json(res, { error: error.message }, 500);
+    }
+  }
+}
+
+module.exports = ProductoController;
+```
+
+## Conclusión
+
+Crear controladores en el framework Insitu es sencillo gracias a la clase `ControllerBase` que proporciona funcionalidades comunes. Recuerda seguir las buenas prácticas para mantener tu código limpio, seguro y mantenible. La arquitectura MVC del framework te permite separar claramente la lógica de negocio (modelos), la presentación (vistas) y el flujo de control (controladores).

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.