Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor code to use interfaces #70

Open
chapinb opened this issue Nov 25, 2020 · 0 comments
Open

Refactor code to use interfaces #70

chapinb opened this issue Nov 25, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@chapinb
Copy link
Owner

chapinb commented Nov 25, 2020

Is your feature request related to a problem? Please describe.

This project is difficult to integrate in to other code bases as a library:

  • The entry points are unclear
  • The steps required to complete an action are not intuitive
  • You need to review the source code in addition to the documentation to determine how to leverage the library

Describe the solution you'd like

A potential solution is to use interfaces and re-structure the library to have a clear workflows for common use cases. Some use cases include:

  • Resolving an IP address against one or more resolvers
  • Extracting an IP address from an input using a parser
  • Leverage utilities that can convert IP addresses to integers, detect that they are BOGON, etc.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Some useful references:

@chapinb chapinb added the enhancement New feature or request label Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant