andrewpap22/URL-Shortener_Rest-API

URL Shortener Microservice (Rest API) built in Python, in particular with the Flask microframework, using 3rd party providers (Bitly, TinyURL).

Software Engineer Task

📁 Project File Structure

• 📂 shorty
  • 📂 custom_shorty

    • 📄 custom.py

  • 📂 error_msgs

    • 📄 errors.py

  • 📂 providers
    • 📂 bitly

      • 📄 bit_ly.py

    • 📂 tinyurl

      • 📄 tinyurl_com.py

    • 📄 provider_short.py

  • 📂 static
    • 📂 css

      • 📄 swagger-ui.css

    • 📂 img

      • 📄 favicon-16x16.png

      • 📄 favicon-32x32.png

    • 📂 js

      • 📄 swagger-ui-bundle.js

      • 📄 swagger-ui-standalone-preset.js

      • 📄 swagger-ui.js

    • 📄 openapi2.json

  • 📂 templates

    • 📄 swaggerui.html

  • 📄 api.py

  • 📄 app.py

• 📂 tests
  • 📂 functional_tests

    • 📄 conftest.py

    • 📄 test_shorty_api.py

  • 📂 unit_tests
    • 📂 test_custom_shorty

      • 📄 test_custom.py

    • 📂 test_providers
      • 📂 test_bitly

        • 📄 test_bit_ly.py

      • 📂 test_tinyurl

        • 📄 test_tinyurl_com.py

      • 📄 test_provider_short.py

• 🐳 Dockerfile

• 📄 LICENSE

• 📄 README.md

• 📄 requirements.txt

• 📄 run.py

• 💾 virtual_enviroment.sh

---

Mission

Your mission, should you choose to accept it, is to build a microservice called shorty, which supports two URL shortening providers: bit.ly and tinyurl.com. You don't need to actually sign up to these providers, just implement their API. The service exposes a single endpoint: POST /shortlinks. The endpoint should receive JSON with the following schema:

param	type	required	description
url	string	Y	The URL to shorten
provider	string	N	The provider to use for shortening

The response should be a Shortlink resource containing:

param	type	required	description
url	string	Y	The original URL
link	string	Y	The shortened link

For example:

{
    "url": "https://example.com",
    "link": "https://bit.ly/8h1bka"
}

You are free to decide how to pick between the providers if one is not requested and what your fallback strategy is in case your primary choice fails. Your endpoint needs to return a JSON response with a sensible HTTP status in case of errors or failures.

---

Details ✍️

So, shorty shortens the url given as a request using as a default provider the tinyurl provider. If the user decides to choose the provider though he's free to do so, and if both providers are unavailable for any reason, shorty uses a custom built in short() function to shorten the url requested.
Example:

{
  "url":"https://www.example.com/",
  "provider":"bitly"
}

Shorty checks for every possible mistake the user might do and provides a useful message for the user alongside an appropriate HTTP status code.
An example of a possible error message:

{
    "Error": "[!] Request must be provided in json format.",
    "Usage": [
        {
          "url":"https://www.example.com/",
          "provider":"bitly"
        },
        {
            "url":"http://example.com/",
            "provider":"tinyurl"
        },
        {
            "url":"http://example.com"
        }
    ]
}

After all shorty responds back if everything's ok.
Response Example

{
    "url": "https://example.com",
    "link": "https://bit.ly/8h1bka"
}

---

What you need to do

1. Create a Python env (using Python 3.6+) and install the requirements.
2. Build the POST /shortlinks endpoint. We've provided a skeleton API using flask.
3. Write some tests using pytest.

---

What I did 👨‍💻

1. Implemented the POST /shortlinks endpoint where the basic functionallity of the API resides.

2. Implemented the GET /shortlinks endpoint where the user gets informed with a usefull error message, that only POST method works with the API.

3. Implemented the GET /shortlinks/docs endpoint where, you can find rendered an HTML page, where basically resides a swaggerUI documentation for the API.

4. Implemented both API providers with the user functionallity to choose whoever he/she wants and if none is chose then a default one handles the request, as well as a custom short() function where the requested url can be shortened, if for any reason the providers fail.

5. Implemented both integration (functional) and unit tests, for whatever was needed to be tested in the API.

6. Provided a Dockerfile as well as a bash script to run the virtual enviroment.

Cool, How to use the API? 🤖

You can run the API locally either with python virtual enviroment or by building 👷 the provided docker image.

To run with python virtual enviroment :

Open up a terminal and run the provided bash script inside the root directory of the project:

$ ./virtual_enviroment.sh

To run with docker:

Open up a terminal again inside the root directory of the project and run the following:

# 1. To build the image
$ sudo docker build --tag shorty:latest . 

#2. To run the image
$ sudo docker run -p 5000:5000 shorty

🎉 Alright!

Now, after running the API successfully, you can install Postman on your machine and play with the API, by posting your request at the /shortlinks endpoint! Also you can open up a browser and type in: localhost to check the swaggerUI documentation interface!

🧪 Tests?

Finally you can check shorty's validity by going into the tests directory and by opening up a terminal inside that directory and provide the following command in the workink shell:

$ pytest -v

---

Deliverable

You should deliver your solution as a Pull Request in your repo. Document your design choices and anything else you think we need to know in the PR description.

What we look for

In a nutshell, we're looking for tidy, production-quality code, a scalable design and sensible tests (unit tests, integration tests or both?). Imagine that your code will be read by other developers in your team – keep them happy :-)

Resources

1. Flask: http://flask.pocoo.org/
2. pytest: http://pytest.org/latest/
3. virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
4. HTTP statuses: https://httpstatuses.com/

---

Thank you! 😃

©️ 2020-2021, Andrew Pappas