acts_as_pushable 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3cf52438238f0a1ecc519c79d1e0c109e2aa3b3
-  data.tar.gz: e0050a1abd40c76018e755af5c972c6df8949c03
+  metadata.gz: 2f6ba8a11226b1b0d7acde10cbaee82fbf763f07
+  data.tar.gz: b1fb5b1eea5225015c4d41557882537d5429e206
 SHA512:
-  metadata.gz: 85e0b91b69df6f7b34a3dbf0acdccf8e5ab1ffa6e6a3ada051fe55edd6dd953e616dff1f1957d8409bffddeeb7909ab3272c04ca1249679138813edfcfd122a6
-  data.tar.gz: 775bf5cd462bceaad998e312409039f5942e294b9ee76359f931f8b767380e4946e99d1cc6c35e4e23ce88747e619e9e2aaf923a2fcc272e0edaa872cb701129
+  metadata.gz: e84af18153948d8d53a498405e5801d84ff2a95ad16568899b592ec926e4c11e12e0cae42160889585fe7ab5b8b0815019e91ec353dde4559ed5004115569634
+  data.tar.gz: 55dd800796c96b4f361c28e23d35a3557d4e401e9cc4669d9dff1932b4051792f54335acd45e088fd7dde0402831a78213e5348aedc3140a192c0fc17a518a2c

data/README.md

@@ -105,14 +105,23 @@ Sending a push notification to a user will send the message to all of their vali
   case device.platform
   when "ios"
     # iOS does not support titles
-    user.send_push_notification(message: 'this is a test', options)
+    device.send_push_notification(message: 'this is a test', options)
   when "android"
