Merge pull request #514 from maxmind/ip-response

Make IP address response optional

Author: wesrice

src/response/models/insights.spec.ts

@@ -10,7 +10,7 @@ describe('Insights()', () => {
 
     const model = new Insights(input);
 
-    expect(model.ipAddress.country).toBeUndefined();
+    expect(model.ipAddress?.country).toBeUndefined();
   });
 
   it('handles empty location responses', () => {
@@ -20,7 +20,17 @@ describe('Insights()', () => {
 
     const model = new Insights(input);
 
-    expect(model.ipAddress.location).toBeUndefined();
+    expect(model.ipAddress?.location).toBeUndefined();
+  });
+
+  it('handles empty IP address responses', () => {
+    let input = cloneDeep(insights) as any;
+    input = input.response.full;
+    delete input.ip_address;
+
+    const model = new Insights(input);
+
+    expect(model.ipAddress).toBeUndefined();
   });
 
   it('allows /email/domain/first_seen to be accessed', () => {

src/response/models/insights.ts

@@ -28,7 +28,7 @@ export default class Insights extends Score {
   /**
    * An object containing GeoIP2 and minFraud Insights information about the IP address.
    */
-  public readonly ipAddress: records.IpAddress;
+  public readonly ipAddress?: records.IpAddress;
   /**
    * An object containing minFraud data related to the shipping address used in the transaction.
    */
@@ -65,7 +65,11 @@ export default class Insights extends Score {
 
   private getIpAddress(
     response: webRecords.InsightsResponse
-  ): records.IpAddress {
+  ): records.IpAddress | undefined {
+    if (!response.ip_address) {
+      return undefined;
+    }
+
     const insights = new GeoInsights(response.ip_address) as records.IpAddress;
 
     if (insights.country && response.ip_address.country) {

src/response/models/score.ts

@@ -20,7 +20,7 @@ export default class Score {
   /**
    * An object containing information about the IP address's risk.
    */
-  public readonly ipAddress: records.ScoreIpAddress;
+  public readonly ipAddress?: records.ScoreIpAddress;
   /**
    * The approximate number of queries remaining for this service before your
    * account runs out of funds.

src/response/web-records.ts

@@ -146,7 +146,7 @@ export interface ScoreResponse {
   readonly disposition?: DispositionWebRecord;
   readonly funds_remaining: number;
   readonly id: string;
-  readonly ip_address: ScoreIpAddress;
+  readonly ip_address?: ScoreIpAddress;
   readonly queries_remaining: number;
   readonly risk_score: number;
   readonly warnings?: Warning[];