setup: url shortening library

Signed-off-by: Kathurima Kimathi <[email protected]>

.gitguardian.yaml

@@ -0,0 +1,12 @@
+version: 2
+all-policies: false
+api-url: https://api.gitguardian.com
+exit-zero: false
+paths-ignore:
+  - "**/README.md"
+  - doc/*
+  - LICENSE
+  - .dockerignore
+  - .gitignore
+show-secrets: false
+verbose: false

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  # Update Github actions in workflows
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/issue_template.md

@@ -0,0 +1,34 @@
+# Issue/Bug/Feature Request
+
+#### Summary
+
+- [ ] fix: Bug fix for `Add the items tackled here as checklists`
+- [x] feat: Completed task
+- [ ] chore: Incomplete task
+  - [ ] test: Sub-task 1
+
+#### What is the current behaviour
+
+- `Describe the current behaviour`
+
+#### What is the expected (Ideal)
+
+- `Describe the current behaviour`
+
+
+#### Sample logs and/or screenshots
+
+- (Paste any relevant logs - please use code blocks (```) to format console output,
+logs, and code as it's very hard to read otherwise.)
+
+#### Steps to reproduce
+
+- (Minimal reproducible test case)
+
+#### Possible fixes
+
+- (If you can, link to the line of code that might be responsible for the problem)
+
+/label ~bug ~reproduced ~needs-investigation
+/cc @project-manager
+/assign @qa-tester

.github/pull_request_template.md

@@ -0,0 +1,44 @@
+# Review Checklist
+
+[![Bugs](https://img.shields.io/badge/BugFixes-0-red.svg?style=for-the-badge)](https://shields.io/)
+[![Features](https://img.shields.io/badge/Features-0-orange?style=for-the-badge)](https://shields.io/)
+[![Tests](https://img.shields.io/badge/Tests-0-success.svg?style=for-the-badge)](https://shields.io/)
+
+#### Summary*
+
+- [ ] fix: Bug fix for `Add the items tackled here as checklists`
+- [x] feat: Completed task
+- [ ] chore: Incomplete task
+  - [ ] test: Sub-task 1
+
+
+#### Structure*
+
+- [ ] The Pull Request has a `proper` title that conforms to our [MR title standards](https://gist.github.com/mikepea/863f63d6e37281e329f8)
+- [ ] The Pull Request has one commit, and if there are more than one, they should be squashed
+- [ ] The commit should have a proper title and a short description
+- [ ] The commit must be signed off
+- [ ] Unused imports are not present
+- [ ] Dead code is not present
+- [ ] Ensure dry running library to confirm changes
+
+#### Tests
+
+- [ ] Proper and high quality unit, integration and acceptance(if applicable) tests have been written
+- [ ] The coverage threshold should not be lowered
+
+### Sign off*
+
+- [ ] All comments have been resolved by the reviewers
+- [ ] Approved by Czar {replace_with_czar_name}
+- [ ] Signed off by second reviewer {replace_with_name}
+- [ ] Ensure all checks are done before merging :warning:
+- [ ] All PRs needs to be signed before merging :warning:
+
+#### N/B:
+
+- Add a checklist if more than one item is done.
+- Add screenshots and/or images where necessary
+- Indicate any breakages caused in the UI :exclamation:
+- Where necessary, indicate which issue the Pull Request solves (Closes #)
+- Any new files are updated in the folder structure in the [README](../../README.md)

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: Test
+
+on: [push]
+
+env:
+  GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}
+  URL_SHORTENER_API_KEY: ${{ secrets.URL_SHORTENER_API_KEY }}
+  URL_SHORTENER_DOMAIN: ${{ secrets.URL_SHORTENER_DOMAIN }}
+
+jobs:
+  lint_and_test:
+    strategy:
+      fail-fast: true
+      matrix:
+        go-version: [1.21.x]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/[email protected]
+      - name: Install Go
+        uses: actions/[email protected]
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Install Go dependencies
+        run: |
+          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.37.1
+          curl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v2.13.1
+          go install honnef.co/go/tools/cmd/[email protected]
+          go install github.com/ory/go-acc@latest
+          go install github.com/axw/gocov/gocov@latest
+          go install github.com/kisielk/errcheck@latest
+
+      - name: Run lint and test
+        run: |
+          staticcheck ./...
+          go fmt $(go list ./... | grep -v /vendor/)
+          go vet $(go list ./... | grep -v /vendor/)
+          errcheck -ignore 'os:.*,' $(go list ./... | grep -v /vendor/)
+          gosec -exclude=G304,G101 ./...
+          go-acc -o coverage.txt --ignore generated,cmd  ./... -- -timeout 60m
+          grep -v "generated.go" coverage.txt > coverage.out
+          go tool cover -html=coverage.out -o coverage.html
+          gocov convert coverage.out > coverage.json
+          gocov report coverage.json > coverage_report.txt
+          tail coverage_report.txt
+        
+      - name: Install goveralls
+        env:
+          GO111MODULE: off
+        run: go get github.com/mattn/goveralls
+
+      - name: Send coverage
+        env:
+          COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: goveralls -coverprofile=coverage.out  -service=github

.gitignore

@@ -0,0 +1,11 @@
+*env.sh
+generate.sh
+
+coverage.txt
+.idea/
+.gitmessage.txt
+.vscode/
+
+.DS_Store
+
+*debug*

.golangci.yaml

@@ -0,0 +1,51 @@
+# Options for analysis running.
+run:
+  timeout: 10m
+  tests: false
+  concurrency: 4
+
+issues:
+  exclude-dirs:
+    - pkg/clinical/presentation/graph/
+
+linters:
+  disable-all: true
+  enable:
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - typecheck
+    - unused
+    - gosec
+    - misspell
+    - revive
+    - funlen
+    - gofmt
+    - unparam
+    - errorlint
+    - bodyclose
+    - gocritic
+    - nilerr
+    - ireturn
+    - importas
+    - wsl
+    - exportloopref
+    - nilerr
+    - makezero
+    - reassign
+
+linters-settings:
+  staticcheck:
+    checks: ["all"]
+  funlen:
+    lines: -1
+    statements: -1
+  revive:
+    rules:
+      - name: unused-parameter
+        severity: warning
+        disabled: true
+        arguments:
+          - allowRegex: "^_"

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/gitguardian/ggshield
+    rev: v1.11.0
+    hooks:
+      - id: ggshield
+        stages: [commit]
+  - repo: https://github.com/dnephin/pre-commit-golang
+    rev: v0.5.0
+    hooks:
+      - id: golangci-lint # install https://golangci-lint.run/usage/install/#local-installation

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## 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 [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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/