suggestgrid 0.3.0 → 0.5.0.rc3

data/lib/suggestgrid/exceptions/{detailed_error_response_error_exception.rb → detailed_error_response.rb}

@@ -1,7 +1,9 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
-  class DetailedErrorResponseErrorException < APIException
+  # Error response.
+  class DetailedErrorResponse < APIException
     # Message of the response.
     # @return [String]
     attr_accessor :error_text
@@ -19,19 +21,17 @@ module SuggestGrid
     attr_accessor :error_details
 
     # The constructor.
-    # @param [String] The reason for raising an exception
+    # @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
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
     end
 
     # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the response body.
+    # @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']

data/lib/suggestgrid/exceptions/{error_response_error_exception.rb → error_response.rb}

@@ -1,7 +1,9 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
-  class ErrorResponseErrorException < APIException
+  # Error response.
+  class ErrorResponse < APIException
     # Message of the response.
     # @return [String]
     attr_accessor :error_text
@@ -15,19 +17,17 @@ module SuggestGrid
     attr_accessor :error_uri
 
     # The constructor.
-    # @param [String] The reason for raising an exception
+    # @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
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
     end
 
     # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the response body.
+    # @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']

data/lib/suggestgrid/exceptions/{limit_exceeded_error_response_error_exception.rb → limit_exceeded_error_response.rb}

@@ -1,7 +1,9 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
-  class LimitExceededErrorResponseErrorException < APIException
+  # Error response.
+  class LimitExceededErrorResponse < APIException
     # Message of the response.
     # @return [String]
     attr_accessor :error_text
@@ -23,19 +25,17 @@ module SuggestGrid
     attr_accessor :limit
 
     # The constructor.
-    # @param [String] The reason for raising an exception
+    # @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
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
     end
 
     # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the response body.
+    # @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']

data/lib/suggestgrid/http/auth/basic_auth.rb

@@ -1,17 +1,20 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
-require "base64"
+require 'base64'
 
 module SuggestGrid
+  # Utility class for basic authorization.
   class BasicAuth
     # Add basic authentication to the request.
-    # @param [HttpRequest] The HttpRequest object to which authentication will be added.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
     def self.apply(http_request)
       username = Configuration.basic_auth_user_name
       password = Configuration.basic_auth_password
       value = Base64.strict_encode64("#{username}:#{password}")
       header_value = "Basic #{value}"
-      http_request.headers["Authorization"] = header_value
+      http_request.headers['Authorization'] = header_value
     end
   end
-end
+end

data/lib/suggestgrid/http/faraday_client.rb

@@ -1,10 +1,13 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 require 'faraday/http_cache'
 
 module SuggestGrid
+  # An implementation of HttpClient.
   class FaradayClient < HttpClient
     # The constructor.
-    def initialize(timeout: nil, cache: false, max_retries: nil, retry_interval: nil)
+    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
@@ -13,26 +16,35 @@ module SuggestGrid
         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 && retry_interval)
+        faraday.request :retry, max: max_retries, interval: if max_retries &&
+                                                               retry_interval
+                                                              retry_interval
+                                                            end
       end
     end
 
     # Method overridden from HttpClient.
     def execute_as_string(http_request)
-      response = @connection.send(http_request.http_method.downcase, http_request.query_url) do |request|
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
         request.headers = http_request.headers
         request.body = http_request.parameters
       end
-      return convert_response(response)
+      convert_response(response)
     end
 
     # Method overridden from HttpClient.
     def execute_as_binary(http_request)
-      response = @connection.send(http_request.http_method.downcase, http_request.query_url) do |request|
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
         request.headers = http_request.headers
         request.body = http_request.parameters
       end
-      return convert_response(response)
+      convert_response(response)
     end
 
     # Method overridden from HttpClient.

data/lib/suggestgrid/http/http_call_back.rb

@@ -1,17 +1,22 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # HttpCallBack allows defining callables for pre and post API calls.
   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.'
+    # @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 [HttpContext] The HttpContext of the API call.
-    def on_after_response(http_context)
-      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    def on_after_response(_http_context)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
     end
   end
 end

data/lib/suggestgrid/http/http_client.rb

@@ -1,23 +1,31 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
   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.'
+    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.'
+    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.'
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
     end
 
     # Get a GET HttpRequest object.
@@ -25,11 +33,21 @@ module SuggestGrid
     # @param [Hash, Optional] The headers for the HTTP Request.
     def get(query_url,
             headers: {})
-      return HttpRequest.new(HttpMethodEnum::GET,
-                             query_url,
-                             headers: headers)
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
     end
-    
+
     # Get a POST HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
@@ -37,12 +55,12 @@ module SuggestGrid
     def post(query_url,
              headers: {},
              parameters: {})
-      return HttpRequest.new(HttpMethodEnum::POST,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters)
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
     end
-    
+
     # Get a PUT HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
@@ -50,12 +68,12 @@ module SuggestGrid
     def put(query_url,
             headers: {},
             parameters: {})
-      return HttpRequest.new(HttpMethodEnum::PUT,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters)
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
     end
-    
+
     # Get a PATCH HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
@@ -63,22 +81,22 @@ module SuggestGrid
     def patch(query_url,
               headers: {},
               parameters: {})
-      return HttpRequest.new(HttpMethodEnum::PATCH,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters)
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
     end
-    
+
     # Get a DELETE HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     def delete(query_url,
                headers: {},
                parameters: {})
-      return HttpRequest.new(HttpMethodEnum::DELETE,
-                             query_url,
-                             headers: headers,
-                             parameters: parameters)
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
     end
   end
 end

data/lib/suggestgrid/http/http_context.rb

@@ -1,12 +1,15 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Represents an Http call in context.
   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.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP
