Xniffer - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #golang #android #deep-learning #linux #nodejs #macos #cli #pytorch #ios #openai

Xniffer

(★ 498)

A swift network profiler built on top of URLSession.

File Explorer

Download Latest Version (.zip)

- CONTRIBUTING.md
- ISSUE_TEMPLATE.md
- PULL_REQUEST_TEMPLATE.md
- - AppDelegate.swift
  - Info.plist
- - project.pbxproj
- - ExampleUITests.swift
  - Info.plist
- - Contents.swift
  - contents.xcplayground
- curl.gif
- fetch.gif
- Main.storyboard
- ViewController.swift
- - URLRequest+Xniffer.swift
  - Xniffer.swift
  - XnifferProtocol.swift
- - ConsoleXniffer.swift
  - Resources.swift
  - ResultCell.swift
  - ResultCell.xib
  - XnifferColors.swift
  - XnifferViewController.swift
  - XnifferWindow.swift
- Info.plist
- Xniffer.h
- Info.plist
- XnifferTests.swift
- - contents.xcworkspacedata
- project.pbxproj
- contents.xcworkspacedata
.gitignore
.swift-version
.travis.yml
Cartfile.private
Cartfile.resolved
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
Xniffer.podspec
XnifferLogo.png

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<img src="./XnifferLogo.png" />
<p align="left">
<img src="https://img.shields.io/badge/platform-iOS-blue.svg?style=flat" alt="Platform iOS" />
<a href="https://developer.apple.com/swift"><img src="https://img.shields.io/badge/swift4-compatible-4BC51D.svg?style=flat" alt="Swift 4 compatible" /></a>
<a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible" /></a>
<a href="https://cocoapods.org/pods/Xniffer"><img src="https://img.shields.io/cocoapods/v/Xniffer.svg" alt="CocoaPods compatible" /></a>
<a href="https://raw.githubusercontent.com/xmartlabs/Xniffer/master/LICENSE"><img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License: MIT" /></a>
</p>

By [Xmartlabs SRL](http://xmartlabs.com).

## Introduction

Xniffer is a non-intrusive framework for intercepting outgoing requests and their responses between your app and any external service for debugging and performance monitoring purposes.

<a href="https://github.com/netguru/ResponseDetective"> Inspired by Response detective. </a>

<img src="Example/fetch.gif" width="300"/>
<img src="Example/curl.gif" width="300"/>

## Setup

In order to work, the Xniffer needs to be added as a middleware between your URLSession and the Internet.
After the initial setup, a window will be displayed on top of the UI that will show all the current requests and their latency.

#### Basic usage
```swift

let configuration = URLSessionConfiguration.default
// The setup method adds the Xniffer's custom protocol as a middleware.
Xniffer.setup(with: configuration)
let session = URLSession(configuration: configuration)
```
Now we can start using this session instance for our requests!

#### Using Alamofire
If you are using Alamofire you can start using the Xniffer by initializing your Manager with the following:
```swift

let configuration = URLSessionConfiguration.default
configuration.httpAdditionalHeaders = SessionManager.defaultHTTPHeaders
Xniffer.setup(with: configuration)
let sessionManager = Alamofire.SessionManager(configuration: configuration)
```
### UI Modes
The Xniffer currently supports three modes which could be used at the same time, `.window`, `.console` and `.custom`. The default value is only`.window` but this can be changed easily on the `Xniffer.setup(configuration: URLSessionConfiguration, modes: [XnifferUI] = [.window])`.

Each one of this uses a different implementation of the `XnifferObserver`.

* `.window` : Displays a window on top of the status bar which can be expanded to display a list of the profiled requests. This is the default value.
  * `.console` : Prints the results on the Xcode console.
  * `.custom` : This one receives a closure of type `() -> ()` so you can use your own implementation of the `XnifferObserver`.

## Requirements

* iOS 9.0+
* Xcode 9.0+

## Getting involved

* If you **want to contribute** please feel free to **submit pull requests**.
* If you **have a feature request** please **open an issue**.
* If you **found a bug** or **need help** please **check older issues, [FAQ](#faq) and threads on [StackOverflow](http://stackoverflow.com/questions/tagged/Xniffer) (Tag 'Xniffer') before submitting an issue.**.

Before contribute check the [CONTRIBUTING](https://github.com/xmartlabs/Xniffer/blob/master/CONTRIBUTING.md) file for more info.

If you use **Xniffer** in your app We would love to hear about it! Drop us a line on [twitter](https://twitter.com/xmartlabs).

## Examples

Follow these 3 steps to run Example project: Clone Xniffer repository, open Xniffer workspace and run the *Example* project.
## Installation

#### CocoaPods

[CocoaPods](https://cocoapods.org/) is a dependency manager for Cocoa projects.

To install Xniffer, simply add the following line to your Podfile:

```ruby
pod 'Xniffer', '~> 3.0'
```

#### Carthage

[Carthage](https://github.com/Carthage/Carthage) is a simple, decentralized dependency manager for Cocoa.

To install Xniffer, simply add the following line to your Cartfile:

```ogdl
github "xmartlabs/Xniffer" ~> 3.0
```

## Author

* [Mauricio Cousillas](https://github.com/mcousillas6)

# Change Log

This can be found in the [CHANGELOG.md](CHANGELOG.md) file.