pushpad 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16e079cb71bb9a62497ef67e1d02d8e10ae52ef9
-  data.tar.gz: 8bd989647419688540a10b16f2ee6400f13176fc
+  metadata.gz: 72937e2f8f9f8340e2c8a503a413a13f5cce90cd
+  data.tar.gz: b296e7b4007accf9d7d8729b31c1f0180fa465a1
 SHA512:
-  metadata.gz: 239f05ffb94da74b1cf932d3200f4e0267e9b41fa53d937b745a919b78500f6aacec685b920c3c3f45032dbb2b791fb368715ea15dfa9a502d5fbd7f6a8646c7
-  data.tar.gz: 7ec1b731bb3a23a275ffdd76f05cbabc3616a05a1cef98aff83e114918d8f5c41829766363a8add0f288e91af64890d2251a1e93967879e0ee09f06f3c184e2a
+  metadata.gz: 85de1abb940f431332c41280c5a47983e93b29999c25877c4eef01e913b2517f208a13804110294d904399f4f348f7899fc10817fa3e95d85436e85a908532fd
+  data.tar.gz: 7c3230b40848571ce581498286364eee8e86388519b1cf82df37cfd54bf45074930196752021ec985b09a2072370632cc5c56c629ac7a298f17f7604fd824f2b

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -1,2 +1,6 @@
 source 'https://rubygems.org'
 gemspec
+
+group :test do
+  gem 'rake'
+end

data/README.md

@@ -1,4 +1,6 @@
 # Pushpad - Web Push Notifications Service
+
+[![Build Status](https://travis-ci.org/pushpad/pushpad-ruby.svg?branch=master)](https://travis-ci.org/pushpad/pushpad-ruby)
  
 [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).
 
@@ -109,13 +111,83 @@ notification.broadcast
 
 If no user with that id has subscribed to push notifications, that id is simply ignored.
 
-The methods above return an hash: 
+The methods above return an hash:
 
 - `"id"` is the id of the notification on Pushpad
 - `"scheduled"` is the estimated reach of the notification (i.e. the number of devices to which the notification will be sent, which can be different from the number of users, since a user may receive notifications on multiple devices)
 - `"uids"` (`deliver_to` only) are the user IDs that will be actually reached by the notification because they are subscribed to your notifications. For example if you send a notification to `['uid1', 'uid2', 'uid3']`, but only `'uid1'` is subscribed, you will get `['uid1']` in response. Note that if a user has unsubscribed after the last notification sent to him, he may still be reported for one time as subscribed (this is due to [the way](http://blog.pushpad.xyz/2016/05/the-push-api-and-its-wild-unsubscription-mechanism/) the W3C Push API works).
 
+The `id` and `scheduled_count` attribute are also stored on the notification object:
+
+```ruby
+
+notification.deliver_to user
+
+notification.id # => 1000
+notification.scheduled_count # => 5
+```
+
+## Getting push notification data
+
+You can retrieve data for past notifications:
+
+```ruby
+notification = Pushpad::Notification.find(42)
+
+# get basic attributes
+notification.id # => 42
+notification.title # => "Foo Bar",
+notification.body # => "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+notification.target_url # => "http://example.com",
+notification.ttl # => 604800,
+notification.require_interaction # => false,
+notification.icon_url # => "http://example.com/assets/icon.png",
+
+# `created_at` is a `Time` instance
+notification.created_at.utc.to_s # => "2016-07-06 10:09:14 UTC",
+
+# get statistics
+notification.scheduled_count # => 1
+notification.successfully_sent_count # => 4,
+notification.opened_count # => 2
+```
+
+Or for mutliple notifications of a project at once:
+
+```ruby
+notifications = Pushpad::Notification.find_all(project_id: 5)
+
+# same attributes as for single notification in example above
+notifications[0].id # => 42
+notifications[0].title # => "Foo Bar",
+```
+
+If `Pushpad.project_id` is defined, the `project_id` option can be
+omitted.
+
+The REST API paginates the result set. You can pass a `page` parameter
+to get the full list in multiple requests.
+
+```ruby
+notifications = Pushpad::Notification.find_all(project_id: 5, page: 2)
+```
+
+## Getting subscription count
+
+You can retrieve the number of subscriptions for a given project,
+optionally filtered by `tags` or `uids`:
+
+```ruby
+Pushpad::Subscription.count(project_id: 5) # => 100
+Pushpad::Subscription.count(project_id: 5, uids: ['user1']) # => 2
+Pushpad::Subscription.count(project_id: 5, tags: ['sports']) # => 10
+Pushpad::Subscription.count(project_id: 5, tags: 'sports && travel') # => 5
+Pushpad::Subscription.count(project_id: 5, uids: ['user1'], tags: 'sports && travel') # => 1
+```
+
+If `Pushpad.project_id` is defined, the `project_id` option can be
+omitted.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/pushpad/notification.rb

@@ -0,0 +1,120 @@
+require "json"
+require "time"
+
+module Pushpad
+  class Notification
+    class DeliveryError < RuntimeError
+    end
+
+    class FindError < RuntimeError
+    end
+
+    class ReadonlyError < RuntimeError
+    end
+
+    attr_accessor :body, :title, :target_url, :icon_url, :ttl, :require_interaction
+    attr_reader :id, :created_at, :scheduled_count, :successfully_sent_count, :opened_count
+
+    def initialize(options)
+      @id = options[:id]
+      @created_at = options[:created_at] && Time.parse(options[:created_at])
+      @scheduled_count = options[:scheduled_count]
+      @successfully_sent_count = options[:successfully_sent_count]
+      @opened_count = options[:opened_count]
+
+      @body = options[:body]
+      @title = options[:title]
+      @target_url = options[:target_url]
+      @icon_url = options[:icon_url]
+      @ttl = options[:ttl]
+      @require_interaction = options[:require_interaction]
+    end
+
+    def self.find(id)
+      response = Request.get("https://pushpad.xyz/notifications/#{id}")
+
+      unless response.code == "200"
+        raise FindError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+
+      new(JSON.parse(response.body, symbolize_names: true)).readonly!
+    end
+
+    def self.find_all(options = {})
+      project_id = options[:project_id] || Pushpad.project_id
+      raise "You must set project_id" unless project_id
+
+      query_parameters = {}
+      query_parameters[:page] = options[:page] if options.key?(:page)
+
+      response = Request.get("https://pushpad.xyz/projects/#{project_id}/notifications",
+                             query_parameters: query_parameters)
+
+      unless response.code == "200"
+        raise FindError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+
+      JSON.parse(response.body, symbolize_names: true).map do |attributes|
+        new(attributes).readonly!
+      end
+    end
+
+    def readonly!
+      @readonly = true
+      self
+    end
+
+    def broadcast(options = {})
+      deliver req_body(nil, options[:tags]), options
+    end
+
+    def deliver_to(users, options = {})
+      uids = if users.respond_to?(:ids)
+        users.ids
+      elsif users.respond_to?(:collect)
+        users.collect {|u| u.respond_to?(:id) ? u.id : u }
+      else
+        [users.respond_to?(:id) ? users.id : users]
+      end
+      deliver req_body(uids, options[:tags]), options
+    end
+
+    private
+
+    def deliver(req_body, options = {})
+      if @readonly
+        raise(ReadonlyError,
+              "Notifications fetched with `find` or `find_all` cannot be delivered again.")
+      end
+
+      project_id = options[:project_id] || Pushpad.project_id
+      raise "You must set project_id" unless project_id
+
+      endpoint = "https://pushpad.xyz/projects/#{project_id}/notifications"
+      response = Request.post(endpoint, req_body)
+
+      unless response.code == "201"
+        raise DeliveryError, "Response #{response.code} #{response.message}: #{response.body}"
+      end
+
+      JSON.parse(response.body).tap do |attributes|
+        @id = attributes["id"]
+        @scheduled_count = attributes["scheduled"]
+      end
+    end
+
+    def req_body(uids = nil, tags = nil)
+      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
+    end
+  end
+end

data/lib/pushpad/request.rb

@@ -0,0 +1,56 @@
+require "uri"
+require "net/http"
+
+module Pushpad
+  module Request
+    extend self
+
+    def head(endpoint, options = {})
+      perform(Net::HTTP::Head, endpoint, options)
+    end
+
+    def get(endpoint, options = {})
+      perform(Net::HTTP::Get, endpoint, options)
+    end
+
+    def post(endpoint, body, options = {})
+      perform(Net::HTTP::Post, endpoint, options) do |request|
+        request.body = body
+      end
+    end
+
+    private
+
+    def perform(method, endpoint, options)
+      uri = URI.parse(endpoint)
+      request = method.new(path_and_query(uri, options[:query_parameters]), headers)
+
+      yield request if block_given?
+
+      https(uri, request)
+    end
+
+    def path_and_query(uri, query_parameters)
+      [uri.path, query(query_parameters)].compact.join("?")
+    end
+
+    def query(parameters)
+      parameters && !parameters.empty? ? URI.encode_www_form(parameters) : nil
+    end
+
+    def https(uri, request)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |https|
+        https.request(request)
+      end
+    end
+
+    def headers
+      raise "You must set Pushpad.auth_token" unless Pushpad.auth_token
+      {
+        "Authorization" => %(Token token="#{Pushpad.auth_token}"),
+        "Content-Type" => "application/json;charset=UTF-8",
+        "Accept" => "application/json"
+      }
+    end
+  end
+end

data/lib/pushpad/subscription.rb

@@ -0,0 +1,52 @@
+module Pushpad
+  class Subscription
+    class CountError < RuntimeError
+    end
+
+    def self.count(options = {})
+      CountQuery.new(options).perform
+    end
+
+    class CountQuery
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def perform
+        project_id = options[:project_id] || Pushpad.project_id
+        raise "You must set project_id" unless project_id
+
+        endpoint = "https://pushpad.xyz/projects/#{project_id}/subscriptions"
+        response = Request.head(endpoint, query_parameters: query_parameters)
+
+        unless response.code == "200"
+          raise CountError, "Response #{response.code} #{response.message}: #{response.body}"
+        end
+
+        response["X-Total-Count"].to_i
+      end
+
+      private
+
+      def query_parameters
+        [uid_query_parameters, tag_query_parameters].flatten(1)
+      end
+
+      def uid_query_parameters
+        options.fetch(:uids, []).map { |uid| ["uids[]", uid] }
+      end
+
+      def tag_query_parameters
+        tags = options.fetch(:tags, [])
+
+        if tags.is_a?(String)
+          [["tags", tags]]
+        else
+          tags.map { |tag| ["tags[]", tag] }
+        end
+      end
+    end
+  end
+end

data/lib/pushpad.rb

@@ -1,6 +1,8 @@
-require 'net/http'
 require 'openssl'
-require 'json'
+
+require "pushpad/request"
+require "pushpad/notification"
+require "pushpad/subscription"
 
 module Pushpad
   @@auth_token = nil
@@ -38,75 +40,4 @@ module Pushpad
     uid_signature = self.signature_for(uid.to_s)
     "#{self.path(options)}?uid=#{uid}&uid_signature=#{uid_signature}"
   end
-
-  class Notification
-    class DeliveryError < RuntimeError
-    end
-
-    attr_accessor :body, :title, :target_url, :icon_url, :ttl, :require_interaction
-
-    def initialize(options)
-      self.body = options[:body]
-      self.title = options[:title]
-      self.target_url = options[:target_url]
-      self.icon_url = options[:icon_url]
-      self.ttl = options[:ttl]
-      self.require_interaction = options[:require_interaction]
-    end
-
-    def broadcast(options = {})
-      deliver req_body(nil, options[:tags]), options
-    end
-
-    def deliver_to(users, options = {})
-      uids = if users.respond_to?(:ids)
-        users.ids
-      elsif users.respond_to?(:collect)
-        users.collect {|u| u.respond_to?(:id) ? u.id : u }
-      else
-        [users.respond_to?(:id) ? users.id : users]
-      end
-      deliver req_body(uids, options[:tags]), options
-    end
-
-    private
-
-    def deliver(req_body, options = {})
-      project_id = options[:project_id] || Pushpad.project_id
-      raise "You must set project_id" unless project_id
-      endpoint = "https://pushpad.xyz/projects/#{project_id}/notifications"
-      uri = URI.parse(endpoint)
-      https = Net::HTTP.new(uri.host, uri.port)
-      https.use_ssl = true
-      req = Net::HTTP::Post.new(uri.path, req_headers)
-      req.body = req_body
-      res = https.request(req)
-      raise DeliveryError, "Response #{res.code} #{res.message}: #{res.body}" unless res.code == '201'
-      JSON.parse(res.body)
-    end
-
-    def req_headers
-      raise "You must set Pushpad.auth_token" unless Pushpad.auth_token
-      {
-        'Authorization' => 'Token token="' + Pushpad.auth_token + '"',
-        'Content-Type' => 'application/json;charset=UTF-8',
-        'Accept' => 'application/json'
-      }
-    end
-
-    def req_body(uids = nil, tags = nil)
-      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
-    end
-  end
-
 end

data/pushpad.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |spec|
+  spec.name          = "pushpad"
+  spec.version       = '0.6.0'
+  spec.authors       = ["Pushpad"]
+  spec.email         = ["support@pushpad.xyz"]
+  spec.summary       = "Web push notifications for Chrome, Firefox and Safari using Pushpad."
+  spec.homepage      = "https://pushpad.xyz"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- spec/*`.split("\n")
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/pushpad/notification_spec.rb

@@ -0,0 +1,360 @@
+require "spec_helper"
+
+module Pushpad
+  describe Notification do
+    let!(:auth_token) { Pushpad.auth_token = "abc123" }
+    let!(:project_id) { Pushpad.project_id = 123 }
+    let(:notification) { Pushpad::Notification.new body: "Example message" }
+
+    def stub_notification_get(attributes)
+      stub_request(:get, "https://pushpad.xyz/notifications/#{attributes[:id]}").
+        to_return(status: 200, body: attributes.to_json)
+    end
+
+    def stub_failing_notification_get(notification_id)
+      stub_request(:get, "https://pushpad.xyz/notifications/#{notification_id}").
+        to_return(status: 404)
+    end
+
+    def stub_notifications_get(options)
+      stub_request(:get, "https://pushpad.xyz/projects/#{options[:project_id]}/notifications").
+        with(query: hash_including(options.fetch(:query, {}))).
+        to_return(status: 200, body: options[:list].to_json)
+    end
+
+    def stub_failing_notifications_get(options)
+      stub_request(:get, "https://pushpad.xyz/projects/#{options[:project_id]}/notifications").
+        to_return(status: 403)
+    end
+
+    def stub_notification_post(project_id, params = {}, response_body = "{}")
+      stub_request(:post, "https://pushpad.xyz/projects/#{project_id}/notifications").
+        with(body: hash_including(params)).
+        to_return(status: 201, body: response_body)
+    end
+
+    def stub_failing_notification_post(project_id)
+      stub_request(:post, "https://pushpad.xyz/projects/#{project_id}/notifications").
+        to_return(status: 403)
+    end
+
+    describe ".new" do
+      it "allows delivering notifications even if an id attribute is supplied" do
+        stub_notification_post(project_id)
+
+        expect {
+          Notification.new(id: "ignored").broadcast
+        }.not_to raise_error
+      end
+    end
+
+    describe ".find" do
+      it "returns notification with attributes from json response" do
+        attributes = {
+          id: 5,
+          title: "Foo Bar",
+          body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+          target_url: "http://example.com",
+          created_at: "2016-07-06T10:09:14.835Z",
+          ttl: 604800,
+          require_interaction: false,
+          icon_url: "https://example.com/assets/icon.png",
+          scheduled_count: 2,
+          successfully_sent_count: 4,
+          opened_count: 1
+        }
+        stub_notification_get(attributes)
+
+        notification = Notification.find(5)
+
+        attributes.delete(:created_at)
+        expect(notification).to have_attributes(attributes)
+        expect(notification.created_at.utc.to_s).to eq(Time.utc(2016, 7, 6, 10, 9, 14.835).to_s)
+      end
+
+      it "fails with FindError if response status code is not 200" do
+        stub_failing_notification_get(5)
+
+        expect {
+          Notification.find(5)
+        }.to raise_error(Notification::FindError)
+      end
+
+      it "returns notification that fails with ReadonlyError when calling deliver_to" do
+        stub_notification_get(id: 5)
+
+        notification = Notification.find(5)
+
+        expect {
+          notification.deliver_to(100)
+        }.to raise_error(Notification::ReadonlyError)
+      end
+
+      it "returns notification that fails with ReadonlyError when calling broadcast" do
+        stub_notification_get(id: 5)
+
+        notification = Notification.find(5)
+
+        expect {
+          notification.broadcast
+        }.to raise_error(Notification::ReadonlyError)
+      end
+    end
+
+    describe ".find_all" do
+      it "returns notifications of project with attributes from json response" do
+        attributes = {
+          id: 5,
+          title: "Foo Bar",
+          body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+          target_url: "http://example.com",
+          created_at: "2016-07-06T10:09:14.835Z",
+          ttl: 604800,
+          require_interaction: false,
+          icon_url: "https://example.com/assets/icon.png",
+          scheduled_count: 2,
+          successfully_sent_count: 4,
+          opened_count: 1
+        }
+        stub_notifications_get(project_id: 10, list: [attributes])
+
+        notifications = Notification.find_all(project_id: 10)
+
+        attributes.delete(:created_at)
+        expect(notifications[0]).to have_attributes(attributes)
+        expect(notifications[0].created_at.utc.to_s).to eq(Time.utc(2016, 7, 6, 10, 9, 14.835).to_s)
+      end
+
+      it "falls back to global project id" do
+        attributes = { id: 5 }
+        stub_notifications_get(project_id: 10, list: [attributes])
+
+        Pushpad.project_id = 10
+        notifications = Notification.find_all
+
+        expect(notifications[0]).to have_attributes(attributes)
+      end
+
+      it "fails with helpful error message when project_id is missing" do
+        Pushpad.project_id = nil
+
+        expect {
+          Notification.find_all
+        }.to raise_error(/must set project_id/)
+      end
+
+      it "allows passing page parameter for pagination" do
+        attributes = { id: 5 }
+        stub_notifications_get(project_id: 10, list: [attributes], query: { page: "3" })
+
+        notifications = Notification.find_all(project_id: 10, page: 3)
+
+        expect(notifications[0]).to have_attributes(attributes)
+      end
+
+      it "fails with FindError if response status code is not 200" do
+        stub_failing_notifications_get(project_id: 10)
+
+        expect {
+          Notification.find_all(project_id: 10)
+        }.to raise_error(Notification::FindError)
+      end
+
+      it "returns notifications that fail with ReadonlyError when calling deliver_to" do
+        stub_notifications_get(project_id: 10, list: [{ id: 5 }])
+
+        notifications = Notification.find_all(project_id: 10)
+
+        expect {
+          notifications[0].deliver_to(100)
+        }.to raise_error(Notification::ReadonlyError)
+      end
+
+      it "returns notifications that fail with ReadonlyError when calling broadcast" do
+        stub_notifications_get(project_id: 10, list: [{ id: 5 }])
+
+        notifications = Notification.find_all(project_id: 10)
+
+        expect {
+          notifications[0].broadcast
+        }.to raise_error(Notification::ReadonlyError)
+      end
+    end
+
+    shared_examples "delivery method" do |method|
+      it "fails with DeliveryError if response status code is not 201" do
+        stub_failing_notification_post(project_id)
+
+        expect {
+          method.call(notification)
+        }.to raise_error(Notification::DeliveryError)
+      end
+
+      it "sets id and scheduled_count from json response" do
+        response_body = {
+          "id" => 3,
+          "scheduled" => 5
+        }.to_json
+        stub_notification_post(project_id, {}, response_body)
+
+        method.call(notification)
+
+        expect(notification).to have_attributes(id: 3, scheduled_count: 5)
+      end
+
+      it "overrides id on subsequent calls" do
+        id_counter = 0
+        response_body = lambda do |*|
+          id_counter += 1
+
+          {
+            "id" => id_counter,
+            "scheduled" => 5
+          }.to_json
+        end
+        stub_notification_post(project_id, {}, response_body)
+
+        method.call(notification)
+        method.call(notification)
+        method.call(notification)
+
+        expect(notification.id).to eq(3)
+      end
+
+      it "returns raw json response" do
+        response = {
+          "id" => 4,
+          "scheduled" => 5,
+          "uids" => ["uid0", "uid1"]
+        }
+        stub_notification_post(project_id, {}, response.to_json)
+
+        result = method.call(notification)
+
+        expect(result).to eq(response)
+      end
+
+      it "fails with helpful error message when project_id is missing" do
+        Pushpad.project_id = nil
+
+        expect {
+          method.call(notification)
+        }.to raise_error(/must set project_id/)
+      end
+    end
+
+    describe "#deliver_to" do
+      include_examples "delivery method", lambda { |notification|
+        notification.deliver_to(100)
+      }
+
+      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
+      include_examples "delivery method", lambda { |notification|
+        notification.broadcast
+      }
+
+      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
+end

data/spec/pushpad/request_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+module Pushpad
+  describe Request do
+    describe ".head" do
+      it "passes auth_token in authorization header" do
+        stub_request(:any, /pushpad.xyz/)
+
+        Pushpad.auth_token = "abc123"
+        Request.head("https://pushpad.xyz/example")
+
+        expect(a_request(:head, "https://pushpad.xyz/example").
+               with(headers: { "Authorization" => 'Token token="abc123"' })).to have_been_made
+      end
+
+      it "supports passing query parameters" do
+        stub_request(:any, /pushpad.xyz/)
+
+        Pushpad.auth_token = "abc123"
+        Request.head("https://pushpad.xyz/example", query_parameters: [["some", "value"]])
+
+        expect(a_request(:head, "https://pushpad.xyz/example?some=value")).to have_been_made
+      end
+    end
+
+    describe ".get" do
+      it "passes auth_token in authorization header" do
+        stub_request(:any, /pushpad.xyz/)
+
+        Pushpad.auth_token = "abc123"
+        Request.get("https://pushpad.xyz/example")
+
+        expect(a_request(:get, "https://pushpad.xyz/example").
+               with(headers: { "Authorization" => 'Token token="abc123"' })).to have_been_made
+      end
+
+      it "supports passing query parameters" do
+        stub_request(:any, /pushpad.xyz/)
+
+        Pushpad.auth_token = "abc123"
+        Request.get("https://pushpad.xyz/example", query_parameters: [["some", "value"]])
+
+        expect(a_request(:get, "https://pushpad.xyz/example?some=value")).to have_been_made
+      end
+    end
+
+    describe ".post" do
+      it "passes auth_token in authorization header" do
+        stub_request(:any, /pushpad.xyz/)
+
+        Pushpad.auth_token = "abc123"
+        Request.post("https://pushpad.xyz/example", '{"some": "value"}')
+
+        expect(a_request(:post, "https://pushpad.xyz/example").
+               with(headers: { "Authorization" => 'Token token="abc123"' })).to have_been_made
+      end
+
+      it "passes request body" do
+        stub_request(:any, /pushpad.xyz/)
+
+        Pushpad.auth_token = "abc123"
+        Request.post("https://pushpad.xyz/example", '{"some": "value"}')
+
+        expect(a_request(:post, "https://pushpad.xyz/example").
+               with(body: '{"some": "value"}')).to have_been_made
+      end
+
+      it "supports passing query parameters" do
+        stub_request(:any, /pushpad.xyz/)
+
+        Pushpad.auth_token = "abc123"
+        Request.post("https://pushpad.xyz/example", "{}", query_parameters: [["some", "value"]])
+
+        expect(a_request(:post, "https://pushpad.xyz/example?some=value")).to have_been_made
+      end
+    end
+  end
+end

data/spec/pushpad/subscription_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+module Pushpad
+  describe Subscription do
+    def stub_subscriptions_head(options)
+      stub_request(:head, "https://pushpad.xyz/projects/#{options[:project_id]}/subscriptions").
+        with(query: hash_including(options.fetch(:query, {}))).
+        to_return(status: 200,
+                  headers: { "X-Total-Count" => options.fetch(:total_count, 10) })
+    end
+
+    def stub_failing_subscriptions_head(options)
+      stub_request(:head, "https://pushpad.xyz/projects/#{options[:project_id]}/subscriptions").
+        to_return(status: 503)
+    end
+
+    describe ".count" do
+      it "returns value from X-Total-Count header" do
+        stub_subscriptions_head(project_id: 5, total_count: 100)
+
+        result = Subscription.count(project_id: 5)
+
+        expect(result).to eq(100)
+      end
+
+      it "falls back to global project_id" do
+        request = stub_subscriptions_head(project_id: 5, total_count: 100)
+
+        Pushpad.project_id = 5
+        Subscription.count
+
+        expect(request).to have_been_made.once
+      end
+
+      it "fails with helpful error message when project_id is missing" do
+        Pushpad.project_id = nil
+
+        expect {
+          Subscription.count
+        }.to raise_error(/must set project_id/)
+      end
+
+      it "allows passing uids" do
+        request = stub_subscriptions_head(project_id: 5, query: { uids:  ["uid0", "uid1"] })
+
+        Subscription.count(project_id: 5, uids: ["uid0", "uid1"])
+
+        expect(request).to have_been_made.once
+      end
+
+      it "allows passing tags" do
+        request = stub_subscriptions_head(project_id: 5, query: { tags:  ["sports", "travel"] })
+
+        Subscription.count(project_id: 5, tags: ["sports", "travel"])
+
+        expect(request).to have_been_made.once
+      end
+
+      it "allows passing tags as boolean expression" do
+        request = stub_subscriptions_head(project_id: 5, query: { tags: "sports || travel" })
+
+        Subscription.count(project_id: 5, tags: "sports || travel")
+
+        expect(request).to have_been_made.once
+      end
+
+      it "allows passing tags and uids" do
+        request = stub_subscriptions_head(project_id: 5,
+                                          query: { tags:  ["sports", "travel"], uids: ["uid0"] })
+
+        Subscription.count(project_id: 5, tags: ["sports", "travel"], uids: ["uid0"])
+
+        expect(request).to have_been_made.once
+      end
+
+      it "fails with CountError if response status code is not 200" do
+        stub_failing_subscriptions_head(project_id: 5)
+
+        expect {
+          Subscription.count(project_id: 5)
+        }.to raise_error(Subscription::CountError)
+      end
+    end
+  end
+end

data/spec/pushpad_spec.rb

@@ -1,10 +1,6 @@
 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'
@@ -25,118 +21,4 @@ describe Pushpad do
       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

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: pushpad
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Pushpad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2017-02-02 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,10 +45,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - lib/pushpad.rb
+- lib/pushpad/notification.rb
+- lib/pushpad/request.rb
+- lib/pushpad/subscription.rb
+- pushpad.gemspec
+- spec/pushpad/notification_spec.rb
+- spec/pushpad/request_spec.rb
+- spec/pushpad/subscription_spec.rb
 - spec/pushpad_spec.rb
 - spec/spec_helper.rb
 homepage: https://pushpad.xyz
@@ -61,20 +72,23 @@ 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.4.5
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Web push notifications for Chrome, Firefox and Safari using Pushpad.
 test_files:
-- spec/spec_helper.rb
+- spec/pushpad/notification_spec.rb
+- spec/pushpad/request_spec.rb
+- spec/pushpad/subscription_spec.rb
 - spec/pushpad_spec.rb
+- spec/spec_helper.rb