cloudmersive-validate-api-client 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42848aae92bdab856adfb954183ca89a7c93d0bafc089573773e1dd6bf048f2e
-  data.tar.gz: af8fd461ed08f4a2c34d5a159fef97dc620c52b335d5f7a1161edf492d67aea9
+  metadata.gz: 4e8e42d5d4ada91525c90549a9f477d4d30c88f411cc95ad0217b72f168debd6
+  data.tar.gz: e3a67503f0e3f8a99ec743b0386a29f8fa4d8c6fd6bfdd2dd22a21bbbc299bd1
 SHA512:
-  metadata.gz: 99104ecbd0706950be75bf090b5585a0286f27001f150c938cb3b003e7a68f59546b29b6e80fcdc866e0c386092786cae8ddd91cdfd2b4721ba1954592262b88
-  data.tar.gz: 86212991b792a4523abc09705b99b705f60fe453d0732310c533dea7b979a7983993e4f7332c098a8bf99259b3dcb31451bf8dc75ca47e45aea37634b25738d1
+  metadata.gz: 56eedda381e6cfdbcf6301f004862a4de5448cc18abb6b9db66b3dfc2cb242dd230d669ab15f231b512624ca16575f607f05794773e9179821da8b34cd5caac4
+  data.tar.gz: c22901807d9c125630ec5d69e307ff6dd75dcddc6e4d19e6779eed326b47739c1c2bf2bbd81b715c03f5c7b4c64706839266088bd2e3dd176d693360ac43a4b0

data/README.md

@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 2.0.4
+- Package version: 2.0.5
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-validate-api-client-2.0.4.gem
+gem install ./cloudmersive-validate-api-client-2.0.5.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.0.4.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.0.5.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-validate-api-client', '~> 2.0.4'
+    gem 'cloudmersive-validate-api-client', '~> 2.0.5'
 
 ### Install from Git
 
@@ -99,6 +99,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveValidateApiClient::EmailApi* | [**email_address_get_servers**](docs/EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
 *CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
 *CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
+*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_tor_node**](docs/IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
 *CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
 *CloudmersiveValidateApiClient::LeadEnrichmentApi* | [**lead_enrichment_enrich_lead**](docs/LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
 *CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
@@ -137,6 +138,7 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
  - [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
  - [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
+ - [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
  - [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
  - [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
  - [CloudmersiveValidateApiClient::ValidateAddressRequest](docs/ValidateAddressRequest.md)

data/docs/IPAddressApi.md

@@ -4,9 +4,64 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**i_p_address_is_tor_node**](IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
 [**i_p_address_post**](IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
 
 
+# **i_p_address_is_tor_node**
+> TorNodeResponse i_p_address_is_tor_node(value)
+
+Check if IP address is a Tor node server
+
+Check if the input IP address is a Tor exit node server.  Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
+
+value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Check if IP address is a Tor node server
+  result = api_instance.i_p_address_is_tor_node(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling IPAddressApi->i_p_address_is_tor_node: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**TorNodeResponse**](TorNodeResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/javascript, application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **i_p_address_post**
 > GeolocateResponse i_p_address_post(value)
 

data/docs/TorNodeResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::TorNodeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_tor_node** | **BOOLEAN** | True if the input IP address is a Tor exit node, false otherwise | [optional] 
+
+

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

@@ -41,6 +41,7 @@ require 'cloudmersive-validate-api-client/models/parse_address_response'
 require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
 require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
 require 'cloudmersive-validate-api-client/models/timezone'
+require 'cloudmersive-validate-api-client/models/tor_node_response'
 require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
 require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
 require 'cloudmersive-validate-api-client/models/validate_address_request'

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

@@ -19,6 +19,60 @@ module CloudmersiveValidateApiClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Check if IP address is a Tor node server
+    # Check if the input IP address is a Tor exit node server.  Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.
+    # @param value IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+    # @param [Hash] opts the optional parameters
+    # @return [TorNodeResponse]
+    def i_p_address_is_tor_node(value, opts = {})
+      data, _status_code, _headers = i_p_address_is_tor_node_with_http_info(value, opts)
+      data
+    end
+
+    # Check if IP address is a Tor node server
+    # Check if the input IP address is a Tor exit node server.  Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.
+    # @param value IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TorNodeResponse, Fixnum, Hash)>] TorNodeResponse data, response status code and response headers
+    def i_p_address_is_tor_node_with_http_info(value, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_is_tor_node ...'
+      end
+      # verify the required parameter 'value' is set
+      if @api_client.config.client_side_validation && value.nil?
+        fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_is_tor_node"
+      end
+      # resource path
+      local_var_path = '/validate/ip/is-tor-node'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/javascript', 'application/json', 'text/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(value)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TorNodeResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_is_tor_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Geolocate an IP address
     # Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc.  Useful for security and UX applications.
     # @param value IP address to geolocate, e.g. \&quot;55.55.55.55\&quot;.  The input is a string so be sure to enclose it in double-quotes.

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

@@ -0,0 +1,186 @@
+=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 performing a Tor node check on an IP address
+  class TorNodeResponse
+    # True if the input IP address is a Tor exit node, false otherwise
+    attr_accessor :is_tor_node
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'is_tor_node' => :'IsTorNode'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'is_tor_node' => :'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?(:'IsTorNode')
+        self.is_tor_node = attributes[:'IsTorNode']
+      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 &&
+          is_tor_node == o.is_tor_node
+    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
+      [is_tor_node].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/version.rb

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

data/spec/api/ip_address_api_spec.rb

@@ -32,6 +32,18 @@ describe 'IPAddressApi' do
     end
   end
 
+  # unit tests for i_p_address_is_tor_node
+  # Check if IP address is a Tor node server
+  # Check if the input IP address is a Tor exit node server.  Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.
+  # @param value IP address to check, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+  # @param [Hash] opts the optional parameters
+  # @return [TorNodeResponse]
+  describe 'i_p_address_is_tor_node 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 i_p_address_post
   # Geolocate an IP address
   # Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc.  Useful for security and UX applications.

data/spec/models/tor_node_response_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::TorNodeResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'TorNodeResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveValidateApiClient::TorNodeResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TorNodeResponse' do
+    it 'should create an instance of TorNodeResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveValidateApiClient::TorNodeResponse)
+    end
+  end
+  describe 'test attribute "is_tor_node"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-validate-api-client
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -234,6 +234,7 @@ files:
 - "./docs/PhoneNumberValidateRequest.md"
 - "./docs/PhoneNumberValidationResponse.md"
 - "./docs/Timezone.md"
+- "./docs/TorNodeResponse.md"
 - "./docs/UserAgentApi.md"
 - "./docs/UserAgentValidateRequest.md"
 - "./docs/UserAgentValidateResponse.md"
@@ -295,6 +296,7 @@ files:
 - "./lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb"
 - "./lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/timezone.rb"
+- "./lib/cloudmersive-validate-api-client/models/tor_node_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb"
 - "./lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb"
 - "./lib/cloudmersive-validate-api-client/models/validate_address_request.rb"
@@ -352,6 +354,7 @@ files:
 - "./spec/models/phone_number_validate_request_spec.rb"
 - "./spec/models/phone_number_validation_response_spec.rb"
 - "./spec/models/timezone_spec.rb"
+- "./spec/models/tor_node_response_spec.rb"
 - "./spec/models/user_agent_validate_request_spec.rb"
 - "./spec/models/user_agent_validate_response_spec.rb"
 - "./spec/models/validate_address_request_spec.rb"