@internetarchive/ia-book-actions 0.0.29 → 0.1.1

package/test/core/services/loan-renew-helper.test.js

@@ -0,0 +1,86 @@
+import { expect, aTimeout } from '@open-wc/testing';
+
+import { LocalCache } from '@internetarchive/local-cache';
+import { LoanRenewHelper } from '../../../src/core/services/loan-renew-helper.js';
+
+const identifier = 'booBar';
+const loanRenewTimeConfig = {
+  loanTotalTime: 13,
+  loanRenewAtLast: 10,
+  pageChangedInLast: 12,
+};
+
+// localCache used for auto-loan-renew
+const localCache = new LocalCache({
+  namespace: 'loanRenew',
+});
+
+beforeEach(async () => {
+  await localCache.set({
+    key: `${identifier}-loanTime`,
+    value: new Date(
+      new Date().getTime() + loanRenewTimeConfig.loanTotalTime * 1000
+    ),
+    ttl: Number(loanRenewTimeConfig.loanTotalTime),
+  });
+});
+
+describe('Loan Renew Determine', () => {
+  it('flip book page while reading a book', async () => {
+    await aTimeout(1500);
+
+    await localCache.set({
+      key: `${identifier}-pageChangedTime`,
+      value: new Date(), // current time
+      ttl: Number(loanRenewTimeConfig.loanTotalTime),
+    });
+
+    const loanRenewHelper = new LoanRenewHelper(
+      true, // hasPageChanged
+      identifier,
+      localCache,
+      loanRenewTimeConfig
+    );
+    await loanRenewHelper.handleLoanRenew();
+
+    expect(loanRenewHelper.result.renewNow).to.be.false;
+  });
+
+  it('auto renewed book when user is currently reading', async () => {
+    await localCache.set({
+      key: `${identifier}-pageChangedTime`,
+      value: new Date(), // current time
+      ttl: Number(loanRenewTimeConfig.loanTotalTime),
+    });
+
+    await aTimeout(1500);
+
+    const loanRenewHelper = new LoanRenewHelper(
+      false, // timer-countdown event
+      identifier,
+      localCache,
+      loanRenewTimeConfig
+    );
+    await loanRenewHelper.handleLoanRenew();
+
+    expect(loanRenewHelper.result.renewNow).to.be.true;
+  });
+
+  it('get toast message template', async () => {
+    const loanRenewHelper = new LoanRenewHelper(
+      false,
+      identifier,
+      localCache,
+      loanRenewTimeConfig
+    );
+
+    const toastMsg = loanRenewHelper.getMessageTexts(
+      loanRenewHelper.loanReturnWarning,
+      '65' // in seconds
+    );
+
+    expect(toastMsg).to.be.equal(
+      'This book will be automatically returned in 2 minutes unless you turn a page.'
+    );
+  });
+});

package/test/ia-book-actions.test.js

@@ -4,11 +4,17 @@ import '../src/ia-book-actions.js';
 import Sinon from 'sinon';
 
 import { SharedResizeObserver } from '@internetarchive/shared-resize-observer';
+import { LocalCache } from '@internetarchive/local-cache';
 
 afterEach(() => {
   Sinon.restore();
 });
 
