Always return an empty array on scraper failure

Author: tirtow

RepresentsMe/Models/Official.swift

@@ -35,36 +35,19 @@ class Official: Equatable, CustomStringConvertible {
         return repr()                   // official. Conforms class to
     }                                   // CustomStringConvertible protocol.
 
-    /// Creates an Official given the values for each field.
-    ///
-    /// - Parameter index:          The index of the official
-    /// - Parameter name:           The name of the official
-    /// - Parameter photoURL:       The URL to the photo of the official
-    /// - Parameter party:          The political party of the official
-    /// - Parameter addresses:      An Array of addresses for the official
-    /// - Parameter phones:         An Array of phone numbers for the official
-    /// - Parameter emails:         An Array of emails for the official
-    /// - Parameter urls:           An Array of URLs for the official
-    /// - Parameter socialMedia:    An Array of social media accounts
-    /// - Parameter office:         The name of the official's office
-    /// - Parameter division:       The name of the office's division
-    init(_ index:Int, _ name:String, _ photoURL:URL?, _ party:String,
-         _ addresses:[[String: String]], _ phones:[String], _ urls:[URL?],
-         _ emails:[String], _ socialMedia:[[String: String]],
-         _ office:String, _ division:String) {
-        self.index = index
-        self.name = name
-        self.photoURL = photoURL
-        self.party = PoliticalParty.determine(for: party)
-        self.addresses = addresses
-        self.phones = phones
-        self.emails = emails
-        self.urls = urls
-        self.socialMedia = socialMedia
-        self.office = office
-        self.division = division
+    init() {
+        self.index = -1
+        self.name = ""
+        self.party = PoliticalParty.unknown
+        self.addresses = [[:]]
+        self.phones = []
+        self.urls = []
+        self.emails = []
+        self.socialMedia = [[:]]
+        self.office = ""
+        self.division = ""
     }
-    
+
     /// Builds an Official
     ///
     /// - Parameter index:      the index of this Official in the JSON

RepresentsMe/Scraper/OfficialScraper.swift

@@ -44,7 +44,8 @@ class OfficialScraper {
         do {
             urlString = try buildURL(address: address.description, apikey: apikey)
         } catch {
-            return completion(nil, error as? ParserError)
+            // Failed to build the url, return an empty Array
+            return completion([], nil)
         }
 
         let url = URL(string: urlString!)
@@ -53,17 +54,16 @@ class OfficialScraper {
         URLSession.shared.dataTask(with: request) { data, response, error in
             if error != nil {
                 // Error occurred, abort
-                return completion(nil, ParserError.requestFailedError(
-                    error?.localizedDescription ?? "Request failed."))
+                return completion([], nil)
             }
 
             do {
                 // Try to parse the JSON
                 let jsonData = try parseJSON(data: data!)
                 return completion(Official.buildOfficials(data: jsonData), nil)
             } catch {
-                // Error occurred while parsing JSON
-                return completion(nil, error as? ParserError)
+                // Error occurred while parsing JSON, return an empty Array
+                return completion([], nil)
             }
         }.resume()
     }

RepresentsMeTests/OfficialScraperTests.swift

@@ -10,6 +10,17 @@ import XCTest
 @testable import RepresentsMe
 
 class OfficialScraperTests: XCTestCase {
+    
+    let validAddress = Address(streetNumber: "2317",
+                               streetName: "Speedway",
+                               city: "Austin",
+                               state: "TX",
+                               zipcode: "78712")
+    let invalidAddress = Address(streetNumber: "invalid",
+                                 streetName: "",
+                                city: "",
+                                state: "",
+                                zipcode: "")
 
     override func setUp() {
         // Put setup code here. This method is called before the invocation of each test method in the class.
@@ -21,35 +32,33 @@ class OfficialScraperTests: XCTestCase {
 
     /// Test successful scraping of data
     func testScrapingData() {
-        let result = makeRequest(address: "2317 Speedway, Austin, TX 78712",
+        let result = makeRequest(address: validAddress,
                                  apikey: civic_api_key)
         XCTAssertNotNil(result.0)       // Assert no errors
         XCTAssertNil(result.1)          // Assert some result returned
     }
 
-    /// Test that an error is received if an invalid address is given
+    /// Test that an empty array is received if an invalid address is given
     func testInvalidAddress() {
-        let result = makeRequest(address: "invalid", apikey: civic_api_key)
+        let result = makeRequest(address: invalidAddress,
+                                 apikey: civic_api_key)
         let officials = result.0
         let error = result.1
 
-        if case .invalidAddressError = error! {
-            XCTAssertTrue(true)
-        } else {
-            XCTFail("Did not throw ParserError.invalidAddressError")
-        }
-        XCTAssertNil(officials)
+        XCTAssertNotNil(officials)
+        XCTAssertNil(error)
+        XCTAssertEqual(officials, [])
     }
 
-    /// Test that an error is received if an invalid api key is given
+    /// Test that an empty array is received if an invalid API key is given
     func testInvalidAPIKey() {
-        let result = makeRequest(address: "2317 Speedway, Austin, TX 78712",
+        let result = makeRequest(address: validAddress,
                                  apikey: "invalid")
         let officials = result.0
         let error = result.1
 
-        XCTAssertNil(error)
         XCTAssertNotNil(officials)
+        XCTAssertNil(error)
         XCTAssertEqual(officials, [])
     }
 
@@ -101,7 +110,7 @@ class OfficialScraperTests: XCTestCase {
     /// - Parameter apikey:     The apikey to use
     ///
     /// - Returns: a tuple with the resulting Officials and errors if any
-    func makeRequest(address:String, apikey:String,
+    func makeRequest(address:Address, apikey:String,
                      timeout:Double = 10) -> ([Official]?, ParserError?) {
         var error:ParserError?
         var officials:[Official]?

RepresentsMeTests/OfficialScraperTestsData.swift

@@ -93,7 +93,7 @@ class OfficialScraperTestsData {
 
 /// Extend Official with hardcoded values for creating officials when testing
 extension Official {
-    
+
     /// Creates an Official given the values for each field.
     ///
     /// - Parameter index:          The index of the official
@@ -116,7 +116,7 @@ extension Official {
         self.index = index
         self.name = name
         self.photoURL = URL(string: photoURL)
-        self.party = party
+        self.party = PoliticalParty.determine(for: party)
         self.addresses = addresses
         self.phones = phones
         self.emails = emails