suggestgrid 0.1.27 → 0.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d16c4bda91e756fab948c163a5eca7f9be6b13b
-  data.tar.gz: 5b7380e60f648cb6cb4ba6490a651be6110966f2
+  metadata.gz: 0a511c55944959fd302cda98f0de49a47b7e2fc0
+  data.tar.gz: c07cb656d5bbd87b4ec356c49acea5731381f8b5
 SHA512:
-  metadata.gz: 9b823a73f7c09feab64633bda1001e68fcfe7c95923a39bf7753b2402124a88673d20ac01e29c9c775a13a72aaa4d1e75f381e988e6cf7a0f3b4a8b650359f01
-  data.tar.gz: 2ddf6fe0bdc8da3b348c94fe4845ff188ebbaad1e4af15f7019bae5a781321e69e94ba66aba05b47128fde2c444a1a6a1af45c884e724fcb148b512467653bbc
+  metadata.gz: 9c8585d8f20f804af0b04d49e36f03f88529983ae0f97f147acc9fbeda9d85064c64b65285b4648cf16b0a93e7aba2606ce84b1511164a30fdd983759fa50b15
+  data.tar.gz: ecd0386e2c43a5ae9f76a79ee0a6a7b354918baf5c34b23986578b1b0b4ff364a5f75cee958f1f09178bfd0662ec28e31a7c373415f7d0e4afaac81b6da53747

data/README.md

@@ -23,7 +23,7 @@ Let's implement this feature in five minutes with SuggestGrid!
 We are beginning the development by adding the client as a dependency.
 
 ```ruby
-gem 'suggest_grid', git: 'https://github.com/suggestgrid/suggestgrid-ruby.git'
+gem 'suggestgrid'
 ```
 
 

data/lib/suggest_grid/api_helper.rb

@@ -94,6 +94,12 @@ module SuggestGrid
       end
     end
 
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |key, value| value.to_s.strip.empty? }
+    end
+
     # Form encodes a hash of parameters.
     # @param [Hash] The hash of parameters to encode.
     # @return [Hash] A hash with the same parameters form encoded.

data/lib/suggest_grid/configuration.rb

@@ -1,6 +1,7 @@
 # This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
 
 module SuggestGrid
+
   class Configuration
     # The base Uri for API calls
     @base_uri = 'https://example.com/api'

data/lib/suggest_grid/controllers/action_controller.rb

@@ -8,145 +8,114 @@ module SuggestGrid
       @@instance
     end
 
-    # Get Actions
-    # @param [String] type Optional parameter: The type of the actions.
-    # @param [String] user_id Optional parameter: The user id of the actions.
-    # @param [String] item_id Optional parameter: The item id of the actions.
-    # @param [String] older_than Optional parameter: Maxium timestamp of the actions. Valid times are 1s, 1m, 1h, 1d, 1M, 1y, or unix timestamp (like 1443798195).
-    # @param [Integer] 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 [Integer] from Optional parameter: The number of users to be skipped for 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,
-                    item_id = nil,
-                    older_than = nil,
-                    size = nil,
-                    from = nil)
+    # Post an Action
+    # @param [Action] action Required parameter: The action to be posted.
+    # @return MessageResponse response from the API call
+    def post_action(action)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
       _query_builder << '/v1/actions'
-
-      # process optional query parameters
-      _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
-      }
-
-      # validate and preprocess url
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
       _headers = {
-        'accept' => 'application/json'
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
       }
 
-      # create the HttpRequest object for the call
-      _request = @http_client.get _query_url, headers: _headers
-
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.post _query_url, headers: _headers, parameters: action.to_json
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
-      if _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+      # validate response against endpoint and global error codes
+      if _context.response.status_code == 400
+        raise ErrorResponseException.new 'Required user id or item id parameters are missing from the request.', _context
+      elsif _context.response.status_code == 402
+        raise ErrorResponseException.new 'Action limit exceeded.', _context
+      elsif _context.response.status_code == 404
+        raise ErrorResponseException.new 'Action type does not exists.', _context
+      elsif !_context.response.status_code.between?(200, 208)
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return ActionsResponse.from_hash(decoded)
+      return MessageResponse.from_hash(decoded)
     end
 
