Skip to content

PROJECT.md

Latest commit

 

History

History
197 lines (143 loc) · 6.2 KB

PROJECT.md

File metadata and controls

197 lines (143 loc) · 6.2 KB
Raw

Drive Store API

Summary

  1. Global View
    1. Global application
    2. Workflow
  2. Zoom on the API
    1. General
    2. Configuration
    3. Dependencies
    4. Contexts available
      1. Path /companies
  3. Dependencies
  4. Run the app
    1. Quickstart
  5. Production eligibility
    1. Application
    2. Reverse Proxy
    3. Resiliency

Global View

Global application

This application is part of a fullchain applications which have the goal to provide the best product prices from all drive stores for a registered cart.

Workflow

To provide a structured data requestable application a chain of steps is required. This chain catch the raw data and store it in a structured way. This data is thus queryable and optimized for processing.

You can find a quick sight of the Data Journey below.

Global application schema

                                                             Customer  
                                                                 |     
                                                                 |     
+-------------+      +--------------+      +---------+      +---------+
|   Scraper   |------|   Database   |------|   Api   |------|   Gui   |
+------+------+      +--------------+      +---------+      +---------+
       |                                                               
       |                                                               
  Drive Stores                                                         
 +----+                                                                 
 |   +----+                                                             
 +---|   +----+                                                         
     +---|    |                                                         
         +----+

Quick description of each step :

  • Scraper : Catches product prices,
  • Database : Stores product prices, Database is MongoDB,
  • Api : Provides REST Api to process/read Product Prices,
  • Gui : Offers a interface to interact with the Api.

Zoom on the API

General

The aim of the api is to provides a endpoint in order to retrieve informations about product prices in time (last entry or history) and to call processing functions making correlation between products and Drive Stores.

The API application only requests the database to process on product prices from different Drive Stores.

The API is RESTful and follow the norm.

The NoSQL database used is MongoDB.

Configuration

All the application configuration is stored in the conf/ directory.

While dev is starting database is hard-coded to localhost.

Dependencies

Code run from Visual Studio Code 2017 with Python and C++ environements configured. Python version selected is python-3.6 because of dependencies with scrapy package (not compatible with python-3.7 yet).

MongoDB database is used.

Required python libs :

  • pywin32 (Visual Studio)
  • pymongo

Contexts available

Path /companies

These are all available methods provided for the context /companies:

/companies/
  • Method: GetCompanies
  • Description: List the companies
/companies/<company_name>
  • Method: getCompanyByName
  • Description: Show the company informations
/companies/<company_name>/products
  • Method: getCompanyProducts
  • Description: List the products of the company
/companies/<company_name>/products/<product_name>
  • Method: getCompanyProductByName
  • Description: Show the product informations
/companies/<company_name>/products/<product_name>/best-price
  • Method: getCompanyProductBestPrice
  • Description: Show the company location to get best price for the product
/companies/<company_name>/products/<product_name>/locations
  • Method: getCompanyProductLocations
  • Description: List the company locations where to find the product
/companies/<company_name>/products/<product_name>/locations/<location_name>
  • Method: getCompanyProductLocationByName
  • Description: Show the product informations for the company location
/companies/<company_name>/products/<product_name>/locations/<location_name>/price-history
  • Method: getCompanyProductLocationPriceHistory
  • Description: Show the product price history for the company location
/companies/<company_name>/locations
  • Method: getCompanyLocations
  • Description: List the company locations
/companies/<company_name>/locations/<location_name>
  • Method: getCompanyLocationByName
  • Description: Show the information for the company location
/companies/<company_name>/locations/<location_name>/products
  • Method: getCompanyLocationProducts
  • Description: List the products for the company location
/companies/<company_name>/locations/<location_name>/products/<product_name>
  • Method: getCompanyLocationProductByName
  • Description: Show the product informations for the company location
/companies/<company_name>/locations/<location_name>/products/<product_name>/price-history
  • Method: getCompanyLocationPriceHistory
  • Description: Show the product price history for the company location

Run the app

Quickstart

python manage.py runserr 0.0.0.0:80

Production eligibility

The application don't have to be run as it is on production server. You need to tune some stuff to make it eligible to Production environment.

Application

You need to tune the app to reduce the loglevel.

Reverse Proxy

You need to run the app behind a Reverse Proxy to protect it from Hack and DDoS. You can choose between Apache and NGinx to shield your app. Mind to tune your Middleware to deactivate all banners and version displaying.

Resiliency

To allow a large amount of connection of the application you need to dispatch requests on multiple servers. You need to pop up several servers with the app and balance all requests on them.

The RESTful property of the app allow it to be deployed on servers without configuring anything (or almost).