zink

README

🗃️ Archive Notice

No longer under development until further notice

---

🔗 zink

Go library and command line tool for https://z.umn.edu, a URL shortening service for people in the University of Minnesota.

Documentation

Overview

Package zink implements the functions to access z.umn.edu.

Index

• Constants
• type Handle
  • func New(id string, secret string) *Handle
  • func (h *Handle) Do(ctx context.Context, reqs ...Request) ([]Response, error)
• type Request
• type Response
• type Result
• type ResultError
• type ResultSuccess

Constants

const DefaultAccessPoint = "https://z.umn.edu/api/v1/urls"

Types

type Handle

type Handle struct {
	AccessID    string
	SecretKey   string
	AccessPoint string
}

Handle holds the access ID and secret key.

func New

func New(id string, secret string) *Handle

New creates a new Handle.

func (*Handle) Do

func (h *Handle) Do(ctx context.Context, reqs ...Request) ([]Response, error)

Do sends the requets to the access point.

type Request

type Request struct {
	URL        string  `json:"url"`
	Keyword    *string `json:"keyword,omitempty"`
	Collection *string `json:"collection,omitempty"`
}

type Response

type Response struct {
	Request
	Result Result
}

type Result

type Result interface{}

type ResultError

type ResultError []string

type ResultSuccess

type ResultSuccess string