authing_ruby 1.0.6

data/lib/authing_ruby/authentication/AuthenticationTokenProvider.rb

@@ -0,0 +1,42 @@
+# 这个 class 只是存取 token 和 user
+# 参照 JS SDK 实现的
+# authing.js/src/lib/authentication/AuthenticationTokenProvider.ts 
+# https://github.com/Authing/authing.js/blob/196b33fe0c7f510ca26cda4d172939e1c74cc5f7/src/lib/authentication/AuthenticationTokenProvider.ts#L7
+
+module AuthingRuby
+  module Authentication
+    class AuthenticationTokenProvider
+      def initialize()
+        @token = nil
+        @user = nil
+      end
+
+      def setToken(token = nil)
+        if token
+          @token = token
+        end
+      end
+
+      def getToken()
+        return @token
+      end
+
+      def getUser()
+        return @user
+      end
+
+      def setUser(user = nil)
+        if user
+          @user = user
+          @token = user['token']
+        end
+      end
+
+      def clearUser()
+        @token = nil
+        @user = nil
+      end
+
+    end
+  end
+end

data/lib/authing_ruby/authentication/BaseAuthenticationClient.rb

@@ -0,0 +1,28 @@
+# https://github.com/Authing/authing.js/blob/196b33fe0c7f510ca26cda4d172939e1c74cc5f7/src/lib/authentication/BaseAuthenticationClient.ts
+
+module AuthingRuby
+  module Authentication
+    class BaseAuthenticationClient
+      def initialize(options = {})
+        @options = options
+      end
+
+      def appHost
+        # 最新版本，传入 appHost
+        appHost = @options.fetch(:appHost, nil)
+        return appHost if appHost != nil
+        # TODO: 用 regex 去掉 appHost 最后的斜杠 "/" (如果有的话)
+        
+        # 兼容协议认证 API 中传入的 domain
+        domain = @options.fetch(:domain, nil)
+        if domain != nil
+          return "https://#{domain}";
+        end
+
+        # 最后使用服务器统一域名 host
+        host = @options.fetch(:host, 'https://core.authing.cn')
+        return host
+      end
+    end
+  end
+end

data/lib/authing_ruby/common/GraphqlClient.rb

@@ -0,0 +1,39 @@
+# GraphqlClient 负责发 GraphQL 请求 (其实就是 HTTP POST)
+# 必须要这个是因为发请求要带上 'x-authing-userpool-id' 和 'x-authing-app-id 等 Header
+# 模仿的是: 
+# https://github.com/Authing/authing.js/blob/cf4757d09de3b44c3c3f4509ae8c8715c9f302a2/src/lib/common/GraphqlClient.ts#L6
+
+require "http"
+require_relative '../version.rb'
+
+module AuthingRuby
+  module Common
+    class GraphqlClient
+      def initialize(endpoint, options = {})
+        @endpoint = endpoint # API 端点
+        @options = options
+      end
+
+      def request(options)
+        headers = {
+          'content-type': 'application/json',
+          'x-authing-sdk-version': "ruby:#{AuthingRuby::VERSION}",
+          'x-authing-userpool-id': @options.fetch(:userPoolId, ''),
+          'x-authing-request-from': @options.fetch(:requestFrom, 'sdk'),
+          'x-authing-app-id': @options.fetch(:appId, ''),
+          'x-authing-lang': @options.fetch(:lang, ''),
+        };
+        token = options.fetch(:token, nil)
+        if token
+          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
+      end
+
+    end
+  end
+end

data/lib/authing_ruby/common/HttpClient.rb

