https://github.com/tonicpow/go-tonicpow
The official Go implementation for interacting with the TonicPow API
https://github.com/tonicpow/go-tonicpow
api conversions go golang gomod gomodule tonic tonicpow tonicpow-api
Last synced: over 1 year ago
JSON representation
The official Go implementation for interacting with the TonicPow API
- Host: GitHub
- URL: https://github.com/tonicpow/go-tonicpow
- Owner: tonicpow
- License: mit
- Created: 2019-10-16T17:30:26.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T12:02:54.000Z (over 1 year ago)
- Last Synced: 2025-04-18T02:40:48.437Z (over 1 year ago)
- Topics: api, conversions, go, golang, gomod, gomodule, tonic, tonicpow, tonicpow-api
- Language: Go
- Homepage: https://docs.tonicpow.com
- Size: 616 KB
- Stars: 8
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
> The official Go implementation for interacting with the [TonicPow API](https://docs.tonicpow.com)
[](https://github.com/tonicpow/go-tonicpow/releases)
[](https://github.com/tonicpow/go-tonicpow/actions)
[](https://goreportcard.com/report/github.com/tonicpow/go-tonicpow)
[](https://codecov.io/gh/tonicpow/go-tonicpow)
[](https://golang.org/)
[](https://mergify.io)
[](https://gitpod.io/#https://github.com/tonicpow/go-tonicpow)
[](https://join.slack.com/t/tonicpow/shared_invite/zt-mlccqx28-IEabvOGPx_QLyFJJbWE3hQ)
## Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples & Tests](#examples--tests)
- [Benchmarks](#benchmarks)
- [Code Standards](#code-standards)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Installation
**go-tonicpow** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/tonicpow/go-tonicpow
```
## Documentation
You can view the generated [documentation here](https://pkg.go.dev/github.com/tonicpow/go-tonicpow).
### Features
- [Client](client.go) is completely configurable
- Using [heimdall http client](https://github.com/gojek/heimdall) with exponential backoff & more
- Coverage for the [TonicPow.com API](https://docs.tonicpow.com/)
- [x] [Authentication](https://docs.tonicpow.com/#632ed94a-3afd-4323-af91-bdf307a399d2)
- [x] [Advertiser Profiles](https://docs.tonicpow.com/#2f9ec542-0f88-4671-b47c-d0ee390af5ea)
- [x] [Campaigns](https://docs.tonicpow.com/#5aca2fc7-b3c8-445b-aa88-f62a681f8e0c)
- [x] [Goals](https://docs.tonicpow.com/#316b77ab-4900-4f3d-96a7-e67c00af10ca)
- [x] [Conversions](https://docs.tonicpow.com/#75c837d5-3336-4d87-a686-d80c6f8938b9)
- [x] [Rates](https://docs.tonicpow.com/#fb00736e-61b9-4ec9-acaf-e3f9bb046c89)
Library Deployment
[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to GitHub and can be installed via: `brew install goreleaser`.
The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).
Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
Makefile Commands
View all `makefile` commands
```shell script
make help
```
List of all current commands:
```text
all Runs multiple commands
clean Remove previous builds and any test cache data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
diff Show the git diff
generate Runs the go generate command in the base of the repo
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install-go Install the application (Using Native Go)
install-releaser Install the GoReleaser application
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in Github)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
run-examples Runs all the examples
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs lint and ALL tests
test-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-no-lint Runs just tests
test-short Runs vet, lint and tests (excludes integration tests)
test-unit Runs tests and outputs coverage
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
```
## Examples & Tests
All unit tests and [examples](examples) run via [GitHub Actions](https://github.com/tonicpow/go-tonicpow/actions) and
uses [Go version 1.18.x](https://golang.org/doc/go1.18). View the [configuration file](.github/workflows/run-tests.yml).
#### View all [real working examples](examples).
- [Loading the Library](examples/new_client)
- [Advertiser Profile Examples](examples/advertiser_profiles)
- [Campaign Examples](examples/campaigns)
- [Goal Examples](examples/goals)
- [Conversion Examples](examples/conversions)
- [Rates Example](examples/rates)
Run all tests (including integration tests)
```shell script
make test
```
Run tests (excluding integration tests)
```shell script
make test-short
```
## Benchmarks
Run the Go [benchmarks](tonicpow_test.go):
```shell script
make bench
```
## Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## Usage
Checkout all the [real working examples](examples).
- [Loading the Library](examples/new_client)
- [Advertiser Profile Examples](examples/advertiser_profiles)
- [Campaign Examples](examples/campaigns)
- [Goal Examples](examples/goals)
- [Conversion Examples](examples/conversions)
- [Rates Example](examples/rates)
## Maintainers
| [
](https://github.com/mrz1836) | [
](https://github.com/rohenaz) |
|:------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------:|
| [MrZ](https://github.com/mrz1836) | [Satchmo](https://github.com/rohenaz) |
## Contributing
If you're looking for a library using JavaScript, checkout [tonicpow-js](https://github.com/tonicpow/tonicpow-js)
View the [contributing guidelines](.github/CONTRIBUTING.md) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
Support the development of this project 🙏
[](https://tonicpow.com/?af=go-tonicpow) [](https://twitter.com/intent/tweet?text=TonicPow%20integration%20with%20Go%20rocks!%20Check%20it%20out:%20https%3A%2F%2Ftncpw.co%2F7ca46e94) [](https://twetch.app/compose?description=TonicPow%20integration%20with%20Go%20rocks!%20Check%20it%20out:%20https%3A%2F%2Ftncpw.co%2F7ca46e94)
[](https://github.com/tonicpow/go-tonicpow/stargazers)
## License
[](LICENSE)