Reqres

Simple network activity logger for iOS

Showing:

Popularity

Downloads/wk

0

GitHub Stars

82

Maintenance

Last Commit

7mos ago

Contributors

9

Package

Dependencies

0

License

MIT

Categories

Readme

ackee|Reqres

Tests Version License Carthage Compatible Platform

Reqres is a simple library for logging all requests and responses in your app. It supports Alamofire and also requests made via native NSURLSession.

⬆️ POST 'https://ackee.cz/examples'
Headers: [
    Accept-Encoding : gzip;q=1.0, compress;q=0.5
    Accept-Language : en-US;q=1.0
    Content-Type : application/json
    User-Agent : Reqres_Example/org.cocoapods.demo.Reqres-Example (1; OS Version 9.3 (Build 13E230))
    Content-Length : 13
]
Body: {
    "foo" : "bar"
}

...

⬇️ POST https://ackee.cz/examples (✅ 201 Created) [time: 0.54741 s]
Headers: [
    Vary : Authorization,Accept-Encoding
    Content-Encoding : gzip
    Content-Length : 13
    Server : Apache
    Content-Type : application/json
    Date : Mon, 05 Sep 2016 07:33:51 GMT
    Cache-Control : no-cache
]
Body: {
    "foo" : "bar"
}

Installation

CocoaPods

Reqres is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "Reqres"

Carthage

You can use Carthage. Specify in Cartfile:

github "AckeeCZ/Reqres"

Run carthage update to build the framework and drag the built Reqres.framework into your Xcode project. Follow build instructions. New Issue.

Usage

Initialization is different for usage with Alamofire and NSURLSession.

Alamofire

Create your SessionManager with proper configuration to make it work with Alamofire.

let configuration = Reqres.defaultSessionConfiguration()
configuration.httpAdditionalHeaders = SessionManager.defaultHTTPHeaders
let alamofireManager = SessionManager(configuration: configuration)
Reqres.sessionDelegate = alamofireManager.delegate

Then you must use this manager for all requests, so replace all Alamofire.request(...) to alamofireManager.request(...)

Usage without Alamofire

Register Reqres on application startup and it will monitor and log any requests you make via NSURLSession or NSURLConnection.

Reqres.register()

Customization

You can do some settings to make it fit your needs.

Custom logger

Reqres uses default print() for logging to avoid unnecessary dependencies but it's ready for any logging framework. Make your custom logger class which complies to ReqresLogging protocol and set it to Reqres, that's all.

class MyLogger: ReqresLogging {
    ...
}

Reqres.logger = MyLogger()

Log level

You can use 3 different log levels:

  • None - made for production use, it completely disables all Reqres functionality
  • Light - Logs only basic info (method, url, status code and time)
⬆️ POST 'https://ackee.cz/examples'
...
⬇️ POST https://ackee.cz/examples (✅ 201 Created) [time: 0.54741 s]
  • Verbose - Logs also headers and body (see example above)

Reqres uses Verbose log level by default. To change log level just set right value to Reqres.logger.logLevel

Emoji

Reqres uses emoji to make log better to read and to make it at least a little funny and nice. If you dont't like that, you can turn it off of course.

Reqres.allowUTF8Emoji = false

Forking this repository

If you use Reqres in your projects drop us as tweet at @ackeecz. We would love to hear about it!

Sharing is caring

This tool and repo has been opensourced within our #sharingiscaring action when we have decided to opensource our internal projects.

Author

Ackee team. We were inspired by andysmart's Timberjack

License

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100