cloudmersive-dlp-api-client 2.2.0

data/spec/api/detect_api_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#dlpapi
+
+#Easily and directly scan and detect sensitive data (PII) in input text.
+
+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 CloudmersiveDlpApiClient::DetectApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DetectApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveDlpApiClient::DetectApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DetectApi' do
+    it 'should create an instance of DetectApi' do
+      expect(@instance).to be_instance_of(CloudmersiveDlpApiClient::DetectApi)
+    end
+  end
+
+  # unit tests for detect_document
+  # Detect User Data in Document Image
+  # Detects configurable types of user data in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DlpDocumentDetectionRequest] :body Input request
+  # @return [DlpDetectionResponse]
+  describe 'detect_document 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 detect_document_advanced
+  # Detect User Data in Document Image (Advanced)
+  # Detects 29 configurable types of user data including health-related PHI in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DlpAdvancedDocumentDetectionRequest] :body Input request
+  # @return [DlpAdvancedDetectionResponse]
+  describe 'detect_document_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 detect_text
+  # Detect User Data in Input Text
+  # Detects configurable types of user data in an input text string using Advanced AI.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DlpDetectionRequest] :body Input request
+  # @return [DlpDetectionResponse]
+  describe 'detect_text 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 detect_text_advanced
+  # Detect User Data in Input Text (Advanced)
+  # Detects 29 configurable types of user data including health-related PHI in an input text string using Advanced AI.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DlpAdvancedDetectionRequest] :body Input request
+  # @return [DlpAdvancedDetectionResponse]
+  describe 'detect_text_advanced 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/redact_api_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#dlpapi
+
+#Easily and directly scan and detect sensitive data (PII) in input text.
+
+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 CloudmersiveDlpApiClient::RedactApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RedactApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveDlpApiClient::RedactApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RedactApi' do
+    it 'should create an instance of RedactApi' do
+      expect(@instance).to be_instance_of(CloudmersiveDlpApiClient::RedactApi)
+    end
+  end
+
+  # unit tests for redact_document
+  # Redact User Data in Document
+  # Detects and redacts configurable types of user data in a document (PDF, DOCX, PNG, JPG) using Advanced AI. Rasterizes document pages, detects PII regions using a grid-overlay approach, blurs those regions, and returns a rasterized PDF.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DlpDocumentRedactionRequest] :body Input request
+  # @return [DlpDocumentRedactionResponse]
+  describe 'redact_document 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 redact_document_advanced
+  # Redact User Data in Document (Advanced)
+  # Detects and redacts 35 configurable types of user data including health-related PHI in a document (PDF, DOCX, PNG, JPG) using Advanced AI. Rasterizes document pages, detects PII regions using a row-overlay approach, redacts those regions, and returns a rasterized PDF.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DlpAdvancedDocumentRedactionRequest] :body Input request
+  # @return [DlpAdvancedDocumentRedactionResponse]
+  describe 'redact_document_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 redact_text
+  # Redact User Data in Input Text
+  # Detects and redacts configurable types of user data in an input text string using Advanced AI. First detects PII, then redacts disallowed types by either deleting them or replacing them with asterisks.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DlpRedactionRequest] :body Input request
+  # @return [DlpRedactionResponse]
+  describe 'redact_text 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 redact_text_advanced
+  # Redact User Data in Input Text (Advanced)
+  # Detects and redacts 34 configurable types of user data including health-related PHI in an input text string using Advanced AI. First detects PII, then redacts disallowed types by either deleting them or replacing them with asterisks.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DlpAdvancedRedactionRequest] :body Input request
+  # @return [DlpAdvancedRedactionResponse]
+  describe 'redact_text_advanced 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
+#dlpapi
+
+#Easily and directly scan and detect sensitive data (PII) in input text.
+
+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 CloudmersiveDlpApiClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          CloudmersiveDlpApiClient.configure { |c| c.host = 'http://example.com' }
+          expect(CloudmersiveDlpApiClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          CloudmersiveDlpApiClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(CloudmersiveDlpApiClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          CloudmersiveDlpApiClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(CloudmersiveDlpApiClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          CloudmersiveDlpApiClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(CloudmersiveDlpApiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          CloudmersiveDlpApiClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(CloudmersiveDlpApiClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          CloudmersiveDlpApiClient.configure { |c| c.base_path = nil }
+          expect(CloudmersiveDlpApiClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { CloudmersiveDlpApiClient::Configuration.new }
+    let(:api_client) { CloudmersiveDlpApiClient::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(CloudmersiveDlpApiClient::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) { CloudmersiveDlpApiClient::Configuration.new }
+    let(:api_client) { CloudmersiveDlpApiClient::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(CloudmersiveDlpApiClient::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) { CloudmersiveDlpApiClient::Configuration.new }
+    let(:api_client) { CloudmersiveDlpApiClient::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 = CloudmersiveDlpApiClient::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 = CloudmersiveDlpApiClient::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 = CloudmersiveDlpApiClient::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 = CloudmersiveDlpApiClient::ApiClient.new
+      # _model = CloudmersiveDlpApiClient::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) { CloudmersiveDlpApiClient::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) { CloudmersiveDlpApiClient::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) { CloudmersiveDlpApiClient::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) { CloudmersiveDlpApiClient::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) { CloudmersiveDlpApiClient::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
+#dlpapi
+
+#Easily and directly scan and detect sensitive data (PII) in input text.
+
+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 CloudmersiveDlpApiClient::Configuration do
+  let(:config) { CloudmersiveDlpApiClient::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("https://localhost")
+    # CloudmersiveDlpApiClient.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://localhost")
+    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://localhost")
+      end
+    end
+  end
+end