update: v2.0.0

Author: SIY1121

README.md

@@ -9,11 +9,6 @@ Twinte内部で利用するために開発された
 ## KdBDownloader
 KDBからCSVファイルをダウンロードする。
 
-js例
-```js
-const csv = await require('twinte-parser').downloadKDB()
-```
-ts例
 ```typescript
 import { donwloadKDB } from 'twinte-parser'
 
@@ -23,18 +18,12 @@ const csv = await downloadKDB()
 ## Parser
 KdBから取得したcsvをオブジェクトに変換する。
 
-js例
-```js
-const classes = require('twinte-parser').parseKDB(csv)
-```
-
-ts例
 ```typescript
 import parseKDB from 'twinte-parser'
 // or
 import { parseKDB } from 'twinte-parser'
 
-const classes = parseKDB(csv)
+const courses = parseKDB(csv)
 ```
 
 ## 型
@@ -70,35 +59,37 @@ enum Day {
 
 ```
 
-### Lecture
+### Course
 ```typescript
-interface Lecture {
-  lectureCode: string
+interface Course {
+  code: string
   name: string
   credits: number
   overview: string
   remarks: string
   type: number
-  year: number[]
-  details: {
+  recommendedGrade: number[]
+  schedules: {
     module: Module
     day: Day
     period: number
     room: string
   }[]
   instructor: string
+  lastUpdate: Date
+  error: boolean
 }
 ```
 
