Merge pull request #71 from BuffettCode/development

Release v11

Author: akiomik

README.md

@@ -64,4 +64,5 @@ npm run deploy:prod
 1. Edit `src/version.ts`.
 2. Merge development branch into master.
 3. Create a release on github.
-3. Create Deployments from `Publish` -> `Deploy from manifest` in script editor for prodcution.
+4. Run `git checkout master && npm run deploy:prod` to deploy master branch.
+5. Create Deployments from `Publish` -> `Deploy from manifest` in script editor for prodcution.

src/__mocks__/fixtures/v3/quarter.js

@@ -182,7 +182,7 @@ module.exports = {
     employee_num: null,
     net_sales_per_employee: null,
     operating_income_per_employee: null,
-    segment_member: null,
+    segment_member: {"segments":[],"periods":[],"values":[]},
     increase_in_properties: 346000000,
     r_and_d_expenses: 35000000,
     defined_benefit_asset: null,

src/api/company-service.test.ts

@@ -2,9 +2,14 @@ import { CompanyService } from '~/api/company-service'
 import { CachingBuffettCodeApiClientV2 } from '~/api/v2/caching-client'
 import { CachingBuffettCodeApiClientV3 } from '~/api/v3/caching-client'
 import { DateParam } from '~/fiscal-periods/date-param'
+import { LqWithOffset } from '~/fiscal-periods/lq-with-offset'
+import { LyWithOffset } from '~/fiscal-periods/ly-with-offset'
 import { YearQuarter } from '~/fiscal-periods/year-quarter'
 import { YearQuarterParam } from '~/fiscal-periods/year-quarter-param'
 
+const LY = new LyWithOffset()
+const LQ = new LqWithOffset()
+
 jest.mock('~/api/v2/client', () =>
   jest.requireActual('~/__mocks__/api/v2/client')
 )
@@ -21,6 +26,55 @@ test('isSupportedTicker', () => {
   expect(new CompanyService('9999', client).isSupportedTicker()).toBe(false)
 })
 
+test('convertYearQuarterParamToYearQuarter', () => {
+  const client = new CachingBuffettCodeApiClientV2('token')
+  const service = new CompanyService('2371', client)
+  expect(
+    service.convertYearQuarterParamToYearQuarter(new YearQuarterParam(LY, 3))
+  ).toEqual(new YearQuarter(2021, 3))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(new YearQuarterParam(2016, LQ))
+  ).toEqual(new YearQuarter(2016, 2))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(new YearQuarterParam(LY, LQ))
+  ).toEqual(new YearQuarter(2021, 2))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(
+      new YearQuarterParam(new LyWithOffset(-5), LQ)
+    )
+  ).toEqual(new YearQuarter(2016, 2))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(
+      new YearQuarterParam(LY, new LqWithOffset(-1))
+    )
+  ).toEqual(new YearQuarter(2021, 1))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(
+      new YearQuarterParam(LY, new LqWithOffset(-2))
+    )
+  ).toEqual(new YearQuarter(2020, 4))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(
+      new YearQuarterParam(LY, new LqWithOffset(-3))
+    )
+  ).toEqual(new YearQuarter(2020, 3))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(
+      new YearQuarterParam(LY, new LqWithOffset(-4))
+    )
+  ).toEqual(new YearQuarter(2020, 2))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(
+      new YearQuarterParam(LY, new LqWithOffset(-5))
+    )
+  ).toEqual(new YearQuarter(2020, 1))
+  expect(
+    service.convertYearQuarterParamToYearQuarter(
+      new YearQuarterParam(new LyWithOffset(-5), new LqWithOffset(-5))
+    )
+  ).toEqual(new YearQuarter(2015, 1))
+})
+
 test('isOndemandQuarterApiPeriod', () => {
   const client = new CachingBuffettCodeApiClientV2('token')
   const service = new CompanyService('2371', client)
@@ -34,9 +88,30 @@ test('isOndemandQuarterApiPeriod', () => {
   expect(service.isOndemandQuarterApiPeriod(new YearQuarter(2016, 3))).toBe(
     false
   )
+  expect(service.isOndemandQuarterApiPeriod(new YearQuarterParam(LY, 3))).toBe(
+    false
+  )
+  expect(
+    service.isOndemandQuarterApiPeriod(new YearQuarterParam(2016, LQ))
+  ).toBe(true)
+  expect(service.isOndemandQuarterApiPeriod(new YearQuarterParam(LY, LQ))).toBe(
+    false
+  )
   expect(
-    service.isOndemandQuarterApiPeriod(new YearQuarterParam('LY', 'LQ'))
+    service.isOndemandQuarterApiPeriod(
+      new YearQuarterParam(new LyWithOffset(-4), new LqWithOffset(-3))
+    )
   ).toBe(false)
+  expect(
+    service.isOndemandQuarterApiPeriod(
+      new YearQuarterParam(new LyWithOffset(-4), new LqWithOffset(-4))
+    )
+  ).toBe(true)
+  expect(
+    service.isOndemandQuarterApiPeriod(
+      new YearQuarterParam(new LyWithOffset(-5), LQ)
+    )
+  ).toBe(true)
 })
 
 test('isOndemandDailyApiPeriod', () => {

src/api/company-service.ts

@@ -1,6 +1,8 @@
 import { BuffettCodeApiClientV2 } from '~/api/v2/client'
 import { BuffettCodeApiClientV3 } from '~/api/v3/client'
 import { DateParam } from '~/fiscal-periods/date-param'
+import { LqWithOffset } from '~/fiscal-periods/lq-with-offset'
+import { LyWithOffset } from '~/fiscal-periods/ly-with-offset'
 import { YearQuarter } from '~/fiscal-periods/year-quarter'
 import { YearQuarterParam } from '~/fiscal-periods/year-quarter-param'
 
@@ -19,20 +21,38 @@ export class CompanyService {
     return !!this.company
   }
 
+  public convertYearQuarterParamToYearQuarter(
+    period: YearQuarterParam
+  ): YearQuarter {
+    if (period.year instanceof LyWithOffset) {
+      period.year = this.company['latest_fiscal_year'] + period.year.offset
+    }
+
+    if (period.quarter instanceof LqWithOffset) {
+      period.year =
+        (period.year as number) + Math.ceil(period.quarter.offset / 4)
+      period.quarter =
+        this.company['latest_fiscal_quarter'] + (period.quarter.offset % 4)
+
+      if (period.quarter <= 0) {
+        period.year -= 1
+        period.quarter = 4 + (period.quarter as number)
+      }
+    }
+
+    return period.toYearQuarter()
+  }
+
   public isOndemandQuarterApiPeriod(
     _period: YearQuarter | YearQuarterParam
   ): boolean {
     if (!this.isSupportedTicker()) {
       throw new Error('unsupported ticker')
     }
 
-    let period
+    let period: YearQuarter
     if (_period instanceof YearQuarterParam) {
-      if (_period.isLatestYear() && _period.isLatestQuarter()) {
-        return false
-      }
-
-      period = _period.toYearQuarter()
+      period = this.convertYearQuarterParamToYearQuarter(_period)
     } else {
       period = _period
     }

src/api/http-error.test.ts

@@ -3,6 +3,6 @@ import { useMockedUrlFetchApp } from '~/api/test-helper'
 
 test('HttpError', () => {
   const res = useMockedUrlFetchApp(403, '{"message": "Forbidden"}')()
-  const error = new HttpError(res)
+  const error = new HttpError('https://example.com', res)
   expect(error instanceof HttpError).toBeTruthy()
 })

src/api/http-error.ts

@@ -2,9 +2,11 @@ export class HttpError implements Error {
   public name = 'HttpError'
   public message: string
 
-  // eslint-disable-next-line @typescript-eslint/camelcase
-  constructor(public response: GoogleAppsScript.URL_Fetch.HTTPResponse) {
-    this.message = `${response.getResponseCode()}: ${response.getContentText()}`
+  constructor(
+    public url: string,
+    public response: GoogleAppsScript.URL_Fetch.HTTPResponse // eslint-disable-line @typescript-eslint/camelcase
+  ) {
+    this.message = `${url} - ${response.getResponseCode()}: ${response.getContentText()}`
   }
 
   public isInvalidTestingRequest(): boolean {

src/api/v2/caching-client.test.ts

@@ -1,6 +1,8 @@
 import { CompanyCache } from '~/__mocks__/services/company-cache'
 import { QuarterCache } from '~/__mocks__/services/quarter-cache'
 import { CachingBuffettCodeApiClientV2 } from '~/api/v2/caching-client'
+import { LqWithOffset } from '~/fiscal-periods/lq-with-offset'
+import { LyWithOffset } from '~/fiscal-periods/ly-with-offset'
 import { YearQuarter } from '~/fiscal-periods/year-quarter'
 import { YearQuarterParam } from '~/fiscal-periods/year-quarter-param'
 import { IndicatorCache } from '~/services/indicator-cache'
@@ -18,6 +20,9 @@ jest.mock('~/services/quarter-cache', () =>
   jest.requireActual('~/__mocks__/services/quarter-cache')
 )
 
+const LY = new LyWithOffset()
+const LQ = new LqWithOffset()
+
 describe('company', () => {
   const ticker = '2371'
 
@@ -111,7 +116,7 @@ describe('quarter', () => {
       QuarterCache.clearAll()
     })
 
-    const period = new YearQuarterParam('LY', 'LQ')
+    const period = new YearQuarterParam(LY, LQ)
 
     test('(uncached)', () => {
       expect(QuarterCache.getData(ticker, new YearQuarter(2018, 1))).toBeNull()
@@ -168,7 +173,7 @@ describe('ondemandQuarter', () => {
       QuarterCache.clearAll()
     })
 
-    const period = new YearQuarterParam('LY', 'LQ')
+    const period = new YearQuarterParam(LY, LQ)
 
     test('(uncached)', () => {
       expect(QuarterCache.getData(ticker, new YearQuarter(2018, 1))).toBeNull()

src/api/v2/client.test.ts

@@ -11,11 +11,11 @@ test('HttpError#isInvalidTestingRequest', () => {
     200,
     '{"message":"Testing Apikey is only allowed to ticker ending with \\"01\\""}'
   )()
-  const error1 = new HttpError(res1)
+  const error1 = new HttpError('https://example.com', res1)
   expect(error1.isInvalidTestingRequest()).toBeTruthy()
 
   const res2 = useMockedUrlFetchApp(403, '{"message": "Forbidden"}')()
-  const error2 = new HttpError(res2)
+  const error2 = new HttpError('https://example.com', res2)
   expect(error2.isInvalidTestingRequest()).toBeFalsy()
 })
 

src/api/v2/client.ts

@@ -16,7 +16,7 @@ export class BuffettCodeApiClientV2 {
 
     const code = res.getResponseCode()
     const content = res.getContentText()
-    const error = new HttpError(res)
+    const error = new HttpError(url, res)
     if (
       Math.floor(code / 100) === 4 ||
       Math.floor(code / 100) === 5 ||
@@ -29,8 +29,8 @@ export class BuffettCodeApiClientV2 {
     try {
       json = JSON.parse(content)
     } catch (e) {
-      console.error('JSON parsing error', code, content)
-      throw new HttpError(res)
+      console.error('JSON parsing error', url, code, content)
+      throw new HttpError(url, res)
     }
 
     return json

src/api/v3/caching-client.test.ts

@@ -3,6 +3,8 @@ import { DailyCache } from '~/__mocks__/services/daily-cache'
 import { QuarterCache } from '~/__mocks__/services/quarter-cache'
 import { CachingBuffettCodeApiClientV3 } from '~/api/v3/caching-client'
 import { DateParam } from '~/fiscal-periods/date-param'
+import { LqWithOffset } from '~/fiscal-periods/lq-with-offset'
+import { LyWithOffset } from '~/fiscal-periods/ly-with-offset'
 import { YearQuarter } from '~/fiscal-periods/year-quarter'
 import { YearQuarterParam } from '~/fiscal-periods/year-quarter-param'
 
@@ -19,6 +21,9 @@ jest.mock('~/services/quarter-cache', () =>
   jest.requireActual('~/__mocks__/services/quarter-cache')
 )
 
+const LY = new LyWithOffset()
+const LQ = new LqWithOffset()
+
 describe('company', () => {
   const ticker = '2371'
 
@@ -112,7 +117,7 @@ describe('quarter', () => {
       QuarterCache.clearAll()
     })
 
-    const period = new YearQuarterParam('LY', 'LQ')
+    const period = new YearQuarterParam(LY, LQ)
 
     test('(uncached)', () => {
       expect(QuarterCache.get(ticker, new YearQuarter(2018, 1))).toBeNull()
@@ -165,7 +170,7 @@ describe('ondemandQuarter', () => {
       QuarterCache.clearAll()
     })
 
-    const period = new YearQuarterParam('LY', 'LQ')
+    const period = new YearQuarterParam(LY, LQ)
 
     test('(uncached)', () => {
       expect(QuarterCache.get(ticker, new YearQuarter(2018, 1))).toBeNull()