suggestgrid 0.3.0 → 0.5.0.rc3

data/lib/suggestgrid/controllers/action_controller.rb

@@ -1,102 +1,159 @@
-# 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
+  # ActionController
   class ActionController < BaseController
-    @@instance = ActionController.new
-    # Singleton instance of the controller class
-    def self.instance
-      @@instance
+    @instance = ActionController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
     end
 
-    # Posts an Action
+    # Posts an action to the given type in the body.
+    # The body must have user id, item id and type.
+    # Rating is required for actions sent to an explicit type.
     # @param [Action] action Required parameter: The action to be posted.
     # @return MessageResponse response from the API call
     def post_action(action)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/actions'
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json',
         'content-type' => 'application/json; charset=utf-8'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.post _query_url, headers: _headers, parameters: action.to_json
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: action.to_json
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 400
-        raise ErrorResponseErrorException.new 'Required user id or item id parameters are missing from the request.', _context
+        raise ErrorResponse.new(
+          'Required user id or item id parameters are missing from the' \
+          ' request.',
+          _context
+        )
       elsif _context.response.status_code == 402
-        raise ErrorResponseErrorException.new 'Action limit exceeded.', _context
+        raise ErrorResponse.new(
+          'Action limit exceeded.',
+          _context
+        )
       elsif _context.response.status_code == 404
-        raise ErrorResponseErrorException.new 'Action type does not exists.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Action type does not exists.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return MessageResponse.from_hash(decoded)
+      MessageResponse.from_hash(decoded)
     end
 
-    # Posts Actions
-    # @param [Collection] actions Required parameter: List of actions to be posted.
+    # Posts bulk actions to SuggestGrid.
+    # The recommended method for posting multiple actions at once.
+    # @param [Collection] actions Required parameter: List of actions to be posted
+    # separated with newlines. Note that this is not a valid JSON data
+    # structure. The body size is limited to 10 thousand lines.
     # @return BulkPostResponse response from the API call
     def post_bulk_actions(actions)
         body = ''
         actions.each do |action|
             body += "#{action.to_json}\n"
         end
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/actions/_bulk'
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json',
         'content-type' => 'text/plain; charset=utf-8'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.post _query_url, headers: _headers, parameters: body
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 400
-        raise ErrorResponseErrorException.new 'Body is missing.', _context
+        raise ErrorResponse.new(
+          'Body is missing.',
+          _context
+        )
       elsif _context.response.status_code == 402
-        raise ErrorResponseErrorException.new 'Action limit exceeded.', _context
+        raise ErrorResponse.new(
+          'Action limit exceeded.',
+          _context
+        )
       elsif _context.response.status_code == 404
-        raise ErrorResponseErrorException.new 'Action type does not exists.', _context
+        raise ErrorResponse.new(
+          'Action type does not exists.',
+          _context
+        )
       elsif _context.response.status_code == 413
-        raise ErrorResponseErrorException.new 'Bulk request maximum line count exceeded.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'Bulk request maximum line count exceeded.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return BulkPostResponse.from_hash(decoded)
+      BulkPostResponse.from_hash(decoded)
     end
 
-    # Gets Actions
+    # Get actions. Defaut responses will be paged by 10 actios each.
+    # Type, user id, item id, or older than parameters could be provided.
+    # The intersection of the provided parameters will be returned.
     # @param [String] type Optional parameter: Get actions of a type.
     # @param [String] user_id Optional parameter: Get actions of a user id.
     # @param [String] item_id Optional parameter: Get actions of an item id.
-    # @param [String] older_than Optional parameter: Get actions older than the given duration, or the given time number. Could be a ISO 8601 duration, or a Unix time number. Specifications are available at https://en.wikipedia.org/wiki/ISO_8601#Durations, or https://en.wikipedia.org/wiki/Unix_time.
-    # @param [Long] size Optional parameter: The number of the users response. Defaults to 10. Must be between 1 and 10,000 inclusive. This parameter must be string represetation of an integer like "1".
-    # @param [Long] from Optional parameter: The number of users to be skipped from the response. Defaults to 0. Must be bigger than or equal to 0. This parameter must be string represetation of an integer like "1".
+    # @param [String] older_than Optional parameter: Get actions older than the
+    # given duration, or the given time number. Could be a ISO 8601 duration, or
+    # a Unix time number. Specifications are available at
+    # https://en.wikipedia.org/wiki/ISO_8601#Durations, or
+    # https://en.wikipedia.org/wiki/Unix_time.
+    # @param [Long] size Optional parameter: The number of the users response.
+    # Defaults to 10. Must be between 1 and 10,000 inclusive. This parameter
+    # must be string represetation of an integer like "1".
+    # @param [Long] from Optional parameter: The number of users to be skipped
+    # from the response. Defaults to 0. Must be bigger than or equal to 0. This
+    # parameter must be string represetation of an integer like "1".
     # @return ActionsResponse response from the API call
     def get_actions(type = nil,
                     user_id = nil,
@@ -104,86 +161,128 @@ module SuggestGrid
                     older_than = nil,
                     size = nil,
                     from = nil)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/actions'
-      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
-        'type' => type,
-        'user_id' => user_id,
-        'item_id' => item_id,
-        'older_than' => older_than,
-        'size' => size,
-        'from' => from
-      }, array_serialization: Configuration.array_serialization
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'type' => type,
+          'user_id' => user_id,
+          'item_id' => item_id,
+          'older_than' => older_than,
+          'size' => size,
+          'from' => from
+        },
+        array_serialization: Configuration.array_serialization
+      )
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.get _query_url, headers: _headers
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
-      if _context.response.status_code == 0
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+      # Validate response against endpoint and global error codes.
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return ActionsResponse.from_hash(decoded)
+      ActionsResponse.from_hash(decoded)
     end
 