-    user.send_push_notification(message: 'this is a test', options)
+    device.send_push_notification(message: 'this is a test', { title: 'My App' })
   end
   ```
 
 > You might want to consider doing this inside a worker.
 
+## Sending silent push notifications to iOS Devices
+
+You can send silent push notifications with no message to iOS devices. This is useful when you just want to update the badge count on the home screen.
+
+  ```ruby
+  user = User.find(id)
+  user.send_push_notification(title: false, message: false, content_available: false, count: 2)
+  ```
+
 ## Apple Feedback Service
 
 Occasionally you'll want to cleanup old tokens that have been invalidated for various reasons. You can do this by running -

data/lib/acts_as_pushable.rb

@@ -2,6 +2,7 @@ require 'acts_as_pushable/version'
 require 'acts_as_pushable/configuration'
 
 require 'acts_as_pushable/active_record/device.rb'
+require 'acts_as_pushable/notification'
 require 'acts_as_pushable/pushable'
 
 require 'acts_as_pushable/apn/notification'

data/lib/acts_as_pushable/apn/notification.rb

@@ -2,36 +2,38 @@ require 'houston'
 
 module ActsAsPushable
   module APN
-    class Notification
-      def self.send(device:, message:, **options)
-        development_apn = Houston::Client.development
-        production_apn = Houston::Client.production
+    class Notification < ActsAsPushable::Notification
+      def perform
+        client.push(notification)
+      end
 
-        development_apn.certificate = ActsAsPushable.configuration.apn_development_certificate_file
-        production_apn.certificate = ActsAsPushable.configuration.apn_production_certificate_file
+      private
 
-        payload = {
-          popup: options.fetch('popup', true),
-          popup_title: options.fetch('popup_title', nil),
-          popup_body: options.fetch('popup_body', nil),
-          popup_type: options.fetch('popup_type', 'alert'),
-          popup_ok_button_text: options.fetch('popup_ok_button_text', 'Ok'),
-          popup_cancel_button_text: options.fetch('popup_cancel_button_text', 'Cancel'),
-          navigate_to_view: options.fetch('navigate_to_view', nil),
-          navigate_to_view_as_modal: options.fetch('navigate_to_view_as_modal', true),
-          navigate_to_view_parameters: options.fetch('navigate_to_view_parameters', {}),
-        }
+      def client
+        client             = Houston::Client.send(environment)
+        client.certificate = certificate
+        client
+      end
 
-        notification = Houston::Notification.new(device: device.token)
-        notification.alert = message
-        notification.badge = options.fetch('count', nil)
-        notification.custom_data = payload
+      def certificate
+        ActsAsPushable.configuration.send("apn_#{environment}_certificate_file")
+      end
 
-        if device.push_environment == 'development'
-          development_apn.push(notification)
-        else
-          production_apn.push(notification)
-        end
+      def content_available
+        options.delete(:content_available) || true
+      end
+
+      def count
+        options.delete(:count)
+      end
+
+      def notification
+        notification = Houston::Notification.new(device: device.token)
+        notification.alert             = message
+        notification.badge             = count
+        notification.content_available = content_available
+        notification.custom_data       = payload
+        notification
       end
     end
   end

data/lib/acts_as_pushable/gcm/notification.rb

@@ -2,33 +2,34 @@ require 'gcm'
 
 module ActsAsPushable
   module GCM
-    class Notification
-      def self.send(device:, title:, message:, **options)
-        payload = {
-          popup: options.fetch("popup", true),
-          popup_title: options.fetch("popup_title", nil),
-          popup_body: options.fetch("popup_body", nil),
-          popup_type: options.fetch("popup_type", 'alert'),
-          popup_ok_button_text: options.fetch("popup_ok_button_text", 'Ok'),
-          popup_cancel_button_text: options.fetch("popup_cancel_button_text", 'Cancel'),
-          navigate_to_view: options.fetch("navigate_to_view", nil),
-          navigate_to_view_as_modal: options.fetch("navigate_to_view_as_modal", true),
-          navigate_to_view_parameters: options.fetch("navigate_to_view_parameters", {}),
-        }
+    class Notification < ActsAsPushable::Notification
+      def perform
+        response = client.send([device.token], gcm_options)
+        if response[:not_registered_ids].include? device.token
+          device.update_attribute 'invalidated_at', Time.now
+        end
+        response
+      end
+
+      private
 
-        gcm = ::GCM.new(ActsAsPushable.configuration.gcm_key)
+      attr_accessor :title
 
-        gcm_options = {
+      def client
+        ::GCM.new(ActsAsPushable.configuration.gcm_key)
+      end
+
+      def gcm_options
+        {
           data: {
             title: title,
             message: message,
           }.merge(payload)
         }
+      end
 
-        response = gcm.send([device.token], gcm_options)
-        if response[:not_registered_ids].include? device.token
-          device.update_attribute 'invalidated_at', Time.now
-        end
+      def title
+        options.delete(:title)
       end
     end
   end

data/lib/acts_as_pushable/notification.rb

@@ -0,0 +1,43 @@
+module ActsAsPushable
+  class Notification
+    def initialize(device:, message:, **options)
+      @device  = device
+      @message = message
+      @options = options
+    end
+
+    def self.send(device:, message:, **options)
+      self.new(device: device, message: message, **options).perform
+    end
+
+    private
+
+    attr_accessor :device, :message, :options
+
+    def default_payload
+      {
+        popup: true,
+        popup_title: nil,
+        popup_body: nil,
+        popup_type: 'alert',
+        popup_ok_button_text: 'Ok',
+        popup_cancel_button_text: 'Cancel',
+        navigate_to_view: nil,
+        navigate_to_view_as_modal: true,
+        navigate_to_view_parameters: {},
+      }
+    end
+
+    def environment
+      device.push_environment
+    end
+
+    def payload
+      payload = default_payload.keys.map do |key|
+        [key, options.delete(key) || default_payload[key]]
+      end.to_h
+
+      payload.merge(options)
+    end
+  end
+end

data/lib/acts_as_pushable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsPushable
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_pushable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta4
+        version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.1'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0.beta4
+        version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.1'
@@ -159,6 +159,7 @@ files:
 - lib/acts_as_pushable/apn/notification.rb
 - lib/acts_as_pushable/configuration.rb
 - lib/acts_as_pushable/gcm/notification.rb
+- lib/acts_as_pushable/notification.rb
 - lib/acts_as_pushable/pushable.rb
 - lib/acts_as_pushable/version.rb
 - lib/generators/acts_as_pushable/install_generator.rb