-ここで`details`が配列になっていることに注意。
+ここで`schedules`が配列になっていることに注意。
 
 例えば春AB・月曜１限・3A201の授業があった場合、
 
 ```typescript
 {
-  id: 'XXXXXXX',
+  code: 'XXXXXXX',
   name: "名前",
-  details: [
+  schedules: [
       {
         module: "春A",
         day: "月",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "twinte-parser",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "description": "Twinte内部で使用するために開発されたKdBパーサ",
   "private": false,
   "main": "dist/index.js",

src/app.ts

@@ -1,10 +1,10 @@
 import * as fs from 'fs'
-import kdbGetter from './kdbDownloader'
+import downloadKdb from './kdbDownloader'
 import parse from './parser'
 import * as colors from 'colors'
 import * as commandLineArgs from 'command-line-args'
 
-console.log('twinte-parser v1.3.2')
+console.log('twinte-parser v2.0.0')
 
 const ops = commandLineArgs([
   { name: 'year', alias: 'y', defaultValue: undefined },
@@ -14,17 +14,18 @@ const main = async () => {
   let xlsx: Buffer
 
   if (fs.existsSync('./kdb.xlsx')) {
-    console.log('i Cache file (kdb.xlsx) found.')
+    console.log('Cache file (kdb.xlsx) found.')
     xlsx = fs.readFileSync('./kdb.xlsx')
   } else {
-    xlsx = await kdbGetter(ops.year)
+    console.log('Downloading xlsx from kdb.\nIt may take a few minutes.')
+    xlsx = await downloadKdb(ops.year)
     fs.writeFileSync('./kdb.xlsx', xlsx)
   }
-  const classes = parse(xlsx)
-  fs.writeFileSync('data.json', JSON.stringify(classes))
-  console.log(
-    'Parsed data has been saved at ${working directory}/data.json'
-  )
+  console.log('parsing...')
+  const courses = parse(xlsx)
+  console.log(`${courses.length} courses have been parsed.`)
+  fs.writeFileSync('data.json', JSON.stringify(courses))
+  console.log('Data has been saved at ./data.json')
 }
 
 main()

src/kdbDownloader.ts

@@ -3,6 +3,20 @@ import _axiosCookiejarSupport from 'axios-cookiejar-support'
 import * as iconv from 'iconv-lite'
 import * as fs from 'fs'
 import * as colors from 'colors'
+import * as assert from 'assert'
+
+export class NoCoursesFoundError extends Error {
+  public constructor() {
+    super('Search results are empty')
+    Object.defineProperty(this, 'name', {
+      configurable: true,
+      enumerable: false,
+      value: this.constructor.name,
+      writable: true,
+    })
+    Error.captureStackTrace(this, NoCoursesFoundError)
+  }
+}
 
 _axiosCookiejarSupport(_axios)
 
@@ -26,15 +40,18 @@ const grantSession = async (): Promise<string> => {
   return extractFlowExecutionKey(iconv.decode(res.data, 'utf8'))
 }
 
-const searchAll = async (flowExecutionKey: string): Promise<string> => {
+const searchAll = async (
+  flowExecutionKey: string,
+  year: number
+): Promise<string> => {
   const res = await axios.post<Buffer>(
     'https://kdb.tsukuba.ac.jp/campusweb/campussquare.do',
     postBody({
       _flowExecutionKey: flowExecutionKey,
       _eventId: 'searchOpeningCourse',
       index: '',
       locale: '',
-      nendo: 2020,
+      nendo: year,
       termCode: '',
       dayCode: '',
       periodCode: '',
@@ -51,18 +68,23 @@ const searchAll = async (flowExecutionKey: string): Promise<string> => {
       outputFormat: 0,
     })
   )
-  return extractFlowExecutionKey(iconv.decode(res.data, 'utf8'))
+  const html = iconv.decode(res.data, 'utf8')
+  if (html.includes('（全部で 0件あります）')) throw new NoCoursesFoundError()
+  return extractFlowExecutionKey(html)
 }
 
-const downloadExcel = async (flowExecutionKey: string): Promise<Buffer> => {
+const downloadExcel = async (
+  flowExecutionKey: string,
+  year
+): Promise<Buffer> => {
   const res = await axios.post<Buffer>(
     'https://kdb.tsukuba.ac.jp/campusweb/campussquare.do',
     postBody({
       _flowExecutionKey: flowExecutionKey,
       _eventId: 'outputOpeningCourseExcel',
       index: '',
       locale: '',
-      nendo: 2020,
+      nendo: year,
       termCode: '',
       dayCode: '',
       periodCode: '',
@@ -79,6 +101,10 @@ const downloadExcel = async (flowExecutionKey: string): Promise<Buffer> => {
       outputFormat: 1,
     })
   )
+  assert(
+    res.headers.contentType !==
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet .xlsx; charset=UTF-8'
+  )
   return res.data
 }
 
@@ -90,6 +116,6 @@ export default async (
 ): Promise<Buffer> => {
   let flowExecutionKey = ''
   flowExecutionKey = await grantSession()
-  flowExecutionKey = await searchAll(flowExecutionKey)
-  return downloadExcel(flowExecutionKey)
+  flowExecutionKey = await searchAll(flowExecutionKey, year)
+  return downloadExcel(flowExecutionKey, year)
 }

src/parser.ts

@@ -128,7 +128,6 @@ const analyzeRow = (columns: string[]) => {
   const periodString = columns[6]
   const roomString = columns[7]
 
-  // 空文字は省く
   const moduleArray = moduleString.split('\r\n')
   const periodArray = periodString.split('\r\n')
   const roomArray = roomString.split('\r\n')
@@ -145,7 +144,6 @@ const analyzeRow = (columns: string[]) => {
       (roomArray.length === count || roomArray.length === 1)
     )
   ) {
-    console.log('Warning!')
     courseData.error = true
   }
 
@@ -171,22 +169,20 @@ const analyzeRow = (columns: string[]) => {
 }
 
 /**
- * CSVをパースする
- * @param csv KDBからダウンロードしたcsv文字列
+ * Excelファイルをパースする
+ * @param data xlsxファイルのバイナリ
  */
 export default (data: Buffer): Course[] => {
   const sheet = readXLSX(data).Sheets['開設科目一覧']
 
   const courses: Course[] = []
 
-  console.log('●  Parsing')
   for (let r = 5; ; r++) {
     const columns: string[] = []
     for (let c = 0; c <= 16; c++)
       columns.push(sheet[utils.encode_cell({ r, c })].v)
     if (columns[0] === '') break
     courses.push(analyzeRow(columns))
   }
-  console.log('✔  Done')
   return courses
 }