CarrierWaveDirect 技术文档

1. 安装指南

1.1 安装最新版本

通过以下命令安装最新版本的 carrierwave_direct：

gem install carrierwave_direct

1.2 在 Rails 项目中安装

在 Rails 项目中，将 carrierwave_direct 添加到 Gemfile 中：

gem 'carrierwave_direct'

注意：CarrierWaveDirect 不支持 Rails 2。

2. 项目的使用说明

2.1 初始化配置

CarrierWaveDirect 依赖于 fog，因此需要先配置 CarrierWave 并初始化 fog 凭证。例如：

CarrierWave.configure do |config|
  config.fog_credentials = {
    :provider               => 'AWS',       # 必填
    :aws_access_key_id      => 'xxx',       # 必填
    :aws_secret_access_key  => 'yyy',       # 必填
    :region                 => 'eu-west-1'  # 可选，默认为 'us-east-1'
  }
  config.fog_directory  = 'name_of_your_aws_bucket' # 必填
end

2.2 生成上传器

通过以下命令生成一个上传器：

rails generate uploader Avatar

这将在 app/uploaders/avatar_uploader.rb 中生成一个文件。打开该文件并修改如下：

class AvatarUploader < CarrierWave::Uploader::Base
  include CarrierWaveDirect::Uploader
end

2.3 移除 store_dir 方法

为了使用 CarrierWaveDirect 默认的存储目录，可以移除 store_dir 方法。默认存储路径为：

/uploads/<unique_guid>/foo.png

3. 项目 API 使用文档

3.1 直接上传表单

在 Rails 中，可以通过以下方式生成直接上传表单：

class AvatarController < ApplicationController
  def new
    @uploader = User.new.avatar
    @uploader.success_action_redirect = new_user_url
  end
end

在视图中使用 direct_upload_form_for 生成表单：

<%= direct_upload_form_for @uploader do |f| %>
  <%= f.file_field :avatar %>
  <%= f.submit %>
<% end %>

3.2 更新上传器对象

上传完成后，需要在控制器中更新上传器对象：

@uploader.update_attribute :avatar_key, params[:key]

3.3 内容类型设置

默认情况下，Amazon 的内容类型为 "binary/octet-stream"。如果需要设置特定的内容类型，可以在配置中进行设置：

CarrierWave.configure do |config|
  config.will_include_content_type = true
  config.default_content_type = 'video/mpeg'
  config.allowed_content_types = %w(video/mpeg video/mp4 video/ogg)
end

或者在上传器中设置：

class VideoUploader < CarrierWave::Uploader::Base
  include CarrierWaveDirect::Uploader

  def will_include_content_type
    true
  end

  default_content_type  'video/mpeg'
  allowed_content_types %w(video/mpeg video/mp4 video/ogg)
end

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Rails 项目中，将 carrierwave_direct 添加到 Gemfile 中：

gem 'carrierwave_direct'

然后运行 bundle install 安装依赖。

4.2 手动安装

通过以下命令手动安装 carrierwave_direct：

gem install carrierwave_direct

4.3 配置 fog

确保 fog 已正确配置，并且 CarrierWave 已初始化。参考 2.1 节中的配置示例。

---

通过以上文档，您可以快速上手 CarrierWaveDirect，并了解如何配置、使用和扩展其功能。