authing_ruby 1.0.7 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aea089117c37cb1ba0f187b8ed1b26d3971af87adb438275c8ed5cf8ca74785
-  data.tar.gz: 27dcf489dd3465c984898573ad885d778db8e32fd915b7538418e825f012888e
+  metadata.gz: 4203f8f2932fcacc6405c533a530d779fef455827507dbb35292813d4c916244
+  data.tar.gz: d62015f96cd7b5ffb283dcc69db496954632f3468894fd2ddf189a3f71dc8ba3
 SHA512:
-  metadata.gz: e50c2815f4009a9f0bbff3e8b22c02ee9b4ade53cf927c34daab002ac4c456383165dd7ffa248004246c0cf24e953aa40e2d46d0de7c3747f6934eebe416ea7f
-  data.tar.gz: e2ce98c1d7d1af2d9a60df129bfa11b6c323f412a91e6143878c13c4a0b36b3d4b59fa090f309acb12963a572c797d3f687f83f3145b21b9a104739e6171b86f
+  metadata.gz: a31bd62c0ddcf683dfb87427e241f24ccf32582d8848cc14764c2b0f496e6f10d49aa691cfb09a820fbfffcddb54ca67f0a82a307e125dcf4fa5dcc8bfe5e4e7
+  data.tar.gz: 24a19d114a8a24a4438e32c9d3b4c1209e1f75c7ec81efb068ce0fe4da0417bfd6279a65150f48f0c66f89f292aab6c3f21afee38dac754b8fe3840aeb54f5e8

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

@@ -68,11 +68,10 @@ module AuthingRuby
         }
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.registerByEmail(@graphqlClient, variables)
-      json = JSON.parse(res)
-      user = json.dig('data', 'registerByEmail')
+      hash = graphqlAPI.registerByEmail(@graphqlClient, variables)
+      user = hash.dig('data', 'registerByEmail')
       return user if user
-      return json
+      return hash
     end
 
     # 使用用户名注册
@@ -96,11 +95,10 @@ module AuthingRuby
         }
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.registerByUsername(@graphqlClient, variables)
-      json = JSON.parse(res)
-      user = json.dig('data', 'registerByUsername')
+      hash = graphqlAPI.registerByUsername(@graphqlClient, variables)
+      user = hash.dig('data', 'registerByUsername')
       return user if user
-      return json
+      return hash
     end
 
     # 发送短信验证码
@@ -138,11 +136,10 @@ module AuthingRuby
         }
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.registerByPhoneCode(@graphqlClient, variables)
-      json = JSON.parse(res)
-      user = json.dig('data', 'registerByPhoneCode')
+      hash = graphqlAPI.registerByPhoneCode(@graphqlClient, variables)
+      user = hash.dig('data', 'registerByPhoneCode')
       return user if user
-      return json
+      return hash
     end
 
     # 使用邮箱登录
@@ -163,14 +160,13 @@ module AuthingRuby
         }
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.loginByEmail(@graphqlClient, variables)
-      json = JSON.parse(res)
-      user = json.dig('data', 'loginByEmail')
+      hash = graphqlAPI.loginByEmail(@graphqlClient, variables)
+      user = hash.dig('data', 'loginByEmail')
       if user
         setCurrentUser(user);
         return user 
       end
-      return json
+      return hash
     end
 
     # 使用用户名登录
@@ -191,14 +187,13 @@ module AuthingRuby
         }
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.loginByUsername(@graphqlClient, variables)
-      json = JSON.parse(res)
-      user = json.dig('data', 'loginByUsername')
+      hash = graphqlAPI.loginByUsername(@graphqlClient, variables)
+      user = hash.dig('data', 'loginByUsername')
       if user
         setCurrentUser(user);
         return user 
       end
-      return json
+      return hash
     end
 
     # 使用手机号验证码登录
@@ -215,14 +210,13 @@ module AuthingRuby
         }
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.loginByPhoneCode(@graphqlClient, variables)
-      json = JSON.parse(res)
-      user = json.dig('data', 'loginByPhoneCode')
+      hash = graphqlAPI.loginByPhoneCode(@graphqlClient, variables)
+      user = hash.dig('data', 'loginByPhoneCode')
       if user
         setCurrentUser(user);
         return user 
       end
-      return json
+      return hash
     end
 
     # 使用手机号密码登录
@@ -242,17 +236,13 @@ module AuthingRuby
         }
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.loginByPhonePassword(@graphqlClient, variables)
-      json = JSON.parse(res)
-      user = json.dig('data', 'loginByPhonePassword')
+      hash = graphqlAPI.loginByPhonePassword(@graphqlClient, variables)
+      user = hash.dig('data', 'loginByPhonePassword')
       if user
         setCurrentUser(user);
         return user 
       end
-      return json
-    end
-
-    def checkLoginStatus
+      return hash
     end
 
     # 发送邮件
