Class: Github::Response::Header

Inherits:
Struct
  • Object
show all
Includes:
Constants
Defined in:
lib/github_api/response/header.rb

Overview

Represents http response header

Constant Summary collapse

SUCCESSFUL_STATUSES = 
200..299

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::RATELIMIT_RESET, Constants::SERVER, Constants::USER_AGENT

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#env ⇒ Object

Returns the value of attribute env

Returns:

  • (Object) —

    the current value of env



7
8
9
 
# File 'lib/github_api/response/header.rb', line 7

def env
  @env
end

Instance Method Details

#[](property) ⇒ Object 



16
17
18
 
# File 'lib/github_api/response/header.rb', line 16

def [](property)
  loaded? ? env[:response_headers][property] : nil
end

#accepted_oauth_scopes ⇒ Object 



24
25
26
 
# File 'lib/github_api/response/header.rb', line 24

def accepted_oauth_scopes
  loaded? ? env[:response_headers][ACCEPTED_OAUTH_SCOPES] : nil
end

#body ⇒ Object

Returns raw body



80
81
82
 
# File 'lib/github_api/response/header.rb', line 80

def body
  loaded? ? env[:body] : nil
end

#cache_control ⇒ Object 



43
44
45
 
# File 'lib/github_api/response/header.rb', line 43

def cache_control
  loaded? ? env[:response_headers][CACHE_CONTROL] : nil
end

#content_length ⇒ Object 



51
52
53
 
# File 'lib/github_api/response/header.rb', line 51

def content_length
  loaded? ? env[:response_headers][CONTENT_LENGTH] : nil
end

#content_type ⇒ Object 



47
48
49
 
# File 'lib/github_api/response/header.rb', line 47

def content_type
  loaded? ? env[:response_headers][CONTENT_TYPE] : nil
end

#date ⇒ Object 



59
60
61
 
# File 'lib/github_api/response/header.rb', line 59

def date
  loaded? ? env[:response_headers][DATE] : nil
end

#etag ⇒ Object 



55
56
57
 
# File 'lib/github_api/response/header.rb', line 55

def etag
  loaded? ? env[:response_headers][ETAG] : nil
end

#loaded? ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/github_api/response/header.rb', line 12

def loaded?
  !!env
end

#location ⇒ Object 



63
64
65
 
# File 'lib/github_api/response/header.rb', line 63

def location
  loaded? ? env[:response_headers][LOCATION] : nil
end

#oauth_scopes ⇒ Object 



20
21
22
 
# File 'lib/github_api/response/header.rb', line 20

def oauth_scopes
  loaded? ? env[:response_headers][OAUTH_SCOPES] : nil
end

#ratelimit_limit ⇒ Object

Requests are limited to API v3 to 5000 per hour.



29
30
31
 
# File 'lib/github_api/response/header.rb', line 29

def ratelimit_limit
  loaded? ? env[:response_headers][RATELIMIT_LIMIT] : nil
end

#ratelimit_remaining ⇒ Object 



33
34
35
 
# File 'lib/github_api/response/header.rb', line 33

def ratelimit_remaining
  loaded? ? env[:response_headers][RATELIMIT_REMAINING] : nil
end

#ratelimit_reset ⇒ Object

A unix timestamp describing when the ratelimit will be reset



39
40
41
 
# File 'lib/github_api/response/header.rb', line 39

def ratelimit_reset
  loaded? ? env[:response_headers][RATELIMIT_RESET] : nil
end

#server ⇒ Object 



67
68
69
 
# File 'lib/github_api/response/header.rb', line 67

def server
  loaded? ? env[:response_headers][SERVER] : nil
end

#status ⇒ Object 



71
72
73
 
# File 'lib/github_api/response/header.rb', line 71

def status
  loaded? ? env[:status] : nil
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/github_api/response/header.rb', line 75

def success?
  SUCCESSFUL_STATUSES.include? status
end