Class: Webbed::MediaType

Inherits:

Object

• Object
• Webbed::MediaType

show all

Defined in:

lib/webbed/media_type.rb

Constant Summary

MIME_TYPE_REGEX =

Regular expression for parsing the type and subtype of a MIME type

/^([-\w.+]+)\/([-\w.+]*)$/

PARAMETERS_REGEX =

Regular expression for parsing the parameters of a Media Type

/=|\s*;\s*/

Instance Attribute Summary (collapse)

• - (Hash<String => String>) parameters

  The parameters of the Media Type.

• - (String) subtype

  The subtype of the MIME type.

• - (String) type

  The type of the MIME type.

Instance Method Summary (collapse)

• - (Boolean) ==(other_media_type)

  Compares the Media Type to another Media Type.

• - (MediaType) initialize(media_type) constructor

  Creates a new Media Type.

• - (Array<String>) interpretable_as

  The MIME types that the Media Type can be interpreted as.

• - (String) mime_type

  The MIME type of the Media Type.

• - mime_type=(new_mime_type)

  Sets the MIME type of the Media Type.

• - (String^?) suffix

  The suffix of the MIME type.

• - (String) to_s

  Converts the Media Type to a string.

• - (Boolean) vendor_specific?

  Whether or not the Media Type is vendor-specific.

media_type = Webbed::MediaType.new('text/html')
media_type.mime_type # => 'text/html'
media_type.parameters # => {}

media_type = Webbed::MediaType.new('text/html; q=1.0')
media_type.mime_type # => 'text/html'
media_type.parameters # => { 'q' => '1.0' }

56
57
58
59

# File 'lib/webbed/media_type.rb', line 56

def initialize(media_type)
  self.mime_type, *parameters = media_type.split(PARAMETERS_REGEX)
  self.parameters = Hash[*parameters] || {}
end

media_type = Webbed::MediaType.new('text/html; q=1.0')
media_type.parameters # => { 'q' => '1.0' }

35
36
37

# File 'lib/webbed/media_type.rb', line 35

def parameters
  @parameters
end

media_type = Webbed::MediaType.new('text/html')
media_type.type # => 'html'

23
24
25

# File 'lib/webbed/media_type.rb', line 23

def subtype
  @subtype
end

media_type = Webbed::MediaType.new('text/html')
media_type.type # => 'text'

12
13
14

# File 'lib/webbed/media_type.rb', line 12

def type
  @type
end

135
136
137

# File 'lib/webbed/media_type.rb', line 135

def ==(other_media_type)
  mime_type == other_media_type.mime_type
end

media_type = Webbed::MediaType.new('application/xml')
media_type.interpretable_as # ['application/xml']

media_type = Webbed::MediaType.new('application/atom+xml')
media_type.interpretable_as # => ['application/atom+xml', 'application/xml']

154
155
156
157
158
159
160

# File 'lib/webbed/media_type.rb', line 154

def interpretable_as
  if suffix
    [mime_type, "#{type}/#{suffix}"]
  else
    [mime_type]
  end
end

64
65
66

# File 'lib/webbed/media_type.rb', line 64

def mime_type
  "#{type}/#{subtype}"
end

71
72
73
74
75

# File 'lib/webbed/media_type.rb', line 71

def mime_type=(new_mime_type)
  MIME_TYPE_REGEX =~ new_mime_type
  self.type = $1
  self.subtype = $2
end

media_type = Webbed::MediaType.new('application/xml')
media_type.suffix # => nil

media_type = Webbed::MediaType.new('application/atom+xml')
media_type.suffix # => 'xml'

119
120
121
122
123
124
125
126
127

# File 'lib/webbed/media_type.rb', line 119

def suffix
  suffix = subtype.split('+')[-1]
  
  if suffix != subtype
    suffix
  else
    nil
  end
end

80
81
82
83
84
85
86
87

# File 'lib/webbed/media_type.rb', line 80

def to_s
  if parameters.empty?
    mime_type
  else
    parameters = self.parameters.map { |k, v| "#{k}=#{v}" }.join('; ')
    "#{mime_type}; #{parameters}"
  end
end

media_type = Webbed::MediaType.new('application/json')
media_type.vendor_specific? # => false

media_type = Webbed::MediaType.new('application/vnd.my-special-type')
media_type.vendor_specific? # => true

102
103
104

# File 'lib/webbed/media_type.rb', line 102

def vendor_specific?
  subtype[0..3] == 'vnd.'
end