Class: Webbed::StatusCode

Inherits:

Object

• Object
• Webbed::StatusCode

show all

Includes:

Comparable

Defined in:

lib/webbed/status_code.rb

Overview

Constant Summary

UNKNOWN_REASON_PHRASE =

'Unknown Status Code'

Instance Attribute Summary (collapse)

• - (String) default_reason_phrase readonly

  The default Reason Phrase of the Status Code.

Class Method Summary (collapse)

• + ({Fixnum => String}) default_reason_phrases

  The default Reason Phrases for Status Codes.

• + (Webbed::StatusCode) lookup(status_code)

  Looks up the registered Status Code or returns a temporary one.

• + (Webbed::StatusCode) register(status_code, default_reason_phrase)

  Registers a Status Code and its default Reason Phrase.

• + ({Fixnum => Webbed::StatusCode}) registered

  The registered Status Codes.

Instance Method Summary (collapse)

• - (Fixnum) <=>(other_status_code)

  Compares the Status Code to another Status Code.

• - (Boolean) client_error?

  Whether or not the Status Code is a client error.

• - (Boolean) error?

  Whether or not the Status Code is an error.

• - (Boolean) informational?

  Whether or not the Status Code is informational.

• - (StatusCode) initialize(status_code) constructor

  Creates a new Status Code.

• - (Boolean) redirection?

  Whether or not the Status Code is a redirection.

• - (Boolean) server_error?

  Whether or not the Status Code is a server error.

• - (Boolean) successful?

  Whether or not the Status Code is successful.

• - (Fixnum) to_i

  Converts the Status Code to an integer.

• - (String) to_s

  Converts the Status Code to a string.

• - (Boolean) unknown?

  Whether or not the Status Code is unknown.

50
51
52
53

# File 'lib/webbed/status_code.rb', line 50

def initialize(status_code)
  @status_code = status_code.to_i
  @default_reason_phrase = self.class.default_reason_phrases[@status_code] || UNKNOWN_REASON_PHRASE
end

45
46
47

# File 'lib/webbed/status_code.rb', line 45

def default_reason_phrase
  @default_reason_phrase
end

19
20
21

# File 'lib/webbed/status_code.rb', line 19

def default_reason_phrases
  @default_reason_phrases ||= {}
end

37
38
39

# File 'lib/webbed/status_code.rb', line 37

def lookup(status_code)
  registered[status_code.to_i] || new(status_code)
end

28
29
30
31

# File 'lib/webbed/status_code.rb', line 28

def register(status_code, default_reason_phrase)
  default_reason_phrases[status_code.to_i] = default_reason_phrase
  registered[status_code.to_i] = new(status_code)
end

12
13
14

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

def registered
  @registered ||= {}
end

59
60
61

# File 'lib/webbed/status_code.rb', line 59

def <=>(other_status_code)
  @status_code <=> other_status_code.to_i
end

113
114
115

# File 'lib/webbed/status_code.rb', line 113

def client_error?
  (400...500).include?(@status_code)
end

143
144
145

# File 'lib/webbed/status_code.rb', line 143

def error?
  (400...600).include?(@status_code)
end

83
84
85

# File 'lib/webbed/status_code.rb', line 83

def informational?
  (100...200).include?(@status_code)
end

103
104
105

# File 'lib/webbed/status_code.rb', line 103

def redirection?
  (300...400).include?(@status_code)
end

123
124
125

# File 'lib/webbed/status_code.rb', line 123

def server_error?
  (500...600).include?(@status_code)
end

93
94
95

# File 'lib/webbed/status_code.rb', line 93

def successful?
  (200...300).include?(@status_code)
end

66
67
68

# File 'lib/webbed/status_code.rb', line 66

def to_i
  @status_code
end

73
74
75

# File 'lib/webbed/status_code.rb', line 73

def to_s
  @status_code.to_s
end

133
134
135

# File 'lib/webbed/status_code.rb', line 133

def unknown?
  !(100...600).include?(@status_code)
end