cloudmersive-security-api-client 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e3fa172a6d3ae2f3278713e3cfd5373ecd62c8758107313f67dab2ab9b9378b3
+  data.tar.gz: 2a00b907aec1cd26d0a772664b46270a2c8ed57ef1ad19061983b09f745e7c72
+SHA512:
+  metadata.gz: 821baf71c818470b2b80f82ff627c413bfce604e5a7dd3687e23c9976e078982f442c1efd9e68ab3ff801f412479d3cf9d454428d901214f182ae0ee5f23c335
+  data.tar.gz: fcf89ec8158860bf38a40e4b50ba96aabfa4258ac5b17151cbfead71e306fb823d209998309b6a84420f33608e9478739aafebc4edf9e4e34086178734f3ee55

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,119 @@
+# cloudmersive-security-api-client
+
+CloudmersiveSecurityApiClient - the Ruby gem for the securityapi
+
+The security APIs help you detect and block security threats.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 2.0.1
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cloudmersive-security-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-security-api-client-2.0.1.gem
+```
+(for development, run `gem install --dev ./cloudmersive-security-api-client-2.0.1.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-security-api-client', '~> 2.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'cloudmersive-security-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'cloudmersive-security-api-client'
+
+# Setup authorization
+CloudmersiveSecurityApiClient.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 = CloudmersiveSecurityApiClient::ContentThreatDetectionApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+
+begin
+  #Automatically detect threats in an input string
+  result = api_instance.content_threat_detection_automatic_threat_detection_string(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling ContentThreatDetectionApi->content_threat_detection_automatic_threat_detection_string: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveSecurityApiClient::ContentThreatDetectionApi* | [**content_threat_detection_automatic_threat_detection_string**](docs/ContentThreatDetectionApi.md#content_threat_detection_automatic_threat_detection_string) | **POST** /security/threat-detection/content/automatic/detect/string | Automatically detect threats in an input string
+*CloudmersiveSecurityApiClient::ContentThreatDetectionApi* | [**content_threat_detection_check_sql_injection_string**](docs/ContentThreatDetectionApi.md#content_threat_detection_check_sql_injection_string) | **POST** /security/threat-detection/content/sql-injection/detect/string | Check text input for SQL Injection (SQLI) attacks
+*CloudmersiveSecurityApiClient::ContentThreatDetectionApi* | [**content_threat_detection_check_xxe**](docs/ContentThreatDetectionApi.md#content_threat_detection_check_xxe) | **POST** /security/threat-detection/content/xxe/detect/xml/string | Protect text input from XML External Entity (XXE) attacks
+*CloudmersiveSecurityApiClient::ContentThreatDetectionApi* | [**content_threat_detection_detect_insecure_deserialization_json_string**](docs/ContentThreatDetectionApi.md#content_threat_detection_detect_insecure_deserialization_json_string) | **POST** /security/threat-detection/content/insecure-deserialization/json/detect/string | Detect Insecure Deserialization JSON (JID) attacks in a string
+*CloudmersiveSecurityApiClient::ContentThreatDetectionApi* | [**content_threat_detection_protect_xss**](docs/ContentThreatDetectionApi.md#content_threat_detection_protect_xss) | **POST** /security/threat-detection/content/xss/detect/string | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
+*CloudmersiveSecurityApiClient::NetworkThreatDetectionApi* | [**network_threat_detection_detect_ssrf_url**](docs/NetworkThreatDetectionApi.md#network_threat_detection_detect_ssrf_url) | **POST** /security/threat-detection/network/url/ssrf/detect | Check a URL for Server-side Request Forgery (SSRF) threats
+*CloudmersiveSecurityApiClient::NetworkThreatDetectionApi* | [**network_threat_detection_is_bot**](docs/NetworkThreatDetectionApi.md#network_threat_detection_is_bot) | **POST** /security/threat-detection/network/ip/is-bot | Check if IP address is a Bot client threat
+*CloudmersiveSecurityApiClient::NetworkThreatDetectionApi* | [**network_threat_detection_is_threat**](docs/NetworkThreatDetectionApi.md#network_threat_detection_is_threat) | **POST** /security/threat-detection/network/ip/is-threat | Check if IP address is a known threat
+*CloudmersiveSecurityApiClient::NetworkThreatDetectionApi* | [**network_threat_detection_is_tor_node**](docs/NetworkThreatDetectionApi.md#network_threat_detection_is_tor_node) | **POST** /security/threat-detection/network/ip/is-tor-node | Check if IP address is a Tor node server
+
+
+## Documentation for Models
+
+ - [CloudmersiveSecurityApiClient::IPThreatDetectionResponse](docs/IPThreatDetectionResponse.md)
+ - [CloudmersiveSecurityApiClient::StringAutomaticThreatDetection](docs/StringAutomaticThreatDetection.md)
+ - [CloudmersiveSecurityApiClient::StringInsecureDeserializationJsonDetection](docs/StringInsecureDeserializationJsonDetection.md)
+ - [CloudmersiveSecurityApiClient::StringSqlInjectionDetectionResult](docs/StringSqlInjectionDetectionResult.md)
+ - [CloudmersiveSecurityApiClient::StringXssProtectionResult](docs/StringXssProtectionResult.md)
+ - [CloudmersiveSecurityApiClient::StringXxeDetectionResult](docs/StringXxeDetectionResult.md)
+ - [CloudmersiveSecurityApiClient::ThreatDetectionBotCheckResponse](docs/ThreatDetectionBotCheckResponse.md)
+ - [CloudmersiveSecurityApiClient::ThreatDetectionTorNodeResponse](docs/ThreatDetectionTorNodeResponse.md)
+ - [CloudmersiveSecurityApiClient::UrlSsrfThreatDetectionRequestFull](docs/UrlSsrfThreatDetectionRequestFull.md)
+ - [CloudmersiveSecurityApiClient::UrlSsrfThreatDetectionResponseFull](docs/UrlSsrfThreatDetectionResponseFull.md)
+
+
+## Documentation for Authorization
+
+
+### Apikey
+
+- **Type**: API key
+- **API key parameter name**: Apikey
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/cloudmersive-security-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#securityapi
+
+#The security APIs help you detect and block security threats.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cloudmersive-security-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-security-api-client"
+  s.version     = CloudmersiveSecurityApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://www.cloudmersive.com/security-api"
+  s.summary     = "Detect and block security threats."
+  s.description = "The security APIs help you detect and block security threats. Provides coverage for the most common types of security threats in one powerful API."
+  s.license     = 'Apache 2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = Dir['./**/*']
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/ContentThreatDetectionApi.md

@@ -0,0 +1,283 @@
+# CloudmersiveSecurityApiClient::ContentThreatDetectionApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**content_threat_detection_automatic_threat_detection_string**](ContentThreatDetectionApi.md#content_threat_detection_automatic_threat_detection_string) | **POST** /security/threat-detection/content/automatic/detect/string | Automatically detect threats in an input string
+[**content_threat_detection_check_sql_injection_string**](ContentThreatDetectionApi.md#content_threat_detection_check_sql_injection_string) | **POST** /security/threat-detection/content/sql-injection/detect/string | Check text input for SQL Injection (SQLI) attacks
+[**content_threat_detection_check_xxe**](ContentThreatDetectionApi.md#content_threat_detection_check_xxe) | **POST** /security/threat-detection/content/xxe/detect/xml/string | Protect text input from XML External Entity (XXE) attacks
+[**content_threat_detection_detect_insecure_deserialization_json_string**](ContentThreatDetectionApi.md#content_threat_detection_detect_insecure_deserialization_json_string) | **POST** /security/threat-detection/content/insecure-deserialization/json/detect/string | Detect Insecure Deserialization JSON (JID) attacks in a string
+[**content_threat_detection_protect_xss**](ContentThreatDetectionApi.md#content_threat_detection_protect_xss) | **POST** /security/threat-detection/content/xss/detect/string | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
+
+
+# **content_threat_detection_automatic_threat_detection_string**
+> StringAutomaticThreatDetection content_threat_detection_automatic_threat_detection_string(value)
+
+Automatically detect threats in an input string
+
+Auto-detects a wide range of threat types in input string, including Cross-Site Scripting (XSS), SQL Injection (SQLI), XML External Entitites (XXE), Server-side Request Forgeries (SSRF), and JSON Insecure Deserialization (JID).
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.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 = CloudmersiveSecurityApiClient::ContentThreatDetectionApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+
+begin
+  #Automatically detect threats in an input string
+  result = api_instance.content_threat_detection_automatic_threat_detection_string(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling ContentThreatDetectionApi->content_threat_detection_automatic_threat_detection_string: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+
+### Return type
+
+[**StringAutomaticThreatDetection**](StringAutomaticThreatDetection.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **content_threat_detection_check_sql_injection_string**
+> StringSqlInjectionDetectionResult content_threat_detection_check_sql_injection_string(value)
+
+Check text input for SQL Injection (SQLI) attacks
+
+Detects SQL Injection (SQLI) attacks from text input.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.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 = CloudmersiveSecurityApiClient::ContentThreatDetectionApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+
+begin
+  #Check text input for SQL Injection (SQLI) attacks
+  result = api_instance.content_threat_detection_check_sql_injection_string(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling ContentThreatDetectionApi->content_threat_detection_check_sql_injection_string: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+
+### Return type
+
+[**StringSqlInjectionDetectionResult**](StringSqlInjectionDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **content_threat_detection_check_xxe**
+> StringXxeDetectionResult content_threat_detection_check_xxe(value)
+
+Protect text input from XML External Entity (XXE) attacks
+
+Detects XXE (XML External Entity) attacks from XML text input.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.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 = CloudmersiveSecurityApiClient::ContentThreatDetectionApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+
+begin
+  #Protect text input from XML External Entity (XXE) attacks
+  result = api_instance.content_threat_detection_check_xxe(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling ContentThreatDetectionApi->content_threat_detection_check_xxe: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+
+### Return type
+
+[**StringXxeDetectionResult**](StringXxeDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **content_threat_detection_detect_insecure_deserialization_json_string**
+> StringInsecureDeserializationJsonDetection content_threat_detection_detect_insecure_deserialization_json_string(value)
+
+Detect Insecure Deserialization JSON (JID) attacks in a string
+
+Detects Insecure Deserialization JSON (JID) attacks from text input.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.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 = CloudmersiveSecurityApiClient::ContentThreatDetectionApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+
+begin
+  #Detect Insecure Deserialization JSON (JID) attacks in a string
+  result = api_instance.content_threat_detection_detect_insecure_deserialization_json_string(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling ContentThreatDetectionApi->content_threat_detection_detect_insecure_deserialization_json_string: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+
+### Return type
+
+[**StringInsecureDeserializationJsonDetection**](StringInsecureDeserializationJsonDetection.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **content_threat_detection_protect_xss**
+> StringXssProtectionResult content_threat_detection_protect_xss(value)
+
+Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
+
+Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization.  Returns the normalized result, as well as information on whether the original input contained an XSS risk.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-security-api-client'
+# setup authorization
+CloudmersiveSecurityApiClient.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 = CloudmersiveSecurityApiClient::ContentThreatDetectionApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+
+begin
+  #Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
+  result = api_instance.content_threat_detection_protect_xss(value)
+  p result
+rescue CloudmersiveSecurityApiClient::ApiError => e
+  puts "Exception when calling ContentThreatDetectionApi->content_threat_detection_protect_xss: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+
+### Return type
+
+[**StringXssProtectionResult**](StringXssProtectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+