@@ -0,0 +1,247 @@
+# 复刻一个 JS SDK 的 HttpClient
+# 问题: 这个 HttpClient 和 GraphqlClient 有什么区别?
+# graphqlClient 是写死的 POST 请求
+# httpClient 的是自己定的，可以是 GET, POST, DELETE 等
+# https://github.com/Authing/authing.js/blob/196b33fe0c7f510ca26cda4d172939e1c74cc5f7/src/lib/common/HttpClient.ts
+# https://github.com/Authing/authing.js/blob/master/src/lib/common/HttpClient.ts
+
+# 如何使用？
+=begin
+发送一个 POST 请求
+  httpClient = AuthingRuby::Common::HttpClient.new
+  httpClient.request({
+    method: 'POST',
+    url: "https://postman-echo.com/post",
+    data: {
+      "x": 100,
+      "y": 200,
+    }
+  })
+
+发送一个 GET 请求
+  httpClient = AuthingRuby::Common::HttpClient.new
+  url = "https://postman-echo.com/get"
+  resp = httpClient.request({
+    method: 'GET',
+    url: url,
+    params: {
+      "a": 3,
+      "b": 4,
+    }
+  })
+
+处理返回结果
+  result = @httpClient.request({
+    method: 'POST',
+    url: "#{@options.fetch(:host, nil)}/api/v2/applications",
+    data: {
+      "name": options.fetch(:name, nil),
+      "identifier": options.fetch(:identifier, nil),
+      "redirectUris": options.fetch(:redirectUris, nil),
+      "logo": options.fetch(:logo, nil),
+    }
+  });
+  return result; # #<Faraday::Response:0x00007fcfce0ce450>
+  return result.body # 这个才是返回, 不过是 String 类型
+  JSON.parse(result.body)
+
+=end
+
+require "http"
+require 'faraday'
+require_relative '../version.rb'
+
+module AuthingRuby
+  module Common
+
+    class HttpClient
+      METHODS = %i[get post put delete]
+      # METHODS = %i[get post put delete head patch options trace]
+      
+      def initialize(options = {}, tokenProvider = nil)
+        @options = options
+        @tokenProvider = tokenProvider
+      end
+
+      # 目的: 把 Faraday 稍微封装一下，因为 Faraday 不能动态指定方法（文档里没写），不像 js 的 axios。
+      # https://github.com/lostisland/faraday/blob/main/lib/faraday/connection.rb
+      # https://www.rubydoc.info/github/lostisland/faraday/Faraday/Connection
+      # 返回 <Faraday::Response>
+      def faraday_conn(config = {})
+        method = config.fetch(:method, nil)
+        if method == nil
+          raise "必须传入 method，可选值 #{METHODS.join(', ')}"
+        end
+        method_downcase = method.downcase # 转成小写
+        if METHODS.include?(method_downcase.to_sym) == false
+          raise "传入的 method 错误，可选值 #{METHODS.join(', ')}"
+        end
+
+        url = config.fetch(:url, nil)
+        data = config.fetch(:data, nil) # data 和 body 一回事
+        params = config.fetch(:params, nil)
+        headers = config.fetch(:headers, nil)
+
+        if method_downcase == 'get'
+          conn = Faraday::Connection.new url
+          return conn.get nil, params, headers
+        end
+
+        if method_downcase == 'post'
+          conn = Faraday::Connection.new url
+          return conn.post nil, data, headers
+        end
+
+        if method_downcase == 'put'
+          conn = Faraday::Connection.new url
+          return conn.put nil, data, headers
+        end
+
+        if method_downcase == 'delete'
+          conn = Faraday::Connection.new url
+          return conn.delete nil, params, headers
+        end
+      end
+
+      def request(config = {})
+        # 处理 config 里5个参数：method, url, data, params, headers
+        method = config.fetch(:method, nil)
+        url = config.fetch(:url, nil)
+        data = config.fetch(:data, nil) # data 和 body 一回事
+        params = config.fetch(:params, nil)
+        headers = {
+          'x-authing-sdk-version': "ruby:#{AuthingRuby::VERSION}",
+          'x-authing-userpool-id': @options.fetch(:userPoolId, ''),
+          'x-authing-request-from': @options.fetch(:requestFrom, 'sdk'),
+          'x-authing-app-id': @options.fetch(:appId, ''),
+          'x-authing-lang': @options.fetch(:lang, ''),
+        };
+
+        # 如果用户传了 authorization 进来。
+        config_headers_authorization = config.dig(:headers, :authorization)
+        if config_headers_authorization != nil
+          headers['Authorization'] = config_headers_authorization
+        else
+          # 如果用户不传 token，就使用 sdk 自己维护的。
+          token = @tokenProvider.getToken() if @tokenProvider
+          headers['Authorization'] = "Bearer #{token}" if token
+        end
+
+        resp = faraday_conn({
+          method: method,
+          params: params,
+          url: url,
+          data: data,
+          headers: headers,
+        })
+
+        # const { code, message } = data;
+        # if (code !== 200) {
+        #   this.options.onError(code, message, data.data);
+        #   throw new Error(JSON.stringify({ code, message, data: data.data }));
+        # }
+        # return data.data;
+
+        return resp
+      end
+
+    end
+
+    # JS SDK 里
+    # NaiveHttpClient 和 HttpClient 的区别:  HttpClient 会处理 onError 回调函数，也会从返回的 data 中处理 code, message
+    # NaiveHttpClient 只返回 data，也不带请求头 Authorization
+    class NaiveHttpClient < HttpClient
+      def initialize(options = {}, tokenProvider = nil)
+        super(options, tokenProvider)
+      end
+    
+      def request(config = {})
+        headers = {
+          'x-authing-sdk-version': "ruby:#{AuthingRuby::VERSION}",
+          'x-authing-userpool-id': @options.fetch(:userPoolId, ''),
+          'x-authing-request-from': @options.fetch(:requestFrom, 'sdk'),
+          'x-authing-app-id': @options.fetch(:appId, ''),
+          'x-authing-lang': @options.fetch(:lang, ''),
+        };
+        headers_merge = headers.merge(config.fetch(:headers, {}))
+        # 先把 header 合并一下，把用户传进来的和这里默认的合并一下
+
+        config = config.merge({headers: headers_merge})
+        # 再把 config 处理一下，把最终 header 合并进去
+
+        response = faraday_conn(config) # 返回 Faraday::Response
+        return response.body
+      end
+    end
+
+  end
+end
+
+=begin
+JS SDK 中调用 httpClient 的使用示例，在 vscode 中搜索 this.httpClient.request 可以找到
+
+第一种：简单 get
+  const data = await this.httpClient.request({
+    method: 'GET',
+    url: api
+  });
+
+第二种：简单 post
+  const data = await this.httpClient.request({
+    method: 'POST',
+    url: api,
+    data: { phone }
+  });
+
+第三种：post 加数据
+  await this.httpClient.request({
+    method: 'POST',
+    url: `${this.baseClient.appHost}/api/v2/users/link`,
+    data: {
+      primaryUserToken: options.primaryUserToken,
+      secondaryUserToken: options.secondaryUserToken
+    }
+  });
+
+第四种: withCredentials
+  await this.httpClient.request({
+    method: 'GET',
+    url: `${this.baseClient.appHost}/api/v2/logout?app_id=${this.options.appId}`,
+    withCredentials: true
+  });
+
+
+# 第五种：params
+  const data: IMfaAuthenticators = await this.httpClient.request({
+    method: 'GET',
+    url: api,
+    params: {
+      type,
+      source
+    },
+    headers
+  });
+    
+
+结论：需要支持以下参数：method, url, data, params，headers
+method, url, headers 很好理解
+
+params 是用于 get 方法的 url 参数
+  // `params` are the URL parameters to be sent with the request
+  // Must be a plain object or a URLSearchParams object
+  params: {
+    ID: 12345
+  },
+
+data 是
+  // `data` is the data to be sent as the request body
+  // Only applicable for request methods 'PUT', 'POST', 'DELETE , and 'PATCH'
+  // When no `transformRequest` is set, must be of one of the following types:
+  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
+  // - Browser only: FormData, File, Blob
+  // - Node only: Stream, Buffer
+  data: {
+    firstName: 'Fred'
+  },
+
+=end

