Support Component Analysis

Author: LandonSmarty

us-street-api/candidate.go

@@ -70,17 +70,40 @@ type (
 	// Analysis contains all output fields defined here:
 	// https://smartystreets.com/docs/us-street-api#analysis
 	Analysis struct {
-		DPVMatchCode      string `json:"dpv_match_code,omitempty"`
-		DPVFootnotes      string `json:"dpv_footnotes,omitempty"`
-		DPVCMRACode       string `json:"dpv_cmra,omitempty"`
-		DPVVacantCode     string `json:"dpv_vacant,omitempty"`
-		DPVNoStat         string `json:"dpv_no_stat,omitempty"`
-		Active            string `json:"active,omitempty"`
-		Footnotes         string `json:"footnotes,omitempty"` // https://smartystreets.com/docs/us-street-api#footnotes
-		LACSLinkCode      string `json:"lacslink_code,omitempty"`
-		LACSLinkIndicator string `json:"lacslink_indicator,omitempty"`
-		SuiteLinkMatch    bool   `json:"suitelink_match,omitempty"`
-		EWSMatch          bool   `json:"ews_match,omitempty"`      // deprecated
-		EnhancedMatch     string `json:"enhanced_match,omitempty"` //v2 integration
+		DPVMatchCode      string            `json:"dpv_match_code,omitempty"`
+		DPVFootnotes      string            `json:"dpv_footnotes,omitempty"`
+		DPVCMRACode       string            `json:"dpv_cmra,omitempty"`
+		DPVVacantCode     string            `json:"dpv_vacant,omitempty"`
+		DPVNoStat         string            `json:"dpv_no_stat,omitempty"`
+		Active            string            `json:"active,omitempty"`
+		Footnotes         string            `json:"footnotes,omitempty"` // https://smartystreets.com/docs/us-street-api#footnotes
+		LACSLinkCode      string            `json:"lacslink_code,omitempty"`
+		LACSLinkIndicator string            `json:"lacslink_indicator,omitempty"`
+		SuiteLinkMatch    bool              `json:"suitelink_match,omitempty"`
+		EWSMatch          bool              `json:"ews_match,omitempty"`      // deprecated
+		EnhancedMatch     string            `json:"enhanced_match,omitempty"` //v2 integration
+		Components        ComponentAnalysis `json:"components,omitempty"`
+	}
+
+	ComponentAnalysis struct {
+		PrimaryNumber            MatchInfo `json:"primary_number,omitempty"`
+		StreetPredirection       MatchInfo `json:"street_predirection,omitempty"`
+		StreetName               MatchInfo `json:"street_name,omitempty"`
+		StreetPostdirection      MatchInfo `json:"street_postdirection,omitempty"`
+		StreetSuffix             MatchInfo `json:"street_suffix,omitempty"`
+		SecondaryNumber          MatchInfo `json:"secondary_number,omitempty"`
+		SecondaryDesignator      MatchInfo `json:"secondary_designator,omitempty"`
+		ExtraSecondaryNumber     MatchInfo `json:"extra_secondary_number,omitempty"`
+		ExtraSecondaryDesignator MatchInfo `json:"extra_secondary_designator,omitempty"`
+		CityName                 MatchInfo `json:"city_name,omitempty"`
+		StateAbbreviation        MatchInfo `json:"state_abbreviation,omitempty"`
+		ZIPCode                  MatchInfo `json:"zipcode,omitempty"`
+		Plus4Code                MatchInfo `json:"plus4_code,omitempty"`
+		Urbanization             MatchInfo `json:"urbanization,omitempty"`
+	}
+
+	MatchInfo struct {
+		Status string   `json:"status,omitempty"`
+		Change []string `json:"change,omitempty"`
 	}
 )

us-street-api/client_test.go

@@ -198,7 +198,42 @@ func (f *ClientFixture) TestFullJSONResponseDeserialization() {
       "lacslink_code": "lacslink_code",
       "lacslink_indicator": "lacslink_indicator",
       "suitelink_match": true,
-      "enhanced_match": "enhanced_match"
+      "enhanced_match": "enhanced_match",
+	  "components": {
+        "primary_number": {
+          "status": "confirmed"
+        },
+        "street_predirection": {
+          "status": "confirmed",
+          "change": ["added"]
+        },
+        "street_name": {
+          "status": "confirmed"
+        },
+        "street_suffix": {
+          "status": "confirmed",
+          "change": ["added"]
+        },
+        "secondary_number": {
+          "status": "unconfirmed"
+        },
+        "secondary_designator": {
+          "status": "unconfirmed"
+        },
+        "city_name": {
+          "status": "confirmed"
+        },
+        "state_abbreviation": {
+          "status": "confirmed"
+        },
+        "zipcode": {
+          "status": "confirmed"
+        },
+        "plus4_code": {
+          "status": "confirmed",
+          "change": ["corrected"]
+        }
+      }
     }
   }
 ]`
@@ -271,6 +306,64 @@ func (f *ClientFixture) TestFullJSONResponseDeserialization() {
 				SuiteLinkMatch:    true,
 				EWSMatch:          false,
 				EnhancedMatch:     "enhanced_match",
+				Components: ComponentAnalysis{
+					PrimaryNumber: MatchInfo{
+						Status: "confirmed",
+						Change: nil,
+					},
+					StreetPredirection: MatchInfo{
+						Status: "confirmed",
+						Change: []string{"added"},
+					},
+					StreetName: MatchInfo{
+						Status: "confirmed",
+						Change: nil,
+					},
+					StreetPostdirection: MatchInfo{
+						Status: "",
+						Change: nil,
+					},
+					StreetSuffix: MatchInfo{
+						Status: "confirmed",
+						Change: []string{"added"},
+					},
+					SecondaryNumber: MatchInfo{
+						Status: "unconfirmed",
+						Change: nil,
+					},
+					SecondaryDesignator: MatchInfo{
+						Status: "unconfirmed",
+						Change: nil,
+					},
+					ExtraSecondaryNumber: MatchInfo{
+						Status: "",
+						Change: nil,
+					},
+					ExtraSecondaryDesignator: MatchInfo{
+						Status: "",
+						Change: nil,
+					},
+					CityName: MatchInfo{
+						Status: "confirmed",
+						Change: nil,
+					},
+					StateAbbreviation: MatchInfo{
+						Status: "confirmed",
+						Change: nil,
+					},
+					ZIPCode: MatchInfo{
+						Status: "confirmed",
+						Change: nil,
+					},
+					Plus4Code: MatchInfo{
+						Status: "confirmed",
+						Change: []string{"corrected"},
+					},
+					Urbanization: MatchInfo{
+						Status: "",
+						Change: nil,
+					},
+				},
 			},
 		},
 	})