authing_ruby 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6593330f870f1b2559fe53cbeb0ed09a06cff11a5c79ea728d328a57136f58
-  data.tar.gz: a037af3385879a07abb47ab49b23712944b0999ace92d9d291bc4a701d090eff
+  metadata.gz: b36719926968b5a3c6b66874c4f804b9c6b78d4f37cfb3ade0a2bee71de464a0
+  data.tar.gz: a177866df7eb186c9deae48b8f8cc5b868b6256f634ac8ad389b31dfae271056
 SHA512:
-  metadata.gz: fd1b2564b11854460730bafe77947659f0ef22b97ee5be871549882837eee2cea373f9fc7303843e044a22d37d93829a95c347c4a4e4216a484470337857dc51
-  data.tar.gz: cbb759903d06dbb5be96d472f32c713983efb56ad736460a4c880f898343fe99d4aaa63cbceefe073ef69cc2e7309c1c0667734f9af588cbcddf78cc295aa324
+  metadata.gz: 42a6dc27513b5573bd0ee10bd73fb0c16610977ade77243ee40839be412f23e6fa68df217a44a1f88f9bd169d601107ce9d03a55ca8dd6f83540902da70a3c31
+  data.tar.gz: 913bea2c6b8a7731ff001482481751c080c8500afcb40b693fc8fba2b095d42106461925a2144a620c4badba49ff2c2389d0d20e9ca9b88d6dfa2a03061caa27

data/lib/authing_ruby/GraphQLAPI.rb

@@ -1,10 +1,15 @@
-# 类似于 JS SDK 里 src/lib/graphqlapi.ts 的用途
-# 把一些 garpqhlClient.request 封装起来，里面包含了 const query = AccessTokenDocument;
+# 类似 JS SDK 里 src/lib/graphqlapi.ts 的用途，把请求进行封装
 
 # 使用示例
 # graphqlAPI = AuthingRuby::GraphQLAPI.new
 # graphqlAPI.getAccessToken(graphqlClient, variables)
 
+# 一共有三个参数
+# (garpqhlClient, tokenProvider = nil, variables = nil)
+  # garpqhlClient 是 lib/authing_ruby/common/GraphqlClient.rb
+  # tokenProvider 是 lib/authing_ruby/authentication/AuthenticationTokenProvider.rb
+  # variables 就是参数
+
 module AuthingRuby
   class GraphQLAPI
 
@@ -112,12 +117,18 @@ module AuthingRuby
       return _graphql_mutation_request("resetPassword", garpqhlClient, tokenProvider, variables)
     end
 
+    # 更新用户手机号码
+    def updatePhone(garpqhlClient, tokenProvider = nil, variables = nil)
+      return _graphql_mutation_request("updatePhone", garpqhlClient, tokenProvider, variables)
+    end
+
     def bindPhone(garpqhlClient, tokenProvider = nil, variables = nil)
       return _graphql_mutation_request("bindPhone", garpqhlClient, tokenProvider, variables)
     end
 
     # 太多同样写法的 method 了，稍微抽象一下
     # 这个负责发 mutation 的 request
+    # 第一个参数 gql_file_name 就是文件名
     def _graphql_mutation_request(gql_file_name, garpqhlClient, tokenProvider, variables)
       file = File.open("#{@folder_mutation}/#{gql_file_name}.gql");
       return _graphql_request(file, garpqhlClient, tokenProvider, variables)

data/lib/authing_ruby/authentication/AuthenticationClient.rb

@@ -692,6 +692,30 @@ module AuthingRuby
       end
     end
 
+    # 更新用户手机号
+    # 更新用户手机号。和修改邮箱一样，默认情况下，如果用户当前已经绑定了手机号，需要同时验证原有手机号（目前账号绑定的手机号）和当前邮箱（将要绑定的手机号）。
+    # 也就是说，用户 A 当前绑定的手机号为 15888888888，想修改为 15899999999，那么就需要同时验证这两个手机号。
+    # 开发者也可以选择不开启 “验证原有手机号“ ，可以在 Authing 控制台 的 设置目录下的安全信息模块进行关闭。
+    # 用户首次绑定手机号请使用 bindPhone 接口。
+    def updatePhone(phone, phoneCode, oldPhone, oldPhoneCode)
+      graphqlAPI = AuthingRuby::GraphQLAPI.new
+      variables = {
+        "phone": phone,
+        "phoneCode": phoneCode,
+      }
+      variables['oldPhone'] = oldPhone if oldPhone
+      variables['oldPhoneCode'] = oldPhoneCode if oldPhoneCode
+
+      hash = graphqlAPI.updatePhone(@graphqlClient, @tokenProvider, variables)
+      user = hash.dig("data", "updatePhone")
+      if user
+        setCurrentUser(user)
+        return user
+      else
+        return hash
+      end
+    end
+
     # 通过短信验证码重置密码
     def resetPasswordByPhoneCode(phone, code, newPassword)
       publicKey = @publicKeyManager.getPublicKey()

data/lib/authing_ruby/graphql/mutations/updatePhone.gql

@@ -0,0 +1,63 @@
+mutation updatePhone(
+  $phone: String!
+  $phoneCode: String!
+  $oldPhone: String
+  $oldPhoneCode: String
+) {
+  updatePhone(
+    phone: $phone
+    phoneCode: $phoneCode
+    oldPhone: $oldPhone
+    oldPhoneCode: $oldPhoneCode
+  ) {
+    id
+    arn
+    userPoolId
+    status
+    username
+    email
+    emailVerified
+    phone
+    phoneVerified
+    unionid
+    openid
+    nickname
+    registerSource
+    photo
+    password
+    oauth
+    token
+    tokenExpiredAt
+    loginsCount
+    lastLogin
+    lastIP
+    signedUp
+    blocked
+    isDeleted
+    device
+    browser
+    company
+    name
+    givenName
+    familyName
+    middleName
+    profile
+    preferredUsername
+    website
+    gender
+    birthdate
+    zoneinfo
+    locale
+    address
+    formatted
+    streetAddress
+    locality
+    region
+    postalCode
+    city
+    province
+    country
+    createdAt
+    updatedAt
+  }
+}

data/lib/authing_ruby/test/mini_test/TestAuthenticationClient.rb

@@ -209,10 +209,6 @@ class TestAuthenticationClient < Minitest::Test
     assert(result.dig('id') != nil, result)
   end
 
-  # 测试: 更新用户手机号
-  def test_updatePhone
-  end
-
   # 绑定邮箱
   def test_bindEmail
   end

data/lib/authing_ruby/test/mini_test/TestSMSandEmail.rb

@@ -12,7 +12,7 @@
 
 require "minitest/autorun"
 require "./lib/authing_ruby.rb"
-require "./lib/test/helper.rb"
+require "./lib/authing_ruby/test/helper.rb"
 require 'dotenv'
 Dotenv.load('.env.test') 
 
@@ -97,5 +97,48 @@ class TestSMSandEmail < Minitest::Test
     # 清理工作：测完了删除第一步注册的用户
     user_id = user['id']
     @managementClient.users.delete(user_id)