-    # Post an Action
-    # @param [Action] action Required parameter: The action to be posted.
-    # @return MessageResponse response from the API call
-    def post_action(action)
+    # Post Bulk Actions
+    # @param [Collection] actions Required parameter: List of actions to be posted.
+    # @return BulkPostResponse response from the API call
+    def post_bulk_actions(actions)
+        body = ''
+        actions.each do |action|
+            body += "#{action.to_json}\n"
+        end
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
-      _query_builder << '/v1/actions'
-
-      # validate and preprocess url
+      _query_builder << '/v1/actions/_bulk'
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'content-type' => 'text/plain; charset=utf-8'
       }
 
-      # create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: action.to_json
-
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.post _query_url, headers: _headers, parameters: body
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
+      # validate response against endpoint and global error codes
       if _context.response.status_code == 400
-        raise ErrorResponseException.new '400 - Required `user_id` or `item_id` parameters are missing from the request body.', _context
+        raise ErrorResponseException.new 'Body is missing.', _context
       elsif _context.response.status_code == 402
-        raise ErrorResponseException.new '402 - Action limit exceeded.', _context
+        raise ErrorResponseException.new 'Action limit exceeded.', _context
       elsif _context.response.status_code == 404
-        raise ErrorResponseException.new '404 - Type does not exists.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+        raise ErrorResponseException.new 'Action type does not exists.', _context
+      elsif _context.response.status_code == 413
+        raise ErrorResponseException.new 'Bulk request maximum line count exceeded.', _context
+      elsif !_context.response.status_code.between?(200, 208)
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return MessageResponse.from_hash(decoded)
+      return BulkPostResponse.from_hash(decoded)
     end
 
-    # Delete Actions
+    # Get Actions
     # @param [String] type Optional parameter: The type of the actions.
     # @param [String] user_id Optional parameter: The user id of the actions.
     # @param [String] item_id Optional parameter: The item id of the actions.
-    # @param [String] older_than Optional parameter: Delete all actions of a type older than the given timestamp or time. Valid times are 1s, 1m, 1h, 1d, 1M, 1y, or unix timestamp (like 1443798195).
-    # @return DeleteSuccessResponse response from the API call
-    def delete_actions(type = nil,
-                       user_id = nil,
-                       item_id = nil,
-                       older_than = nil)
+    # @param [String] older_than Optional parameter: Maxium timestamp of the actions. Valid times are in form of 1s, 1m, 1h, 1d, 1M, 1y, where 1 can be any integer, or a UNIX timestamp like 1443798195.
+    # @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,
+                    item_id = nil,
+                    older_than = nil,
+                    size = nil,
+                    from = nil)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
       _query_builder << '/v1/actions'
-
-      # process optional query parameters
       _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
         'type' => type,
         'user_id' => user_id,
         'item_id' => item_id,
-        'older_than' => older_than
+        'older_than' => older_than,
+        'size' => size,
+        'from' => from
       }
-
-      # validate and preprocess url
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
@@ -154,88 +123,71 @@ module SuggestGrid
         'accept' => 'application/json'
       }
 
-      # create the HttpRequest object for the call
-      _request = @http_client.delete _query_url, headers: _headers
-
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.get _query_url, headers: _headers
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
-      if _context.response.status_code == 400
-        raise ErrorResponseException.new '400 - Required `user_id` or `item_id` parameters are missing from the request body.', _context
-      elsif _context.response.status_code == 404
-        raise DeleteErrorResponseException.new '404 - Delete actions not found.', _context
-      elsif _context.response.status_code == 422
-        raise ErrorResponseException.new '422 - No query parameter (`user_id`, `item_id`, or `older_than`) is given.  In order to delete all actionsdelete the type.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 505
-        raise ErrorResponseException.new '505 - Request timed out.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+      # validate response against endpoint and global error codes
+      if _context.response.status_code == 0
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return DeleteSuccessResponse.from_hash(decoded)
+      return ActionsResponse.from_hash(decoded)
     end
 
