Sauron

1.0.0

👁‍🗨 gotta see 'em all
volatilegg/Sauron

What's New

Narya

2023-04-25T14:43:24Z

Ring of Fire
Three rings for the Elven kings under the sky...

Change logs

  • Initial project
  • Add Cocoapod support and example project
  • Add SPM support and example project
  • Add CI with build action
  • Add MIT license

Sauron

An iOS library to check and share network log easier Easyly embedded into iOS applications

List Simulator Screenshot - iPhone 14 Pro - 2023-04-25 at 15 45 30 Simulator Screenshot - iPhone 14 Pro - 2023-04-25 at 15 45 33 Simulator Screenshot - iPhone 14 Pro - 2023-04-25 at 15 45 35 Simulator Screenshot - iPhone 14 Pro - 2023-04-25 at 15 45 38

Installation

Swift Package Manager

To integrate Sauron into your Xcode using Swift Package Manager, add it to the dependencies of Package.swift

dependencies: [
    .package(url: "https://github.com/volatilegg/Sauron.git", .upToNextMajor(from: "1.0"))
]

Cocoapods

To integrate Sauron into your Xcode using Cocoapod, add it to your Podfile

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '13.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'Sauron', '~> 1.0.0'
end

Usage

1. Network configuration

Default network config

Using Reqres.defaultSessionConfiguration as URLSession.configuration

let url = URL(string: "https://pokeapi.co/api/v2/pokemon/108")!
let urlSessionConfig = Reqres.defaultSessionConfiguration(
  additionalHeaders: ["Content-Type":"application/json; charset=UTF-8"],
  additionalHeaders: 40,
  timeoutIntervalForResource: 40,
  requestCachePolicy: .useProtocolCachePolicy
)
let urlSession = URLSession(configuration: config, delegate: nil, delegateQueue: nil)

urlSession.dataTask(
  with: url,
  completionHandler: { (data, response, error) in
      // handling response callback
  }
)

Inject Reqres.defaultSessionConfiguration into Alamofire.Session(configuration:{{configuration}})

let urlSessionConfig = Reqres.defaultSessionConfiguration(
  additionalHeaders: ["Content-Type":"application/json; charset=UTF-8"],
  additionalHeaders: 40,
  timeoutIntervalForResource: 40,
  requestCachePolicy: .useProtocolCachePolicy
)

// Usage for Alamofire
let sessionManager = Alamofire.Session(configuration: urlSessionConfig)

// Usage for Moya
var provider = MoyaProvider<PokemonAPI>(
  endpointClosure: endpointClosure,
  session: sessionManager,
  plugins: []
)

provider.request(target) { result in
  // handling response callback
}

2. Configure log mode

Note default mode is disabled and should be the mode to use in prodution

Using this snippet to control the mode

// Display all network information
Sauron.shared.logMode = .enable

// Remove all network information
Sauron.shared.logMode = .disable

// Display network information without request's headers
Sauron.shared.logMode = .disableHeader

3. Configure log UI

SwiftUI

Open this view RequestListPresentView() to see the whole log UI

NavigationLink(destination: RequestListPresentView()) {
  Text("Open Log")
}

UIKit

Open this view RequestsListViewController to see the whole log UI

viewController.show(RequestsListViewController.makeViewController())

Description

  • Swift Tools 5.7.0
View More Packages from this Author

Dependencies

  • None
Last updated: Mon Mar 18 2024 02:03:52 GMT-0900 (Hawaii-Aleutian Daylight Time)