suggestgrid 0.1.17.pre.SNAPSHOT → 0.1.27

data/lib/suggest_grid/controllers/recommendation_controller.rb

@@ -12,6 +12,7 @@ module SuggestGrid
     # @param [GetRecommendedUsersBody] query Required parameter: The query for recommended users.
     # @return UsersResponse response from the API call
     def get_recommended_users(query)
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -23,42 +24,35 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => '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
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # execute the request
+      _context = execute_request(_request)
 
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 400
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
         raise ErrorResponseException.new '400 - Request body is invalid.', _context
-      elsif _response.status_code == 422
+      elsif _context.response.status_code == 422
         raise ErrorResponseException.new '422 - Required parameters are missing.', _context
-      elsif _response.status_code == 429
+      elsif _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return UsersResponse.from_hash(decoded)
     end
 
@@ -66,6 +60,7 @@ module SuggestGrid
     # @param [GetRecommendedItemsBody] query Required parameter: The query for recommended items.
     # @return ItemsResponse response from the API call
     def get_recommended_items(query)
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -77,42 +72,35 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => '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
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # execute the request
+      _context = execute_request(_request)
 
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 400
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
         raise ErrorResponseException.new '400 - Request body is invalid.', _context
-      elsif _response.status_code == 422
+      elsif _context.response.status_code == 422
         raise ErrorResponseException.new '422 - Required parameters are missing.', _context
-      elsif _response.status_code == 429
+      elsif _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return ItemsResponse.from_hash(decoded)
     end
   end

data/lib/suggest_grid/controllers/similarity_controller.rb

@@ -12,6 +12,7 @@ module SuggestGrid
     # @param [GetSimilarUsersBody] query Required parameter: The query for similar users.
     # @return UsersResponse response from the API call
     def get_similar_users(query)
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -23,42 +24,35 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => '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
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # execute the request
+      _context = execute_request(_request)
 
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 400
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
         raise ErrorResponseException.new '400 - Request body is invalid.', _context
-      elsif _response.status_code == 422
+      elsif _context.response.status_code == 422
         raise ErrorResponseException.new '422 - Required parameters are missing.', _context
-      elsif _response.status_code == 429
+      elsif _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return UsersResponse.from_hash(decoded)
     end
 
@@ -66,6 +60,7 @@ module SuggestGrid
     # @param [GetSimilarItemsBody] query Required parameter: The query for similar items.
     # @return ItemsResponse response from the API call
     def get_similar_items(query)
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -77,42 +72,35 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => '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
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: query.to_json, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # execute the request
+      _context = execute_request(_request)
 
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 400
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
         raise ErrorResponseException.new '400 - Request body is invalid.', _context
-      elsif _response.status_code == 422
+      elsif _context.response.status_code == 422
         raise ErrorResponseException.new '422 - Required parameters are missing.', _context
-      elsif _response.status_code == 429
+      elsif _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return ItemsResponse.from_hash(decoded)
     end
   end

data/lib/suggest_grid/controllers/type_controller.rb

@@ -11,6 +11,7 @@ module SuggestGrid
     # Get All Types
     # @return GetTypesResponse response from the API call
     def get_all_types
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -22,43 +23,37 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => 'SUGGESTGRID',
         'accept' => 'application/json'
       }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.get _query_url, headers: _headers, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
+      # execute the request
+      _context = execute_request(_request)
 
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
-
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 429
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return GetTypesResponse.from_hash(decoded)
     end
 
     # Delete All Types
     # @return GetTypesResponse response from the API call
     def delete_all_types
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -70,37 +65,30 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => 'SUGGESTGRID',
         'accept' => 'application/json'
       }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.delete _query_url, headers: _headers
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.delete _query_url, headers: _headers, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
+      # execute the request
+      _context = execute_request(_request)
 
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
-
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
-
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 429
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return GetTypesResponse.from_hash(decoded)
     end
 
@@ -108,6 +96,7 @@ module SuggestGrid
     # @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
       _query_builder = Configuration.base_uri.dup
 
@@ -124,37 +113,30 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => 'SUGGESTGRID',
         'accept' => 'application/json'
       }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.get _query_url, headers: _headers, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
+      # execute the request
+      _context = execute_request(_request)
 
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
-
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 429
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return GetTypeResponse.from_hash(decoded)
     end
 
