README
¶
INet
What is this?
This module is a simple wrapper around net/http, winhttp, and
wininet. It creates a minimal, cross-platform HTTP Client
interface and handles choosing an appropriate backend. On Windows you
can use any of the three supported backends (defaults to wininet).
On Linux the only supported backend is net/http.
How to install
Open a terminal and run the following:
$ go get --ldflags "-s -w" --trimpath -u github.com/mjwhitta/inet
Usage
Minimal example:
package main
import (
"bytes"
"crypto/tls"
"fmt"
"io"
"net/http"
"net/http/cookiejar"
"github.com/mjwhitta/inet"
)
var dst string = "https://icanhazip.com"
func configuredRequestAndDedicatedClientExample() error {
var body io.Reader = bytes.NewReader([]byte("test"))
var c inet.Client
var e error
var jar http.CookieJar
var req *http.Request
var res *http.Response
// Create cookiejar
if jar, e = cookiejar.New(nil); e != nil {
panic(e)
}
// Create client
if c, e = inet.NewClient("My custom UA"); e != nil {
return e
}
// Set cookiejar
c.Jar(jar)
// Create request
req, e = http.NewRequest(http.MethodPost, dst, body)
if e != nil {
return e
}
// Configure request
req.AddCookie(&http.Cookie{Name: "chocolatechip", Value: "tasty"})
req.AddCookie(&http.Cookie{Name: "oatmealraisin", Value: "gross"})
req.AddCookie(&http.Cookie{Name: "snickerdoodle", Value: "yummy"})
// Send request
if res, e = c.Do(req); e != nil {
return e
}
defer res.Body.Close()
return output(res)
}
func init() {
// Disable TLS verification (WARNING: insecure)
if t, ok := http.DefaultTransport.(*http.Transport); ok {
if t.TLSClientConfig == nil {
t.TLSClientConfig = &tls.Config{}
}
t.TLSClientConfig.InsecureSkipVerify = true
}
}
func main() {
if e := simpleGetExample(); e != nil {
panic(e)
}
if e := configuredRequestAndDedicatedClientExample(); e != nil {
panic(e)
}
}
func output(res *http.Response) error {
var b []byte
var e error
if b, e = io.ReadAll(res.Body); e != nil {
return e
}
fmt.Println(res.Status)
for k := range res.Header {
fmt.Printf("%s: %s\n", k, res.Header.Get(k))
}
for _, cookie := range res.Cookies() {
fmt.Printf("%s = %s\n", cookie.Name, cookie.Value)
}
if len(b) > 0 {
fmt.Println(string(b))
}
fmt.Println()
return nil
}
func simpleGetExample() error {
var e error
var res *http.Response
// Use simple helper function
if res, e = inet.Get(dst); e != nil {
return e
}
defer res.Body.Close()
return output(res)
}
Links
Documentation
¶
Index ¶
- Constants
- func Backend(backend int) error
- func Get(url string) (*http.Response, error)
- func Head(url string) (*http.Response, error)
- func Post(url string, contentType string, body io.Reader) (*http.Response, error)
- func PostForm(url string, data url.Values) (*http.Response, error)
- type Client
- type HTTPClient
Constants ¶
const ( HTTPBackend = iota // Default on non-Windows WinHTTPBackend WinINetBackend // Default on Windows )
Supported backends
const Version string = "0.4.4"
Version is the package version
Variables ¶
This section is empty.
Functions ¶
func Backend ¶
Backend is used to track the preferred backend HTTP client. Only net/http is supported for non-Windows OS.
Types ¶
type Client ¶
type Client interface {
Debug(enable bool) Client
Do(req *http.Request) (*http.Response, error)
Get(url string) (*http.Response, error)
Head(url string) (*http.Response, error)
Jar(jar http.CookieJar) Client
Post(
url string, contentType string, body io.Reader,
) (*http.Response, error)
PostForm(url string, data url.Values) (*http.Response, error)
Timeout(timeout time.Duration) Client
Transport(trans *http.Transport) Client
}
Client is an interface defining required functions for an HTTP client.
var ( // DefaultClient points to the default Client for the current // backend. DefaultClient Client )
type HTTPClient ¶
HTTPClient is a simple wrapper around net/http that adds the Jar(http.CookieJar) method for the Client interface.
func (*HTTPClient) Debug ¶ added in v0.4.0
func (c *HTTPClient) Debug(enable bool) Client
Debug will enable debugging/logging of Requests/Responses.
func (*HTTPClient) Do ¶ added in v0.4.0
Do is a wrapper around net/http.Client.Do which allows for debugging of Requests/Responses.
func (*HTTPClient) Jar ¶
func (c *HTTPClient) Jar(jar http.CookieJar) Client
Jar will set the cookiejar for the underlying http.Client.
Source Files