authing_ruby 1.0.6

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

@@ -0,0 +1,193 @@
+# ruby ./lib/test/mini_test/TestManagementClient.rb
+
+require "minitest/autorun"
+require "./lib/authing_ruby.rb"
+require "./lib/test/helper.rb"
+require 'dotenv'
+Dotenv.load('.env.test') 
+
+class TestManagementClient < Minitest::Test
+  def setup
+    @options = {
+      host: 'https://core.authing.cn',
+      userPoolId: ENV["userPoolId"],
+      secret: ENV["secret"],
+    }
+    @helper = Test::Helper.new
+  end
+
+  # 创建用户
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_users_create
+  def test_users_create
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    userInfo = {
+      username: @helper.randomString, # 随机字符串，比如 "mpflok"
+      # username: 'SpongeBob3', # 或者明确指定用户名
+      password: 'passw0rd',
+    }
+    res = managementClient.users.create(userInfo)
+    json = JSON.parse(res)
+    # puts res
+    # 如果成功
+    # {"data":{"createUser":{"id":"608ab9828eab7e35e81bd732","arn":"arn:cn:authing:60800b8ee5b66b23128b4980:user:608ab9828eab7e35e81bd732","userPoolId":"60800b8ee5b66b23128b4980","status":"Activated","username":"SpongeBob2","email":null,"emailVerified":false,"phone":null,"phoneVerified":false,"unionid":null,"openid":null,"nickname":null,"registerSource":["import:manual"],"photo":"default-user-avatar.png","password":"91b133c2e13e40852505946b7e0c2f04","oauth":null,"token":null,"tokenExpiredAt":null,"loginsCount":0,"lastLogin":null,"lastIP":null,"signedUp":null,"blocked":false,"isDeleted":false,"device":null,"browser":null,"company":null,"name":null,"givenName":null,"familyName":null,"middleName":null,"profile":null,"preferredUsername":null,"website":null,"gender":"U","birthdate":null,"zoneinfo":null,"locale":null,"address":null,"formatted":null,"streetAddress":null,"locality":null,"region":null,"postalCode":null,"city":null,"province":null,"country":null,"createdAt":"2021-04-29T13:49:54+00:00","updatedAt":"2021-04-29T13:49:54+00:00","externalId":null}}}
+    
+    # 如果失败
+    # {"errors":[{"message":{"code":2026,"message":"用户已存在，请勿重复创建！"},"locations":[{"line":2,"column":3}],"path":["createUser"],"extensions":{"code":"INTERNAL_SERVER_ERROR"}}],"data":null}
+
+    assert(json.dig("data", "createUser") != nil, json)
+  end
+
+  # 创建用户
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_user_create_2
+  def test_user_create_2
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    random_phone = "1350000#{rand(1000..9999)}"
+    userInfo = {
+      nickname: 'Nick Water3',
+      phone: random_phone, # 由于是管理员操作，所以不需要检验手机号验证码, 如果你需要检验，请使用  AuthenticationClient
+      loginsCount: 2, # 原有用户系统记录的用户登录次数
+      signedUp: '2020-10-15T17:55:37+08:00' # 原有用户系统记录的用户注册时间
+    }
+    res = managementClient.users.create(userInfo)
+    # puts res
+    json = JSON.parse(res)
+    assert(json.dig("data", "createUser") != nil, json)
+  end
+
+  # 创建一个用户, 并返回这个用户
+  def create_random_user(userInfo = {})
+    # 如果没传参数就用一个默认的，随机生成的。
+    if userInfo.empty?
+      random_phone = "1760000#{rand(1000..9999)}"
+      userInfo = {
+        nickname: "Nick #{random_phone}",
+        phone: random_phone, # 由于是管理员操作，所以不需要检验手机号验证码, 如果你需要检验，请使用  AuthenticationClient
+      }
+    end
+
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    res = managementClient.users.create(userInfo)
+    json = JSON.parse(res)
+    user = json.dig("data", "createUser")
+    return user
+  end
+
+  # 更新用户
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_update_user
+  def test_update_user
+    # 第一步：创建用户
+    user = create_random_user()
+    user_id = user.dig("id") # "6088decdcc904f5c993d6226"
+
+    # 第二步：更新用户
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    res2 = managementClient.users.update(user_id, {
+      nickname: 'Nick',
+    })
+    # puts res2
+    # 如果失败
+    # {"errors":[{"message":{"code":2004,"message":"用户不存在"},"locations":[{"line":2,"column":3}],"path":["updateUser"],"extensions":{"code":"INTERNAL_SERVER_ERROR"}}],"data":null}
+
+    json2 = JSON.parse(res2)
+    assert(json2.dig("data", "updateUser") != nil, json2)
+  end
+
+  # 测试通过 ID 获取用户信息
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_detail
+  def test_detail
+    user = create_random_user()
+    user_id = user.dig("id")
+
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    res = managementClient.users.detail(user_id)
+
+    json = JSON.parse(res)
+    assert(json.dig("data", "user") != nil, json)
+  end
+  
+  # 测试删除用户
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_delete
+  def test_delete
+    user = create_random_user()
+    user_id = user.dig("id")
+
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    res = managementClient.users.delete(user_id)
+
+    # puts res
+    # {"data":{"deleteUser":{"message":"删除成功！","code":200}}}
+
+    json = JSON.parse(res)
+    assert(json.dig("data", "deleteUser") != nil, json)
+  end
+
+  # 测试删除多个用户
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_deleteMany
+  def test_deleteMany
+    user1 = create_random_user()
+    user1_id = user1.dig("id")
+
+    user2 = create_random_user()
+    user2_id = user2.dig("id")
+
+    user_ids = [user1_id, user2_id]
+
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    res = managementClient.users.deleteMany(user_ids)
+    # puts res
+    # {"data":{"deleteUsers":{"message":"删除成功！","code":200}}}
+
+    json = JSON.parse(res)
+    assert(json.dig("data", "deleteUsers") != nil, json)
+  end
+
+  # 测试获取用户列表
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_list
+  def test_list
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    res = managementClient.users.list()
+    # puts res
+    json = JSON.parse(res)
+    assert(json.dig("data", "users") != nil, json)
+  end
+
+  # 测试 检查用户是否存在 (返回 true | false)
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_exists
+  def test_exists
+    # 第一步：先创建用户
+    userInfo = {
+      "username": "bob",
+    }
+    create_random_user(userInfo)
+
+    # 第二步：检查是否存在
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    options = { 
+      "username": "bob",
+      # "email": "haha2@qq.com",
+      # "phone": "13700001111",
+    }
+    boolean = managementClient.users.exists(options)
+    assert(boolean)
+  end
+
+  # 测试 查找用户 (返回这个用户)
+  # ruby ./lib/test/mini_test/TestManagementClient.rb -n test_find
+  def test_find
+    # 第一步：先创建用户
+    userInfo = {
+      "username": "alice",
+    }
+    create_random_user(userInfo)
+
+    managementClient = AuthingRuby::ManagementClient.new(@options)
+    options = { 
+      "username": "alice",
+      # "email": "haha2@qq.com",
+      # "phone": "13700001111",
+    }
+    result = managementClient.users.find(options)
+    assert(result.dig("data", "findUser"), result)
+  end
+
+end

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

