auth

README

gentleman/auth

gentleman's plugin to easily define HTTP authorization headers based on multiple schemas.

Installation

go get -u gopkg.in/h2non/gentleman.v1/plugins/auth

API

See godoc reference.

Example

package main

import (
  "fmt"
  "gopkg.in/h2non/gentleman.v1"
  "gopkg.in/h2non/gentleman.v1/plugins/auth"
)

func main() {
  // Create a new client
  cli := gentleman.New()

  // Attach the plugin at client level
  cli.Use(auth.Basic("user", "pas$w0rd"))

  // Perform the request
  res, err := cli.Request().Method().URL("http://httpbin.org/headers").Send()
  if err != nil {
    fmt.Printf("Request error: %s\n", err)
    return
  }
  if !res.Ok {
    fmt.Printf("Invalid server response: %d\n", res.StatusCode)
    return
  }

  fmt.Printf("Status: %d\n", res.StatusCode)
  fmt.Printf("Body: %s", res.String())
}

License

MIT - Tomas Aparicio

Documentation

Index

• func Basic(username, password string) p.Plugin
• func Bearer(token string) p.Plugin
• func Custom(value string) p.Plugin

Functions

func Basic

func Basic(username, password string) p.Plugin

Basic defines an authorization basic header in the outgoing request

func Bearer

func Bearer(token string) p.Plugin

Bearer defines an authorization bearer token header in the outgoing request

func Custom

func Custom(value string) p.Plugin

Custom defines a custom authorization header field in the outgoing request