-  end 
-end
+  end
+
+  # 测试: 更新用户手机号
+  # ruby ./lib/authing_ruby/test/mini_test/TestSMSandEmail.rb -n test_updatePhone
+  # 文档: https://docs.authing.cn/v2/reference/sdk-for-node/authentication/AuthenticationClient.html#%E6%9B%B4%E6%96%B0%E7%94%A8%E6%88%B7%E6%89%8B%E6%9C%BA%E5%8F%B7
+  def test_updatePhone
+    # 前提条件：先确保有一个用户是自己的手机号，可以直接进 Authing 手工新建一个用户。新建时给设定手机号和密码，手机号可以随便填比如13511112222
+    # 填写对应手机号, 以及密码
+    phone = '13511112222'
+    password = '123456789'
+    # 登录
+    user = @authenticationClient.loginByPhonePassword(phone, password)
+    # 填写另一个要绑定的新手机号（可以填你自己的，这样才能收到短信）
+    phone = '13556136684'
+
+    # 发送验证码 (把下面发短信这一行先取消注释, 收到短信后再注释上)
+    # puts manual_send_SMS(phone); return;
+
+    # 填写收到的短信验证码
+    code = '4874'
+
+    # 默认情况下，如果用户当前已经绑定了手机号，需要同时验证原有手机号
+    # 开发者也可以选择不开启 “验证原有手机号“ ，可以在 Authing 控制台 的 设置目录下的安全信息模块进行关闭。
+    # 单个用户池 -> 设置 -> 安全信息 -> 用户池安全设置 -> 修改手机号时是否验证旧手机号 -> 点击开关,切换为关闭 -> 右上角"保存"
+    # 由于没有2个手机号，这里是关闭后再测试
+    oldPhone = nil
+    oldPhoneCode = nil
+
+    updatePhoneResult = @authenticationClient.updatePhone(phone, code, oldPhone, oldPhoneCode)
+    puts updatePhoneResult
+    assert(updatePhoneResult.dig('id') != nil)
+
+    # 错误:
+    # {:code=>2020, :message=>"尚未登录，无访问权限", :data=>nil}
+    # {:code=>500, :message=>"该手机号已被绑定", :data=>nil}
+    # {:code=>2230, :message=>"新手机号和旧手机号一样", :data=>nil}
+    # {:code=>500, :message=>"修改手机号必须验证原来的手机号。", :data=>nil}
+    # {:code=>500, :message=>"验证码已过期", :data=>nil}
+    # {:code=>500, :message=>"验证码不正确！", :data=>nil}
+
+    # 成功会返回 User
+    # {"id"=>"60b5b17a9cf59b23b2bcbccb", "arn"=>"arn:cn:authing:60800b8ee5b66b23128b4980:user:60b5b17a9cf59b23b2bcbccb", "userPoolId"=>"60800b8ee5b66b23128b4980", "status"=>"Activated", "username"=>"测试更新手机号", "email"=>nil, "emailVerified"=>false, "phone"=>"13556136684", "phoneVerified"=>true, "unionid"=>nil, "openid"=>nil, "nickname"=>nil, "registerSource"=>["import:manual"], "photo"=>"https://files.authing.co/authing-console/default-user-avatar.png", "password"=>"871fde109c2f0f463cc35e0c3e840932", "oauth"=>nil, "token"=>"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MGI1YjE3YTljZjU5YjIzYjJiY2JjY2IiLCJiaXJ0aGRhdGUiOm51bGwsImZhbWlseV9uYW1lIjpudWxsLCJnZW5kZXIiOiJVIiwiZ2l2ZW5fbmFtZSI6bnVsbCwibG9jYWxlIjpudWxsLCJtaWRkbGVfbmFtZSI6bnVsbCwibmFtZSI6bnVsbCwibmlja25hbWUiOm51bGwsInBpY3R1cmUiOiJodHRwczovL2ZpbGVzLmF1dGhpbmcuY28vYXV0aGluZy1jb25zb2xlL2RlZmF1bHQtdXNlci1hdmF0YXIucG5nIiwicHJlZmVycmVkX3VzZXJuYW1lIjpudWxsLCJwcm9maWxlIjpudWxsLCJ1cGRhdGVkX2F0IjoiMjAyMS0wNi0wMVQwNDoxNjo1MS41NDBaIiwid2Vic2l0ZSI6bnVsbCwiem9uZWluZm8iOm51bGwsImFkZHJlc3MiOnsiY291bnRyeSI6bnVsbCwicG9zdGFsX2NvZGUiOm51bGwsInJlZ2lvbiI6bnVsbCwiZm9ybWF0dGVkIjpudWxsfSwicGhvbmVfbnVtYmVyIjoiMTM1MTExMTIyMjIiLCJwaG9uZV9udW1iZXJfdmVyaWZpZWQiOmZhbHNlLCJlbWFpbCI6bnVsbCwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJleHRlcm5hbF9pZCI6bnVsbCwidW5pb25pZCI6bnVsbCwiZGF0YSI6eyJ0eXBlIjoidXNlciIsInVzZXJQb29sSWQiOiI2MDgwMGI4ZWU1YjY2YjIzMTI4YjQ5ODAiLCJhcHBJZCI6IjYwYjViMjFiZTMxMjkwNjI2ZmY2ZDgyZiIsImlkIjoiNjBiNWIxN2E5Y2Y1OWIyM2IyYmNiY2NiIiwidXNlcklkIjoiNjBiNWIxN2E5Y2Y1OWIyM2IyYmNiY2NiIiwiX2lkIjoiNjBiNWIxN2E5Y2Y1OWIyM2IyYmNiY2NiIiwicGhvbmUiOiIxMzUxMTExMjIyMiIsImVtYWlsIjpudWxsLCJ1c2VybmFtZSI6Iua1i-ivleabtOaWsOaJi-acuuWPtyIsInVuaW9uaWQiOm51bGwsIm9wZW5pZCI6bnVsbCwiY2xpZW50SWQiOiI2MDgwMGI4ZWU1YjY2YjIzMTI4YjQ5ODAifSwidXNlcnBvb2xfaWQiOiI2MDgwMGI4ZWU1YjY2YjIzMTI4YjQ5ODAiLCJhdWQiOiI2MGI1YjIxYmUzMTI5MDYyNmZmNmQ4MmYiLCJleHAiOjE2MjM3MzA2MzEsImlhdCI6MTYyMjUyMTAzMSwiaXNzIjoiaHR0cHM6Ly9tb3Jlbi5hdXRoaW5nLmNuL29pZGMifQ.VKSB6q-DBmtKLzOh_2qjBPQCSNZUAtrw_G2ZlNjOxbs", "tokenExpiredAt"=>"2021-06-15T04:17:11+00:00", "loginsCount"=>6, "lastLogin"=>"2021-06-01T04:17:11+00:00", "lastIP"=>nil, "signedUp"=>"2021-06-01T04:03:06+00:00", "blocked"=>false, "isDeleted"=>false, "device"=>nil, "browser"=>nil, "company"=>nil, "name"=>nil, "givenName"=>nil, "familyName"=>nil, "middleName"=>nil, "profile"=>nil, "preferredUsername"=>nil, "website"=>nil, "gender"=>"U", "birthdate"=>nil, "zoneinfo"=>nil, "locale"=>nil, "address"=>nil, "formatted"=>nil, "streetAddress"=>nil, "locality"=>nil, "region"=>nil, "postalCode"=>nil, "city"=>nil, "province"=>nil, "country"=>nil, "createdAt"=>"2021-06-01T04:03:06+00:00", "updatedAt"=>"2021-06-01T04:17:12+00:00"}
+  end
+
+end

data/lib/authing_ruby/version.rb

@@ -2,5 +2,5 @@
 # https://github.com/Authing/authing.js/blob/cf4757d09de3b44c3c3f4509ae8c8715c9f302a2/src/lib/version.ts
 
 module AuthingRuby
-  VERSION = "1.1.0".freeze
+  VERSION = "1.1.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authing_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - 郑诚(Zheng Cheng)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -189,6 +189,7 @@ files:
 - lib/authing_ruby/graphql/mutations/resetPassword.gql
 - lib/authing_ruby/graphql/mutations/sendEmail.gql
 - lib/authing_ruby/graphql/mutations/updatePassword.gql
+- lib/authing_ruby/graphql/mutations/updatePhone.gql
 - lib/authing_ruby/graphql/mutations/updateUser.gql
 - lib/authing_ruby/graphql/queries/accessToken.gql
 - lib/authing_ruby/graphql/queries/checkLoginStatus.gql