Added testing and travis/codecov integrations (#19)

* Added testing and travis/codecov integrations

* Small fixes

* Fixed travis yml

Author: dingwilson

.gitignore

@@ -1,4 +1,4 @@
 .DS_Store
 build/
 DerivedData/
-xcuserdata
+xcuserdata

.travis.yml

@@ -7,14 +7,23 @@ branches:
     master
 
 before_install:
+  - gem install xcpretty
+  - gem install xcpretty-json-formatter
   - git clone https://github.com/dingwilson/devops-ci.git
 
+env:
+  matrix:
+    - UDID="7A5E86EB-E32C-475F-8FF5-10AA330C1D34", IOS_DEVICE="iPhone 7 Plus (11.1)"
+    - UDID="80BE80F4-C243-43F0-BD95-5CB085DAD04F", IOS_DEVICE="iPhone 6 (8.1)"
+
 script:
   - set -o pipefail
-
-  - pod spec lint
-
+  - open -a "simulator" --args -CurrentDeviceUDID $UDID
+  - xcodebuild clean test -project RandomUserSwift.xcodeproj -scheme RandomUserSwift -configuration Debug -sdk iphonesimulator -destination "platform=iOS Simulator,id=$UDID" CODE_SIGN_IDENTITY=\"\" CODE_SIGNING_REQUIRED=NO ONLY_ACTIVE_ARCH=NO -enableCodeCoverage yes | XCPRETTY_JSON_FILE_OUTPUT="xcodebuild.json" xcpretty -f `xcpretty-json-formatter`
+  - bash <(curl -s https://codecov.io/bash)
   - bundle exec danger --fail-on-errors=true
 
-after_success:
-  - source ./devops-ci/gen_jazzy_docs.sh
+jobs:
+  include:
+    - stage: jazzy
+      script: source ./devops-ci/gen_jazzy_docs.sh

Dangerfile

@@ -3,3 +3,6 @@ warn('PR is classed as Work in Progress', sticky: false) if github.pr_title.incl
 
 # Run SwiftLint
 swiftlint.lint_files
+
+# Report any xcodebuild warnings/errors
+xcode_summary.report 'xcodebuild.json'

Gemfile

@@ -4,3 +4,4 @@ source "https://rubygems.org"
 
 gem "danger"
 gem "danger-swiftlint"
+gem "danger-xcode_summary"

README.md

@@ -3,6 +3,8 @@
 </p>
 
 [![Build Status](https://travis-ci.org/dingwilson/RandomUserSwift.svg?branch=master)](https://travis-ci.org/dingwilson/RandomUserSwift)
+[![codecov](https://codecov.io/gh/dingwilson/RandomUserSwift/branch/master/graph/badge.svg)](https://codecov.io/gh/dingwilson/RandomUserSwift)
+[![doccov](https://wilsonding.com/RandomUserSwift/badge.svg)](https://wilsonding.com/RandomUserSwift)
 [![CocoaPods Version Status](https://img.shields.io/cocoapods/v/RandomUserSwift.svg)](https://cocoapods.org/pods/RandomUserSwift)
 [![Carthage compatible](https://img.shields.io/badge/Carthage-Compatible-brightgreen.svg?style=flat)](https://github.com/Carthage/Carthage)
 [![CocoaPods](https://img.shields.io/cocoapods/dt/RandomUserSwift.svg)](https://cocoapods.org/pods/RandomUserSwift)
@@ -50,7 +52,7 @@ import RandomUserSwift
 Then, use the `getUsers` function via the `shared` singleton with a completion handler.
 
 ```swift
-RandomUser.shared.getUsers() { data, error in
+RandomUser.shared.getUsers { data, error in
     guard let data = data else { return }
 
     print(data)

RandomUserSwift.xcodeproj/project.pbxproj

@@ -376,6 +376,7 @@
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = RandomUserSwift/Info.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
+				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = com.wilsonding.RandomUserSwift;
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -398,6 +399,7 @@
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = RandomUserSwift/Info.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
+				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = com.wilsonding.RandomUserSwift;
 				PRODUCT_NAME = "$(TARGET_NAME)";

RandomUserSwift/RandomUser.swift

@@ -15,7 +15,7 @@ public class RandomUser {
     public static let shared = RandomUser()
 
     /// API Version Number
-    public static var apiVersion = 1.2
+    private static var apiVersion = 1.2
 
     /**
      Get one or more users from RandomUser API (https://www.randomuser.me/documentation)
@@ -32,7 +32,7 @@ public class RandomUser {
     public func getUsers(results: Int = 1,
                          gender: String = "both",
                          nationality: String = "",
-                         completionHandler: @escaping (_ data: Users?, _ error: Error?) -> Void) {
+                         _ completionHandler: @escaping (_ data: Users?, _ error: Error?) -> Void) {
 
         guard let url = createUrl(results: results, gender: gender, nationality: nationality) else { return }
 
@@ -46,7 +46,6 @@ public class RandomUser {
             }
 
             let users = try? JSONDecoder().decode(Users.self, from: data)
-
             completionHandler(users, nil)
         }
 

RandomUserSwift/Users.swift

@@ -10,33 +10,33 @@ import Foundation
 
 /// Codable Struct conforming to return payload from RandomUser API call
 public struct Users: Codable {
-    let results: [Result]
-    let info: Info
+    let results: [Result]?
+    let info: Info?
 }
 
 struct Info: Codable {
-    let seed: String
-    let results, page: Int
-    let version: String
+    let seed: String?
+    let results, page: Int?
+    let version: String?
 }
 
 struct Result: Codable {
-    let gender: Gender
-    let name: Name
-    let location: Location
-    let email: String
-    let login: Login
-    let dob, registered: Dob
-    let phone, cell: String
+    let gender: Gender?
+    let name: NameClass?
+    let location: Location?
+    let email: String?
+    let login: Login?
+    let dob, registered: Dob?
+    let phone, cell: String?
     // swiftlint:disable identifier_name
-    let id: ID
-    let picture: Picture
-    let nat: String
+    let id: ID?
+    let picture: Picture?
+    let nat: String?
 }
 
 struct Dob: Codable {
-    let date: Date
-    let age: Int
+    let date: String?
+    let age: Int?
 }
 
 enum Gender: String, Codable {
@@ -46,19 +46,35 @@ enum Gender: String, Codable {
 
 // swiftlint:disable type_name
 struct ID: Codable {
-    let name: String
+    let name: NameEnum?
     let value: String?
 }
 
+enum NameEnum: String, Codable {
+    case avs = "AVS"
+    case bsn = "BSN"
+    case cpr = "CPR"
+    case dni = "DNI"
+    case empty = ""
+    // swiftlint:disable identifier_name
+    case fn = "FN"
+    case hetu = "HETU"
+    case insee = "INSEE"
+    case nino = "NINO"
+    case pps = "PPS"
+    case ssn = "SSN"
+    case tfn = "TFN"
+}
+
 struct Location: Codable {
-    let street, city, state: String
-    let postcode: Postcode
-    let coordinates: Coordinates
-    let timezone: Timezone
+    let street, city, state: String?
+    let postcode: Postcode?
+    let coordinates: Coordinates?
+    let timezone: Timezone?
 }
 
 struct Coordinates: Codable {
-    let latitude, longitude: String
+    let latitude, longitude: String?
 }
 
 enum Postcode: Codable {
@@ -75,7 +91,6 @@ enum Postcode: Codable {
             self = .string(value)
             return
         }
-
         throw DecodingError.typeMismatch(Postcode.self,
                                          DecodingError.Context(codingPath: decoder.codingPath,
                                                                debugDescription: "Wrong type for Postcode"))
@@ -93,21 +108,22 @@ enum Postcode: Codable {
 }
 
 struct Timezone: Codable {
-    let offset, description: String
+    let offset, description: String?
 }
 
 struct Login: Codable {
-    let uuid, username, password, salt: String
-    let md5, sha1, sha256: String
+    let uuid, username, password, salt: String?
+    let md5, sha1, sha256: String?
 }
 
-struct Name: Codable {
-    let title: Title
-    let first, last: String
+struct NameClass: Codable {
+    let title: Title?
+    let first, last: String?
 }
 
 enum Title: String, Codable {
     case madame
+    case mademoiselle
     case miss
     case monsieur
     // swiftlint:disable identifier_name
@@ -118,5 +134,5 @@ enum Title: String, Codable {
 }
 
 struct Picture: Codable {
-    let large, medium, thumbnail: String
+    let large, medium, thumbnail: String?
 }

RandomUserSwiftTests/RandomUserSwiftTests.swift

@@ -11,26 +11,84 @@ import XCTest
 
 class RandomUserSwiftTests: XCTestCase {
 
+    var data: Users?
+    var error: Error?
+
+    var expectation: XCTestExpectation?
+
     override func setUp() {
         super.setUp()
-        // Put setup code here. This method is called before the invocation of each test method in the class.
+
+        self.error = nil
+        self.data = nil
+        self.expectation = self.expectation(description: "api")
     }
 
     override func tearDown() {
-        // Put teardown code here. This method is called after the invocation of each test method in the class.
+        XCTAssertNil(self.error, "Running getUsers returns non-nil error.")
+        XCTAssertNotNil(self.data, "Running getUsers returns nil value for data.")
+
+        self.expectation = nil
         super.tearDown()
     }
 
-    func testExample() {
-        // This is an example of a functional test case.
-        // Use XCTAssert and related functions to verify your tests produce the correct results.
+    func testGetUsersWithMultipleResults() {
+        RandomUser.shared.getUsers(results: 5) {
+            self.data = $0
+            self.error = $1
+
+            self.expectation?.fulfill()
+        }
+
+        waitForExpectations(timeout: 5, handler: nil)
+
+        XCTAssertEqual(data?.results?.count,
+                       5,
+                       "Setting multiple results does not generate correct number of users.")
+    }
+
+    func testGetUsersByFemaleGender() {
+        RandomUser.shared.getUsers(gender: "female") {
+            self.data = $0
+            self.error = $1
+
+            self.expectation?.fulfill()
+        }
+
+        waitForExpectations(timeout: 5, handler: nil)
+
+        XCTAssertEqual(data?.results?[0].gender?.rawValue,
+                       "female",
+                       "Setting gender as female does not generate a female user.")
     }
 
-    func testPerformanceExample() {
-        // This is an example of a performance test case.
-        self.measure {
-            // Put the code you want to measure the time of here.
+    func testGetUsersByMaleGender() {
+        RandomUser.shared.getUsers(gender: "male") {
+            self.data = $0
+            self.error = $1
+
+            self.expectation?.fulfill()
         }
+
+        waitForExpectations(timeout: 5, handler: nil)
+
+        XCTAssertEqual(data?.results?[0].gender?.rawValue,
+                       "male",
+                       "Setting gender as male does not generate a male user.")
     }
 
+    func testGetUsersByNationality() {
+        RandomUser.shared.getUsers(nationality: "us") {
+            self.data = $0
+            self.error = $1
+
+            self.expectation?.fulfill()
+        }
+
+        waitForExpectations(timeout: 5, handler: nil)
+
+        XCTAssertEqual(data?.results?[0].nat,
+                       "US",
+                       "Setting nationality as US does not generate a user with US nat.")
+    }
 }