Remove broken Heroku demo link - #205
Open
kimjune01 wants to merge 2 commits into
Open
Conversation
The Heroku demo at gringottspay.herokuapp.com is no longer active and returns "There's nothing here, yet." This commit removes the broken link from the project description and link references. Fixes aviabird#191
The gringottspay.herokuapp.com Heroku app is no longer active. The README was cleaned up in the previous commit, but the same broken link remained in the CAMS gateway moduledoc. Remove it and keep the source repo reference.
📝 WalkthroughWalkthroughThe PR removes all references to the broken gringottspay.herokuapp.com Heroku deployment from the README and CAMS gateway documentation, replacing them with pointers to the working repository. A new test validates that the broken URL does not reappear in future README changes. ChangesBroken Demo Link Cleanup
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
test/documentation_test.exs (1)
6-13: ⚡ Quick winConsider expanding test coverage to include the CAMS module documentation.
The test currently only checks
README.md, but the PR also removed the broken Heroku demo link fromlib/gringotts/gateways/cams.ex. Consider adding a similar assertion for that file to prevent reintroduction of the broken link in both locations.🧪 Proposed expansion
+ `@cams_gateway_path` Path.join([__DIR__, "..", "lib", "gringotts", "gateways", "cams.ex"]) + test "README should not contain broken Heroku demo link" do readme_content = File.read!(`@readme_path`) # The old Heroku demo at https://gringottspay.herokuapp.com is no longer active # and should be removed from the README refute String.contains?(readme_content, "gringottspay.herokuapp.com"), "README contains broken Heroku demo link that should be removed" end + + test "CAMS gateway docs should not contain broken Heroku demo link" do + cams_content = File.read!(`@cams_gateway_path`) + + refute String.contains?(cams_content, "gringottspay.herokuapp.com"), + "CAMS gateway documentation contains broken Heroku demo link that should be removed" + end🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@test/documentation_test.exs` around lines 6 - 13, Add a second assertion to the existing test that reads the CAMS gateway source and asserts it does not contain the old Heroku URL: open lib/gringotts/gateways/cams.ex (look for the CAMS gateway module) using File.read!/File.read and use refute String.contains?(..., "gringottspay.herokuapp.com") with a clear failure message like "CAMS module contains broken Heroku demo link that should be removed" so both README and the CAMS module are checked in the same test.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@lib/gringotts/gateways/cams.ex`:
- Line 96: Update the inline comment that currently reads "Refer the
[GringottsPay][gpay-repo] source for an example of how to" to correct grammar by
changing it to "Refer to the [GringottsPay][gpay-repo] source for an example of
how to"; locate this comment in the cams module file
(lib/gringotts/gateways/cams.ex) and replace the phrase only, keeping the
existing reference tokens and surrounding text intact.
---
Nitpick comments:
In `@test/documentation_test.exs`:
- Around line 6-13: Add a second assertion to the existing test that reads the
CAMS gateway source and asserts it does not contain the old Heroku URL: open
lib/gringotts/gateways/cams.ex (look for the CAMS gateway module) using
File.read!/File.read and use refute String.contains?(...,
"gringottspay.herokuapp.com") with a clear failure message like "CAMS module
contains broken Heroku demo link that should be removed" so both README and the
CAMS module are checked in the same test.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 87393a55-94b8-45e9-a32e-34e055b32316
📒 Files selected for processing (3)
README.mdlib/gringotts/gateways/cams.extest/documentation_test.exs
|
|
||
| Refer the [GringottsPay][gpay-heroku-cams] website for an example of how to | ||
| integrate CAMS with phoenix. The source is available [here][gpay-repo]. | ||
| Refer the [GringottsPay][gpay-repo] source for an example of how to |
There was a problem hiding this comment.
Fix grammatical error.
"Refer the" should be "Refer to the" for correct English grammar.
📝 Proposed fix
- Refer the [GringottsPay][gpay-repo] source for an example of how to
+ Refer to the [GringottsPay][gpay-repo] source for an example of how to📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Refer the [GringottsPay][gpay-repo] source for an example of how to | |
| Refer to the [GringottsPay][gpay-repo] source for an example of how to |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@lib/gringotts/gateways/cams.ex` at line 96, Update the inline comment that
currently reads "Refer the [GringottsPay][gpay-repo] source for an example of
how to" to correct grammar by changing it to "Refer to the
[GringottsPay][gpay-repo] source for an example of how to"; locate this comment
in the cams module file (lib/gringotts/gateways/cams.ex) and replace the phrase
only, keeping the existing reference tokens and surrounding text intact.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #191
Summary
gringottspay.herokuapp.comis no longer active (Heroku removed free dynos in Nov 2022). Removed the broken link from README.md and the CAMS gateway moduledoc.aviabird/gringotts_paymentso users can still find the integration example.test/documentation_test.exsto prevent broken Heroku links from being reintroduced.Test plan
mix test test/documentation_test.exspassesgringottspay.herokuapp.comin codebaseSummary by CodeRabbit
Documentation
Tests