https://github.com/divs1210/pushy-clj

Send APNs push notifications using the new HTTP/2 protocol from Clojure
https://github.com/divs1210/pushy-clj

apns2 clojure push-notifications

Last synced: 3 months ago
JSON representation

Send APNs push notifications using the new HTTP/2 protocol from Clojure

• Host: GitHub
• URL: https://github.com/divs1210/pushy-clj
• Owner: divs1210
• License: epl-1.0
• Created: 2016-05-25T12:19:47.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-06-27T22:48:40.000Z (over 5 years ago)
• Last Synced: 2024-10-12T23:07:02.218Z (4 months ago)
• Topics: apns2, clojure, push-notifications
• Language: Clojure
• Size: 28.3 KB
• Stars: 27
• Watchers: 4
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pushy-clj

A Clojure library for sending push notifications via APNS to Apple devices

using the new HTTP/2 protocol.

It's a thin wrapper around [Pushy](https://github.com/relayrides/pushy).

Make sure you have one of:

* [Universal Push Notification Client SSL Certificate](https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppDistributionGuide/AddingCapabilities/AddingCapabilities.html#//apple_ref/doc/uid/TP40012582-CH26-SW11)

* APNS Auth Key from [Apple member center](https://developer.apple.com/account/)

## Leiningen

The current stable version is:

`[pushy-clj "0.4.2"]`

## Usage

> :wrench: If you are upgrading from versions prior to 0.4.0, note

> that the API has changed, because of deep changes to the API of the

> Pushy Java library itself. You will need to change your existing

> code to conform to the examples below. There is no longer a

> no-argument version of `make-client`, and you need to provide the

> `:dev` or `:prod` keyword as a new, first argument. There is also no

> longer a `connect` function; Pushy takes responsibility for the

> connection as soon as you create the client, until you call

> `disconnect`.

First, we create a client and connect to the APNs development server:

```clojure

(require '[pushy-clj.core :refer :all]

         '[clojure.java.io :as io])

(import 'java.io.File)

;; Old-school certificate-based auth

(with-open [cert (io/input-stream (File. "/path/to/cert.p12"))]

  (def client (make-client :dev cert "password")))

                    ;; use :prod in production env

;; New token-based auth

(with-open [key (io/input-stream (File. "/path/to/key.p8"))]

  (def client (make-client :dev key "team-id" "key-id")))

```

Pushy is responsible for opening the connection to the specified

server, and reopening it if anything causes it to close.

Then we build a notification following Apple's [guidelines](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CreatingtheNotificationPayload.html#//apple_ref/doc/uid/TP40008194-CH10-SW1):

```clojure

(def payload {:aps {:alert "Hello!"}})

(def notification (build-push-notification "device-token" 

                                           "topic" ;; this can be nil

                                           payload))

```

Now, we can send the notification:

```clojure

(def resp-future (send-push-notification client notification)) ;; async operation!

```

The notification is sent asynchronously, and `resp-future` is returned immediately.

This future can be derefed to get the response as a hashmap.

```clojure

@resp-future ;; blocking operation

;; => {:accepted? true

;;     :rejection-reason nil

;;     :token-expiration-ts nil}

```

Finally, we can close the connection using `disconnect`:

```clojure

(disconnect client) ;; blocking operation

```

## License

Copyright © 2016 Divyansh Prakash

Distributed under the Eclipse Public License version 1.0.