archer

README

Archer

Archer helps fire API calls

Getting Started

Archer gives you functions to get, post, put, delete and upload files along with a testable interface

Prerequisites

Here are the things that you would require before you get started

1. Install git
2. Install golang

Using Archer

You can install it into your project using

dep ensure -add github.com/build-tanker/archer

Installing

Clone the repo and build it

git clone https://github.com/build-tanker/archer.git
make build

Running the tests

If you would like to run the automated tests for the complete package, run this

make coverage
open ./coverage.html

And coding style tests

We use the default golang coding conventions. Run the following to test for those

make fmt
make vet
make lint

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning based on the recommendation from Dave Chaney. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details

Documentation

Index

• type Archer
  • func NewArcher(timeout time.Duration) Archer

Types

type Archer

type Archer interface {
	Get(url string) ([]byte, error)
	Post(url string, body io.Reader) ([]byte, error)
	Put(url string) ([]byte, error)
	Delete(url string) ([]byte, error)
	Upload(url string, file string) ([]byte, error)
}

Archer - inteface to http.client

func NewArcher

func NewArcher(timeout time.Duration) Archer

NewArcher - create a new requester which provides http.client