gravago

README

Gravago - Gravatar library for Go

Simple go library for creating gravatar.com avatar URLs

Current version: 0.4.0

Credits

This library has some inspiration from the eefret/gravatar Go library and the node-gravatar Node.js library.

Table of Contents

1. Overview
2. Installation - Getting this package ready to roll
3. Usage - How to use this thing
4. License - Licensing information
5. Contact - How to contact me

Installation

Just like any other Go package, you can install this baby with go get ...

go get github.com/Ascendings/gravago

Usage

Now for the fun stuff... the meat! Seriously, though, this package isn't designed to be too difficult to use in a web application - just create a new instance, fiddle some options, then generate your URL!

For example:

// of course we need to import this package
import "github.com/Ascendings/gravago"

// create a new instance
grav := gravago.New(gravago.GravatarOptions{
  ForceHTTPS: true,
  IconSet: "mosterid",
  IconRating: "x",
  IconSize: 80,
})

// change some options later on...
grav.SetSize(80) // set the icon size to 80
grav.SetIcons("monsterid") // use monsterid default icons
grav.SetRating("x") // allow x-rated icons
grav.UseHTTPS(true) // force HTTPS

// generate URL
gravURL := grav.URL("myemail@example.com")

License

This package/program is licensed under the 2-Clause BSD License

Contact

Email me at: brotherballantine@gmail.com

Feel free to hit me up at

• Mastodon
• Google+
• Wire @brotherballan

Documentation

Index

• type Gravatar
  • func New(opts GravatarOptions) *Gravatar
  • func (g *Gravatar) GetURL(email string) string
  • func (g *Gravatar) SetIcons(iconset string)
  • func (g *Gravatar) SetRating(rating string)
  • func (g *Gravatar) SetSize(size int)
  • func (g *Gravatar) UseHTTPS(protocol bool)
• type GravatarOptions

Types

type Gravatar

type Gravatar struct {
	// contains filtered or unexported fields
}

Gravatar - gravatar object

func New

func New(opts GravatarOptions) *Gravatar

New - create new gravatar object instance

func (*Gravatar) GetURL

func (g *Gravatar) GetURL(email string) string

GetURL - generate gravatar URL string

func (*Gravatar) SetIcons

func (g *Gravatar) SetIcons(iconset string)

SetIcons - set the default icon to return

func (*Gravatar) SetRating

func (g *Gravatar) SetRating(rating string)

SetRating - set rating

func (*Gravatar) SetSize

func (g *Gravatar) SetSize(size int)

SetSize - set size of gravatar image

func (*Gravatar) UseHTTPS

func (g *Gravatar) UseHTTPS(protocol bool)

UseHTTPS - force using HTTPS protocol

type GravatarOptions

type GravatarOptions struct {
	ForceHTTPS bool
	IconSet    string
	IconRating string
	IconSize   int
}

GravatarOptions - gravatar struct settings