AlamofireJsonToObjects

An Alamofire extension which converts JSON response data into swift objects using EVReflection

Code Quality Rank: L4

Programming language: Swift

License: GNU General Public License v3.0 or later

Tags: JSON    

Latest version: v2.4.1

README

AlamofireJsonToObjects

🚨 This is now a subspec of EVReflection and the code is maintained there. 🚨

You can install it as a subspec like this:

use_frameworks!
pod "EVReflection/Alamofire"

Besideds this subspec there are also subspecs for: XML, AlamofireXML, Moya, MoyaRxSwift and MoyaReflectiveSwift

<!--- -->

If you have a question and don't want to create an issue, then we can (EVReflection is the base of AlamofireJsonToObjects)

With AlamofireJsonToObjects it's extremely easy to fetch a json feed and parse it into objects. No property mapping is required. Reflection is used to put the values in the corresponding properties.

AlamofireJsonToObjects is based on the folowing libraries:

• Alamofire is an elegant HTTP Networking library in Swift
• EVReflection is used to parse the JSON result to your objects

This library was greatly inspired by AlamofireObjectMapper

At this moment the master branch is for Swift3. If you want to continue using Swift 2.2 (or 2.3) then switch to the Swift2.2 branch. Run the tests to see AlamofireJsonToObjects in action.

Using AlamofireJsonToObjects in your own App

'AlamofireJsonToObjects' is available through the dependency manager CocoaPods.

You can just add AlamofireJsonToObjects to your workspace by adding the folowing 2 lines to your Podfile:

use_frameworks!
pod "AlamofireJsonToObjects"

you also have to add an import at the top of your swift file like this:

import AlamofireJsonToObjects

Sample code

class WeatherResponse: EVNetworkingObject {
    var location: String?
    var three_day_forecast: [Forecast] = [Forecast]()
}

class Forecast: EVNetworkingObject {
    var day: String?
    var temperature: NSNumber?
    var conditions: String?
}

class AlamofireJsonToObjectsTests: XCTestCase { 
    func testResponseObject() {
        let URL = "https://raw.githubusercontent.com/evermeer/AlamofireJsonToObjects/master/AlamofireJsonToObjectsTests/sample_json"
        Alamofire.request(URL)
            .responseObject { (response: DataResponse<WeatherResponse>) in
            if let result = response.result.value {
                // That was all... You now have a WeatherResponse object with data
           }
        }
        waitForExpectationsWithTimeout(10, handler: { (error: NSError!) -> Void in
            XCTAssertNil(error, "\(error)")
        })
    }
}

The code above will pass the folowing json to the objects:

{  "location": "Toronto, Canada",    
   "three_day_forecast": [
      { "conditions": "Partly cloudy",
        "day" : "Monday",
        "temperature": 20 
      }, { 
        "conditions": "Showers",
        "day" : "Tuesday",
        "temperature": 22 
      }, { 
        "conditions": "Sunny",
        "day" : "Wednesday",
        "temperature": 28 
      }
   ]
}

Advanced object mapping

AlamofireJsonToObjects is based on EVReflection and you can use all EVReflection features like property mapping, converters, validators and key kleanup. See EVReflection for more information.

Handling HTTP status >= 300

When a network call returns a HTTP error status (300 or highter) then this will be added to the evReflectionStatuses as a custom error. see the unit test testErrorResponse as a sample. In order to make this work, you do have to set EVNetworkingObject as your bass class and not EVObject. You then also have to be aware that if you override the initValidation or the propertyMapping function, that you also have to call the super for that function.

License

AlamofireJsonToObjects is available under the MIT 3 license. See the LICENSE file for more info.

My other libraries:

Also see my other open source iOS libraries:

• EVReflection - Swift library with reflection functions with support for NSCoding, Printable, Hashable, Equatable and JSON
• EVCloudKitDao - Simplified access to Apple's CloudKit
• EVFaceTracker - Calculate the distance and angle of your device with regards to your face in order to simulate a 3D effect
• EVURLCache - a NSURLCache subclass for handling all web requests that use NSURLReques
• AlamofireJsonToObject - An Alamofire extension which converts JSON response data into swift objects using EVReflection
• AlamofireXmlToObject - An Alamofire extension which converts XML response data into swift objects using EVReflection and XMLDictionary
• AlamofireOauth2 - A swift implementation of OAuth2 using Alamofire
• EVWordPressAPI - Swift Implementation of the WordPress (Jetpack) API using AlamofireOauth2, AlomofireJsonToObjects and EVReflection (work in progress)
• PassportScanner - Scan the MRZ code of a passport and extract the firstname, lastname, passport number, nationality, date of birth, expiration date and personal numer.