Add Nock Integration Tests for One API Example

[YasharF]

Update Oct 22: As we are approaching the end of October, I'll accept the first PR that is ready to be merged. No need for an exclusive issue assignment. Note that AI generated content including code, PR description, or issue reply text may be marked as SPAM.

---

We need to introduce Nock for backend integration testing. The goal is to stub outbound HTTP calls in one of the API example controllers (e.g., Foursquare, GitHub, Twitter, etc.) and verify that our backend logic handles responses correctly.

This first integration test should:

• Use Mocha/Chai/Sinon as the test runner/assertion framework.
• Use Nock to intercept one API endpoint and return a canned response.
• Assert that the controller/service processes the mocked response as expected.

Acceptance Criteria:

• Nock is installed and configured for use in integration tests.
• A test file exists under test/integration/ that covers one API example controller.
• The test runs without network access (all external calls are mocked).
• The README Testing section is updated with instructions on:
  • How to run integration tests (npm run test:unit or similar).
  • How to add new Nock tests for additional API integrations.
  • Recap: Integration tests should validate backend logic in isolation, using Nock to simulate external APIs. Contributors can extend coverage by following the provided example.

[jassu2244]

hi @YasharF
want to work on this issue, could you please assign it to me?

[YasharF]

@jassu2244 assigning to you for the next week or so. Let me know if you can't submit a PR by then.

[jassu2244]

Okk, sure, I'll try to get it done asap!

[YasharF]

Also note that you may need to replace any API keys that you have in your live captures with mock API keys from .env.example before doing your commit/PR :)

[YasharF]

Posting this quick note on all issues that are currently open:

Within a day of Hacktoberfest, I've seen PRs and posts miss the mark due to overreliance on AI. AI can help, but they often suggests irrelevant or unnecessary changes. Please run the project locally, read the README, review and test, revisit the issue, iterate, and think critically about whether your submission needs revision before opening a PR.

[YasharF]

Removing the issue assignment, and putting this issue it in the up-for-grabs bucket to see if someone else can pick this up.

[Sid0004]

Hi @YasharF,

I'd like to work on this issue and add Nock integration tests for one API example (Foursquare). Here's my plan:

Approach:

Add nock as a dev dependency.
Create [test/integration/foursquare.integration.test.js] that uses Mocha/Chai/Sinon + Nock to intercept the Foursquare Places API calls (/places/search and /places/{id}) and return canned responses.
Test the controller directly by calling [apiController.getFoursquare(req, res)]with a fake [req] and a Sinon spy [res.render], avoiding app/MongoDB startup for fast, isolated tests.
Assert that the controller processes the mocked API responses correctly (e.g., [trendingVenues] has expected length, [venueDetail] is passed to the template).
Disable external network access during tests using nock.disableNetConnect() to ensure all external calls are mocked.
Add an npm script [test:integration] to run integration tests.
Update the README Testing section with instructions on running integration tests and adding new Nock tests for other APIs.
Testing:

Run the new integration test locally with [npm run test:integration](or npx mocha --timeout=60000 "test/integration/**/*.test.js").
Ensure the test passes without network access and validates backend logic in isolation.

Deliverables:

[test/integration/foursquare.integration.test.js]
[package.json] updated with nock dev dependency and [test:integration] script
README Testing section updated with integration test instructions
PR following Conventional Commits (e.g., [test(integration): add Nock integration test for Foursquare API])

I’m currently working on #1483
(Foursquare E2E test, PR #1491
), which is awaiting review/merge. I already have the project set up locally, so I can start on this issue right away once I receive confirmation.

[Sid0004]

may i ?