Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnsonandjohnson/Guppy-iOS
iOS pod about a curious fish named Guppy
https://github.com/johnsonandjohnson/Guppy-iOS
guppy ios network-monitoring networking swift urlsession
Last synced: 13 days ago
JSON representation
iOS pod about a curious fish named Guppy
- Host: GitHub
- URL: https://github.com/johnsonandjohnson/Guppy-iOS
- Owner: johnsonandjohnson
- License: apache-2.0
- Created: 2019-04-12T13:45:28.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2022-02-03T20:25:07.000Z (almost 3 years ago)
- Last Synced: 2024-12-30T22:22:08.026Z (about 1 month ago)
- Topics: guppy, ios, network-monitoring, networking, swift, urlsession
- Language: Swift
- Homepage:
- Size: 2.87 MB
- Stars: 40
- Watchers: 12
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- top-pharma50 - **johnsonandjohnson/Guppy-iOS** - monitoring`, `networking`, `swift`, `urlsession`<br><img src='https://github.com/HubTou/topgh/blob/main/icons/gstars.png'> 40 <img src='https://github.com/HubTou/topgh/blob/main/icons/forks.png'> 3 <img src='https://github.com/HubTou/topgh/blob/main/icons/code.png'> Swift <img src='https://github.com/HubTou/topgh/blob/main/icons/license.png'> Apache License 2.0 <img src='https://github.com/HubTou/topgh/blob/main/icons/last.png'> 2022-02-03 20:25:07 | (Ranked by starred repositories)
- top-pharma50 - **johnsonandjohnson/Guppy-iOS** - monitoring`, `networking`, `swift`, `urlsession`<br><img src='https://github.com/HubTou/topgh/blob/main/icons/gstars.png'> 40 <img src='https://github.com/HubTou/topgh/blob/main/icons/forks.png'> 3 <img src='https://github.com/HubTou/topgh/blob/main/icons/code.png'> Swift <img src='https://github.com/HubTou/topgh/blob/main/icons/license.png'> Apache License 2.0 <img src='https://github.com/HubTou/topgh/blob/main/icons/last.png'> 2022-02-03 20:25:07 | (Ranked by starred repositories)
README
[](https://img.shields.io/badge/platform-iOS-blue.svg?style=flat)
[](https://developer.apple.com/swift)
[](https://cocoapods.org/pods/Guppy)
[](https://github.com/Carthage/Carthage)
[](https://codecov.io/gh/johnsonandjohnson/Guppy-iOS)
[](https://opensource.org/licenses/Apache-2.0)
Do you want to know what's tedious? Debugging network requests and responses if you don't have the right tools. Guppy is a logging tool focused on HTTP requests that can be easily plugged into any iOS application. Guppy will intercept and log each network request sent from the app. You can access any Guppy log and share it with the rest of your team effortlessly.
## Usage
While in the simulator you can use: `^ + ⌘ + z` to bring up Guppy or shake your phone.
You can dig deep into the details of your network logs and share them with your team or yourself.
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
### URLSession
```swift
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
Guppy.registerURLProtocol()
return true
}
}
```
### URLSession with Custom Protocols
```swift
class Session: URLSession {
init() {
let configuration = URLSessionConfiguration.default
configuration.urlCache = nil
// Protocols are evaluated in reverse order
// If GuppyURLProtocol is not the last protocol it is not guaranteed to be executed
configuration.protocolClasses = [MyCustomProtocol, GuppyURLProtocol.self]
super.init(configuration: configuration)
}
}
```
### Alamofire
```swift
class SessionManager: Alamofire.SessionManager {
init() {
let configuration = URLSessionConfiguration.default
configuration.urlCache = nil
configuration.protocolClasses = [GuppyURLProtocol.self]
super.init(configuration: configuration)
}
}
```
## Requirements
* Xcode 12.0+
* iOS 13.0+
## Installation
Guppy is best used in non-production environments. By default, installing the Guppy framework will automatically make it available when the user shakes their device. To avoid this do any combination of the following:
* If you are using multiple targets for different environments, only include the Guppy framework in the non-production targets
* If you are using one target with multiple configurations for different environments, only include the Guppy framework in the non-production configuration
* Set `Guppy.shared.showOnShake = false` in your `didFinishLaunchingWithOptions` for the specific times where Guppy should not be available
### [Swift Package Manager](https://swift.org/package-manager/)
```
https://github.com/johnsonandjohnson/Guppy-iOS.git
```
### [CocoaPods](https://cocoapods.org)
```ruby
pod 'Guppy'
```
### [Carthage](https://github.com/Carthage/Carthage)
```
github "johnsonandjohnson/Guppy-iOS"
```
## License
Guppy is released under the Apache 2.0 license. See [LICENSE](https://github.com/johnsonandjohnson/Guppy-iOS/blob/main/LICENSE) for details.