pushpad 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90bdda996e91aeb9895cec9561e37ef295f70794
+  data.tar.gz: ab5ce0db6b9a5cf5c6014ce1f9a7a72ca888b881
+SHA512:
+  metadata.gz: c9603df2c24e32a48b4e3d393847edf8125cdf4d96b005bf26444e75082fb355bcb35efb6ed3a2f96e49645ad94a51f8ce7263149f2fdb88f4c1da82944fdc80
+  data.tar.gz: b06c575e6e1b36f2ea5e9ec78c3f4d030f13512b01084cb3a625a13403d51b6802db6e72e82b21c36f0cbd73050f40cf68878a79836de6f2df585f68cb4f8a4f

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pushpad (https://pushpad.xyz)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# Pushpad: web push notifications
+
+Add web push notifications to your web app using third-party service [Pushpad](https://pushpad.xyz).
+
+Currently push notifications work on the following browsers:
+
+- Chrome (Desktop and Android)
+- 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:
+
+```ruby
+gem 'pushpad'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pushpad
+
+## Usage
+
+First you need to sign up to Pushpad and create a project there. It takes 1 minute.
+
+Then set your authentication credentials:
+
+```
+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`).
+
+Let users subscribe to your push notifications: 
+
+```erb
+<a href="<%= Pushpad.path %>">Subscribe anonymous to push notifications</a>
+
+<a href="<%= Pushpad.path_for current_user # or current_user_id %>">Subscribe current user to push notifications</a>
+```
+
+`current_user` is the user currently logged in on your website.
+
+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:
+
+```ruby
+notification = Pushpad::Notification.new({
+  body: "Hello world!",
+  title: "Website Name", # optional, defaults to your project name
+  target_url: "http://example.com" # optional, defaults to your project website
+})
+
+notification.deliver_to user # or user_id
+notification.deliver_to users # or user_ids
+notification.broadcast # deliver to everyone
+# => {"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}`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/pushpad.rb

@@ -0,0 +1,103 @@
+require 'net/http'
+require 'OpenSSL'
+require 'json'
+
+module Pushpad
+  @@auth_token = nil
+  @@project_id = nil
+
+  def self.auth_token
+    @@auth_token
+  end
+
+  def self.auth_token=(auth_token)
+    @@auth_token = auth_token
+  end
+
+  def self.project_id
+    @@project_id
+  end
+
+  def self.project_id=(project_id)
+    @@project_id = project_id
+  end
+
+  def self.path(options = {})
+    project_id = options[:project_id] || self.project_id
+    raise "You must set project_id" unless project_id
+    "https://pushpad.xyz/projects/#{self.project_id}/subscription/edit"
+  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)
+    "#{self.path(options)}?uid=#{uid}&uid_signature=#{uid_signature}" 
+  end
+
+  class Notification
+    class DeliveryError < RuntimeError
+    end
+
+    attr_accessor :body, :title, :target_url
+
+    def initialize(options)
+      self.body = options[:body]
+      self.title = options[:title]
+      self.target_url = options[:target_url]
+    end
+
+    def broadcast(options = {})
+      deliver req_body, 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
+    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)
+      body = {
+        "notification" => {
+          "body" => self.body,
+          "title" => self.title,
+          "target_url" => self.target_url
+        }
+      }
+      body["uids"] = uids if uids
+      body.to_json
+    end
+  end
+
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: pushpad
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Pushpad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- support@pushpad.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/pushpad.rb
+homepage: https://pushpad.xyz
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Web push notifications for Chrome, Firefox and Safari using Pushpad.
+test_files: []