ShamRack 技术文档

1. 安装指南

安装 ShamRack

ShamRack 是一个 Ruby Gem，可以通过以下命令进行安装：

gem install sham_rack

安装完成后，你可以在 Ruby 项目中使用 require 'sham_rack' 来引入 ShamRack。

2. 项目的使用说明

概述

ShamRack 是一个用于将 HTTP 请求路由到 Rack 应用的工具。它主要用于在开发和测试环境中轻松地模拟外部 HTTP 服务，或者用于测试 HTTP 客户端代码。ShamRack 支持多种 HTTP 客户端库，如 rest-client、httparty 和 oauth，并且可以在不启动服务器的情况下测试 Rack 应用。

基本用法

简单的内联应用

你可以通过 ShamRack 快速创建一个简单的 HTTP 服务：

require 'sham_rack'

ShamRack.at("www.greetings.com") do |env|
  ["200 OK", { "Content-type" => "text/plain" }, ["Hello, world!"]]
end

require 'open-uri'
open("http://www.greetings.com/").read            #=> "Hello, world!"

Sinatra 集成

ShamRack 也支持与 Sinatra 集成：

ShamRack.at("sinatra.xyz").sinatra do
  get "/hello/:subject" do
    "Hello, #{params[:subject]}"
  end
end

open("http://sinatra.xyz/hello/stranger").read  #=> "Hello, stranger"

Rackup 支持

ShamRack 还支持通过 rackup 配置中间件和应用：

ShamRack.at("rackup.xyz").rackup do
  use Some::Middleware
  use Some::Other::Middleware
  run MyApp.new
end

任意 Rack 应用

你可以将任意 Rack 应用挂载到 ShamRack：

ShamRack.at("google.com").mount(my_google_stub)

通用 stubbing

ShamRack 还提供了通用的 stubbing 功能：

@stub_app = ShamRack.at("stubbed.com").stub
@stub_app.register_resource("/greeting", "Hello, world!", "text/plain")

open("http://stubbed.com/greeting").read       #=> "Hello, world!"
@stub_app.last_request.path                    #=> "/greeting"

指定端口

你可以指定 ShamRack 监听的端口：

ShamRack.at("example.com", 8080) do |env|
  ["200 OK", { "Content-type" => "text/plain" }, ["Hello, world!"]]
end

避免真实网络连接

在测试环境中，你可以使用 ShamRack 来阻止真实的网络连接：

ShamRack.prevent_network_connections

测试完成后重置

测试完成后，你可以重置 ShamRack：

ShamRack.reset

open("http://stubbed.com/greeting").read       #=> OpenURI::HTTPError

3. 项目 API 使用文档

ShamRack API

ShamRack.at(host, port = nil)

• host: 要挂载的域名或 IP 地址。
• port: 可选参数，指定监听的端口。

返回一个 ShamRack::Application 实例，用于配置和挂载 Rack 应用。

ShamRack.prevent_network_connections

阻止所有真实的网络连接，确保所有请求都由 ShamRack 处理。

ShamRack.reset

重置 ShamRack，移除所有挂载的应用。

ShamRack::Application API

mount(app)

挂载一个 Rack 应用。

sinatra(&block)

挂载一个 Sinatra 应用。

rackup(&block)

通过 rackup 配置中间件和应用。

stub

返回一个通用的 stub 应用。

register_resource(path, body, content_type)

在 stub 应用中注册一个资源。

• path: 资源的 URL 路径。
• body: 资源的响应内容。
• content_type: 资源的 MIME 类型。

last_request

返回最后一个处理的请求对象。

4. 项目安装方式

ShamRack 的安装非常简单，只需使用 RubyGems 进行安装：

gem install sham_rack

安装完成后，你可以在 Ruby 项目中通过 require 'sham_rack' 引入 ShamRack，并按照上述使用说明进行配置和使用。

---

通过以上文档，你应该能够顺利安装和使用 ShamRack 项目，并了解其 API 的使用方法。