首页
/ Roy 项目技术文档

Roy 项目技术文档

2024-12-23 21:13:03作者:伍希望

1. 安装指南

Roy 是一个用于将 Ruby 对象转换为 Rack-friendly 并提供 REST-like 接口的小型模块。要安装 Roy,请按照以下步骤操作:

  1. 确保你已经安装了 Ruby 环境。
  2. 使用 gem 命令安装 Roy:
    gem install roy
    

2. 项目的使用说明

Roy 的主要目标是使任何 Ruby 对象能够与 Rack 兼容,并为其提供 REST-like 接口。Roy 通过提供一个 #call 方法来实现这一点,该方法接收 Rack 环境并将其分派到与 HTTP 方法同名的常规方法。

示例

以下是一个简单的示例,展示了如何使用 Roy 创建一个消息队列对象:

class MessageQueue
  include Roy

  roy allow: [:get, :post, :delete]

  def initialize
    @stack = []
  end

  def get(_)
    @stack.inspect
  end

  def post(_)
    roy.halt 403 unless roy.params[:item]
    @stack << roy.params[:item].strip
    get
  end

  def delete(_)
    @stack.shift.inspect
  end
end

在这个示例中,MessageQueue 类包含了 Roy 模块,并通过 roy 方法定义了允许的 HTTP 方法(GET、POST、DELETE)。每个方法处理不同的 HTTP 请求,并操作 @stack 数组。

3. 项目API使用文档

配置

Roy 提供了 roy 类方法来定义访问控制和方法前缀。你还可以定义自定义选项。以下是一个配置示例:

class Example
  include Roy
  roy allow: [:get], prefix: :http_, foo: "bar"

  def http_get(path)
    "foo is #{roy.conf.foo}"
  end
end

在这个示例中,Example 类只允许 GET 请求,并且方法名前缀为 http_roy.conf.foo 可以访问自定义配置项 foo

环境

在处理方法内部,你可以访问 roy 属性,它是一个包含以下字段的 OpenStruct

  • env: Rack 环境
  • response: 一个 Rack::Response 对象,将由 call 方法返回
  • request: 从环境构建的 Rack::Request 对象
  • headers: 响应头哈希
  • params: 从查询字符串和请求体中提取的参数
  • conf: 通过 ::roy 设置的配置

params 的键可以通过 StringSymbol 访问。

控制流

处理方法在 catch 块中运行,该块会捕获 :halt 符号。你可以使用 throw 来中止方法,但必须返回一个由状态码和消息组成的数组。Roy 提供了 roy.halt 方法,该方法接收状态码和一个可选的消息。如果没有提供消息,则使用 Rack::Utils::HTTP_STATUS_CODES 中的默认消息。

插件

Roy 附带了多个插件,每个插件都设计为只做一件事。以下是完整的插件列表:

  • after: 在应用调用后修改响应
  • before: 在调用应用前修改环境
  • render: 与 Tilt 集成
  • plugins: 一个简单的插件加载器

4. 项目安装方式

Roy 可以通过 RubyGems 安装,具体步骤如下:

  1. 打开终端或命令行工具。
  2. 运行以下命令安装 Roy:
    gem install roy
    

安装完成后,你可以在 Ruby 项目中使用 require 'roy' 来引入 Roy 模块。

登录后查看全文
热门项目推荐