├── .env.template ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── api ├── __init__.py ├── room.py └── test │ ├── test.ym │ └── test │ └── aaaa │ └── yml.yml ├── app.py ├── conf ├── __init__.py └── elasticsearch_mapper.py ├── docker-compose.yml ├── requirements.txt ├── services ├── __init__.py └── elasticsearch.py └── swagger └── indexer.yaml /.env.template: -------------------------------------------------------------------------------- 1 | export ELASTICSEARCH_HOST=127.0.0.1 2 | export ELASTICSEARCH_PORT=9200 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | .idea/ 6 | 7 | # C extensions 8 | *.so 9 | 10 | # Distribution / packaging 11 | .Python 12 | env/ 13 | build/ 14 | develop-eggs/ 15 | dist/ 16 | downloads/ 17 | eggs/ 18 | .eggs/ 19 | lib/ 20 | lib64/ 21 | parts/ 22 | sdist/ 23 | var/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *,cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # IPython Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # dotenv 80 | .env 81 | 82 | # virtualenv 83 | venv/ 84 | ENV/ 85 | 86 | # Spyder project settings 87 | .spyderproject 88 | 89 | # Rope project settings 90 | .ropeproject 91 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.6 2 | 3 | RUN mkdir /code 4 | WORKDIR /code 5 | ADD . /code/ 6 | RUN pip install -r requirements.txt 7 | 8 | EXPOSE 9090 9 | CMD ["python", "/code/app.py"] 10 | -------------------------------------------------------------------------------- /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 {yyyy} {name of copyright owner} 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # python-flask-microservice 2 | 3 | This is the code used in this series of articles: 4 | 5 | - https://medium.com/p/building-microservices-with-python-part-i-5240a8dcc2fb 6 | - https://medium.com/@ssola/building-microservices-with-python-part-2-9f951199094a#.z48wq941g 7 | - https://medium.com/@ssola/building-microservices-with-python-part-3-a556a4c4bc00#.yn4p8rstp 8 | 9 | This is a basic approach of building a Microservice on top of Flask, with some useful packages like: 10 | 11 | - [Flask](http://flask.pocoo.org/) 12 | - [Flask-Injector](https://pypi.python.org/pypi/Flask-Injector) 13 | - [Connexion](https://github.com/zalando/connexion) 14 | 15 | # Requirements 16 | 17 | We are going to build a microservice to index rooms information coming from another service (crawler). This service will be responsible for indexing the information into Elasticsearch. 18 | 19 | The indexing will be a process of: 20 | 21 | - Validate and sanitize the data 22 | - Get some metadata from the room information like geolocalization 23 | - Upload the given images URL to [Amazon S3](https://github.com/boto/boto) 24 | - Send an event to [RabbitMQ](https://github.com/pika/pika) every time a new room has been indexed serializing the payload with Avro. 25 | 26 | 27 | **Endpoints**: 28 | 29 | |Method|URI|Description| Status | 30 | |------|---|-----------|--------| 31 | | POST | /room | it will receive the room payload, and it will proceed to index it | **Development** | 32 | | PATCH | /room/{id} | this PATCH method will allow us to make changes on the indexed item | Not started | 33 | | DELETE | /room/{id} | this method will remove the room from the index | Not started | 34 | | GET | /room/{id} | this method will return the room data for a given room id | Not started | 35 | | GET | /health-check | This endpoint retuns the state of the service | Not started | 36 | 37 | # Running the environment 38 | 39 | You need to have Docker installed in your machine, after that, just run this command `docker-compose build && docker-compose up -d`. 40 | -------------------------------------------------------------------------------- /api/__init__.py: -------------------------------------------------------------------------------- 1 | from api.room import Room -------------------------------------------------------------------------------- /api/room.py: -------------------------------------------------------------------------------- 1 | import uuid 2 | 3 | from flask_injector import inject 4 | 5 | from services.elasticsearch import ElasticSearchIndex 6 | 7 | 8 | class Room(object): 9 | @inject(indexer=ElasticSearchIndex) 10 | def post(self, indexer: ElasticSearchIndex, room: dict) -> dict: 11 | """ 12 | This wil return a location, kind of 'Camden, London'. 13 | We need to have some data like lat/lon for that input. 14 | """ 15 | if indexer.exists_by_url(room['url']): 16 | # 409 HTTP Conflict 17 | return room, 409 18 | 19 | # Generates a unique ID for the room 20 | room['id'] = str(uuid.uuid4()) 21 | 22 | if not indexer.index(room): 23 | return {"error": "Room not saved"}, 400 24 | 25 | return room, 201 26 | 27 | class_instance = Room() 28 | -------------------------------------------------------------------------------- /api/test/test.ym: -------------------------------------------------------------------------------- 1 | test 2 | -------------------------------------------------------------------------------- /api/test/test/aaaa/yml.yml: -------------------------------------------------------------------------------- 1 | test 2 | -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | import os 2 | import connexion 3 | 4 | from injector import Binder 5 | from flask_injector import FlaskInjector 6 | from connexion.resolver import RestyResolver 7 | 8 | from services.elasticsearch import ElasticSearchIndex, ElasticSearchFactory 9 | from conf.elasticsearch_mapper import room_mapping 10 | 11 | 12 | def configure(binder: Binder) -> Binder: 13 | binder.bind( 14 | ElasticSearchIndex, 15 | ElasticSearchIndex( 16 | ElasticSearchFactory( 17 | os.environ['ELASTICSEARCH_HOST'], 18 | os.environ['ELASTICSEARCH_PORT'], 19 | ), 20 | 'rooms', 21 | 'room', 22 | room_mapping 23 | ) 24 | ) 25 | 26 | return binder 27 | 28 | 29 | if __name__ == '__main__': 30 | app = connexion.App(__name__, specification_dir='swagger/') 31 | app.add_api('indexer.yaml', resolver=RestyResolver('api')) 32 | FlaskInjector(app=app.app, modules=[configure]) 33 | app.run(port=9090) 34 | -------------------------------------------------------------------------------- /conf/__init__.py: -------------------------------------------------------------------------------- 1 | __author__ = 'ssola' 2 | -------------------------------------------------------------------------------- /conf/elasticsearch_mapper.py: -------------------------------------------------------------------------------- 1 | room_mapping = { 2 | "settings": { 3 | "number_of_shards": 3, 4 | "number_of_replicas": 2 5 | }, 6 | "room": { 7 | "properties": { 8 | "id": {"type": "string"}, 9 | "name": {"type": "string"}, 10 | "description": { "type": "string"}, 11 | "price": { "type": "integer"}, 12 | "recurrency": { "type": "keyword"}, 13 | "provider": { "type": "keyword"}, 14 | "url": { "type": "keyword"}, 15 | "monthly_price": { "type": "integer"}, 16 | "property_size": {"type": "keyword"}, 17 | "is_visible": {"type": "keyword"}, 18 | "coordinates": {"type": "geo_point"}, 19 | "area": { 20 | "id": { "type": "string"}, 21 | "name": { "type": "keyword"}, 22 | "coordinates": { "type": "geo_point"}, 23 | "country": { "type": "keyword"}, 24 | "city": {"type": "keyword"} 25 | }, 26 | "images": [{ 27 | "url": { "type": "string"} 28 | }] 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: "2" 3 | 4 | services: 5 | our-app: 6 | build: . 7 | environment: 8 | - MODE=dev 9 | - ELASTICSEARCH_HOST=127.0.0.1 10 | - ELASTICSEARCH_PORT=9200 11 | volumes: 12 | - .:/code 13 | depends_on: 14 | - elasticsearch 15 | - rabbitmq 16 | ports: 17 | - "9091:9090" 18 | 19 | rabbitmq: 20 | image: rabbitmq:3.6.1-management 21 | environment: 22 | - RABBITMQ_DEFAULT_USER=admin 23 | - RABBITMQ_DEFAULT_PASS=admin 24 | ports: 25 | - "8023:15672" 26 | - "8024:5672" 27 | 28 | elasticsearch: 29 | image: elasticsearch:5-alpine 30 | restart: unless-stopped 31 | command: elasticsearch -Etransport.host=127.0.0.1 32 | environment: 33 | - "ES_JAVA_OPTS=-Xms512m -Xmx512m" 34 | ports: 35 | - "9200:9200" 36 | - "9300:9300" 37 | volumes: 38 | - ../data:/usr/share/elasticsearch/data 39 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Flask 2 | connexion 3 | Flask-Injector 4 | fastavro 5 | elasticsearch 6 | boto -------------------------------------------------------------------------------- /services/__init__.py: -------------------------------------------------------------------------------- 1 | __author__ = 'ssola' 2 | -------------------------------------------------------------------------------- /services/elasticsearch.py: -------------------------------------------------------------------------------- 1 | from elasticsearch import Elasticsearch 2 | 3 | 4 | class ElasticSearchFactory(object): 5 | def __init__(self, host: str, port: int): 6 | self.host = host 7 | self.port = port 8 | 9 | def create(self) -> Elasticsearch: 10 | return Elasticsearch( 11 | [{'host': self.host, 'port': self.port}] 12 | ) 13 | 14 | 15 | class ElasticSearchIndex(object): 16 | def __init__( 17 | self, 18 | elastic_factory: ElasticSearchFactory, 19 | index_name: str, 20 | doc_type: str, 21 | index_mapper: dict 22 | ): 23 | """ 24 | It creates the index if it doesn't exists 25 | 26 | :param elasticsearch: 27 | :param index_name: 28 | :param doc_type: 29 | :param index_mapper: 30 | """ 31 | self.index_name = index_name 32 | self.index_mapper = index_mapper 33 | self.doc_type = doc_type 34 | self.elastic_factory = elastic_factory 35 | self.instance = None 36 | 37 | def connection(self) -> Elasticsearch: 38 | if not self.instance: 39 | self.instance = self.elastic_factory.create() 40 | 41 | if not self.instance.indices.exists(self.index_name): 42 | self.instance.indices.create( 43 | index=self.index_name, 44 | body=self.index_mapper 45 | ) 46 | 47 | return self.instance 48 | 49 | def index(self, payload: dict) -> bool: 50 | return self.connection().index( 51 | index=self.index_name, 52 | doc_type=self.doc_type, 53 | body=payload 54 | ) 55 | 56 | def exists_by_url(self, url: str) -> bool: 57 | matches = self.connection().search( 58 | index=self.index_name, 59 | doc_type=self.doc_type, 60 | body={ 61 | "query": { 62 | "query_string": { 63 | "query": 'url:"{}"'.format(url) 64 | } 65 | } 66 | } 67 | ) 68 | 69 | hits = matches['hits']['hits'] 70 | 71 | if hits: 72 | return True 73 | 74 | return False 75 | -------------------------------------------------------------------------------- /swagger/indexer.yaml: -------------------------------------------------------------------------------- 1 | swagger: "2.0" 2 | 3 | info: 4 | version: 1.0.0 5 | title: Indexer Service 6 | license: 7 | name: MIT 8 | 9 | basePath: /1.0 10 | 11 | schemes: 12 | - http 13 | consumes: 14 | - application/json 15 | produces: 16 | - application/json 17 | 18 | paths: 19 | /room/: 20 | post: 21 | operationId: api.room.class_instance.post 22 | parameters: 23 | - in: body 24 | name: room 25 | required: true 26 | schema: 27 | $ref: '#/definitions/Room' 28 | responses: 29 | '201': 30 | description: 'Room indexed' 31 | schema: 32 | $ref: '#/definitions/Room' 33 | 34 | definitions: 35 | ImageUrl: 36 | type: object 37 | required: 38 | - url 39 | 40 | properties: 41 | url: 42 | type: string 43 | Area: 44 | type: object 45 | required: 46 | - name 47 | - country 48 | - city 49 | properties: 50 | id: 51 | type: string 52 | name: 53 | type: string 54 | coordinates: 55 | $ref: '#/definitions/Coordinates' 56 | country: 57 | type: string 58 | city: 59 | type: string 60 | 61 | Coordinates: 62 | type: object 63 | required: 64 | - lat 65 | - lon 66 | properties: 67 | lat: 68 | type: number 69 | format: float 70 | lon: 71 | type: number 72 | format: float 73 | 74 | Room: 75 | type: object 76 | required: 77 | - name 78 | - description 79 | - price 80 | - recurrency 81 | - url 82 | - monthly_price 83 | - property_size 84 | - provider 85 | - coordinates 86 | properties: 87 | id: 88 | type: string 89 | name: 90 | type: string 91 | description: 92 | type: string 93 | price: 94 | type: integer 95 | recurrency: 96 | type: string 97 | provider: 98 | type: string 99 | url: 100 | type: string 101 | monthly_price: 102 | type: integer 103 | property_size: 104 | type: string 105 | area: 106 | $ref: '#/definitions/Area' 107 | is_visible: 108 | type: boolean 109 | coordinates: 110 | $ref: '#/definitions/Coordinates' 111 | images: 112 | type: array 113 | $ref: '#/definitions/ImageUrl' 114 | 115 | --------------------------------------------------------------------------------