data/lib/authing_ruby/common/PublicKeyManager.rb

@@ -0,0 +1,42 @@
+# PublicKeyManager 负责获取公钥
+# 模仿的是：
+# https://github.com/Authing/authing.js/blob/cf4757d09de3b44c3c3f4509ae8c8715c9f302a2/src/lib/common/PublicKeyManager.ts#L28
+# authing.js/src/lib/common/PublicKeyManager.ts 
+require "http"
+require_relative '../authentication/BaseAuthenticationClient.rb'
+
+module AuthingRuby
+  module Common
+    class PublicKeyManager
+
+      def initialize(options = {})
+        @options = options
+        @public_key = nil # 用于缓存公钥，免得每次都发请求
+        @baseClient = Authentication::BaseAuthenticationClient.new(options)
+      end
+      
+      def getPublicKey
+        # 用传进来的 publicKey
+        option_publicKey = @options.fetch(:publicKey, nil)
+        return option_publicKey if option_publicKey != nil
+
+        # 用缓存的 publickKey
+        return @public_key if @public_key != nil
+
+        # 发请求获取 publicKey
+        appHost = @baseClient.appHost()
+        url = "#{appHost}/api/v2/.well-known"
+        response = HTTP.get(url) # TODO: 处理失败情况，如网络请求失败，或返回代码不为200
+        
+        response_text = response.body.to_s
+        # {"code":200,"message":"获取成功","data":{"publicKey":"-----BEGIN PUBLIC KEY-----\nMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC4xKeUgQ+Aoz7TLfAfs9+paePb\n5KIofVthEopwrXFkp8OCeocaTHt9ICjTT2QeJh6cZaDaArfZ873GPUn00eOIZ7Ae\n+TiA2BKHbCvloW3w5Lnqm70iSsUi5Fmu9/2+68GZRH9L7Mlh8cFksCicW2Y2W2uM\nGKl64GDcIq3au+aqJQIDAQAB\n-----END PUBLIC KEY-----\n"}}
+        
+        json = JSON.parse(response_text)
+        publicKey = json['data']['publicKey']
+        @public_key = publicKey # 存入缓存
+        return publicKey
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+mutation bindPhone($phone: String!, $phoneCode: String!) {
+  bindPhone(phone: $phone, phoneCode: $phoneCode) {
+    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/graphql/mutations/createUser.gql

@@ -0,0 +1,54 @@
+mutation createUser($userInfo: CreateUserInput!, $keepPassword: Boolean) {
+  createUser(userInfo: $userInfo, keepPassword: $keepPassword) {
+    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
+    externalId
+  }
+}

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

@@ -0,0 +1,6 @@
+mutation deleteUser($id: String!){
+    deleteUser(id: $id){
+        message
+        code
+    }
+}

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

@@ -0,0 +1,6 @@
+mutation deleteUsers($ids: [String!]!){
+    deleteUsers(ids: $ids){
+        message
+        code
+    }
+}

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

@@ -0,0 +1,54 @@
+mutation loginByEmail($input: LoginByEmailInput!) {
+  loginByEmail(input: $input) {
+    id
+    arn
+    status
+    userPoolId
+    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
+    externalId
+  }
+}

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

@@ -0,0 +1,54 @@
+mutation loginByPhoneCode($input: LoginByPhoneCodeInput!) {
+  loginByPhoneCode(input: $input) {
+    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
+    externalId
+  }
+}

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

@@ -0,0 +1,54 @@
+mutation loginByPhonePassword($input: LoginByPhonePasswordInput!) {
+  loginByPhonePassword(input: $input) {
+    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
+    externalId
+  }
+}