Default profile avatars (#579)

mozilla · Jan 24, 2019 · 1040b6f · 1040b6f
1 parent 07bb924
commit 1040b6f
Show file tree

Hide file tree

Showing 41 changed files with 1,916 additions and 220 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,16 @@
 
 - Autocomplete will no longer return an error when asked to match a unicode string. ([#298](https://github.com/mozilla/application-services/issues/298))
 
+## FxA
+
+### What's New
+
+- It is now possible to know whether a profile avatar has been set by the user. ([#579](https://github.com/mozilla/application-services/pull/579))
+
+### Breaking Changes
+
+- The `avatar` accessor from the `Profile` class in the Swift framework now returns an optional `Avatar` struct instead of a `String`. ([#579](https://github.com/mozilla/application-services/pull/579))
+
 # 0.14.0 (_2019-01-23_)
 
 [Full Changelog](https://github.com/mozilla/application-services/compare/v0.13.3...v0.14.0)

diff --git a/components/fxa-client/android/src/main/java/org/mozilla/fxaclient/internal/Profile.kt b/components/fxa-client/android/src/main/java/org/mozilla/fxaclient/internal/Profile.kt
@@ -14,20 +14,22 @@ class Profile internal constructor(raw: Raw) {
     val uid: String?
     val email: String?
     val avatar: String?
+    val avatarDefault: Boolean
     val displayName: String?
 
     internal class Raw(p: Pointer) : Structure(p) {
         @JvmField var uid: Pointer? = null
         @JvmField var email: Pointer? = null
         @JvmField var avatar: Pointer? = null
+        @JvmField var avatarDefault: Byte = 0
         @JvmField var displayName: Pointer? = null
 
         init {
             read()
         }
 
         override fun getFieldOrder(): List<String> {
-            return Arrays.asList("uid", "email", "avatar", "displayName")
+            return Arrays.asList("uid", "email", "avatar", "avatarDefault", "displayName")
         }
     }
 
@@ -36,6 +38,7 @@ class Profile internal constructor(raw: Raw) {
             this.uid = raw.uid?.getRustString()
             this.email = raw.email?.getRustString()
             this.avatar = raw.avatar?.getRustString()
+            this.avatarDefault = raw.avatarDefault == 1.toByte()
             this.displayName = raw.displayName?.getRustString()
         } finally {
             FxaClient.INSTANCE.fxa_profile_free(raw.pointer)

diff --git a/components/fxa-client/ios/FxAClient/FirefoxAccount.swift b/components/fxa-client/ios/FxAClient/FirefoxAccount.swift
@@ -287,6 +287,11 @@ open class AccessTokenInfo: RustStructPointer<AccessTokenInfoC> {
     }
 }
 
+public struct Avatar {
+    let url: String
+    let isDefault: Bool
+}
+
 open class Profile: RustStructPointer<ProfileC> {
     open var uid: String {
         get {
@@ -300,9 +305,12 @@ open class Profile: RustStructPointer<ProfileC> {
         }
     }
 
-    open var avatar: String {
+    open var avatar: Avatar? {
         get {
-            return String(cString: raw.pointee.avatar)
+            guard let pointer = raw.pointee.avatar else {
+                return nil
+            }
+            return Avatar(url: String(cString: pointer), isDefault: raw.pointee.avatar_default == 0x01)
         }
     }
 

diff --git a/components/fxa-client/ios/FxAClient/fxa.h b/components/fxa-client/ios/FxAClient/fxa.h
@@ -50,7 +50,8 @@ typedef struct SyncKeysC {
 typedef struct ProfileC {
     const char *const _Nonnull uid;
     const char *const _Nonnull email;
-    const char *const _Nonnull avatar;
+    const char *const _Nullable avatar;
+    const uint8_t avatar_default;
     const char *const _Nullable display_name;
 } ProfileC;
 

diff --git a/components/fxa-client/ios/docs/Classes.html b/components/fxa-client/ios/docs/Classes.html
@@ -14,7 +14,7 @@
     <a title="Classes  Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="index.html"> Docs</a> (31% documented)</p>
+        <p><a href="index.html"> Docs</a> (20% documented)</p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -39,6 +39,9 @@
               <li class="nav-group-task">
                 <a href="Classes/FxAConfig.html">FxAConfig</a>
               </li>
+              <li class="nav-group-task">
+                <a href="Classes/FxAConfig/Server.html">– Server</a>
+              </li>
               <li class="nav-group-task">
                 <a href="Classes/Profile.html">Profile</a>
               </li>
@@ -63,6 +66,14 @@
               </li>
             </ul>
           </li>
+          <li class="nav-group-name">
+            <a href="Structs.html">Structures</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a href="Structs.html#/s:9FxAClient6AvatarV">Avatar</a>
+              </li>
+            </ul>
+          </li>
         </ul>
       </nav>
       <article class="main-content">
@@ -96,7 +107,7 @@ <h1>Classes</h1>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">FxAConfig</span> <span class="p">:</span> <span class="kt">MovableRustOpaquePointer</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">FxAConfig</span></code></pre>
 
                         </div>
                       </div>
@@ -124,7 +135,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">FirefoxAccount</span> <span class="p">:</span> <span class="kt">RustOpaquePointer</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">FirefoxAccount</span> <span class="p">:</span> <span class="kt">RustHandle</span></code></pre>
 
                         </div>
                       </div>
@@ -220,8 +231,8 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-11-14)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+          <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2019-01-23)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>
     </div>

diff --git a/components/fxa-client/ios/docs/Classes/AccessTokenInfo.html b/components/fxa-client/ios/docs/Classes/AccessTokenInfo.html
@@ -14,7 +14,7 @@
     <a title="AccessTokenInfo Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html"> Docs</a> (31% documented)</p>
+        <p><a href="../index.html"> Docs</a> (20% documented)</p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -39,6 +39,9 @@
               <li class="nav-group-task">
                 <a href="../Classes/FxAConfig.html">FxAConfig</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Classes/FxAConfig/Server.html">– Server</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Classes/Profile.html">Profile</a>
               </li>
@@ -63,6 +66,14 @@
               </li>
             </ul>
           </li>
+          <li class="nav-group-name">
+            <a href="../Structs.html">Structures</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a href="../Structs.html#/s:9FxAClient6AvatarV">Avatar</a>
+              </li>
+            </ul>
+          </li>
         </ul>
       </nav>
       <article class="main-content">
@@ -194,8 +205,8 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-11-14)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+          <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2019-01-23)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>
     </div>

diff --git a/components/fxa-client/ios/docs/Classes/FirefoxAccount.html b/components/fxa-client/ios/docs/Classes/FirefoxAccount.html
@@ -14,7 +14,7 @@
     <a title="FirefoxAccount Class Reference"></a>
     <header>
       <div class="content-wrapper">
-        <p><a href="../index.html"> Docs</a> (31% documented)</p>
+        <p><a href="../index.html"> Docs</a> (20% documented)</p>
       </div>
     </header>
     <div class="content-wrapper">
@@ -39,6 +39,9 @@
               <li class="nav-group-task">
                 <a href="../Classes/FxAConfig.html">FxAConfig</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Classes/FxAConfig/Server.html">– Server</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Classes/Profile.html">Profile</a>
               </li>
@@ -63,6 +66,14 @@
               </li>
             </ul>
           </li>
+          <li class="nav-group-name">
+            <a href="../Structs.html">Structures</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a href="../Structs.html#/s:9FxAClient6AvatarV">Avatar</a>
+              </li>
+            </ul>
+          </li>
         </ul>
       </nav>
       <article class="main-content">
@@ -71,7 +82,7 @@
             <h1>FirefoxAccount</h1>
               <div class="declaration">
                 <div class="language">
-                  <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">FirefoxAccount</span> <span class="p">:</span> <span class="kt">RustOpaquePointer</span></code></pre>
+                  <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">FirefoxAccount</span> <span class="p">:</span> <span class="kt">RustHandle</span></code></pre>
 
                 </div>
               </div>
@@ -85,8 +96,8 @@ <h1>FirefoxAccount</h1>
                   <div>
                     <code>
                     <a name="/"></a>
-                    <a name="//apple_ref/swift/Method/from(config:clientId:redirectUri:webChannelResponse:)" class="dashAnchor"></a>
-                    <a class="token" href="#/">from(config:clientId:redirectUri:webChannelResponse:)</a>
+                    <a name="//apple_ref/swift/Method/from(config:webChannelResponse:)" class="dashAnchor"></a>
+                    <a class="token" href="#/">from(config:webChannelResponse:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -134,9 +145,9 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:9FxAClient14FirefoxAccountC6config8clientId11redirectUriAcA0A7AConfigC_S2StKcfc"></a>
-                    <a name="//apple_ref/swift/Method/init(config:clientId:redirectUri:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:9FxAClient14FirefoxAccountC6config8clientId11redirectUriAcA0A7AConfigC_S2StKcfc">init(config:clientId:redirectUri:)</a>
+                    <a name="/s:9FxAClient14FirefoxAccountC6configAcA0A7AConfigC_tKcfc"></a>
+                    <a name="//apple_ref/swift/Method/init(config:)" class="dashAnchor"></a>
+                    <a class="token" href="#/s:9FxAClient14FirefoxAccountC6configAcA0A7AConfigC_tKcfc">init(config:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -154,7 +165,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">config</span><span class="p">:</span> <span class="kt"><a href="../Classes/FxAConfig.html">FxAConfig</a></span><span class="p">,</span> <span class="nv">clientId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">redirectUri</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">throws</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">config</span><span class="p">:</span> <span class="kt"><a href="../Classes/FxAConfig.html">FxAConfig</a></span><span class="p">)</span> <span class="k">throws</span></code></pre>
 
                         </div>
                       </div>
@@ -320,6 +331,33 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:9FxAClient14FirefoxAccountC23getConnectionSuccessURL10Foundation0H0VyKF"></a>
+                    <a name="//apple_ref/swift/Method/getConnectionSuccessURL()" class="dashAnchor"></a>
+                    <a class="token" href="#/s:9FxAClient14FirefoxAccountC23getConnectionSuccessURL10Foundation0H0VyKF">getConnectionSuccessURL()</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Undocumented</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">getConnectionSuccessURL</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt">URL</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -439,8 +477,8 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-11-14)</p>
-          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
+          <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2019-01-23)</p>
+          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>
     </div>