generated from shanilhirani/seed
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat(app): adds main.go and credly.go (type) for return api response from credly initial build * feat(using-cobra-for-cli-framework): mini refactor to enable cobra framework * feat(fetch): adds a simple filter for retrieving only badge data * feat(fetch): tweaked the cobra cli and tidied up some of warnings * feat(fetch): added a flag to include expired certs, default logic is to exclude modified the filterdata func to filter out expird certs and uses a helper function for date comparison * refactor(fetch): parsing time function trying to optimise by reducing allocations * refactor(rename): updates the struct fields for readability and accuracy * feat(outfile): introduced a method to write output to markdown users can passing filename via cli, default behaviour still sends data to stdout unless flags are provided * feat(tofile.go): split into sub functions to assist with the ability of updating content of files(new and existing * test: Validate the date parser works as expected (#3) * test: Validate dat parser works as expected * chore: Update go mod * refactor: Added some standard errors for uniformity inerror handling * test: Add a few variations of different dateformats * docs: Add comments to exported Errors * refactor: Improved the parameter validation slightly to accept returning multiple params * fix: Scrap this test as it breaks CI and doesn't do anything * refactor: Implemented the io.Writer interface to facilitate testing (#4) * refactor: Refactored the file writer to implement the io.Writer interface for testing * test: Added some tests for the file writer * fix: Added a helper/decorator closer to return the error in a defer * fix: Fix unsafe path return error reported in CI * refactor: Renamed the parameter name to avoid collision with the filepath package * style(pre-commit): checking files against pre-commit * refactor(licence): switch to MIT License * docs(docs): updated readme with better examples and descriptions * fix(fetch): handle case for badges with null value for expiration some badges do not have expiry dates therefore API response contains a null value, nested if should handle by adding a zero value for the expected data type --------- Co-authored-by: Richard Weston <[email protected]>
- Loading branch information
1 parent
8a6f93b
commit ef894d5
Showing
20 changed files
with
1,099 additions
and
220 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,3 @@ | ||
| { | ||
| "recommendations": [ | ||
| "golang.Go" | ||
| ] | ||
| "recommendations": ["golang.Go"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,17 @@ | ||
| { | ||
| // Use IntelliSense to learn about possible attributes. | ||
| // Hover to view descriptions of existing attributes. | ||
| // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "name": "Launch", | ||
| "type": "go", | ||
| "request": "launch", | ||
| "mode": "auto", | ||
| "program": "${fileDirname}", | ||
| "env": {}, | ||
| "args": [] | ||
| } | ||
| ] | ||
| // Use IntelliSense to learn about possible attributes. | ||
| // Hover to view descriptions of existing attributes. | ||
| // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "name": "Launch", | ||
| "type": "go", | ||
| "request": "launch", | ||
| "mode": "auto", | ||
| "program": "${fileDirname}", | ||
| "env": {}, | ||
| "args": [] | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,29 @@ | ||
| { | ||
| "[go]": { | ||
| "editor.formatOnSave": true, | ||
| "editor.codeActionsOnSave": { | ||
| "source.organizeImports": "explicit" | ||
| }, | ||
| }, | ||
| "[go.mod]": { | ||
| "editor.formatOnSave": true, | ||
| "editor.codeActionsOnSave": { | ||
| "source.organizeImports": "explicit" | ||
| }, | ||
| }, | ||
| // gopls | ||
| "go.useLanguageServer": true, | ||
| "gopls": { | ||
| "formatting.local": "github.com/shanilhirani/go-credly", | ||
| "formatting.gofumpt": true | ||
| }, | ||
| // golangci-lint | ||
| "go.lintTool": "golangci-lint", | ||
| "go.lintFlags": [ | ||
| "--fast" | ||
| ], | ||
| "[go][go.mod]": { | ||
| "editor.codeActionsOnSave": { | ||
| "source.organizeImports": "explicit" | ||
| } | ||
| }, | ||
| "cSpell.words": [ | ||
| "Credly's", | ||
| "Credly" | ||
| ] | ||
| "[go]": { | ||
| "editor.formatOnSave": true, | ||
| "editor.codeActionsOnSave": { | ||
| "source.organizeImports": "explicit" | ||
| } | ||
| }, | ||
| "[go.mod]": { | ||
| "editor.formatOnSave": true, | ||
| "editor.codeActionsOnSave": { | ||
| "source.organizeImports": "explicit" | ||
| } | ||
| }, | ||
| // gopls | ||
| "go.useLanguageServer": true, | ||
| "gopls": { | ||
| "formatting.local": "github.com/shanilhirani/go-credly", | ||
| "formatting.gofumpt": true | ||
| }, | ||
| // golangci-lint | ||
| "go.lintTool": "golangci-lint", | ||
| "go.lintFlags": ["--fast"], | ||
| "[go][go.mod]": { | ||
| "editor.codeActionsOnSave": { | ||
| "source.organizeImports": "explicit" | ||
| } | ||
| }, | ||
| "cSpell.words": ["Credly", "Credly's", "nosec", "pkgs"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,17 @@ | ||
| { | ||
| // See https://go.microsoft.com/fwlink/?LinkId=733558 | ||
| // for the documentation about the tasks.json format | ||
| "version": "2.0.0", | ||
| "tasks": [ | ||
| { | ||
| "label": "make", | ||
| "type": "shell", | ||
| "command": "make", | ||
| "problemMatcher": [ | ||
| "$go" | ||
| ], | ||
| "group": { | ||
| "kind": "build", | ||
| "isDefault": true | ||
| } | ||
| } | ||
| ] | ||
| // See https://go.microsoft.com/fwlink/?LinkId=733558 | ||
| // for the documentation about the tasks.json format | ||
| "version": "2.0.0", | ||
| "tasks": [ | ||
| { | ||
| "label": "make", | ||
| "type": "shell", | ||
| "command": "make", | ||
| "problemMatcher": ["$go"], | ||
| "group": { | ||
| "kind": "build", | ||
| "isDefault": true | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,121 +1,21 @@ | ||
| Creative Commons Legal Code | ||
|
|
||
| CC0 1.0 Universal | ||
|
|
||
| CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE | ||
| LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN | ||
| ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS | ||
| INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES | ||
| REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS | ||
| PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM | ||
| THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED | ||
| HEREUNDER. | ||
|
|
||
| Statement of Purpose | ||
|
|
||
| The laws of most jurisdictions throughout the world automatically confer | ||
| exclusive Copyright and Related Rights (defined below) upon the creator | ||
| and subsequent owner(s) (each and all, an "owner") of an original work of | ||
| authorship and/or a database (each, a "Work"). | ||
|
|
||
| Certain owners wish to permanently relinquish those rights to a Work for | ||
| the purpose of contributing to a commons of creative, cultural and | ||
| scientific works ("Commons") that the public can reliably and without fear | ||
| of later claims of infringement build upon, modify, incorporate in other | ||
| works, reuse and redistribute as freely as possible in any form whatsoever | ||
| and for any purposes, including without limitation commercial purposes. | ||
| These owners may contribute to the Commons to promote the ideal of a free | ||
| culture and the further production of creative, cultural and scientific | ||
| works, or to gain reputation or greater distribution for their Work in | ||
| part through the use and efforts of others. | ||
|
|
||
| For these and/or other purposes and motivations, and without any | ||
| expectation of additional consideration or compensation, the person | ||
| associating CC0 with a Work (the "Affirmer"), to the extent that he or she | ||
| is an owner of Copyright and Related Rights in the Work, voluntarily | ||
| elects to apply CC0 to the Work and publicly distribute the Work under its | ||
| terms, with knowledge of his or her Copyright and Related Rights in the | ||
| Work and the meaning and intended legal effect of CC0 on those rights. | ||
|
|
||
| 1. Copyright and Related Rights. A Work made available under CC0 may be | ||
| protected by copyright and related or neighboring rights ("Copyright and | ||
| Related Rights"). Copyright and Related Rights include, but are not | ||
| limited to, the following: | ||
|
|
||
| i. the right to reproduce, adapt, distribute, perform, display, | ||
| communicate, and translate a Work; | ||
| ii. moral rights retained by the original author(s) and/or performer(s); | ||
| iii. publicity and privacy rights pertaining to a person's image or | ||
| likeness depicted in a Work; | ||
| iv. rights protecting against unfair competition in regards to a Work, | ||
| subject to the limitations in paragraph 4(a), below; | ||
| v. rights protecting the extraction, dissemination, use and reuse of data | ||
| in a Work; | ||
| vi. database rights (such as those arising under Directive 96/9/EC of the | ||
| European Parliament and of the Council of 11 March 1996 on the legal | ||
| protection of databases, and under any national implementation | ||
| thereof, including any amended or successor version of such | ||
| directive); and | ||
| vii. other similar, equivalent or corresponding rights throughout the | ||
| world based on applicable law or treaty, and any national | ||
| implementations thereof. | ||
|
|
||
| 2. Waiver. To the greatest extent permitted by, but not in contravention | ||
| of, applicable law, Affirmer hereby overtly, fully, permanently, | ||
| irrevocably and unconditionally waives, abandons, and surrenders all of | ||
| Affirmer's Copyright and Related Rights and associated claims and causes | ||
| of action, whether now known or unknown (including existing as well as | ||
| future claims and causes of action), in the Work (i) in all territories | ||
| worldwide, (ii) for the maximum duration provided by applicable law or | ||
| treaty (including future time extensions), (iii) in any current or future | ||
| medium and for any number of copies, and (iv) for any purpose whatsoever, | ||
| including without limitation commercial, advertising or promotional | ||
| purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each | ||
| member of the public at large and to the detriment of Affirmer's heirs and | ||
| successors, fully intending that such Waiver shall not be subject to | ||
| revocation, rescission, cancellation, termination, or any other legal or | ||
| equitable action to disrupt the quiet enjoyment of the Work by the public | ||
| as contemplated by Affirmer's express Statement of Purpose. | ||
|
|
||
| 3. Public License Fallback. Should any part of the Waiver for any reason | ||
| be judged legally invalid or ineffective under applicable law, then the | ||
| Waiver shall be preserved to the maximum extent permitted taking into | ||
| account Affirmer's express Statement of Purpose. In addition, to the | ||
| extent the Waiver is so judged Affirmer hereby grants to each affected | ||
| person a royalty-free, non transferable, non sublicensable, non exclusive, | ||
| irrevocable and unconditional license to exercise Affirmer's Copyright and | ||
| Related Rights in the Work (i) in all territories worldwide, (ii) for the | ||
| maximum duration provided by applicable law or treaty (including future | ||
| time extensions), (iii) in any current or future medium and for any number | ||
| of copies, and (iv) for any purpose whatsoever, including without | ||
| limitation commercial, advertising or promotional purposes (the | ||
| "License"). The License shall be deemed effective as of the date CC0 was | ||
| applied by Affirmer to the Work. Should any part of the License for any | ||
| reason be judged legally invalid or ineffective under applicable law, such | ||
| partial invalidity or ineffectiveness shall not invalidate the remainder | ||
| of the License, and in such case Affirmer hereby affirms that he or she | ||
| will not (i) exercise any of his or her remaining Copyright and Related | ||
| Rights in the Work or (ii) assert any associated claims and causes of | ||
| action with respect to the Work, in either case contrary to Affirmer's | ||
| express Statement of Purpose. | ||
|
|
||
| 4. Limitations and Disclaimers. | ||
|
|
||
| a. No trademark or patent rights held by Affirmer are waived, abandoned, | ||
| surrendered, licensed or otherwise affected by this document. | ||
| b. Affirmer offers the Work as-is and makes no representations or | ||
| warranties of any kind concerning the Work, express, implied, | ||
| statutory or otherwise, including without limitation warranties of | ||
| title, merchantability, fitness for a particular purpose, non | ||
| infringement, or the absence of latent or other defects, accuracy, or | ||
| the present or absence of errors, whether or not discoverable, all to | ||
| the greatest extent permissible under applicable law. | ||
| c. Affirmer disclaims responsibility for clearing rights of other persons | ||
| that may apply to the Work or any use thereof, including without | ||
| limitation any person's Copyright and Related Rights in the Work. | ||
| Further, Affirmer disclaims responsibility for obtaining any necessary | ||
| consents, permissions or other rights required for any use of the | ||
| Work. | ||
| d. Affirmer understands and acknowledges that Creative Commons is not a | ||
| party to this document and has no duty or obligation with respect to | ||
| this CC0 or use of the Work. | ||
| MIT License | ||
|
|
||
| Copyright (c) [2024] [Shanil Hirani] | ||
|
|
||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.