Contents

require 'http_accept'

module Pliny::Middleware
  class Versioning
    def initialize(app, options={})
      @app = app
      @default = options[:default] || raise("missing=default")
      @app_name = options[:app_name] || raise("missing=app_name")
    end

    def call(env)
      Pliny.log middleware: :versioning, id: env["REQUEST_ID"] do
        detect_api_version(env)
      end
    end

    private

    def detect_api_version(env)
      media_types = HTTPAccept.parse(env["HTTP_ACCEPT"])

      version = nil
      media_types.map! do |media_type|
        if accept_headers.include?(media_type.format)
          if !media_type.params["version"]
            error = { id: :bad_version, message: <<-eos }
Please specify a version along with the MIME type. For example, `Accept: application/vnd.#{@app_name}+json; version=1`.
            eos
            return [400, { "Content-Type" => "application/json; charset=utf-8" },
              [MultiJson.encode(error)]]
          end

          if !version
            version = media_type.params["version"]
          end

          # replace the MIME with a simplified version for easier
          # parsing down the stack
          media_type.format = "application/json"
          media_type.params.delete("version")
        end
        media_type.to_s
      end
      env["HTTP_ACCEPT"] = media_types.map(&:to_s).join(", ")

      version ||= @default
      set_api_version(env, version)
      @app.call(env)
    end

    def set_api_version(env, version)
      # API modules will look for the version in env
      env["HTTP_X_API_VERSION"] = version
    end

    def accept_headers
      [
        "application/vnd.#{@app_name}",
        "application/vnd.#{@app_name}+json",
        "application/*+json",
      ]
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version	Path
pliny-0.2.1	lib/pliny/middleware/versioning.rb
pliny-0.2.0	lib/pliny/middleware/versioning.rb
pliny-0.1.0	lib/pliny/middleware/versioning.rb
pliny-0.0.4	lib/pliny/middleware/versioning.rb
pliny-0.0.3	lib/pliny/middleware/versioning.rb
pliny-0.0.1	lib/pliny/middleware/versioning.rb
pliny-0.0.1.pre3	lib/pliny/middleware/versioning.rb
pliny-0.0.1.pre2	lib/pliny/middleware/versioning.rb
pliny-0.0.1.pre	lib/pliny/middleware/versioning.rb