Implement Domain Availability Checker Using GoDaddy API

[jalexray]

Summary

Enhance the Flask application by adding a feature that allows users to check the availability of domain names for purchase using the GoDaddy API.

Description

We aim to provide users with the ability to check domain name availability directly from our application. This feature will involve creating a new HTML template for user input, adding a corresponding Flask route to handle form submissions, integrating with the GoDaddy API, and securely managing API credentials.

1. Create a New HTML Template for User Input

• Template File: Add a new template named domain_check.html to the application's templates directory.
• Template Content:
  • Include an input field where users can enter a domain name.
  • Add a submit button to post the entered domain name to the application.
  • Ensure the form uses the POST method and is set up to submit to the designated route.
• Notes:
  • Follow existing template conventions within the application.
  • Ensure the user interface is intuitive and accessible.

2. Add a New Flask Route to Handle Form Submissions

• Route File: Update /app/main/routes.py to include a new route for domain availability checks.
• Route Definition:
  • Create a route that handles both GET and POST requests at the endpoint /domain-check.
• Functionality:
  • On GET request: Render the domain_check.html template to display the input form.
  • On POST request:
  • Retrieve the domain name entered by the user from the form data.
  • Call a helper function to check availability using the GoDaddy API.
  • Render the template with the availability result displayed to the user.
• Error Handling:
  • Implement error handling to manage cases where the GoDaddy API is unreachable or returns an error.
  • Provide user-friendly messages in case of input validation errors or API failures.

3. Integrate with the GoDaddy API

• Helper Function:
  • In /utilities/utilities.py, create a function named check_domain_availability(domain_name).
• Functionality:
  • Use the GoDaddy API endpoint to check domain availability.
  • Send a request with the required parameters, including the domain name and check type.
  • Include necessary headers, such as authorization and content type.
  • Parse the API response to determine if the domain is available.
  • Return the availability status and any relevant information to the calling function.
• Security:
  • Ensure that API keys are not hard-coded and are accessed securely.
  • Handle exceptions and errors without exposing sensitive information.

4. Securely Manage GoDaddy API Credentials

• Environment Variables:
  • Store GoDaddy API credentials in environment variables: GODADDY_API_KEY and GODADDY_API_SECRET.
• Configuration File:
  • In /config.py, load the API credentials from the environment variables.
  • Ensure these credentials are accessible to the helper function and Flask routes without exposing them in the codebase.
• Security Best Practices:
  • Do not commit API credentials to the repository.
  • Ensure that sensitive information is not logged or displayed in error messages.

5. Update Documentation

• README.md:
  • Add a section titled Domain Availability Checker.
  • Explain the new feature and provide instructions on how to use it.
  • Include steps for setting up the GoDaddy API credentials using environment variables.
  • Emphasize the importance of keeping API credentials secure and not exposing them in the codebase.

Expected Outcome

• Users can navigate to /domain-check, enter a domain name, and submit the form.
• The application checks the domain's availability via the GoDaddy API.
• Users receive clear feedback indicating whether the domain is available for purchase.
• GoDaddy API credentials are securely managed using environment variables.
• The README.md file is updated with information about the new feature and setup instructions.

Additional Notes

• Adhere to existing codebase conventions when adding new templates and routes.
• Ensure robust error handling for API failures and invalid user input.
• Avoid including any external URLs or links in the code or user interface.
• Test the new feature thoroughly to ensure reliability and security.
• Ensure compliance with GoDaddy's API usage policies. @jacob-ai-bot --skip-build

[jacob-ai-bot[bot]]

JACoB here...

You mentioned me on this issue and I am busy taking a look at it.

I'll continue to comment on this issue with status as I make progress.

[jacob-ai-bot[bot]]

Unfortunately, I ran into trouble working on this.

Here is some error information:

ENOENT: no such file or directory, stat '/mnt/tmp/tmp-110-ZVIfNu7sfnbt/jacob-env/bin/python'