cloudmersive-validate-api-client 2.1.5 → 2.1.6

data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_full.rb

@@ -0,0 +1,196 @@
+=begin
+#validateapi
+
+#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveValidateApiClient
+  # Result of checking a URL for SSRF threats
+  class UrlSsrfResponseFull
+    # True if the URL is clean, false if it is at risk of containing an SSRF threat or attack
+    attr_accessor :clean_url
+
+    # Threat level of the URL; possible values are High, Medium, Low and None
+    attr_accessor :threat_level
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'clean_url' => :'CleanURL',
+        :'threat_level' => :'ThreatLevel'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'clean_url' => :'BOOLEAN',
+        :'threat_level' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'CleanURL')
+        self.clean_url = attributes[:'CleanURL']
+      end
+
+      if attributes.has_key?(:'ThreatLevel')
+        self.threat_level = attributes[:'ThreatLevel']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          clean_url == o.clean_url &&
+          threat_level == o.threat_level
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [clean_url, threat_level].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveValidateApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb

@@ -21,11 +21,15 @@ module CloudmersiveValidateApiClient
     # Well-formed version of the URL
     attr_accessor :well_formed_url
 
+    # The top-level domain name of the URL, e.g. mydomain.com
+    attr_accessor :top_level_domain_name
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'valid_url' => :'ValidURL',
-        :'well_formed_url' => :'WellFormedURL'
+        :'well_formed_url' => :'WellFormedURL',
+        :'top_level_domain_name' => :'TopLevelDomainName'
       }
     end
 
@@ -33,7 +37,8 @@ module CloudmersiveValidateApiClient
     def self.swagger_types
       {
         :'valid_url' => :'BOOLEAN',
-        :'well_formed_url' => :'String'
+        :'well_formed_url' => :'String',
+        :'top_level_domain_name' => :'String'
       }
     end
 
@@ -52,6 +57,10 @@ module CloudmersiveValidateApiClient
       if attributes.has_key?(:'WellFormedURL')
         self.well_formed_url = attributes[:'WellFormedURL']
       end
+
+      if attributes.has_key?(:'TopLevelDomainName')
+        self.top_level_domain_name = attributes[:'TopLevelDomainName']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -73,7 +82,8 @@ module CloudmersiveValidateApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           valid_url == o.valid_url &&
-          well_formed_url == o.well_formed_url
+          well_formed_url == o.well_formed_url &&
+          top_level_domain_name == o.top_level_domain_name
     end
 
     # @see the `==` method
@@ -85,7 +95,7 @@ module CloudmersiveValidateApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [valid_url, well_formed_url].hash
+      [valid_url, well_formed_url, top_level_domain_name].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-validate-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersiveValidateApiClient
-  VERSION = '2.1.5'
+  VERSION = '2.1.6'
 end

data/spec/api/domain_api_spec.rb

@@ -44,6 +44,18 @@ describe 'DomainApi' do
     end
   end
 
+  # unit tests for domain_get_top_level_domain_from_url
+  # Get top-level domain name from URL
+  # Gets the top-level domain name from a URL, such as mydomain.com.
+  # @param request Input URL information
+  # @param [Hash] opts the optional parameters
+  # @return [ValidateUrlResponseSyntaxOnly]
+  describe 'domain_get_top_level_domain_from_url test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for domain_post
   # Get WHOIS information for a domain
   # Validate whether a domain name exists, and also return the full WHOIS record for that domain name.  WHOIS records include all the registration details of the domain name, such as information about the domain's owners.
@@ -68,6 +80,30 @@ describe 'DomainApi' do
     end
   end
 
+  # unit tests for domain_ssrf_check
+  # Check a URL for SSRF threats
+  # Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
+  # @param request Input URL request
+  # @param [Hash] opts the optional parameters
+  # @return [UrlSsrfResponseFull]
+  describe 'domain_ssrf_check test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for domain_ssrf_check_batch
+  # Check a URL for SSRF threats in batches
+  # Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.
+  # @param request Input URL request as a batch of multiple URLs
+  # @param [Hash] opts the optional parameters
+  # @return [UrlSsrfResponseBatch]
+  describe 'domain_ssrf_check_batch test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for domain_url_full
   # Validate a URL fully
   # Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks.  Accepts various types of input and produces a well-formed URL as output.

data/spec/models/url_ssrf_request_batch_spec.rb

@@ -0,0 +1,41 @@
+=begin
+#validateapi
+
+#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveValidateApiClient::UrlSsrfRequestBatch
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UrlSsrfRequestBatch' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::UrlSsrfRequestBatch.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UrlSsrfRequestBatch' do
+    it 'should create an instance of UrlSsrfRequestBatch' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::UrlSsrfRequestBatch)
+    end
+  end
+  describe 'test attribute "input_items"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/url_ssrf_request_full_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#validateapi
+
+#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveValidateApiClient::UrlSsrfRequestFull
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UrlSsrfRequestFull' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::UrlSsrfRequestFull.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UrlSsrfRequestFull' do
+    it 'should create an instance of UrlSsrfRequestFull' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::UrlSsrfRequestFull)
+    end
+  end
+  describe 'test attribute "url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "blocked_domains"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/url_ssrf_response_batch_spec.rb

@@ -0,0 +1,41 @@
+=begin
+#validateapi
+
+#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveValidateApiClient::UrlSsrfResponseBatch
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UrlSsrfResponseBatch' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::UrlSsrfResponseBatch.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UrlSsrfResponseBatch' do
+    it 'should create an instance of UrlSsrfResponseBatch' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::UrlSsrfResponseBatch)
+    end
+  end
+  describe 'test attribute "output_items"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/url_ssrf_response_full_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#validateapi
+
+#The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveValidateApiClient::UrlSsrfResponseFull
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UrlSsrfResponseFull' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::UrlSsrfResponseFull.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UrlSsrfResponseFull' do
+    it 'should create an instance of UrlSsrfResponseFull' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::UrlSsrfResponseFull)
+    end
+  end
+  describe 'test attribute "clean_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "threat_level"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end