Class: SuggestGrid::SimilarityController

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

Constant Summary collapse

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

def self.instance
  @@instance
end

Instance Method Details

#get_similar_items(query) ⇒ Object

Get Similar Items

Parameters:

Returns:

  • ItemsResponse response from the API call



50
51
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
 
# File 'lib/suggest_grid/controllers/similarity_controller.rb', line 50

def get_similar_items(query)

  # prepare query url

  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/similar/items'
  _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: query.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 'Request body is invalid.', _context
  elsif _context.response.status_code == 422
    raise ErrorResponseException.new 'Required parameters are missing.', _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 ItemsResponse.from_hash(decoded)
end

#get_similar_users(query) ⇒ Object

Get Similar Users

Parameters:

Returns:

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

def get_similar_users(query)

  # prepare query url

  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/similar/users'
  _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: query.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 'Request body is invalid.', _context
  elsif _context.response.status_code == 422
    raise ErrorResponseException.new 'Required parameters are missing.', _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 UsersResponse.from_hash(decoded)
end