omglol-client-go's Introduction

omglol-client-go

API client library for omg.lol written in Go

Warning The omg.lol API is still in development, and endpoints are subject to change. This may cause the client to break unexpectedly.

Usage

To install this module:

go get github.com/ejstreet/omglol-client-go@latest

To import:

import (
  "github.com/ejstreet/omglol-client-go/omglol"
 )

Create a new client:

c, err := omglol.NewClient(email, api_key)

Use a method:

a, err := c.GetAccountInfo()

See test files for further examples.

Tests

To run tests, first export the following variables:

export OMGLOL_API_KEY=<your_api_key>
export OMGLOL_USER_EMAIL=<your_email>
export OMGLOL_USERNAME=<your_name>
export OMGLOL_TEST_OWNED_DOMAIN=<your_domain>

Then run from the root of the git repo:

go test ./... -v

Supported Features

This project is a work-in-progress, see the following table for supported features:

Resource	Sub-Resource	Method	Supported
Account	Info	GET	✔️
	Addresses	GET	✔️
	Name	GET	✔️
		POST	✔️
	Sessions	GET	✔️
		DELETE	✔️
	Settings	GET	✔️
		POST	✔️
Address	Availability	GET	✔️
	Expiration	GET	✔️
	Info	GET	✔️
Directory	List	GET	✔️
DNS	ListRecords	GET	✔️
	FilterRecord*	GET	✔️
	Create	POST	✔️
	Update	PATCH	✔️
	Delete	DELETE	✔️
Email	Retrieve	GET	✔️
	Set	POST	✔️
Now	Retrieve	GET	✔️
	Garden	GET	✔️
	Update	POST	✔️
PURL	List	GET	✔️
	Retrieve	GET	✔️
	Create	POST	✔️
	Delete	DELETE	✔️
Paste	List	GET	✔️
	Retrieve	GET	✔️
	Create	POST	✔️
	Delete	DELETE	✔️
Web	Retrieve	GET	✔️
	Update	POST	✔️
Service	Info	GET	✔️

Note Features marked with a * are additional to what the API provides

omglol-client-go's People

Contributors

Stargazers

Watchers

omglol-client-go's Issues

API update changed variable types

Tests failing

See: https://github.com/ejstreet/omglol-client-go/actions/runs/4392364003/jobs/7692088804

Failing test logs:

=== RUN   TestGetSetRestoreWeb
    web_test.go:20: Previous content: 
    web_test.go:44: New content: 
    web_test.go:46: Expected content 'this is the new content
        
        it has newlines
        ', got ''
    web_test.go:49: Expected ContentBytes 'this is the new content
        
        it has newlines
        ', got ''
--- FAIL: TestGetSetRestoreWeb (4.09s)

=== RUN   TestGetClearAndSetEmails
    email_test.go:20: Original Destinations: [***]
    email_test.go:45: Destinations once cleared: [***]
    email_test.go:48: Expected 0, got 1
    email_test.go:64: Final Destinations: [***]
--- FAIL: TestGetClearAndSetEmails (3.63s)