mirror of
https://github.com/holidayapi/holidayapi-node.git
synced 2025-06-21 12:36:33 +00:00
Josh Sherman
046aadeea4
This started as a feature request for our upstream API (closes #33) that led to a bit of rework to help make the library a bit more flexible in terms of not needing modification when something on the API changes. This update also includes your typical round of dependency updates and a bit of preemptive planning by way of dropping support for Node.js as we're on the cusp of it being out of maintenance and the release of Node.js v18.
378 lines
10 KiB
TypeScript
378 lines
10 KiB
TypeScript
import * as nock from 'nock';
|
|
import { HolidayAPI } from '../src/holidayapi';
|
|
|
|
const baseUrl = 'https://holidayapi.com/v1/';
|
|
const key = 'b58e6dec-8a47-459f-a3c1-eaa26eb4dd30';
|
|
|
|
describe('holidayapi', () => {
|
|
describe('instantiation', () => {
|
|
it('should error when key is missing', () => {
|
|
expect.assertions(1);
|
|
expect(() => {
|
|
const holidayapi = new HolidayAPI({});
|
|
expect(holidayapi.key).toBeUndefined();
|
|
}).toThrowError(/missing api key/i);
|
|
});
|
|
|
|
it('should error when key is invalid format', () => {
|
|
expect.assertions(1);
|
|
expect(() => {
|
|
const holidayapi = new HolidayAPI({
|
|
key: 'zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz',
|
|
});
|
|
expect(holidayapi.key).toBeUndefined();
|
|
}).toThrowError(/invalid api key/i);
|
|
});
|
|
|
|
it('should error when version is too low', () => {
|
|
expect.assertions(1);
|
|
expect(() => {
|
|
const holidayapi = new HolidayAPI({ key, version: 0 });
|
|
expect(holidayapi.baseUrl).toBeUndefined();
|
|
}).toThrowError(/invalid version/i);
|
|
});
|
|
|
|
it('should error when version is too high', () => {
|
|
expect.assertions(1);
|
|
expect(() => {
|
|
const holidayapi = new HolidayAPI({ key, version: 2 });
|
|
expect(holidayapi.baseUrl).toBeUndefined();
|
|
}).toThrowError(/invalid version/i);
|
|
});
|
|
|
|
it('should assign class members', () => {
|
|
const holidayapi = new HolidayAPI({ key });
|
|
expect(holidayapi.baseUrl).toBe(baseUrl);
|
|
expect(holidayapi.key).toBe(key);
|
|
});
|
|
});
|
|
|
|
describe('v1 requests', () => {
|
|
const holidayapi = new HolidayAPI({ key });
|
|
const mockRequest = nock(baseUrl);
|
|
|
|
describe('/v1/countries', () => {
|
|
const basePath = `/countries?key=${key}`;
|
|
|
|
it('should return countries', async () => {
|
|
const expectedResponse = {
|
|
status: 200,
|
|
requests: {
|
|
used: 1000,
|
|
available: 9000,
|
|
resets: '2019-10-01 00:00:00',
|
|
},
|
|
countries: [
|
|
{
|
|
code: 'ST',
|
|
name: 'Sao Tome and Principe',
|
|
languages: ['pt'],
|
|
codes: {
|
|
'alpha-2': 'ST',
|
|
'alpha-3': 'STP',
|
|
numeric: 678,
|
|
},
|
|
flag: 'https://www.countryflags.io/ST/flat/64.png',
|
|
subdivisions: [
|
|
{
|
|
code: 'ST-P',
|
|
name: 'Príncipe',
|
|
languages: ['pt'],
|
|
},
|
|
{
|
|
code: 'ST-S',
|
|
name: 'São Tomé',
|
|
languages: ['pt'],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
};
|
|
|
|
mockRequest.get(basePath).reply(200, expectedResponse);
|
|
expect(await holidayapi.countries()).toStrictEqual(expectedResponse);
|
|
});
|
|
|
|
it('should raise 4xx errors', async () => {
|
|
const expectedResponse = {
|
|
status: 429,
|
|
error: 'Rate limit exceeded',
|
|
};
|
|
|
|
expect.assertions(1);
|
|
mockRequest.get(basePath).reply(429, expectedResponse);
|
|
|
|
try {
|
|
await holidayapi.countries();
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/rate limit exceeded/i);
|
|
}
|
|
});
|
|
|
|
it('should raise 5xx errors', async () => {
|
|
expect.assertions(1);
|
|
mockRequest.get(basePath).reply(500);
|
|
|
|
try {
|
|
await holidayapi.countries();
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/internal server error/i);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('/v1/holidays', () => {
|
|
const basePath = `/holidays?key=${key}`;
|
|
|
|
it('should return holidays', async () => {
|
|
const expectedResponse = {
|
|
status: 200,
|
|
requests: {
|
|
used: 1000,
|
|
available: 9000,
|
|
resets: '2019-10-01 00:00:00',
|
|
},
|
|
holidays: [
|
|
{
|
|
name: 'Independence Day',
|
|
date: '2015-07-04',
|
|
observed: '2015-07-03',
|
|
public: true,
|
|
country: 'US',
|
|
uuid: '88268759-9b90-468c-804f-b729b8418e7c',
|
|
weekday: {
|
|
date: {
|
|
name: 'Saturday',
|
|
numeric: '6',
|
|
},
|
|
observed: {
|
|
name: 'Friday',
|
|
numeric: '5',
|
|
},
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
mockRequest.get(`${basePath}&country=US&year=2019&month=7&day=4`)
|
|
.reply(200, expectedResponse);
|
|
|
|
expect(await holidayapi.holidays({
|
|
country: 'US',
|
|
year: 2019,
|
|
month: 7,
|
|
day: 4,
|
|
})).toStrictEqual(expectedResponse);
|
|
});
|
|
|
|
it('should raise 4xx errors', async () => {
|
|
const expectedResponse = {
|
|
status: 429,
|
|
error: 'Rate limit exceeded',
|
|
};
|
|
|
|
expect.assertions(1);
|
|
mockRequest.get(`${basePath}&country=US&year=2019`)
|
|
.reply(429, expectedResponse);
|
|
|
|
try {
|
|
await holidayapi.holidays({ country: 'US', year: 2019 });
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/rate limit exceeded/i);
|
|
}
|
|
});
|
|
|
|
it('should raise 5xx errors', async () => {
|
|
expect.assertions(1);
|
|
mockRequest.get(`${basePath}&country=US&year=2019`).reply(500);
|
|
|
|
try {
|
|
await holidayapi.holidays({ country: 'US', year: 2019 });
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/internal server error/i);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('/v1/languages', () => {
|
|
const basePath = `/languages?key=${key}`;
|
|
|
|
it('should return languages', async () => {
|
|
const expectedResponse = {
|
|
status: 200,
|
|
requests: {
|
|
used: 1000,
|
|
available: 9000,
|
|
resets: '2019-10-01 00:00:00',
|
|
},
|
|
languages: [
|
|
{
|
|
code: 'ar',
|
|
name: 'Arabic',
|
|
},
|
|
{
|
|
code: 'en',
|
|
name: 'English',
|
|
},
|
|
{
|
|
code: 'es',
|
|
name: 'Spanish, Castilian',
|
|
},
|
|
{
|
|
code: 'hi',
|
|
name: 'Hindi',
|
|
},
|
|
{
|
|
code: 'zh',
|
|
name: 'Chinese (Simplified)',
|
|
},
|
|
],
|
|
};
|
|
|
|
mockRequest.get(basePath).reply(200, expectedResponse);
|
|
expect(await holidayapi.languages()).toStrictEqual(expectedResponse);
|
|
});
|
|
|
|
it('should raise 4xx errors', async () => {
|
|
const expectedResponse = {
|
|
status: 429,
|
|
error: 'Rate limit exceeded',
|
|
};
|
|
|
|
expect.assertions(1);
|
|
mockRequest.get(basePath).reply(429, expectedResponse);
|
|
|
|
try {
|
|
await holidayapi.languages();
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/rate limit exceeded/i);
|
|
}
|
|
});
|
|
|
|
it('should raise 5xx errors', async () => {
|
|
expect.assertions(1);
|
|
mockRequest.get(basePath).times(2).reply(500);
|
|
|
|
try {
|
|
await holidayapi.languages();
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/internal server error/i);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('/v1/workday', () => {
|
|
const basePath = `/workday?key=${key}`;
|
|
|
|
it('should return workday', async () => {
|
|
const expectedResponse = {
|
|
status: 200,
|
|
requests: {
|
|
used: 1000,
|
|
available: 9000,
|
|
resets: '2019-10-01 00:00:00',
|
|
},
|
|
workday: [
|
|
{
|
|
date: '2019-07-16',
|
|
weekday: {
|
|
name: 'Tuesday',
|
|
numeric: '2',
|
|
},
|
|
},
|
|
],
|
|
};
|
|
|
|
mockRequest.get(`${basePath}&country=US&start=2019-07-01&days=10`)
|
|
.reply(200, expectedResponse);
|
|
|
|
expect(await holidayapi.workday({
|
|
country: 'US',
|
|
start: '2019-07-01',
|
|
days: 10,
|
|
})).toStrictEqual(expectedResponse);
|
|
});
|
|
|
|
it('should raise 4xx errors', async () => {
|
|
const expectedResponse = {
|
|
status: 429,
|
|
error: 'Rate limit exceeded',
|
|
};
|
|
|
|
expect.assertions(1);
|
|
mockRequest.get(`${basePath}&country=US&start=2019-07-01&days=10`)
|
|
.reply(429, expectedResponse);
|
|
|
|
try {
|
|
await holidayapi.workday({ country: 'US', start: '2019-07-01', days: 10 });
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/rate limit exceeded/i);
|
|
}
|
|
});
|
|
|
|
it('should raise 5xx errors', async () => {
|
|
expect.assertions(1);
|
|
mockRequest.get(`${basePath}&country=US&start=2019-07-01&days=10`).reply(500);
|
|
|
|
try {
|
|
await holidayapi.workday({ country: 'US', start: '2019-07-01', days: 10 });
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/internal server error/i);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('/v1/workdays', () => {
|
|
const basePath = `/workdays?key=${key}`;
|
|
|
|
it('should return workdays', async () => {
|
|
const expectedResponse = {
|
|
status: 200,
|
|
requests: {
|
|
used: 1000,
|
|
available: 9000,
|
|
resets: '2019-10-01 00:00:00',
|
|
},
|
|
workdays: 7,
|
|
};
|
|
|
|
mockRequest.get(`${basePath}&country=US&start=2019-07-01&end=2019-07-10`)
|
|
.reply(200, expectedResponse);
|
|
|
|
expect(await holidayapi.workdays({
|
|
country: 'US',
|
|
start: '2019-07-01',
|
|
end: '2019-07-10',
|
|
})).toStrictEqual(expectedResponse);
|
|
});
|
|
|
|
it('should raise 4xx errors', async () => {
|
|
const expectedResponse = {
|
|
status: 429,
|
|
error: 'Rate limit exceeded',
|
|
};
|
|
|
|
expect.assertions(1);
|
|
mockRequest.get(`${basePath}&country=US&start=2019-07-01&end=2019-07-10`)
|
|
.reply(429, expectedResponse);
|
|
|
|
try {
|
|
await holidayapi.workdays({ country: 'US', start: '2019-07-01', end: '2019-07-10' });
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/rate limit exceeded/i);
|
|
}
|
|
});
|
|
|
|
it('should raise 5xx errors', async () => {
|
|
expect.assertions(1);
|
|
mockRequest.get(`${basePath}&country=US&start=2019-07-01&end=2019-07-10`).reply(500);
|
|
|
|
try {
|
|
await holidayapi.workdays({ country: 'US', start: '2019-07-01', end: '2019-07-10' });
|
|
} catch (err) {
|
|
expect(err.message).toMatch(/internal server error/i);
|
|
}
|
|
});
|
|
});
|
|
});
|
|
});
|