mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
Merged 131464:131680 from DEV/mward/5.2.n_createperson to 5.2.n
Creating branch for REPO-892 (Create person REST API) REPO-892: create person - initial commit, bare-bones implementation and test. REPO-892: refactored test versions of Person and Company to reduce duplication. REPO-892: further refactoring to reduce prod/test duplication. REPO-892: add missing fields to the 'create person' operation. REPO-892: introduced PersonUpdate class for create (and I'm assuming update) operations. REPO-892: missing license header REPO-892: very minor refactoring - extract field in tests. REPO-892: make sure not all fields need to be supplied during create. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@131858 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Matt Ward
@@ -1,54 +1,58 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
*
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
*
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
package org.alfresco.rest.api.tests;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
import java.util.Iterator;
|
||||
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.repo.tenant.TenantUtil;
|
||||
import org.alfresco.repo.tenant.TenantUtil.TenantRunAsWork;
|
||||
import org.alfresco.repo.transaction.RetryingTransactionHelper;
|
||||
import org.alfresco.rest.api.tests.RepoService.SiteInformation;
|
||||
import org.alfresco.rest.api.model.PersonUpdate;
|
||||
import org.alfresco.rest.api.tests.RepoService.TestNetwork;
|
||||
import org.alfresco.rest.api.tests.RepoService.TestSite;
|
||||
import org.alfresco.rest.api.tests.client.PublicApiClient.People;
|
||||
import org.alfresco.rest.api.tests.client.PublicApiException;
|
||||
import org.alfresco.rest.api.tests.client.RequestContext;
|
||||
import org.alfresco.rest.api.tests.client.data.Company;
|
||||
import org.alfresco.rest.api.tests.client.data.JSONAble;
|
||||
import org.alfresco.rest.api.tests.client.data.Person;
|
||||
import org.alfresco.rest.api.tests.client.data.SiteRole;
|
||||
import org.alfresco.service.cmr.site.SiteVisibility;
|
||||
import org.apache.commons.httpclient.HttpStatus;
|
||||
import org.json.simple.JSONObject;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import java.util.Iterator;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
public class TestPeople extends EnterpriseTestApi
|
||||
{
|
||||
private People people;
|
||||
|
||||
@Before
|
||||
public void setUp() throws Exception
|
||||
{
|
||||
people = publicApiClient.people();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testPeople() throws Exception
|
||||
{
|
||||
@@ -62,13 +66,11 @@ public class TestPeople extends EnterpriseTestApi
|
||||
Iterator<String> personIt2 = account2.getPersonIds().iterator();
|
||||
final String person3 = personIt2.next();
|
||||
|
||||
People peopleProxy = publicApiClient.people();
|
||||
|
||||
// Test Case cloud-2192
|
||||
// should be able to see oneself
|
||||
{
|
||||
publicApiClient.setRequestContext(new RequestContext(account1.getId(), person1));
|
||||
Person resp = peopleProxy.getPerson(person1);
|
||||
Person resp = people.getPerson(person1);
|
||||
Person person1Entity = repoService.getPerson(person1);
|
||||
check(person1Entity, resp);
|
||||
}
|
||||
@@ -76,7 +78,7 @@ public class TestPeople extends EnterpriseTestApi
|
||||
// should be able to see another user in the same domain, and be able to see full profile
|
||||
{
|
||||
publicApiClient.setRequestContext(new RequestContext(account1.getId(), person2));
|
||||
Person resp = peopleProxy.getPerson(person1);
|
||||
Person resp = people.getPerson(person1);
|
||||
Person person1Entity = repoService.getPerson(person1);
|
||||
check(person1Entity, resp);
|
||||
}
|
||||
@@ -84,7 +86,7 @@ public class TestPeople extends EnterpriseTestApi
|
||||
// "-me-" user
|
||||
{
|
||||
publicApiClient.setRequestContext(new RequestContext(account1.getId(), person1));
|
||||
Person resp = peopleProxy.getPerson(org.alfresco.rest.api.People.DEFAULT_USER);
|
||||
Person resp = people.getPerson(org.alfresco.rest.api.People.DEFAULT_USER);
|
||||
Person person1Entity = repoService.getPerson(person1);
|
||||
check(person1Entity, resp);
|
||||
}
|
||||
@@ -93,7 +95,7 @@ public class TestPeople extends EnterpriseTestApi
|
||||
publicApiClient.setRequestContext(new RequestContext(account1.getId(), person3));
|
||||
try
|
||||
{
|
||||
peopleProxy.getPerson(person1);
|
||||
people.getPerson(person1);
|
||||
fail("");
|
||||
}
|
||||
catch(PublicApiException e)
|
||||
@@ -111,4 +113,156 @@ public class TestPeople extends EnterpriseTestApi
|
||||
assertEquals(resp.getDescription(), desc);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testCreatePerson() throws Exception
|
||||
{
|
||||
Iterator<TestNetwork> accountsIt = getTestFixture().getNetworksIt();
|
||||
final TestNetwork account1 = accountsIt.next();
|
||||
final String networkAdmin = "admin@"+account1.getId();
|
||||
publicApiClient.setRequestContext(new RequestContext(account1.getId(), networkAdmin, "admin"));
|
||||
|
||||
PersonUpdate person = new PersonUpdate.Builder().
|
||||
id("myUserName@"+account1.getId()).
|
||||
firstName("Firstname").
|
||||
lastName("Lastname").
|
||||
description("my description").
|
||||
email("email@example.com").
|
||||
skypeId("my.skype.id").
|
||||
googleId("google").
|
||||
instantMessageId("jabber@im.example.com").
|
||||
jobTitle("International Man of Mystery").
|
||||
location("location").
|
||||
company(new Company("Org", "addr1", "addr2", "addr3", "AB1 1BA", "111 12312123", "222 345345345", "company.email@example.com")).
|
||||
mobile("5657 567567 34543").
|
||||
telephone("1234 5678 9012").
|
||||
userStatus("userStatus").
|
||||
enabled(true).
|
||||
emailNotificationsEnabled(true).
|
||||
build();
|
||||
|
||||
// true -> use extra fields such as company
|
||||
Person p = people.create(person, true);
|
||||
|
||||
assertEquals("myUserName@"+account1.getId(), p.getId());
|
||||
assertEquals("Firstname", p.getFirstName());
|
||||
assertEquals("Lastname", p.getLastName());
|
||||
|
||||
// TODO: we currently have confusion over cm:description, cm:persondescription and RestApi:description
|
||||
// PeopleImpl currently removes cm:persondescription and replaces it with {RestApi}description
|
||||
// We'll keep description as null until we know better.
|
||||
// assertEquals("my description", p.getDescription());
|
||||
assertEquals(null, p.getDescription());
|
||||
|
||||
assertEquals("email@example.com", p.getEmail());
|
||||
assertEquals("my.skype.id", p.getSkypeId());
|
||||
assertEquals("google", p.getGoogleId());
|
||||
assertEquals("jabber@im.example.com", p.getInstantMessageId());
|
||||
assertEquals("International Man of Mystery", p.getJobTitle());
|
||||
assertEquals("location", p.getLocation());
|
||||
|
||||
// Check embedded "company" document
|
||||
org.alfresco.rest.api.model.Company co = p.getCompany();
|
||||
assertEquals("Org", co.getOrganization());
|
||||
assertEquals("addr1", co.getAddress1());
|
||||
assertEquals("addr2", co.getAddress2());
|
||||
assertEquals("addr3", co.getAddress3());
|
||||
assertEquals("AB1 1BA", co.getPostcode());
|
||||
assertEquals("111 12312123", co.getTelephone());
|
||||
assertEquals("222 345345345", co.getFax());
|
||||
assertEquals("company.email@example.com", co.getEmail());
|
||||
|
||||
assertEquals("5657 567567 34543", p.getMobile());
|
||||
assertEquals("1234 5678 9012", p.getTelephone());
|
||||
assertEquals("userStatus", p.getUserStatus());
|
||||
assertEquals(true, p.isEnabled());
|
||||
assertEquals(true, p.isEmailNotificationsEnabled());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testCreatePerson_notAllFieldsRequired() throws Exception
|
||||
{
|
||||
Iterator<TestNetwork> accountsIt = getTestFixture().getNetworksIt();
|
||||
final TestNetwork account1 = accountsIt.next();
|
||||
final String networkAdmin = "admin@"+account1.getId();
|
||||
publicApiClient.setRequestContext(new RequestContext(account1.getId(), networkAdmin, "admin"));
|
||||
|
||||
PersonUpdate person = new PersonUpdate.Builder().
|
||||
id("joe.bloggs@"+account1.getId()).
|
||||
firstName("Joe").
|
||||
lastName("Bloggs").
|
||||
email("joe.bloggs@example.com").
|
||||
skypeId("jb.skype.id").
|
||||
telephone("1234 5678 9012").
|
||||
enabled(false).
|
||||
emailNotificationsEnabled(false).
|
||||
build();
|
||||
|
||||
// true -> use extra fields such as company
|
||||
Person p = people.create(person, true);
|
||||
|
||||
assertEquals("joe.bloggs@"+account1.getId(), p.getId());
|
||||
assertEquals("Joe", p.getFirstName());
|
||||
assertEquals("Bloggs", p.getLastName());
|
||||
assertEquals(null, p.getDescription());
|
||||
assertEquals("joe.bloggs@example.com", p.getEmail());
|
||||
assertEquals("jb.skype.id", p.getSkypeId());
|
||||
assertEquals(null, p.getGoogleId());
|
||||
assertEquals(null, p.getInstantMessageId());
|
||||
assertEquals(null, p.getJobTitle());
|
||||
assertEquals(null, p.getLocation());
|
||||
assertEquals(null, p.getCompany());
|
||||
assertEquals(null, p.getMobile());
|
||||
assertEquals("1234 5678 9012", p.getTelephone());
|
||||
assertEquals(null, p.getUserStatus());
|
||||
assertEquals(true, p.isEnabled());
|
||||
assertEquals(false, p.isEmailNotificationsEnabled());
|
||||
}
|
||||
|
||||
public static class PersonUpdateJSONSerializer implements JSONAble
|
||||
{
|
||||
private final PersonUpdate personUpdate;
|
||||
|
||||
public PersonUpdateJSONSerializer(PersonUpdate personUpdate)
|
||||
{
|
||||
this.personUpdate = personUpdate;
|
||||
}
|
||||
|
||||
@Override
|
||||
public JSONObject toJSON()
|
||||
{
|
||||
return toJSON(true);
|
||||
}
|
||||
|
||||
public JSONObject toJSON(boolean fullVisibility)
|
||||
{
|
||||
JSONObject personJson = new JSONObject();
|
||||
|
||||
personJson.put("id", personUpdate.getUserName());
|
||||
personJson.put("firstName", personUpdate.getFirstName());
|
||||
personJson.put("lastName", personUpdate.getLastName());
|
||||
|
||||
if (fullVisibility)
|
||||
{
|
||||
personJson.put("description", personUpdate.getDescription());
|
||||
personJson.put("email", personUpdate.getEmail());
|
||||
personJson.put("skypeId", personUpdate.getSkypeId());
|
||||
personJson.put("googleId", personUpdate.getGoogleId());
|
||||
personJson.put("instantMessageId", personUpdate.getInstantMessageId());
|
||||
personJson.put("jobTitle", personUpdate.getJobTitle());
|
||||
personJson.put("location", personUpdate.getLocation());
|
||||
org.alfresco.rest.api.model.Company co = personUpdate.getCompany();
|
||||
if (co == null)
|
||||
{
|
||||
co = new org.alfresco.rest.api.model.Company();
|
||||
}
|
||||
personJson.put("company", new Company(co).toJSON());
|
||||
personJson.put("mobile", personUpdate.getMobile());
|
||||
personJson.put("telephone", personUpdate.getTelephone());
|
||||
personJson.put("userStatus", personUpdate.getUserStatus());
|
||||
personJson.put("enabled", personUpdate.isEnabled());
|
||||
personJson.put("emailNotificationsEnabled", personUpdate.isEmailNotificationsEnabled());
|
||||
}
|
||||
return personJson;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user