crickets-and-comb / crickets-and-comb/comb_utils

Add method for sanitizing URL.

Open
#65 3 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

A URL can only have a handful of characters in it without requiring any modifications (i.e., unencoded). These characters are `:`, `/`, `?`, `&`, and `=`, and they serve a specific purpose in the URL. All other characters need to be encoded in order to be included in the URL. Unencoded characters can result in unwanted behavior.

A method can be implemented inside the `BasePagedResponseGetter` class of the `src/comb_utils/lib/api_callers.py` module in order to sanitize the input URL so that all unencoded characters are encoded properly.

This issue was formed based on the changes made in #62.

Contributor guide

Open the contributing guide

Research direction

Start in src/comb_utils/lib/api_callers.py and inspect the BasePagedResponseGetter class and how it receives or builds input URLs. Define the sanitization behavior there so URL characters outside the allowed unencoded set are encoded, then verify that the resulting URL preserves the intended delimiters and no longer contains unintended unencoded characters.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.