pushpad 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72937e2f8f9f8340e2c8a503a413a13f5cce90cd
-  data.tar.gz: b296e7b4007accf9d7d8729b31c1f0180fa465a1
+  metadata.gz: 62b82eeebcf3b9611c204c4752dd44a0beb6b45c
+  data.tar.gz: cf789a7d62f9a8aae45cdb7d5fd758594ad3dd7f
 SHA512:
-  metadata.gz: 85de1abb940f431332c41280c5a47983e93b29999c25877c4eef01e913b2517f208a13804110294d904399f4f348f7899fc10817fa3e95d85436e85a908532fd
-  data.tar.gz: 7c3230b40848571ce581498286364eee8e86388519b1cf82df37cfd54bf45074930196752021ec985b09a2072370632cc5c56c629ac7a298f17f7604fd824f2b
+  metadata.gz: cfa24ded993111cf8d193336f29e1be39372cf3e9b95a25166b67c9bc142699311fa5c7c35ff75df12a988d526a8345d1825e110f317bd1f40ebc2fd6337285e
+  data.tar.gz: 2a690c2bce05779cf56c5a475853292e0c637ab4dfbeb753513a67d69544fa1ea35ac829b52a63d5b0fb3290ad164bbcdfaccc91288b0d5e15df562945f86729

data/README.md

@@ -1,7 +1,8 @@
-# Pushpad - Web Push Notifications Service
+# Pushpad - Web Push Notifications
 
 [![Build Status](https://travis-ci.org/pushpad/pushpad-ruby.svg?branch=master)](https://travis-ci.org/pushpad/pushpad-ruby)
- 
+[![Gem Version](https://badge.fury.io/rb/pushpad.svg)](https://badge.fury.io/rb/pushpad)
+
 [Pushpad](https://pushpad.xyz) is a service for sending push notifications from your web app. It supports the **Push API** (Chrome, Firefox, Opera) and **APNs** (Safari).
 
 Features:
@@ -82,8 +83,21 @@ notification = Pushpad::Notification.new({
   title: "Website Name", # optional, defaults to your project name, max 30 characters
   target_url: "http://example.com", # optional, defaults to your project website
   icon_url: "http://example.com/assets/icon.png", # optional, defaults to the project icon
+  image_url: "http://example.com/assets/image.png", # optional, an image to display in the notification content
   ttl: 604800, # optional, drop the notification after this number of seconds if a device is offline
-  require_interaction: true # optional, if true it prevents Chrome from automatically closing the notification after a few seconds
+  require_interaction: true, # optional, prevent Chrome on desktop from automatically closing the notification after a few seconds
+  custom_data: "123", # optional, a string that is passed as an argument to action button callbacks
+  // optional, add some action buttons to the notification
+  // see https://pushpad.xyz/docs/action_buttons
+  actions: [
+    {
+      title: "My Button 1", # max length is 20 characters
+      target_url: "http://example.com/button-link", # optional
+      icon: "http://example.com/assets/button-icon.png", # optional
+      action: "myActionName" # optional
+    }
+  ],
+  starred: true # optional, bookmark the notification in the Pushpad dashboard (e.g. to highlight manual notifications)
 })
 
 # deliver to a user
@@ -109,7 +123,9 @@ notification.deliver_to users, tags: ['tag1 && tag2', 'tag3'] # equal to 'tag1 &
 notification.broadcast
 ```
 
-If no user with that id has subscribed to push notifications, that id is simply ignored.
+You can set the default values for most fields in the project settings. See also [the docs](https://pushpad.xyz/docs/rest_api#notifications_api_docs) for more information about notification fields.
+
+If you try to send a notification to a user ID, but that user is not subscribed, that ID is simply ignored.
 
 The methods above return an hash:
 

data/lib/pushpad/notification.rb

@@ -12,7 +12,7 @@ module Pushpad
     class ReadonlyError < RuntimeError
     end
 
-    attr_accessor :body, :title, :target_url, :icon_url, :ttl, :require_interaction
+    attr_accessor :body, :title, :target_url, :icon_url, :image_url, :ttl, :require_interaction, :custom_data, :actions, :starred
     attr_reader :id, :created_at, :scheduled_count, :successfully_sent_count, :opened_count
 
     def initialize(options)
@@ -26,8 +26,12 @@ module Pushpad
       @title = options[:title]
       @target_url = options[:target_url]
       @icon_url = options[:icon_url]
+      @image_url = options[:image_url]
       @ttl = options[:ttl]
       @require_interaction = options[:require_interaction]
+      @custom_data = options[:custom_data]
+      @actions = options[:actions]
+      @starred = options[:starred]
     end
 
     def self.find(id)
@@ -108,8 +112,12 @@ module Pushpad
       notification_params["title"] = self.title if self.title
       notification_params["target_url"] = self.target_url if self.target_url
       notification_params["icon_url"] = self.icon_url if self.icon_url
+      notification_params["image_url"] = self.image_url if self.image_url
       notification_params["ttl"] = self.ttl if self.ttl
       notification_params["require_interaction"] = self.require_interaction unless self.require_interaction.nil?
+      notification_params["custom_data"] = self.custom_data if self.custom_data
+      notification_params["actions"] = self.actions if self.actions
+      notification_params["starred"] = self.starred unless self.starred.nil?
 
       body = { "notification" => notification_params }
       body["uids"] = uids if uids

data/pushpad.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "pushpad"
-  spec.version       = '0.6.0'
+  spec.version       = '0.7.0'
   spec.authors       = ["Pushpad"]
   spec.email         = ["support@pushpad.xyz"]
   spec.summary       = "Web push notifications for Chrome, Firefox and Safari using Pushpad."

data/spec/pushpad/notification_spec.rb

@@ -271,8 +271,19 @@ module Pushpad
             title: "Website Name",
             target_url: "http://example.com",
             icon_url: "http://example.com/assets/icon.png",
+            image_url: "http://example.com/assets/image.png",
             ttl: 604800,
-            require_interaction: true
+            require_interaction: true,
+            custom_data: "123",
+            actions: [
+              {
+                title: "My Button 1",
+                target_url: "http://example.com/button-link",
+                icon: "http://example.com/assets/button-icon.png",
+                action: "myActionName"
+              }
+            ],
+            starred: true
           }
         end
         let(:notification) { Pushpad::Notification.new notification_params }
@@ -332,8 +343,19 @@ module Pushpad
             title: "Website Name",
             target_url: "http://example.com",
             icon_url: "http://example.com/assets/icon.png",
+            image_url: "http://example.com/assets/image.png",
             ttl: 604800,
-            require_interaction: true
+            require_interaction: true,
+            custom_data: "123",
+            actions: [
+              {
+                title: "My Button 1",
+                target_url: "http://example.com/button-link",
+                icon: "http://example.com/assets/button-icon.png",
+                action: "myActionName"
+              }
+            ],
+            starred: true
           }
         end
         let(:notification) { Pushpad::Notification.new notification_params }

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Pushpad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -45,9 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -72,17 +72,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Web push notifications for Chrome, Firefox and Safari using Pushpad.