Shield 项目技术文档
2024-12-20 14:53:11作者:鲍丁臣Ursa
1. 安装指南
首先,确保您的环境中已经安装了Ruby。接下来,使用以下命令通过RubyGems安装Shield项目:
gem install shield
2. 项目的使用说明
Shield是一个简单的认证库,它的目的是为应用提供保护。Shield的特点是代码简洁(大约110行Ruby代码),不会干扰现有代码,并且假设用户具备一定的编程能力。
Shield::Model
Shield::Model 是一个基本的协议,用于针对您的模型进行认证。它假设以下内容:
- 你会实现
User.fetch方法,它接收登录字符串。 - 你有一个属性
crypted_password,可以存储多达192个字符。
实现模型协议的方法是包括 Shield::Model。
class User < Struct.new(:email, :crypted_password)
include Shield::Model
def self.fetch(email)
user = new(email)
user.password = "pass1234"
return user
end
end
通过包括 Shield::Model,你会得到所有进行认证所需的一般方法:
- 你会得到
User.authenticate方法,它接收登录字符串和密码作为两个参数。 - 你会得到
User#password=方法,它自动将明文密码转换为哈希形式并赋值给#crypted_password。
支持邮箱和用户名登录
如果你的需求需要支持使用邮箱或用户名登录,你可以通过扩展 User.fetch 方法来实现:
class User < Sequel::Model
include Shield::Model
def self.fetch(identifier)
filter(email: identifier).first || filter(username: identifier).first
end
end
如果出于某些原因需要支持不区分大小写的登录,你可以将值转换为小写形式。
3. 项目API使用文档
Shield的API使用非常简单,主要包括以下几个部分:
Shield::Model
User.fetch(email):通过邮箱获取用户。User.authenticate(email, password):通过邮箱和密码进行用户认证。User#password=:设置用户密码,并自动将其转换为哈希存储。
Shield::Helpers
Shield::Helpers 提供了一些在Rack应用程序上下文中使用的辅助方法,例如:
authenticated(User):检查当前是否有用户认证。login(User, login, password):尝试登录用户。logout(User):登出用户。
Shield::Middleware
Shield::Middleware 用于处理HTTP 401 Unauthorized响应,并将其重定向到登录页面。
use Shield::Middleware, "/login"
use Rack::Session::Cookie
4. 项目安装方式
如前所述,通过RubyGems安装Shield:
gem install shield
以上是Shield项目的基本安装和使用说明,希望对您的应用开发有所帮助。
登录后查看全文
热门项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
247
2.45 K
deepin linux kernel
C
24
6
仓颉编译器源码及 cjdb 调试工具。
C++
116
89
React Native鸿蒙化仓库
JavaScript
217
297
仓颉编程语言测试用例。
Cangjie
34
80
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
355
1.7 K
暂无简介
Dart
545
119
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.01 K
595
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
407
Ascend Extension for PyTorch
Python
85
118