suggestgrid 0.3.0 → 0.5.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4162fd36c4cfabbbc3ac47dc4a9b442ee8d2899
-  data.tar.gz: 4ccbc83218922d0368ed16256fd9c6782944fdbb
+  metadata.gz: a2a974bdf596222b4c056093bce0bd736ecc28f5
+  data.tar.gz: 9853de9a1a5c71516759bd8060d03831ab0f7e47
 SHA512:
-  metadata.gz: 24c608a35956ccaab49f3b4e16819840abf3d632f8fbe68fce58ece6fb9a3cf55332a1adfc27a9e691903498cf20004e8cc395c2f008a71bd959518e88081fcb
-  data.tar.gz: 1251ea00f8fe3e5aa4d6b7e674945b1f1060e19030b0085360766dd4543093f2913ef1a6a16bc3e56f9d2d7725848b5bce49ad5a218822cca920414caf1b8f22
+  metadata.gz: 3976ab3ffa54efe3444cd5363d647e2756d74a72a5b19387f7d6158a60bcff4842e89ed8ed754bb2ab1cea8027a64e74799a55eecb166134411a08b24fc5cb79
+  data.tar.gz: 11656a71d76f28961d61abc699f62b4122fbe45ad97249853acb2b6def8c65d455618ec031db9dcf6c59f1306e9cba008b353af2a11404b1aa8872733e76ec0e

data/lib/suggestgrid/api_helper.rb

@@ -1,18 +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
+  # API utility class
   class APIHelper
-    # Serializes an array parameter (creates key value pairs)
-    # @param [String] The name of the parameter
-    # @param [Array] The value of the parameter
-    # @param [String] The format of the serialization
+    # Serializes an array parameter (creates key value pairs).
+    # @param [String] The name of the parameter.
+    # @param [Array] The value of the parameter.
+    # @param [String] The format of the serialization.
     def self.serialize_array(key, array, formatting: 'indexed')
       tuples = []
 
       if formatting == 'unindexed'
         tuples += array.map { |element| ["#{key}[]", element] }
       elsif formatting == 'indexed'
-        tuples += array.map.with_index { |element, index| ["#{key}[#{index}]", element] }
+        tuples += array.map.with_index do |element, index|
+          ["#{key}[#{index}]", element]
+        end
       elsif formatting == 'plain'
         tuples += array.map { |element| [key, element] }
       else
@@ -21,17 +25,21 @@ module SuggestGrid
       tuples
     end
 
-    # Replaces template parameters in the given url
-    # @param [String] The query string builder to replace the template parameters
-    # @param [Hash] The parameters to replace in the url
+    # Replaces template parameters in the given url.
+    # @param [String] The query string builder to replace the template
+    # parameters.
+    # @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
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\" is
+          invalid.'
+      end
 
-      # return if there are no parameters to replace
+      # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
-      # iterate and append parameters
+      # Iterate and append parameters.
       parameters.each do |key, value|
         replace_value = ''
 
@@ -44,38 +52,50 @@ module SuggestGrid
           replace_value = CGI.escape(value.to_s)
         end
 
-        # find the template parameter and replace it with its value
+        # Find the template parameter and replace it with its value.
         query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
       end
       query_builder
     end
 
-    # Appends the given set of parameters to the given query string
-    # @param [String] The query string builder to add the query parameters to
-    # @param [Hash] The parameters to append
-    # @param [String] The format of array parameter serialization
-    def self.append_url_with_query_parameters(query_builder, parameters, array_serialization: 'indexed')
-      # perform parameter validation
-      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+    # Appends the given set of parameters to the given query string.
+    # @param [String] The query string builder to add the query parameters to.
+    # @param [Hash] The parameters to append.
+    # @param [String] The format of array parameter serialization.
+    def self.append_url_with_query_parameters(query_builder, parameters,
+                                              array_serialization: 'indexed')
+      # Perform parameter validation.
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\"
+          is invalid.'
+      end
 
-      # return if there are no parameters to replace
+      # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
       parameters.each do |key, value|
-        seperator = (query_builder.include? '?') ? '&' : '?'
-        if not value.nil?
+        seperator = query_builder.include?('?') ? '&' : '?'
+        unless value.nil?
           if value.instance_of? Array
             value.compact!
-            if array_serialization == 'csv'
-              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join(',')}"
-            elsif array_serialization == 'psv'
-              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join('|')}"
-            elsif array_serialization == 'tsv'
-              query_builder += "#{seperator}#{key}=#{value.map { |element| CGI.escape(element.to_s) }.join('\t')}"
-            else
-              query_builder += "#{seperator}#{APIHelper.serialize_array(key, value, formatting: array_serialization).
-                map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')}"
-            end
+            query_builder += if array_serialization == 'csv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join(',')}"
+                             elsif array_serialization == 'psv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join('|')}"
+                             elsif array_serialization == 'tsv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join("\t")}"
+                             else
+                               "#{seperator}#{APIHelper.serialize_array(
+                                 key, value, formatting: array_serialization
+                               ).map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }
+                               .join('&')}"
+                             end
           else
             query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
           end
@@ -84,31 +104,31 @@ module SuggestGrid
       query_builder
     end
 
-    # Validates and processes the given Url
-    # @param [String] The given Url to process
-    # @return [String] Pre-processed Url as string
+    # Validates and processes the given Url.
+    # @param [String] The given Url to process.
+    # @return [String] Pre-processed Url as string.
     def self.clean_url(url)
