init

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Docs: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+*       @clivern

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: clivern

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,15 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Development or production environment**
+ - OS: [e.g. Ubuntu 18.04]
+ - Go 1.13
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -0,0 +1,14 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+config.prod.yml

.goreleaser.yml

@@ -0,0 +1,28 @@
+# This is an example goreleaser.yaml file with some sane defaults.
+# Make sure to check the documentation at http://goreleaser.com
+before:
+  hooks:
+    # you may remove this if you don't use vgo
+    - go mod download
+    # you may remove this if you don't need go generate
+    - go generate ./...
+builds:
+- env:
+  - CGO_ENABLED=0
+archives:
+- replacements:
+    darwin: Darwin
+    linux: Linux
+    windows: Windows
+    386: i386
+    amd64: x86_64
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+    - '^docs:'
+    - '^test:'

.travis.yml

@@ -0,0 +1,59 @@
+language: go
+
+# needed for the nfpm pipe
+addons:
+  apt:
+    packages:
+    - rpm
+
+services:
+  - redis-server
+
+go:
+  - 1.9.x
+  - 1.10.x
+  - 1.11.x
+  - 1.12.x
+  - 1.13.x
+  - master
+
+matrix:
+  include:
+  allow_failures:
+  - go: 1.9.x
+  - go: 1.10.x
+  - go: master
+
+env:
+  - GO111MODULE=on
+
+install: true
+
+# Fix this by renaming the directory before testing.
+# https://github.com/travis-ci/travis-ci/issues/4573
+script:
+  - export GOBIN="$GOPATH/bin"
+  - export PATH="$PATH:$GOBIN"
+  # Fix dir names
+  - cd $GOPATH/src/github.com/
+  - mv Clivern/Beetle Clivern/beetle
+  - mv Clivern clivern
+  - cd clivern/beetle
+  # Config & execute ci tasks
+  - make install_revive
+  - make ci
+  # Workaround to clear any package used for testing only
+  - git status
+  - git diff > diff.log
+  - cat diff.log
+  - git clean -fd
+  - git reset --hard
+
+deploy:
+- provider: script
+  skip_cleanup: true
+  script: curl -sL http://git.io/goreleaser | bash
+  on:
+    tags: true
+    go: 1.13.x
+    condition: $TRAVIS_OS_NAME = linux

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+## Contributing
+
+- With issues:
+  - Use the search tool before opening a new issue.
+  - Please provide source code and commit sha if you found a bug.
+  - Review existing issues and provide feedback or react to them.
+
+- With pull requests:
+  - Open your pull request against `master`
+  - Your pull request should have no more than two commits, if not you should squash them.
+  - It should pass all tests in the available continuous integrations systems such as TravisCI.
+  - You should add/modify tests to cover your proposed code changes.
+  - If your pull request contains a new feature, please document it on the README.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Clivern
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,86 @@
+GO           ?= go
+GOFMT        ?= $(GO)fmt
+pkgs          = ./...
+
+
+help: Makefile
+	@echo
+	@echo " Choose a command run in Beetle:"
+	@echo
+	@sed -n 's/^##//p' $< | column -t -s ':' |  sed -e 's/^/ /'
+	@echo
+
+
+## install_revive: Install revive for linting.
+install_revive:
+	@echo ">> ============= Install Revive ============= <<"
+	$(GO) get github.com/mgechev/revive
+
+
+## style: Check code style.
+style:
+	@echo ">> ============= Checking Code Style ============= <<"
+	@fmtRes=$$($(GOFMT) -d $$(find . -path ./vendor -prune -o -name '*.go' -print)); \
+	if [ -n "$${fmtRes}" ]; then \
+		echo "gofmt checking failed!"; echo "$${fmtRes}"; echo; \
+		echo "Please ensure you are using $$($(GO) version) for formatting code."; \
+		exit 1; \
+	fi
+
+
+## check_license: Check if license header on all files.
+check_license:
+	@echo ">> ============= Checking License Header ============= <<"
+	@licRes=$$(for file in $$(find . -type f -iname '*.go' ! -path './vendor/*') ; do \
+               awk 'NR<=3' $$file | grep -Eq "(Copyright|generated|GENERATED)" || echo $$file; \
+       done); \
+       if [ -n "$${licRes}" ]; then \
+               echo "license header checking failed:"; echo "$${licRes}"; \
+               exit 1; \
+       fi
+
+
+## test_short: Run test cases with short flag.
+test_short:
+	@echo ">> ============= Running Short Tests ============= <<"
+	$(GO) test -short $(pkgs)
+
+
+## test: Run test cases.
+test:
+	@echo ">> ============= Running All Tests ============= <<"
+	$(GO) test -race -cover $(pkgs)
+
+
+## lint: Lint the code.
+lint:
+	@echo ">> ============= Lint All Files ============= <<"
+	revive -config config.toml -exclude vendor/... -formatter friendly ./...
+
+
+## format: Format the code.
+format:
+	@echo ">> ============= Formatting Code ============= <<"
+	$(GO) fmt $(pkgs)
+
+
+## vet: Examines source code and reports suspicious constructs.
+vet:
+	@echo ">> ============= Vetting Code ============= <<"
+	$(GO) vet $(pkgs)
+
+
+## coverage: Create HTML coverage report
+coverage:
+	@echo ">> ============= Coverage ============= <<"
+	rm -f coverage.html cover.out
+	$(GO) test -coverprofile=cover.out $(pkgs)
+	go tool cover -html=cover.out -o coverage.html
+
+
+## ci: Run all CI tests.
+ci: style check_license test vet lint
+	@echo "\n==> All quality checks passed"
+
+
+.PHONY: help

