Swiftpack.co - Package - sunshinejr/Moya-ModelMapper

Moya-ModelMapper

CocoaPods

ModelMapper bindings for Moya for easier JSON serialization with RxSwift and ReactiveCocoa bindings.

Installation

CocoaPods

pod 'Moya-ModelMapper', '7.1.0'

The subspec if you want to use the bindings over RxSwift.

pod 'Moya-ModelMapper/RxSwift', '7.1.0'

And the subspec if you want to use the bindings over ReactiveSwift.

pod 'Moya-ModelMapper/ReactiveSwift', '7.1.0'

Carthage

Specify in Cartfile:

github "sunshinejr/Moya-ModelMapper" "7.1.0"

Carthage users can point to this repository and use whichever generated framework they'd like, Moya-ModelMapper, RxMoya-ModelMapper, or ReactiveMoya-ModelMapper.

Swift Package Manager

Add the following as a dependency to your Package.swift.

.package(url: "https://github.com/sunshinejr/Moya-ModelMapper.git", .exact("7.1.0"))

The bindings are available through Moya_ModelMapper module. If you are interested in reactive extensions, use ReactiveMoya_ModelMapper or RxMoya_ModelMapper respectively.

Usage

Create a model struct or class. It needs to implement protocol Mappable.

import Foundation
import Mapper

struct Repository: Mappable {

    let identifier: Int
    let language: String
    let url: String? // Optional property

    init(map: Mapper) throws {
        try identifier = map.from("id")
        try language = map.from("language")
        url = map.optionalFrom("url") // Optional property
    }

}

Then you have methods that extends the response from Moya. These methods are:

map(to:)
map(to:keyPath:)
compactMap(to:)
compactMap(to:keyPath)

While using map(to:) tries to map whole response data to object/array, with map(to:keyPath:) you can specify nested object in a response to fetch. For example map(to: User.self, keyPath: "data.response.user") will go through dictionary of data, through dictionary of response to dictionary of user, which it will parse. compactMap is a variant of array map that doesn't fail the whole operation if one of the objects fails, it will just remove the object from the array. RxSwift and ReactiveCocoa extensions also have all of the methods, but RxSwift have optional mapping additionally. See examples below, or in a Demo project.

1. Normal usage (without RxSwift or ReactiveCocoa)

provider = MoyaProvider<GitHub>(endpointClosure: endpointClosure)
provider.request(GitHub.repos("mjacko")) { (result) in
    if case .success(let response) = result {
        do {
            let repos = try response.map(to: [Repository].self)
            print(repos)
        } catch Error.jsonMapping(let error) {
            print(try? error.mapString())
        } catch {
            print(":(")
        }
    }
}

2. RxSwift

provider = MoyaProvider<GitHub>(endpointClosure: endpointClosure)
provider.rx.request(GitHub.repo("Moya/Moya"))
    .map(to: User.self, keyPath: "owner")
    .subscribe { event in
        switch event {
        case .success(let user):
            print(user)
        case .error(let error):
            print(error)
        }
}

Additionally, modules for RxSwift contains optional mappings. It basically means that if the mapping fails, mapper doesn't throw errors but returns nil. For instance:

provider = MoyaProvider<GitHub>(endpointClosure: endpointClosure)
provider.rx.request(GitHub.repos("mjacko"))
    .mapOptional(to: [Repository].self)
    .subscribe { event in
        switch event {
        case .success(let repos):
            // Here we can have either nil or [Repository] object.
            print(repos)
        case .error(let error):
            print(error)
        }
}

3. ReactiveSwift

provider = MoyaProvider<GitHub>(endpointClosure: endpointClosure)
provider.reactive.request(GitHub.repos("mjacko"))
    .map(to: [Repository].self)
    .observeOn(UIScheduler())
    .start { event in
        switch event {
        case .value(let repos):
            print(repos)
        case .failed(let error):
            print(error)
        default: break
        }
}

Author

Sunshinejr, thesunshinejr@gmail.com, @thesunshinejr

License

Moya-ModelMapper is available under the MIT license. See the LICENSE file for more info.

Github

link
Stars: 103
Help us keep the lights on

Releases

7.1.0 - Apr 21, 2018

Added compactMap as a variation of mapping an array that doesn't fail when one of the objects fails. All reactive extensions get them as well! 🎉

7.0.2 - Mar 7, 2018

Changes:

  • Fixed a bug that Single extensions still had observing on schedulers that Observable extensions had removed in Moya-ModelMapper 6.0.

7.0.0 - Feb 10, 2018

Changes:

  • Moya updated to 11.0.0

6.0.0 - Oct 24, 2017

Changes since 6.0.0-beta.1:

  • Fixed SPM integration for reactive providers.
  • Moya updated to 10.0.0

Full changelog for Moya-ModelMapper 6.0.0:

  • Breaking change Removed observing schedulers from mapping. Take a look at MigrationGuide.md.
  • Fixed SPM integration for reactive providers.
  • Updated Moya 10.0.0
  • SPM updated to SPMv4
  • Carthage support for tvOS, macOS and watchOS

6.0.0-beta.1 - Oct 11, 2017

  • Breaking change Removed observing schedulers from mapping. Take a look at MigrationGuide.md.
  • Updated Moya 10.0.0-beta.1
  • SPM updated to SPMv4
  • Carthage support for tvOS, macOS and watchOS