Merge pull request #488 from weakish/release-280

docs: 2.8.0

Author: weakish

changelog

@@ -1,3 +1,8 @@
+## [2.8.0] - 2020-07-15
+### Added
+- `request_change_phone_number` and `change_phone_number` to verify mobile number *before* updating it.
+- `request_sms_code` now accepts phone number in E.164 format.
+
 ## [2.7.1] - 2020-06-18
 ### Fixed
 - LeanEngineError now encodes valid HTTP status code.

docs/_modules/leancloud/cloud.html

@@ -248,7 +248,9 @@ <h1>leancloud.cloud 源代码</h1><div class="highlight"><pre>
         <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;phone_number must be a string&quot;</span><span class="p">)</span>
 
     <span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
-        <span class="s2">&quot;mobilePhoneNumber&quot;</span><span class="p">:</span> <span class="n">idd</span> <span class="o">+</span> <span class="n">phone_number</span><span class="p">,</span>
+        <span class="s2">&quot;mobilePhoneNumber&quot;</span><span class="p">:</span> <span class="n">phone_number</span>
+        <span class="k">if</span> <span class="n">phone_number</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;+&quot;</span><span class="p">)</span>
+        <span class="k">else</span> <span class="n">idd</span> <span class="o">+</span> <span class="n">phone_number</span><span class="p">,</span>
         <span class="s2">&quot;smsType&quot;</span><span class="p">:</span> <span class="n">sms_type</span><span class="p">,</span>
     <span class="p">}</span>
 

docs/_modules/leancloud/user.html

@@ -487,6 +487,25 @@ <h1>leancloud.user 源代码</h1><div class="highlight"><pre>
         <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;password&quot;</span><span class="p">:</span> <span class="n">new_password</span><span class="p">}</span>
         <span class="n">client</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="s2">&quot;/resetPasswordBySmsCode/&quot;</span> <span class="o">+</span> <span class="n">sms_code</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span></div>
 
+    <span class="c1"># This should be an instance method.</span>
+    <span class="c1"># However, to be consistent with other similar methods (`request_password_reset_by_sms_code`),</span>
+    <span class="c1"># it is implemented as a class method.</span>
+<div class="viewcode-block" id="User.request_change_phone_number"><a class="viewcode-back" href="../../index.html#leancloud.User.request_change_phone_number">[文档]</a>    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">request_change_phone_number</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">phone_number</span><span class="p">,</span> <span class="n">ttl</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">validate_token</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+        <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;mobilePhoneNumber&quot;</span><span class="p">:</span> <span class="n">phone_number</span><span class="p">}</span>
+        <span class="k">if</span> <span class="n">ttl</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="n">params</span><span class="p">[</span><span class="s2">&quot;ttl&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ttl</span>
+        <span class="k">if</span> <span class="n">validate_token</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="n">params</span><span class="p">[</span><span class="s2">&quot;validate_token&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">validate_token</span>
+        <span class="n">client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">&quot;/requestChangePhoneNumber&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span></div>
+
+    <span class="c1"># This should be an instance method and update the local date,</span>
+    <span class="c1"># but it is implemented as a class method for the same reason as above.</span>
+<div class="viewcode-block" id="User.change_phone_number"><a class="viewcode-back" href="../../index.html#leancloud.User.change_phone_number">[文档]</a>    <span class="nd">@classmethod</span>
+    <span class="k">def</span> <span class="nf">change_phone_number</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">sms_code</span><span class="p">,</span> <span class="n">phone_number</span><span class="p">):</span>
+        <span class="n">params</span> <span class="o">=</span> <span class="p">{</span><span class="s2">&quot;mobilePhoneNumber&quot;</span><span class="p">:</span> <span class="n">phone_number</span><span class="p">,</span> <span class="s2">&quot;code&quot;</span><span class="p">:</span> <span class="n">sms_code</span><span class="p">}</span>
+        <span class="n">client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">&quot;/changePhoneNumber&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">)</span></div>
+
 <div class="viewcode-block" id="User.verify_mobile_phone_number"><a class="viewcode-back" href="../../index.html#leancloud.User.verify_mobile_phone_number">[文档]</a>    <span class="nd">@classmethod</span>
     <span class="k">def</span> <span class="nf">verify_mobile_phone_number</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">sms_code</span><span class="p">):</span>
         <span class="n">client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s2">&quot;/verfyMobilePhone/&quot;</span> <span class="o">+</span> <span class="n">sms_code</span><span class="p">,</span> <span class="p">{})</span></div>

docs/genindex.html

@@ -268,6 +268,8 @@ <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#leancloud.cloud.Captcha">Captcha (leancloud.cloud 中的类)</a>
+</li>
+      <li><a href="index.html#leancloud.User.change_phone_number">change_phone_number() (leancloud.User 类方法)</a>
 </li>
       <li><a href="index.html#leancloud.Object.clear">clear() (leancloud.Object 方法)</a>
 
@@ -764,6 +766,8 @@ <h2 id="R">R</h2>
 </li>
       </ul></li>
       <li><a href="index.html#leancloud.cloud.request_captcha">request_captcha() (在 leancloud.cloud 模块中)</a>
+</li>
+      <li><a href="index.html#leancloud.User.request_change_phone_number">request_change_phone_number() (leancloud.User 类方法)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>

docs/index.html

@@ -683,6 +683,11 @@ <h3>User<a class="headerlink" href="#user" title="永久链接至标题">¶</a><
 <code class="sig-name descname">bit_xor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">attr</span></em>, <em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#leancloud.User.bit_xor" title="永久链接至目标">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py method">
+<dt id="leancloud.User.change_phone_number">
+<em class="property">classmethod </em><code class="sig-name descname">change_phone_number</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sms_code</span></em>, <em class="sig-param"><span class="n">phone_number</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/leancloud/user.html#User.change_phone_number"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#leancloud.User.change_phone_number" title="永久链接至目标">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt id="leancloud.User.clear">
 <code class="sig-name descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#leancloud.User.clear" title="永久链接至目标">¶</a></dt>
@@ -1038,6 +1043,11 @@ <h3>User<a class="headerlink" href="#user" title="永久链接至标题">¶</a><
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt id="leancloud.User.request_change_phone_number">
+<em class="property">classmethod </em><code class="sig-name descname">request_change_phone_number</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">phone_number</span></em>, <em class="sig-param"><span class="n">ttl</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">validate_token</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/leancloud/user.html#User.request_change_phone_number"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#leancloud.User.request_change_phone_number" title="永久链接至目标">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt id="leancloud.User.request_email_verify">
 <em class="property">classmethod </em><code class="sig-name descname">request_email_verify</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">email</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/leancloud/user.html#User.request_email_verify"><span class="viewcode-link">[源代码]</span></a><a class="headerlink" href="#leancloud.User.request_email_verify" title="永久链接至目标">¶</a></dt>