Contents

require_relative 'base'
require_relative '../../parsers/type'

module Swaggard
  module Swagger
    module Parameters
      class Query < Base
        def initialize(string)
          @in = 'query'
          parse(string)
        end

        def to_doc
          {
            'name'          => @name,
            'in'            => @in,
            'required'      => @is_required,
          }.tap do |doc|
            doc.merge!(@type.to_doc)

            doc.merge!('enum' => @options) if @options.any?
            doc.merge!('description'   => description)
          end
        end

        private

        # Example: [Array]     status            Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
        # Example: [Array]     status(required)  Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
        # Example: [Integer]   media[media_type_id]                          ID of the desired media type.
        def parse(string)
          data_type, required, name, options_and_description = string.match(/\A\[(\S*)\](!)?\s*([\w\[\]]*)\s*(.*)\Z/).captures
          allow_multiple = name.gsub!('[]', '')

          options, description = options_and_description.match(/\A(\[.*\])?(.*)\Z/).captures
          options = options ? options.gsub(/\[?\]?\s?/, '').split(',') : []

          @name = name
          @description = description
          @type = Parsers::Type.run(data_type)
          @is_required = required.present?
          @allow_multiple = allow_multiple.present?
          @options = options
        end
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
swaggard-1.5.1	lib/swaggard/swagger/parameters/query.rb
swaggard-1.5.0	lib/swaggard/swagger/parameters/query.rb
swaggard-1.4.0	lib/swaggard/swagger/parameters/query.rb
swaggard-1.3.0	lib/swaggard/swagger/parameters/query.rb