Refactor API methods

[Rylan12]

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same change?
• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes? Here's an example.
• Have you successfully run brew style with your changes locally?
• Have you successfully run brew typecheck with your changes locally?
• Have you successfully run brew tests with your changes locally?

---

This PR refactors all calls to https://formulae.brew.sh/api/ into a new Homebrew::API module. I think this makes it easier to understand what's happening and also allows for some shared logic between them (i.e. fetching and parsing a JSON file). This is mainly motivated by the (in my opinion) poorly-names BottleAPI module. Now, some of the functionality from that module has been moved to Homebrew::API::Bottle, and some to Homebrew::API::Versions.

Now, these are the modules and functions available after using require "api"

• Homebrew::API: Helper module but can be used for any API call
  • ::fetch(endpoint, json: false): Takes an endpoint (e.g. formula/wget.json) and returns the API response (parsing to JSON if desired)
• Homebrew::API::Analytics: For /api/analytics or /api/analytics-linux
  • ::fetch(category, days): Makes a request to /api/analytics/{category}/{days}d.json or /api/analytics-linux/{category}/{days}d.json
• Homebrew::API::Bottle: For /api/bottle or /api/bottle-linux
  • ::fetch(name): Makes a request to /api/bottle/{name}.json or /api/bottle-linux/{name}.json
  • Other methods that already were present in the BottleAPI module including available? and fetch_bottles (among others)
• Homebrew::API::Cask: For /api/cask (there's no way to call /api/cask.json at the moment because this is not used anywhere)
  • ::fetch(token): Makes a request to /api/cask/{token}.json
• Homebrew::API::Formula: For /api/formula or /api/formula-linux (there's no way to call /api/formula.json at the moment because this is not used anywhere)
  • ::fetch(name): Makes a request to /api/formula/{name}.json or /api/formula-linux/{name}.json
• Homebrew::API::Versions: For /api/versions-{formulae,linux,casks}
  • ::formula: Makes a request to /api/versions-formulae
  • ::linux: Makes a request to /api/versions-linux
  • ::casks: Makes a request to /api/versions-casks
  • ::latest_formula_version(name): Returns the PkgVersion of name using /api/versions-formulae or /api/versions-linux
  • ::latest_cask_version(token): Returns the Version of token using /api/versions-casks

[BrewTestBot]

Review period will end on 2021-08-09 at 08:31:56 UTC.

[Rylan12]

After this PR, I'll open one that adds HOMEBREW_JSON_CORE functionality to homebrew/cask which will use a new API module that I'll add here (and has already been added to formulae.brew.sh): Homebrew::API::CaskSource

[BrewTestBot]

Review period ended.

[MikeMcQuaid]

Love this cleanup. Some improved test coverage would be nice but both that and my comment are non-blocking.

[Rylan12]

Some improved test coverage would be nice

I wrote some tests for Homebrew::API::fetch by stubbing (or mocking—can't remember which one's which) Utils::Curl::curl_output so it doesn't actually make a network call. I also wrote some tests for the other methods in Homebrew::API::Bottle. Other then that, though, I didn't write tests for the API modules because most of the methods are simply calling Homebrew::API::fetch with different options. It felt like a lot of extra work and tests for limited extended coverage (i.e. one line that just calls a method that we're already testing anyway). I can add more if you think it's important, though

[MikeMcQuaid]

I wrote some tests for Homebrew::API::fetch by stubbing (or mocking—can't remember which one's which) Utils::Curl::curl_output so it doesn't actually make a network call. I also wrote some tests for the other methods in Homebrew::API::Bottle. Other then that, though, I didn't write tests for the API modules because most of the methods are simply calling Homebrew::API::fetch with different options. It felt like a lot of extra work and tests for limited extended coverage (i.e. one line that just calls a method that we're already testing anyway). I can add more if you think it's important, though

Fine with me 👍🏻

[carlocab]

Error: undefined local variable or method `generic_formula_api_path' for Homebrew::API::Formula:Module

https://github.com/Homebrew/homebrew-core/pull/83028/checks?check_run_id=3283057919#step:7:37

🙈

[Rylan12]

Oops, thanks! Fix in #11839

[Rylan12]

Should be fixed now @carlocab @dtrodrigues