rm-hull / fuel-prices-api / 22203703132

22%

push

github

feat: add command to update retailer favicons & enrich search results with retailer metadata (#11)

* feat: add command to update retailer favicons

Introduces a new CLI command to scrape favicon URLs for fuel retailers
listed in a CSV file. This includes a new extraction engine that
prioritizes high-resolution icons and social media metadata.

- Add `favicons` command to `main.go`.
- Implement `internal/favicon` for HTML scraping and icon discovery.
- Add a generic CSV parser using **Go 1.23+** iterators.
- Include a seed list of UK fuel retailers in `internal/brands`.

```mermaid
sequenceDiagram
    participant CLI as Main/CLI
    participant CMD as update_favicons
    participant Retailers as brands.GetRetailersList
    participant Extractor as favicon.Extract
    participant Web as Retailer Website
    participant CSV as retailers.csv

    CLI->>CMD: Run UpdateFaviconsInCSV
    CMD->>Retailers: Load embedded CSV
    Retailers-->>CMD: List of Retailers
    loop Each Retailer
        CMD->>Extractor: Extract(URL)
        Extractor->>Web: HTTP GET
        Web-->>Extractor: HTML Content
        Extractor-->>CMD: Best Favicon URL
    end
    CMD->>CSV: Write updated records
```

* feat: add retailer favicons and brand matching

Enrich search results with retailer metadata, specifically favicon
URLs, to improve the API's front-end integration capabilities.

- Add favicon URLs for various fuel brands in `retailers.csv`.
- Implement brand name matching logic in `internal/models`.
- Update repository to link search results with retailer info.
- Adjust **VS Code** launch tasks and bootstrap process.

```mermaid
sequenceDiagram
    participant API
    participant Repository
    participant RetailersMap

    API->>Repository: fetchPfs(boundingBox)
    Repository->>Repository: Execute SQL Query
    loop For each record
        Repository->>RetailersMap: MatchBrandName(brand)
        RetailersMap-->>Repository: Retailer Metadata
        Repository->>Repository:... (continued)

11 of 257 new or added lines in 8 files covered. (4.28%)

203 of 922 relevant lines covered (22.02%)

0.24 hits per line