Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thecoolwinter/swiftswot
Vapor service for verifying academic emails against the SWOT database
https://github.com/thecoolwinter/swiftswot
academic-product swift swot vapor vapor-4 vapor-service vapor-swift
Last synced: 4 days ago
JSON representation
Vapor service for verifying academic emails against the SWOT database
- Host: GitHub
- URL: https://github.com/thecoolwinter/swiftswot
- Owner: thecoolwinter
- Created: 2021-01-06T00:14:10.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-06T14:46:05.000Z (almost 4 years ago)
- Last Synced: 2024-11-06T16:55:47.265Z (about 2 months ago)
- Topics: academic-product, swift, swot, vapor, vapor-4, vapor-service, vapor-swift
- Language: Swift
- Homepage:
- Size: 509 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SwiftSWOT
[](http://cocoapods.org/pods/FASwift)
[](http://swift.org)
[](https://vapor.codes)
`SwiftSWOT` is a Vapor service for verifying academic emails against the [SWOT database](https://github.com/leereilly/swot).
SWOT is a community-driven database that has a large list of valid academic emails. This is useful for things like providing student discounts. This package checks against that database to give a reasonably good idea of if a given email is an academic email.
## Installation
Installation is done through the Swift Package Manager
```swift
.package(url: "https://github.com/thecoolwinter/SwiftSWOT.git", from: "1.0.1")
.target(name: "App", dependencies: [
.product(name: "Vapor", package: "vapor"),
.product(name: "SwiftSWOT", package: "SwiftSWOT")
])
```
## Usage
#### Validate Academic Emails
In your request path, validate emails using the `SWOT` variable on the request.
```swift
app.on(.GET, "validateStudent", ":email") { (req) -> [String: String] in
guard let email = try? req.parameters.require("email") else {
return [
"valid": "false",
"reason": "Please provide an email to validate."
]
}
let isValidEmail = req.SWOT.validateEmail(email)
if isValidEmail {
return [
"valid": "true"
]
} else {
return [
"valid": "false",
"reason": "Not a valid academic email address."
]
}
}
```
You can also get the academic institution's name from the email.
```swift
app.on(.GET, "institution", ":email") { (req) -> [String: String] in
guard let email = try? req.parameters.require("email") else {
return [
"valid": "false",
"reason": "Please provide an email to validate.",
"institutionName": ""
]
}
let institutionName = req.SWOT.institutionFromEmail(email)
if institutionName != nil {
return [
"valid": "true",
"institutionName": institutionName!
]
} else {
return [
"valid": "false",
"reason": "Not a valid academic email address.",
"institutionName": ""
]
}
}
```
#### Configuration & Customization
The configuration can be set using the `SwiftSWOTConfig` object on your app.
You can configure:
- Blacklist
- Custom institutions that might not be in the database
- Toggle logging
```swift
app.SWOT.configuration = .init(loggingEnabled: true, // Default `false`
blacklist: [ // Array of domain names to ignore
"gmail.com",
"yahoo.org"
],
trustedDomains: [
"my.gcu.edu": "Grand Canyon University"
])
```
`trustedDomains` is a dictionary of `Domain : Institution Name`. The domain is what SWOT wil search for when validating an email, Institution Name is what will be returned from `req.SWOT.institutionFromEmail(email)`
*Note: `gmail.com` and` yahoo.org` are there for example, they will return false if checked against the database.*