+// localCache used for auto-loan-renew
+const localCache = new LocalCache({
+  namespace: 'loanRenew',
+});
+
 const container = ({ userid, identifier, lendingStatus = {} } = {}) =>
   html`<ia-book-actions
     .userid=${userid}
@@ -81,7 +87,7 @@ describe('Primary Actions data', () => {
     );
     const expectedPrimaryActions = [
       {
-        text: 'Borrow for 1 hour',
+        text: 'Borrow', // changed from 'Borrow for 1 hour'
         callback: () => {},
         className: 'ia-button primary',
       },
@@ -161,7 +167,7 @@ describe('Borrow status actions', () => {
 
     // removed available_to_borrow from lending bar
     expect(el.lendingStatus.available_to_borrow).to.be.false;
-    expect(el.primaryActions[0].text).to.equal('Borrow for 1 hour');
+    expect(el.primaryActions[0].text).to.equal('Borrow');
   });
 
   it('Check action for borrowable book without user', async () => {
@@ -182,9 +188,7 @@ describe('Borrow status actions', () => {
       },
     ];
 
-    expect(el.primaryTitle).to.equal(
-      'Renewable every hour, pending availability.'
-    );
+    expect(el.primaryTitle).to.equal('');
     expect(el.primaryActions.length).to.equal(2);
     expect(el.primaryActions[0].text).to.equal('Log In and Borrow');
     expect(el.primaryActions[0].text).to.equal(expectedPrimaryActions[0].text);
@@ -232,9 +236,14 @@ describe('Browsing expired status', () => {
         },
       })
     );
-    expect(el.primaryTitle).contains('Borrow ends at ');
+    expect(el.primaryTitle).contains('');
     expect(el.primaryActions[0].text).to.equal('Return now');
     expect(el.primaryActions[1].text).to.equal('Print Disability Access');
+
+    // default params of one-hour loan renew
+    expect(el.loanRenewResult.texts).to.equal('');
+    expect(el.loanRenewResult.renewNow).to.equal(false);
+    expect(el.loanRenewResult.secondsLeft).to.equal(0);
   });
 
   it('Book is browsing and going to expire after 1 second', async () => {
@@ -250,11 +259,23 @@ describe('Browsing expired status', () => {
       })
     );
 
+    // timer-countdown is still active
+    expect(el.shadowRoot.querySelector('timer-countdown')).to.not.be.null;
+
     await aTimeout(1500); // wait for 1.5 second
     await el.updateComplete;
 
-    expect(el.primaryTitle).contains('Your loan has expired.');
-    expect(el.primaryActions[0].text).to.equal('Borrow again');
+    expect(el.primaryActions[0].text).to.equal('Borrow');
+
+    // timer-countdown is gone now
+    expect(el.shadowRoot.querySelector('timer-countdown')).to.be.null;
+
+    //   // book has been expired
+    expect(el.loanRenewResult.renewNow).to.equal(false);
+    expect(el.loanRenewResult.secondsLeft).to.equal(0);
+    expect(el.loanRenewResult.texts).to.equal(
+      'This book has been automatically returned due to inactivity.'
+    );
   });
 
   it('Expiring book cancels interval & emits event', async () => {
@@ -279,9 +300,8 @@ describe('Browsing expired status', () => {
     el.lendingStatus = browsingStatus;
     await el.updateComplete;
 
-    expect(el.primaryTitle).contains('Borrow ends at ');
+    expect(el.primaryTitle).contains('');
     expect(el.primaryActions[0].text).to.equal('Return now');
-    expect(el.tokenPoller.loanTokenInterval).to.not.equal(undefined);
 
     const expiredStatus = { ...browsingStatus, browsingExpired: true };
     el.lendingStatus = expiredStatus;
@@ -289,12 +309,55 @@ describe('Browsing expired status', () => {
     await aTimeout(1500); // wait for 1.5 sec
 
     expect(eventReceived).to.equal(true);
-    expect(el.primaryTitle).contains('Your loan has expired.');
-    expect(el.primaryActions[0].text).to.equal('Borrow again');
+    expect(el.primaryActions[0].text).to.equal('Borrow');
     expect(el.tokenPoller.loanTokenInterval).to.equal(undefined);
   });
 });
 
+describe('Auto renew one hour loan', () => {
+  it('Book is browsing and renewed it now', async () => {
+    const el = await fixture(
+      container({
+        userid: '@userid',
+        identifier: 'Foo',
+        lendingStatus: {
+          is_lendable: true,
+          user_has_browsed: true,
+          browseHasExpired: false,
+          secondsLeftOnLoan: 12,
+        },
+      })
+    );
+
+    el.loanRenewResult = {
+      texts: 'This book has been renewed for 1 hour.',
+      renewNow: true,
+      secondsLeft: 10,
+    };
+
+    await localCache.set({
+      key: `${el.identifier}-loanTime`,
+      value: new Date(new Date().getTime() + 10 * 1000),
+      ttl: Number(10),
+    });
+
+    const myEvent = new CustomEvent('loanAutoRenewed');
+    el.addEventListener('loanAutoRenewed', () => {
+      el.handleLoanAutoRenewed();
+    });
+    el.dispatchEvent(myEvent);
+
+    await aTimeout(1500); // wait for 1.5 second
+    await el.updateComplete;
+
+    expect(el.loanRenewResult.texts).to.equal(
+      'This book has been renewed for 1 hour.'
+    );
+    expect(el.loanRenewResult.renewNow).to.equal(true);
+    expect(el.loanRenewResult.secondsLeft).to.equal(10);
+  });
+});
+
 describe('Shared Resize Observer', () => {
   it('can receive a Shared Resize Observer', async () => {
     const sharedObserverStub = new SharedResizeObserver();

package/demo/with-bookreader.html

@@ -1,146 +0,0 @@
-<!doctype html>
-<html lang="en-GB">
-
-<head>
-  <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
-  <style>
-    html {
-      font-size: 10px;
-      /* This is to match petabox's base font size */
-    }
-    body {
-      margin: 0;
-      text-align: center;
-      font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
-    }
-    #demo {
-      height: 50px;
-    }
-    ia-book-actions {
-      --white: #fff;
-      --black: #000;
-      --primaryBGColor: var(--black);
-      --secondaryBGColor: #222;
-      --tertiaryBGColor: #333;
-      --primaryTextColor:  var(--white);
-      --primaryCTAFill: #194880;
-      --primaryCTABorder: #c5d1df;
-      --secondaryCTAFill: #333;
-      --secondaryCTABorder: #999;
-      --secondaryCTAFillRGB: 51, 51, 51;
-      --primaryErrorCTAFill: #e51c26;
-      --primaryErrorCTABorder: #f8c6c8;
-      --primaryCTAFillRGB: 25, 72, 128;
-      --primaryErrorCTAFillRGB: 229, 28, 38;
-      --primaryDisableCTAFill: #767676;
-    }
-
-    fieldset {
-      width: fit-content;
-      margin-top: 50px;
-    }
-    fieldset legend {
-      text-align: left;
-      font-size: 12px;
-    }
-    td {
-      color: white;
-      font-size: 14px;
-      border-radius: 5%;
-      display: table-cell;
-      text-align: initial;
-      margin: 5px 0;
-      width: max-content;
-      display: block;
-    }
-    label {
-      padding: 10px;
-      display: block;
-      cursor: pointer;
-      margin: 2px;
-      background: #4e545a;
-      border-radius: 10px;
-    }
-    input[type="radio"], input[type="checkbox"] {
-      margin-top: 0;
-      vertical-align: middle;
-    }
-
-    .initial td {
-      float: left;
-      margin: 2px;
-    }
-
-    body.modal-manager-open {
-      overflow: hidden;
-    }
-  
-    modal-manager[mode='closed'] {
-      display: none;
-    }
-  </style>
-</head>
-
-<body>
-  <ia-bookreader class="focus-on-child-only" signedin="" fullscreen="">
-    <div slot="header">
-      <ia-book-actions></ia-book-actions>
-    </div>
-    <div slot="main">
-      <div id="BookReader"></div>
-    </div>
-  </ia-bookreader>
-
-
-  <script type="module">
-    /* eslint-disable */
-    import '@internetarchive/bookreader';
-    import '@internetarchive/bookreader/BookReader/jquery-1.10.1.js';
-    import '@internetarchive/bookreader/BookReader/BookReader.js';
-    import '../src/ia-book-actions.js';
-    import {
-      defaultLendingStatus,
-      canBrowseAndBorrow,
-    } from '../src/assets/data/lending-get-status-service.js';
-    import { ModalConfig } from '@internetarchive/modal-manager';
-
-    const userid = '@neeraj-archive';
-    const identifier = 'naturalhistoryof00unse_4111';
-    let bwbPurchaseUrl = 'https://www.betterworldbooks.com/product/detail/cambridge-ancient-hist-v04-0521044863';
-
-    let iaBookActions = document.querySelector('ia-book-actions');
-
-    // for debugging
-    window.iaBookActions = iaBookActions;
-
-    const modalConfig = new ModalConfig();
-    modalConfig.headerColor = '#d9534f';
-
-    let lendingBarPostInit = function lendingBarPostInit() {
-      setTimeout(function() {
-        console.log('executed', 'br.init()');
-      }, 100);
-    }
-
-    // set defaultLendingStatus for unavailable (without borrowables) book
-    iaBookActions.userid = userid;
-    iaBookActions.identifier = identifier;
-    iaBookActions.bookTitle = 'Contemporary Black biography. Volume 39 : profiles from the interContemporary Black biography. Volume 39';
-    iaBookActions.lendingStatus = canBrowseAndBorrow;
-    iaBookActions.bwbPurchaseUrl = '';
-    iaBookActions.modalConfig = modalConfig;
-    iaBookActions.lendingBarPostInit = lendingBarPostInit;
-    iaBookActions.tokenDelay = 2000; // 2 seconds
-    iaBookActions.returnUrl = 'https://openlibrary.org';
-
-    let lendingStatus1 = iaBookActions.lendingStatus;
-
-    const manifest = await fetch('https://ia801302.us.archive.org/BookReader/BookReaderJSIA.php?id=goody&itemPath=/29/items/goody&server=ia801302.us.archive.org&format=jsonp&subPrefix=goody&requestUri=/details/goody/mode/1up%3Fview%3Dtheater%26ui%3Dembed%26wrapper%3Dfalse');
-
-    console.log('manifest ****', manifest).then(res => res.json());
-  </script>
-
-  </div>
-</body>
-</html>