cloudmersive-phishing-detection-api-client 2.2.1 → 2.2.3

data/lib/cloudmersive-phishing-detection-api-client/models/unsafe_url_result.rb

@@ -0,0 +1,226 @@
+=begin
+#phishingapi
+
+#Easily and directly scan and block phishing security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersivePhishingDetectionApiClient
+  # Result of analyzing an individual URL found in text
+  class UnsafeUrlResult
+    # The URL that was detected and analyzed
+    attr_accessor :url
+
+    # True if the result is not phishing (clean), and false otherwise
+    attr_accessor :clean_result
+
+    # True if the URL is an SSRF threat
+    attr_accessor :is_ssrf_threat
+
+    # True if the URL contains phishing threat risks, false otherwise
+    attr_accessor :contains_phishing
+
+    # True if the URL contains a phishing attempt, false otherwise
+    attr_accessor :contains_phishing_attempt
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'Url',
+        :'clean_result' => :'CleanResult',
+        :'is_ssrf_threat' => :'IsSsrfThreat',
+        :'contains_phishing' => :'ContainsPhishing',
+        :'contains_phishing_attempt' => :'ContainsPhishingAttempt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'url' => :'String',
+        :'clean_result' => :'BOOLEAN',
+        :'is_ssrf_threat' => :'BOOLEAN',
+        :'contains_phishing' => :'BOOLEAN',
+        :'contains_phishing_attempt' => :'BOOLEAN'
+      }
+    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?(:'Url')
+        self.url = attributes[:'Url']
+      end
+
+      if attributes.has_key?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      end
+
+      if attributes.has_key?(:'IsSsrfThreat')
+        self.is_ssrf_threat = attributes[:'IsSsrfThreat']
+      end
+
+      if attributes.has_key?(:'ContainsPhishing')
+        self.contains_phishing = attributes[:'ContainsPhishing']
+      end
+
+      if attributes.has_key?(:'ContainsPhishingAttempt')
+        self.contains_phishing_attempt = attributes[:'ContainsPhishingAttempt']
+      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 &&
+          url == o.url &&
+          clean_result == o.clean_result &&
+          is_ssrf_threat == o.is_ssrf_threat &&
+          contains_phishing == o.contains_phishing &&
+          contains_phishing_attempt == o.contains_phishing_attempt
+    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
+      [url, clean_result, is_ssrf_threat, contains_phishing, contains_phishing_attempt].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 = CloudmersivePhishingDetectionApiClient.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-phishing-detection-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersivePhishingDetectionApiClient
-  VERSION = '2.2.1'
+  VERSION = '2.2.3'
 end

data/lib/cloudmersive-phishing-detection-api-client.rb

@@ -18,10 +18,15 @@ require 'cloudmersive-phishing-detection-api-client/configuration'
 
 # Models
 require 'cloudmersive-phishing-detection-api-client/models/advanced_email_detection_request'
+require 'cloudmersive-phishing-detection-api-client/models/advanced_url_detection_request'
 require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_advanced_request'
 require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_advanced_response'
 require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_email_advanced_response'
 require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_response'
+require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_text_string_request'
+require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_text_string_response'
+require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_url_advanced_response'
+require 'cloudmersive-phishing-detection-api-client/models/unsafe_url_result'
 
 # APIs
 require 'cloudmersive-phishing-detection-api-client/api/phishing_detection_api'

data/spec/api/phishing_detection_api_spec.rb

@@ -47,6 +47,7 @@ describe 'PhishingDetectionApi' do
   # Perform advanced AI phishing detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :model 
+  # @option opts [String] :custom_policy_id 
   # @option opts [File] :input_file 
   # @return [PhishingDetectionAdvancedResponse]
   describe 'phishing_detect_file_advanced_post test' do
@@ -78,4 +79,26 @@ describe 'PhishingDetectionApi' do
     end
   end
 
