Refactor the external package to use an interface

[ekefan]

Made request externally configurable to support integration with any external service in hng_boilerplate using the external interface SendExternalRequest
​

Description

Towards resolving #371:

• Created an inteface for all external services.
• Currently the only external service is implemented in ipstack/ but new external services can be defined in the external package and implemented following the SendExternalRequest interface
• Updated ExternalRequest to function as a handler for all external services

Changes:

Modified

type ExternalRequest struct {
	Logger      *utility.Logger
	Test        bool
}

to

type ExternalRequest struct {
	Logger      *utility.Logger
	Test        bool
	Ipstack     *ipstack.IpstackRequest
	requestName string
}

Factory-based Initialization

New ExternalRequest will be created using a factory function, taking a logger and options.
Available options:

• Use the ExternalRequest in test mode,
• Use the ExternalRequest with ipstack as an external service for sending requests
• Extendability: other external services can be defined, added as fields in ExternalRequest, and integrated as options during setup

Defined the interface for external services:

type SendExternalRequest interface {
   SetupExternalRequest(name string, data any) error
   SendRequest() (any, error)
}

​

Related Issue (Link to Github issue)

​Towards resolving #371

How Has This Been Tested?

Unit tested

Screenshots (if appropriate - Postman, etc):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
  ​

Checklist:

• My code follows the code style of this project.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[samuelIkoli]

Looking good, you want to add proof of tests, screenshots

[ekefan]

Looking good, you want to add proof of tests, screenshots

@samuelIkoli, I've added the tests, the changes I made did not affect endpoint handlers, so I don't think postman screenshots are necessary

[ihechiwilliams]

@ekefan Please add screenshot of existing functionalities still working after the refactor, like the calls going through

[ekefan]

@ekefan Please add screenshot of existing functionalities still working after the refactor, like the calls going through

@ihechiwilliams, I have added screenshots of existing functionalities