suggestgrid 0.1.17.pre.SNAPSHOT → 0.1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ada01f923b1b9dd491c6a8a6666b7ffe8f709b8c
-  data.tar.gz: 72fe56da2934b0387707159761dce05a084ca608
+  metadata.gz: 4d16c4bda91e756fab948c163a5eca7f9be6b13b
+  data.tar.gz: 5b7380e60f648cb6cb4ba6490a651be6110966f2
 SHA512:
-  metadata.gz: 19d22bb73bc52bb9d7a9d9bda5a55088a30d16264da5c993e55040e1359fbfce1ff860d940247385689fe82098312dfaecf70234bcd4ee0607e52106efc0bdc1
-  data.tar.gz: 9970d65ae9a06d043835180da9da72e4c6ec578a381cb549cc22d9f2232e732f12e1f689936acb15a76fe2f50de3acb093aff564e4896a741f32eef696fec8fa
+  metadata.gz: 9b823a73f7c09feab64633bda1001e68fcfe7c95923a39bf7753b2402124a88673d20ac01e29c9c775a13a72aaa4d1e75f381e988e6cf7a0f3b4a8b650359f01
+  data.tar.gz: 2ddf6fe0bdc8da3b348c94fe4845ff188ebbaad1e4af15f7019bae5a781321e69e94ba66aba05b47128fde2c444a1a6a1af45c884e724fcb148b512467653bbc

data/lib/suggest_grid/api_helper.rb

@@ -4,7 +4,7 @@ module SuggestGrid
   class APIHelper
     # Replaces template parameters in the given url
     # @param [String] The query string builder to replace the template parameters
-    # @param [Array] The parameters to replace in the url
+    # @param [Hash] The parameters to replace in the url
     def self.append_url_with_template_parameters(query_builder, parameters)
       # perform parameter validation
       raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
@@ -35,7 +35,7 @@ module SuggestGrid
 
     # Appends the given set of parameters to the given query string
     # @param [String] The query string builder to replace the template parameters
-    # @param [Array] The parameters to append
+    # @param [Hash] The parameters to append
     def self.append_url_with_query_parameters(query_builder, parameters)
       # perform parameter validation
       raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String

data/lib/suggest_grid/configuration.rb

@@ -11,11 +11,12 @@ module SuggestGrid
     # The password to use with basic authentication
     @basic_auth_password = 'TODO: Replace'
 
-    # create the getters and setters
+    # The attribute accessors for public properties
     class << self
       attr_accessor :base_uri
       attr_accessor :basic_auth_user_name
       attr_accessor :basic_auth_password
     end
+ 
   end
 end

data/lib/suggest_grid/controllers/action_controller.rb

@@ -12,12 +12,17 @@ module SuggestGrid
     # @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 CountResponse response from the API call
+    # @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)
+                    older_than = nil,
+                    size = nil,
+                    from = nil)
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -29,7 +34,9 @@ module SuggestGrid
         '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
@@ -37,46 +44,38 @@ 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, 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)
+      # create the HttpRequest object for the call
+      _request = @http_client.get _query_url, headers: _headers
 
-      # 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
-        raise ErrorResponseException.new '400 - Required `user_id` or `item_id` parameters are missing from the request body.', _context
-      elsif _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 CountResponse.from_hash(decoded)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return ActionsResponse.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)
+
       # the base uri for api requests
       _query_builder = Configuration.base_uri.dup
 
@@ -88,44 +87,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.post _query_url, headers: _headers, parameters: action.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
+      # create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: action.to_json
 
-      # 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 == 400
+      # 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 _response.status_code == 402
+      elsif _context.response.status_code == 402
         raise ErrorResponseException.new '402 - Action limit exceeded.', _context
-      elsif _response.status_code == 404
+      elsif _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
 
@@ -134,11 +126,12 @@ module SuggestGrid
     # @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 MessageResponse response from the API call
+    # @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
       _query_builder = Configuration.base_uri.dup
 
@@ -158,56 +151,50 @@ 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, 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)
+      # create the HttpRequest object for the call
+      _request = @http_client.delete _query_url, headers: _headers
 
-      # 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 - Required `user_id` or `item_id` parameters are missing from the request body.', _context
-      elsif _response.status_code == 404
-        raise ErrorResponseException.new '404 - Type does not exists.', _context
-      elsif _response.status_code == 422
+      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 _response.status_code == 429
+      elsif _context.response.status_code == 429
         raise ErrorResponseException.new '429 - Too many requests.', _context
-      elsif _response.status_code == 505
+      elsif _context.response.status_code == 505
         raise ErrorResponseException.new '505 - Request timed out.', _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 MessageResponse.from_hash(decoded)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return DeleteSuccessResponse.from_hash(decoded)
     end
 
     # Post Bulk Actions
     # @param [Collection] actions Required parameter: List of actions to be posted.
-    # @return MessageResponse response from the API call
+    # @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
       _query_builder = Configuration.base_uri.dup
 
@@ -219,45 +206,36 @@ module SuggestGrid
 
       # prepare headers
       _headers = {
-        'user-agent' => 'SUGGESTGRID',
         'accept' => 'application/json',
         'content-type' => 'text/plain; charset=utf-8'
       }
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: actions, 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
+      # create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers, parameters: actions
 
-      # 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 == 209
-        raise BulkSchemaErrorResponseException.new '209 - Some metadata is not uploaded successfully.', _context
-      elsif _response.status_code == 400
+      # endpoint error handling using HTTP status codes.
+      if _context.response.status_code == 400
         raise ErrorResponseException.new '400 - Body is missing.', _context
-      elsif _response.status_code == 402
+      elsif _context.response.status_code == 402
         raise ErrorResponseException.new '402 - Action limit exceeded.', _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 MessageResponse.from_hash(decoded)
+      # return appropriate response type
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      return BulkPostResponse.from_hash(decoded)
     end
   end
 end

data/lib/suggest_grid/controllers/base_controller.rb

@@ -4,14 +4,39 @@ module SuggestGrid
   class BaseController
     attr_accessor :http_client, :http_call_back
 
-    @@http_client = UnirestClient.new
+    @@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_call_back = http_call_back
     end
 
-    def validate_response(context)			
+    def validate_parameters(args)
+      args.each do |name, value|
+        if value == nil
+            raise ArgumentError.new "Required parameter #{name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false) 
+      @http_call_back.on_before_request(request) if @http_call_back
+
+      request.headers = @@global_headers.clone.merge(request.headers)
+      
+      response = binary ? @http_client.execute_as_binary(request) : @http_client.execute_as_string(request)
+      context = HttpContext.new(request, response)
+
+      @http_call_back.on_after_response(context) if @http_call_back
+
+      return 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