Swiftpack.co - Package - TICESoftware/vapor-gorush

Gorush Service for Vapor

This service allows to easily integrate Gorush into Vapor to send push notifications.

Installation

Add the package to the Package.swift

.package(url: "https://github.com/TICESoftware/vapor-gorush.git", from: "1.0.0")
// ...
.target(name: "App", dependencies: ["Vapor", "Gorush"])

From version 1.0.0, this uses Vapor 4. If you want to use Gorush in Vapor 3, you can use version 0.9.0.

Register Gorush in configure.swift

let hostname = Environment.get("GORUSH_HOSTNAME")
app.gorush.use { req in
    Gorush(client: req.client, hostname: hostname)
}

Per default, HTTPS will be used. To use HTTP instead, just add httpScheme: .http into that initialization.

Usage

import Gorush
// ...
let notification = GorushNotification(tokens: ["deviceToken"], platform: .ios, message: "Push message", title: "Push title")

req.gorush.dispatch(notification, on: req.eventLoop).map { (response: GorushResponse) in
    if !response.logs.isEmpty {
        // This means an error occurred, if Gorush was configured to return errors
    }
}
// ...

License

This vapor-gorush package is released under an MIT license. See License for more information.

Todo

  • ☐ Parse Gorush response and answer with succeeded or failed future
  • ☐ Write further documentation
  • ☐ Complete fields for Gorush notification
  • ☐ Write tests

Github

link
Stars: 2

Dependencies

Used By

Total: 0

Releases

Vapor-Gorush 1.0.0 - 2020-08-25 10:01:12

With this version, we support Vapor 4.

Vapor-Gorush 0.9.0 - 2020-02-04 09:44:02

Add sound to notifications

Vapor-Gorush 0.7.0 - 2019-11-21 11:06:33

Add priority, which can be .normal or .high.

Vapor-Gorush 0.6.0 - 2019-10-17 14:51:45

Make message optional

Vapor-Gorush 0.5.0 - 2019-10-04 11:13:45

Add push_type into GorushNotification to send alerts or background notifications. (Thanks to @FabioTacke!)

Vapor-Gorush 0.2.1 - 2019-02-21 07:38:50

⚠️ Breaking changes: Changes the return type inside the Future from HTTPResponse to GorushResponse, which can be useful for evaluating the success

Return useful GorushResponse type - 2019-02-21 07:30:34

⚠️ Breaking changes: Changes the return type inside the Future from HTTPResponse to GorushResponse, which can be useful for evaluating the success

0.1.0 - 2019-01-15 20:54:32

First release with basic functionality