-    # Post Bulk Actions
-    # @param [Collection] actions Required parameter: List of actions to be posted.
-    # @return BulkPostResponse response from the API call
-    def post_bulk_actions(actions)
-        body = ''
-        actions.each do |action|
-            body += "#{action.to_json}\n"
-        end
+    # Delete Actions
+    # @param [String] type Optional parameter: The type of the actions.
+    # @param [String] user_id Optional parameter: The user id of the actions.
+    # @param [String] item_id Optional parameter: The item id of the actions.
+    # @param [String] older_than Optional parameter: Delete all actions of a type older than the given timestamp or time. Valid times are in form of 1s, 1m, 1h, 1d, 1M, 1y, where 1 can be any integer, or a UNIX timestamp like 1443798195.
+    # @return DeleteSuccessResponse response from the API call
+    def delete_actions(type = nil,
+                       user_id = nil,
+                       item_id = nil,
+                       older_than = nil)
 
-      # the base uri for api requests
+      # prepare query url
       _query_builder = Configuration.base_uri.dup
-
-      # prepare query string for API call
-      _query_builder << '/v1/actions/_bulk'
-
-      # validate and preprocess url
+      _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
+      }
       _query_url = APIHelper.clean_url _query_builder
 
       # prepare headers
       _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'text/plain; charset=utf-8'
+        'accept' => 'application/json'
       }
 
-      # create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: actions
-
-      # apply authentication
+      # prepare and execute HttpRequest
+      _request = @http_client.delete _query_url, headers: _headers
       BasicAuth.apply(_request)
-
-      # execute the request
       _context = execute_request(_request)
 
-      # endpoint error handling using HTTP status codes.
+      # validate response against endpoint and global error codes
       if _context.response.status_code == 400
-        raise ErrorResponseException.new '400 - Body is missing.', _context
-      elsif _context.response.status_code == 402
-        raise ErrorResponseException.new '402 - Action limit exceeded.', _context
-      elsif _context.response.status_code == 429
-        raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _context.response.status_code == 500
-        raise APIException.new '500 - Unexpected internal error.', _context
+        raise ErrorResponseException.new 'Required user id or item id parameters are missing.', _context
+      elsif _context.response.status_code == 404
+        raise DeleteErrorResponseException.new 'Delete actions not found.', _context
+      elsif _context.response.status_code == 422
+        raise ErrorResponseException.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 == 505
+        raise ErrorResponseException.new 'Request timed out.', _context
+      elsif !_context.response.status_code.between?(200, 208)
+        raise ErrorResponseException.new 'Unexpected internal error.', _context
       end
-
-      # global error handling using HTTP status codes.
       validate_response(_context)
 
       # return appropriate response type
       decoded = APIHelper.json_deserialize(_context.response.raw_body)
-      return BulkPostResponse.from_hash(decoded)
+      return DeleteSuccessResponse.from_hash(decoded)
     end
   end
 end

data/lib/suggest_grid/controllers/base_controller.rb

@@ -18,14 +18,15 @@ module SuggestGrid
     def validate_parameters(args)
       args.each do |name, value|
         if value == nil
-            raise ArgumentError.new "Required parameter #{name} cannot be nil."
+          raise ArgumentError.new 'Required parameter #{name} cannot be nil.'
         end
       end
     end
 
-    def execute_request(request, binary: false) 
+    def execute_request(request, binary: false)
       @http_call_back.on_before_request(request) if @http_call_back
 
+      APIHelper.clean_hash(request.headers)
       request.headers = @@global_headers.clone.merge(request.headers)
       
       response = binary ? @http_client.execute_as_binary(request) : @http_client.execute_as_string(request)