suggestgrid 0.1.15.pre.SNAPSHOT

data/lib/suggest_grid/controllers/similarity_controller.rb

@@ -0,0 +1,119 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class SimilarityController < BaseController
+    @@instance = SimilarityController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # Get Similar Users
+    # @param [GetSimilarUsersBody] body Required parameter: Similar users method parameters.
+    # @return UsersResponse response from the API call
+    def get_similar_users(body)
+      # the base uri for api requests
+      _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
+      _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: body.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)
+
+      # 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 == 400
+        raise APIException.new '400 - Request body is invalid.', _context
+      elsif _response.status_code == 422
+        raise APIException.new '422 - Required parameters are missing.', _context
+      elsif _response.status_code == 429
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return UsersResponse.from_hash(decoded)
+    end
+
+    # Get Similar Items
+    # @param [GetSimilarItemsBody] body Required parameter: Similar items method parameter.
+    # @return ItemsResponse response from the API call
+    def get_similar_items(body)
+      # the base uri for api requests
+      _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
+      _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: body.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)
+
+      # 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 == 400
+        raise APIException.new '400 - Request body is invalid.', _context
+      elsif _response.status_code == 422
+        raise APIException.new '422 - Required parameters are missing.', _context
+      elsif _response.status_code == 429
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return ItemsResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/suggest_grid/controllers/type_controller.rb

@@ -0,0 +1,280 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class TypeController < BaseController
+    @@instance = TypeController.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # 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
+
+      # prepare query string for API call
+      _query_builder << '/v1/types'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'SUGGESTGRID',
+        'accept' => 'application/json'
+      }
+
+      # 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)
+
+      # 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
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_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
+
+      # prepare query string for API call
+      _query_builder << '/v1/types'
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'SUGGESTGRID',
+        'accept' => 'application/json'
+      }
+
+      # 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)
+
+      # 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
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return GetTypesResponse.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)
+      # the base uri for api requests
+      _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 = {
+        'user-agent' => 'SUGGESTGRID',
+        'accept' => 'application/json'
+      }
+
+      # 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)
+
+      # 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
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return GetTypeResponse.from_hash(decoded)
+    end
+
+    # Create a New Type
+    # @param [String] type Required parameter: The name of the type to be created.
+    # @param [TypeRequestBody] body Optional parameter: Optional body for the rating parameter.
+    # @return MessageResponse response from the API call
+    def create_type(type, 
+                    body = nil)
+      # the base uri for api requests
+      _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 = {
+        '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: body.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)
+
+      # 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 == 402
+        raise APIException.new '402 - Type limit reached.', _context
+      elsif _response.status_code == 409
+        raise APIException.new '409 - Type already exists.', _context
+      elsif _response.status_code == 422
+        raise APIException.new '422 - Rating type is not `implicit` or `explicit`.', _context
+      elsif _response.status_code == 429
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return MessageResponse.from_hash(decoded)
+    end
+
+    # 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
+      _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 = {
+        'user-agent' => 'SUGGESTGRID',
+        'accept' => 'application/json'
+      }
+
+      # 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)
+
+      # 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 == 404
+        raise APIException.new '404 - Type does not exists.', _context
+      elsif _response.status_code == 429
+        raise APIException.new '429 - Too many requests.', _context
+      elsif _response.status_code == 500
+        raise APIException.new '500 - Unexpected internal error.', _context
+      end
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      return MessageResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/suggest_grid/exceptions/api_exception.rb

@@ -0,0 +1,16 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class APIException < StandardError
+    attr_reader :context, :response_code
+
+    # 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 = context
+	  @response_code = context.response.status_code
+    end
+  end
+end

data/lib/suggest_grid/http/http_call_back.rb

@@ -0,0 +1,17 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class HttpCallBack
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] The HttpRequest object which the HttpClient will execute.
+    def on_before_request(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpResponse] The HttpResponse object received from the HttpClient.
+    def on_after_response(http_response)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+  end
+end

data/lib/suggest_grid/http/http_client.rb

@@ -0,0 +1,112 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(http_request)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+    
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(response)
+      raise NotImplementedError, "This method needs to be implemented in a child class."
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def get(query_url,
+            headers: nil,
+            username: nil,
+            password: nil)
+      return HttpRequest.new(HttpMethodEnum::GET,
+                             query_url,
+                             headers: headers,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def post(query_url,
+             headers: nil,
+             parameters: nil,
+             username: nil,
+             password: nil)
+      return HttpRequest.new(HttpMethodEnum::POST,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def put(query_url,
+            headers: nil,
+            parameters: nil,
+            username: nil,
+            password: nil)
+      return HttpRequest.new(HttpMethodEnum::PUT,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def patch(query_url,
+              headers: nil,
+              parameters: nil,
+              username: nil,
+              password: nil)
+      return HttpRequest.new(HttpMethodEnum::PATCH,
+                             query_url,
+                             headers: headers,
+                             parameters: parameters,
+                             username: username,
+                             password: password)
+    end
+    
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def delete(query_url,
+               headers: nil,
+               username: nil,
+               password: nil)
+      return HttpRequest.new(HttpMethodEnum::DELETE,
+                             query_url,
+                             headers: headers,
+                             username: username,
+                             password: password)
+    end
+  end
+end

data/lib/suggest_grid/http/http_context.rb

@@ -0,0 +1,15 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class HttpContext
+    attr_accessor :request, :response
+
+    # The constructor.
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP response.
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+  end
+end

data/lib/suggest_grid/http/http_method_enum.rb

@@ -0,0 +1,7 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = "GET", POST = "POST", PUT = "PUT", PATCH = "PATCH", DELETE = "DELETE"]
+  end
+end

data/lib/suggest_grid/http/http_request.rb

@@ -0,0 +1,28 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers, :parameters, :username, :password
+
+    # The constructor.	
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String, Optional] Username for Basic Auth requests.
+    # @param [String, Optional] Password for Basic Auth requests.
+    def initialize(http_method,
+                   query_url,
+                   headers: nil,
+                   parameters: nil,
+                   username: nil,
+                   password: nil)
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+      @username = username
+      @password = password
+    end
+  end
+end

data/lib/suggest_grid/http/http_response.rb

@@ -0,0 +1,19 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+
+module SuggestGrid
+  class HttpResponse
+    attr_accessor :status_code, :headers, :raw_body
+    
+    # The constructor.	
+    # @param [Integer] The status code returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    def initialize(status_code,
+                   headers,
+                   raw_body)
+      @status_code = status_code
+      @headers = headers
+      @raw_body = raw_body
+    end
+  end
+end

data/lib/suggest_grid/http/unirest_client.rb

@@ -0,0 +1,41 @@
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+module SuggestGrid
+  class UnirestClient < HttpClient
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+
+      response = get_connection(http_request.username, http_request.password)
+      .send(http_request.http_method.downcase, http_request.query_url) do |faraday_request|
+        faraday_request.headers = http_request.headers
+        faraday_request.body = http_request.parameters
+      end
+
+      return convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+
+      response = get_connection(http_request.username, http_request.password)
+      .send(http_request.http_method.downcase, http_request.query_url) do |faraday_request|
+        faraday_request.headers = http_request.headers
+        faraday_request.body = http_request.parameters
+      end
+
+      return convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response)
+      return HttpResponse.new(response.status, response.headers, response.body)
+    end
+
+    def get_connection(user_name, password)
+      Faraday.new do |builder|
+        builder.request :retry
+        builder.request :basic_auth, user_name, password if user_name
+        builder.adapter :net_http
+      end
+    end
+  end
+end