Adding authorization functionality to increase request limit #19
Conversation
### What's done: 1. New diktat version 2. Authorization functionality 3. Refactoring
| ArgType.String, | ||
| shortName = "a", | ||
| description = """GitHub username and authorization token separated by ':' | ||
| | (can be used to extend the number of requests)""".trimMargin() |
There was a problem hiding this comment.
Maybe, provide some info about token requirements (scopes, permissions)?
There was a problem hiding this comment.
Github tokens can have different scopes and give token bearers different permission (read only or write). You should specify required settings for token for your app.
There was a problem hiding this comment.
we don't need any permissions, as we expect to access only open public repositories
token here is only to have a bigger limit of attempts
There was a problem hiding this comment.
Ok, but if I want to use git-stat with token and I open token creation page what should I choose? If I generate token with minimum permissions, will it be enough, or will I have to regenerate it again? I'd feel confused in this situation.
| auth.let { | ||
| val splitAuth = auth.split(":") | ||
| if (splitAuth.size != 2) { | ||
| """Incorrect value ($auth) is passed to 'auth' property. |
There was a problem hiding this comment.
I don't think you should log it here - user sees the command they just entered, and logging secret token might be considered a security risk.
| @@ -10,6 +10,7 @@ import kotlin.system.exitProcess | |||
|
|
|||
| /** | |||
| * Yes, it is yet another logger, because the quality and functionality of the current loggers is extremely poor | |||
There was a problem hiding this comment.
I don't really see a reason for this: for JVM projects you still can use kotlin-logging as a facade and logback/log4j as an implementation.
There was a problem hiding this comment.
will make it later, but I do not think that it is a good idea actually
There was a problem hiding this comment.
Well, I don't insist and for a small CLI tool it's probably fine to have a small custom logger, I'm just not quite convinced of advantages over existing solutions.
### What's done: 1. Review notes
What's done: