pushpad 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1bdf804e269c7ee9bcb0684030849617c955e98
-  data.tar.gz: c0da7ef0194d0950671c86154e2bc45d0d6507b7
+  metadata.gz: 16e079cb71bb9a62497ef67e1d02d8e10ae52ef9
+  data.tar.gz: 8bd989647419688540a10b16f2ee6400f13176fc
 SHA512:
-  metadata.gz: f8f8d324fe7068c3bc4fb0744637e311106146849a4fb0ccea0183b431d2ef7ae3a82313fa690143eda9a3a865b4ae961d44129c013566b9f0f5fd68d49a78b7
-  data.tar.gz: db783ff3ebc5215fe7f9bf7315fa3f3debb13b48ae5ddc545471ceb3d514d7a95cb63199ff3cc4dc1bf27d78e240de094146f8236cb7d033cb7ec92ce7c533a2
+  metadata.gz: 239f05ffb94da74b1cf932d3200f4e0267e9b41fa53d937b745a919b78500f6aacec685b920c3c3f45032dbb2b791fb368715ea15dfa9a502d5fbd7f6a8646c7
+  data.tar.gz: 7ec1b731bb3a23a275ffdd76f05cbabc3616a05a1cef98aff83e114918d8f5c41829766363a8add0f288e91af64890d2251a1e93967879e0ee09f06f3c184e2a

data/README.md

@@ -1,6 +1,6 @@
 # Pushpad - Web Push Notifications Service
  
