Class: SuggestGrid::TypeController

Inherits:
BaseController show all
Defined in:
lib/suggest_grid/controllers/type_controller.rb

Constant Summary collapse

@@instance = 
TypeController.new

Instance Attribute Summary

Attributes inherited from BaseController

#http_call_back, #http_client

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #initialize, #validate_parameters, #validate_response

Constructor Details

This class inherits a constructor from SuggestGrid::BaseController

Class Method Details

.instance ⇒ Object

Singleton instance of the controller class



7
8
9
 
# File 'lib/suggest_grid/controllers/type_controller.rb', line 7

def self.instance
  @@instance
end

Instance Method Details

#create_type(type, settings = nil) ⇒ Object

Create a New Type

Parameters:

  • type (String) —

    Required parameter: The name of the type.

  • settings (TypeRequestBody) (defaults to: nil) —

    Optional parameter: Optional settings for the rating parameter.

Returns:

  • MessageResponse response from the API call



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/suggest_grid/controllers/type_controller.rb', line 15

def create_type(type, 
                settings = nil)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/types/{type}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'type' => type
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # prepare and execute HttpRequest
  _request = @http_client.put _query_url, headers: _headers, parameters: settings.to_json
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 402
    raise LimitExceededErrorResponseException.new 'Type limit reached.', _context
  elsif _context.response.status_code == 409
    raise ErrorResponseException.new 'Type already exists.', _context
  elsif _context.response.status_code == 422
    raise ErrorResponseException.new 'Rating type is not `implicit` or `explicit`.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end

#delete_all_types ⇒ Object

Delete All Types

Returns:

  • MessageResponse response from the API call



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/suggest_grid/controllers/type_controller.rb', line 158

def delete_all_types

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/types'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.delete _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 0
    raise ErrorResponseException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end

#delete_type(type) ⇒ Object

Delete a Type

Parameters:

  • type (String) —

    Required parameter: The name of the type to be deleted.

Returns:

  • MessageResponse response from the API call



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/suggest_grid/controllers/type_controller.rb', line 93

def delete_type(type)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/types/{type}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'type' => type
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.delete _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 404
    raise ErrorResponseException.new 'Action type does not exists.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end

#get_all_types ⇒ Object

Get All Types

Returns:

  • GetTypesResponse response from the API call



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/suggest_grid/controllers/type_controller.rb', line 128

def get_all_types

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/types'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 0
    raise ErrorResponseException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return GetTypesResponse.from_hash(decoded)
end

#get_type(type) ⇒ Object

Get Properties of a Type

Parameters:

  • type (String) —

    Required parameter: The name of the type to get properties.

Returns:

  • GetTypeResponse response from the API call



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/suggest_grid/controllers/type_controller.rb', line 57

def get_type(type)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/types/{type}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'type' => type
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 404
    raise ErrorResponseException.new 'Type does not exists.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return GetTypeResponse.from_hash(decoded)
end