README.md

@@ -0,0 +1,50 @@
+<p align="center">
+    <img alt="Beetle Logo" src="https://raw.githubusercontent.com/clivern/Beetle/master/assets/img/logo.png" width="130" />
+    <h3 align="center">Beetle</h3>
+    <p align="center"></p>
+    <p align="center">
+        <a href="https://godoc.org/github.com/clivern/beetle"><img src="https://godoc.org/github.com/clivern/beetle?status.svg"></a>
+        <a href="https://travis-ci.org/clivern/Beetle"><img src="https://travis-ci.org/clivern/Beetle.svg?branch=master"></a>
+        <a href="https://github.com/clivern/Beetle/releases"><img src="https://img.shields.io/badge/Version-0.0.1-red.svg"></a>
+        <a href="https://goreportcard.com/report/github.com/clivern/Beetle"><img src="https://goreportcard.com/badge/github.com/clivern/Beetle?v=0.0.1"></a>
+        <a href="https://github.com/clivern/Beetle/blob/master/LICENSE"><img src="https://img.shields.io/badge/LICENSE-MIT-orange.svg"></a>
+    </p>
+</p>
+
+
+## Documentation
+
+### Installation:
+
+```golang
+#
+```
+
+
+## Versioning
+
+For transparency into our release cycle and in striving to maintain backward compatibility, Beetle is maintained under the [Semantic Versioning guidelines](https://semver.org/) and release process is predictable and business-friendly.
+
+See the [Releases section of our GitHub project](https://github.com/clivern/beetle/releases) for changelogs for each release version of Beetle. It contains summaries of the most noteworthy changes made in each release.
+
+
+## Bug tracker
+
+If you have any suggestions, bug reports, or annoyances please report them to our issue tracker at https://github.com/clivern/beetle/issues
+
+
+## Security Issues
+
+If you discover a security vulnerability within Beetle, please send an email to [[email protected]](mailto:[email protected])
+
+
+## Contributing
+
+We are an open source, community-driven project so please feel free to join us. see the [contributing guidelines](CONTRIBUTING.md) for more details.
+
+
+## License
+
+© 2020, clivern. Released under [MIT License](https://opensource.org/licenses/mit-license.php).
+
+**Beetle** is authored and maintained by [@clivern](http://github.com/clivern).