-[Pushpad](https://pushpad.xyz) is a service for sending push notifications from your web app. It supports the **Push API** (Chrome and Firefox) and **APNs** (Safari).
+[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:
 
@@ -12,6 +12,7 @@ Currently push notifications work on the following browsers:
 
 - Chrome (Desktop and Android)
 - Firefox (44+)
+- Opera (42+)
 - Safari
 
 ## Installation
@@ -80,7 +81,7 @@ notification = Pushpad::Notification.new({
   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
   ttl: 604800, # optional, drop the notification after this number of seconds if a device is offline
-  require_interaction: true # optional, default is false, if true it prevents Chrome from automatically closing the notification after a few seconds
+  require_interaction: true # optional, if true it prevents Chrome from automatically closing the notification after a few seconds
 })
 
 # deliver to a user

data/lib/pushpad.rb

@@ -51,7 +51,7 @@ module Pushpad
       self.target_url = options[:target_url]
       self.icon_url = options[:icon_url]
       self.ttl = options[:ttl]
-      self.require_interaction = !!options[:require_interaction]
+      self.require_interaction = options[:require_interaction]
     end
 
     def broadcast(options = {})
@@ -95,16 +95,14 @@ module Pushpad
     end
 
     def req_body(uids = nil, tags = nil)
-      body = {
-        "notification" => {
-          "body" => self.body,
-          "title" => self.title,
-          "target_url" => self.target_url,
-          "icon_url" => self.icon_url,
-          "ttl" => self.ttl,
-          "require_interaction" => self.require_interaction
-        }
-      }
+      notification_params = { "body" => self.body }
+      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["ttl"] = self.ttl if self.ttl
+      notification_params["require_interaction"] = self.require_interaction unless self.require_interaction.nil?
+
+      body = { "notification" => notification_params }
       body["uids"] = uids if uids
       body["tags"] = tags if tags
       body.to_json

data/spec/pushpad_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe Pushpad do
+  let!(:auth_token) { Pushpad.auth_token = 'abc123' }
+  let!(:project_id) { Pushpad.project_id = 123 }
+  let(:notification) { Pushpad::Notification.new body: "Example message" }
+
+  describe "#auth_token=" do
+    it "sets the Pushpad auth token globally" do
+      Pushpad.auth_token = 'abc123'
+      expect(Pushpad.auth_token).to eq 'abc123'
+    end
+  end
+
+  describe "#project_id=" do
+    it "sets the Pushpad project id globally" do
+      Pushpad.project_id = 123
+      expect(Pushpad.project_id).to eq 123
+    end
+  end
+
+  describe "#signature_for" do
+    it "produces the hex-encoded HMAC-SHA1 signature for the data passed as argument" do
+      signature = Pushpad.signature_for('myuid1')
+      expect(signature).to eq '27fbe136f5a4aa0b6be74c0e18fa8ce81ad91b60'
+    end
+  end
+
+  def stub_notification_post project_id, params
+    stub_request(:post, "https://pushpad.xyz/projects/#{project_id}/notifications").
+      with(body: hash_including(params)).
+      to_return(status: 201, body: '{}')
+  end
+
+  describe "#deliver_to" do
+    
+    shared_examples 'notification params' do
+      it "includes the params in the request" do
+        req = stub_notification_post project_id, notification: notification_params
+        notification.deliver_to [123, 456]
+        expect(req).to have_been_made.once
+      end
+    end
+
+    context "a notification with just the required params" do
+      let(:notification_params) do 
+        { body: "Example message" }
+      end
+      let(:notification) { Pushpad::Notification.new body: notification_params[:body] }
+      include_examples 'notification params'
+    end
+
+    context "a notification with all the optional params" do
+      let(:notification_params) do 
+        {
+          body: "Example message",
+          title: "Website Name",
+          target_url: "http://example.com",
+          icon_url: "http://example.com/assets/icon.png",
+          ttl: 604800,
+          require_interaction: true
+        }
+      end
+      let(:notification) { Pushpad::Notification.new notification_params } 
+      include_examples 'notification params'
+    end
+
+    context "with a scalar as a param" do
+      it "reaches only that uid" do
+        req = stub_notification_post project_id, uids: [100]
+        notification.deliver_to(100)
+        expect(req).to have_been_made.once
+      end
+    end
+
+    context "with an array as a param" do
+      it "reaches only those uids" do
+        req = stub_notification_post project_id, uids: [123, 456]
+        notification.deliver_to([123, 456])
+        expect(req).to have_been_made.once
+      end
+    end
+
+    context "with uids and tags" do
+      it "filters audience by uids and tags" do
+        req = stub_notification_post project_id, uids: [123, 456], tags: ['tag1']
+        notification.deliver_to([123, 456], tags: ['tag1'])
+        expect(req).to have_been_made.once
+      end
+    end
+  end
+
+  describe "#broadcast" do
+
+    shared_examples 'notification params' do
+      it "includes the params in the request" do
+        req = stub_notification_post project_id, notification: notification_params
+        notification.broadcast
+        expect(req).to have_been_made.once
+      end
+    end
+
+    context "a notification with just the required params" do
+      let(:notification_params) do 
+        { body: "Example message" }
+      end
+      let(:notification) { Pushpad::Notification.new body: notification_params[:body] }
+      include_examples 'notification params'
+    end
+
+    context "a notification with all the optional params" do
+      let(:notification_params) do 
+        {
+          body: "Example message",
+          title: "Website Name",
+          target_url: "http://example.com",
+          icon_url: "http://example.com/assets/icon.png",
+          ttl: 604800,
+          require_interaction: true
+        }
+      end
+      let(:notification) { Pushpad::Notification.new notification_params } 
+      include_examples 'notification params'
+    end
+
+    context "without params" do
+      it "reaches everyone" do
+        req = stub_notification_post project_id, {}
+        notification.broadcast
+        expect(req).to have_been_made.once
+      end
+    end
+
+    context "with tags" do
+      it "filters audience by tags" do
+        req = stub_notification_post project_id, tags: ['tag1', 'tag2']
+        notification.broadcast tags: ['tag1', 'tag2']
+        expect(req).to have_been_made.once
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'pushpad'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  # some config
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Pushpad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
-dependencies: []
+date: 2017-01-27 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: 
 email:
 - support@pushpad.xyz
@@ -21,6 +49,8 @@ files:
 - LICENSE.txt
 - README.md
 - lib/pushpad.rb
+- spec/pushpad_spec.rb
+- spec/spec_helper.rb
 homepage: https://pushpad.xyz
 licenses:
 - MIT
@@ -31,18 +61,20 @@ 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.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/pushpad_spec.rb