online

Documentation

Overview

Package online is for simple HTTP interactions with the GitHub API. It is used to fetch the latest release information of the program.

Index

• Constants
• Variables
• func Get(url, etag string) (*http.Response, []byte, error)
• func Ping(url string) (bool, error)
• type API
  • func Endpoint(url, etag string) (bool, API, error)

Examples

• Ping

Constants

const (
	// ReleaseAPI GitHub API v3 releases endpoint.
	// See: https://developer.github.com/v3/repos/releases/
	ReleaseAPI = "https://api.github.com/repos/bengarrett/retrotxtgo/releases/latest"
)

Variables

var (
	ErrJSON = errors.New("the response body syntax is not json")
	ErrMash = errors.New("cannot unmarshal the json response body")
)

Functions

func Get

func Get(url, etag string) (*http.Response, []byte, error)

Get fetches a URL and returns both its response and body. If an etag is provided a "If-None-Match" header request will be included.

func Ping

func Ping(url string) (bool, error)

Ping requests a URL and reports whether if the status is successful. A server response status code between 200 and 299 is considered a success.

Example

package main

import (
	"fmt"

	"github.com/bengarrett/retrotxtgo/pkg/online"
)

func main() {
	ok, _ := online.Ping("https://example.org")
	fmt.Print(ok)
}

Output:

true

Types

type API

type API map[string]interface{}

API interface to store the JSON results from GitHub.

func Endpoint

func Endpoint(url, etag string) (bool, API, error)

Endpoint requests an API endpoint from the URL. A HTTP ETag can be provided to validate local data cache against the server. It also reports whether the etag value matches the server ETag header.