Magickly项目技术文档

1. 安装指南

Magickly是基于Imagemagick的一个实用包装器，能够处理缓存。兼容Ruby 1.9.3、2.0和2.1版本以及jRuby（1.9模式）。Imagemagick版本需大于等于6.2.4。

安装方式如下：

$ gem install magickly

2. 项目使用说明

Magickly可以作为独立应用运行，也可以作为其他Rack应用的端点。

2.1 直接运行应用

在应用目录下执行以下命令：

# 在应用目录中:
$ gem install thin
$ thin start

应用可以通过http://localhost:3000访问。

当作为应用运行时，使用Rack::Cache来缓存生成的图像版本。缓存的文件和元数据存储在tmp/目录中，并根据需要重新生成。

2.2 在其他Rack应用中作为端点

例如，在Rails应用中将Magickly作为/magickly路径的端点：

# Gemfile
gem 'magickly', '~> 1.1'
 
# config/routes.rb
match '/magickly', to: Magickly::App, anchor: false

更多相关信息，请参考Rails路由指南或Michael Raidel的Mount Rails apps in Rails 3。

3. 项目API使用文档

以下是Magickly支持的参数和操作：

• src=*url*：原始图片的URL（必填）。
• brightness_contrast=*br.* x *con.*：亮度和对比度调整，范围为-100到100。
• flip=true：垂直翻转图片。
• flop=true：水平翻转图片。
• glow=*amount*,*softness*：添加辉光效果。
• greyscale=true：转换为灰度图。
• halftone=*threshold*：半色调效果，阈值范围0到100。
• jcn=true：应用JCN效果。
• resize=*geometry*：调整图片大小。
• rotate=*degrees*：旋转图片。
• saturation=*percentage*：调整饱和度。
• tilt_shift=true：倾斜位移效果。
• thumb=*geometry*：生成缩略图。
• two_color=true：转换为两种颜色。

4. 项目安装方式

请参考“安装指南”部分，使用以下命令安装Magickly：

$ gem install magickly