suggestgrid 0.1.27 → 0.1.30

data/lib/suggest_grid/controllers/recommendation_controller.rb

@@ -9,17 +9,13 @@ module SuggestGrid
     end
 
     # Get Recommended Users
-    # @param [GetRecommendedUsersBody] query Required parameter: The query for recommended users.
+    # @param [GetRecommendedUsersBody] query Required parameter: Query for recommended users.
     # @return UsersResponse response from the API call
     def get_recommended_users(query)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
       _query_builder << '/v1/recommend/users'
-
-      # validate and preprocess url
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
@@ -27,28 +23,20 @@ module SuggestGrid
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
+      # validate response against endpoint and global error codes
       if _context.response.status_code == 400
-        raise ErrorResponseException.new '400 - Request body is invalid.', _context
+        raise ErrorResponseException.new 'Request body is invalid.', _context
       elsif _context.response.status_code == 422
-        raise ErrorResponseException.new '422 - Required parameters are missing.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+        raise ErrorResponseException.new 'Required parameters are missing.', _context
+      elsif !_context.response.status_code.between?(200, 208)
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
@@ -57,17 +45,13 @@ module SuggestGrid
     end
 
     # Get Recommended Items
-    # @param [GetRecommendedItemsBody] query Required parameter: The query for recommended items.
+    # @param [GetRecommendedItemsBody] query Required parameter: Query for recommended items.
     # @return ItemsResponse response from the API call
     def get_recommended_items(query)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
       _query_builder << '/v1/recommend/items'
-
-      # validate and preprocess url
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
@@ -75,28 +59,20 @@ module SuggestGrid
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
+      # validate response against endpoint and global error codes
       if _context.response.status_code == 400
-        raise ErrorResponseException.new '400 - Request body is invalid.', _context
+        raise ErrorResponseException.new 'Request body is invalid.', _context
       elsif _context.response.status_code == 422
-        raise ErrorResponseException.new '422 - Required parameters are missing.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+        raise ErrorResponseException.new 'Required parameters are missing.', _context
+      elsif !_context.response.status_code.between?(200, 208)
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type

data/lib/suggest_grid/controllers/similarity_controller.rb

@@ -9,17 +9,13 @@ module SuggestGrid
     end
 
     # Get Similar Users
-    # @param [GetSimilarUsersBody] query Required parameter: The query for similar users.
+    # @param [GetSimilarUsersBody] query Required parameter: Query for similar users.
     # @return UsersResponse response from the API call
     def get_similar_users(query)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
       _query_builder << '/v1/similar/users'
-
-      # validate and preprocess url
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
@@ -27,28 +23,20 @@ module SuggestGrid
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
+      # validate response against endpoint and global error codes
       if _context.response.status_code == 400
-        raise ErrorResponseException.new '400 - Request body is invalid.', _context
+        raise ErrorResponseException.new 'Request body is invalid.', _context
       elsif _context.response.status_code == 422
-        raise ErrorResponseException.new '422 - Required parameters are missing.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+        raise ErrorResponseException.new 'Required parameters are missing.', _context
+      elsif !_context.response.status_code.between?(200, 208)
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
@@ -57,17 +45,13 @@ module SuggestGrid
     end
 
     # Get Similar Items
-    # @param [GetSimilarItemsBody] query Required parameter: The query for similar items.
+    # @param [GetSimilarItemsBody] query Required parameter: Query for similar items.
     # @return ItemsResponse response from the API call
     def get_similar_items(query)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
       _query_builder << '/v1/similar/items'
-
-      # validate and preprocess url
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
@@ -75,28 +59,20 @@ module SuggestGrid
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
+      # validate response against endpoint and global error codes
       if _context.response.status_code == 400
-        raise ErrorResponseException.new '400 - Request body is invalid.', _context
+        raise ErrorResponseException.new 'Request body is invalid.', _context
       elsif _context.response.status_code == 422
-        raise ErrorResponseException.new '422 - Required parameters are missing.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+        raise ErrorResponseException.new 'Required parameters are missing.', _context
+      elsif !_context.response.status_code.between?(200, 208)
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type

data/lib/suggest_grid/controllers/type_controller.rb

@@ -8,238 +8,174 @@ module SuggestGrid
       @@instance
     end
 
-    # Get All Types
-    # @return GetTypesResponse response from the API call
-    def get_all_types
+    # Create a New Type
+    # @param [String] type Required parameter: The name of the type.
+    # @param [TypeRequestBody] settings Optional parameter: Optional settings for the rating parameter.
+    # @return MessageResponse response from the API call
+    def create_type(type, 
+                    settings = nil)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
-      _query_builder << '/v1/types'
-
-      # validate and preprocess url
+      _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'
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.get _query_url, headers: _headers
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.put _query_url, headers: _headers, parameters: settings.to_json
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
-      if _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+      # 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
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return GetTypesResponse.from_hash(decoded)
+      return MessageResponse.from_hash(decoded)
     end
 
-    # Delete All Types
-    # @return GetTypesResponse response from the API call
-    def delete_all_types
+    # Get Properties of a Type
+    # @param [String] type Required parameter: The name of the type to get properties.
+    # @return GetTypeResponse response from the API call
+    def get_type(type)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
-      _query_builder << '/v1/types'
-
-      # validate and preprocess url
+      _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'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.delete _query_url, headers: _headers
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.get _query_url, headers: _headers
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
-      if _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+      # 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
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return GetTypesResponse.from_hash(decoded)
+      return GetTypeResponse.from_hash(decoded)
     end
 
-    # Get Properties of a Type
-    # @param [String] type Required parameter: The name of the type to get properties.
-    # @return GetTypeResponse response from the API call
-    def get_type(type)
+    # Delete a Type
+    # @param [String] type Required parameter: The name of the type to be deleted.
+    # @return MessageResponse response from the API call
+    def delete_type(type)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
       _query_builder << '/v1/types/{type}'
