https://github.com/ticesoftware/vapor-gorush

Vapor service to easily integrate push notifications via Gorush
https://github.com/ticesoftware/vapor-gorush

apns gorush-server ios-notifications swift vapor vapor-3 vapor-service

Last synced: about 2 months ago
JSON representation

Vapor service to easily integrate push notifications via Gorush

• Host: GitHub
• URL: https://github.com/ticesoftware/vapor-gorush
• Owner: TICESoftware
• License: mit
• Created: 2019-01-15T17:01:40.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-02-09T00:32:01.000Z (11 months ago)
• Last Synced: 2024-10-29T11:28:25.181Z (about 2 months ago)
• Topics: apns, gorush-server, ios-notifications, swift, vapor, vapor-3, vapor-service
• Language: Swift
• Homepage:
• Size: 16.6 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gorush Service for Vapor

This service allows to easily integrate [Gorush](https://github.com/appleboy/gorush) into [Vapor](https://vapor.codes) to send push notifications.

## Installation

### Add the package to the `Package.swift`

```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`

```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

```swift

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](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