api: Default transport and Json methods. Overloads of getDefault and fromStream on GoogleCredential using defaults.

https://codereview.appspot.com/79890047/

Author: anthmgoogle

google-api-client/pom.xml

@@ -64,12 +64,11 @@
     </dependency>
     <dependency>
       <groupId>com.google.http-client</groupId>
-      <artifactId>google-http-client-gson</artifactId>
-      <scope>test</scope>
+      <artifactId>google-http-client-jackson2</artifactId>
     </dependency>
     <dependency>
       <groupId>com.google.http-client</groupId>
-      <artifactId>google-http-client-jackson</artifactId>
+      <artifactId>google-http-client-gson</artifactId>
       <scope>test</scope>
     </dependency>
     <dependency>

google-api-client/src/main/java/com/google/api/client/googleapis/GoogleUtils.java

@@ -14,6 +14,11 @@
 
 package com.google.api.client.googleapis;
 
+import com.google.api.client.http.HttpTransport;
+import com.google.api.client.http.javanet.NetHttpTransport;
+import com.google.api.client.json.JsonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
+import com.google.api.client.util.Beta;
 import com.google.api.client.util.SecurityUtils;
 
 import java.io.IOException;
@@ -78,6 +83,38 @@ public static synchronized KeyStore getCertificateTrustStore()
     return certTrustStore;
   }
 
+  /**
+   * {@link Beta} <br/>
+   * Returns a cached default implementation of the JsonFactory interface.
+   */
+  @Beta
+  public static JsonFactory getDefaultJsonFactory() {
+    return JsonFactoryInstanceHolder.INSTANCE;
+  }
+
+  @Beta
+  private static class JsonFactoryInstanceHolder {
+    // The jackson2.JacksonFactory was introduced as a product dependency in 1.19 to enable
+    // other APIs to not require one of these for input. This was the most commonly used
+    // implementation in public samples. This is a compile-time dependency to help detect the
+    // dependency as early as possible.
+    static final JsonFactory INSTANCE = new JacksonFactory();
+  }
+
+  /**
+   * {@link Beta} <br/>
+   * Returns a cached default implementation of the HttpTransport interface.
+   */
+  @Beta
+  public static HttpTransport getDefaultTransport() {
+    return TransportInstanceHolder.INSTANCE;
+  }
+
+  @Beta
+  private static class TransportInstanceHolder {
+    static final HttpTransport INSTANCE = new NetHttpTransport();
+  }
+
   private GoogleUtils() {
   }
 }

google-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/GoogleCredential.java

@@ -21,6 +21,7 @@
 import com.google.api.client.auth.oauth2.DataStoreCredentialRefreshListener;
 import com.google.api.client.auth.oauth2.TokenRequest;
 import com.google.api.client.auth.oauth2.TokenResponse;
+import com.google.api.client.googleapis.GoogleUtils;
 import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets.Details;
 import com.google.api.client.http.GenericUrl;
 import com.google.api.client.http.HttpExecuteInterceptor;