+    # response.
     def initialize(request, response)
       @request = request
       @response = response

data/lib/suggestgrid/http/http_method_enum.rb

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

data/lib/suggestgrid/http/http_request.rb

@@ -1,8 +1,11 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Represents a single Http Request.
   class HttpRequest
-    attr_accessor :http_method, :query_url, :headers, :parameters, :username, :password
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
 
     # The constructor.
     # @param [HttpMethodEnum] The HTTP method.
@@ -37,7 +40,8 @@ module SuggestGrid
     # @param [String] The name of the query parameter.
     # @param [String] The value of the query parameter.
     def add_query_parameter(name, value)
-      @query_url = APIHelper.append_url_with_query_parameters(@query_url, name => value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
       @query_url = APIHelper.clean_url(@query_url)
     end
   end

data/lib/suggestgrid/http/http_response.rb

@@ -1,6 +1,8 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Http response received.
   class HttpResponse
     attr_accessor :status_code, :headers, :raw_body
 

data/lib/suggestgrid/models/action.rb

@@ -1,6 +1,8 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # An action object represents a user's action of a type on an item.
   class Action < BaseModel
     # The type that the action belongs to.
     # @return [String]
@@ -18,20 +20,19 @@ module SuggestGrid
     # @return [Float]
     attr_accessor :rating
 
-    # The optional UNIX epoch timestamp of the action. Defaults to the current timestamp.
+    # The optional UNIX epoch timestamp of the action. Defaults to the current
+    # timestamp.
     # @return [Long]
     attr_accessor :timestamp
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["type"] = "type"
-        @_hash["user_id"] = "user_id"
-        @_hash["item_id"] = "item_id"
-        @_hash["rating"] = "rating"
-        @_hash["timestamp"] = "timestamp"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['user_id'] = 'user_id'
+      @_hash['item_id'] = 'item_id'
+      @_hash['rating'] = 'rating'
+      @_hash['timestamp'] = 'timestamp'
       @_hash
     end
 
@@ -47,18 +48,18 @@ module SuggestGrid
       @timestamp = timestamp
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       type = hash['type']
       user_id = hash['user_id']
       item_id = hash['item_id']
       rating = hash['rating']
       timestamp = hash['timestamp']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       Action.new(type,
                  user_id,
                  item_id,

data/lib/suggestgrid/models/actions_response.rb

@@ -1,6 +1,8 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Paged actions response.
   class ActionsResponse < BaseModel
     # The number of actions in the response.
     # @return [Long]
@@ -14,14 +16,12 @@ module SuggestGrid
     # @return [List of Action]
     attr_accessor :actions
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["count"] = "count"
-        @_hash["total_count"] = "total_count"
-        @_hash["actions"] = "actions"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['count'] = 'count'
+      @_hash['total_count'] = 'total_count'
+      @_hash['actions'] = 'actions'
       @_hash
     end
 
@@ -33,21 +33,23 @@ module SuggestGrid
       @actions = actions
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       count = hash['count']
       total_count = hash['total_count']
       # Parameter is an array, so we need to iterate through it
       actions = nil
-      if hash['actions'] != nil
-        actions = Array.new
-        hash['actions'].each{|structure| actions << (Action.from_hash(structure) if structure)}
+      unless hash['actions'].nil?
+        actions = []
+        hash['actions'].each do |structure|
+          actions << (Action.from_hash(structure) if structure)
+        end
       end
 
-      # Create object from extracted values
+      # Create object from extracted values.
       ActionsResponse.new(count,
                           total_count,
                           actions)

data/lib/suggestgrid/models/base_model.rb

@@ -1,32 +1,34 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Base model.
   class BaseModel
-    # Returns a Hash representation of the current object
+    # Returns a Hash representation of the current object.
     def to_hash
       hash = {}
-      self.instance_variables.each do |name|
-        value = self.instance_variable_get(name)
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
         name = name[1..-1]
         key = self.class.names.key?(name) ? self.class.names[name] : name
         if value.instance_of? Array
-          hash[key] = value.map{|v| v.kind_of?(BaseModel) ? v.to_hash : v}
+          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
         elsif value.instance_of? Hash
           hash[key] = {}
           value.each do |k, v|
-            hash[key][k] = v.kind_of?(BaseModel) ? v.to_hash : v
+            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
           end
         else
-          hash[key] = value.kind_of?(BaseModel) ? value.to_hash : value
+          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
         end
       end
       hash
     end
 
-    # Returns a JSON representation of the curent object
+    # Returns a JSON representation of the curent object.
     def to_json(options = {})
       hash = to_hash
       hash.to_json(options)
     end
   end
-end
+end

data/lib/suggestgrid/models/bulk_post_error.rb

@@ -1,6 +1,8 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0
+# ( https://apimatic.io ).
 
 module SuggestGrid
+  # Error response returned due to bulk post schema validations.
   class BulkPostError < BaseModel
     # Message of the response.
     # @return [String]
@@ -14,14 +16,12 @@ module SuggestGrid
     # @return [Object]
     attr_accessor :error
 
-    # A mapping from model property names to API property names
+    # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash["message"] = "message"
-        @_hash["value"] = "value"
-        @_hash["error"] = "error"
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['value'] = 'value'
+      @_hash['error'] = 'error'
       @_hash
     end
 
@@ -33,16 +33,16 @@ module SuggestGrid
       @error = error
     end
 
-    # Creates an instance of the object from a hash
+    # Creates an instance of the object from a hash.
     def self.from_hash(hash)
       return nil unless hash
 
-      # Extract variables from the hash
+      # Extract variables from the hash.
       message = hash['message']
       value = hash['value']
       error = hash['error']
 
-      # Create object from extracted values
+      # Create object from extracted values.
       BulkPostError.new(message,
                         value,
                         error)