-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
hexpm.service.js
186 lines (161 loc) · 3.98 KB
/
hexpm.service.js
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
'use strict'
const Joi = require('@hapi/joi')
const { metric, addv, maybePluralize } = require('../text-formatters')
const { downloadCount, version: versionColor } = require('../color-formatters')
const { BaseJsonService } = require('..')
const hexSchema = Joi.object({
downloads: Joi.object({
// these keys may or may not exist
all: Joi.number()
.integer()
.default(0),
week: Joi.number()
.integer()
.default(0),
day: Joi.number()
.integer()
.default(0),
}).required(),
meta: Joi.object({
licenses: Joi.array().required(),
}).required(),
releases: Joi.array()
.items(Joi.object({ version: Joi.string().required() }).required())
.required(),
}).required()
class BaseHexPmService extends BaseJsonService {
static get defaultBadgeData() {
return { label: 'hex' }
}
async fetch({ packageName }) {
return this._requestJson({
schema: hexSchema,
url: `https://hex.pm/api/packages/${packageName}`,
})
}
}
class HexPmLicense extends BaseHexPmService {
static get category() {
return 'license'
}
static get route() {
return {
base: 'hexpm/l',
pattern: ':packageName',
}
}
static get examples() {
return [
{
title: 'Hex.pm',
namedParams: { packageName: 'plug' },
staticPreview: this.render({ licenses: ['Apache 2'] }),
},
]
}
static get defaultBadgeData() {
return { label: 'license' }
}
static render({ licenses }) {
if (licenses.length === 0) {
return {
label: 'license',
message: 'Unknown',
color: 'lightgrey',
}
}
return {
label: maybePluralize('license', licenses),
message: licenses.join(', '),
color: 'blue',
}
}
async handle({ packageName }) {
const json = await this.fetch({ packageName })
return this.constructor.render({ licenses: json.meta.licenses })
}
}
class HexPmVersion extends BaseHexPmService {
static get category() {
return 'version'
}
static get route() {
return {
base: 'hexpm/v',
pattern: ':packageName',
}
}
static get examples() {
return [
{
title: 'Hex.pm',
namedParams: { packageName: 'plug' },
staticPreview: this.render({ version: '1.6.4' }),
},
]
}
static render({ version }) {
return { message: addv(version), color: versionColor(version) }
}
async handle({ packageName }) {
const json = await this.fetch({ packageName })
return this.constructor.render({ version: json.releases[0].version })
}
}
function DownloadsForInterval(interval) {
const { base, messageSuffix, name } = {
day: {
base: 'hexpm/dd',
messageSuffix: '/day',
name: 'HexPmDownloadsDay',
},
week: {
base: 'hexpm/dw',
messageSuffix: '/week',
name: 'HexPmDownloadsWeek',
},
all: {
base: 'hexpm/dt',
messageSuffix: '',
name: 'HexPmDownloadsTotal',
},
}[interval]
return class HexPmDownloads extends BaseHexPmService {
static get name() {
return name
}
static get category() {
return 'downloads'
}
static get route() {
return {
base,
pattern: ':packageName',
}
}
static get examples() {
return [
{
title: 'Hex.pm',
namedParams: { packageName: 'plug' },
staticPreview: this.render({ downloads: 85000 }),
},
]
}
static get defaultBadgeData() {
return { label: 'downloads' }
}
static render({ downloads }) {
return {
message: `${metric(downloads)}${messageSuffix}`,
color: downloadCount(downloads),
}
}
async handle({ packageName }) {
const json = await this.fetch({ packageName })
return this.constructor.render({ downloads: json.downloads[interval] })
}
}
}
const downloadsServices = ['day', 'week', 'all'].map(DownloadsForInterval)
module.exports = [...downloadsServices, HexPmLicense, HexPmVersion]