Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: introduce top-pages command using ahrefs (#3)
- Loading branch information
Showing
7 changed files
with
206 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * Copyright 2024 Adobe. All rights reserved. | ||
| * This file is licensed to you 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 REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import path from 'path'; | ||
| import fs from 'fs'; | ||
| import { fileURLToPath } from 'url'; | ||
| import { csv2json, json2csv } from 'json-2-csv'; | ||
| import { generateFileName } from './file-lib.js'; | ||
|
|
||
| const AHREFS_API_BASE_URL = 'https://api.ahrefs.com/v3'; | ||
| const OUTPUT_DIR = path.join(path.dirname(fileURLToPath(import.meta.url)), 'output'); | ||
|
|
||
| const sendRequest = async (endpoint, queryParams = {}) => { | ||
| const queryParamsKeys = Object.keys(queryParams); | ||
| const queryString = queryParamsKeys.length > 0 | ||
| ? `?${queryParamsKeys | ||
| .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(queryParams[key])}`) | ||
| .join('&')}` : ''; | ||
|
|
||
| const fullAuditRef = `${AHREFS_API_BASE_URL}${endpoint}${queryString}`; | ||
| const response = await fetch(fullAuditRef, { | ||
| method: 'GET', | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| Authorization: `Bearer ${process.env.AHREFS_API_KEY}`, | ||
| }, | ||
| }); | ||
|
|
||
| if (!response.ok) { | ||
| throw new Error(`Ahrefs API request failed with status: ${response.status}`); | ||
| } | ||
|
|
||
| try { | ||
| const result = await response.json(); | ||
| return { | ||
| result, | ||
| fullAuditRef, | ||
| }; | ||
| } catch (e) { | ||
| throw new Error(`Error parsing Ahrefs API response: ${e.message}`); | ||
| } | ||
| }; | ||
|
|
||
| export const getTopPages = async (target, limit) => { | ||
| // check if file exists that starts with and return immediately if it does | ||
| const files = fs.readdirSync(OUTPUT_DIR); | ||
| const existingFile = files.find((file) => file.startsWith(`${generateFileName(target, `top-pages-${limit}`)}`)); | ||
| if (existingFile) { | ||
| console.log(`Using cached file to avoid Ahrefs API call: ${existingFile}`); | ||
| const cachedContent = fs.readFileSync(`${OUTPUT_DIR}/${existingFile}`); | ||
| return csv2json(cachedContent.toString()); | ||
| } | ||
|
|
||
| const queryParams = { | ||
| select: [ | ||
| 'url', | ||
| 'sum_traffic', | ||
| ].join(','), | ||
| limit, | ||
| order_by: 'sum_traffic_merged', | ||
| target, | ||
| date: new Date().toISOString().split('T')[0], | ||
| date_compared: new Date(Date.now() - 30 * 24 * 60 * 60 * 1000).toISOString().split('T')[0], | ||
| output: 'json', | ||
| }; | ||
| // safe result as csv to cache | ||
| const { result } = await sendRequest('/site-explorer/top-pages', queryParams); | ||
| if (result.pages) { | ||
| const csvResult = json2csv(result.pages); | ||
| const FILE_PATH = path.join(OUTPUT_DIR, `${generateFileName(target, `top-pages-${limit}`)}-${Date.now()}.csv`); | ||
| fs.writeFileSync(FILE_PATH, csvResult); | ||
| return result.pages; | ||
| } else { | ||
| throw new Error('No pages found in Ahrefs API response.'); | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /* | ||
| * Copyright 2024 Adobe. All rights reserved. | ||
| * This file is licensed to you 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 REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import path from 'path'; | ||
| import { fileURLToPath } from 'url'; | ||
|
|
||
| export const OUTPUT_DIR = path.join(path.dirname(fileURLToPath(import.meta.url)), 'output'); | ||
| export const sanitizeFilename = (url) => url.replace(/[^a-zA-Z0-9]/g, '_').toLowerCase(); | ||
|
|
||
| export const generateFileName = (siteUrl, title) => `${sanitizeFilename(title)}-${sanitizeFilename(siteUrl)}`; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters