shields-fun-fork/services/hexpm/hexpm.service.js at 7f8aba57fa6d3f695e83e2c0a364f5055e608360 · jNullj/shields-fun-fork · GitHub

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
import Joi from 'joi'
import { renderDownloadsBadge } from '../downloads.js'
import { maybePluralize } from '../text-formatters.js'
import { renderVersionBadge } from '../version.js'
import { BaseJsonService, pathParams } from '../index.js'

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(),
  latest_stable_version: Joi.string().allow(null),
  latest_version: Joi.string().required(),
}).required()

const description = '[Hex.pm](https://hex.pm/) is a package registry for Erlang'

class BaseHexPmService extends BaseJsonService {
  static defaultBadgeData = { label: 'hex' }

  async fetch({ packageName }) {
    return this._requestJson({
      schema: hexSchema,
      url: `https://hex.pm/api/packages/${packageName}`,
    })
  }
}

class HexPmLicense extends BaseHexPmService {
  static category = 'license'

  static route = {
    base: 'hexpm/l',
    pattern: ':packageName',
  }

  static openApi = {
    '/hexpm/l/{packageName}': {
      get: {
        summary: 'Hex.pm License',
        description,
        parameters: pathParams({
          name: 'packageName',
          example: 'plug',
        }),
      },
    },
  }

  static defaultBadgeData = { 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 category = 'version'

  static route = {
    base: 'hexpm/v',
    pattern: ':packageName',
  }

  static openApi = {
    '/hexpm/v/{packageName}': {
      get: {
        summary: 'Hex.pm Version',
        description,
        parameters: pathParams({
          name: 'packageName',
          example: 'plug',
        }),
      },
    },
  }

  static render({ version }) {
    return renderVersionBadge({ version })
  }

  async handle({ packageName }) {
    const json = await this.fetch({ packageName })
    return this.constructor.render({
      version: json.latest_stable_version || json.latest_version,
    })
  }
}

const periodMap = {
  dd: {
    field: 'day',
    label: 'day',
  },
  dw: {
    field: 'week',
    label: 'week',
  },
  dt: {
    field: 'all',
  },
}

class HexPmDownloads extends BaseHexPmService {
  static category = 'downloads'

  static route = {
    base: 'hexpm',
    pattern: ':interval/:packageName',
  }
  static routeEnum = ['dd', 'dw', 'dt']

  static openApi = {
    '/hexpm/{interval}/{packageName}': {
      get: {
        summary: 'Hex.pm Downloads',
        description,
        parameters: pathParams(
          {
            name: 'interval',
            example: 'dw',
            schema: { type: 'string', enum: this.getEnum('interval') },
            description: 'Daily, Weekly, or Total downloads',
          },
          {
            name: 'packageName',
            example: 'plug',
          },
        ),
      },
    },
  }

  static defaultBadgeData = { label: 'downloads' }

  async handle({ interval, packageName }) {
    const json = await this.fetch({ packageName })
    const downloads = json.downloads[periodMap[interval].field]
    return renderDownloadsBadge({
      downloads,
      interval: periodMap[interval].label,
    })
  }
}

export default [HexPmDownloads, HexPmLicense, HexPmVersion]