+  # unit tests for phishing_detect_text_string_post
+  # Perform AI phishing detection against input text string.  Returns a clean/not-clean result with confidence level and optional rationale.
+  # @param [Hash] opts the optional parameters
+  # @option opts [PhishingDetectionTextStringRequest] :body Phishing detection request
+  # @return [PhishingDetectionTextStringResponse]
+  describe 'phishing_detect_text_string_post 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 phishing_detect_url_advanced_post
+  # Perform advanced AI phishing detection and classification against an input URL.  Retrieves the URL content, checks for SSRF threats, and analyzes the page with AI deep learning to detect phishing and other unsafe content.  Uses 100-125 API calls.
+  # @param [Hash] opts the optional parameters
+  # @option opts [AdvancedUrlDetectionRequest] :body URL phishing detection request
+  # @return [PhishingDetectionUrlAdvancedResponse]
+  describe 'phishing_detect_url_advanced_post test' 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/advanced_email_detection_request_spec.rb

@@ -68,6 +68,12 @@ describe 'AdvancedEmailDetectionRequest' do
     end
   end
 
+  describe 'test attribute "custom_policy_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "input_email_file"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/advanced_url_detection_request_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#phishingapi
+
+#Easily and directly scan and block phishing security threats in input.
+
+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 CloudmersivePhishingDetectionApiClient::AdvancedUrlDetectionRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AdvancedUrlDetectionRequest' do
+  before do
+    # run before each test
+    @instance = CloudmersivePhishingDetectionApiClient::AdvancedUrlDetectionRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AdvancedUrlDetectionRequest' do
+    it 'should create an instance of AdvancedUrlDetectionRequest' do
+      expect(@instance).to be_instance_of(CloudmersivePhishingDetectionApiClient::AdvancedUrlDetectionRequest)
+    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 "custom_policy_id"' 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/phishing_detection_advanced_request_spec.rb

@@ -38,10 +38,100 @@ describe 'PhishingDetectionAdvancedRequest' do
     end
   end
 
+  describe 'test attribute "text_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "model"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  describe 'test attribute "allow_unsolicited_sales"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_promotional_content"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_web_urls"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_phone_numbers"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_email_addresses"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "provide_url_analysis"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "custom_policy_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "provide_analysis_rationale"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "from_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "to_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "from_phone_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "to_phone_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "from_email_address"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "to_email_address"' 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/phishing_detection_advanced_response_spec.rb

@@ -38,7 +38,43 @@ describe 'PhishingDetectionAdvancedResponse' do
     end
   end
 
-  describe 'test attribute "phishing_risk_level"' do
+  describe 'test attribute "contains_phishing"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "contains_unsolicited_sales"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "contains_promotional_content"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "contains_web_urls"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "contains_phone_numbers"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "contains_email_addresses"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "confidence_level"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -50,4 +86,10 @@ describe 'PhishingDetectionAdvancedResponse' do
     end
   end
 
+  describe 'test attribute "unsafe_urls"' 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/phishing_detection_text_string_request_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#phishingapi
+
+#Easily and directly scan and block phishing security threats in input.
+
+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 CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'PhishingDetectionTextStringRequest' do
+  before do
+    # run before each test
+    @instance = CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PhishingDetectionTextStringRequest' do
+    it 'should create an instance of PhishingDetectionTextStringRequest' do
+      expect(@instance).to be_instance_of(CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringRequest)
+    end
+  end
+  describe 'test attribute "input_string"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "model"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "provide_analysis_rationale"' 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/phishing_detection_text_string_response_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#phishingapi
+
+#Easily and directly scan and block phishing security threats in input.
+
+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 CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'PhishingDetectionTextStringResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PhishingDetectionTextStringResponse' do
+    it 'should create an instance of PhishingDetectionTextStringResponse' do
+      expect(@instance).to be_instance_of(CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringResponse)
+    end
+  end
+  describe 'test attribute "clean_result"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "confidence_level"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "analysis_rationale"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end