Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-lab/ndt7-client-ios
https://github.com/m-lab/ndt7-client-ios
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/m-lab/ndt7-client-ios
- Owner: m-lab
- License: apache-2.0
- Created: 2019-03-25T17:24:12.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-06T09:36:24.000Z (7 months ago)
- Last Synced: 2024-10-29T14:46:18.737Z (about 2 months ago)
- Language: Swift
- Size: 1.9 MB
- Stars: 21
- Watchers: 13
- Forks: 14
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# NDT7 iOS
| branch | travis-ci | codacy | sonarcloud | codecov |
|--------|-----------|--------|------------|---------|
| develop | [](https://travis-ci.org/m-lab/ndt7-client-ios) | | | [](https://codecov.io/gh/m-lab/ndt7-client-ios/branch/develop) |
| master | [](https://travis-ci.org/m-lab/ndt7-client-ios) | [](https://www.codacy.com/app/miguelangelnet/ndt7-client-ios?utm_source=github.com&utm_medium=referral&utm_content=m-lab/ndt7-client-ios&utm_campaign=Badge_Grade) | [](https://sonarcloud.io/dashboard/index/m-lab_ndt7-client-ios) | [](https://codecov.io/gh/m-lab/ndt7-client-ios/branch/master) |
[](https://sonarcloud.io/component_measures?id=m-lab_ndt7-client-ios&metric=Reliability)
[](https://sonarcloud.io/component_measures?id=m-lab_ndt7-client-ios&metric=Security)
[](https://sonarcloud.io/component_measures?id=m-lab_ndt7-client-ios&metric=Maintainability)
[](https://sonarcloud.io/component_measures?id=m-lab_ndt7-client-ios&metric=Reliability)
[](https://sonarcloud.io/component_measures?id=m-lab_ndt7-client-ios&metric=Security)
[](http://isitmaintained.com/project/m-lab/ndt7-client-ios "Average time to resolve an issue")
[](http://isitmaintained.com/project/m-lab/ndt7-client-ios "Percentage of issues still open")
[](https://www.measurementlab.net/)
[](http://www.apache.org/licenses/LICENSE-2.0)
[](http://htmlpreview.github.io/?https://github.com/m-lab/ndt7-client-ios/blob/master/docs/index.html)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/NDT7)
# Table of Contents
- [Introduction](#introduction)
- [Current supported features](#current-supported-features)
- [Requirements](#requirements)
- [Documentation](#documentation)
- [Installation](#installation)
- [CocoaPods](#cocoapods)
- [Carthage](#carthage)
- [Manual Installation](#manual-installation)
- [Setup and Usage](#setup-and-usage)
- [Setup](#setup)
- [Start speed test](#start-speed-test)
- [License](#license)
"Measure the Internet, save the data, and make it universally accessible and useful."
NDT7 provides a framework to measure the download and upload speed.
- [X] Download Speed Test
- [X] Upload Speed Test
- iOS 10.0+ / macOS 10.14.0+ / appleTV 10.0+ / watchOS 3.0+
- Xcode 10.2+
- Swift 5.0+
Visit the `NDT7` [documentation](http://htmlpreview.github.io/?https://github.com/m-lab/ndt7-client-ios/blob/master/docs/index.html) for instructions and browsing api references.
[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website.
```ruby
platform :ios, '10.0'
use_frameworks!
target 'NDT7 example' do
pod 'NDT7', '0.0.4'
end
```
Then, run the following command:
```bash
$ pod install
```
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
Create a `Cartfile` and add the following line:
```
github "m-lab/ndt7-client-ios" ~> 0.0.4
```
Next, run the following command:
```bash
$ carthage update
```
Check out the **[Carthage docs »](https://github.com/Carthage/Carthage#if-youre-building-for-ios-tvos-or-watchos)** for more info.
### Adding all swift files
Add all `*.swift` files from `Sources` directory into your project.
### Embedded Framework
#### Step 1. Add as a git Submodule
Add NDT7 as a submodule to your local git repo with the following command:
```bash
$ git submodule add [email protected]:m-lab/ndt7-client-ios
```
#### Step 2. Drag NDT7.xcodeproj to your project
Drag the `NDT7.xcodeproj` into the Project Navigator of you application's Xcode project.
#### Step 3. Embed the framework
Under "General" tab from your project, add the NDT7 framework as an embedded binary. You'll see different frameworks depending if you need it for iOS, macOS or appleTV.
If you experiment issues been blocked for App Transport Security during the M-Lab server discovery, that means that requires data to be transmitted securely and you need to tell iOS to make exceptions for you.
Remember, if you add this exception you'll be required to explain it to the app review team when you submit your app to the App Store.
The exception will be defined for the individual site locate.measurementlab.net inside your application's info.plist file. You can edit the plist as source code, right-click on your info.plist and choose Open As > Source Code.
Your plist should end like this:
```swift
```
Please, copy paste this before that:
```swift
NSAppTransportSecurity
NSExceptionDomains
locate.measurementlab.net
NSIncludesSubdomains
NSThirdPartyExceptionAllowsInsecureHTTPLoads
```
That requests add an exception for site locate.measurementlab.net.
The only setup needed for debugging purpose is to enable logging if needed.
```swift
NDT7.loggingEnabled = true
```
If specific settings are needed for the testing configuration, you can define an NDT7Settings object, otherwise, use the default one with NDT7Settings().
In the next section, "Start speed test", we'll show all the steps needed to start a test.
The next example show the whole process for a download and upload speed test.
1. Setup all the functions needed for NDT7Test delegate.
2. Create the settings for testing. NDT7Settings.
3. Create a NDT7Test object with NDT7Settings already created.
4. Setup a delegation for NDT7Test to get the test information.
5. Start speed test for download and/or upload.
```swift
import UIKit
import NDT7
class ViewController: UIViewController {
var ndt7Test: NDT7Test?
override func viewDidLoad() {
super.viewDidLoad()
// For debugging purpose you can enable logs for NDT7 framework.
NDT7.loggingEnabled = true
startTest()
}
func startTest() {
// 2. Create the settings for testing. NDT7Settings.
let settings = NDT7Settings()
// 3. Create a NDT7Test object with NDT7Settings already created.
ndt7Test = NDT7Test(settings: settings)
// 4. Setup a delegation for NDT7Test to get the test information.
ndt7Test?.delegate = self
// 5. Start speed test for download and/or upload.
ndt7Test?.startTest(download: true, upload: true) { [weak self] (error) in
guard self != nil else { return }
if let error = error {
print("NDT7 iOS Example app - Error during test: \(error.localizedDescription)")
} else {
print("NDT7 iOS Example app - Test finished.")
}
}
}
func cancelTest() {
ndt7Test?.cancel()
}
}
// 1. Setup all the functions needed for NDT7Test delegate.
extension ViewController: NDT7TestInteraction {
func test(kind: NDT7TestConstants.Kind, running: Bool) {
}
func measurement(origin: NDT7TestConstants.Origin, kind: NDT7TestConstants.Kind, measurement: NDT7Measurement) {
}
func error(kind: NDT7TestConstants.Kind, error: NSError) {
}
}
```
# License
`NDT7` iOS client is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). See LICENSE for details.