github-api-get/coverage/githubApi.js.html at master · roebi/github-api-get · GitHub

History

331 lines (326 loc) · 13 KB

Raw

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

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

<!doctype html>

<head>

<title>Code coverage report for githubApi.js</title>

.coverage-summary .sorter {

background-image: url(sort-arrow-sprite.png);

}

</style>

</head>

<body>

<h1><a href="index.html">All files</a> githubApi.js</h1>

<span class="quiet">Statements</span>

</div>

<span class="quiet">Branches</span>

</div>

<span class="quiet">Functions</span>

</div>

<span class="quiet">Lines</span>

</div>

Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the

previous block.

</p>

Filter:

</div>

</template>

</div>

<span class="cline-any cline-neutral"> </span></td><td class="text"><pre class="prettyprint lang-js">// githubApi.ts

import fetch from "node-fetch";

import jp from "jsonpath";

import { GITHUB_API_BASE_URL } from "./consts.js";

// const isProd = false; // import.meta.env.PROD; // false;

/**

* Returns the github topics of a project.

* @remarks

* This method is part of the {@link githubApi | github-api}.

* @param {String} loginName - The github login name

* @param {String} projectName - The github project name

* @param {boolean} infoLog - true Logs group and info into the console

* @param {boolean} isProd - true Calls fetch to github api, false returns mock data with same structure

* @returns {Promise<String[]>} The github topics of a project

export async function getGithubTopics(loginName, projectName, infoLog, isProd) {

if (infoLog) {

console.group("getGithubTopics");

}

if (loginName && projectName) {

if (infoLog) {

console.info("githubApi.ts: loginName: " + loginName);

console.info("githubApi.ts: projectName: " + projectName);

}

if (infoLog) {

console.groupEnd();

}

// https://www.npmjs.com/package/jsonpath MIT License

return Promise.resolve(jp.query(await returnData(loginName, projectName, infoLog, isProd), "$.topics[*]"));

} else {

if (infoLog) {

console.groupEnd();

}

return Promise.resolve([]);

}

/**

* Returns the github the project object / json of a project.

* @remarks

* This method is part of the {@link githubApi | github-api}.

* @param {String} loginName - The github login name

* @param {String} projectName - The github project name

* @param {boolean} infoLog - true Logs group and info into the console

* @param {boolean} isProd - true Calls fetch to github api, false returns mock data with same structure

* @returns {Promise<any>} The github the project object / json of a project

async function returnData(loginName, projectName, infoLog, isProd) {

if (isProd) {

// get from github project api

const GITHUB_API_PROJECT_URL = GITHUB_API_BASE_URL + "repos/" + loginName + "/";

const response = await fetch(GITHUB_API_PROJECT_URL + projectName);

if (!response.ok) {

if (infoLog) {

console.info(

"API rate limit exceeded for nnn.nnn.nnn.nnn. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)",

);

console.info("https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting");

}

// Github has a Rate Limit

// in this case Status is 403 Forbidden

// and return this Message Object / Json:

// {

// message: "API rate limit exceeded for nnn.nnn.nnn.nnn. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)",

// documentation_url: 'https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting'

// }

}

return await response.json();

} else {

// return mock data

// based on

// github-api/01-01-vanilla-HTML5-starter-page.json

return Promise.resolve({

name: "01-01-vanilla-HTML5-starter-page",

html_url: "https://github.com/roebi/01-01-vanilla-HTML5-starter-page",

description: "vanilla HTML 5 starter page - Have you ever heard of this HTML 5 tags ?",

homepage: "https://roebi.github.io/01-01-vanilla-HTML5-starter-page/",

topics: [" mockdata!", "html5", "html5-template", "roebi", "starter"],

});

}

 </pre></td></tr></table></pre>

</div>

Code coverage generated by

<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>

at 2023-09-19T10:01:15.058Z

</div>

window.onload = function () {

prettyPrint();

};

</script>

</body>

</html>

github-api-get/coverage/githubApi.js.html at master · roebi/github-api-get · GitHub

Expand file tree

Breadcrumbs

githubApi.js.html

Latest commit

History

Breadcrumbs

githubApi.js.html

File metadata and controls