imgix-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57076ae3e45e23986cf73972ab57e6f1ea9c3c4a
+  data.tar.gz: 1f557d144e7cba2b5e2ed80f37a9fad560594604
+SHA512:
+  metadata.gz: b08a5cfa44532e6e8269326506fe0b42e013b90ad6c65e667b57713931cefe35e65d81ca4cef10f56f0d74b2ed9df71749016b056c6e29872b862a0be40cb05a
+  data.tar.gz: c4f19d240009a659fb66ea47ad49347ea2548729353b7223ccaa9b5cf9b47d82809c36cb3ff55a6f361417c6652a3dbf47cb345478b3701f2c8e8a2fd04b41fb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in imgix-rails.gemspec
+gemspec

data/README.md

@@ -0,0 +1,157 @@
+# imgix-rails
+
+[![Build Status](https://travis-ci.org/imgix/imgix-rails.png?branch=master)](https://travis-ci.org/imgix/imgix-rails)
+
+`imgix-rails` is a gem designed to make integrating imgix into your Rails app easier. It builds on [imgix-rb](https://github.com/imgix/imgix-rb) to offer a few Rails-specific interfaces.
+
+imgix is a real-time image processing service and CDN. It allows you to manipulate images merely by changing their URL parameters. For a full list of URL parameters, please see the [imgix URL API documentation](https://www.imgix.com/docs/reference).
+
+We recommend using something like [Paperclip](https://github.com/thoughtbot/paperclip), [Carrierwave](https://github.com/carrierwaveuploader/carrierwave), or [s3_direct_upload](https://github.com/waynehoover/s3_direct_upload) to handle uploads and then serving the images out using this gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'imgix-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+imgix-rails provides a few different hooks to work with your existing Rails application. All current methods are drop-in replacements for the `image_tag` helper.
+
+### Configuration
+
+Before you get started, you will need to define your imgix configuration in your `config/application.rb`, or in an environment-specific configuration file.
+
+```ruby
+Rails.application.configure do
+  config.imgix = {
+    source: "Name of your source, e.g. assets.imgix.net",
+    secure_url_token: "optional secure URL token found in your dashboard (https://webapp.imgix.com)"
+  }
+end
+```
+
+### ix_image_tag
+
+The simplest way of working with imgix-rails is to use the `ix_image_tag`, this allows you to pass parameters to imgix to handle things like resizing, cropping, etc.
+
+```erb
+<%= ix_image_tag('/path/to/image.jpg', { w: 400, h: 300 }) %>
+```
+
+Will render out HTML like the following:
+
+```html
+<img src="https://assets.imgix.net/path/to/image?w=400&h=300" />
+```
+
+We recommend leveraging this to generate powerful helpers within your application like the following:
+
+```ruby
+def profile_image_tag(user)
+  ix_image_tag(user.profile_image_url, { w: 100, h: 200, fit: 'crop' })
+end
+```
+
+Then rendering the portrait in your application is very easy:
+
+```erb
+<%= profile_image_tag(@user) %>
+```
+
+### ix_responsive_image_tag
+
+The `ix_responsive_image_tag` helper method makes it easy to bring responsive imagery to your Rails app. We talk a bit about using the `srcset` attribute in an application in the following blog post: [“Responsive Images with `srcset` and imgix.”](http://blog.imgix.com/post/127012184664/responsive-images-with-srcset-imgix)
+
+The `ix_responsive_image_tag` will generate an `<img>` element with a filled-out `srcset` attribute that leans on imgix to do the hard work.
+
+It will use the configured device-pixel-ratios in the `config.imgix[:responsive_resolutions]` value. It will default to `[1, 2]`.
+
+```erb
+<%= ix_responsive_image_tag('/users/1/avatar.png', { w: 400, h: 300 }) %>
+```
+
+This will generate the following HTML:
+
+```html
+<img
+  srcset="https://assets.imgix.net/users/1/avatar.png?w=400&h=300 1x,
+          https://assets.imgix.net/users/1/avatar.png?w=400&h=300&dpr=2 2x"
+  src="https://assets.imgix.net/users/1/avatar.png?w=400&h=300"
+/>
+```
+
+### ix_picture_tag
+
+The `ix_picture_tag` helper method makes it easy to generate `<picture>` elements in your Rails app.
+
+The `ix_picture_tag` method will generate a `<picture>` element with a single `<source>` element and a fallback `<img>` element. We are open for new directions to take this in.
+
+It will use the configured device-pixel-ratios in the `config.imgix[:responsive_resolutions]` value. It will default to `[1, 2]`.
+
+```erb
+<%= ix_picture_tag('/users/1/avatar.png', { w: 400, h: 300 }) %>
+```
+
+Will generate the following HTML:
+
+```html
+<picture>
+  <source srcset="https://assets.imgix.net/users/1/avatar.png?w=400&h=300 1x,
+                  https://assets.imgix.net/users/1/avatar.png?w=400&h=300&dpr=2 2x" />
+  <img src="https://assets.imgix.net/users/1/avatar.png?w=400&h=300" />
+</picture>
+```
+
+### Hostname Removal
+
+You can also configure imgix-rails to disregard given hostnames and only use the path component from given URLs. This is useful if you have [a Web Folder or an Amazon S3 imgix Source configured](https://www.imgix.com/docs/tutorials/creating-sources) but store the fully-qualified URLs for those resources in your database.
+
+For example, let's say you are using S3 for storage. An `#avatar_url` value might look like the following in your application:
+
+```ruby
+@user.avatar_url #=> "https://s3.amazonaws.com/my-bucket/users/1.png"
+```
+
+You would then configure imgix in your Rails application to disregard the `'s3.amazonaws.com'` hostname:
+
+```ruby
+Rails.application.configure do
+  config.imgix = {
+    source: "my-imgix-source.imgix.net",
+    hostname_to_replace: "s3.amazonaws.com"
+  }
+end
+```
+
+Now when you call `ix_image_tag` or another helper, you get an imgix URL:
+
+```erb
+<%= ix_image_tag(@user.avatar_url) %>
+```
+
+Renders:
+
+```html
+<img src="https://my-imgix-source.imgix.net/my-bucket/users/1.png" />
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/imgix-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "imgix/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/imgix-rails.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imgix/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imgix-rails"
+  spec.version       = Imgix::Rails::VERSION
+  spec.authors       = ["Kelly Sutton"]
+  spec.email         = ["kelly@imgix.com"]
+
+  spec.summary       = %q{Makes integrating imgix into your Rails app easier. It builds on imgix-rb to offer a few Rails-specific interfaces.}
+  spec.description   = %q{Makes integrating imgix into your Rails app easier. It builds on imgix-rb to offer a few Rails-specific interfaces.}
+  spec.homepage      = "https://github.com/imgix/imgix-rails"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "imgix", '~> 0.3', '>= 0.3.5'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+end

data/lib/imgix/rails.rb

@@ -0,0 +1,21 @@
+require "imgix/rails/version"
+
+if defined? Rails::Railtie
+  require "imgix/railtie"
+end
+
+require "active_support"
+
+module Imgix
+  module Rails
+    class Config < ::ActiveSupport::OrderedOptions; end
+
+    def self.config
+      @@config ||= Config.new
+    end
+
+    def self.configure
+      yield self.config
+    end
+  end
+end

data/lib/imgix/rails/version.rb

@@ -0,0 +1,5 @@
+module Imgix
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/imgix/rails/view_helper.rb

@@ -0,0 +1,105 @@
+require "imgix"
+
+module Imgix
+  module Rails
+    class ConfigurationError < StandardError; end
+
+    module ViewHelper
+      def ix_image_tag(source, options={})
+        validate_configuration!
+
+        source = replace_hostname(source)
+        normal_opts = options.slice!(*available_parameters)
+
+        image_tag(client.path(source).to_url(options).html_safe, normal_opts)
+      end
+
+      def ix_responsive_image_tag(source, options={})
+        options.merge!({
+          srcset: srcset_for(source, options)
+        })
+
+        ix_image_tag(source, options)
+      end
+
+      def ix_picture_tag(source, options={})
+        content_tag(:picture) do
+          concat(tag(:source, srcset: srcset_for(source, options)))
+          concat(ix_image_tag(source, options))
+        end
+      end
+
+    private
+
+      def validate_configuration!
+        imgix = ::Imgix::Rails.config.imgix
+        unless imgix.try(:[], :source)
+          raise ConfigurationError.new("imgix source is not configured. Please set config.imgix[:source].")
+        end
+
+        unless imgix[:source].is_a?(Array) || imgix[:source].is_a?(String)
+          raise ConfigurationError.new("imgix source must be a String or an Array.")
+        end
+      end
+
+      def replace_hostname(source)
+        new_source = source.dup
+
+        # Replace any hostnames configured to trim things down just to their paths.
+        # We use split to remove the protocol in the process.
+        hostnames_to_remove.each do |hostname|
+          splits = source.split(hostname)
+          new_source = splits.last if splits.size > 1
+        end
+
+        new_source
+      end
+
+      def client
+        return @client if @client
+        imgix = ::Imgix::Rails.config.imgix
+
+        opts = {
+          host: imgix[:source],
+          library_param: "rails",
+          library_version: Imgix::Rails::VERSION
+        }
+
+        if imgix[:secure_url_token].present?
+          opts[:token] = imgix[:secure_url_token]
+        end
+
+        if imgix.has_key?(:include_library_param)
+          opts[:include_library_param] = imgix[:include_library_param]
+        end
+
+        @client = ::Imgix::Client.new(opts)
+      end
+
+      def available_parameters
+        @available_parameters ||= parameters.keys
+      end
+
+      def parameters
+        path = File.expand_path("../../../../vendor/parameters.json", __FILE__)
+        @parameters ||= JSON.parse(File.read(path), symbolize_names: true)[:parameters]
+      end
+
+      def srcset_for(source, options={})
+        configured_resolutions.map do |resolution|
+          srcset_options = options.slice(*available_parameters)
+          srcset_options[:dpr] = resolution unless resolution == 1
+          client.path(source).to_url(srcset_options) + " #{resolution}x"
+        end.join(', ')
+      end
+
+      def configured_resolutions
+        ::Imgix::Rails.config.imgix[:responsive_resolutions] || [1, 2]
+      end
+
+      def hostnames_to_remove
+        Array(::Imgix::Rails.config.imgix[:hostname_to_replace] || ::Imgix::Rails.config.imgix[:hostnames_to_replace])
+      end
+    end
+  end
+end

data/lib/imgix/railtie.rb

@@ -0,0 +1,20 @@
+require "rails"
+require "rails/railtie"
+require "imgix/rails"
+require "imgix/rails/view_helper"
+
+module Imgix
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.imgix = ActiveSupport::OrderedOptions.new
+
+      initializer "imgix-rails.view_helper" do |app|
+        Imgix::Rails.configure do |config|
+          config.imgix = app.config.imgix
+        end
+
+        ActionView::Base.send :include, ViewHelper
+      end
+    end
+  end
+end

data/vendor/parameters.json

@@ -0,0 +1,1145 @@
+{
+	"parameters": {
+		"auto": {
+			"display_name": "auto features",
+			"category": "automatic",
+			"expects": "list",
+			"possible_values": [
+				"enhance",
+				"format",
+				"redeye"
+			],
+			"url": "https://www.imgix.com/docs/reference/automatic#param-auto",
+			"short_description": "Applies automatic enhancements to images."
+		},
+		"ba": {
+			"display_name": "blend align",
+			"category": "blend",
+			"expects": "list",
+			"possible_values": [
+				"top",
+				"bottom",
+				"left",
+				"right",
+				"middle"
+			],
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendalign",
+			"short_description": "Changes the blend alignment relative to the parent image."
+		},
+		"balph": {
+			"display_name": "blend alpha",
+			"category": "blend",
+			"expects": "number",
+			"default": 100,
+			"min": 0,
+			"max": 100,
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendalpha",
+			"short_description": "Changes the alpha of the blend image."
+		},
+		"bc": {
+			"display_name": "blend crop",
+			"category": "blend",
+			"expects": "list",
+			"possible_values": [
+				"top",
+				"bottom",
+				"left",
+				"right",
+				"faces"
+			],
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendcrop",
+			"short_description": "Specifies the type of crop for blend images."
+		},
+		"bf": {
+			"display_name": "blend fit",
+			"category": "blend",
+			"expects": "string",
+			"default": "clip",
+			"possible_values": [
+				"clamp",
+				"clip",
+				"crop",
+				"scale",
+				"max"
+			],
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendfit",
+			"short_description": "Specifies the fit mode for blend images."
+		},
+		"bg": {
+			"display_name": "background color",
+			"category": "background",
+			"expects": "hex_color",
+			"default": "fff",
+			"url": "https://www.imgix.com/docs/reference/background#param-bg",
+			"short_description": "Colors the background of padded images."
+		},
+		"bh": {
+			"display_name": "blend height",
+			"category": "blend",
+			"expects": "number",
+			"min": 0,
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendheight",
+			"short_description": "Adjusts the height of the blend image."
+		},
+		"blend": {
+			"display_name": "blend",
+			"category": "blend",
+			"expects": [
+				"hex_color",
+				"url"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blend",
+			"short_description": "Specifies the location of the blend image."
+		},
+		"blur": {
+			"display_name": "blur",
+			"category": "stylize",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"max": 2000,
+			"url": "https://www.imgix.com/docs/reference/stylize#param-blur",
+			"short_description": "Applies a gaussian blur to an image."
+		},
+		"bm": {
+			"display_name": "blend mode",
+			"category": "blend",
+			"expects": "string",
+			"default": "overlay",
+			"possible_values": [
+				"color",
+				"burn",
+				"dodge",
+				"darken",
+				"difference",
+				"exclusion",
+				"hardlight",
+				"hue",
+				"lighten",
+				"luminosity",
+				"multiply",
+				"overlay",
+				"saturation",
+				"screen",
+				"softlight"
+			],
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendmode",
+			"short_description": "Sets the blend mode for a blend image."
+		},
+		"border": {
+			"display_name": "border",
+			"category": "border_and_padding",
+			"expects": "list",
+			"length": 2,
+			"url": "https://www.imgix.com/docs/reference/border-padding#param-border",
+			"short_description": "Applies a border to an image."
+		},
+		"bp": {
+			"display_name": "blend padding",
+			"category": "blend",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendpadding",
+			"short_description": "Applies padding to the blend image."
+		},
+		"bri": {
+			"display_name": "brightness",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-bri",
+			"short_description": "Adjusts the brightness of the source image."
+		},
+		"bs": {
+			"display_name": "blend size",
+			"category": "blend",
+			"expects": "string",
+			"possible_values": [
+				"inherit"
+			],
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendsize",
+			"short_description": "Adjusts the size of the blend image."
+		},
+		"bw": {
+			"display_name": "blend width",
+			"category": "blend",
+			"expects": "number",
+			"min": 0,
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendwidth",
+			"short_description": "Adjusts the width of the blend image."
+		},
+		"bx": {
+			"display_name": "blend x",
+			"category": "blend",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendx",
+			"short_description": "Adjusts the x-offset of the blend image relative to its parent."
+		},
+		"by": {
+			"display_name": "blend y",
+			"category": "blend",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"depends": [
+				"blend"
+			],
+			"url": "https://www.imgix.com/docs/reference/blend#param-blendy",
+			"short_description": "Adjusts the y-offset of the blend image relative to its parent."
+		},
+		"chromasub": {
+			"display_name": "chroma subsampling",
+			"category": "format",
+			"expects": "integer",
+			"default": 420,
+			"possible_values": [
+				444,
+				422,
+				420
+			],
+			"url": "https://www.imgix.com/docs/reference/format#param-chromasub",
+			"short_description": "Specifies the output chroma subsampling rate."
+		},
+		"colorquant": {
+			"display_name": "color quantization",
+			"category": "format",
+			"expects": "integer",
+			"min": 2,
+			"max": 256,
+			"url": "https://www.imgix.com/docs/reference/format#param-colorquant",
+			"short_description": "Limits the number of unique colors in an image."
+		},
+		"colors": {
+			"display_name": "color count",
+			"category": "palette",
+			"expects": "integer",
+			"default": 6,
+			"min": 0,
+			"max": 16,
+			"depends": [
+				"palette"
+			],
+			"url": "https://www.imgix.com/docs/reference/palette#param-colors",
+			"short_description": "Specifies how many colors to include in a palette-extraction response."
+		},
+		"con": {
+			"display_name": "contrast",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-con",
+			"short_description": "Adjusts the contrast of the source image."
+		},
+		"crop": {
+			"display_name": "crop mode",
+			"category": "size",
+			"expects": "list",
+			"possible_values": [
+				"top",
+				"bottom",
+				"left",
+				"right",
+				"faces"
+			],
+			"depends": [
+				"fit=crop"
+			],
+			"url": "https://www.imgix.com/docs/reference/size#param-crop",
+			"short_description": "Specifies how to crop an image."
+		},
+		"cs": {
+			"display_name": "colorspace",
+			"category": "format",
+			"expects": "string",
+			"possible_values": [
+				"srgb",
+				"adobergb1998"
+			],
+			"short_description": "Specifies the color space of the output image."
+		},
+		"dl": {
+			"display_name": "download",
+			"category": "format",
+			"expects": "string",
+			"url": "https://www.imgix.com/docs/reference/format#param-dl",
+			"short_description": "Marks a URL should use send-file to deliver its response."
+		},
+		"dpr": {
+			"display_name": "device pixel ratio",
+			"category": "pixel_density",
+			"expects": "number",
+			"default": 1,
+			"min": 0.75,
+			"max": 8,
+			"url": "https://www.imgix.com/docs/reference/pixeldensity#param-dpr",
+			"short_description": "Adjusts the device-pixel-ratio of the output image."
+		},
+		"exp": {
+			"display_name": "exposure",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-exp",
+			"short_description": "Adjusts the exposure of the output image."
+		},
+		"faceindex": {
+			"display_name": "face index",
+			"category": "face_detection",
+			"expects": "integer",
+			"min": 1,
+			"url": "https://www.imgix.com/docs/reference/face-detection#param-faceindex",
+			"short_description": "Selects a face to crop to."
+		},
+		"facepad": {
+			"display_name": "face padding",
+			"category": "face_detection",
+			"expects": "number",
+			"default": 1,
+			"min": 0,
+			"url": "https://www.imgix.com/docs/reference/face-detection#param-facepad",
+			"short_description": "Adjusts padding around a selected face."
+		},
+		"fit": {
+			"display_name": "fit mode",
+			"category": "size",
+			"expects": "string",
+			"default": "clip",
+			"possible_values": [
+				"clamp",
+				"clip",
+				"crop",
+				"facearea",
+				"fill",
+				"max",
+				"min",
+				"scale"
+			],
+			"aliases": [
+				"f"
+			],
+			"url": "https://www.imgix.com/docs/reference/size#param-fit",
+			"short_description": "Specifies how to map the source image to the output image dimensions."
+		},
+		"flip": {
+			"display_name": "flip direction",
+			"category": "rotation",
+			"expects": "string",
+			"possible_values": [
+				"h",
+				"v",
+				"hv"
+			],
+			"url": "https://www.imgix.com/docs/reference/rotation#param-flip",
+			"short_description": "Flips an image on a specified axis."
+		},
+		"fm": {
+			"display_name": "output format",
+			"category": "format",
+			"expects": "string",
+			"possible_values": [
+				"gif",
+				"jpg",
+				"jp2",
+				"json",
+				"jxr",
+				"pjpg",
+				"mp4",
+				"png",
+				"png8",
+				"png32",
+				"webp"
+			],
+			"url": "https://www.imgix.com/docs/reference/format#param-fm",
+			"short_description": "Changes the format of the output image."
+		},
+		"gam": {
+			"display_name": "gamma",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-gam",
+			"short_description": "Adjusts the gamma of the source image."
+		},
+		"h": {
+			"display_name": "height",
+			"category": "size",
+			"expects": [
+				"number",
+				"unit_scalar"
+			],
+			"url": "https://www.imgix.com/docs/reference/size#param-h",
+			"short_description": "Adjusts the height of the output image."
+		},
+		"high": {
+			"display_name": "high",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-high",
+			"short_description": "Adjusts the highlights of the source image."
+		},
+		"htn": {
+			"display_name": "halftone",
+			"category": "stylize",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/stylize#param-htn",
+			"short_description": "Applies a half-tone effect to the source image."
+		},
+		"hue": {
+			"display_name": "hue shift",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"max": 360,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-hue",
+			"short_description": "Adjusts the hue of the source image."
+		},
+		"invert": {
+			"display_name": "invert",
+			"category": "adjustment",
+			"expects": "string",
+			"possible_values": [
+				"true"
+			],
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-invert",
+			"short_description": "Inverts the colors on the source image."
+		},
+		"lossless": {
+			"display_name": "lossless",
+			"category": "format",
+			"expects": "integer",
+			"default": 0,
+			"possible_values": [
+				0,
+				1
+			],
+			"url": "https://www.imgix.com/docs/reference/format#param-fm",
+			"short_description": "Specifies that the output image should be a lossless variant."
+		},
+		"mark": {
+			"display_name": "watermark image",
+			"category": "watermark",
+			"expects": "url",
+			"aliases": [
+				"m"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-mark",
+			"short_description": "Specifies the location of the watermark image."
+		},
+		"markalign": {
+			"display_name": "watermark alignment mode",
+			"category": "watermark",
+			"expects": "list",
+			"possible_values": [
+				"top",
+				"middle",
+				"bottom",
+				"left",
+				"center",
+				"right"
+			],
+			"aliases": [
+				"ma"
+			],
+			"depends": [
+				"mark"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-markalign",
+			"short_description": "Changes the watermark alignment relative to the parent image."
+		},
+		"markalpha": {
+			"display_name": "watermark alpha",
+			"category": "watermark",
+			"expects": "integer",
+			"default": 100,
+			"min": 0,
+			"max": 100,
+			"depends": [
+				"mark"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-markalpha",
+			"short_description": "Changes the alpha of the watermark image."
+		},
+		"markbase": {
+			"display_name": "watermark url base",
+			"category": "watermark",
+			"expects": "url",
+			"aliases": [
+				"mb"
+			],
+			"depends": [
+				"mark"
+			],
+			"short_description": "Changes base URL of the watermark image."
+		},
+		"markfit": {
+			"display_name": "watermark fit mode",
+			"category": "watermark",
+			"expects": "string",
+			"default": "clip",
+			"possible_values": [
+				"clip",
+				"crop",
+				"fill",
+				"max",
+				"scale"
+			],
+			"aliases": [
+				"mf"
+			],
+			"depends": [
+				"mark",
+				"markw",
+				"markh"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-markfit",
+			"short_description": "Specifies the fit mode for watermark images."
+		},
+		"markh": {
+			"display_name": "watermark height",
+			"category": "watermark",
+			"expects": [
+				"number",
+				"unit_scalar"
+			],
+			"aliases": [
+				"mh"
+			],
+			"depends": [
+				"mark"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-markh",
+			"short_description": "Adjusts the height of the watermark image."
+		},
+		"markpad": {
+			"display_name": "watermark padding",
+			"category": "watermark",
+			"expects": "number",
+			"default": 10,
+			"aliases": [
+				"mp"
+			],
+			"depends": [
+				"mark"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-markpad",
+			"short_description": "Applies padding to the watermark image."
+		},
+		"markscale": {
+			"display_name": "watermark scale",
+			"category": "watermark",
+			"expects": "number",
+			"min": 0,
+			"max": 100,
+			"aliases": [
+				"ms"
+			],
+			"depends": [
+				"mark"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-markscale",
+			"short_description": "Adjusts the scale of the watermark image."
+		},
+		"markw": {
+			"display_name": "watermark width",
+			"category": "watermark",
+			"expects": [
+				"number",
+				"unit_scalar"
+			],
+			"aliases": [
+				"mw"
+			],
+			"depends": [
+				"mark"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-markw",
+			"short_description": "Adjusts the width of the watermark image."
+		},
+		"markx": {
+			"display_name": "watermark x-position",
+			"category": "watermark",
+			"expects": "integer",
+			"aliases": [
+				"mx"
+			],
+			"depends": [
+				"mark"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-markx",
+			"short_description": "Adjusts the x-offset of the watermark image relative to its parent."
+		},
+		"marky": {
+			"display_name": "watermark y-position",
+			"category": "watermark",
+			"expects": "integer",
+			"aliases": [
+				"my"
+			],
+			"depends": [
+				"mark"
+			],
+			"url": "https://www.imgix.com/docs/reference/watermark#param-marky",
+			"short_description": "Adjusts the y-offset of the watermark image relative to its parent."
+		},
+		"mask": {
+			"display_name": "mask",
+			"category": "mask",
+			"expects": [
+				"string",
+				"url"
+			],
+			"possible_values": [
+				"ellipse"
+			],
+			"url": "https://www.imgix.com/docs/reference/mask#param-mask",
+			"short_description": "Specifies the location of the mask image."
+		},
+		"mono": {
+			"display_name": "monochrome",
+			"category": "stylize",
+			"expects": "hex_color",
+			"aliases": [
+				"monochrome"
+			],
+			"url": "https://www.imgix.com/docs/reference/stylize#param-mono",
+			"short_description": "Applies a monochrome effect to the source image."
+		},
+		"nr": {
+			"display_name": "noise blur",
+			"category": "noise",
+			"expects": "number",
+			"default": 20,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/noise#param-nr",
+			"short_description": "Reduces the noise in an image."
+		},
+		"nrs": {
+			"display_name": "noise sharpen",
+			"category": "noise",
+			"expects": "number",
+			"default": 20,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/noise#param-nrs",
+			"short_description": "Provides a threshold by which to sharpen an image."
+		},
+		"or": {
+			"display_name": "orientation",
+			"category": "rotation",
+			"expects": "integer",
+			"possible_values": [
+				0,
+				1,
+				2,
+				3,
+				4,
+				5,
+				6,
+				7,
+				8,
+				90,
+				180,
+				270
+			],
+			"aliases": [
+				"orient"
+			],
+			"url": "https://www.imgix.com/docs/reference/rotation#param-or",
+			"short_description": "Changes the image orientation."
+		},
+		"pad": {
+			"display_name": "padding",
+			"category": "border_and_padding",
+			"expects": "integer",
+			"default": 0,
+			"min": 0,
+			"url": "https://www.imgix.com/docs/reference/border-padding#param-pad",
+			"short_description": "Pads an image."
+		},
+		"page": {
+			"display_name": "pdf page number",
+			"category": "pdf",
+			"expects": "integer",
+			"default": 1,
+			"min": 1,
+			"url": "https://www.imgix.com/docs/reference/pdf#param-page",
+			"short_description": "Selects a page from a PDF for display."
+		},
+		"palette": {
+			"display_name": "palette extraction",
+			"category": "palette",
+			"expects": "string",
+			"possible_values": [
+				"css",
+				"json"
+			],
+			"url": "https://www.imgix.com/docs/reference/palette#param-palette",
+			"short_description": "Specifies an output format for palette-extraction."
+		},
+		"prefix": {
+			"display_name": "css prefix",
+			"category": "palette",
+			"expects": "string",
+			"default": "image",
+			"depends": [
+				"palette=css"
+			],
+			"url": "https://www.imgix.com/docs/reference/palette#param-prefix",
+			"short_description": "Specifies a CSS prefix for all classes in palette-extraction."
+		},
+		"px": {
+			"display_name": "pixellate",
+			"category": "stylize",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/stylize#param-px",
+			"short_description": "Applies a pixelation effect to an image."
+		},
+		"q": {
+			"display_name": "output quality",
+			"category": "format",
+			"expects": "number",
+			"default": 75,
+			"min": 0,
+			"max": 100,
+			"depends": [
+				"fm=jpg",
+				"fm=pjpg",
+				"fm=webp",
+				"fm=jxr"
+			],
+			"url": "https://www.imgix.com/docs/reference/format#param-q",
+			"short_description": "Adjusts the quality of an output image."
+		},
+		"rect": {
+			"display_name": "crop rectangle",
+			"category": "size",
+			"expects": "rectangle",
+			"url": "https://www.imgix.com/docs/reference/size#param-rect",
+			"short_description": "Crops an image to a specified rectangle."
+		},
+		"rot": {
+			"display_name": "rotation angle",
+			"category": "rotation",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"max": 359,
+			"url": "https://www.imgix.com/docs/reference/rotation#param-rot",
+			"short_description": "Rotates an image by a specified number of degrees."
+		},
+		"sat": {
+			"display_name": "saturation",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-sat",
+			"short_description": "Adjusts the saturation of an image."
+		},
+		"sepia": {
+			"display_name": "sepia",
+			"category": "stylize",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/stylize#param-sepia",
+			"short_description": "Applies a sepia effect to an image."
+		},
+		"shad": {
+			"display_name": "shadow",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-shad",
+			"short_description": "Adjusts the highlights of the source image."
+		},
+		"sharp": {
+			"display_name": "sharpen",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-sharp",
+			"short_description": "Adjusts the sharpness of the source image."
+		},
+		"trim": {
+			"display_name": "trim mode",
+			"category": "trim",
+			"expects": "string",
+			"possible_values": [
+				"auto",
+				"color"
+			],
+			"url": "https://www.imgix.com/docs/reference/trim#param-trim",
+			"short_description": "Trims the source image."
+		},
+		"trimcol": {
+			"display_name": "trim color",
+			"category": "trim",
+			"expects": "hex_color",
+			"depends": [
+				"trim=color"
+			],
+			"url": "https://www.imgix.com/docs/reference/trim#param-trimcolor",
+			"short_description": "Specifies a trim color on a trim operation."
+		},
+		"trimmd": {
+			"display_name": "trim mean difference",
+			"category": "trim",
+			"expects": "number",
+			"default": 11,
+			"depends": [
+				"trim=auto"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-trimmd",
+			"short_description": "Specifies the mean difference on a trim operation."
+		},
+		"trimsd": {
+			"display_name": "trim standard deviation",
+			"category": "trim",
+			"expects": "number",
+			"default": 10,
+			"depends": [
+				"trim=auto"
+			],
+			"url": "https://www.imgix.com/docs/reference/trim#param-trimsd",
+			"short_description": "Specifies the standard deviation on a trim operation."
+		},
+		"trimtol": {
+			"display_name": "trim tolerance",
+			"category": "trim",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"depends": [
+				"trim=color"
+			],
+			"url": "https://www.imgix.com/docs/reference/trim#param-trimtol",
+			"short_description": "Specifies the tolerance on a trim operation."
+		},
+		"txt": {
+			"display_name": "text",
+			"category": "text",
+			"expects": "string",
+			"aliases": [
+				"t"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txt",
+			"short_description": "Sets the text to render."
+		},
+		"txtalign": {
+			"display_name": "text align",
+			"category": "text",
+			"expects": "list",
+			"possible_values": [
+				"top",
+				"middle",
+				"bottom",
+				"left",
+				"center",
+				"right"
+			],
+			"aliases": [
+				"ta"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtalign",
+			"short_description": "Sets the alignment of rendered text."
+		},
+		"txtclip": {
+			"display_name": "text clipping",
+			"category": "text",
+			"expects": "string",
+			"default": "end",
+			"possible_values": [
+				"start",
+				"middle",
+				"end"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtclip",
+			"short_description": "Sets the clipping properties of rendered text."
+		},
+		"txtclr": {
+			"display_name": "text color",
+			"category": "text",
+			"expects": "hex_color",
+			"aliases": [
+				"txtclr",
+				"tc"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtclr",
+			"short_description": "Specifies the color of rendered text"
+		},
+		"txtfit": {
+			"display_name": "text fit mode",
+			"category": "text",
+			"expects": "string",
+			"possible_values": [
+				"max"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtfit",
+			"short_description": "Specifies the fit approach for rendered text."
+		},
+		"txtfont": {
+			"display_name": "text font",
+			"category": "text",
+			"expects": "list",
+			"aliases": [
+				"tf"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtfont",
+			"short_description": "Selects a font for rendered text."
+		},
+		"txtline": {
+			"display_name": "text outline",
+			"category": "text",
+			"expects": "number",
+			"default": 0,
+			"min": 0,
+			"aliases": [
+				"tl"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtline",
+			"short_description": "Outlines the rendered text with a specified color."
+		},
+		"txtlineclr": {
+			"display_name": "text outline color",
+			"category": "text",
+			"expects": "hex_color",
+			"default": "FFF",
+			"depends": [
+				"txt",
+				"txtline"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtlineclr",
+			"short_description": "Specifies a text outline color."
+		},
+		"txtpad": {
+			"display_name": "text padding",
+			"category": "text",
+			"expects": "number",
+			"default": 10,
+			"aliases": [
+				"tp"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtpad",
+			"short_description": "Specifies padding for rendered text."
+		},
+		"txtshad": {
+			"display_name": "text shadow",
+			"category": "text",
+			"expects": "number",
+			"default": 0,
+			"aliases": [
+				"tsh"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtshad",
+			"short_description": "Applies a shadow to rendered text."
+		},
+		"txtsize": {
+			"display_name": "text font size",
+			"category": "text",
+			"expects": "number",
+			"default": 12,
+			"min": 0,
+			"aliases": [
+				"tsz"
+			],
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtsize",
+			"short_description": "Sets the size of rendered text."
+		},
+		"txtwidth": {
+			"display_name": "text width",
+			"category": "text",
+			"expects": "number",
+			"min": 0,
+			"depends": [
+				"txt"
+			],
+			"url": "https://www.imgix.com/docs/reference/text#param-txtwidth",
+			"short_description": "Sets the width of rendered text."
+		},
+		"usm": {
+			"display_name": "unsharp mask",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-usm",
+			"short_description": "Sharpens the source image using an unsharp mask."
+		},
+		"usmrad": {
+			"display_name": "unsharp mask radius",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 2.5,
+			"min": 0,
+			"depends": [
+				"usm"
+			],
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-usmrad",
+			"short_description": "Specifies the radius for an unsharp mask operation."
+		},
+		"vib": {
+			"display_name": "vibrance",
+			"category": "adjustment",
+			"expects": "number",
+			"default": 0,
+			"min": -100,
+			"max": 100,
+			"url": "https://www.imgix.com/docs/reference/adjustment#param-vib",
+			"short_description": "Adjusts the vibrance an image."
+		},
+		"w": {
+			"display_name": "width",
+			"category": "size",
+			"expects": [
+				"number",
+				"unit_scalar"
+			],
+			"url": "https://www.imgix.com/docs/reference/size#param-w",
+			"short_description": "Adjusts the width of the output image."
+		}
+	},
+	"deprecatedParameters": {
+		"class": {
+			"display_name": "css class",
+			"category": "palette",
+			"expects": "string",
+			"deprecated": true,
+			"url": "https://www.imgix.com/docs/reference/palette#param-colors",
+			"short_description": "Specifies the CSS class to use for palette extraction."
+		}
+	},
+	"experimentalParameters": {
+		"rott": {
+			"display_name": "rotation type",
+			"category": "rotation",
+			"expects": "string",
+			"possible_values": [
+				"pivot",
+				"straighten"
+			],
+			"experimental": true,
+			"short_description": "Changes the rotation type."
+		},
+		"skin": {
+			"display_name": "skin detection",
+			"category": "misc",
+			"expects": "string",
+			"possible_values": [
+				"map"
+			],
+			"experimental": true,
+			"deprectated": true
+		}
+	},
+	"aliases": {
+		"f": "fit",
+		"m": "mark",
+		"ma": "markalign",
+		"mb": "markbase",
+		"mf": "markfit",
+		"mh": "markh",
+		"mp": "markpad",
+		"ms": "markscale",
+		"mw": "markw",
+		"mx": "markx",
+		"my": "marky",
+		"monochrome": "mono",
+		"orient": "or",
+		"t": "txt",
+		"ta": "txtalign",
+		"txtclr": "txtclr",
+		"tc": "txtclr",
+		"tf": "txtfont",
+		"tl": "txtline",
+		"tp": "txtpad",
+		"tsh": "txtshad",
+		"tsz": "txtsize"
+	}
+}