Class: Gitlab::Request
- Inherits:
-
Object
- Object
- Gitlab::Request
- Includes:
- HTTParty
- Defined in:
- lib/gitlab/request.rb
Direct Known Subclasses
Instance Attribute Summary collapse
-
#endpoint ⇒ Object
Returns the value of attribute endpoint.
-
#private_token ⇒ Object
Returns the value of attribute private_token.
Class Method Summary collapse
-
.decode(response) ⇒ Object
Decodes a JSON response into Ruby object.
-
.parse(body) ⇒ Object
Converts the response body to an ObjectifiedHash.
Instance Method Summary collapse
- #delete(path, options = {}) ⇒ Object
- #get(path, options = {}) ⇒ Object
- #post(path, options = {}) ⇒ Object
- #put(path, options = {}) ⇒ Object
-
#set_request_defaults(sudo = nil) ⇒ Object
Sets a base_uri and default_params for requests.
-
#validate(response) ⇒ Object
Checks the response code for common errors.
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.
30 31 32 33 34 35 36 |
# File 'lib/gitlab/request.rb', line 30 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 26 27 |
# 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) } elsif body.nil? false else raise Error::Parsing.new "Couldn't parse a response body" end end |
Instance Method Details
#delete(path, options = {}) ⇒ Object
56 57 58 59 60 |
# File 'lib/gitlab/request.rb', line 56 def delete(path, ={}) set_httparty_config() () validate self.class.delete(@endpoint + path, ) end |
#get(path, options = {}) ⇒ Object
38 39 40 41 42 |
# File 'lib/gitlab/request.rb', line 38 def get(path, ={}) set_httparty_config() () validate self.class.get(@endpoint + path, ) end |
#post(path, options = {}) ⇒ Object
44 45 46 47 48 |
# File 'lib/gitlab/request.rb', line 44 def post(path, ={}) set_httparty_config() (, path) validate self.class.post(@endpoint + path, ) end |
#put(path, options = {}) ⇒ Object
50 51 52 53 54 |
# File 'lib/gitlab/request.rb', line 50 def put(path, ={}) set_httparty_config() () validate self.class.put(@endpoint + path, ) end |
#set_request_defaults(sudo = nil) ⇒ Object
Sets a base_uri and default_params for requests.
82 83 84 85 86 |
# File 'lib/gitlab/request.rb', line 82 def set_request_defaults(sudo=nil) raise Error::MissingCredentials.new("Please set an endpoint to API") unless @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.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/gitlab/request.rb', line 64 def validate(response) case response.code when 400; raise Error::BadRequest.new (response) when 401; raise Error::Unauthorized.new (response) when 403; raise Error::Forbidden.new (response) when 404; raise Error::NotFound.new (response) when 405; raise Error::MethodNotAllowed.new (response) when 409; raise Error::Conflict.new (response) when 500; raise Error::InternalServerError.new (response) when 502; raise Error::BadGateway.new (response) when 503; raise Error::ServiceUnavailable.new (response) end response.parsed_response end |