-    # Delete Actions
-    # @param [String] type Required parameter: Delete actions of a type. This parameter and at least one other parameter is required.
+    # Warning: Please use get actions with the exact parameters first to inspect
+    # the actions to be deleted.
+    # * Type must be provided.
+    # * If user id is provided, all actions of the user will be deleted.
+    # * If item id is provided, all actions on the item will be deleted.
+    # * If older than is provided, all actions older than the timestamp or the
+    # duration will be deleted.
+    # * If a number of these parameters are provided, the intersection of these
+    # parameters will be deleted.
+    # * In addition to a type, at least one of these parameters must be
+    # provided. In order to delete all the actions of a type, delete the type.
+    # @param [String] type Required parameter: Delete actions of a type. This
+    # parameter and at least one other parameter is required.
     # @param [String] user_id Optional parameter: Delete actions of a user id.
-    # @param [String] item_id Optional parameter: Delete actions of an item id.
-    # @param [String] older_than Optional parameter: Delete actions older than the given duration, or the given time number. Could be a ISO 8601 duration, or a Unix time number. Specifications are available at https://en.wikipedia.org/wiki/ISO_8601#Durations, or https://en.wikipedia.org/wiki/Unix_time.
+    # @param [String] item_id Optional parameter: Delete actions of an item
+    # id.
+    # @param [String] older_than Optional parameter: Delete actions older than
+    # the given duration, or the given time number. Could be a ISO 8601
+    # duration, or a Unix time number. Specifications are available at
+    # https://en.wikipedia.org/wiki/ISO_8601#Durations, or
+    # https://en.wikipedia.org/wiki/Unix_time.
     # @return MessageResponse response from the API call
     def delete_actions(type,
                        user_id = nil,
                        item_id = nil,
                        older_than = nil)
-
-      # prepare query url
+      # Prepare query url.
       _query_builder = Configuration.base_uri.dup
       _query_builder << '/v1/actions'
-      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
-        'type' => type,
-        'user_id' => user_id,
-        'item_id' => item_id,
-        'older_than' => older_than
-      }, array_serialization: Configuration.array_serialization
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'type' => type,
+          'user_id' => user_id,
+          'item_id' => item_id,
+          'older_than' => older_than
+        },
+        array_serialization: Configuration.array_serialization
+      )
       _query_url = APIHelper.clean_url _query_builder
 
-      # prepare headers
+      # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
-      # prepare and execute HttpRequest
-      _request = @http_client.delete _query_url, headers: _headers
+      # Prepare and execute HttpRequest.
+      _request = @http_client.delete(
+        _query_url,
+        headers: _headers
+      )
       BasicAuth.apply(_request)
       _context = execute_request(_request)
 
-      # validate response against endpoint and global error codes
+      # Validate response against endpoint and global error codes.
       if _context.response.status_code == 400
-        raise ErrorResponseErrorException.new 'Required user id or item id parameters are missing.', _context
+        raise ErrorResponse.new(
+          'Required user id or item id parameters are missing.',
+          _context
+        )
       elsif _context.response.status_code == 422
-        raise ErrorResponseErrorException.new 'No query parameter (user id, item id, or older than) is given. qIn order to delete all actionsdelete the type.', _context
-      elsif !_context.response.status_code.between?(200, 208)
-        raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
+        raise ErrorResponse.new(
+          'No query parameter (user id, item id, or older than) is given.' \
+          ' qIn order to delete all actionsdelete the type.',
+          _context
+        )
+      end
+      unless _context.response.status_code.between?(200, 208)
+        raise ErrorResponse.new(
+          'Unexpected internal error.',
+          _context
+        )
       end
       validate_response(_context)
 
-      # return appropriate response type
+      # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return MessageResponse.from_hash(decoded)
+      MessageResponse.from_hash(decoded)
     end
   end
 end

data/lib/suggestgrid/controllers/base_controller.rb

@@ -1,24 +1,24 @@
-# 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 controller.
   class BaseController
     attr_accessor :http_client, :http_call_back
 
-    @@http_client = FaradayClient.new
-
-    @@global_headers = {
-      'user-agent' => 'SUGGESTGRID'
-    }
-
     def initialize(http_client: nil, http_call_back: nil)
-      @http_client = http_client ||= @@http_client
+      @http_client = http_client || FaradayClient.new
       @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'SUGGESTGRID'
+      }
     end
 
     def validate_parameters(args)
       args.each do |_name, value|
         if value.nil?
-          raise ArgumentError.new 'Required parameter #{name} cannot be nil.'
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
         end
       end
     end
@@ -27,20 +27,23 @@ module SuggestGrid
       @http_call_back.on_before_request(request) if @http_call_back
 
       APIHelper.clean_hash(request.headers)
-      request.headers = @@global_headers.clone.merge(request.headers)
+      request.headers = @global_headers.clone.merge(request.headers)
 
-      response = binary ? @http_client.execute_as_binary(request) : @http_client.execute_as_string(request)
+      response = if binary
+                   @http_client.execute_as_binary(request)
+                 else
+                   @http_client.execute_as_string(request)
+                 end
       context = HttpContext.new(request, response)
 
       @http_call_back.on_after_response(context) if @http_call_back
 
-      return context
+      context
     end
 
     def validate_response(context)
-      if !context.response.status_code.between?(200, 208) #[200,208] = HTTP OK
-        raise APIException.new 'HTTP Response Not OK', context
-      end
+      raise APIException.new 'HTTP Response Not OK', context unless
+        context.response.status_code.between?(200, 208) # [200,208] = HTTP OK
     end
   end
 end