Fix for AuthSub encoding/decoding.

Analytics API updates

Author: [email protected]

RELEASE_NOTES.txt

@@ -1,4 +1,9 @@
 Google Data API - Release Notes
+Notes for v1.41.5
+-----------------
+o Update Analytics API
+o Fix AuthSub encoding/decoding issue.
+
 Notes for v1.41.4
 -----------------
 o Updates Apps For Your Domain API

java/sample/authsub/dist/authsub_sample.war

@@ -24,6 +24,7 @@
 import com.google.gdata.data.analytics.CombinationFeed;
 import com.google.gdata.data.analytics.DataFeed;
 import com.google.gdata.data.analytics.ExperimentFeed;
+import com.google.gdata.data.analytics.ManagementFeed;
 import com.google.gdata.data.analytics.SectionFeed;
 import com.google.gdata.data.analytics.VariationFeed;
 import com.google.gdata.util.Version;
@@ -68,8 +69,8 @@ public static final class Versions {
     public static final Version V2_1 = new Version(AnalyticsService.class,
         "2.1", Service.Versions.V2_1);
 
-    /** Version {@code 2.2}.  This version adds generalized account feeds, and
-     * is based on GData version 2.1. */
+    /** Version {@code 2.2}.  This version adds Management API feeds, and is
+     * based on GData version 2.1. */
     public static final Version V2_2 = new Version(AnalyticsService.class,
         "2.2", Service.Versions.V2_1);
 
@@ -80,7 +81,7 @@ private Versions() {}
    * Default GData version used by the Google Analytics Data Export API.
    */
   public static final Version DEFAULT_VERSION =
-      Service.initServiceVersion(AnalyticsService.class, Versions.V2_1);
+      Service.initServiceVersion(AnalyticsService.class, Versions.V2_2);
 
   /**
    * Constructs an instance connecting to the Google Analytics Data Export API
@@ -160,6 +161,7 @@ private void declareExtensions() {
     new CombinationFeed().declareExtensions(extProfile);
     new DataFeed().declareExtensions(extProfile);
     new ExperimentFeed().declareExtensions(extProfile);
+    new ManagementFeed().declareExtensions(extProfile);
     new SectionFeed().declareExtensions(extProfile);
     new VariationFeed().declareExtensions(extProfile);
   }

java/src/com/google/gdata/client/analytics/AnalyticsService.java

@@ -26,8 +26,10 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStreamReader;
+import java.io.UnsupportedEncodingException;
 import java.net.HttpURLConnection;
 import java.net.URL;
+import java.net.URLDecoder;
 import java.security.GeneralSecurityException;
 import java.security.KeyStore;
 import java.security.PrivateKey;
@@ -207,19 +209,30 @@ public static String getTokenFromReply(URL url) {
   /**
    * Parses and returns the AuthSub token returned by Google on a successful
    * AuthSub login request.  The token will be appended as a query parameter
-   * to the next URL specified while making the AuthSub request.
+   * to the "next" URL specified while making the AuthSub request.
    *
    * @param queryString the query portion of the redirected-to URL containing
-   *                    the token
-   * @return the AuthSub token returned by Google
+   *                    the token (as the server received it; i.e. what
+   *                    {@code httpServletRequest.getQueryString()} returns)
+   * @return the AuthSub token returned by Google; {@code null} if there is no
+   *         token present in {@code queryString}. The token text will have
+   *         been run through {@link URLDecoder} already, and will not need any
+   *         additional decoding before use; however, the token string will
+   *         not contain percent ({@code %}) characters and therefore
+   *         additional url-decoding will do no harm.
    */
   public static String getTokenFromReply(String queryString) {
 
     // Parse the query parameters
     Map<String, String> params =
       StringUtil.string2Map(queryString, "&", "=", true /*stripEntry*/);
     params = StringUtil.lowercaseKeys(params);
-    return params.get("token");
+    String encoded = params.get("token");
+    try {
+      return encoded == null ? null : URLDecoder.decode(encoded, "UTF-8");
+    } catch (UnsupportedEncodingException e) {
+      throw new RuntimeException(e); // Can't happen - UTF-8 in all jvms
+    }
   }
 
 

java/src/com/google/gdata/client/http/AuthSubUtil.java

@@ -546,19 +546,23 @@ public void execute() throws IOException, ServiceException {
    */
   protected void checkResponse() throws IOException, ServiceException {
 
-    if (httpConn.getResponseCode() >= 300) {
-      handleErrorResponse();
-    } else if (isOAuthProxyErrorResponse()) {
+    if (isOAuthProxyErrorResponse()) {
       handleOAuthProxyErrorResponse();
+    } else if (httpConn.getResponseCode() >= 300) {
+      handleErrorResponse();
     }
   }
 
   /** Whether or not the http response comes from the OAuth Proxy. */
-  private boolean isOAuthProxyErrorResponse() {
+  private boolean isOAuthProxyErrorResponse() throws IOException {
     Set<String> headers = httpConn.getHeaderFields().keySet();
-    return headers.contains(OAuthProxyProtocol.Header.X_OAUTH_APPROVAL_URL)
-        || headers.contains(OAuthProxyProtocol.Header.X_OAUTH_ERROR)
-        || headers.contains(OAuthProxyProtocol.Header.X_OAUTH_ERROR_TEXT);
+    boolean isOAuthRedirectToApproval =
+        headers.contains(OAuthProxyProtocol.Header.X_OAUTH_APPROVAL_URL);
+    boolean isOtherOAuthError =
+        httpConn.getResponseCode() == HttpURLConnection.HTTP_OK
+        && (headers.contains(OAuthProxyProtocol.Header.X_OAUTH_ERROR)
+        || headers.contains(OAuthProxyProtocol.Header.X_OAUTH_ERROR_TEXT));
+    return isOAuthRedirectToApproval || isOtherOAuthError;
   }
 
   /**

java/src/com/google/gdata/client/http/HttpGDataRequest.java

@@ -57,6 +57,8 @@ public void declareExtensions(ExtensionProfile extProfile) {
     extProfile.declare(AccountEntry.class, Goal.getDefaultDescription(false,
         true));
     new Goal().declareExtensions(extProfile);
+    extProfile.declare(AccountEntry.class,
+        AnalyticsLink.getDefaultDescription(false, true));
     extProfile.declare(AccountEntry.class, Property.getDefaultDescription(false,
         true));
     extProfile.declare(AccountEntry.class, TableId.getDefaultDescription(true,
@@ -209,5 +211,4 @@ public String getProperty(String name) {
     }
     return null;
   }
-
 }

java/src/com/google/gdata/data/analytics/AccountEntry.java

@@ -0,0 +1,198 @@
+/* Copyright (c) 2008 Google Inc.
+ *
+ * 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.
+ */
+
+
+package com.google.gdata.data.analytics;
+
+import com.google.gdata.data.AttributeGenerator;
+import com.google.gdata.data.AttributeHelper;
+import com.google.gdata.data.ExtensionDescription;
+import com.google.gdata.data.ExtensionProfile;
+import com.google.gdata.data.Link;
+import com.google.gdata.util.Namespaces;
+import com.google.gdata.util.ParseException;
+import com.google.gdata.util.XmlParser.ElementHandler;
+
+import org.xml.sax.Attributes;
+
+/**
+ * Extends the base Link class with Analytics extensions.
+ *
+ * 
+ */
+@ExtensionDescription.Default(
+    nsAlias = "atom",
+    nsUri = Namespaces.atom,
+    localName = AnalyticsLink.XML_NAME)
+public class AnalyticsLink extends Link {
+
+  /** XML element name */
+  static final String XML_NAME = "link";
+
+  /** XML "gd:targetKind" attribute name */
+  private static final String TARGETKIND = "gd:targetKind";
+
+  /** Kind of feed/entry the href is pointing to */
+  private String targetKind = null;
+
+  /** Link relation type. */
+  public static final class Rel {
+
+    /** Represents a link to a CHILD feed. */
+    public static final String CHILD = AnalyticsNamespace.GA_PREFIX + "child";
+
+    /** Represents a link to a PARENT entry. */
+    public static final String PARENT = AnalyticsNamespace.GA_PREFIX + "parent";
+
+  }
+
+  /**
+   * Default mutable constructor.
+   */
+  public AnalyticsLink() {
+    super();
+  }
+
+  /**
+   * Immutable constructor.
+   *
+   * @param targetKind kind of feed/entry the href is pointing to.
+   */
+  public AnalyticsLink(String targetKind) {
+    super();
+    setTargetKind(targetKind);
+    setImmutable(true);
+  }
+
+  /**
+   * Returns the kind of feed/entry the href is pointing to.
+   *
+   * @return kind of feed/entry the href is pointing to
+   */
+  public String getTargetKind() {
+    return targetKind;
+  }
+
+  /**
+   * Sets the kind of feed/entry the href is pointing to.
+   *
+   * @param targetKind kind of feed/entry the href is pointing to or
+   *     <code>null</code> to reset
+   */
+  public void setTargetKind(String targetKind) {
+    throwExceptionIfImmutable();
+    this.targetKind = targetKind;
+  }
+
+  /**
+   * Returns whether it has the kind of feed/entry the href is pointing to.
+   *
+   * @return whether it has the kind of feed/entry the href is pointing to
+   */
+  public boolean hasTargetKind() {
+    return getTargetKind() != null;
+  }
+
+  @Override
+  protected void validate() {
+  }
+
+  /**
+   * Returns the extension description, specifying whether it is required, and
+   * whether it is repeatable.
+   *
+   * @param required   whether it is required
+   * @param repeatable whether it is repeatable
+   * @return extension description
+   */
+  public static ExtensionDescription getDefaultDescription(boolean required,
+      boolean repeatable) {
+    ExtensionDescription desc =
+        ExtensionDescription.getDefaultDescription(AnalyticsLink.class);
+    desc.setRequired(required);
+    desc.setRepeatable(repeatable);
+    return desc;
+  }
+
+  @Override
+  protected void putAttributes(AttributeGenerator generator) {
+    generator.put(TARGETKIND, targetKind);
+  }
+
+  @Override
+  protected void consumeAttributes(AttributeHelper helper) throws ParseException
+      {
+    targetKind = helper.consume("targetKind", false);
+  }
+
+  @Override
+  public boolean equals(Object obj) {
+    if (this == obj) {
+      return true;
+    }
+    if (!sameClassAs(obj)) {
+      return false;
+    }
+    AnalyticsLink other = (AnalyticsLink) obj;
+    return eq(targetKind, other.targetKind);
+  }
+
+  @Override
+  public int hashCode() {
+    int result = getClass().hashCode();
+    if (targetKind != null) {
+      result = 37 * result + targetKind.hashCode();
+    }
+    return result;
+  }
+
+  @Override
+  public String toString() {
+    return "{AnalyticsLink targetKind=" + targetKind + " " + super.toString() +
+        "}";
+  }
+
+
+  @Override
+  public ElementHandler getHandler(ExtensionProfile p, String namespace,
+      String localName,
+      Attributes attrs) {
+    return new AnalyticsLinkHandler(p);
+  }
+
+  /**
+   * An XML Parser for 'atom:link' extension for Google Analytics.
+   */
+  class AnalyticsLinkHandler extends AtomHandler {
+
+    public AnalyticsLinkHandler(ExtensionProfile extProfile) {
+      super(extProfile, AnalyticsLink.class);
+    }
+
+    /**
+     * Adds parsing for 'gd:targetKind' attribute.
+     */
+    @Override
+    public void processAttribute(String namespace, String localName,
+        String value)
+        throws ParseException {
+      super.processAttribute(namespace, localName, value);
+
+      if (namespace.equals(Namespaces.g) && localName.equals("targetKind")) {
+        targetKind = value;
+      }
+    }
+  }
+}

java/src/com/google/gdata/data/analytics/AnalyticsLink.java

@@ -54,6 +54,8 @@ public void declareExtensions(ExtensionProfile extProfile) {
     super.declareExtensions(extProfile);
     extProfile.declare(DataEntry.class, Dimension.getDefaultDescription(false,
         true));
+    extProfile.declare(DataEntry.class,
+        AnalyticsLink.getDefaultDescription(false, true));
     extProfile.declare(DataEntry.class, Metric.getDefaultDescription(false,
         true));
   }