Mimesis: Mimesis Simple HTTP Server

[duckyou]

Implement very simple http server like in module http.server, which returns generated data by mimesis.

The idea is to pass template in header, and ignore body and query arguments, for future integration with another server.

For example:

Template:

{
  "id": ":uuid",
  "version": "0.1.2",
  "owner.full_name": ":name :personal.surname",
  "owner.email": {"_type": "str", "_field": ":email", "_key": "lower"},
  "owner.phones": {"_type": "list", "_count": 5, "_field": [":telephone", "other1", "other2"]}
}

Output:

{
  "id": "dfcfd2f3-0799-b519-1a94-326c978b10c6",
  "version": "0.1.2",
  "owner": {
    "full_name": "Charley Parker",
    "email": "[email protected]",
    "phones": ["776.907.0588", "717.592.4382", "168.028.7210", "other1", "other2"]
  }
}

Or we can implement something like jinja2 templating system for open customize output

Some header examples:

• Mimesis-Template - Template for response
• Mimesis-Count - Count of outputs. Default: 0
  
  
  
  • 0 - Response contain object.
  
  
  • 1-99 - Response contain array of objects.
  
  
• Mimesis-Locale - Response locale. Default: en

It's may be helpful for prototyping some RESTful/GRAPHql api.

[sobolevn]

Why not use mimesis-cloud? https://github.com/wemake-services/mimesis-cloud
That's exactly what it should do.

[lk-geimfari]

@duckyou Do you have checked out mimesis-cloud? Is it suitable? If yes, then I suggest improving mimesis-cloud.

[lk-geimfari]

Let's improving mimesis-cloud and add a section about it to documentation.

[duckyou]

@sobolevn @lk-geimfari Heres what i mean:

HTTP Requests:

Get 100 users:

Request:

GET /api/users?count=100 HTTP/1.1
Host: localhost:8000
Mimesis-Template: {"id": ":uuid", "email": ":email"}
Mimesis-Locale: en
Mimesis-Count: 100
Cache-Control: no-cache

Response:

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 100500
Content-Type: application/json
Date: Tue, 13 Feb 2018 13:12:25 GMT
Server: Mimesis Server

[
  {"id": "dfcfd2f3-0799-b519-1a94-326c978b10c6", "email": "[email protected]"},
  {"id": "dfcfd2f3-0799-b519-1a94-326c978b10c7", "email": "[email protected]"},
  {"id": "dfcfd2f3-0799-b519-1a94-326c978b10c8", "email": "[email protected]"},
  ...
]

Add 1 user

Request:

POST /api/users HTTP/1.1
Host: localhost:8000
Mimesis-Template: {"id": ":uuid", "email": "[email protected]"}
Mimesis-Locale: en
Mimesis-Count: 0
Content-Type: application/json

{
    "email": "[email protected]"
}

Response:

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 40
Content-Type: application/json
Date: Tue, 13 Feb 2018 13:16:06 GMT
Server: Mimesis Server

{"id": "dfcfd2f3-0799-b519-1a94-326c978b10c9", "email": "[email protected]"}

Mimesis-Cloud using only graphql, if I understand correctly.

[lk-geimfari]

@duckyou Can we do it without extra-requirements? If not, then I suggest do it as another package.

[duckyou]

@lk-geimfari, yes. It can be done without third-party modules ^^

[lk-geimfari]

@duckyou Let's try to do it in module mimesis.http, branch server.

[lk-geimfari]

Of course, if @sobolevn don't mind against.

[duckyou]

@lk-geimfari maybe better mimesis.server?
And when it will be done, we can run it like python -m mimesis.server?

We also need to discuss the template system in more detail.

[lk-geimfari]

@duckyou Sure!

[lk-geimfari]

@duckyou Illustrate your simple working demo version and we will be thinking about improving it together.

[sobolevn]

@duckyou nope, mimesis-cloud supports any kind of http requests: rest, graphql, whatever other.

I am strongly against adding this kind of functionality to the core package.
Main reasons is over complicating functionality. One library should do one thing and do it well.

[lk-geimfari]

In general, I agree with @sobolevn.

I thought, and it seems to me that we will greatly complicate the support of the project if we add such resource-intensive features to one project, so it's better to create a different repository for it or something like this. Let this be an experimental project in another repository. What do you think?

[lk-geimfari]

@duckyou I have created mimesis-mock-server. Feel free to rename it.

[lk-geimfari]

Or (better) we can improve existing project mimesis-cloud.

[sobolevn]

+1 for improving mimesis-cloud.

[duckyou]

@lk-geimfari @sobolevn , here's an alpha realisation: https://github.com/duckyou/mimesis/tree/http-server

How to get:

