Examples with ScanTextRequest ai.nightfall.scan.model.ScanTextRequest used on opensource projects

Example 1 with ScanTextRequest

use of ai.nightfall.scan.model.ScanTextRequest in project nightfall-java-sdk by nightfallai.

the class NightfallClientTest method testScanText_RateLimitRetried.

@Test
public void testScanText_RateLimitRetried() {
    // use reference type to work around Java inner class limitations
    final int[] reqCount = { 0 };
    try (MockWebServer server = new MockWebServer()) {
        server.setDispatcher(new Dispatcher() {

            @NotNull
            @Override
            public MockResponse dispatch(@NotNull RecordedRequest r) {
                if (++reqCount[0] >= 3) {
                    return new MockResponse().setBody("{\"findings\": [[]]}");
                }
                // rate limit the first few requests
                return new MockResponse().setResponseCode(429).setBody(getRateLimitErrorResponse());
            }
        });
        List<List<Finding>> expectedFindings = Arrays.asList(Arrays.asList());
        NightfallClient c = new NightfallClient(getRequestURL(server), "key", 1, getHttpClient());
        ScanTextRequest req = new ScanTextRequest(null, (ScanTextConfig) null);
        ScanTextResponse resp = c.scanText(req);
        assertEquals(expectedFindings, resp.getFindings());
        // validate that rate limit responses were actually returned
        assertEquals(reqCount[0], 3);
    } catch (IOException e) {
        fail("IOException during test: " + e.getMessage());
    }
}

Example 2 with ScanTextRequest

use of ai.nightfall.scan.model.ScanTextRequest in project nightfall-java-sdk by nightfallai.

the class TextScannerExample method main.

/**
 * Submit the provided args for scanning and print the result.
 */
public static void main(String[] args) {
    if (args.length == 0) {
        throw new RuntimeException(usage);
    }
    try (NightfallClient client = NightfallClient.Builder.defaultClient()) {
        Detector creditCard = new Detector("CREDIT_CARD_NUMBER");
        creditCard.setMinConfidence(Confidence.LIKELY);
        creditCard.setMinNumFindings(1);
        Detector ssn = new Detector("US_SOCIAL_SECURITY_NUMBER");
        ssn.setMinConfidence(Confidence.POSSIBLE);
        ssn.setMinNumFindings(1);
        // A rule contains a set of detectors to scan with
        DetectionRule rule = new DetectionRule(Arrays.asList(creditCard, ssn), LogicalOp.ANY);
        List<String> payload = Arrays.asList(args).subList(1, args.length);
        // Define some detectors to use to scan your data
        ScanTextConfig config = ScanTextConfig.fromDetectionRules(Arrays.asList(rule), 20);
        ScanTextRequest req = new ScanTextRequest(payload, config);
        ScanTextResponse response = client.scanText(req);
        System.out.println("findings: " + response.getFindings());
    }
}

Example 3 with ScanTextRequest

use of ai.nightfall.scan.model.ScanTextRequest in project nightfall-java-sdk by nightfallai.

the class NightfallClientTest method testScanText_InternalException.

@Test
public void testScanText_InternalException() {
    NightfallErrorResponse expectedErr = new NightfallErrorResponse(500, "internal", "internal error", null);
    NightfallAPIException expectedException = new NightfallAPIException("unsuccessful response", expectedErr, 500);
    NightfallAPIException actualException = assertThrows(NightfallAPIException.class, () -> {
        try (MockWebServer server = new MockWebServer()) {
            String body = "{\"code\": 500, \"message\": \"internal\", \"description\": \"internal error\"}";
            server.enqueue(new MockResponse().setResponseCode(500).setBody(body));
            String serverURL = new HttpUrl.Builder().scheme("http").host(server.getHostName()).port(server.getPort()).build().url().toString();
            NightfallClient c = new NightfallClient(serverURL, "key", 1, getHttpClient());
            ScanTextRequest req = new ScanTextRequest(null, (ScanTextConfig) null);
            c.scanText(req);
            fail("did not expect scanText to succeed");
        } catch (IOException e) {
            fail("IOException during test: " + e.getMessage());
        }
    });
    assertEquals(expectedException.getError(), actualException.getError());
    assertEquals(expectedException.getMessage(), actualException.getMessage());
}

Example 4 with ScanTextRequest

use of ai.nightfall.scan.model.ScanTextRequest in project nightfall-java-sdk by nightfallai.

the class NightfallClientTest method testScanText_HappyPath.

@Test
public void testScanText_HappyPath() {
    try (MockWebServer server = new MockWebServer()) {
        server.enqueue(new MockResponse().setBody("{\"findings\": [[]]}"));
        List<List<Finding>> expectedFindings = Arrays.asList(Collections.emptyList());
        NightfallClient c = new NightfallClient(getRequestURL(server), "key", 1, getHttpClient());
        RedactionConfig defRedCfg = new RedactionConfig(new SubstitutionConfig("REDACTED"));
        ScanTextConfig cfg = new ScanTextConfig(Arrays.asList(UUID.fromString("c08c6c43-85ca-40e5-8f46-7d1cf1e176a3")), Collections.emptyList(), 20, defRedCfg);
        ScanTextRequest req = new ScanTextRequest(null, cfg);
        ScanTextResponse resp = c.scanText(req);
        assertEquals(expectedFindings, resp.getFindings());
    } catch (IOException e) {
        fail("IOException during test: " + e.getMessage());
    }
}

Example 5 with ScanTextRequest

use of ai.nightfall.scan.model.ScanTextRequest in project nightfall-java-sdk by nightfallai.

the class NightfallClientTest method testScanText_429RetryCountExceeded.

@Test
public void testScanText_429RetryCountExceeded() {
    NightfallErrorResponse expectedErr = new NightfallErrorResponse(429, "too many requests", "too many requests", null);
    NightfallAPIException expectedException = new NightfallAPIException("exceeded max retry count on request: /v3/scan", expectedErr, 429);
    NightfallAPIException actualException = assertThrows(NightfallAPIException.class, () -> {
        try (MockWebServer server = new MockWebServer()) {
            String body = "{\"code\": 429, \"message\": \"too many requests\", \"description\": \"too many requests\"}";
            server.setDispatcher(new Dispatcher() {

                @NotNull
                @Override
                public MockResponse dispatch(@NotNull RecordedRequest r) {
                    return new MockResponse().setResponseCode(429).setBody(body);
                }
            });
            String serverURL = new HttpUrl.Builder().scheme("http").host(server.getHostName()).port(server.getPort()).build().url().toString();
            NightfallClient c = new NightfallClient(serverURL, "key", 1, getHttpClient());
            ScanTextRequest req = new ScanTextRequest(null, (ScanTextConfig) null);
            c.scanText(req);
            fail("did not expect scanText to succeed");
        } catch (IOException e) {
            fail("IOException during test: " + e.getMessage());
        }
    });
    assertEquals(expectedException.getError(), actualException.getError());
    assertEquals(expectedException.getMessage(), actualException.getMessage());
}