feat: implement updateContact(contact)

codebytere · codebytere · commit 7dbbe4803dea · 2019-08-13T10:02:50.000-07:00
diff --git a/README.md b/README.md
@@ -126,7 +126,7 @@ console.log(`New contact was ${success ? 'saved' : 'not saved'}.`)
 
 This method will return `false` if access to Contacts has not been granted.
 
-### contacts.deleteContactByName(name)
+### contacts.deleteContact(name)
 
 * `name` String (required) - The first, last, or full name of a contact.
 
@@ -139,9 +139,38 @@ However, you should take care to specify `name` to such a degree that you can be
 
 ```js
 const name = 'Jonathan Appleseed'
-const deleted = contacts.deleteContactByName(name)
+const deleted = contacts.deleteContact(name)
 
 console.log(`Contact ${name} was ${deleted ? 'deleted' : 'not deleted'}.`)
 ```
 
 This method will return `false` if access to Contacts has not been granted.
+
+### contacts.updateContact(contact)
+
+* `contact` Object
+  * `firstName` String (required) - The first name of the contact.
+  * `lastName` String (optional) - The last name of the contact.
+  * `nickname` String (optional) - The nickname for the contact.
+  * `birthday` String (optional) - The birthday for the contact in `YYYY-MM-DD` format.
+  * `phoneNumbers` Array\<String\> (optional) - The phone numbers for the contact, as strings in [E.164 format](https://en.wikipedia.org/wiki/E.164): `+14155552671` or `+442071838750`.
+  * `emailAddresses` Array\<String\> (optional) - The email addresses for the contact, as strings.
+
+Returns `Boolean` - whether the contact was updated successfully.
+
+Updates a contact to the user's contacts database.
+
+You should take care to specify parameters to the `contact` object to such a degree that you can be confident the first contact to be returned from a predicate search is the contact you intend to update.
+
+```js
+// Change contact's nickname from Billy -> Will
+const updated = contacts.updateContact({
+  firstName: 'William',
+  lastName: 'Grapeseed',
+  nickname: 'Will'
+})
+
+console.log(`Contact was ${updated ? 'updated' : 'not updated'}.`)
+```
+
+This method will return `false` if access to Contacts has not been granted.
diff --git a/contacts.mm b/contacts.mm
@@ -146,6 +146,56 @@ CNAuthorizationStatus AuthStatus() {
   return keys;
 }
 
+NSArray* FindContacts(const std::string& name_string) {
+  CNContactStore *addressBook = [[CNContactStore alloc] init];
+
+  NSString *name = [NSString stringWithUTF8String:name_string.c_str()];
+  NSPredicate *predicate = [CNContact predicateForContactsMatchingName:name];
+
+  return [addressBook unifiedContactsMatchingPredicate:predicate
+                                                          keysToFetch:GetContactKeys()
+                                                                error:nil];
+}
+
+CNMutableContact* CreateCNMutableContact(Napi::Object contact_data) {
+  CNMutableContact *contact = [[CNMutableContact alloc] init];
+  
+  if (contact_data.Has("firstName")) {
+    std::string first_name = contact_data.Get("firstName").As<Napi::String>().Utf8Value();
+    [contact setGivenName:[NSString stringWithUTF8String:first_name.c_str()]];
+  }
+
+  if (contact_data.Has("lastName")) {
+    std::string last_name = contact_data.Get("lastName").As<Napi::String>().Utf8Value();
+    [contact setFamilyName:[NSString stringWithUTF8String:last_name.c_str()]];
+  }
+
+  if (contact_data.Has("nickname")) {
+    std::string nick_name = contact_data.Get("nickname").As<Napi::String>().Utf8Value();
+    [contact setNickname:[NSString stringWithUTF8String:nick_name.c_str()]];
+  }
+
+  if (contact_data.Has("birthday")) {
+    std::string birth_day = contact_data.Get("birthday").As<Napi::String>().Utf8Value();
+    NSDateComponents *birthday_components = ParseBirthday(birth_day);
+    [contact setBirthday:birthday_components];
+  }
+
+  if (contact_data.Has("phoneNumbers")) {
+    Napi::Array phone_number_data = contact_data.Get("phoneNumbers").As<Napi::Array>();
+    NSArray *phone_numbers = ParsePhoneNumbers(phone_number_data);
+    [contact setPhoneNumbers:[NSArray arrayWithArray:phone_numbers]];
+  }
+
+  if (contact_data.Has("emailAddresses")) {
+    Napi::Array email_address_data = contact_data.Get("emailAddresses").As<Napi::Array>();
+    NSArray *email_addresses = ParseEmailAddresses(email_address_data);
+    [contact setEmailAddresses:[NSArray arrayWithArray:email_addresses]];
+  }
+
+  return contact;
+}
+
 /***** EXPORTED FUNCTIONS *****/
 
 Napi::Value GetAuthStatus(const Napi::CallbackInfo &info) {
@@ -174,8 +224,8 @@ CNAuthorizationStatus AuthStatus() {
 
   NSPredicate *predicate = [CNContact predicateForContactsInContainerWithIdentifier:addressBook.defaultContainerIdentifier];
 	NSArray *cncontacts = [addressBook unifiedContactsMatchingPredicate:predicate 
-                                                    keysToFetch:GetContactKeys() 
-                                                                      error:nil];
+                                                          keysToFetch:GetContactKeys() 
+                                                                error:nil];
   
   int num_contacts = [cncontacts count];
   for (int i = 0; i < num_contacts; i++) {
@@ -189,18 +239,12 @@ CNAuthorizationStatus AuthStatus() {
 Napi::Array GetContactsByName(const Napi::CallbackInfo &info) {
   Napi::Env env = info.Env();
   Napi::Array contacts = Napi::Array::New(env);
-  CNContactStore *addressBook = [[CNContactStore alloc] init];
 
   if (AuthStatus() != CNAuthorizationStatusAuthorized)
     return contacts;
 
-  std::string name_string = info[0].As<Napi::String>().Utf8Value();
-  NSString *name = [NSString stringWithUTF8String:name_string.c_str()];
-  NSPredicate *predicate = [CNContact predicateForContactsMatchingName:name];
-
-  NSArray *cncontacts = [addressBook unifiedContactsMatchingPredicate:predicate
-                                                    keysToFetch:GetContactKeys()
-                                                                      error:nil];
+  const std::string name_string = info[0].As<Napi::String>().Utf8Value();
+  NSArray *cncontacts = FindContacts(name_string);
   
   int num_contacts = [cncontacts count];
   for (int i = 0; i < num_contacts; i++) {
@@ -218,71 +262,48 @@ CNAuthorizationStatus AuthStatus() {
   if (AuthStatus() != CNAuthorizationStatusAuthorized)
     return Napi::Boolean::New(env, false);
 
-  CNMutableContact *contact = [[CNMutableContact alloc] init];
   Napi::Object contact_data = info[0].As<Napi::Object>();
+  CNMutableContact *contact = CreateCNMutableContact(contact_data);
 
-  if (contact_data.Has("firstName")) {
-    std::string first_name = contact_data.Get("firstName").As<Napi::String>().Utf8Value();
-    [contact setGivenName:[NSString stringWithUTF8String:first_name.c_str()]];
-  }
-
-  if (contact_data.Has("lastName")) {
-    std::string last_name = contact_data.Get("lastName").As<Napi::String>().Utf8Value();
-    [contact setFamilyName:[NSString stringWithUTF8String:last_name.c_str()]];
-  }
-
-  if (contact_data.Has("nickname")) {
-    std::string nick_name = contact_data.Get("nickname").As<Napi::String>().Utf8Value();
-    [contact setNickname:[NSString stringWithUTF8String:nick_name.c_str()]];
-  }
+  CNSaveRequest *request = [[CNSaveRequest alloc] init];
+  [request addContact:contact toContainerWithIdentifier:nil];
+  bool success = [addressBook executeSaveRequest:request error:nil];
 
-  if (contact_data.Has("birthday")) {
-    std::string birth_day = contact_data.Get("birthday").As<Napi::String>().Utf8Value();
-    NSDateComponents *birthday_components = ParseBirthday(birth_day);
-    [contact setBirthday:birthday_components];
-  }
+  return Napi::Boolean::New(env, success);
+}
 
-  if (contact_data.Has("phoneNumbers")) {
-    Napi::Array phone_number_data = contact_data.Get("phoneNumbers").As<Napi::Array>();
-    NSArray *phone_numbers = ParsePhoneNumbers(phone_number_data);
-    [contact setPhoneNumbers:[NSArray arrayWithArray:phone_numbers]];
-  }
+Napi::Value DeleteContact(const Napi::CallbackInfo &info) {
+  Napi::Env env = info.Env();
 
-  if (contact_data.Has("emailAddresses")) {
-    Napi::Array email_address_data = contact_data.Get("emailAddresses").As<Napi::Array>();
-    NSArray *email_addresses = ParseEmailAddresses(email_address_data);
-    [contact setEmailAddresses:[NSArray arrayWithArray:email_addresses]];
-  }
+  if (AuthStatus() != CNAuthorizationStatusAuthorized)
+    return Napi::Boolean::New(env, false);
 
+  const std::string name_string = info[0].As<Napi::String>().Utf8Value();
+  NSArray *cncontacts = FindContacts(name_string);
+  
+  CNContact *contact = (CNContact*)[cncontacts objectAtIndex:0];
   CNSaveRequest *request = [[CNSaveRequest alloc] init];
-  [request addContact:contact toContainerWithIdentifier:nil];
+  [request deleteContact:[contact mutableCopy]];
+  
+  CNContactStore *addressBook = [[CNContactStore alloc] init];
   bool success = [addressBook executeSaveRequest:request error:nil];
 
   return Napi::Boolean::New(env, success);
 }
 
-Napi::Value DeleteContactByName(const Napi::CallbackInfo &info) {
+Napi::Value UpdateContact(const Napi::CallbackInfo &info) {
   Napi::Env env = info.Env();
-  CNContactStore *addressBook = [[CNContactStore alloc] init];
 
   if (AuthStatus() != CNAuthorizationStatusAuthorized)
     return Napi::Boolean::New(env, false);
 
-  std::string name_string = info[0].As<Napi::String>().Utf8Value();
-  NSString *name = [NSString stringWithUTF8String:name_string.c_str()];
-  NSPredicate *predicate = [CNContact predicateForContactsMatchingName:name];
-
-  NSArray *cncontacts = [addressBook unifiedContactsMatchingPredicate:predicate
-                                                                keysToFetch:GetContactKeys()
-                                                                      error:nil];
+  Napi::Object contact_data = info[0].As<Napi::Object>();
   
-  // Place the burden on end-users to specify name enough that
-  // the first contact to be returned from a predicate search would
-  // be the person they want to delete
-  CNContact *contact = (CNContact*)[cncontacts objectAtIndex:0];
+  CNMutableContact *contact = CreateCNMutableContact(contact_data);
   CNSaveRequest *request = [[CNSaveRequest alloc] init];
-  [request deleteContact:[contact mutableCopy]];
+  [request updateContact:contact];
   
+  CNContactStore *addressBook = [[CNContactStore alloc] init];
   bool success = [addressBook executeSaveRequest:request error:nil];
 
   return Napi::Boolean::New(env, success);
@@ -302,7 +323,10 @@ CNAuthorizationStatus AuthStatus() {
     Napi::String::New(env, "addNewContact"), Napi::Function::New(env, AddNewContact)
   );
   exports.Set(
-    Napi::String::New(env, "deleteContactByName"), Napi::Function::New(env, DeleteContactByName)
+    Napi::String::New(env, "deleteContact"), Napi::Function::New(env, DeleteContact)
+  );
+  exports.Set(
+    Napi::String::New(env, "updateContact"), Napi::Function::New(env, UpdateContact)
   );
 
   return exports;
diff --git a/index.js b/index.js
@@ -36,16 +36,47 @@ function addNewContact(contact) {
   return contacts.addNewContact.call(this, contact)
 }
 
-function deleteContactByName(name) {
+function updateContact(contact) {
+  if (!contact || Object.keys(contact).length === 0) {
+    throw new TypeError('contact must be a non-empty object')
+  } else {
+    const hasFirstName = contact.hasOwnProperty('firstName')
+    const hasLastName = contact.hasOwnProperty('lastName')
+    const hasNickname = contact.hasOwnProperty('nickname')
+    const hasBirthday = contact.hasOwnProperty('birthday')
+    const hasPhoneNumbers = contact.hasOwnProperty('phoneNumbers')
+    const hasEmailAddresses = contact.hasOwnProperty('emailAddresses')
+
+    if (hasFirstName && typeof contact.firstName !== 'string') throw new TypeError('firstName must be a string')
+    if (hasLastName && typeof contact.lastName !== 'string') throw new TypeError('lastName must be a string')
+    if (hasNickname && typeof contact.nickname !== 'string') throw new TypeError('nickname must be a string')
+    if (hasPhoneNumbers && !Array.isArray(contact.phoneNumbers)) throw new TypeError('phoneNumbers must be an array')
+    if (hasEmailAddresses && !Array.isArray(contact.emailAddresses)) throw new TypeError('emailAddresses must be an array')
+
+    if (hasBirthday) {
+      const datePattern = /^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$/
+      if (typeof contact.birthday !== 'string') {
+        throw new TypeError('birthday must be a string')
+      } else if (!contact.birthday.match(datePattern)) {
+        throw new Error('birthday must use YYYY-MM-DD format')
+      }
+    }
+  }
+
+  return contacts.updateContact.call(this, contact)
+}
+
+function deleteContact(name) {
   if (typeof name !== 'string') throw new TypeError('name must be a string')
 
-  return contacts.deleteContactByName.call(this, name)
+  return contacts.deleteContact.call(this, name)
 }
 
 module.exports = {
   getAuthStatus: contacts.getAuthStatus,
   getAllContacts: contacts.getAllContacts,
   getContactsByName,
   addNewContact,
-  deleteContactByName
+  deleteContact,
+  updateContact
 }
diff --git a/test/module.spec.js b/test/module.spec.js
@@ -4,7 +4,8 @@ const {
   getContactsByName,
   getAllContacts,
   addNewContact,
-  deleteContactByName
+  deleteContact,
+  updateContact
 } = require('../index')
 
 describe('node-mac-contacts', () => {
@@ -82,11 +83,59 @@ describe('node-mac-contacts', () => {
     })
   })
 
-  describe('deleteContactByName(name)', () => {
+  describe('deleteContact(name)', () => {
     it('should throw if name is not a string', () => {
       expect(() => {
-        deleteContactByName(12345)
+        deleteContact(12345)
       }).to.throw(/name must be a string/)
     })
   })
+
+  describe('updateContact(contact)', () => {
+    it('throws if contact is not a nonempty object', () => {
+      expect(() => {
+        updateContact(1)
+      }).to.throw(/contact must be a non-empty object/)
+
+      expect(() => {
+        updateContact({})
+      }).to.throw(/contact must be a non-empty object/)
+    })
+
+    it('should throw if name properties are not strings', () => {
+      expect(() => {
+        updateContact({ firstName: 1 })
+      }).to.throw(/firstName must be a string/)
+
+      expect(() => {
+        updateContact({ lastName: 1 })
+      }).to.throw(/lastName must be a string/)
+
+      expect(() => {
+        updateContact({ nickname: 1 })
+      }).to.throw(/nickname must be a string/)
+    })
+
+    it('should throw if birthday is not a string in YYYY-MM-DD format', () => {
+      expect(() => {
+        updateContact({ birthday: 1 })
+      }).to.throw(/birthday must be a string/)
+
+      expect(() => {
+        updateContact({ birthday: '01-01-1970' })
+      }).to.throw(/birthday must use YYYY-MM-DD format/)
+    })
+
+    it('should throw if phoneNumbers is not an array', () => {
+      expect(() => {
+        updateContact({ phoneNumbers: 1 })
+      }).to.throw(/phoneNumbers must be an array/)
+    })
+
+    it('should throw if emailAddresses is not an array', () => {
+      expect(() => {
+        updateContact({ emailAddresses: 1 })
+      }).to.throw(/emailAddresses must be an array/)
+    })
+  })
 })