git clone -b http-server https://github.com/duckyou/mimesis && cd mimesis
python -m mimesis.server

   _____ _               _
  |     |_|_____ ___ ___|_|___
  | | | | |     | -_|_ -| |_ -|
  |_|_|_|_|_|_|_|___|___|_|___|
   _____ _____ _____ _____    _____
  |  |  |_   _|_   _|  _  |  |   __|___ ___ _ _ ___ ___
  |     | | |   | | |   __|  |__   | -_|  _| | | -_|  _|
  |__|__| |_|   |_| |__|     |_____|___|_|  \_/|___|_|   v0.0.4

  Easy way to GET mock data at http://0.0.0.0:8080 ...

Now we can request data:

import json
import requests

url = "http://localhost:8080/this/url/"
querystring = {'does': 'not', 'affect': 'anything'}

payload = 'This body string does not affect anything to.'

template = {
    'id': ':uuid',
    'version': '0.1.2',
    'owner.full_name': ':name :personal.surname',
    'owner.email': {
        '_type': 'str',
        '_field': ':email',
        '_key': 'lower'
    },
    'owner.phones': {
        '_type': 'list',
        '_count': 5,
        '_field': [":telephone", "other1", "other2"]
    },
}
headers = {
    'Mimesis-Template': json.dumps(template),
    'Mimesis-Count': "10",
    'Mimesis-Locale': "ru"
    }

response = requests.request("POST", url, data=payload,
                            headers=headers, params=querystring)

print(json.loads(response.text))

Output:

[{'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Фёдор Демина', 'email': '[email protected]'}, 'version': '0.1.2', 'id': 'f28f236a-f1b8-a560-f650-1514588cb322'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Григорий Алчёв', 'email': '[email protected]'}, 'version': '0.1.2', 'id': '5835bf1c-965f-7187-52c7-655b44fabb9e'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Виктор Алексеенко', 'email': '[email protected]'}, 'version': '0.1.2', 'id': '3200de62-d51a-bbbc-c39d-dd12fcd2f2ef'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Иннокентий Горелова', 'email': '[email protected]'}, 'version': '0.1.2', 'id': 'f331fc1e-6ea1-6941-fa24-ceaaaef4e890'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Тала Азерникова', 'email': '[email protected]'}, 'version': '0.1.2', 'id': '8503b1e3-589a-b7c2-747d-cd2b96dcb148'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Любовь Агопов', 'email': '[email protected]'}, 'version': '0.1.2', 'id': '6c3ff0f0-7cb9-17ce-39ac-581f5dabd190'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Ириней Агеева', 'email': '[email protected]'}, 'version': '0.1.2', 'id': 'aeac06fa-5f9f-5d44-dff3-6360822422c3'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Мирослава Астапенкова', 'email': '[email protected]'}, 'version': '0.1.2', 'id': 'b73cb445-9856-b2f4-15a0-5f0840cd353e'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Мэлор Амвросимов', 'email': '[email protected]'}, 'version': '0.1.2', 'id': '66c17195-37bb-4234-c38b-d37f016ec8e7'}, {'owner': {'phones': ['[phone]', '[phone]', '[phone]', 'other1', 'other2'], 'full_name': 'Марьяна Трифонов', 'email': '[email protected]'}, 'version': '0.1.2', 'id': '60e84178-b9af-461f-f2f2-72d559e94f4c'}]

This mimesis http server may be helpful, example, for front-end devs. They can get mock data, and after back-end realise api, just delete headers and call normal data from dev server. :smirk:

[sobolevn]

https://stackoverflow.com/questions/3561381/custom-http-headers-naming-conventions

[sobolevn]

Also, is it just for alpha version that you are creating it inside the main repo?

[duckyou]

https://stackoverflow.com/questions/3561381/custom-http-headers-naming-convention

I read this when thinking about naming of headers. If you want to use X- preffix, then I do not mind.

Also, is it just for alpha version that you are creating it inside the main repo?

Sorry, i don't understand the question :sweat_smile:.

[sobolevn]

Sorry, i don't understand the question 😅.

We are discussing several possible way where to implement this new feature. These places are: mimesis-mock-server and mimesis-cloud.

That's why I am asking if you are developing this prototype in the main repo. Just to be sure that you have not missed our discussion.

[duckyou]

For mimesis http server i created one file server.py with 200+ lines of code. This is 'very'*100 simple feature without complicated design. Its like http.server but for mimesis.

Also about mimesis-clod. Here's an idea. What if we write not just data provider service, but something like proxy. I can explain in more detail in the mimesis-lab if you want it.

[lk-geimfari]

We should not want to reject proposals simply without justifying them. Therefore, if you will allow me, I will express my opinion. That's looks really useful and i like it, but we should keep in mind that Mimesis is library for generating data. We have added special section related to subject to documentation: What Mimesis is, What Mimesis is Not.

Let's create it in another repository. In this repository we will concentrate on improving the existing functional and data.

@duckyou @sobolevn If you agree with me, let's close this issue.