Work in progress

Ponzu HTTP Client - Go

The Go client can be used from within any Go program to interact with a Ponzu CMS.

Currently, the Go client has built-in support for:

Content API

Fetching content from Ponzu using:

Content: get single content item from Ponzu by Type and ID
Contents: get multiple content items as per QueryOptions from Ponzu
ContentBySlug: get content identified only by its slug from Ponzu
Reference: get content behind a reference URI

Creating content in Ponzu using:

Create: insert content (if allowed) into Ponzu CMS, handles multipart/form-data encoding and file uploads

Updating content in Ponzu using:

Update: change content (if allowed) in Ponzu CMS, handles multipart/form-data encoding and file uploads

Deleting content in Ponzu using:

Delete: remove content (if allowed) in Ponzu CMS, handles multipart/form-data encoding

Search API

If your content types are indexed, the Go client can handle search requests using:

Search: find content items matching a query for a specific content type

File Metadata API

All files uploaded to a Ponzu CMS can be inspected if the file slug is known, using:

FileBySlug: see metadata associated with a file, including file size, content type, and upload date

Usage

package main

import (
	"fmt"
	"net/url"
	"net/http"
	"github.com/ponzu-cms/go-client"
)

func main() {
    // configure the http client
    cfg := &client.Config{
        Host:         "http://localhost:8080",
        DisableCache: false, // defaults to false, here for documentation
      	Header: make(http.Header),
    }

    // add custom header(s) if needed:
    cfg.Header.Set("Authorization", "Bearer $ACCESS_TOKEN")
    cfg.Header.Set("X-Client", "MyGoApp v0.9")

    ponzu := client.New(cfg)


    //------------------------------------------------------------------
    // GET content (single item)
    //------------------------------------------------------------------

    // fetch single Content item of type Blog by ID 1
    resp, err := ponzu.Content("Blog", 1)
    if err != nil {
        fmt.Println("Blog:1 error:", err)
        return
    }

    fmt.Println(resp.Data[0]["title"])
	fmt.Println(fieldName)
	for fieldName , _ := range resp.Data[0]  {
		fmt.Println(fieldName)
	}


    //------------------------------------------------------------------
    // GET contents (multiple items)
    //------------------------------------------------------------------

    // fetch multiple Content items of type Blog, using the default QueryOptions
    // Count: 10
    // Offset: 0
    // Order: DESC
    resp, err = ponzu.Contents("Blog", nil)
    if err != nil {
        fmt.Println("Blog:multi error:", err)
        return
    }

    for i := 0; i < len(resp.Data); i++ {
        fmt.Println(resp.Data[i]["title"])
    }



    //------------------------------------------------------------------
    // SEARCH content
    //------------------------------------------------------------------

    // fetch the search results for a query "Steve" from Content items of type Blog
    resp, err = ponzu.Search("Blog", "Steve")
    if err != nil {
        fmt.Println("Blog:search error:", err)
        return
    }

    fmt.Println(resp.Data[0]["title"])
    fmt.Println(resp.Data[1]["title"])



    //------------------------------------------------------------------
    // GET File metadata (single item)
    //------------------------------------------------------------------

    // fetch file metadata for uploaded file with slug "mudcracks-mars.jpg" (slug is normalized filename)
    resp, err = ponzu.FileBySlug("mudcracks-mars.jpg")
    if err != nil {
        fmt.Println("File:slug error:", err)
        return
    }

    fmt.Println(resp.Data[0]["name"])
    fmt.Println(resp.Data[0]["content_type"])
    fmt.Println(resp.Data[0]["content_length"])



    //------------------------------------------------------------------
    // CREATE content (single item)
    //------------------------------------------------------------------

    // create Content item of type Blog with data
    data := client.NewValues()
    data.Set("title", "Added via API")
    data.Set("body", "<p>Here's some HTML for you...</p>")
    data.Set("author", "Steve")

    // or, instead of making client.Values and setting key/values use helper func:
    blog := &content.Blog{
        Title: "Added via API client",
        Body: "<p>Here's some HTML for you...</p>",
        Author: "Steve",
    }
    data, err := client.ToValues(blog)


    // nil indicates no data params are filepaths, 
    // otherwise would be a []string of key names that are filepaths (docs coming)
    resp, err = ponzu.Create("Blog", data, nil)
    if err != nil {
        fmt.Println("Create:Blog error:", err)
        return
    }

    fmt.Println(resp.Data[0]["status"], resp.Data[0]["id"])
    id := int(resp.Data[0]["id"].(float64))



    //------------------------------------------------------------------
    // UPDATE content (single item)
    //------------------------------------------------------------------

    // update Content item of type Blog and ID {id} with data
    data = client.NewValues()
    data.Set("title", "Added then updated via API")
    data.Set("author", "API Steve")

    resp, err = ponzu.Update("Blog", id, data, nil)
    if err != nil {
        fmt.Println("Create:Blog error:", err)
        return
    }

    resp, err = ponzu.Search("Blog", `"API Steve"`)
    if err != nil {
        fmt.Println("Blog:search error:", err)
        return
    }

    fmt.Println(resp.Data[0]["title"])



    //------------------------------------------------------------------
    // DELETE content (single item)
    //------------------------------------------------------------------

    // delete Content item of type Blog with ID {id}
    resp, err = ponzu.Delete("Blog", id)
    if err != nil {
        fmt.Println("Delete:Blog:#id error:", err, id)
        return
    }

    fmt.Println(resp.Data[0]["status"], resp.Data[0]["id"])
}

Alternatively, the resp return value (which is an *APIResponse type) contains the response body's original []byte as resp.JSON, which you can use to unmarshal to content structs from your Ponzu's content package.

ponzu-cms / go-client