Implement logic to add expiration date to banned books and remove exp…

…ired banned books

Simplified.xcodeproj/project.pbxproj

@@ -2556,8 +2556,8 @@
 				73FB0AC824EB403D0072E430 /* NYPLBookContentTypeConverter.swift */,
 				1139DA6319C7755D00A07810 /* NYPLBookCoverRegistry.h */,
 				1139DA6419C7755D00A07810 /* NYPLBookCoverRegistry.m */,
-				1164F104199AC236009BF8BF /* NYPLBookLocation.h */,
 				1164F105199AC236009BF8BF /* NYPLBookLocation.m */,
+				1164F104199AC236009BF8BF /* NYPLBookLocation.h */,
 				11616E0F196B0531003D60D9 /* NYPLBookRegistry.h */,
 				11616E10196B0531003D60D9 /* NYPLBookRegistry.m */,
 				112C694B197301FE00C48F95 /* NYPLBookRegistryRecord.h */,

Simplified/Book/Models/NYPLBook.h

@@ -102,4 +102,9 @@
 /// @return The default NYPLBookContentType
 - (NYPLBookContentType)defaultBookContentType;
 
+/// Add a custom expiration date to book if
+/// 1. book is distributed by Axis360
+/// 2. book does not contain an expiration date
+- (void)addCustomExpirateDate:(nonnull NSDate *)date;
+
 @end

Simplified/Book/Models/NYPLBook.m

@@ -618,4 +618,19 @@ - (NYPLBookContentType)defaultBookContentType
   return defaultType;
 }
 
+- (void)addCustomExpirateDate:(nonnull NSDate *)date
+{
+  if (self.defaultAcquisitionIfOpenAccess.type &&
+      [self.defaultAcquisitionIfOpenAccess.type isEqualToString:ContentTypeAxis360] &&
+      !self.defaultAcquisitionIfOpenAccess.availability.until)
+  {
+    NYPLOPDSAcquisitionAvailabilityLimited *currentAvailability = (NYPLOPDSAcquisitionAvailabilityLimited *)self.defaultAcquisition.availability;
+    NYPLOPDSAcquisitionAvailabilityLimited *newAvailability = [[NYPLOPDSAcquisitionAvailabilityLimited alloc]
+                                                               initWithCopiesAvailable:currentAvailability.copiesAvailable
+                                                               copiesTotal:currentAvailability.copiesTotal
+                                                               since:currentAvailability.since
+                                                               until:date];
+      [self.defaultAcquisition updateAvailability:newAvailability];
+    }
+}
 @end

Simplified/Book/Models/NYPLBookRegistry.h

@@ -109,6 +109,12 @@ typedef NS_ENUM(NSInteger, NYPLBookState);
  */
 - (void)syncWithStandardAlertsOnCompletion;
 
+/**
+ Goes through all books in registry and remove the expired books distributed by Axis 360.
+ @note: Only call this function if the library does not require authentication
+ */
+- (void)removeExpiredBooksWithoutFeed;
+
 // Adds a book to the book registry until it is manually removed. It allows the application to
 // present information about obtained books when offline. Attempting to add a book already present
 // will overwrite the existing book as if |updateBook:| were called. The location may be nil. The

Simplified/Book/Models/NYPLBookRegistry.m

@@ -448,6 +448,29 @@ - (void)syncWithStandardAlertsOnCompletion
   }];
 }
 
+- (void)removeExpiredBooksWithoutFeed
+{
+  @synchronized(self) {
+    NSMutableArray *booksToRemove = [[NSMutableArray alloc] init];
+    for (NSString *bookIdentifer in self.identifiersToRecords) {
+      NYPLBookRegistryRecord *record = self.identifiersToRecords[bookIdentifer];
+      // Add the book to remove list if it is distributed by Axis360 and expired
+      if(record &&
+        record.book.defaultAcquisition.type &&
+        [record.book.defaultAcquisition.type isEqualToString:ContentTypeAxis360]) {
+          if (record.book.defaultAcquisition.availability.until &&
+            [record.book.defaultAcquisition.availability.until compare:[NSDate date]] == NSOrderedAscending) {
+              [booksToRemove addObject:bookIdentifer];
+          }
+      }
+    }
+    for (NSString *bookIdentifier in booksToRemove) {
+      [self removeBookForIdentifier:bookIdentifier];
+    }
+    [self save];
+  }
+}
+
 - (void)addBook:(NYPLBook *const)book
        location:(NYPLBookLocation *const)location
           state:(NSInteger)state