@@ -0,0 +1,49 @@
+# 这个文件测什么？ManagementTokenProvider
+# 只是管理 accessToken
+# ruby ./lib/test/mini_test/TestManagementTokenProvider.rb
+
+require "minitest/autorun"
+require "./lib/authing_ruby.rb"
+require "./lib/test/helper.rb"
+require 'dotenv'
+Dotenv.load('.env.test') 
+
+class TestManagementTokenProvider < Minitest::Test
+
+  def setup
+    appHost = ENV["appHost"]
+    graphqlEndpoint = "#{appHost}/graphql/v2"
+    graphqlClient = AuthingRuby::Common::GraphqlClient.new(graphqlEndpoint)
+
+    options = {
+      userPoolId: ENV["userPoolId"],
+      secret: ENV["secret"],
+    }
+    @managementTokenProvider = AuthingRuby::ManagementTokenProvider.new(options, graphqlClient)
+  end
+
+  # ruby ./lib/test/mini_test/TestManagementTokenProvider.rb -n test_getToken
+  def test_getToken
+    token = @managementTokenProvider.getToken()
+    assert(token != nil)
+  end
+
+  # ruby ./lib/test/mini_test/TestManagementTokenProvider.rb -n test_getAccessTokenFromServer
+  def test_getAccessTokenFromServer
+    token = @managementTokenProvider._getAccessTokenFromServer()
+    assert(token != nil)
+  end
+
+  # ruby ./lib/test/mini_test/TestManagementTokenProvider.rb -n test_getClientWhenSdkInit
+  def test_getClientWhenSdkInit
+    token = @managementTokenProvider.getClientWhenSdkInit()
+    assert(token != nil)
+  end
+
+  # ruby ./lib/test/mini_test/TestManagementTokenProvider.rb -n test_refreshToken
+  def test_refreshToken
+    token = @managementTokenProvider.refreshToken()
+    assert(token != nil)
+  end
+
+end

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

