-
Notifications
You must be signed in to change notification settings - Fork 456
/
cii_client.go
75 lines (67 loc) · 2.08 KB
/
cii_client.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
// Copyright 2021 OpenSSF Scorecard Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package clients
import (
"context"
)
const (
// Unknown or non-parsable CII Best Practices badge.
Unknown BadgeLevel = iota
// NotFound represents when CII Best Practices returns an empty response for a project.
NotFound
// InProgress state of CII Best Practices badge.
InProgress
// Passing level for CII Best Practices badge.
Passing
// Silver level for CII Best Practices badge.
Silver
// Gold level for CII Best Practices badge.
Gold
)
// BadgeLevel corresponds to CII-Best-Practices badge levels.
// https://www.bestpractices.dev/en
type BadgeLevel uint
// String returns a string value for BadgeLevel enum.
func (badge BadgeLevel) String() string {
switch badge {
case Unknown:
return "Unknown"
case NotFound:
return "not_found"
case InProgress:
return "in_progress"
case Passing:
return "passing"
case Silver:
return "silver"
case Gold:
return "gold"
default:
return ""
}
}
// CIIBestPracticesClient interface returns the BadgeLevel for a repo URL.
type CIIBestPracticesClient interface {
GetBadgeLevel(ctx context.Context, uri string) (BadgeLevel, error)
}
// DefaultCIIBestPracticesClient returns http-based implementation of the interface.
func DefaultCIIBestPracticesClient() CIIBestPracticesClient {
return &httpClientCIIBestPractices{}
}
// BlobCIIBestPracticesClient returns a blob-based implementation of the interface.
func BlobCIIBestPracticesClient(bucketURL string) CIIBestPracticesClient {
return &blobClientCIIBestPractices{
bucketURL: bucketURL,
}
}