@@ -265,11 +255,10 @@ module AuthingRuby
         "scene": scene,
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.sendEmail(@graphqlClient, variables)
-      json = JSON.parse(res)
-      data = json.dig('data')
+      hash = graphqlAPI.sendEmail(@graphqlClient, variables)
+      data = hash.dig('data')
       return data if data
-      return json
+      return hash
       # {"sendEmail":{"message":"","code":200}}
     end
 
@@ -277,14 +266,13 @@ module AuthingRuby
     # 返回：用户信息
     def getCurrentUser()
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.getCurrentUser(@graphqlClient, @tokenProvider, {})
-      json = JSON.parse(res)
-      user = json.dig("data", "user")
+      hash = graphqlAPI.getCurrentUser(@graphqlClient, @tokenProvider, {})
+      user = hash.dig("data", "user")
       if user
         setCurrentUser(user)
         return user
       else
-        return json
+        return hash
       end
     end
 
@@ -609,9 +597,8 @@ module AuthingRuby
         "id": userId,
         "input": updates
       }
-      res = graphqlAPI.updateUser(@graphqlClient, @tokenProvider, variables)
-      json = JSON.parse(res)
-      updated_user = json.dig('data', 'updateUser')
+      hash = graphqlAPI.updateUser(@graphqlClient, @tokenProvider, variables)
+      updated_user = hash.dig('data', 'updateUser')
       if updated_user
         # 如果更新成功，返回更新后的用户
         setCurrentUser(updated_user)
@@ -619,7 +606,7 @@ module AuthingRuby
       else
         # 如果更新失败，返回原结果
         # {"errors"=>[{"message"=>{"code"=>2020, "message"=>"尚未登录，无访问权限"}, "locations"=>[{"line"=>2, "column"=>3}], "path"=>["updateUser"], "extensions"=>{"code"=>"INTERNAL_SERVER_ERROR"}}], "data"=>nil}
-        return json
+        return hash
       end
     end
 
@@ -661,18 +648,16 @@ module AuthingRuby
     def checkPasswordStrength(password)
       graphqlAPI = AuthingRuby::GraphQLAPI.new
       variables = { "password": password }
-      res = graphqlAPI.checkPasswordStrength(@graphqlClient, @tokenProvider, variables)
-      json = JSON.parse(res)
-      return json.dig("data", "checkPasswordStrength")
+      hash = graphqlAPI.checkPasswordStrength(@graphqlClient, @tokenProvider, variables)
+      return hash.dig("data", "checkPasswordStrength")
     end
 
     # 检测 Token 登录状态
     def checkLoginStatus(token)
       graphqlAPI = AuthingRuby::GraphQLAPI.new
       variables = { "token": token }
-      res = graphqlAPI.checkLoginStatus(@graphqlClient, @tokenProvider, variables)
-      json = JSON.parse(res)
-      return json.dig("data", "checkLoginStatus")
+      hash = graphqlAPI.checkLoginStatus(@graphqlClient, @tokenProvider, variables)
+      return hash.dig("data", "checkLoginStatus")
     end
 
     # 更新用户密码
@@ -685,9 +670,8 @@ module AuthingRuby
         "oldPassword": oldPasswordEncrypted,
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      res = graphqlAPI.updatePassword(@graphqlClient, @tokenProvider, variables)
-      json = JSON.parse(res)
-      return json.dig("data", "updatePassword")
+      hash = graphqlAPI.updatePassword(@graphqlClient, @tokenProvider, variables)
+      return hash.dig("data", "updatePassword")
     end
 
     # 绑定手机号
@@ -698,14 +682,37 @@ module AuthingRuby
         "phone": phone,
         "phoneCode": phoneCode,
       }
-      res = graphqlAPI.bindPhone(@graphqlClient, @tokenProvider, variables)
-      json = JSON.parse(res)
-      user = json.dig("data", "bindPhone")
+      hash = graphqlAPI.bindPhone(@graphqlClient, @tokenProvider, variables)
+      user = hash.dig("data", "bindPhone")
       if user
         setCurrentUser(user);
         return user;
       else
-        return json
+        return hash
+      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
 
@@ -720,11 +727,10 @@ module AuthingRuby
         "newPassword": newPasswordEncrypted,
       }
       graphqlAPI = AuthingRuby::GraphQLAPI.new
-      resp = graphqlAPI.resetPassword(@graphqlClient, @tokenProvider, variables)
-      json = JSON.parse(resp)
-      result = json.dig("data", "resetPassword") # {"message":"重置密码成功！","code":200}
+      hash = graphqlAPI.resetPassword(@graphqlClient, @tokenProvider, variables)
+      result = hash.dig("data", "resetPassword") # {"message":"重置密码成功！","code":200}
       return result if result
-      return json
+      return hash
     end
 
     def generateCodeChallenge()

