ulule / picfit-go

A Go client library for generating URLs with picfit

picfit-go

A Go client library for generating URLs with picfit

Installation

$ go get github.com/ulule/picfit-go

Usage

First, import the package:

import "github.com/ulule/picfit-go"

Now, you can access the package through picfit namespace.

API

BuildURL()

The BuildURL() function returns a pre-formatted URL for picfit server.

This function takes three required parameters:

• path - your original image path
• geometry - width and height formatted like this: widthxheight (example: "20x30")
• options - picfit options

Supported options are:

• Ops - see Operations
• Quality - see General Parameters
• Upscale - see General Parameters
• DefaultMethod - see Methods (defaults to display)
• SecretKey - your secret key (see Security)

Options is just an instance of Options struct:

// Create your own instance, with your own parameters.
options := &picfit.Options{
	Op:            "thumbnail",
	BaseURL:       "https://img.yourpicfitserver.com",
	DefaultMethod: "display",
	SecretKey:     "$ecretkeyplizkeepitseeeecret"
}

// Or, use the default ones (same as above) with NewOptions()
options := picfit.NewOptions()

// And, of course, you can override everything...
options.BaseURL = "https://img.superserver.com"
options.SecretKey = "qwerty1234ohitsbad"

Then, generate your URL:

url, err := picfit.BuildURL("image.jpg", "90x90", options)
if err != nil {
	return fmt.Errorf("couldn't build picfit URL: %w", err)
}

Contributing

• Ping us on twitter @thoas, @oibafsellig
• Fork the project
• Fix bugs