class Github::Response::Header

Represents http response header

Constants

SUCCESSFUL_STATUSES

Public Instance Methods

accepted_oauth_scopes() click to toggle source
# File lib/github_api/response/header.rb, line 19
def accepted_oauth_scopes
  loaded? ? env[:response_headers][ACCEPTED_OAUTH_SCOPES] : nil
end
body() click to toggle source

Returns raw body

# File lib/github_api/response/header.rb, line 75
def body
  loaded? ? env[:body] : nil
end
cache_control() click to toggle source
# File lib/github_api/response/header.rb, line 38
def cache_control
  loaded? ? env[:response_headers][CACHE_CONTROL] : nil
end
content_length() click to toggle source
# File lib/github_api/response/header.rb, line 46
def content_length
  loaded? ? env[:response_headers][CONTENT_LENGTH] : nil
end
content_type() click to toggle source
# File lib/github_api/response/header.rb, line 42
def content_type
  loaded? ? env[:response_headers][CONTENT_TYPE] : nil
end
date() click to toggle source
# File lib/github_api/response/header.rb, line 54
def date
  loaded? ? env[:response_headers][DATE] : nil
end
etag() click to toggle source
# File lib/github_api/response/header.rb, line 50
def etag
  loaded? ? env[:response_headers][ETAG] : nil
end
loaded?() click to toggle source
# File lib/github_api/response/header.rb, line 11
def loaded?
  !!env
end
location() click to toggle source
# File lib/github_api/response/header.rb, line 58
def location
  loaded? ? env[:response_headers][LOCATION] : nil
end
oauth_scopes() click to toggle source
# File lib/github_api/response/header.rb, line 15
def oauth_scopes
  loaded? ? env[:response_headers][OAUTH_SCOPES] : nil
end
ratelimit_limit() click to toggle source

Requests are limited to API v3 to 5000 per hour.

# File lib/github_api/response/header.rb, line 24
def ratelimit_limit
  loaded? ? env[:response_headers][RATELIMIT_LIMIT] : nil
end
ratelimit_remaining() click to toggle source
# File lib/github_api/response/header.rb, line 28
def ratelimit_remaining
  loaded? ? env[:response_headers][RATELIMIT_REMAINING] : nil
end
ratelimit_reset() click to toggle source

A unix timestamp describing when the ratelimit will be reset

# File lib/github_api/response/header.rb, line 34
def ratelimit_reset
  loaded? ? env[:response_headers][RATELIMIT_RESET] : nil
end
server() click to toggle source
# File lib/github_api/response/header.rb, line 62
def server
  loaded? ? env[:response_headers][SERVER] : nil
end
status() click to toggle source
# File lib/github_api/response/header.rb, line 66
def status
  loaded? ? env[:status] : nil
end
success?() click to toggle source
# File lib/github_api/response/header.rb, line 70
def success?
  SUCCESSFUL_STATUSES.include? status
end