data/lib/authing_ruby/common/GraphqlClient.rb

@@ -14,6 +14,8 @@ module AuthingRuby
         @options = options
       end
 
+      # 发请求
+      # 成功或失败都返回 Hash
       def request(options)
         headers = {
           'content-type': 'application/json',
@@ -28,10 +30,46 @@ module AuthingRuby
           headers['Authorization'] = "Bearer #{token}"
         end
 
-        json = options.fetch(:json, nil)
-        # puts "@endpoint 是 #{@endpoint}"
-        response = HTTP.headers(headers).post(@endpoint, json: json)
-        return response.body.to_s
+        option_json = options.fetch(:json, nil)
+        response = HTTP.headers(headers).post(@endpoint, json: option_json)
+
+        # 如果直接拿 body，它的类型是：
+        # puts response.body
+        # puts response.body.class.name # HTTP::Response::Body
+        
+        # 如果转成 String：
+        # puts response.body.to_s
+        # puts response.body.to_s.class.name # String
+
+        hash = JSON.parse(response.body.to_s)
+
+        # 这里的错误处理代码参照的 JS SDK （src/lib/common/GraphqlClient.ts）
+        if hash['errors'] == nil
+          # 如果没错误
+          return hash
+        else
+          # 如果有错误, 最后返回这3个字段就行
+          code = nil
+          message = nil
+          data = nil
+
+          hash['errors'].each do |e|
+            if e['message']
+              message = e['message'] 
+              code = message['code']
+              message = message['message']
+              data = message['data']
+            end
+          end
+
+          # 返回 Hash
+          obj = { 
+            code: code,
+            message: message,
+            data: data
+          }
+          return obj
+        end
       end
 
     end

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/management/ManagementClient.rb

@@ -17,7 +17,7 @@ module AuthingRuby
       @accessToken = options.fetch(:accessToken, nil)
       
       if @userPoolId == nil && @appId == nil
-        throw '请提供 userPoolId 或 appId!'
+        raise '请提供 userPoolId 或 appId!'
       end
 
       graphqlApiEndpointV2 = "#{@host}/graphql/v2"

data/lib/authing_ruby/management/ManagementTokenProvider.rb

@@ -16,8 +16,8 @@ module AuthingRuby
       @_accessToken = nil
       @_accessTokenExpriredAt = nil # 过期时间
   
-      accessToken = options.fetch(:accessToken, nil)
       # 如果 options 里传入了 accessToken
+      accessToken = options.fetch(:accessToken, nil)
       if accessToken
         @_accessToken = accessToken;
         decoded_token_array = JWT.decode @_accessToken, nil, false # 试着解析一下
@@ -46,6 +46,7 @@ module AuthingRuby
     def _getAccessTokenFromServer
       accessToken = nil;
       secret = @options.fetch(:secret, nil)
+
       if secret
         accessToken = getClientWhenSdkInit()
       else
@@ -68,20 +69,20 @@ module AuthingRuby
         secret: @options.fetch(:secret, nil),
       }
       api = AuthingRuby::GraphQLAPI.new
-      res = api.getAccessToken(@graphqlClient, variables)
+      hash = api.getAccessToken(@graphqlClient, variables)
       # {"data":{"accessToken":{"accessToken":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7InR5cGUiOiJ1[省略]ZWE2NjE3IiwidXNlcks2lkIjoiNjA3YjBiMTVhYWIzYTgwNWY3ZWE2NjE3IiwiX2lkIjoiNjA3YjBiMTVhYWIzYTgwNWY3ZWE2NjE3IiwicGhvbmz3Mzk5M30.K7pwyvbxypeiOlYRsTIlLXY2xyk94tTd-CATQ85jYqM","exp":1620873993,"iat":1619577993}}}
-      hash = JSON.parse(res)
       return hash.dig("data", "accessToken", "accessToken")
     end
 
-    # TODO 还需要做什么？
     def refreshToken
       api = AuthingRuby::GraphQLAPI.new
-      res = api.refreshAccessToken(@graphqlClient, {
-        accessToken: @options.fetch(:accessToken, nil)
+      accessToken = @options.fetch(:accessToken, nil)
+      if accessToken == nil
+        raise "无法刷新 token, 因为初始化时没有传入 accessToken"
+      end
+      hash = api.refreshAccessToken(@graphqlClient, {
+        accessToken: accessToken
       })
-      hash = JSON.parse(res)
-      # puts hash
       # {"errors"=>[{"message"=>{"code"=>500, "message"=>"该 token 在黑名单中"}, "locations"=>[{"line"=>2, "column"=>5}], "path"=>["refreshAccessToken"], "extensions"=>{"code"=>"INTERNAL_SERVER_ERROR", "exception"=>{"name"=>"TokenInBlackListError"}}}], "data"=>nil}
       if hash.dig("errors")
         return hash