Class: SuggestGrid::ActionController

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

Constant Summary collapse

@@instance = 
ActionController.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/action_controller.rb', line 7

def self.instance
  @@instance
end

Instance Method Details

#delete_actions(type, user_id = nil, item_id = nil, older_than = nil) ⇒ Object

Delete Actions

Parameters:

  • type (String) —

    Required parameter: Delete actions of a type. This parameter and at least one other parameter is required.

  • user_id (String) (defaults to: nil) —

    Optional parameter: Delete actions of a user id.

  • item_id (String) (defaults to: nil) —

    Optional parameter: Delete actions of an item id.

  • older_than (String) (defaults to: nil) —

    Optional parameter: Delete actions older than the given duration, or the given time number. Could be a ISO 8601 duration, or a Unix time number. Specifications are available at en.wikipedia.org/wiki/ISO_8601#Durations, or en.wikipedia.org/wiki/Unix_time.

Returns:

  • DeleteSuccessResponse response from the API call



148
149
150
151
152
153
154
155
156
157
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
185
186
187
188
189
190
191
 
# File 'lib/suggest_grid/controllers/action_controller.rb', line 148

def delete_actions(type,
                   user_id = nil,
                   item_id = nil,
                   older_than = nil)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/actions'
  _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
    'type' => type,
    'user_id' => user_id,
    'item_id' => item_id,
    'older_than' => older_than
  }
  _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 == 400
    raise ErrorResponseException.new 'Required user id or item id parameters are missing.', _context
  elsif _context.response.status_code == 404
    raise DeleteErrorResponseException.new 'Delete actions not found.', _context
  elsif _context.response.status_code == 422
    raise ErrorResponseException.new 'No query parameter (user id, item id, or older than) is given. qIn order to delete all actionsdelete the type.', _context
  elsif _context.response.status_code == 505
    raise ErrorResponseException.new 'Request timed out.', _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 DeleteSuccessResponse.from_hash(decoded)
end

#get_actions(type = nil, user_id = nil, item_id = nil, older_than = nil, size = nil, from = nil) ⇒ Object

Gets Actions

Parameters:

  • type (String) (defaults to: nil) —

    Optional parameter: Get actions of a type.

  • user_id (String) (defaults to: nil) —

    Optional parameter: Get actions of a user id.

  • item_id (String) (defaults to: nil) —

    Optional parameter: Get actions of an item id.

  • older_than (String) (defaults to: nil) —

    Optional parameter: Get actions older than the given duration, or the given time number. Could be a ISO 8601 duration, or a Unix time number. Specifications are available at en.wikipedia.org/wiki/ISO_8601#Durations, or en.wikipedia.org/wiki/Unix_time.

  • size (Long) (defaults to: nil) —

    Optional parameter: The number of the users response. Defaults to 10. Must be between 1 and 10,000 inclusive. This parameter must be string represetation of an integer like “1”.

  • from (Long) (defaults to: nil) —

    Optional parameter: The number of users to be skipped from the response. Defaults to 0. Must be bigger than or equal to 0. This parameter must be string represetation of an integer like “1”.

Returns:

  • ActionsResponse response from the API call



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/suggest_grid/controllers/action_controller.rb', line 101

def get_actions(type = nil,
                user_id = nil,
                item_id = nil,
                older_than = nil,
                size = nil,
                from = nil)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/actions'
  _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
    'type' => type,
    'user_id' => user_id,
    'item_id' => item_id,
    'older_than' => older_than,
    'size' => size,
    'from' => from
  }
  _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 ActionsResponse.from_hash(decoded)
end

#post_action(action) ⇒ Object

Posts an Action

Parameters:

  • action (Action) —

    Required parameter: The action to be posted.

Returns:

  • MessageResponse response from the API call



14
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
 
# File 'lib/suggest_grid/controllers/action_controller.rb', line 14

def post_action(action)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/actions'
  _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.post _query_url, headers: _headers, parameters: action.to_json
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise ErrorResponseException.new 'Required user id or item id parameters are missing from the request.', _context
  elsif _context.response.status_code == 402
    raise ErrorResponseException.new 'Action limit exceeded.', _context
  elsif _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

#post_bulk_actions(actions) ⇒ Object

Posts Actions

Parameters:

  • actions (Collection) —

    Required parameter: List of actions to be posted.

Returns:

  • BulkPostResponse response from the API call



52
53
54
55
56
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
89
90
91
 
# File 'lib/suggest_grid/controllers/action_controller.rb', line 52

def post_bulk_actions(actions)
    body = ''
    actions.each do |action|
        body += "#{action.to_json}\n"
    end

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

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

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

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise ErrorResponseException.new 'Body is missing.', _context
  elsif _context.response.status_code == 402
    raise ErrorResponseException.new 'Action limit exceeded.', _context
  elsif _context.response.status_code == 404
    raise ErrorResponseException.new 'Action type does not exists.', _context
  elsif _context.response.status_code == 413
    raise ErrorResponseException.new 'Bulk request maximum line count exceeded.', _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 BulkPostResponse.from_hash(decoded)
end