ANSCoder/Contacts-App

Contacts-App

This repository contains a Contact-App based on Web APIs. User can see pre fetch contacts list and able to create new contact with this application.

Features

• Contact List
• Create New Contact
• Contact Detail
• Add to favourite
• Edit Details
• Choose Image for Contact
• Swipe to Delete Contact
• Email
• Call
• Messahe

Requirements

• iOS 13.1+
• Xcode 11.1

Project Structure

├─ Common (LoadingViewController, ImageProvider, Endpoints)
├─ Extensions
├─ Entities (Model)
├─ Remote
├─ Interactor
├─ WireFrame
├─ Protocols
├─ Presentor
├─ View (ViewController, Cell, HeaderView)

Swift Package Manager

- Alamofire

    dependencies: [
    .package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.0.0-rc.3")
    ]

- IQKeyboardManagerSwift

    dependencies: [
        .package(url: "https://github.com/hackiftekhar/IQKeyboardManager.git", from: "6.5.0")
    ]

Architecture

• View-Interactor-Presenter-Entity-Routing (VIPER)
  • Main Parts of VIPER

The main parts of VIPER are:

• View: displays what it is told to by the Presenter and relays user input back to the Presenter.
• Interactor: contains the business logic as specified by a use case.
• Presenter: contains view logic for preparing content for display (as received from the Interactor) and for reacting to user inputs (by requesting new data from the Interactor).
• Entity: contains basic model objects used by the Interactor.
• Routing: contains navigation logic for describing which screens are shown in which order.

Image Downloading

import UIKit


struct ImageProvider {
    
    fileprivate let downloadQueue = DispatchQueue(label: "Images cache", qos: DispatchQoS.background)
    internal var cache = NSCache<NSURL, UIImage>()

    
    //MARK: - Fetch image from URL and Images cache
    func loadImages(from url: NSURL, completion: @escaping (_ image: UIImage) -> Void) {
        downloadQueue.async(execute: { () -> Void in
            if let image = self.cache.object(forKey: url) {
                DispatchQueue.main.async {
                    completion(image)
                }
                return
            }
            
            do{
                let data = try Data(contentsOf: url as URL)
                if let image = UIImage(data: data) {
                    DispatchQueue.main.async {
                        self.cache.setObject(image, forKey: url)
                        completion(image)
                    }
                } else {
                    print("Could not decode image")
                }
            }catch {
                print("Could not load URL: \(url): \(error)")
            }
        })
    }
}

Contact API Documentation

Contact API Base API Path.

• EndPoint:

struct API {
    static let baseUrl = "http://gojek-contacts-app.herokuapp.com"
}

protocol Endpoint {
    var path: String { get }
    var url: String { get }
}

enum Endpoints {
    
    enum ImagePath: Endpoint{
        
        case profilePic(String)
        
        public var path: String {
            switch self {
            case .profilePic(let name): return name
            }
        }
        
        public var url: String {
            switch self {
            case .profilePic: return "\(API.baseUrl)\(path)"
            }
        }
    }
    
    enum contactList: Endpoint {
        case fetch
        
        public var path: String {
            switch self {
            case .fetch: return "/contacts.json"
            }
        }
        
        public var url: String {
            switch self {
            case .fetch: return "\(API.baseUrl)\(path)"
            }
        }
    }
    
    enum contactDetail: Endpoint {
        case fetch(_ contactId: String)
        
        public var path: String {
            switch self {
            case .fetch(let id): return "/contacts/\(id).json"
            }
        }
        
        public var url: String {
            switch self {
            case .fetch: return "\(API.baseUrl)\(path)"
            }
        }
    }
}

To load the photo, you can build the full URL following this pattern:

Endpoints.ImagePath.profilePic(model.profilePic).url

Fetch Contact List:

            AF
            .request(Endpoints.contactList.fetch.url, method: .get)
            .validate()
            .responseDecodable { (response: DataResponse<ContactList, AFError>) in
                switch response.result {
                case .success(let contacts):
                    self.remoteRequestHandler?.onContactsRetrieved(contacts)
                case .failure( _):
                    self.remoteRequestHandler?.onError()
                }
        }

Contact Details:

let headers: HTTPHeaders = [
            "Content-Type": "application/json"
        ]
        let urlPath = Endpoints.contactDetail.fetch(contactId).url
       
        AF.request(urlPath,
                   method: .put,
                   parameters: details,
                   encoding: JSONEncoding.default,
                   headers: headers)
            .validate()
            .responseDecodable {[weak self] (response: DataResponse<ContactDetailModel, AFError>) in
                    switch response.result {
                    case .success(let value):
                        self?.remoteRequestHandler?.contactAddedToFavourite(value)
                    case .failure( _):
                        self?.remoteRequestHandler?.onError()
                    }
        }

Edit Details:

let headers: HTTPHeaders = [
            "Content-Type": "application/json"
        ]
        let urlPath = Endpoints.contactDetail.fetch(contactId).url
       
        AF.request(urlPath,
                   method: .put,
                   parameters: details,
                   encoding: JSONEncoding.default,
                   headers: headers)
            .validate()
            .responseJSON {[weak self] response in
                    switch response.result {
                    case .success(let value):
                        self?.remoteRequestHandler?.onSuccessfullyUpdated(value as? [String: Any] ?? [:])
                    case .failure( _):
                        self?.remoteRequestHandler?.onError()
                    }
        }

Create New Contact:

let headers: HTTPHeaders = [
            "Content-Type": "application/json"
        ]
        let urlPath = Endpoints.contactList.fetch.url

        AF.request(urlPath,
                   method: .post,
                   parameters: details,
                   encoding: JSONEncoding.default,
                   headers: headers)
            .validate()
            .responseJSON { response in
                switch response.result {
                case .success(let value):
                    self.remoteRequestHandler?.onSuccessfullyCreated(value as? [String: Any] ?? [:])
                case .failure( _):
                    self.remoteRequestHandler?.onError()
                }
        }

Delete Contact:

let urlPath = Endpoints.contactDetail.fetch(contactId).url
        
        AF.request(urlPath,
                   method: .delete)
            .validate()
            .responseJSON {[weak self] response in
                    switch response.result {
                    case .success:
                        self?.remoteRequestHandler?.onDeleteContactSuccessFully()
                    case .failure( _):
                        self?.remoteRequestHandler?.onError()
                    }
        }

UI Components & Apple APIs

• Storyboard
• Coadable Protocol
• UITableView
• MessageUI
• UIAlertController
• UIImagePickerController

Unit Testing

Test case added for these following views -

• Contact List
• Create New Contact
• Contact Detail
• Add to favourite

👤 Author

Anscoder (Anand Nimje)