Class: Gitlab::Request

Inherits:
Object
  • Object
show all
Includes:
HTTParty
Defined in:
lib/gitlab/request.rb

Direct Known Subclasses

API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#endpoint ⇒ Object

Returns the value of attribute endpoint.



12
13
14
 
# File 'lib/gitlab/request.rb', line 12

def endpoint
  @endpoint
end

#private_token ⇒ Object

Returns the value of attribute private_token.



12
13
14
 
# File 'lib/gitlab/request.rb', line 12

def private_token
  @private_token
end

Class Method Details

.decode(response) ⇒ Object

Decodes a JSON response into Ruby object.



28
29
30
31
32
33
34
 
# File 'lib/gitlab/request.rb', line 28

def self.decode(response)
  begin
    JSON.load response
  rescue JSON::ParserError
    raise Error::Parsing.new "The response is not a valid JSON"
  end
end

.parse(body) ⇒ Object

Converts the response body to an ObjectifiedHash.



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/gitlab/request.rb', line 15

def self.parse(body)
  body = decode(body)

  if body.is_a? Hash
    ObjectifiedHash.new body
  elsif body.is_a? Array
    body.collect! { |e| ObjectifiedHash.new(e) }
  else
    raise Error::Parsing.new "Couldn't parse a response body"
  end
end

Instance Method Details

#delete(path, options = {}) ⇒ Object 



54
55
56
57
58
 
# File 'lib/gitlab/request.rb', line 54

def delete(path, options={})
  set_httparty_config(options)
  set_private_token_header(options)
  validate self.class.delete(@endpoint + path, options)
end

#get(path, options = {}) ⇒ Object 



36
37
38
39
40
 
# File 'lib/gitlab/request.rb', line 36

def get(path, options={})
  set_httparty_config(options)
  set_private_token_header(options)
  validate self.class.get(@endpoint + path, options)
end

#post(path, options = {}) ⇒ Object 



42
43
44
45
46
 
# File 'lib/gitlab/request.rb', line 42

def post(path, options={})
  set_httparty_config(options)
  set_private_token_header(options, path)
  validate self.class.post(@endpoint + path, options)
end

#put(path, options = {}) ⇒ Object 



48
49
50
51
52
 
# File 'lib/gitlab/request.rb', line 48

def put(path, options={})
  set_httparty_config(options)
  set_private_token_header(options)
  validate self.class.put(@endpoint + path, options)
end

#set_request_defaults(endpoint, private_token, sudo = nil) ⇒ Object

Sets a base_uri and default_params for requests.

Raises:



80
81
82
83
84
85
86
87
 
# File 'lib/gitlab/request.rb', line 80

def set_request_defaults(endpoint, private_token, sudo=nil)
  raise Error::MissingCredentials.new("Please set an endpoint to API") unless endpoint
  @private_token = private_token
  @endpoint = endpoint

  self.class.default_params :sudo => sudo
  self.class.default_params.delete(:sudo) if sudo.nil?
end

#validate(response) ⇒ Object

Checks the response code for common errors. Returns parsed response for successful requests.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/gitlab/request.rb', line 62

def validate(response)
  case response.code
    when 400; raise Error::BadRequest.new error_message(response)
    when 401; raise Error::Unauthorized.new error_message(response)
    when 403; raise Error::Forbidden.new error_message(response)
    when 404; raise Error::NotFound.new error_message(response)
    when 405; raise Error::MethodNotAllowed.new error_message(response)
    when 409; raise Error::Conflict.new error_message(response)
    when 500; raise Error::InternalServerError.new error_message(response)
    when 502; raise Error::BadGateway.new error_message(response)
    when 503; raise Error::ServiceUnavailable.new error_message(response)
  end

  response.parsed_response
end