Skip to content
forked from ulule/picfit-go

A Go client library for generating URLs with picfit

License

Notifications You must be signed in to change notification settings

zkilgore/picfit-go

 
 

Repository files navigation

picfit-go

Build Status

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

GenerateThumbnailURL()

The GenerateThumbnailURL() 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:

  • Op - see Operations (defaults to thumbnail)
  • Crop - either crop image or not (true or false, defaults to false)
  • Upscale - see General Parameters (defaults to 0)
  • 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",
	Crop:          false,
	Upscale:       0,
	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"
options.Crop = true

Then, generate your URL:

url, err := picfit.GenerateThumbnailURL("image.jpg", "90x90", options)
if err != nil {
	fmt.Println("Oops, sorry guys")
}

Contributing

About

A Go client library for generating URLs with picfit

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 99.5%
  • Makefile 0.5%