Merge pull request #15 from getyoti/java-sdk-spring-security

Spring Security SDK

Author: qzagarese

README.md

@@ -35,6 +35,9 @@ The Modules above explained
 1) [Spring Boot Auto Configuration](#spring-boot-auto-configuration)- 
 Description of utilising Spring Boot
 
+1) [Spring Security Integration](#spring-security-integration)- 
+Integrating Yoti Authentication with Spring Boot.
+
 1) [Misc](#misc)
 
 1) [Known Issues](#known-issues)-
@@ -91,12 +94,12 @@ If you are using Maven, you need to add the following dependency:
 <dependency>
 	<groupId>com.yoti</groupId>
 	<artifactId>java-sdk-impl</artifactId>
-	<version>1.1</version>
+	<version>1.2</version>
 </dependency>
 ```
 If you are using Gradle, here is the dependency to add:
 
-`compile group: 'com.yoti', name: 'java-sdk-impl', version: '1.1'`
+`compile group: 'com.yoti', name: 'java-sdk-impl', version: '1.2'`
 
 You will find all classes packaged under `com.yoti.api`
 
@@ -205,13 +208,21 @@ Dummy implementation without connectivity to any platform services. Can be used
 Real SDK implementation that takes care of decrypting the token, fetching the user profile from Yoti servers by issuing a signed request and finally decrypting the fetched profile.
 ### java-sdk-spring-boot-auto-config
 A module that can be used in Spring Boot applications to automatically configure the YotiClient and KeyPairSource with standard application properties.
+### java-sdk-spring-security
+A module that can be used in Spring applications that use Spring Security to add Yoti authentication.
 
 ## Spring Boot Auto Configuration
 
 As a convenience, if your application happens to use Spring Boot, you can utilise the Spring Boot auto configuration module that will take care of configuring the Yoti Client and Key Pair for you based on standard application properties.
 
 For more information and to see an example of this in use take a look at the Spring Boot Auto Configuration module and Spring Boot example in this repository.
 
+## Spring Security Integration
+
+If you use Spring Security you can use the `java-sdk-spring-security` module to make integration easier. You are provided with some classes that fit into Spring Security's existing authentication model.
+
+Combining this with the Spring Boot Auto Configuration can make integration very easy with very little code needing to be written.
+
 ## Misc
 
 * By default, Yoti SDKs fetch profiles from [https://api.yoti.com/api/v1](https://api.yoti.com/api/v1).

java-sdk-api/.gitignore

@@ -175,7 +175,6 @@ Temporary Items
 Session.vim
 # temporary
 .netrwhist
-*~
 # auto-generated tag files
 tags
 

java-sdk-api/pom.xml

@@ -4,7 +4,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.yoti</groupId>
   <artifactId>java-sdk-api</artifactId>
-  <version>1.1</version>
+  <version>1.2</version>
   <name>Yoti Java SDK API</name>
   <description>Java SDK for simple integration with the Yoti platform</description>
   <url>https://github.com/getyoti/java</url>

java-sdk-api/src/main/java/com/yoti/api/client/HumanProfile.java

@@ -2,41 +2,50 @@
 
 /**
  * Profile of an human user with convenience methods to access well-known attributes.
- *
- *
  */
 public interface HumanProfile extends Profile {
     /**
-     * Corresponds to primary name in passport, and surname in English. 
+     * Corresponds to primary name in passport, and surname in English.
+     *
      * @return the surname
      */
     String getFamilyName();
 
     /**
      * Corresponds to secondary names in passport, and first/middle names in English.
-     * 
+     *
      * @return the name
      */
     String getGivenNames();
 
     /**
      * Equal to ${given_names} + " " + ${family_name}.
-     * 
+     *
      * @return the given names + the surname
+     * @deprecated this method has never featured as intended (it has always returned null). Deprecated since version 1.2, likely to be removed in version 2.0. Instead please use {@link #getGivenAndLastNames()}
      */
+    @Deprecated
     String getFullName();
 
+    /**
+     * Equal to ${given_names} + " " + ${family_name}.
+     *
+     * @return the given names + the surname
+     * @since 1.2
+     */
+    String getGivenAndLastNames();
+
     /**
      * Date of birth
-     * 
+     *
      * @return Date of birth
      */
     Date getDateOfBirth();
 
     /**
      * Corresponds to the gender in the passport; will be one of the strings "MALE", "FEMALE" or "OTHER".
      *
-     *@return the gender
+     * @return the gender
      */
     Gender getGender();
 
@@ -50,28 +59,28 @@ public interface HumanProfile extends Profile {
     /**
      * The user's phone number, as verified at registration time. This will be a number with + for international prefix
      * and no spaces, e.g. "+447777123456".
-     * 
+     *
      * @return the phone number
      */
     String getPhoneNumber();
 
     /**
      * Photograph of user, encoded as a JPEG image.
-     * 
+     *
      * @return the selfie
      */
     Image getSelfie();
 
     /**
      * The user's verified email address.
-     * 
+     *
      * @return the email address
      */
     String getEmailAddress();
 
     /**
      * Document details
-     * 
+     *
      * @return the document details
      */
     DocumentDetails getDocumentDetails();

java-sdk-api/src/test/java/com/yoti/api/client/AttributeTest.java

@@ -1,11 +1,9 @@
 package com.yoti.api.client;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNull;
-
 import org.junit.Test;
 
-import com.yoti.api.client.Attribute;
+import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.*;
 
 public class AttributeTest {
     private static final String NAME = "test";
@@ -24,7 +22,7 @@ public void shouldReturnNullIfValueIsNull() {
     }
 
     @Test
-    public void shouldReturnNullIfValueTypeIsDiffernet() {
+    public void shouldReturnNullIfValueTypeIsDifferent() {
         Attribute a = new Attribute(NAME, "testString");
         assertNull(a.getValue(Integer.class));
     }
@@ -38,12 +36,12 @@ public void shouldReturnValueNotDefault() {
     @Test
     public void shouldReturnDefaultIfValueTypeIsDifferent() {
         Attribute a = new Attribute(NAME, "testString");
-        assertEquals(new Integer(1), a.getValueOrDefault(Integer.class, new Integer(1)));
+        assertThat(1, is(a.getValueOrDefault(Integer.class, 1)));
     }
 
     @Test
     public void shouldReturnDefaultIfValueIsNull() {
         Attribute a = new Attribute(NAME, null);
-        assertEquals(new Integer(1), a.getValueOrDefault(Integer.class, new Integer(1)));
+        assertThat(1, is(a.getValueOrDefault(Integer.class, 1)));
     }
 }

java-sdk-dummy/.gitignore

@@ -175,7 +175,6 @@ Temporary Items
 Session.vim
 # temporary
 .netrwhist
-*~
 # auto-generated tag files
 tags
 

java-sdk-dummy/pom.xml

@@ -4,7 +4,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.yoti</groupId>
   <artifactId>java-sdk-dummy</artifactId>
-  <version>1.0</version>
+  <version>1.1</version>
   <name>Yoti Java SDK mock testing package</name>
   <description>Java SDK for simple integration with the Yoti platform</description>
   <url>https://github.com/getyoti/java</url>
@@ -117,7 +117,7 @@
     <dependency>
       <groupId>com.yoti</groupId>
       <artifactId>java-sdk-api</artifactId>
-      <version>1.1</version>
+      <version>1.2</version>
     </dependency>
   </dependencies>
 

java-sdk-dummy/src/main/java/com/yoti/api/client/spi/dummy/DummyYotiClient.java

@@ -1,23 +1,12 @@
 package com.yoti.api.client.spi.dummy;
 
+import com.yoti.api.client.*;
+
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 
-import com.yoti.api.client.ActivityDetails;
-import com.yoti.api.client.ApplicationProfile;
-import com.yoti.api.client.Attribute;
-import com.yoti.api.client.Date;
-import com.yoti.api.client.DocumentDetails;
-import com.yoti.api.client.HumanProfile;
-import com.yoti.api.client.Image;
-import com.yoti.api.client.InitialisationException;
-import com.yoti.api.client.ProfileException;
-import com.yoti.api.client.YotiClient;
-import com.yoti.api.client.YotiClientConfiguration;
-import com.yoti.api.client.YotiClientFactory;
-
 public class DummyYotiClient implements YotiClient, YotiClientFactory {
     private static final String EXCEPTION_TRIGGER_PREFIX = "exception-";
     private static final String DUMMY_PREFIX = "dummy-";
@@ -65,10 +54,16 @@ public String getGivenNames() {
             }
 
             @Override
+            @Deprecated
             public String getFullName() {
                 return "John Doe";
             }
 
+            @Override
+            public String getGivenAndLastNames() {
+                return "John Doe";
+            }
+
             @Override
             public Date getDateOfBirth() {
                 return null;

java-sdk-impl/.gitignore

@@ -177,7 +177,6 @@ Temporary Items
 Session.vim
 # temporary
 .netrwhist
-*~
 # auto-generated tag files
 tags
 

java-sdk-impl/pom.xml

@@ -4,7 +4,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.yoti</groupId>
   <artifactId>java-sdk-impl</artifactId>
-  <version>1.1</version>
+  <version>1.2</version>
   <name>Yoti Java SDK implementation package</name>
   <description>Java SDK for simple integration with the Yoti platform</description>
   <url>https://github.com/getyoti/java</url>
@@ -81,7 +81,7 @@
     <dependency>
       <groupId>com.yoti</groupId>
       <artifactId>java-sdk-api</artifactId>
-      <version>1.1</version>
+      <version>1.2</version>
     </dependency>
     <!-- Testing dependencies -->
     <dependency>