pushpad 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 280dfb492f2142c46bc48aab853d09a1d2a6c8a8
-  data.tar.gz: 30ae77b7b02d8c1f989f24870f2ed8f0918add83
+  metadata.gz: d941c8e87de24cb7ba4198735ca46708021d3617
+  data.tar.gz: e524dc59cbeda5cc9206a19fa8337f74d0ba5b86
 SHA512:
-  metadata.gz: 3889d1b96e444ded703aa7900c2b47abc1462aae58dec4ac937103efc2dde2d4d34ea9e6f7532f4e8a0abc755f63b692ff1db96c6ca37416ff15089648927f37
-  data.tar.gz: 83589e468d60ae8fde4af1239a9349bf916f09da1a509502483d462ffc33132a2314b68e1f1da169837789e04e1eb7ac71a8d71a8b3c93a835a9343968ce3962
+  metadata.gz: 1eae7e84da75f77a2da39f00e9a3fea1c7ec7232c25083290aa3c3dc92fc70cad72388667007af012aea5cb5357eb011bea6cc6a9dbdde29b5e4c2434fa9f828
+  data.tar.gz: fbd1ad0c2488840b723dbc47efe20d0bf8aaa7e66cc6f2eec188b553f0a76ab20950269d7911a338edbdd8349be02ccec95e881a5070372dbbd804eac566e816

data/README.md

@@ -1,4 +1,4 @@
-# Pushpad: real push notifications for websites
+# Pushpad - Web Push Notifications
 
 Add native push notifications to your web app using [Pushpad](https://pushpad.xyz).
 
@@ -41,14 +41,16 @@ Pushpad.auth_token = '5374d7dfeffa2eb49965624ba7596a09'
 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`).
+- `auth_token` can be found in the user account settings. 
+- `project_id` can be found in the project settings. If your application uses multiple projects, you can pass the `project_id` as a param to methods (e.g. `notification.deliver_to user, project_id: 123`).
 
-## Collecting user subscriptions
+## Collecting user subscriptions to push notifications
+
+Pushpad offers two different ways to collect subscriptions. [Learn more](https://pushpad.xyz/docs#simple_vs_custom_api_docs)
 
 ### Custom API
 
-Read the [docs](https://pushpad.xyz/docs#custom_api_docs).
+Choose the Custom API if you want to use Javascript for a seamless integration. [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:
 
@@ -58,7 +60,7 @@ Pushpad.signature_for current_user.id
 
 ### Simple API
 
-Let users subscribe to your push notifications: 
+Add a link to let users subscribe to push notifications: 
 
 ```erb
 <a href="<%= Pushpad.path %>">Subscribe anonymous to push notifications</a>
@@ -70,26 +72,36 @@ 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.
 
-## Sending notifications
-
-After you have collected the user subscriptions you can send them push notifications:
+## Sending push notifications
 
 ```ruby
 notification = Pushpad::Notification.new({
-  body: "Hello world!",
-  title: "Website Name", # optional, defaults to your project name
+  body: "Hello world!", # max 90 characters
+  title: "Website Name", # optional, defaults to your project name, max 30 characters
   target_url: "http://example.com" # optional, defaults to your project website
 })
 
+# deliver to a user
 notification.deliver_to user # or user_id
+
+# deliver to a group of users
 notification.deliver_to users # or user_ids
-notification.broadcast # deliver to everyone
+
+# deliver to some users only if they have a given preference
+# e.g. only "users" who have a interested in "events" will be reached
+notification.deliver_to users, tags: ['events']
+
+# deliver to segments
+notification.broadcast tags: ['segment1', 'segment2']
+
+# deliver to everyone
+notification.broadcast
 # => {"scheduled": 12}
 ```
 
 If no user with that id has subscribed to push notifications, that id is simply ignored.
 
-The methods above return an hash: `res["scheduled"]` contains the number of notifications that will be sent. For example if you call `notification.deliver_to user` but the user has never subscribed to push notifications the result will be `{"scheduled": 0}`.
+The methods above return an hash: `"scheduled"` is the number of devices to which the notification will be sent.
 
 ## License
 

data/lib/pushpad.rb

@@ -52,7 +52,7 @@ module Pushpad
     end
 
     def broadcast(options = {})
-      deliver req_body, options
+      deliver req_body(nil, options[:tags]), options
     end
 
     def deliver_to(users, options = {})
@@ -63,7 +63,7 @@ module Pushpad
       else
         [users.respond_to?(:id) ? users.id : users]
       end
-      deliver req_body(uids), options
+      deliver req_body(uids, options[:tags]), options
     end
 
     private
@@ -91,7 +91,7 @@ module Pushpad
       }
     end
 
-    def req_body(uids = nil)
+    def req_body(uids = nil, tags = nil)
       body = {
         "notification" => {
           "body" => self.body,
@@ -100,6 +100,7 @@ module Pushpad
         }
       }
       body["uids"] = uids if uids
+      body["tags"] = tags if tags
       body.to_json
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Pushpad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-04-23 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Web push notifications for Chrome, Firefox and Safari using Pushpad.