cloudmersive-virus-scan-api-client 2.0.1 → 2.0.2

data/lib/cloudmersive-virus-scan-api-client/version.rb

@@ -0,0 +1,15 @@
+=begin
+#virusapi
+
+#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+module CloudmersiveVirusScanApiClient
+  VERSION = '2.0.2'
+end

data/spec/api/scan_api_spec.rb

@@ -0,0 +1,76 @@
+=begin
+#virusapi
+
+#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
+
+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'
+
+# Unit tests for CloudmersiveVirusScanApiClient::ScanApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ScanApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveVirusScanApiClient::ScanApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ScanApi' do
+    it 'should create an instance of ScanApi' do
+      expect(@instance).to be_instance_of(CloudmersiveVirusScanApiClient::ScanApi)
+    end
+  end
+
+  # unit tests for scan_file
+  # Scan a file for viruses
+  # Scan files and content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities.  Over 17 million virus and malware signatures.  Continuous cloud-based updates.  Wide file format support including Office, PDF, HTML, Flash.  Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats.  Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware.  High-speed in-memory scanning delivers subsecond typical response time.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [VirusScanResult]
+  describe 'scan_file 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 scan_file_advanced
+  # Advanced Scan a file for viruses
+  # Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities.  Over 17 million virus and malware signatures.  Continuous cloud-based updates.  Block threats beyond viruses including executables, scripts, invalid files, and more.  Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only).  Wide file format support including Office, PDF, HTML, Flash.  Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats.  Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware.  High-speed in-memory scanning delivers subsecond typical response time.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
+  # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
+  # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Pythong scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
+  # @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords.  Set to true to allow these file types.  Default is false (recommended).
+  # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
+  # @return [VirusScanAdvancedResult]
+  describe 'scan_file_advanced 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 scan_website
+  # Scan a website for malicious content and threats
+  # Operation includes scanning the content of the URL for various types of malicious content and threats, including viruses and threats (including Phishing).
+  # @param input 
+  # @param [Hash] opts the optional parameters
+  # @return [WebsiteScanResult]
+  describe 'scan_website 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/api_client_spec.rb

@@ -0,0 +1,243 @@
+=begin
+#virusapi
+
+#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+
+describe CloudmersiveVirusScanApiClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          CloudmersiveVirusScanApiClient.configure { |c| c.host = 'http://example.com' }
+          expect(CloudmersiveVirusScanApiClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          CloudmersiveVirusScanApiClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(CloudmersiveVirusScanApiClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          CloudmersiveVirusScanApiClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(CloudmersiveVirusScanApiClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          CloudmersiveVirusScanApiClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(CloudmersiveVirusScanApiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          CloudmersiveVirusScanApiClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(CloudmersiveVirusScanApiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          CloudmersiveVirusScanApiClient.configure { |c| c.base_path = nil }
+          expect(CloudmersiveVirusScanApiClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { CloudmersiveVirusScanApiClient::Configuration.new }
+    let(:api_client) { CloudmersiveVirusScanApiClient::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(CloudmersiveVirusScanApiClient::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { CloudmersiveVirusScanApiClient::Configuration.new }
+    let(:api_client) { CloudmersiveVirusScanApiClient::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(CloudmersiveVirusScanApiClient::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#build_request' do
+    let(:config) { CloudmersiveVirusScanApiClient::Configuration.new }
+    let(:api_client) { CloudmersiveVirusScanApiClient::ApiClient.new(config) }
+
+    it 'does not send multipart to request' do
+      expect(Typhoeus::Request).to receive(:new).with(anything, hash_not_including(:multipart))
+      api_client.build_request(:get, '/test')
+    end
+
+    context 'when the content type is multipart' do
+      it 'sends multipart to request' do
+        expect(Typhoeus::Request).to receive(:new).with(anything, hash_including(multipart: true))
+        api_client.build_request(:get, '/test', {header_params: { 'Content-Type' => 'multipart/form-data'}})
+      end
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = CloudmersiveVirusScanApiClient::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = CloudmersiveVirusScanApiClient::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = CloudmersiveVirusScanApiClient::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = CloudmersiveVirusScanApiClient::ApiClient.new
+      # _model = CloudmersiveVirusScanApiClient::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { CloudmersiveVirusScanApiClient::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { CloudmersiveVirusScanApiClient::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { CloudmersiveVirusScanApiClient::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { CloudmersiveVirusScanApiClient::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { CloudmersiveVirusScanApiClient::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#virusapi
+
+#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+
+describe CloudmersiveVirusScanApiClient::Configuration do
+  let(:config) { CloudmersiveVirusScanApiClient::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("https://api.cloudmersive.com")
+    # CloudmersiveVirusScanApiClient.configure do |c|
+    #   c.host = uri.host
+    #   c.base_path = uri.path
+    # end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      # uncomment below to test default value of the base path
+      # expect(config.base_url).to eq("https://api.cloudmersive.com")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        # uncomment below to test trailing slashes
+        # expect(config.base_url).to eq("https://api.cloudmersive.com")
+      end
+    end
+  end
+end

data/spec/models/virus_found_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#virusapi
+
+#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
+
+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 CloudmersiveVirusScanApiClient::VirusFound
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'VirusFound' do
+  before do
+    # run before each test
+    @instance = CloudmersiveVirusScanApiClient::VirusFound.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of VirusFound' do
+    it 'should create an instance of VirusFound' do
+      expect(@instance).to be_instance_of(CloudmersiveVirusScanApiClient::VirusFound)
+    end
+  end
+  describe 'test attribute "file_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 "virus_name"' 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/virus_scan_advanced_result_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#virusapi
+
+#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
+
+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 CloudmersiveVirusScanApiClient::VirusScanAdvancedResult
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'VirusScanAdvancedResult' do
+  before do
+    # run before each test
+    @instance = CloudmersiveVirusScanApiClient::VirusScanAdvancedResult.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of VirusScanAdvancedResult' do
+    it 'should create an instance of VirusScanAdvancedResult' do
+      expect(@instance).to be_instance_of(CloudmersiveVirusScanApiClient::VirusScanAdvancedResult)
+    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 "contains_executable"' 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_invalid_file"' 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_script"' 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_password_protected_file"' 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_restricted_file_format"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "verified_file_format"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "found_viruses"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end