@@ -0,0 +1,33 @@
+# ruby ./lib/test/mini_test/TestNaiveHttpClient.rb
+require "minitest/autorun"
+require "./lib/authing_ruby.rb"
+require "./lib/test/helper.rb"
+require 'dotenv'
+Dotenv.load('.env.test') 
+
+
+class TestNaiveHttpClient < Minitest::Test
+
+	def test_init
+    naiveHttpClient = AuthingRuby::Common::NaiveHttpClient.new
+	end
+
+	def test_get
+    http = AuthingRuby::Common::NaiveHttpClient.new()
+    url = "https://postman-echo.com/get"
+    params = {
+      "a": 3
+    }
+    resp = http.request({
+      method: 'GET',
+      url: url,
+      params: params,
+			headers: { b: "100" },
+    })
+    json = JSON.parse(resp.body)
+    # puts JSON.pretty_generate(json)
+    assert(json.dig('args', "a") == "3")
+    assert(json.dig('headers', "b") == "100")
+	end
+
+end

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

@@ -0,0 +1,101 @@
+# 有些方法必须用"短信验证码"或"邮件验证码"
+# 比如
+#    通过短信验证码重置密码
+#    通过邮件验证码重置密码
+#    发送邮件
+#    发送短信验证码
+#    使用手机号验证码登录
+
+# 我们将这些测试统一放到这个文件里，方便查找
+# 因为这些方法需要手工测试，无法自动化
+# ruby ./lib/test/mini_test/TestSMSandEmail.rb
+
+require "minitest/autorun"
+require "./lib/authing_ruby.rb"
+require "./lib/test/helper.rb"
+require 'dotenv'
+Dotenv.load('.env.test') 
+
+class TestSMSandEmail < Minitest::Test
+	def setup
+    # 新建一个用户侧的
+    authenticationClient_options = {
+      appHost: ENV["appHost"], # "https://rails-demo.authing.cn", 
+      appId: ENV["appId"], # "60800b9151d040af9016d60b"
+    }
+    @authenticationClient = AuthingRuby::AuthenticationClient.new(authenticationClient_options)
+
+    # 新建一个管理侧的
+    managementClient_options = {
+      host: 'https://core.authing.cn',
+      userPoolId: ENV["userPoolId"],
+      secret: ENV["secret"],
+    }
+    @managementClient = AuthingRuby::ManagementClient.new(managementClient_options)
+
+    @helper = Test::Helper.new
+
+    @phone = '13556136684' # 测发短信时需要改一下这里, 填你自己的手机号，这样才能收到短信
+  end
+
+  # 手动发送短信
+  def manual_send_SMS(phone)
+    sms_result = @authenticationClient.sendSmsCode(phone)
+    return sms_result
+    # {"code":200,"message":"发送成功"}
+    #【Authing】验证码7326，该验证码5分钟内有效，请勿泄漏于他人。
+  end
+
+  # 通过短信验证码重置密码
+  # ruby ./lib/test/mini_test/TestSMSandEmail.rb -n test_resetPasswordByPhoneCode
+  def test_resetPasswordByPhoneCode
+    # 前提条件：先确保有一个用户是自己的手机号，可以直接进 Authing 手工新建一个用户。
+
+    phone = @phone # 手机号
+    phoneCode = nil # 先保持为 nil 运行一次, 触发 manual_send_SMS 发个短信，然后自己填一下 phoneCode 为手机短信收到的验证码
+    if phoneCode == nil
+      # manual_send_SMS(phone) # 取消这行的注释
+    else
+      newPassword = '123456789'
+      res = @authenticationClient.resetPasswordByPhoneCode(phone, phoneCode, newPassword)
+      assert(res.dig("code") == 200, res)
+    end
+    # 如果成功
+    # {"message":"重置密码成功！","code":200}
+
+    # 错误可能1
+    # {"errors":[{"message":{"code":2004,"message":"用户不存在"},"locations":[{"line":2,"column":5}],"path":["resetPassword"],"extensions":{"code":"INTERNAL_SERVER_ERROR"}}],"data":{"resetPassword":null}}
+
+    # 错误可能2
+    # {"errors":[{"message":{"code":2001,"message":"验证码不正确！"},"locations":[{"line":2,"column":5}],"path":["resetPassword"],"extensions":{"code":"INTERNAL_SERVER_ERROR"}}],"data":{"resetPassword":null}}
+  end
+
+  # 测试: 绑定手机号
+  # ruby ./lib/test/mini_test/TestSMSandEmail.rb -n test_bindPhone
+  def test_bindPhone
+    # 第一步：用户名注册用户
+    username = "test_bindPhone_#{@helper.randomString()}"
+    password = "123456789"
+    user = @authenticationClient.registerByUsername(username, password)
+
+    # 第二步：登录用户
+    @authenticationClient.loginByUsername(username, password)
+
+    # 第三步
+    phoneCode = nil # 先保持为 nil 运行一次, 触发 manual_send_SMS 发个短信，然后自己填一下 phoneCode 为手机短信收到的验证码
+    if phoneCode == nil
+      # manual_send_SMS(@phone) # 取消这行的注释
+    else
+      res = @authenticationClient.bindPhone(@phone, phoneCode)
+      assert(res.dig('id') != nil)
+
+      # 错误情况
+      # puts res
+      # {"errors":[{"message":{"code":500,"message":"该手机号已被绑定"},"locations":[{"line":2,"column":3}],"path":["bindPhone"],"extensions":{"code":"INTERNAL_SERVER_ERROR"}}],"data":null}
+    end
+
+    # 清理工作：测完了删除第一步注册的用户
+    user_id = user['id']
+    @managementClient.users.delete(user_id)
+  end 
+end

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

