comcigan-parser
v1.0.0
Published
Parse timetable data from comcigan.com
Downloads
13
Readme
comcigan-parser
📘🕘 본 라이브러리는 Node.js 환경에서 사용할 수 있는 컴시간 알리미 시간표 파싱 라이브러리 입니다.
본 라이브러리는 컴시간 홈페이지에서 등록된 학교의 시간표 데이터를 파싱하여 제공합니다.
매주 월요일 09시에 본 라이브러리 동작 여부를 확인합니다. 위 health의 상태가 passing이 아니라면 컴시간 사이트 변경, 소스코드 변경 등의 문제가 발생했다는 의미이니 이슈 전달 부탁드립니다.
기능
- 학교명 입력 후 바로 사용 가능
- 학급 시간표 데이터 제공
정보
아래 두 챗봇에서 사용하던 시간표 파싱 기능을 라이브러리로 개발하였습니다.
설치하기
컴시간 서비스를 사용하는 학교의 시간표 데이터를 쉽게 수집하여 사용할 수 있습니다.
컴시간측의 소스코드 변경으로 인해 시간표 데이터 파싱이 불가능 할 수 있습니다. 문제가 발생할 경우 여기를 참고해주세요
(주의!) 본 라이브러리는 비공식적으로 컴시간 서비스의 데이터를 파싱하며, 상업적인 용도로 사용하다 문제가 발생할 경우 본 라이브러리 개발자는 책임을 지지 않습니다.
npm i comcigan-parser개발 문서
Timetable
Timetable 클래스의 인스턴스를 생성하여 사용합니다.
모듈을 불러오면 Timetable 클래스의 인스턴스를 생성할 수 있습니다.
const Timetable = require('comcigan-parser');
const timetable = new Timetable();Timetable.init()
인스턴스 정보를 초기화 합니다.
옵션을 추가하여 사용자 설정을 진행할 수 있습니다.
timetable.init(options);| Parameter | Type | Required | | :-------- | :----: | :------: | | option | object | X |
옵션 정보는 아래 표 참고
| Option | Value | default | Required | | :------- | :----: | :-----: | :------: | | maxGrade | number | 3 | X | | cache | number | 0 | X |
maxGrade: 최대 학년을 지정합니다. (초등: 6, 중/고등: 3)cache: 시간표 데이터 캐싱 시간(ms)을 지정합니다 (기본값: 0 - 비활성)- 시간을 지정하면, 데이터 조회 시 지정한 시간만큼 임시로 보관하고 있다가, 이후 새로운 조회할 때 보관하던 결과 데이터를 즉시 반환합니다.
- 지정한 캐싱 시간이 지나면 새로 수집하며, 다시 캐싱 시간만큼 보관합니다.
Return - Promise<void>
Timetable.search()
학교 정보를 검색합니다.
컴시간에 등록된 학교가 아닐 경우 검색되지 않습니다.
timetable.search(keyword);| Parameter | Type | Required | | :-------- | :----: | :------: | | keyword | string | O |
Return - Promise<학교데이터[]>
학교 데이터는 여기 참고
Timetable.setSchool()
시간표를 불러올 학교를 지정합니다. 학교 코드는 학교 검색을 통해 확인할 수 있습니다.
timetable.setSchool(schoolCode);| Parameter | Type | Required | | :-------- | :----: | :------: | | keyword | number | O |
Return - Promise<void>
Timetable.getTimetable()
지정한 학교의 시간표 데이터를 불러옵니다.
timetable.getTimetable();Return - Promise<시간표>
Timetable.getClassTime()
각 교시별 수업 시작/종료 시간정보를 반환합니다.
timetable.getClassTime();Return - string[]
사용 방법
Timetable 인스턴스 생성
comcigan-parser 모듈을 불러온 후 인스턴스를 생성합니다.
생성 후 반드시 init(option)를 호출하여 초기화 합니다.
- 옵션은 여기 참조
const Timetable = require('comcigan-parser');
const timetable = new Timetable();
timetable.init().then(() => {
// 초기화 완료..
});학교 검색
컴시간에 등록되어있는 학교를 검색하여 결과를 반환합니다.
검색 결과가 없는 경우 예외가 발생합니다.
timetable.search('광명').then((schoolList) => {
// schoolList
// [
// { _: 24966, region: '경기', name: '광명북중학교', code: 74350 },
// { _: 24966, region: '경기', name: '광명경영회계고등학교', code: 13209 },
// { _: 24966, region: '경기', name: '광명북고등학교', code: 36854 },
// { _: 24966, region: '경기', name: '광명고등학교', code: 31443 },
// { _: 24966, region: '경기', name: '광명중학교', code: 31098 }
// ]
});학교 설정
컴시간에 등록되어있는 학교를 검색하고 인스턴스에 등록합니다.
학교가 여러개 조회되거나 검색 결과가 없는 경우 예외가 발생합니다.
const mySchool = schoolList.find((school) => {
return school.region === '경기' && school.name === '광명경영회계고등학교';
});
timetable.setSchool(mySchool.code).then(() => {
// 학교 설정 완료..
});시간표 조회
등록한 학교의 시간표 데이터를 조회합니다.
timetable.getTimetable().then((result) => {
console.log(result);
// result[학년][반][요일][교시]
// 요일: (월: 0 ~ 금: 4)
// 교시: 1교시(0), 2교시(1), 3교시(2)..
// 3학년 8반 화요일 2교시 시간표
console.log(result[3][8][1][1]);
});수업시간 정보 조회
수업 시간 정보를 반환힙니다.
timetable.getClassTime();활용 예시
const Timetable = require('comcigan-parser');
const timetable = new Timetable();
const schoolFinder = (schoolName, region) => (schoolList) => {
const targetSchool = schoolList.find((school) => {
return school.region === region && school.name.includes(schoolName);
});
return targetSchool;
};
timetable
.init({ cache: 1000 * 60 * 60 }) // 캐시 1시간동안 보관
.then(() => timetable.search('광명'))
.then(schoolFinder('광명경영회계고등학교', '경기'))
.then((school) => timetable.setSchool(school.code))
.then(() => {
Promise.all([timetable.getClassTime(), timetable.getTimetable()]).then((res) => {
console.log(res[0]); // 시간표
console.log(res[1]); // 수업시간정보
});
});const Timetable = require('comcigan-parser');
const timetable = new Timetable();
const test = async () => {
await timetable.init();
const school = await timetable.search('광명경영회계고등학교');
await timetable.setSchool(school[0].code);
// 전교 시간표 정보 조회
const result = await timetable.getTimetable();
console.log(result);
// 각 교시별 수업 시작/종료 시간 정보 조회
const time = await timetable.getClassTime();
console.log(time);
};데이터 형식
학교 데이터
{
_: 24966, // 알 수 없는 코드
region:'경기', // 지역
name: '광명경영회계고등학교', // 학교명
code: 13209 // 학교코드
}시간표 데이터
{
"1": {
// 1학년
"1": [ // 1반
[ // 월요일 시간표
{
grade: 1, // 학년
class: 1, // 반
weekday: 1, // 요일 (1: 월 ~ 5: 금)
weekdayString: '월', // 요일 문자열
classTime: 1, // 교시
teacher: '이희*', // 선생님 성함
subject: '실용비즈니스영어' // 과목명
},
{
grade: 1,
class: 1,
weekday: 1,
weekdayString: '월',
classTime: 2,
code: '1606',
teacher: '강연*',
subject: '진로활동'
}
],
[화요일시간표],
[수요일시간표],
[목요일시간표],
[금요일시간표]
],
"2": [ // 2반
[월요일시간표],
[화요일시간표],
[수요일시간표],
[목요일시간표],
[금요일시간표]
],
"3": [
[], [], [], [], []
],
...
},
"2": {
// 2학년
},
"3": {
// 3학년
}
}각 시간표 데이터 형식
- 각 요일
Array에는 아래와 같은 형식의 데이터가 포함되어있음
[
{
grade: 3, // 학년
class: 10, // 반
weekday: 1, // 요일 (1: 월 ~ 5: 금)
weekdayString: '월', // 요일 문자열
classTime: 1, // 교시
code: '5644', // 수업 코드
teacher: '이희*', // 선생님 성함
subject: '실용비즈니스영어' // 과목명
},
{
grade: 3,
class: 10,
weekday: 1,
weekdayString: '월',
classTime: 2,
teacher: '강연*',
subject: '진로활동'
},
...
]수업시간 정보
['1(09:10)', '2(10:10)', '3(11:10)', '4(12:10)', '5(13:50)', '6(14:50)', '7(15:50)', '8(16:50)'];응용 방법
timetable.getTimetable().then((result) => {
// 3학년 8반 시간표 (월 ~ 금)
console.log(result[3][8]);
// 1학년 1반 월요일 시간표
console.log(result[1][1][0]);
// 2학년 5반 금요일 3교시 시간표
console.log(result[2][5][4][2]);
});- 학년, 반의 경우 인덱스 상관 없이 동일하게 접근
- 예: 1학년 3반(result[1][3]), 3학년 9반(result[3][9])
- 요일, 교시의 경우 인덱스는 0부터 시작하므로 -1 값을 통해 접근
- 예: 월요일 3교시(result[..][..][0][2])
문제 신고
시간표 파싱이 되지 않거나 문제가 발생한 경우 이슈를 남겨주세요.
변경사항
1.0.00.3.0- 컴시간 변경사항 대응 (도메인 변경)
- 더 원활한 데이터 수집을 위해 코어 로직 수정
getClassTime()사용법 변경 - 이제 프라미스를 반환합니다firstNames옵션 제거cache옵션 추가- 시간표 데이터의 속성명 변경 (전:
class_time, 후:classTime) - 시간표 데이터의
code값 제거
0.2.0- getClassTime 메소드 추가 (각 교시별 수업 시작/종료 시간 정보) - 참조
0.1.1- tempSave 옵션 문제 수정
0.1.0- tempSave 옵션 삭제
- 시간표 추출 데이터 임계값 옵션 추가 (자세한 사항은 여기 참조)
0.0.3- 데이터 파싱 문제 수정
0.0.2- 개발 문서 추가
init의 기본 옵션 문제 수정
0.0.1- 첫 번째 릴리즈!