();
91 | this.headers.putAll(request.headers);
92 | }
93 |
94 | public Builder url(URL url) {
95 | if (url == null) {
96 | throw new IBMWatsonServiceExceptions.IllegalArgumentException('url == null');
97 | }
98 |
99 | this.url = url;
100 | return this;
101 | }
102 |
103 | /**
104 | * Sets the URL target of this request.
105 | *
106 | * @throws IllegalArgumentException if {@code url} is not a valid HTTP or HTTPS URL. Avoid this
107 | * exception by calling {@link HttpUrl#parse}; it returns null for invalid URLs.
108 | */
109 | public Builder url(String url) {
110 | if (url == null) {
111 | throw new IBMWatsonServiceExceptions.IllegalArgumentException('url == null');
112 | }
113 |
114 | URL parsed = new URL(url);
115 | if (parsed == null) {
116 | throw new IBMWatsonServiceExceptions.IllegalArgumentException('unexpected url: ' + url);
117 | }
118 | return url(parsed);
119 | }
120 |
121 | /**
122 | * Adds a header with {@code name} and {@code value}. Prefer this method for multiply-valued
123 | * headers like "Cookie".
124 | *
125 | * Note that for some headers including {@code Content-Length} and {@code Content-Encoding},
126 | * OkHttp may replace {@code value} with a header derived from the request body.
127 | */
128 | public Builder addHeader(String name, String value) {
129 | headers.put(name, value);
130 | return this;
131 | }
132 |
133 | public Builder method(String method, IBMWatsonRequestBody body) {
134 | if (String.isBlank(method)) {
135 | throw new IBMWatsonServiceExceptions.IllegalArgumentException('method == empty');
136 | }
137 | this.method = method;
138 | this.body = body;
139 | return this;
140 | }
141 |
142 | public IBMWatsonRequest build() {
143 | if (url == null) {
144 | throw new IBMWatsonServiceExceptions.IllegalArgumentException('url == null');
145 | }
146 | return new IBMWatsonRequest(this);
147 | }
148 | }
149 | }
150 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonRequest.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonRequestBody.cls:
--------------------------------------------------------------------------------
1 | /*
2 | * (C) Copyright IBM Corp. 2017, 2020.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
5 | * the License. You may obtain a copy of the License at
6 | *
7 | * http://www.apache.org/licenses/LICENSE-2.0
8 | *
9 | * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
10 | * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
11 | * specific language governing permissions and limitations under the License.
12 | */
13 |
14 | public virtual class IBMWatsonRequestBody {
15 |
16 | public IBMWatsonMediaType contentType {get;set;}
17 | public Long contentSize {get;set;}
18 | public String content {get;set;}
19 | public Blob blobContent {get;set;}
20 | public String name {get;set;}
21 |
22 | private static final String UTF_8 = 'UTF-8';
23 |
24 | public IBMWatsonRequestBody() {
25 | name = '';
26 | }
27 |
28 | public IBMWatsonMediaType bodyContentType() {
29 | return contentType;
30 | }
31 |
32 | public Boolean hasBase64Data() {
33 | return blobContent != null;
34 | }
35 |
36 | public static IBMWatsonRequestBody create() {
37 | IBMWatsonRequestBody reqBody = new IBMWatsonRequestBody();
38 | reqBody.contentSize = 0;
39 | reqBody.content = null;
40 | reqBody.contentType = null;
41 | return reqBody;
42 | }
43 |
44 | public static IBMWatsonRequestBody create(String content, IBMWatsonMediaType contentType) {
45 | IBMWatsonRequestBody reqBody = new IBMWatsonRequestBody();
46 | String charset = UTF_8;
47 | if (contentType != null) {
48 | charset = contentType.charset;
49 | if (String.isBlank(charset)) {
50 | charset = UTF_8;
51 | contentType = IBMWatsonMediaType.parse(contentType + '; charset=utf-8');
52 | }
53 | }
54 | reqBody.contentSize = (String.isNotBlank(content)) ? content.length() : 0;
55 | reqBody.contentType = contentType;
56 | reqBody.content = content;
57 | return reqBody;
58 | }
59 |
60 | public static IBMWatsonRequestBody create(IBMWatsonFile fileContent, String contentType) {
61 | IBMWatsonMediaType mediaType = (contentType != null) ? IBMWatsonMediaType.parse(contentType) : IBMWatsonHttpMediaType.BINARY_FILE;
62 | return create(fileContent, mediaType);
63 | }
64 |
65 | public static IBMWatsonRequestBody create(IBMWatsonFile fileContent, IBMWatsonMediaType mediaType) {
66 | IBMWatsonRequestBody reqBody = new IBMWatsonRequestBody();
67 | reqBody.contentSize = (fileContent != null) ? fileContent.bodyLength() : 0;
68 | reqBody.contentType = mediaType;
69 | reqBody.blobContent = fileContent.body();
70 | reqBody.name = fileContent.name();
71 | return reqBody;
72 | }
73 | }
74 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonRequestBody.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonRequestBuilder.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonResponse.cls:
--------------------------------------------------------------------------------
1 | /*
2 | * (C) Copyright IBM Corp. 2017, 2020.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
5 | * the License. You may obtain a copy of the License at
6 | *
7 | * http://www.apache.org/licenses/LICENSE-2.0
8 | *
9 | * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
10 | * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
11 | * specific language governing permissions and limitations under the License.
12 | */
13 |
14 | public with sharing class IBMWatsonResponse {
15 | private static final String ERRORS_KEY = 'errors';
16 | private static final String MESSAGE_STRING = 'message';
17 | private static final String ERROR_STRING = 'error';
18 |
19 | private final String errorMessage;
20 | private final String contentType;
21 | private final String globalTransactionId;
22 | private final String url;
23 | private final HttpResponse httpResponse;
24 |
25 | public IBMWatsonResponse(String url, HttpResponse httpResponse) {
26 | this.httpResponse = httpResponse;
27 |
28 | this.url = url;
29 | this.contentType = this.getHeader(IBMWatsonHttpHeaders.CONTENT_TYPE);
30 | this.globalTransactionId = this.getHeader(IBMWatsonHttpHeaders.X_GLOBAL_TRANSACTION_ID);
31 |
32 | if (!isSuccessful()) {
33 | this.errorMessage = getErrorMessage(httpResponse.getBody());
34 | }
35 | }
36 |
37 | public String getBody() {
38 | return this.httpResponse.getBody();
39 | }
40 |
41 | public Blob getBodyAsBlob() {
42 | return this.httpResponse.getBodyAsBlob();
43 | }
44 |
45 | public String getHeader(String key) {
46 | // we'll try the lowercase key too as a fallback
47 | String lowerCaseKey = key.toLowerCase();
48 |
49 | String headerVal = this.httpResponse.getHeader(key);
50 | if (headerVal == null) {
51 | headerVal = this.httpResponse.getHeader(lowerCaseKey);
52 | }
53 |
54 | return headerVal;
55 | }
56 |
57 | public String[] getHeaderKeys() {
58 | return this.httpResponse.getHeaderKeys();
59 | }
60 |
61 | public Integer getStatusCode() {
62 | return this.httpResponse.getStatusCode();
63 | }
64 |
65 | public String getStatus() {
66 | return this.httpResponse.getStatus();
67 | }
68 |
69 | public Boolean isSuccessful() {
70 | return (this.getStatusCode() >= 200 && this.getStatusCode() < 300);
71 | }
72 |
73 | private String getErrorMessage(String errorResponse) {
74 | String error = errorResponse;
75 | try {
76 | Map responseMap = (Map) JSON.deserializeUntyped(errorResponse);
77 | if (responseMap.containsKey(ERRORS_KEY)) {
78 | List> errorList = (List>) responseMap.get(ERRORS_KEY);
79 | error = errorList[0].get(MESSAGE_STRING);
80 | } else if (responseMap.containsKey(ERROR_STRING)) {
81 | error = (String) responseMap.get(ERROR_STRING);
82 | } else if (responseMap.containsKey(MESSAGE_STRING)) {
83 | error = (String) responseMap.get(MESSAGE_STRING);
84 | }
85 | } catch (Exception e) {
86 | // Ignore any kind of exception parsing the json and use fallback String version of response
87 | }
88 |
89 | return error;
90 | }
91 | }
92 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonResponse.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonResponseModel.cls:
--------------------------------------------------------------------------------
1 | /*
2 | * (C) Copyright IBM Corp. 2018, 2020.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
5 | * the License. You may obtain a copy of the License at
6 | *
7 | * http://www.apache.org/licenses/LICENSE-2.0
8 | *
9 | * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
10 | * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
11 | * specific language governing permissions and limitations under the License.
12 | */
13 |
14 | public virtual class IBMWatsonResponseModel extends IBMWatsonGenericModel {
15 | private Map headers = new Map();
16 |
17 | /**
18 | * Allows user to see the JSON string by default for easier debugging.
19 | *
20 | * @return serialized String form of this
21 | */
22 | public override String toString() {
23 | // remove response headers from string representation
24 | Map fullJsonMap = (Map) JSON.deserializeUntyped(JSON.serialize(this, true));
25 | fullJsonMap.remove('headers');
26 |
27 | // raise additional props
28 | fullJsonMap = IBMWatsonJSONUtil.raiseAdditionalProperties(fullJsonMap);
29 |
30 | // pretty print formatting
31 | return JSON.serializePretty(fullJsonMap);
32 | }
33 |
34 | /**
35 | * Gets the response headers attached to this response model.
36 | */
37 | public Map getHeaders() {
38 | return this.headers;
39 | }
40 |
41 | /**
42 | * Adds a header to this response model.
43 | *
44 | * Meant to only be used internally to populate response headers from the IBMWatsonService class.
45 | */
46 | public void addHeader(String name, String value) {
47 | if (this.headers == null) {
48 | this.headers = new Map();
49 | }
50 | this.headers.put(name, value);
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonResponseModel.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonResponseModelTest.cls:
--------------------------------------------------------------------------------
1 | /*
2 | * (C) Copyright IBM Corp. 2019, 2020.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
5 | * the License. You may obtain a copy of the License at
6 | *
7 | * http://www.apache.org/licenses/LICENSE-2.0
8 | *
9 | * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
10 | * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
11 | * specific language governing permissions and limitations under the License.
12 | */
13 |
14 | @isTest
15 | private class IBMWatsonResponseModelTest {
16 | private class TestModel extends IBMWatsonResponseModel {
17 | private String team;
18 |
19 | public TestModel() {
20 | team = 'buckeyes';
21 | }
22 | }
23 |
24 | static testMethod void testEquals() {
25 | Test.startTest();
26 |
27 | TestModel testModel1 = new TestModel();
28 | TestModel testModel2 = new TestModel();
29 | System.assert(testModel1.equals(testModel2));
30 |
31 | Test.stopTest();
32 | }
33 |
34 | static testMethod void testHeaders() {
35 | Test.startTest();
36 |
37 | String headerKey = 'key';
38 | String headerVal = 'val';
39 | TestModel testModel = new TestModel();
40 | testModel.addHeader(headerKey, headerVal);
41 | System.assert(testModel.getHeaders().size() == 1);
42 | System.assertEquals(headerVal, testModel.getHeaders().get(headerKey));
43 |
44 | Test.stopTest();
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonResponseModelTest.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonService.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonServiceExceptions.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonServiceTest.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonTokenRequestBasedAuthenticator.cls:
--------------------------------------------------------------------------------
1 | /*
2 | * (C) Copyright IBM Corp. 2019, 2020.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
5 | * the License. You may obtain a copy of the License at
6 | *
7 | * http://www.apache.org/licenses/LICENSE-2.0
8 | *
9 | * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
10 | * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
11 | * specific language governing permissions and limitations under the License.
12 | */
13 |
14 | /**
15 | * This class serves as a common base class for IBMWatsonAuthenticator implementations that interact with a Token Server
16 | * via a REST interface.
17 | * This base class allows for the configuration of the following properties:
18 | * username/password - if specified, these values will be used to build a basic auth Authorization header
19 | * to be sent with requests to the Token Server.
20 | * headers - a Map of keys/values that will be set as headers on requests sent to the Token Server.
21 | */
22 | public abstract class IBMWatsonTokenRequestBasedAuthenticator extends IBMWatsonAuthenticatorBase implements IBMWatsonAuthenticator {
23 | private String username;
24 | private String password;
25 | private Map headers;
26 |
27 | // The cached value of the Authorization header.
28 | private String authHeader;
29 |
30 | public void setBasicAuthInfo(String username, String password) {
31 | this.username = username;
32 | this.password = password;
33 | this.authHeader = constructBasicAuthHeader(this.username, this.password);
34 | }
35 |
36 | /**
37 | * @return the basic auth username configured for this IBMWatsonAuthenticator
38 | */
39 | public String getUsername() {
40 | return this.username;
41 | }
42 |
43 | /**
44 | * @return the basic auth password configured for this IBMWatsonAuthenticator
45 | */
46 | public String getPassword() {
47 | return this.password;
48 | }
49 |
50 | /**
51 | * Returns the set of user-supplied headers configured for this IBMWatsonAuthenticator.
52 | *
53 | * @return a Map containing the configured headers
54 | */
55 | public Map getHeaders() {
56 | return headers;
57 | }
58 |
59 | /**
60 | * Sets a Map of key/value pairs which will be sent as HTTP headers in any interactions with the Token Server.
61 | *
62 | * @param headers the user-supplied headers to be included in Token Server interactions
63 | */
64 | public void setHeaders(Map headers) {
65 | this.headers = headers;
66 | }
67 |
68 | public abstract String authenticationType();
69 | public abstract void authenticate(IBMWatsonRequest.Builder requestBuilder);
70 | public abstract void validate();
71 |
72 | public IBMWatsonTokenServerResponse invokeRequest(IBMWatsonRequest request, Type targetTokenType) {
73 | IBMWatsonRequest.Builder requestBuilder = request.newBuilder();
74 |
75 | // If present, set the Authorization header to be sent to the token server.
76 | if (String.isNotBlank(this.authHeader)) {
77 | requestBuilder.addHeader(IBMWatsonHttpHeaders.AUTHORIZATION, this.authHeader);
78 | }
79 |
80 | // Now add any user-supplied headers to the request.
81 | if (this.headers != null && !this.headers.isEmpty()) {
82 | for (String headerKey : this.headers.keySet()) {
83 | requestBuilder.addHeader(headerKey, this.headers.get(headerKey));
84 | }
85 | }
86 |
87 | // Send request
88 | IBMWatsonResponse response = IBMWatsonClient.executeRequest(requestBuilder.build());
89 |
90 | if (response.isSuccessful() && String.isNotBlank(response.getBody())) {
91 | Map jsonMap = (Map) JSON.deserializeUntyped(response.getBody());
92 | String jsonString = JSON.serialize(jsonMap);
93 | Object targetObject = targetTokenType.newInstance();
94 | return (IBMWatsonTokenServerResponse) ((IBMWatsonResponseModel) targetObject).deserialize(jsonString, jsonMap, targetTokenType);
95 | } else {
96 | Map responseMap = (Map) JSON.deserializeUntyped(response.getBody());
97 | String errorMessage = responseMap.get('errorMessage').toString();
98 | if (errorMessage == null) {
99 | errorMessage = IBMWatsonAuthenticatorBase.ERRORMSG_REQ_FAILED;
100 | }
101 | Integer statusCode = response.getStatusCode();
102 | throw new IBMWatsonServiceExceptions.ResponseException(statusCode, errorMessage, response);
103 | }
104 | }
105 | }
106 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonTokenRequestBasedAuthenticator.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonTokenServerResponse.cls:
--------------------------------------------------------------------------------
1 | /*
2 | * (C) Copyright IBM Corp. 2019, 2020.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
5 | * the License. You may obtain a copy of the License at
6 | *
7 | * http://www.apache.org/licenses/LICENSE-2.0
8 | *
9 | * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
10 | * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
11 | * specific language governing permissions and limitations under the License.
12 | */
13 |
14 | public interface IBMWatsonTokenServerResponse {}
15 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonTokenServerResponse.cls-meta.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | 41.0
4 | Active
5 |
6 |
--------------------------------------------------------------------------------
/force-app/main/default/classes/IBMWatsonValidator.cls:
--------------------------------------------------------------------------------
1 | /*
2 | * (C) Copyright IBM Corp. 2017, 2020.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
5 | * the License. You may obtain a copy of the License at
6 | *
7 | * http://www.apache.org/licenses/LICENSE-2.0
8 | *
9 | * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
10 | * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
11 | * specific language governing permissions and limitations under the License.
12 | */
13 |
14 | /**
15 | * This class assists in validating arguments.
16 | * If an argument value is deemed invalid, an IllegalArgumentException is thrown.
17 | */
18 | public class IBMWatsonValidator {
19 |
20 | private IBMWatsonValidator() {
21 | // This is a utility class - no instantiation allowed.
22 | }
23 |
24 | /**
25 | * Validates that the argument condition is true; otherwise throwing an exception with the specified
26 | * message. This method is useful when validating according to an arbitrary boolean expression, such as validating a
27 | * primitive number or using your own custom validation expression.
28 | *
29 | *
30 | * @param expression the boolean expression to check
31 | * @param message the exception message if invalid
32 | * @throws IllegalArgumentException if expression is false
33 | */
34 | public static void isTrue(boolean expression, String message) {
35 | if (!expression) {
36 | throw new IBMWatsonServiceExceptions.IllegalArgumentException(message);
37 | }
38 | }
39 |
40 | /**
41 | * Validates that the specified argument array is neither null nor a length of zero (no elements);
42 | * otherwise throwing an exception with the specified message.
43 | *
44 | * @param array the array to check
45 | * @param message the exception message if invalid
46 | * @throws IllegalArgumentException if the array is empty
47 | */
48 | public static void notEmpty(List