@@ -164,6 +146,7 @@ module SuggestGrid
     # @return MessageResponse response from the API call
     def create_type(type, 
                     settings = nil)
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -180,44 +163,37 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => 'SUGGESTGRID',
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.put _query_url, headers: _headers, parameters: settings.to_json
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.put _query_url, headers: _headers, parameters: settings.to_json, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # execute the request
+      _context = execute_request(_request)
 
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 402
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 402
         raise LimitExceededErrorResponseException.new '402 - Type limit reached.', _context
-      elsif _response.status_code == 409
+      elsif _context.response.status_code == 409
         raise ErrorResponseException.new '409 - Type already exists.', _context
-      elsif _response.status_code == 422
+      elsif _context.response.status_code == 422
         raise ErrorResponseException.new '422 - Rating type is not `implicit` or `explicit`.', _context
-      elsif _response.status_code == 429
+      elsif _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return MessageResponse.from_hash(decoded)
     end
 
@@ -225,6 +201,7 @@ module SuggestGrid
     # @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
       _query_builder = Configuration.base_uri.dup
 
@@ -241,39 +218,32 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => 'SUGGESTGRID',
         'accept' => 'application/json'
       }
+
+      # create the HttpRequest object for the call
+      _request = @http_client.delete _query_url, headers: _headers
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.delete _query_url, headers: _headers, username: Configuration.basic_auth_user_name, password: Configuration.basic_auth_password
-      
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
+      # apply authentication
+      BasicAuth.apply(_request)
 
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # execute the request
+      _context = execute_request(_request)
 
-      # Endpoint error handling using HTTP status codes.
-      if _response.status_code == 404
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 404
         raise ErrorResponseException.new '404 - Type does not exists.', _context
-      elsif _response.status_code == 429
+      elsif _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 500
+      elsif _context.response.status_code == 500
         raise APIException.new '500 - Unexpected internal error.', _context
       end
 
-      # Global error handling using HTTP status codes.
+      # global error handling using HTTP status codes.
       validate_response(_context)
 
-      # Return appropriate response type
-      decoded = APIHelper.json_deserialize(_response.raw_body)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
       return MessageResponse.from_hash(decoded)
     end
   end

data/lib/suggest_grid/exceptions/api_exception.rb

@@ -10,7 +10,7 @@ module SuggestGrid
     def initialize(reason, context)
       super(reason)
       @context = context
-	  @response_code = context.response.status_code
+      @response_code = context.response.status_code
     end
   end
 end

data/lib/suggest_grid/exceptions/delete_error_response_exception.rb

@@ -0,0 +1,52 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class DeleteErrorResponseException < APIException
+    # Message of the response.
+    # @return [String]
+    attr_accessor :error_text
+
+    # Description of the response.
+    # @return [String]
+    attr_accessor :error_description
+
+    # URI of the response for more details.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The number of records found for the delete query.
+    # @return [Integer]
+    attr_accessor :found
+
+    # The number of records deleted for the delete query.
+    # @return [Integer]
+    attr_accessor :deleted
+
+    # The number of records found but not deleted for the delete query.
+    # @return [Integer]
+    attr_accessor :failed
+
+    # The constructor.
+    # @param [String] The reason for raising an exception
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason, context)
+      begin
+        hash = APIHelper.json_deserialize(@context.response.raw_body)
+        unbox(hash)
+      rescue TypeError
+      end
+    end
+    
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the response body.
+    def unbox(hash)
+      @error_text = hash["error_text"]
+      @error_description = hash["error_description"]
+      @error_uri = hash["error_uri"]
+      @found = hash["found"]
+      @deleted = hash["deleted"]
+      @failed = hash["failed"]
+    end
+  end
+end

data/lib/suggest_grid/exceptions/detailed_error_response_exception.rb

@@ -26,10 +26,10 @@ module SuggestGrid
       begin
         hash = APIHelper.json_deserialize(@context.response.raw_body)
         unbox(hash)
-	  rescue TypeError
-	  end
+      rescue TypeError
+      end
     end
-	
+    
     # Populates this object by extracting properties from a hash.
     # @param [Hash] The deserialized response sent by the server in the response body.
     def unbox(hash)

data/lib/suggest_grid/exceptions/error_response_exception.rb

@@ -22,10 +22,10 @@ module SuggestGrid
       begin
         hash = APIHelper.json_deserialize(@context.response.raw_body)
         unbox(hash)
-	  rescue TypeError
-	  end
+      rescue TypeError
+      end
     end
-	
+    
     # Populates this object by extracting properties from a hash.
     # @param [Hash] The deserialized response sent by the server in the response body.
     def unbox(hash)