-
-      # process optional query parameters
       _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
         'type' => type
       }
-
-      # validate and preprocess url
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
       _headers = {
         'accept' => 'application/json'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.get _query_url, headers: _headers
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.delete _query_url, headers: _headers
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
-      if _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+      # 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
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return GetTypeResponse.from_hash(decoded)
+      return MessageResponse.from_hash(decoded)
     end
 
-    # Create a New Type
-    # @param [String] type Required parameter: The name of the type to be created.
-    # @param [TypeRequestBody] settings Optional parameter: Optional settings for the rating parameter.
-    # @return MessageResponse response from the API call
-    def create_type(type, 
-                    settings = nil)
+    # Get All Types
+    # @return GetTypesResponse response from the API call
+    def get_all_types
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
-      _query_builder << '/v1/types/{type}'
-
-      # process optional query parameters
-      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
-        'type' => type
-      }
-
-      # validate and preprocess url
+      _query_builder << '/v1/types'
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
       _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'accept' => 'application/json'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.put _query_url, headers: _headers, parameters: settings.to_json
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.get _query_url, headers: _headers
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
-      if _context.response.status_code == 402
-        raise LimitExceededErrorResponseException.new '402 - Type limit reached.', _context
-      elsif _context.response.status_code == 409
-        raise ErrorResponseException.new '409 - Type already exists.', _context
-      elsif _context.response.status_code == 422
-        raise ErrorResponseException.new '422 - Rating type is not `implicit` or `explicit`.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+      # validate response against endpoint and global error codes
+      if _context.response.status_code == 0
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return MessageResponse.from_hash(decoded)
+      return GetTypesResponse.from_hash(decoded)
     end
 
-    # Delete a Type
-    # @param [String] type Required parameter: The name of the type to be deleted.
+    # Delete All Types
     # @return MessageResponse response from the API call
-    def delete_type(type)
+    def delete_all_types
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
-      _query_builder << '/v1/types/{type}'
-
-      # process optional query parameters
-      _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
-        'type' => type
-      }
-
-      # validate and preprocess url
+      _query_builder << '/v1/types'
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
       _headers = {
         'accept' => 'application/json'
       }
-
-      # create the HttpRequest object for the call
-      _request = @http_client.delete _query_url, headers: _headers
 
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.delete _query_url, headers: _headers
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
-      if _context.response.status_code == 404
-        raise ErrorResponseException.new '404 - Type does not exists.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+      # validate response against endpoint and global error codes
+      if _context.response.status_code == 0
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type

data/lib/suggest_grid/exceptions/delete_error_response_exception.rb

@@ -10,20 +10,20 @@ module SuggestGrid
     # @return [String]
     attr_accessor :error_description
 
-    # URI of the response for more details.
+    # The URI of the error for more details.
     # @return [String]
     attr_accessor :error_uri
 
-    # The number of records found for the delete query.
-    # @return [Integer]
+    # The number of records found.
+    # @return [Long]
     attr_accessor :found
 
-    # The number of records deleted for the delete query.
-    # @return [Integer]
+    # The number of records deleted.
+    # @return [Long]
     attr_accessor :deleted
 
-    # The number of records found but not deleted for the delete query.
-    # @return [Integer]
+    # The number of records failed to be deleted.
+    # @return [Long]
     attr_accessor :failed
 
     # The constructor.

data/lib/suggest_grid/exceptions/detailed_error_response_exception.rb

@@ -10,7 +10,7 @@ module SuggestGrid
     # @return [String]
     attr_accessor :error_description
 
-    # URI of the response for more details.
+    # The URI of the error for more details.
     # @return [String]
     attr_accessor :error_uri
 

data/lib/suggest_grid/exceptions/error_response_exception.rb

@@ -10,7 +10,7 @@ module SuggestGrid
     # @return [String]
     attr_accessor :error_description
 
-    # URI of the response for more details.
+    # The URI of the error for more details.
     # @return [String]
     attr_accessor :error_uri
 

data/lib/suggest_grid/exceptions/limit_exceeded_error_response_exception.rb

@@ -10,16 +10,16 @@ module SuggestGrid
     # @return [String]
     attr_accessor :error_description
 
-    # URI of the response for more details.
+    # The URI of the error for more details.
     # @return [String]
     attr_accessor :error_uri
 
     # The quantity used by the account.
-    # @return [Integer]
+    # @return [Long]
     attr_accessor :used
 
     # The limit quantity of the account.
-    # @return [Integer]
+    # @return [Long]
     attr_accessor :limit
 
     # The constructor.

data/lib/suggest_grid/http/faraday_client.rb

@@ -4,14 +4,16 @@ require 'faraday/http_cache'
 module SuggestGrid
   class FaradayClient < HttpClient
     # The constructor.
-    def initialize(timeout: nil, cache: false)
+    def initialize(timeout: nil, cache: false, max_retries: nil, retry_interval: nil)
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.request :multipart
         faraday.request :url_encoded
         faraday.ssl[:ca_file] = Certifi.where
         faraday.adapter Faraday.default_adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:open_timeout] = timeout if timeout
+        faraday.request :retry, max: max_retries, interval: retry_interval if (max_retries and retry_interval)
       end
     end
 

data/lib/suggest_grid/http/http_client.rb

@@ -73,10 +73,12 @@ module SuggestGrid
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     def delete(query_url,
-               headers: {})
+               headers: {},
+               parameters: {})
       return HttpRequest.new(HttpMethodEnum::DELETE,
                              query_url,
-                             headers: headers)
+                             headers: headers,
+                             parameters: parameters)
     end
   end
 end