gogi

README

#gogi - Go client for gitignore.io

#Why gogi?

Make gitignore client more portable, without relying on the shell, curl, wget or any other http client.

#Installation

go get -u github.com/Gnouc/gogi

#Usage

As library

import (
	"fmt"
	"io/ioutil"
	"log"

	"github.com/Gnouc/gogi"
)

func main() {
	gogiClient, _ := gogi.NewHTTPClient()
	resp, _ := gogiClient.List()
	body, err := ioutil.ReadAll(resp.Body)
	if body != nil {
		defer resp.Body.Close()
	}

	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(string(body))
}

As binary:

$ go get github.com/Gnouc/gogi/cmd/gogi
$ gogi
Usage of gogi:
  -create string
    	Create .gitignore content for given types
  -list
    	List all defined types
  -search string
    	Show all types match string

Using docker

Using gnouc/gogi image

$ docker pull gnouc/gogi
$ docker run --rm gnouc/gogi -search python
ipythonnotebook
python

Building your own image

Building builder image

docker build -t gogi-builder -f Dockerfile.build .

Building binary image

docker run --rm gogi-builder | docker build -t gogi -f Dockerfile.run -

#Environment variables

GOGI_API_URL to change your gitignore server, default to https://www.gitignore.io

#Author

Cuong Manh Le cuong.manhle.vn@gmail.com

#License

See LICENSE

Documentation

Index

• func WithAPIUrl(u string) func(*Client) error
• func WithHTTPClient(client *http.Client) func(*Client) error
• type Client
  • func NewHTTPClient(options ...func(*Client) error) (*Client, error)
  • func (c *Client) Create(typeName string) (*http.Response, error)
  • func (c *Client) Do(req *http.Request) (resp *http.Response, err error)
  • func (c *Client) List() (*http.Response, error)
  • func (c *Client) NewRequest(method, path string, body interface{}) (*http.Request, error)

Functions

func WithAPIUrl

func WithAPIUrl(u string) func(*Client) error

WithAPIUrl sets the API url option for gogi client

func WithHTTPClient

func WithHTTPClient(client *http.Client) func(*Client) error

WithHTTPClient sets the client option for gogi client

Types

type Client

type Client struct {
	UserAgent string
	APIURL    *url.URL
	// contains filtered or unexported fields
}

Client for querying API

func NewHTTPClient

func NewHTTPClient(options ...func(*Client) error) (*Client, error)

NewHTTPClient create new gogi client

func (*Client) Create

func (c *Client) Create(typeName string) (*http.Response, error)

Create create .gitignore content for input type

func (*Client) Do

func (c *Client) Do(req *http.Request) (resp *http.Response, err error)

Do make an http request

func (*Client) List

func (c *Client) List() (*http.Response, error)

List list all defined gitignore types

func (*Client) NewRequest

func (c *Client) NewRequest(method, path string, body interface{}) (*http.Request, error)

NewRequest create new http request