@@ -0,0 +1,35 @@
+# ruby ./lib/test/mini_test/TestUtils.rb
+
+require "minitest/autorun" 
+require "./lib/authing_ruby.rb"
+require "./lib/test/helper.rb" 
+require 'dotenv'
+Dotenv.load('.env.test') 
+
+
+class TestUtils < Minitest::Test
+
+	# 测试生成随机字符串
+	def test_randomString
+		random = AuthingRuby::Utils.generateRandomString(43)
+		assert(random.length == 43)
+	end
+
+	def test_randomNumberString
+		random = AuthingRuby::Utils.randomNumberString(10)
+		assert(random.length == 10)
+	end
+
+	def test_hash_each
+		hash = {
+			a:1,
+			b:2,
+		}
+		hash.each do |key, value|
+			puts "key: #{key}"
+			puts "value: #{value}"
+			puts "---"
+		end
+	end
+
+end

data/lib/authing_ruby/utils/utils.rb

@@ -0,0 +1,40 @@
+require 'openssl'
+require "base64"
+
+module AuthingRuby
+  class Utils
+    # 参照 JS SDK 的 encrypt 函数
+    # https://github.com/Authing/authing.js/blob/cf4757d09de3b44c3c3f4509ae8c8715c9f302a2/src/lib/utils.ts#L12
+    # 用途：传入一个明文，传入一个公钥
+    # 用这个公钥对明文进行 RSA 加密，
+    # 然后返回 base64 编码后的结果
+    def self.encrypt(plainText, publicKey)
+      key = OpenSSL::PKey::RSA.new(publicKey)
+      result = key.public_encrypt(plainText)
+      return Base64.encode64(result)
+    end
+
+    # 生成随机字符串，参照 JS SDK 里的 src/lib/utils.ts
+    def self.generateRandomString(length = 30)
+      result = ""
+      chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
+      for i in 0..length-1
+        random_index = rand(0..chars.length-1)
+        result += chars[random_index]
+      end
+      return result
+    end
+
+    # 生成一个纯数字的随机字符串
+    def self.randomNumberString(length = 8)
+      result = ""
+      chars = '0123456789'
+      for i in 0..length-1
+        random_index = rand(0..chars.length-1)
+        result += chars[random_index]
+      end
+      return result
+    end
+
+  end
+end

data/lib/authing_ruby/version.rb

@@ -0,0 +1,6 @@
+# SDK 版本
+# https://github.com/Authing/authing.js/blob/cf4757d09de3b44c3c3f4509ae8c8715c9f302a2/src/lib/version.ts
+
+module AuthingRuby
+  VERSION = "1.0.6".freeze
+end

data/lib/authing_ruby.rb

@@ -0,0 +1,14 @@
+# 主文件，引入各种东西
+require_relative 'authing_ruby/utils/utils' # 工具
+require_relative 'authing_ruby/common/PublicKeyManager.rb' # 公钥
+require_relative 'authing_ruby/common/GraphqlClient.rb' # 发 GraphQL 请求的工具
+require_relative 'authing_ruby/common/HttpClient.rb' # 发 http 请求的工具
+require_relative 'authing_ruby/authentication/AuthenticationTokenProvider.rb' # 存 token 和 User
+
+require_relative 'authing_ruby/authentication/AuthenticationClient.rb' 
+# AuthenticationClient 以终端用户（End User）的身份进行请求，提供了登录、注册、登出、管理用户资料、获取授权资源等所有管理用户身份的方法；
+
+require_relative 'authing_ruby/management/ManagementClient.rb'
+# ManagementClient 以管理员（Administrator）的身份进行请求，用于管理用户池资源和执行管理任务，提供了管理用户、角色、应用、资源等方法；一般来说，你在 Authing 控制台 (opens new window)中能做的所有操作，都能用此模块完成。
+
+# 所有的代码都放在 AuthingRuby 这个 module 下，作为命名空间