-      # perform parameter validation
+      # Perform parameter validation.
       raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
 
-      # ensure that the urls are absolute
+      # Ensure that the urls are absolute.
       matches = url.match(%r{^(https?:\/\/[^\/]+)})
       raise ArgumentError, 'Invalid Url format.' if matches.nil?
 
-      # get the http protocol match
+      # Get the http protocol match.
       protocol = matches[1]
 
-      # check if parameters exist
+      # Check if parameters exist.
       index = url.index('?')
 
-      # remove redundant forward slashes
+      # Remove redundant forward slashes.
       query = url[protocol.length...(!index.nil? ? index : url.length)]
       query.gsub!(%r{\/\/+}, '/')
 
-      # get the parameters
+      # Get the parameters.
       parameters = !index.nil? ? url[url.index('?')...url.length] : ''
 
-      # return processed url
+      # Return processed url.
       protocol + query + parameters
     end
 
@@ -116,7 +136,7 @@ module SuggestGrid
     # @param [String] A JSON string.
     def self.json_deserialize(json)
       return JSON.parse(json)
-    rescue
+    rescue StandardError
       raise TypeError, 'Server responded with invalid JSON.'
     end
 
@@ -132,18 +152,52 @@ module SuggestGrid
     def self.form_encode_parameters(form_parameters)
       encoded = {}
       form_parameters.each do |key, value|
-        encoded.merge!(APIHelper.form_encode(value, key))
+        encoded.merge!(APIHelper.form_encode(value, key, formatting:
+          Configuration.array_serialization))
       end
       encoded
     end
 
+    def self.custom_merge(a, b)
+      x = {}
+      a.each do |key, value_a|
+        b.each do |k, value_b|
+          next unless key == k
+          x[k] = []
+          if value_a.instance_of? Array
+            value_a.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_a)
+          end
+          if value_b.instance_of? Array
+            value_b.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_b)
+          end
+          a.delete(k)
+          b.delete(k)
+        end
+      end
+      x.merge!(a)
+      x.merge!(b)
+      x
+    end
+
     # Form encodes an object.
     # @param [Dynamic] An object to form encode.
     # @param [String] The name of the object.
-    # @return [Hash] A form encoded representation of the object in the form of a hash.
-    def self.form_encode(obj, instance_name)
+    # @return [Hash] A form encoded representation of the object in the form
+    # of a hash.
+    def self.form_encode(obj, instance_name, formatting: 'indexed')
       retval = {}
 
+      serializable_types = [String, Numeric, TrueClass,
+                            FalseClass, Date, DateTime]
+
       # If this is a structure, resolve it's field names.
       obj = obj.to_hash if obj.is_a? BaseModel
 
@@ -151,31 +205,69 @@ module SuggestGrid
       if obj.nil?
         nil
       elsif obj.instance_of? Array
-        obj.each_with_index do |value, index|
-          retval.merge!(APIHelper.form_encode(value, instance_name + '[' + index.to_s + ']'))
+        if formatting == 'indexed'
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']'))
+          end
+        elsif serializable_types.map { |x| obj[0].is_a? x }.any?
+          obj.each do |value|
+            abc = if formatting == 'unindexed'
+                    APIHelper.form_encode(value, instance_name + '[]',
+                                          formatting: formatting)
+                  else
+                    APIHelper.form_encode(value, instance_name,
+                                          formatting: formatting)
+                  end
+            retval = APIHelper.custom_merge(retval, abc)
+            # print retval
+          end
+        else
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']', formatting: formatting))
+          end
         end
       elsif obj.instance_of? Hash
         obj.each do |key, value|
-          retval.merge!(APIHelper.form_encode(value, instance_name + '[' + key + ']'))
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+            key + ']', formatting: formatting))
         end
       else
         retval[instance_name] = obj
       end
       retval
     end
+
+    # Safely converts a string into an rfc3339 DateTime object
+    # @param [String] The datetime string
+    # @return [DateTime] A DateTime object of rfc3339 format
+    def self.rfc3339(date_time)
+      # missing timezone information
+      if date_time.end_with?('Z') || date_time.index('+')
+        DateTime.rfc3339(date_time)
+      else
+        DateTime.rfc3339(date_time + 'Z')
+      end
+    end
   end
 end
 
-# extend types to support to_bool
+# Extend types to support to_bool.
 module ToBoolean
   def to_bool
-    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
-    return false
+    return true if self == true || to_s.strip =~ /^(true|yes|y|1)$/i
+    false
   end
 end
 
+# Extend NilClass type to support to_bool.
 class NilClass; include ToBoolean; end
+# Extend TrueClass type to support to_bool.
 class TrueClass; include ToBoolean; end
+# Extend FalseClass type to support to_bool.
 class FalseClass; include ToBoolean; end
+# Extend Numeric type to support to_bool.
 class Numeric; include ToBoolean; end
-class String; include ToBoolean; end
+# Extend String type to support to_bool.
+class String; include ToBoolean; end

data/lib/suggestgrid/configuration.rb

@@ -1,6 +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
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
   class Configuration
     # The base Uri for API calls
     @base_uri = 'https://example.com/api'
@@ -11,7 +14,7 @@ module SuggestGrid
     # The password to use with basic authentication
     @basic_auth_password = 'TODO: Replace'
 
-    # The attribute accessors for public properties
+    # The attribute accessors for public properties.
     class << self
       attr_accessor :array_serialization
       attr_accessor :base_uri