feat: initial version

Author: gr2m

src/auth.ts

@@ -0,0 +1,8 @@
+import { Authentication } from "./types";
+
+export async function auth(reason: string): Promise<Authentication> {
+  return {
+    type: "unauthenticated",
+    reason,
+  };
+}

src/hook.ts

@@ -0,0 +1,52 @@
+import { RequestError } from "@octokit/request-error";
+
+import {
+  AnyResponse,
+  EndpointDefaults,
+  EndpointOptions,
+  RequestInterface,
+  RequestParameters,
+  Route,
+} from "./types";
+import { isRateLimitError } from "./is-rate-limit-error";
+import { isAbuseLimitError } from "./is-abuse-limit-error";
+
+const MUTATING_METHODS = ["DELETE", "PATCH", "POST", "PUT"];
+
+export async function hook(
+  reason: string,
+  request: RequestInterface,
+  route: Route | EndpointOptions,
+  parameters?: RequestParameters
+): Promise<AnyResponse> {
+  const endpoint: EndpointDefaults = request.endpoint.merge(
+    route as string,
+    parameters
+  );
+
+  if (MUTATING_METHODS.includes(endpoint.method)) {
+    throw new RequestError(
+      `"${endpoint.method} ${endpoint.url}" is not permitted due to lack authentication. Reason: ${reason}`,
+      403,
+      {
+        request: request.endpoint.parse(endpoint),
+      }
+    );
+  }
+
+  return request(endpoint as EndpointOptions).catch((error) => {
+    if (error.status === 404) {
+      error.message = `Not found. May be due to lack of authentication. Reason: ${reason}`;
+    }
+
+    if (isRateLimitError(error)) {
+      error.message = `API rate limit exceeded. This maybe caused by the lack of authentication. Reason: ${reason}`;
+    }
+
+    if (isAbuseLimitError(error)) {
+      error.message = `You have triggered an abuse detection mechanism. This maybe caused by the lack of authentication. Reason: ${reason}`;
+    }
+
+    throw error;
+  });
+}

src/index.ts

@@ -0,0 +1,23 @@
+import { auth } from "./auth";
+import { hook } from "./hook";
+import { StrategyInterface, Options, Authentication } from "./types";
+
+export type Types = {
+  StrategyOptions: Options;
+  AuthOptions: never;
+  Authentication: Authentication;
+};
+
+export const createUnauthenticatedAuth: StrategyInterface = function createUnauthenticatedAuth(
+  options: Options
+) {
+  if (!options || !options.reason) {
+    throw new Error(
+      "[@octokit/auth-unauthenticated] No reason passed to createUnauthenticatedAuth"
+    );
+  }
+
+  return Object.assign(auth.bind(null, options.reason), {
+    hook: hook.bind(null, options.reason),
+  });
+};

src/is-abuse-limit-error.ts

@@ -0,0 +1,11 @@
+import { RequestError } from "@octokit/request-error";
+
+const REGEX_ABUSE_LIMIT_MESSAGE = /\babuse\b/i;
+
+export function isAbuseLimitError(error: RequestError) {
+  if (error.status !== 403) {
+    return false;
+  }
+
+  return REGEX_ABUSE_LIMIT_MESSAGE.test(error.message);
+}

src/is-rate-limit-error.ts

@@ -0,0 +1,14 @@
+import { RequestError } from "@octokit/request-error";
+
+export function isRateLimitError(error: RequestError) {
+  if (error.status !== 403) {
+    return false;
+  }
+
+  /* istanbul ignore if */
+  if (!error.headers) {
+    return false;
+  }
+
+  return error.headers["x-ratelimit-remaining"] === "0";
+}

src/types.ts

@@ -0,0 +1,22 @@
+import * as OctokitTypes from "@octokit/types";
+
+export type AnyResponse = OctokitTypes.OctokitResponse<any>;
+export type StrategyInterface = OctokitTypes.StrategyInterface<
+  [Options],
+  [],
+  Authentication
+>;
+
+export type EndpointDefaults = OctokitTypes.EndpointDefaults;
+export type EndpointOptions = OctokitTypes.EndpointOptions;
+export type RequestParameters = OctokitTypes.RequestParameters;
+export type RequestInterface = OctokitTypes.RequestInterface;
+export type Route = OctokitTypes.Route;
+
+export type Options = {
+  reason: string;
+};
+export type Authentication = {
+  type: "unauthenticated";
+  reason: string;
+};