toolpageorg

Documentation

Overview

Package toolpageorg provides an interface to the en.toolpage.org web service.

Index

• Variables
• type Client
  • func New() *Client
  • func (c *Client) GetIP() (net.IP, error)
  • func (c *Client) Name() string
  • func (c *Client) SetURL(url string)
• type Response
  • func GetResponse(urlProvider string) (*Response, error)
  • func (r *Response) String() string

Examples

• Client.Name

Variables

var IOReadAll = io.ReadAll

IOReadAll is a copy of io.ReadAll function to ease mock it's behavior during test.

var LogInfo = info.Log

LogInfo is a copy of info.Log function to ease mock it's behavior during test.

var NewDocument = goquery.NewDocumentFromReader

NewDocument is a copy of goquery.NewDocumentFromReader function to ease mock it's behavior during test.

Types

type Client

type Client struct {
	EndpointURL string
}

Client holds information to request en.toolpage.org's URL.

func New

func New() *Client

New returns a new Client for the en.toolpage.org API with default values.

func (*Client) GetIP

func (c *Client) GetIP() (net.IP, error)

GetIP returns the current IP address detected by en.toolpage.org.

func (*Client) Name

func (c *Client) Name() string

Name returns the URL of the current provider as its name.

Example

package main

import (
	"fmt"

	"github.com/KEINOS/whereami/pkg/provider/providers/toolpageorg"
)

func main() {
	cli := toolpageorg.New()

	fmt.Println(cli.Name())

}

Output:

https://en.toolpage.org/tool/ip-address

func (*Client) SetURL

func (c *Client) SetURL(url string)

SetURL overrides the default value of the API endpoint URL.

type Response

type Response struct {
	Provider   string `json:"provider"`
	IP         string `json:"ip"`
	Hostname   string `json:"hostname,omitempty"`
	IPVersion  string `json:"ipVersion,omitempty"`
	RemotePort string `json:"remotePort,omitempty"`
}

Response is the structure of JSON from the API response of en.toolpage.org.

func GetResponse

func GetResponse(urlProvider string) (*Response, error)

GetResponse returns the Response object parsed from the en.toolpage.org's content body.

func (*Response) String

func (r *Response) String() string

String returns the struct pretty in JSON format.