productManager

Este proyecto contiene dos componente:

1. productManager-api-rest: (backend) API Rest .
2. productManager-web: (frontend) Una aplicación que exponé una página web la cual permite consultar la lista de ordenes asociadas a un cliente en el último mes.

Pagina web

La pagina web esta implementada en html y usa Angular.

1. Permite seleccionar un cliente y presentar las órdenes del último mes usando el método listar órdenes del servicio web.

La aplicación esta desplegada en la siguiente URL:

http://18.216.163.175:8080/productManager-web/

API Rest

La API Rest esta implementada en Spring y Hibernate. Expone las siguientes funcionalidas:

1. Consultar el listado de clientes.

2. Permite crear una órden para un cliente con hasta máximo 5 productos. Teniendo en cuenta que sólo algunos productos están permitidos para un cliente.

3. Permite listar las órdenes de un cliente por un rango de fechas.

Para mas detalle ver ejemplos en la parte inferior y ver archivo PDF de la documentación de la API :

La aplicación esta desplegada en una instancia de EC2 Amazon y esta es la URL: http://18.216.163.175:8080/productManager-api-rest/v1/customer/1/order?fromDate=2017-09-26&untilDate=2017-10-26

Instalación y despliegue

Generación de WAR

Los proyectos usan Maven para la gestión de librerías o dependencias por lo tanto para crear el war es necesario ejecutar el comando:

mvn install

Para el caso del proyecto API REST:

{RELATIVE_DIRECTORY}/productManager-SpringRestApi-Angular/productManager-api-rest$ mvn install

Configuración de conexión hacia la base de datos Mysql

También es necesario crear la base de datos y la configuración de la conexión esta en el properites:

{RELATIVE_DIRECTORY}/productManager-api-rest/src/main/resources/ProductManager.properties

Es necesario configurar las siguientes propiedades del archivo ProductManager.properties:

datasource.driverClassName=com.mysql.jdbc.Driver
datasource.url=jdbc:mysql://[host_name]:[port]/beitech_db
datasource.username=[USER]
datasource.password=[PASSWORD]

Los scripts están al final de esta página.

Diagrama entidad relación

Componentes

Frontend: productManager-web

• Angular, html

Backend: productManager-api-rest

• Spring, Hibernate

Ejemplos API Rest

Create order

URL [/v1/order]http://18.216.163.175:8080/productManager-api-rest/v1/order)

Method The request type POST

Version 1.0

Ejemplo:

http://ec2-52-14-66-207.us-east-2.compute.amazonaws.com:8080/productManager-api-rest/v1/order

{
  "order": { 
    "deliveryAddress": "15 Queens Park Road, W32 YYY, UK", 
    "customer": {
      "customerId": 1
    }
  },
  "orderProducts": [
    {
      "productId": 1
    }, 
        {
      "productId": 2
    }, 
        {
      "productId": 2
    }, 
        {
      "productId": 3
    }
    
  ]
}

Success Response The order was created.

Code: 200 Content:

{
    "description": "OK",
    "code": 200
}

Error Response

• Validate the maximum products Example: Code: 400 BAD_REQUEST Content:

{
    "description": "The amount of products must be less or equal to 5",
    "code": 400
}

• Not available products by Customer Example: Code: 400 BAD_REQUEST Content:

{
    "description": "The product with id 4  is not available for  'Manny Bharma '",
    "code": 400
}

Get orders by Customer and Date

URL /v1/customer/:id/order?fromDate=:fromDate&untilDate=:untilDate

Method The request type GET

Version 1.0

http://ec2-52-14-66-207.us-east-2.compute.amazonaws.com:8080/productManager-api-rest/v1/customer/1/order?fromDate=2017-09-26&untilDate=2017-10-26

• The order was found.

Code: 200 Content:

{
   "customerId": 1,
   "email": "manny@Bharma.com",
   "name": "Manny Bharma",
   "availableProducts": [
       {
           "productId": 1,
           "name": "Product A",
           "price": 100.05
       },
       {
           "productId": 2,
           "name": "Product B",
           "price": 200.1
       },
       {
           "productId": 3,
           "name": "Product C",
           "price": 300.05
       }
   ],
   "orders": [
       {
           "orderId": 1,
           "deliveryAddress": "15 Queens Park Road, W32 YYY, UK",
           "orderTime": "2017-10-26",
           "orderDetails": [
               {
                   "orderDetailId": 1,
                   "price": 200.1,
                   "productDescription": "2 X Product A"
               },
               {
                   "orderDetailId": 2,
                   "price": 200.1,
                   "productDescription": "1 X Product B"
               },
               {
                   "orderDetailId": 3,
                   "price": 300.05,
                   "productDescription": "1 X Product C"
               }
           ],
           "totalPrice": 700.25
       },
       {
           "orderId": 2,
           "deliveryAddress": "15 Queens Park Road, W32 YYY, UK",
           "orderTime": "2017-10-26",
           "orderDetails": [
               {
                   "orderDetailId": 4,
                   "price": 100.05,
                   "productDescription": "1 X Product A"
               },
               {
                   "orderDetailId": 5,
                   "price": 200.1,
                   "productDescription": "1 X Product B"
               },
               {
                   "orderDetailId": 6,
                   "price": 600.1,
                   "productDescription": "2 X Product C"
               }
           ],
           "totalPrice": 900.25
       },
       {
           "orderId": 5,
           "deliveryAddress": "15 Queens Park Road, W32 YYY, UK",
           "orderTime": "2017-10-27",
           "orderDetails": [
               {
                   "orderDetailId": 9,
                   "price": 100.05,
                   "productDescription": "1 X Product A"
               },
               {
                   "orderDetailId": 10,
                   "price": 200.1,
                   "productDescription": "1 X Product B"
               }
           ],
           "totalPrice": 300.15
       },
       {
           "orderId": 6,
           "deliveryAddress": "15 Queens Park Road, W32 YYY, UK",
           "orderTime": "2017-10-27",
           "orderDetails": [
               {
                   "orderDetailId": 11,
                   "price": 100.05,
                   "productDescription": "1 X Product A"
               },
               {
                   "orderDetailId": 12,
                   "price": 400.2,
                   "productDescription": "2 X Product B"
               },
               {
                   "orderDetailId": 13,
                   "price": 300.05,
                   "productDescription": "1 X Product C"
               }
           ],
           "totalPrice": 800.3
       },
       {
           "orderId": 7,
           "deliveryAddress": "15 Queens Park Road, W32 YYY, UK",
           "orderTime": "2017-10-27",
           "orderDetails": [
               {
                   "orderDetailId": 14,
                   "price": 100.05,
                   "productDescription": "1 X Product A"
               },
               {
                   "orderDetailId": 15,
                   "price": 400.2,
                   "productDescription": "2 X Product B"
               },
               {
                   "orderDetailId": 16,
                   "price": 300.05,
                   "productDescription": "1 X Product C"
               }
           ],
           "totalPrice": 800.3
       }
   ]
}

Página web

http://18.216.163.175:8080/productManager-web/

Script base de datos Mysql

create database beitech_db;

use beitech_db;

/** Esto es un ejemplo del usuario que debe corresponder al archivo properties
/productManager-api-rest/src/main/resources/ProductManager.properties
*/ 
CREATE USER 'beithecUser'@'localhost' IDENTIFIED BY 'TEST-2017';
GRANT ALL PRIVILEGES ON beitech_db. * TO 'beithecUser'@'localhost';

CREATE TABLE IF NOT EXISTS `product` (
 `product_id` INT(11) NOT NULL AUTO_INCREMENT,
 `name` VARCHAR(255) NOT NULL,
 `price` DECIMAL(10,3) NOT NULL,
 PRIMARY KEY (`product_id`));

CREATE TABLE `customer` (
 `customer_id` INT(11) NOT NULL AUTO_INCREMENT,
 `name` VARCHAR(255) NOT NULL,
 `email` VARCHAR(255) NOT NULL,
 PRIMARY KEY (`customer_id`));


create table `order_`(
   order_id int not null auto_increment,  
   customer_id int not null,  
   order_time datetime not null, 
   delivery_address varchar(255) not null, 
   primary key(order_id), index(customer_id), 
   FOREIGN key (customer_id) references customer(customer_id)) ;

CREATE TABLE IF NOT EXISTS `customer_available_product` (
 `customer_id` INT(11) NOT NULL,
 `product_id` INT(11) NOT NULL,
PRIMARY KEY (`customer_id`,`product_id`),
 CONSTRAINT `customer_product_ibfk_1`
   FOREIGN KEY (`customer_id`)
   REFERENCES `customer` (`customer_id`),
 CONSTRAINT `customer_product_ibfk_2`
   FOREIGN KEY (`product_id`)
   REFERENCES `product` (`product_id`));


CREATE TABLE IF NOT EXISTS `order_detail` (
 `order_detail_id` INT(11) NOT NULL AUTO_INCREMENT,
 `product_description` VARCHAR(255) NOT NULL,
 `price` DECIMAL(10,3) NOT NULL,
 `order_id` INT(11) NOT NULL,
  PRIMARY KEY (`order_detail_id`),
 INDEX `order_id` (`order_id` ASC),
 CONSTRAINT `order_detail_ibfk_1`
   FOREIGN KEY (`order_id`)
   REFERENCES `order_` (`order_id`));



INSERT INTO `customer` (`customer_id`, `name`, `email`) VALUES (1, 'Manny Bharma', 'manny@Bharma.com');
INSERT INTO `customer` (`customer_id`, `name`, `email`) VALUES (2, 'Alan Briggs', 'alan@Briggs.com');
INSERT INTO `customer` (`customer_id`, `name`, `email`) VALUES (3, 'Mike Simm', 'mike@Simm.com');

INSERT INTO `product` (`product_id`, `name`, `price`) VALUES (1, 'Product A', 100.05);
INSERT INTO `product` (`product_id`, `name`, `price`) VALUES (2, 'Product B', 200.10);
INSERT INTO `product` (`product_id`, `name`, `price`) VALUES (3, 'Product C', 300.05);
INSERT INTO `product` (`product_id`, `name`, `price`) VALUES (4, 'Product D', 400.25);

INSERT INTO `customer_available_product` (`customer_id`, `product_id`) VALUES (1, 1);
INSERT INTO `customer_available_product` (`customer_id`, `product_id`) VALUES (1, 2);
INSERT INTO `customer_available_product` (`customer_id`, `product_id`) VALUES