Merge remote-tracking branch 'origin/dev'

Author: pipldev

.gitignore

@@ -2,3 +2,4 @@
 .settings
 .classpath
 .project
+/bin/

LICENSE

@@ -1,11 +1,11 @@
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
 limitations under the License.

README.md

@@ -1,25 +1,25 @@
-piplapis Java Library
-===========================
-
-This is a Java client library for easily integrating Pipl's APIs into your application.
-
-* Full details about Pipl's APIs - [http://pipl.com/dev](http://pipl.com/dev)  
-* This library is available in other languages - [http://pipl.com/dev/guide/code_libraries](http://pipl.com/dev/guide/code_libraries)
-
-Library Requirements
---------------------
-
-* Google Gson, you can find it inside this project under `lib/google/` or download from [here](http://code.google.com/p/google-gson/downloads/list).
-* The library was tested on Java 7 but will probably work on earlier versions as well.
-
-Installation
-------------
-
-* Import the piplapis jar file (can be found under `lib/`) or compile the source code (can be found under `src/`) 
-
-Getting Started & Code Snippets
--------------------------------
-
-**Pipl's Search API**
-* Code snippets - [http://pipl.com/dev/guide/code_snippets](http://pipl.com/dev/guide/code_snippets)  
-* Full reference - [http://pipl.com/dev/reference](http://pipl.com/dev/reference)
+piplapis Java Library
+===========================
+
+This is a Java client library for easily integrating Pipl's APIs into your application.
+
+* Full details about Pipl's APIs - [http://pipl.com/dev](http://pipl.com/dev)  
+* This library is available in other languages - [http://pipl.com/dev/guide/code_libraries](http://pipl.com/dev/guide/code_libraries)
+
+Library Requirements
+--------------------
+
+* Google Gson, you can find it inside this project under `lib/google/` or download from [here](http://code.google.com/p/google-gson/downloads/list).
+* The library was tested on Java 7 but will probably work on earlier versions as well.
+
+Installation
+------------
+
+* Import the piplapis jar file (can be found under `lib/`) or compile the source code (can be found under `src/`) 
+
+Getting Started & Code Snippets
+-------------------------------
+
+**Pipl's Search API**
+* Code snippets - [http://pipl.com/dev/guide/code_snippets](http://pipl.com/dev/guide/code_snippets)  
+* Full reference - [http://pipl.com/dev/reference](http://pipl.com/dev/reference)

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>com.pipl.api</groupId>
 	<artifactId>piplapis</artifactId>
-	<version>5.0.1</version>
+	<version>5.0.2</version>
 	<packaging>jar</packaging>
 
 	<name>${project.groupId}:${project.artifactId}</name>

src/main/java/com/pipl/api/search/SearchAPIResponse.java

@@ -106,6 +106,8 @@ public class SearchAPIResponse implements Serializable {
 	@Expose
     @SerializedName("@match_requirements")
 	public String matchRequirements;
+    @SerializedName("@source_category_requirements")
+	public String sourceCategoryRequirements;
 
     /**
      * @return Sources that match the person from the query.

src/main/java/com/pipl/api/search/SearchConfiguration.java

@@ -28,6 +28,7 @@ public class SearchConfiguration {
 	public Boolean hideSponsored;
 	public Boolean liveFeeds;
 	public String matchRequirements;
+	public String sourceCategoryRequirements;
 	public String extraParams;
 
 	public SearchConfiguration() {
@@ -63,6 +64,24 @@ public SearchConfiguration(String protocol, String host, String path,
 		setMatchRequirements(matchRequirements);
 	}
 
+	public SearchConfiguration(String protocol, String host, String path,
+			String apiKey, float minimumProbability, String showSources,
+			boolean hideSponsored, float minimumMatch, boolean liveFeeds,
+			Expression matchRequirements, Expression sourceCategoryRequirements) {
+		this(protocol, host, path, apiKey, minimumProbability, showSources, hideSponsored, minimumMatch, liveFeeds);
+		setMatchRequirements(matchRequirements);
+		setSourceCategoryRequirements(sourceCategoryRequirements);
+	}
+	
+	public SearchConfiguration(String protocol, String host, String path,
+			String apiKey, float minimumProbability, String showSources,
+			boolean hideSponsored, float minimumMatch, boolean liveFeeds,
+			String matchRequirements, String sourceCategoryRequirements) {
+		this(protocol, host, path, apiKey, minimumProbability, showSources, hideSponsored, minimumMatch, liveFeeds);
+		setMatchRequirements(matchRequirements);
+		setSourceCategoryRequirements(sourceCategoryRequirements);
+	}
+	
 	public SearchConfiguration(Builder builder) {
 		setProtocol(builder.protocol);
 		setHost(builder.host);
@@ -74,6 +93,7 @@ public SearchConfiguration(Builder builder) {
 		setMinimumMatch(builder.minimumMatch);
 		setLiveFeeds(builder.liveFeeds);
 		setMatchRequirements(builder.matchRequirements);
+		setSourceCategoryRequirements(builder.sourceCategoryRequirements);
 	}
 
 	/**
@@ -254,6 +274,29 @@ public void setMatchRequirements(Expression expression) {
 		this.matchRequirements = expression.toString();
 	}
 
+	/**
+	 * @param sourceCategoryRequirements a source category requirements criteria.
+	 * This criteria defines what source categories must be present in an
+	 * API response in order for it to be returned as a match.
+	 * For example: "email" or "email or phone", or 
+	 * "media & (personal_profiles | professional_and_business)".
+	 */
+	public void setSourceCategoryRequirements(String sourceCategoryRequirements) {
+		this.sourceCategoryRequirements = sourceCategoryRequirements;
+	}
+	
+	/**
+	 * @param expression an Expression that describes a source category requirements
+	 * This is a helper method that allows you to build and set a
+	 * source category requirement programmatically.
+	 * See the documentation for 
+	 * {@link com.pipl.api.search.SearchConfiguration.Expression}
+	 * for more details.
+	 */
+	public void setSourceCategoryRequirements(Expression expression) {
+		this.sourceCategoryRequirements = expression.toString();
+	}
+	
 	@Override
 	public String toString() {
 		StringBuilder sb = new StringBuilder();
@@ -277,6 +320,9 @@ public String toString() {
 		if (matchRequirements!=null) {
 			sb.append("&match_requirements=").append(matchRequirements);
 		}
+		if (sourceCategoryRequirements!=null) {
+			sb.append("&source_category_requirements=").append(sourceCategoryRequirements);
+		}
 		if (extraParams!=null) {
 			sb.append(extraParams);
 		}
@@ -294,6 +340,7 @@ public static class Builder {
 		private Float minimumMatch;
 		private Boolean liveFeeds;
 		private String matchRequirements;
+		private String sourceCategoryRequirements;
 
 		public Builder protocol(String protocol) {
 			this.protocol = protocol;
@@ -350,11 +397,22 @@ public Builder matchRequirements(Expression expression) {
 			return this;
 		}
 
+		public Builder sourceCategoryRequirements(String sourceCategoryRequirements) {
+			this.sourceCategoryRequirements = sourceCategoryRequirements;
+			return this;
+		}
+		
+		public Builder sourceCategoryRequirements(Expression expression) {
+			this.sourceCategoryRequirements = expression.toString();
+			return this;
+		}
+
 	}
 
 	/**
-	 * You can use the Expression interface and its implementation, 
-	 * AtomicExpression to programmatically create a matchRequirment
+	 * You can use the Expression interface and its implementations, 
+	 * AtomicExpression and AtomicSourceCategoryExpression to 
+	 * programmatically create a matchRequirment or a sourceCategoryRequirment
 	 * Simply start form AtomicExpressions, use the or/and methods on
 	 * them, and then use the resulting expressions to build even more
 	 * complex expressions.
@@ -388,6 +446,26 @@ public Expression and(Expression... expressions) {
 		public Expression or(Expression... expressions) {
 			return LogicalExpression.or(this, expressions);
 		}
+	}
+	
+	public static enum AtomicSourceCategoryExpression implements Expression {
+		PERSONAL_PROFILES, MEDIA, PROFESSIONAL_AND_BUSINESS, PUBLIC_RECORDS, PUBLICATIONS, SCHOOL_AND_CLASSMATES, EMAIL_ADDRESS, BACKGROUND_REPORTS, CONTACT_DETAILS, WEB_PAGES;
+
+		@Override
+		public Type type() {
+			return Type.ATOMIC;
+		}
+
+		@Override
+		public Expression and(Expression... expressions) {
+			return LogicalExpression.and(this, expressions);
+		}
+
+		@Override
+		public Expression or(Expression... expressions) {
+			return LogicalExpression.or(this, expressions);
+		}
+	}
 
 	private static class LogicalExpression implements Expression {
 		private Type type;
@@ -447,7 +525,6 @@ public static Expression or(Expression expression, Expression... expressions) {
 			}
 			return new LogicalExpression(Type.OR, sb.toString());
 		}
-	}
 	};
 
 }