first commit

Author: Julien Neuhart

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at neuhart.julien@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+
+Hi! Thank you for considering contributing to Gotenberg Go client. You'll
+find below useful information about how to contribute to the Gotenberg project.
+
+## Contributing code
+
+### Install from sources
+
+1. Install and run the latest version of Docker
+2. Verify your Go version (>= 1.12)
+3. Fork this repository
+4. Clone it outside of your `GOPATH` (we're using Go modules)
+
+### Working with git
+
+1. Create your feature branch (`git checkout -b my-new-feature`)
+2. Commit your changes (`git commit -am 'Add some feature'`)
+3. Push to the branch (`git push origin my-new-feature`)
+4. Create a new pull request
+
+### Testing
+
+1. Run all linters (`make lint`)
+2. Run all tests (`make tests`)
+
+## Reporting bugs and feature request
+
+Your issue or feature request may already be reported!
+Please search on the [issue tracker](../../../issues) before creating one.
+
+If you do not find any relevant issue or feature request, feel free to
+add a new one!
+
+## Additional resources
+
+* [Code of conduct](CODE_OF_CONDUCT.md)
+* [Issue template](ISSUE_TEMPLATE.md)
+* [Pull request template](PULL_REQUEST_TEMPLATE.md)

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,32 @@
+Your issue may already be reported!
+Please search on the [issue tracker](../../../issues) before creating one.
+
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Version used:
+* Operating System and version:
+* Link to your project:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,44 @@
+A similar PR may already be submitted!
+Please search among the [pull requests](../../../pulls) before creating one.
+
+Thanks for submitting a pull request! Please provide enough information so that others can review your pull request:
+
+For more information, see the [CONTRIBUTING](CONTRIBUTING.md) guide.
+
+**Summary**
+
+<!-- Summary of the PR -->
+
+This PR fixes/implements the following **bugs/features**
+
+* [ ] Bug 1
+* [ ] Bug 2
+* [ ] Feature 1
+* [ ] Feature 2
+* [ ] Breaking changes
+
+<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
+
+Explain the **motivation** for making this change. What existing problem does the pull request solve?
+
+<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
+
+**Test plan (required)**
+
+Demonstrate the code is solid. Example: The exact commands you ran and their output.
+
+<!-- Make sure tests pass on Travis. -->
+
+**Closing issues**
+
+<!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
+Fixes #
+
+**Checklist**
+
+- [ ] Have you followed the guidelines in our [CONTRIBUTING](CONTRIBUTING.md) guide?
+- [ ] Have you lint your code locally prior to submission (`make lint`)?
+- [ ] Have you written new tests for your core changes, as applicable?
+- [ ] Have you successfully ran tests with your changes locally (`make tests`)?
+- [ ] I have squashed any insignificant commits
+- [ ] This change has comments for package types, values, functions, and non-obvious lines of code

.travis.yml

@@ -0,0 +1,16 @@
+sudo: required
+
+language: generic
+
+services:
+  - docker
+
+stages:
+  - tests
+
+jobs:
+  include:
+    - stage: tests
+      script: make lint
+    - stage: tests
+      script: make tests

Makefile

@@ -0,0 +1,18 @@
+GOLANG_VERSION=1.12
+GOTENBERG_VERSION=4.2.1
+VERSION=snapshot
+
+# gofmt and goimports all go files.
+fmt:
+	go fmt ./...
+	go mod tidy
+
+# run all linters.
+lint:
+	docker build --build-arg GOLANG_VERSION=$(GOLANG_VERSION) -t thecodingmachine/gotenberg-go-client:lint -f build/lint/Dockerfile .
+	docker run --rm -it -v "$(PWD):/lint" thecodingmachine/gotenberg-go-client:lint
+
+# run all tests.
+tests:
+	docker build --build-arg GOLANG_VERSION=$(GOLANG_VERSION) --build-arg GOTENBERG_VERSION=$(GOTENBERG_VERSION)  -t thecodingmachine/gotenberg-go-client:tests -f build/tests/Dockerfile .
+	docker run --rm -it -v "$(PWD):/tests" thecodingmachine/gotenberg-go-client:tests

README.md

@@ -0,0 +1,42 @@
+# Gotenberg Go client
+
+A simple Go client for interacting with a Gotenberg API.
+
+## Install
+
+```bash
+$ go get -u github.com/thecodingmachine/gotenberg-go-client/v4
+```
+
+## Usage
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v4"
+
+func main() {
+    // HTML conversion example.
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewHTMLRequest("index.html")
+    req.SetHeader("header.html")
+    req.SetFooter("footer.html")
+    req.SetAssets(
+        "font.woff",
+        "img.gif",
+        "style.css",
+    )
+    req.SetPaperSize(gotenberg.A4)
+    req.SetMargins(gotenberg.NormalMargins)
+    req.SetLandscape(false)
+    dest := "foo.pdf"
+    c.Store(req, dest)
+}
+```
+
+For more complete usages, head to the [documentation](https://thecodingmachine.github.io/gotenberg).
+
+
+## Badges
+
+[![Travis CI](https://travis-ci.org/thecodingmachine/gotenberg-go-client.svg?branch=master)](https://travis-ci.org/thecodingmachine/gotenberg-go-client)
+[![GoDoc](https://godoc.org/github.com/thecodingmachine/gotenberg-go-client?status.svg)](https://godoc.org/github.com/thecodingmachine/gotenberg-go-client)
+[![Go Report Card](https://goreportcard.com/badge/github.com/thecodingmachine/gotenberg-go-client)](https://goreportcard.com/report/thecodingmachine/gotenberg-go-client)

build/lint/Dockerfile

@@ -0,0 +1,35 @@
+ARG GOLANG_VERSION
+
+FROM golang:${GOLANG_VERSION}-stretch
+
+# |--------------------------------------------------------------------------
+# | GolangCI-Lint
+# |--------------------------------------------------------------------------
+# |
+# | Installs GolangCI-Lint, a linters Runner for Go. 5x faster 
+# | than gometalinter.
+# |
+
+ENV GOLANGCI_LINT_VERSION 1.15.0
+
+RUN curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b /usr/local/bin v${GOLANGCI_LINT_VERSION} &&\
+    golangci-lint --version
+
+# |--------------------------------------------------------------------------
+# | Final touch
+# |--------------------------------------------------------------------------
+# |
+# | Last instructions of this build.
+# |
+
+# Define our workding outside of $GOPATH (we're using go modules).
+WORKDIR /lint
+
+# Copy our module dependencies definitions.
+COPY go.mod .
+COPY go.sum .
+
+# Install module dependencies.
+RUN go mod download
+
+CMD [ "golangci-lint", "run" ,"--tests=false", "--enable-all", "--disable=dupl", "--disable=lll", "--disable=errcheck", "--disable=gosec", "--disable=gochecknoglobals", "--disable=gochecknoinits" ]

build/tests/Dockerfile

@@ -0,0 +1,49 @@
+ARG GOLANG_VERSION
+ARG GOTENBERG_VERSION
+
+FROM golang:${GOLANG_VERSION}-stretch AS golang
+
+FROM thecodingmachine/gotenberg:${GOTENBERG_VERSION}
+
+# |--------------------------------------------------------------------------
+# | Common libraries
+# |--------------------------------------------------------------------------
+# |
+# | Libraries used in the build process of this image.
+# |
+
+RUN apt-get install -y git gcc
+
+# |--------------------------------------------------------------------------
+# | Golang
+# |--------------------------------------------------------------------------
+# |
+# | Installs Golang.
+# |
+
+COPY --from=golang /usr/local/go /usr/local/go
+
+RUN export PATH="/usr/local/go/bin:$PATH" &&\
+    go version
+
+ENV GOPATH /go
+ENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH
+
+# |--------------------------------------------------------------------------
+# | Final touch
+# |--------------------------------------------------------------------------
+# |
+# | Last instructions of this build.
+# |
+
+# Define our workding outside of $GOPATH (we're using go modules).
+WORKDIR /tests
+
+# Copy our module dependencies definitions.
+COPY go.mod .
+COPY go.sum .
+
+# Install module dependencies.
+RUN go mod download
+
+ENTRYPOINT [ "build/tests/docker-entrypoint.sh" ]

build/tests/docker-entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -xe
+
+# Testing Go client.
+gotenberg &
+sleep 10
+go test -race -cover -covermode=atomic github.com/thecodingmachine/gotenberg-go-client/v4
+sleep 10 # allows Gotenberg to remove generated files (concurrent requests).