nandlabs/go-commons

A common collection of utilities for Go programming language

go-commons's Issues

Redirect Package namespace to Documentation

Redirect the webpage go.nandlabs.io/commons to the documentation page.

Depends on nandlabs/golly#9

Create a Semver package

Create a package to parse and compare Semantic versioning as specified in https://semver.org

Add Test Cases fro VFS

The VFS Package does not have tests. Need to add test cases for the same.

Documentation for the Clients Package

Create a README for the client package and link the project readme

Copy Function incomplete

the Copy() implementation in BaseVFS is incomplete

If the source is a directory, the implementation seems to be incomplete

https://github.com/nandlabs/go-commons/blob/main/vfs/base_fs.go#L29

PR Guidelines

Need to create PR Guidelines for the project

AES Encrypt and Decrypt Util

Create a utility for AES Encryption and Decryption

1. Use String as well as Bytes inout

add multipart support in rest client

codec to use content-type with character encoding

codec documentation

Codec documentation

TODO Cleanup

Move library to golly

go-commons is a very boring name. Let's Rename the library to golly .
Its an acronym that loosely means Go Open Source Library

1. Update the project name
2. Update Go Mod name
3. Update Main Documentation Read Me

L3 Message Provider Support

Add message provider support for l3

Array Index incorrect in checkForHelpfn

If no params are passed the array index 1 is being checked which causes a panic

VFile Create new DeleteAll Fn

The current VFile interface defines a function Delete() that is supposed to delete file or directory. However this is confusing to use.

1. Define a new function named DeleteAll in the VFile interface. This function will delete a file or directory with all its contents.
2. Update the defn of Delete() fn to just delete file and throw error in case of directory
3. Update the DeleteMatching() fn to check if the vFile object resolved by the filter is a directory ?

1. If it s a directory call the resolvedFile.DeleteAll()
2. If its a File call resolvedFile.Delete()

FnUtils test cases

add test cases for fnutils and erratics package.

add ssl support in the rest client

Add nill checks in fnutils

1. Add a nil function check and return error in case no funciton is provided as a parameter
2. Refactor where the function is used

CLI App

Create a command line utility to execute command line apps.

Yaml implementaion

Currently the go commons uses an external dependency for yaml support in codec.
I would like to get away with this dependency with an implementation of yaml Reader and Writer within go commons

Create Contribution guidelines

1. Development how to work, Comms Channel etc.
2. Project Naming Conventions
3. Pull Requests
4. Documentation
5. Approvers and Maintainers List and how to join
6. Any general guidelines

Create Str Functions Library

Create String library with following use cases

1. Case Conversion
2. String Manuplation

Create a HTTP Client interface tailored for REST APIs

Need a new HTTP Client interface that encapsulates all operations for the REST API such as

1. Authentication

• Basic
• Implicit token generation for token based auth
• Auto renewal of tokens

3. Codec/Data Transformation
4. SSL and External certificate/key store usage
5. Retries
6. Circuit Breaker implementation
7. HTTP redirect follows with limits
8. Reusing and Caching of clients
9. Error Handling

[FEATURE] Implement Circuit Breaker, Retry Handler and Filters

CheckSum Calculator

Add a utility to calculate checksum for text content as well as for binary/file content

Documentation for the cli package

The CLI Package soruce files lacks documentation. Add inline documentations for the source files.

Fix the infinite loop

https://github.com/nandlabs/go-commons/blob/main/clients/rest/request.go#L101 causes an infinite loop on adding content type

Fileutils test cases fail

Failing test case to be fixed
TestFileExists/Existing_File

ListAll Implementation

The ListAll() fn implementation should be able to handle the nested folder strucutre scenario.
The current implementation is unable to process nested folder structure

Create a wrappable multi error function

[BUG] The Test data needs to be in directory testdata

All test resources needs to be in a directory call testdata.

The resources for vfs and clients/rest packages are in different directory.

Remove Println Statements

Remove the println statements from toHttpRequest method in rest client request.go

Add Branch Protection Rules

The Branches need to be protected based on types

• Main Branch

  1. Cannot push Directly
  2. Neds a PR
  3. Needs Approval for PR to merge

• Feature Branch/Bug Fixes

  1. Need an issue to push and needs to be mentioned in the commit message

CLI Flag Parsing only happens in begining

When I test the example3 in the readme go run main.go -pd="test" -pf="dev" test it works fine but go run main.go test -pd="test" -pf="dev" does not parse flags

Add Mime Consts

Create a consts of known mimetypes to ioutils package.
Refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types for common mime types and the extension.

Remove fmt.Print Statements

Remove unnecessary fmt.Print Statements from the code

LocalSecrets Store Implementation

Implement a local Secret store as mentioned by #27

Community Standards

Check and add Github Community Standards

Testing Utils

Create a set of utils for testing assertion

This is required for testing files.

New Package Name : testing

VFS Create Description

Add a description to VFS Create functions

VFS Create is generally means creation of file. However different VFS Implementation can have its own constraints.

Document the following on the interface function defn.

1. Default behaviour
2. Accepted Behaviour
3. Caveats if any

This is needs to happen for all the individual VFS Implementation

Client Messaging Support

Requirements

• add a messaging client parallel to rest
  2 providers to be added

  1. vmp -> virtual message producer
  2. vmc -> virtual message consumer

• support in-out and out-only

• design to be created based on VFS pattern

• create a local implementation based on channels for vmp and vmc

Readme For Secrets Management

Create a readme file for secret management.

Missing function to add path params

The Rest Client in the go commons is missing support for path parameters.

Codec Pretty Print

Add Pretty Print support for xml and json codec

Text encoding util

Create a utility to be able to convert text between different formats.

Check if Endianness support is required.

Utils inline code documentation

Any package/collection of functions that does not have a specific feature in itself should have a details inline documentation of the functions.

Rest Client HTTP/HTTPS env proxy

The rest.Client#UseEnvProxy currently does not specify if the proxy is for HTTP or HTTPs update the function to include the protocol as well.

Create Depandabot Version update config

Dependabot version updates config needs to be added

Credentials Management

Create a package that can handle sensitive information like

1. Passwords
2. Certificates ?

Documentation for Semver

Create a Readme for the SemVer Package