Simplified/Catalog/NYPLCatalogFeedViewController.m

@@ -138,6 +138,9 @@ - (void)viewDidLoad
   }
 
   [[NYPLBookRegistry sharedRegistry] justLoad];
+  if (!NYPLUserAccount.sharedAccount.requiresUserAuthentication) {
+    [[NYPLBookRegistry sharedRegistry] removeExpiredBooksWithoutFeed];
+  }
   UIApplicationState applicationState = [[UIApplication sharedApplication] applicationState];
   if (applicationState == UIApplicationStateActive) {
     [self syncBookRegistryForNewFeed];

Simplified/Catalog/NYPLCatalogGroupedFeed.m

@@ -91,6 +91,12 @@ - (instancetype)initWithOPDSFeed:(NYPLOPDSFeed *)feed
   NSMutableDictionary *const groupTitleToMutableBookArray = [NSMutableDictionary dictionary];
   NSMutableDictionary *const groupTitleToURLOrNull = [NSMutableDictionary dictionary];
 
+  // Create an expiration date object with value of 2 months from now
+  NSDateComponents *dateComponents = [[NSDateComponents alloc] init];
+  [dateComponents setMonth:2];
+  NSCalendar *calendar = [NSCalendar currentCalendar];
+  NSDate *expirationDate = [calendar dateByAddingComponents:dateComponents toDate:[NSDate new] options:0];
+
   for(NYPLOPDSEntry *const entry in feed.entries) {
     if(!entry.groupAttributes) {
       NYPLLOG(@"Ignoring entry with missing group.");
@@ -110,6 +116,13 @@ - (instancetype)initWithOPDSFeed:(NYPLOPDSFeed *)feed
       continue;
     }
 
+    /// Add a custom expiration date (2 months from now) to banned book.
+    /// This expiration date will be overwritten by the updatedBookMetadata function below
+    /// if the book is already checked out.
+    if (!NYPLUserAccount.sharedAccount.requiresUserAuthentication) {
+      [book addCustomExpirateDate:expirationDate];
+    }
+
     NYPLBook *updatedBook = [[NYPLBookRegistry sharedRegistry] updatedBookMetadata:book];
     if(updatedBook) {
       book = updatedBook;

Simplified/Catalog/NYPLCatalogUngroupedFeed.m

@@ -38,6 +38,12 @@ - (instancetype)initWithOPDSFeed:(NYPLOPDSFeed *const)feed
 
   self.books = [NSMutableArray array];
 
+  // Create an expiration date object with value of 2 months from now
+  NSDateComponents *dateComponents = [[NSDateComponents alloc] init];
+  [dateComponents setMonth:2];
+  NSCalendar *calendar = [NSCalendar currentCalendar];
+  NSDate *expirationDate = [calendar dateByAddingComponents:dateComponents toDate:[NSDate new] options:0];
+
   for(NYPLOPDSEntry *const entry in feed.entries) {
     NYPLBook *book = [NYPLBook bookWithEntry:entry];
     if(!book) {
@@ -50,6 +56,13 @@ - (instancetype)initWithOPDSFeed:(NYPLOPDSFeed *const)feed
       continue;
     }
 
+    /// Add a custom expiration date (2 months from now) to banned book.
+    /// This expiration date will be overwritten by the updatedBookMetadata function below
+    /// if the book is already checked out.
+    if (!NYPLUserAccount.sharedAccount.requiresUserAuthentication) {
+      [book addCustomExpirateDate:expirationDate];
+    }
+
     NYPLBook *updatedBook = [[NYPLBookRegistry sharedRegistry] updatedBookMetadata:book];
     if(updatedBook) {
       book = updatedBook;

Simplified/OPDS/NYPLOPDSAcquisition.h

@@ -100,4 +100,6 @@ NYPLOPDSAcquisitionRelationString(NYPLOPDSAcquisitionRelation relation);
 /// @c acquisitionWithDictionary: method for later deserialization.
 - (NSDictionary *_Nonnull)dictionaryRepresentation;
 
+- (void)updateAvailability:(id<NYPLOPDSAcquisitionAvailability> _Nonnull)availability;
+
 @end

Simplified/OPDS/NYPLOPDSAcquisition.m

@@ -276,4 +276,8 @@ - (NSDictionary *_Nonnull)dictionaryRepresentation
   };
 }
 
+- (void)updateAvailability:(id<NYPLOPDSAcquisitionAvailability> _Nonnull)availability {
+  self.availability = availability;
+}
+
 @end