@@ -173,6 +174,23 @@ public class GoogleCredential extends Credential {
   private static DefaultCredentialProvider defaultCredentialProvider =
       new DefaultCredentialProvider();
 
+  /**
+   * {@link Beta} <br/>
+   * Returns a default credential for the application.
+   *
+   * <p>Returns the built-in service account's credential for the application if running on
+   * Google App Engine or Google Compute Engine, or returns the credential pointed to by the
+   * environment variable GOOGLE_CREDENTIALS_DEFAULT.
+   * </p>
+   *
+   * @return the credential instance.
+   * @throws IOException if the credential cannot be created in the current environment.
+   */
+  @Beta
+  public static GoogleCredential getDefault() throws IOException {
+    return getDefault(GoogleUtils.getDefaultTransport(), GoogleUtils.getDefaultJsonFactory());
+  }
+
   /**
    * {@link Beta} <br/>
    * Returns a default credential for the application.
@@ -195,6 +213,22 @@ public static GoogleCredential getDefault(HttpTransport transport, JsonFactory j
     return defaultCredentialProvider.getDefaultCredential(transport, jsonFactory);
   }
 
+  /**
+   * {@link Beta} <br/>
+   * Return a credential defined by a Json file.
+   *
+   * @param credentialStream the stream with the credential definition.
+   * @return the credential defined by the credentialStream.
+   * @throws IOException if the credential cannot be created from the stream.
+   */
+  @Beta
+  public static GoogleCredential fromStream(InputStream credentialStream) throws IOException {
+     return fromStream(
+        credentialStream,
+        GoogleUtils.getDefaultTransport(),
+        GoogleUtils.getDefaultJsonFactory());
+  }
+
   /**
    * {@link Beta} <br/>
    * Return a credential defined by a Json file.

google-api-client/src/test/java/com/google/api/client/googleapis/GoogleUtilsTest.java

@@ -14,10 +14,19 @@
 
 package com.google.api.client.googleapis;
 
+import com.google.api.client.http.HttpTransport;
+import com.google.api.client.http.javanet.NetHttpTransport;
+import com.google.api.client.json.JsonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
+
 import junit.framework.TestCase;
 
+import java.io.IOException;
+import java.net.URLDecoder;
 import java.security.KeyStore;
 import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Tests {@link GoogleUtils}.
@@ -37,4 +46,36 @@ public void testGetCertificateTrustStore() throws Exception {
     // has been added or removed
     assertEquals(70, trustStore.size());
   }
+
+  public void testGetDefaultJsonFactory() {
+    JsonFactory jsonFactory = GoogleUtils.getDefaultJsonFactory();
+    assertNotNull(jsonFactory);
+    assertTrue(jsonFactory instanceof JacksonFactory);
+    JsonFactory secondCall = GoogleUtils.getDefaultJsonFactory();
+    assertSame(jsonFactory, secondCall);
+  }
+
+  public void testGetDefaultTransport() {
+    HttpTransport transport = GoogleUtils.getDefaultTransport();
+    assertNotNull(transport);
+    assertTrue(transport instanceof NetHttpTransport);
+    HttpTransport secondCall = GoogleUtils.getDefaultTransport();
+    assertSame(transport, secondCall);
+  }
+
+  public static Map<String, String> parseQuery(String query) throws IOException {
+    Map<String, String> map = new HashMap<String, String>();
+    String[] entries = query.split("&");
+    for (String entry : entries) {
+      String[] sides = entry.split("=");
+      if (sides.length != 2) {
+        throw new IOException("Invalid Query String");
+      }
+      String key = URLDecoder.decode(sides[0], "UTF-8");
+      String value = URLDecoder.decode(sides[1], "UTF-8");
+      map.put(key, value);
+    }
+    return map;
+  }
+
 }

google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/DefaultCredentialProviderTest.java

@@ -21,7 +21,7 @@
 import com.google.api.client.http.LowLevelHttpResponse;
 import com.google.api.client.json.GenericJson;
 import com.google.api.client.json.JsonFactory;
-import com.google.api.client.json.jackson.JacksonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
 import com.google.api.client.testing.http.MockHttpTransport;
 import com.google.api.client.testing.http.MockLowLevelHttpRequest;
 import com.google.api.client.util.Joiner;

google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/GoogleAuthorizationCodeFlowTest.java

@@ -14,7 +14,7 @@
 
 package com.google.api.client.googleapis.auth.oauth2;
 
-import com.google.api.client.json.jackson.JacksonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
 import com.google.api.client.testing.http.MockHttpTransport;
 import com.google.common.collect.ImmutableList;
 

google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/GoogleAuthorizationCodeTokenRequestTest.java

@@ -15,7 +15,7 @@
 package com.google.api.client.googleapis.auth.oauth2;
 
 import com.google.api.client.auth.oauth2.ClientParametersAuthentication;
-import com.google.api.client.json.jackson.JacksonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
 import com.google.api.client.testing.http.MockHttpTransport;
 
 import junit.framework.TestCase;

google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/GoogleCredentialTest.java

@@ -17,7 +17,7 @@
 import com.google.api.client.http.HttpTransport;
 import com.google.api.client.json.GenericJson;
 import com.google.api.client.json.JsonFactory;
-import com.google.api.client.json.jackson.JacksonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
 import com.google.api.client.testing.http.MockHttpTransport;
 import com.google.api.client.testing.util.SecurityTestUtils;
 import com.google.api.client.util.Joiner;

google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/GoogleIdTokenVerifierTest.java

@@ -16,7 +16,7 @@
 
 import com.google.api.client.auth.openidconnect.IdTokenVerifier;
 import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload;
-import com.google.api.client.json.jackson.JacksonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
 import com.google.api.client.json.webtoken.JsonWebSignature.Header;
 import com.google.api.client.testing.http.FixedClock;
 import com.google.api.client.util.Clock;

google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/GooglePublicKeysManagerTest.java

@@ -20,7 +20,7 @@
 import com.google.api.client.http.LowLevelHttpResponse;
 import com.google.api.client.json.Json;
 import com.google.api.client.json.JsonFactory;
-import com.google.api.client.json.jackson.JacksonFactory;
+import com.google.api.client.json.jackson2.JacksonFactory;
 import com.google.api.client.testing.http.FixedClock;
 import com.google.api.client.testing.http.MockHttpTransport;
 import com.google.api.client.testing.http.MockLowLevelHttpRequest;