@internetarchive/ia-book-actions 0.0.19 → 0.0.20

package/demo/index.html

@@ -101,6 +101,9 @@
 
     let iaBookActions = document.querySelector('ia-book-actions');
 
+    // for debugging
+    window.iaBookActions = iaBookActions;
+
     const modalConfig = new ModalConfig();
     modalConfig.headerColor = '#d9534f';
 
@@ -214,6 +217,12 @@
           lendingStatus1.user_on_waitlist = false;
           lendingStatus1.available_to_waitlist = false;
           lendingStatus1.user_has_borrowed = false;
+        } else if (e.target.value === 'user_can_claim_waitlist') {
+          lendingStatus1.available_to_borrow = true;
+          lendingStatus1.user_on_waitlist = true;
+          lendingStatus1.user_can_claim_waitlist = true;
+          lendingStatus1.user_has_borrowed = false;
+          lendingStatus1.available_to_waitlist = false;
         } else if (e.target.value === 'user_on_waitlist') {
           lendingStatus1.available_to_borrow = false;
           lendingStatus1.user_on_waitlist = true;
@@ -283,6 +292,7 @@
             <td class="availableToBorrow">
               <label><input type="radio" name="borrow" value="available_to_borrow" />available_to_borrow</label>
               <label><input type="radio" name="borrow" value="user_on_waitlist" />user_on_waitlist</label>
+              <label><input type="radio" name="borrow" value="user_can_claim_waitlist" />user_can_claim_waitlist</label>
               <label><input type="radio" name="borrow" value="available_to_waitlist" />available_to_waitlist</label>
               <label><input type="radio" name="borrow" value="user_has_borrowed" />user_has_borrowed</label>
             </td>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetarchive/ia-book-actions",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "Bookreader actions for borrowable book",
   "author": "Internet Archive",
   "license": "AGPL-3.0-only",
@@ -40,7 +40,7 @@
     "husky": "^1.0.0",
     "lint-staged": "^10.0.0",
     "prettier": "^2.0.4",
-    "sinon": "^9.2.4"
+    "sinon": "^13.0.2"
   },
   "eslintConfig": {
     "extends": [

package/src/core/services/get-lending-actions.js

@@ -34,7 +34,26 @@ import ActionsConfig from './actions-config.js';
  *    The action buttons configuration is coming from ActionsConfig class.
  */
 
-export default class GetLendingActions {
+/**
+ * Enum: Book Titles
+ * @readonly
+ * @enum {string}
+ */
+export const bookTitles = {
+  available_1hr: 'Renewable every hour, pending availability.',
+  available_14d: 'This book can be borrowed for 14 days.',
+  available_pd: 'Book available to patrons with print disabilities.',
+  available_waitlist: 'A waitlist is available.',
+  admin_access: 'You have administrative privileges to read this book.',
+  claim_waitlist: 'You are at the top of the waitlist for this book.',
+  being_borrowed: 'Another patron is using this book. Please check back later.',
+  eligible_pd: 'You are eligible for print-disabled access.',
+  on_waitlist: 'You are on the waitlist for this book.',
+  session_expired: 'Your loan has expired.',
+  unavailable: 'This book is not available at this time.',
+};
+
+export class GetLendingActions {
   constructor(userid, identifier, lendingStatus, bwbPurchaseUrl) {
     this.userid = userid;
     this.identifier = identifier;
@@ -52,7 +71,7 @@ export default class GetLendingActions {
 
   onlyAdminAction() {
     return {
-      primaryTitle: 'You have administrative privileges to read this book.',
+      primaryTitle: bookTitles.admin_access,
       primaryActions: [],
       primaryColor: 'primary',
       secondaryActions: [
@@ -100,7 +119,7 @@ export default class GetLendingActions {
     };
   }
 
-  leaveWaitlistAction() {
+  claimWaitlistAction() {
     const lendingStatus = this.lendingStatus || {};
 
     const leaveWaitlist = this.actionsConfig.leaveWaitlistConfig();
@@ -109,12 +128,13 @@ export default class GetLendingActions {
       ? this.actionsConfig.firstBrowseConfig()
       : null;
 
-    const dropdownOptions = browseBook ? [browseBook, borrowBook] : [];
-    const actions = !browseBook ? [borrowBook, leaveWaitlist] : [leaveWaitlist];
+    let actions = [borrowBook];
+    if (browseBook) actions.push(browseBook);
+    actions.push(leaveWaitlist);
 
     return {
-      primaryTitle: 'You are at the top of the waitlist for this book',
-      primaryActions: actions.concat(dropdownOptions),
+      primaryTitle: bookTitles.claim_waitlist,
+      primaryActions: actions,
       primaryColor: 'primary',
       footer: 'printDisabilityLine()',
       secondaryActions: [
@@ -126,7 +146,7 @@ export default class GetLendingActions {
 
   borrowPrintDisabledAction() {
     return {
-      primaryTitle: 'You are eligible for print-disabled access.',
+      primaryTitle: bookTitles.eligible_pd,
       primaryActions: [this.actionsConfig.borrowBookConfig()],
       primaryColor: 'primary',
       secondaryActions: [
@@ -141,7 +161,7 @@ export default class GetLendingActions {
       ? this.actionsConfig.unavailableBookConfig()
       : [];
     return {
-      primaryTitle: 'Book available to patrons with print disabilities.',
+      primaryTitle: bookTitles.available_pd,
       primaryActions: [unavailable],
       primaryColor: 'primary',
       secondaryActions: [],
@@ -150,7 +170,7 @@ export default class GetLendingActions {
 
   onWaitlistAction() {
     return {
-      primaryTitle: 'You are on the waitlist for this book.',
+      primaryTitle: bookTitles.on_waitlist,
       primaryActions: [
         this.actionsConfig.leaveWaitlistConfig(),
         this.actionsConfig.firstBrowseConfig(),
@@ -170,8 +190,8 @@ export default class GetLendingActions {
       lendingStatus.max_browsable_copies &&
       !lendingStatus.available_lendable_copies;
     const title = anotherPatronUsing
-      ? 'Another patron is using this book. Please check back later.'
-      : 'This book is not available at this time.';
+      ? bookTitles.being_borrowed
+      : bookTitles.unavailable;
 
     return {
       primaryTitle: title,
@@ -210,10 +230,10 @@ export default class GetLendingActions {
     });
 
     const title = lendingStatus.available_to_browse
-      ? 'Renewable every hour, pending availability.'
+      ? bookTitles.available_1hr
       : lendingStatus.available_to_borrow
-      ? 'This book can be borrowed for 14 days.'
-      : 'Another patron is using this book.';
+      ? bookTitles.available_14d
+      : bookTitles.unavailable;
 
     return {
       primaryTitle: title,
@@ -260,12 +280,12 @@ export default class GetLendingActions {
     // end config
 
     const title = browsingHasExpired
-      ? possibleTitles.session_expired
+      ? bookTitles.session_expired
       : !canBrowse && allBrowsableCopiesTaken
-      ? possibleTitles.session_tryagain
+      ? bookTitles.being_borrowed
       : !canBrowse && lendingStatus.available_to_waitlist
-      ? possibleTitles.waitlist
-      : possibleTitles.one_hour;
+      ? bookTitles.available_waitlist
+      : bookTitles.available_1hr;
 
     // one hour borrow config
     const oneHrBorrow = browsingHasExpired
@@ -332,7 +352,7 @@ export default class GetLendingActions {
     });
 
     return {
-      primaryTitle: waitlist ? 'Another patron is using this book.' : '',
+      primaryTitle: waitlist ? bookTitles.being_borrowed : '',
       primaryActions: actions,
       primaryColor: 'primary',
       secondaryActions: [
@@ -406,7 +426,7 @@ export default class GetLendingActions {
     } else if (patronIsReading) {
       lendingActions = this.patronIsReadingAction();
     } else if (lendingStatus.user_can_claim_waitlist) {
-      lendingActions = this.leaveWaitlistAction();
+      lendingActions = this.claimWaitlistAction();
     } else if (userCanAccessPrintDisabled) {
       lendingActions = this.borrowPrintDisabledAction();
     } else if (canBorrow || lendingStatus.browsingExpired) {

package/src/ia-book-actions.js

@@ -9,7 +9,7 @@ import './components/book-title-bar.js';
 import './components/text-group.js';
 import './components/info-icon.js';
 
-import GetLendingActions from './core/services/get-lending-actions.js';
+import { GetLendingActions } from './core/services/get-lending-actions.js';
 import { mobileContainerWidth } from './core/config/constants.js';
 import { LoanTokenPoller } from './core/services/loan-token-poller.js';
 

package/test/core/services/get-lending-actions.test.js

@@ -1,5 +1,13 @@
 import { expect } from '@open-wc/testing';
-import GetLendingActions from '../../../src/core/services/get-lending-actions.js';
+import sinon from 'sinon';
+import {
+  GetLendingActions,
+  bookTitles,
+} from '../../../src/core/services/get-lending-actions.js';
+
+afterEach(() => {
+  sinon.restore();
+});
 
 describe('Get Lending Actions', () => {
   it('Browsable and Borrowable with purchase link', async () => {
@@ -15,9 +23,7 @@ describe('Get Lending Actions', () => {
     );
     const actions = lendingOptions.getCurrentLendingActions();
 
-    expect(actions.primaryTitle).to.equal(
-      'Renewable every hour, pending availability.'
-    );
+    expect(actions.primaryTitle).to.equal(bookTitles.available_1hr);
     expect(actions.primaryActions.length).to.equal(3);
     expect(actions.primaryActions[0].text).to.equal('Borrow for 1 hour');
     expect(actions.primaryActions[1].text).to.equal('Borrow for 14 days');
@@ -37,9 +43,7 @@ describe('Get Lending Actions', () => {
     const actions = lendingOptions.getCurrentLendingActions();
 
     expect(actions.primaryActions.length).to.equal(2);
-    expect(actions.primaryTitle).to.equal(
-      'This book can be borrowed for 14 days.'
-    );
+    expect(actions.primaryTitle).to.equal(bookTitles.available_14d);
     expect(actions.primaryActions[0].text).to.equal('Log In and Borrow');
   });
 
@@ -64,24 +68,104 @@ describe('Get Lending Actions', () => {
     expect(actions.primaryActions[0].text).to.equal('Return now');
   });
 
-  it('Reedem borrow action', async () => {
-    const lendingOptions = new GetLendingActions(
-      '@user',
-      'identifier',
-      {
-        is_lendable: true,
-        available_to_borrow: true,
-        user_can_claim_waitlist: true,
-      },
-      ''
-    );
-    const actions = lendingOptions.getCurrentLendingActions();
-
-    expect(actions.primaryTitle).to.equal(
-      'You are at the top of the waitlist for this book'
-    );
-    expect(actions.primaryActions.length).to.equal(2);
-    expect(actions.primaryActions[0].text).to.equal('Borrow for 14 days');
+  describe('WAITLIST', () => {
+    describe('`user_can_claim_waitlist = true`', () => {
+      it('top of waitlist & cannot browse', async () => {
+        const lendingOptions = new GetLendingActions(
+          '@user',
+          'identifier',
+          {
+            is_lendable: true,
+            available_to_borrow: true,
+            user_can_claim_waitlist: true,
+          },
+          ''
+        );
+
+        const spy = sinon.spy(lendingOptions, 'claimWaitlistAction');
+        const actions = lendingOptions.getCurrentLendingActions();
+
+        expect(actions.primaryTitle).to.equal(bookTitles.claim_waitlist);
+        expect(actions.primaryActions.length).to.equal(2);
+        expect(actions.primaryActions[0].text).to.equal('Borrow for 14 days');
+        expect(actions.primaryActions[1].text).to.equal('Leave Waitlist');
+
+        expect(spy.called).to.be.true;
+      });
+      it('top of waitlist & can browse', async () => {
+        const lendingOptions = new GetLendingActions(
+          '@user',
+          'identifier',
+          {
+            is_lendable: true,
+            available_to_borrow: true,
+            available_to_browse: true,
+            user_can_claim_waitlist: true,
+          },
+          ''
+        );
+
+        const spy = sinon.spy(lendingOptions, 'claimWaitlistAction');
+        const actions = lendingOptions.getCurrentLendingActions();
+
+        expect(actions.primaryTitle).to.equal(bookTitles.claim_waitlist);
+        expect(actions.primaryActions.length).to.equal(3);
+        expect(actions.primaryActions[0].text).to.equal('Borrow for 14 days');
+        expect(actions.primaryActions[1].text).to.equal('Borrow for 1 hour');
+        expect(actions.primaryActions[2].text).to.equal('Leave Waitlist');
+        expect(spy.called).to.be.true;
+      });
+    });
+    describe('`user_on_waitlist = true`', () => {
+      it('on waitlist && cannot browse', async () => {
+        const lendingOptions = new GetLendingActions(
+          '@user',
+          'identifier',
+          {
+            is_lendable: true,
+            available_to_borrow: false,
+            available_to_browse: false,
+            user_can_claim_waitlist: false,
+            user_on_waitlist: true,
+          },
+          ''
+        );
+
+        const claimSpy = sinon.spy(lendingOptions, 'claimWaitlistAction');
+        const waitlistSpy = sinon.spy(lendingOptions, 'onWaitlistAction');
+        const actions = lendingOptions.getCurrentLendingActions();
+
+        expect(actions.primaryTitle).to.equal(bookTitles.on_waitlist);
+        expect(actions.primaryActions.length).to.equal(2);
+        expect(actions.primaryActions[0].text).to.equal('Leave Waitlist');
+        expect(actions.primaryActions[1].text).to.equal('Borrow for 1 hour');
+        expect(claimSpy.called).to.be.false;
+        expect(waitlistSpy.called).to.be.true;
+      });
+      it('on waitlist && can browse', async () => {
+        const lendingOptions = new GetLendingActions(
+          '@user',
+          'identifier',
+          {
+            is_lendable: true,
+            available_to_borrow: false,
+            available_to_browse: true,
+            user_can_claim_waitlist: false,
+            user_on_waitlist: true,
+          },
+          ''
+        );
+
+        const waitlistSpy = sinon.spy(lendingOptions, 'onWaitlistAction');
+        const actions = lendingOptions.getCurrentLendingActions();
+
+        expect(actions.primaryTitle).to.equal(bookTitles.on_waitlist);
+        expect(actions.primaryActions.length).to.equal(2);
+        expect(actions.primaryActions[0].text).to.equal('Leave Waitlist');
+        expect(actions.primaryActions[1].text).to.equal('Borrow for 1 hour');
+        expect(waitlistSpy.called).to.be.true;
+      });
+    });
   });
 
   it('User can access print disabled', async () => {
@@ -99,9 +183,7 @@ describe('Get Lending Actions', () => {
     const actions = lendingOptions.getCurrentLendingActions();
 
     // in-case of print-disabled, we show 14 days borrow
-    expect(actions.primaryTitle).to.equal(
-      'You are eligible for print-disabled access.'
-    );
+    expect(actions.primaryTitle).to.equal(bookTitles.eligible_pd);
     expect(actions.primaryActions.length).to.equal(1);
     expect(actions.primaryActions[0].text).to.equal('Borrow for 14 days');
   });
@@ -117,39 +199,16 @@ describe('Get Lending Actions', () => {
     );
     const actions = lendingOptions.getCurrentLendingActions();
 
-    expect(actions.primaryTitle).to.equal(
-      'Book available to patrons with print disabilities.'
-    );
+    expect(actions.primaryTitle).to.equal(bookTitles.available_pd);
     expect(actions.primaryActions.length).to.equal(1);
     expect(actions.primaryActions[0].text).to.equal('Borrow Unavailable');
   });
 
-  it('If user is on waitlist', async () => {
-    const lendingOptions = new GetLendingActions(
-      '@user',
-      'identifier',
-      {
-        user_on_waitlist: true,
-        user_can_claim_waitlist: false,
-      },
-      ''
-    );
-    const actions = lendingOptions.getCurrentLendingActions();
-
-    expect(actions.primaryTitle).to.equal(
-      'You are on the waitlist for this book.'
-    );
-    expect(actions.primaryActions.length).to.equal(2);
-    expect(actions.primaryActions[0].text).to.equal('Leave Waitlist');
-  });
-
   it('If book borrow is not available', async () => {
     const lendingOptions = new GetLendingActions('@user', 'identifier', {}, '');
     const actions = lendingOptions.getCurrentLendingActions();
 
-    expect(actions.primaryTitle).to.equal(
-      'This book is not available at this time.'
-    );
+    expect(actions.primaryTitle).to.equal(bookTitles.unavailable);
     expect(actions.primaryActions.length).to.equal(1);
     expect(actions.primaryActions[0].text).to.equal('Borrow Unavailable');
   });