pushpad 0.1.6 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90bdda996e91aeb9895cec9561e37ef295f70794
-  data.tar.gz: ab5ce0db6b9a5cf5c6014ce1f9a7a72ca888b881
+  metadata.gz: 280dfb492f2142c46bc48aab853d09a1d2a6c8a8
+  data.tar.gz: 30ae77b7b02d8c1f989f24870f2ed8f0918add83
 SHA512:
-  metadata.gz: c9603df2c24e32a48b4e3d393847edf8125cdf4d96b005bf26444e75082fb355bcb35efb6ed3a2f96e49645ad94a51f8ce7263149f2fdb88f4c1da82944fdc80
-  data.tar.gz: b06c575e6e1b36f2ea5e9ec78c3f4d030f13512b01084cb3a625a13403d51b6802db6e72e82b21c36f0cbd73050f40cf68878a79836de6f2df585f68cb4f8a4f
+  metadata.gz: 3889d1b96e444ded703aa7900c2b47abc1462aae58dec4ac937103efc2dde2d4d34ea9e6f7532f4e8a0abc755f63b692ff1db96c6ca37416ff15089648927f37
+  data.tar.gz: 83589e468d60ae8fde4af1239a9349bf916f09da1a509502483d462ffc33132a2314b68e1f1da169837789e04e1eb7ac71a8d71a8b3c93a835a9343968ce3962

data/README.md

@@ -1,6 +1,12 @@
-# Pushpad: web push notifications
+# Pushpad: real push notifications for websites
 
-Add web push notifications to your web app using third-party service [Pushpad](https://pushpad.xyz).
+Add native push notifications to your web app using [Pushpad](https://pushpad.xyz).
+
+Features:
+
+- notifications are delivered even when the user is not on your website
+- users don't need to install any app or plugin
+- you can target specific users or send bulk notifications
 
 Currently push notifications work on the following browsers:
 
@@ -8,12 +14,6 @@ Currently push notifications work on the following browsers:
 - Firefox (44+)
 - Safari
 
-Features:
-
-- users don't need to install any app or plugin 
-- notifications are delivered even when the user is not on your website
-- you can target specific users or send bulk notifications
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,13 +30,13 @@ Or install it yourself as:
 
     $ gem install pushpad
 
-## Usage
+## Getting started
 
-First you need to sign up to Pushpad and create a project there. It takes 1 minute.
+First you need to sign up to Pushpad and create a project there.
 
 Then set your authentication credentials:
 
-```
+```ruby
 Pushpad.auth_token = '5374d7dfeffa2eb49965624ba7596a09'
 Pushpad.project_id = 123 # set it here or pass it as a param to methods later
 ```
@@ -44,6 +44,20 @@ Pushpad.project_id = 123 # set it here or pass it as a param to methods later
 `auth_token` can be found in the user account settings. 
 `project_id` can be found in the project settings on Pushpad. A project is a list of subscriptions. You can set it globally or pass it as a param to methods if your app uses multiple lists (e.g. `Pushpad.path_for current_user, project_id: 123`, `notification.deliver_to user, project_id: 123`).
 
+## Collecting user subscriptions
+
+### Custom API
+
+Read the [docs](https://pushpad.xyz/docs#custom_api_docs).
+
+If you need to generate the HMAC signature for the `uid` you can use this helper:
+
+```ruby
+Pushpad.signature_for current_user.id
+```
+
+### Simple API
+
 Let users subscribe to your push notifications: 
 
 ```erb
@@ -56,7 +70,9 @@ Let users subscribe to your push notifications:
 
 When a user clicks the link is sent to Pushpad, automatically asked to receive push notifications and redirected back to your website.
 
-Then you can send notifications:
+## Sending notifications
+
+After you have collected the user subscriptions you can send them push notifications:
 
 ```ruby
 notification = Pushpad::Notification.new({

data/lib/pushpad.rb

@@ -22,6 +22,11 @@ module Pushpad
     @@project_id = project_id
   end
 
+  def self.signature_for(data)
+    raise "You must set Pushpad.auth_token" unless Pushpad.auth_token
+    OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), self.auth_token, data.to_s)
+  end
+
   def self.path(options = {})
     project_id = options[:project_id] || self.project_id
     raise "You must set project_id" unless project_id
@@ -29,9 +34,8 @@ module Pushpad
   end
 
   def self.path_for(user, options = {})
-    raise "You must set Pushpad.auth_token" unless Pushpad.auth_token
     uid = user.respond_to?(:id) ? user.id : user
-    uid_signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), self.auth_token, uid.to_s)
+    uid_signature = self.signature_for(uid.to_s)
     "#{self.path(options)}?uid=#{uid}&uid_signature=#{uid_signature}" 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors:
 - Pushpad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: