notify_user 0.0.29 → 0.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a577a48ef571d2031ff5df80e68446265b7c4f1
-  data.tar.gz: 007bc887cd900949443af637df989638d61b46ae
+  metadata.gz: 5980a65a991cb1e398fbbcda1ce3f44f446752a0
+  data.tar.gz: 8d5ce270933bb2cf0739d5c15835e5653ace2b52
 SHA512:
-  metadata.gz: 1e8be63dd0b8d2fa14de7ccbfbe7a927b521b3d086ff9ef344116b48170c6e68e37d9bfae0fbe95d01061d9f698c5e88fb06f6d1543ce9e2a0b2ecefb8777058
-  data.tar.gz: 0e98eb7957dd725d95d8750429cd06bf38f01a4d558adcdbcab02265768124b8cfe93028b581de64e551e2c13c9dedde4772f1f19bce19c0e04f8ec662fbfd12
+  metadata.gz: d409a8e666e78e51ab3f6b5e8c6344c5717a994bf099a82b1fd089a6a912f8c86d520d7ceb86628e83f80cf5b2e8e2153787933adc86c8c3e8c039b592c61278
+  data.tar.gz: 62aa3a3c24b490c11420d5021b6ad749f99d47b156908ff61b3b803ce6d35acf670ba6233014bac2b76071722fc378cdb98bcede15200fd9139d16c2bdea6edd

data/README.md

@@ -35,7 +35,7 @@ channel :action_mailer,
 To enable APNS add this line to your app/notification/notification_type.rb
 ```
 channel :apns,
-	aggregate_per: false    
+	aggregate_per: false
 ```
 
 To run the tests:
@@ -50,6 +50,61 @@ gem install wwtd
 wwtd
 ```
 
+## APNS providers
+By default, we use [Houston](https://github.com/nomad/houston/) to deliver push notifications via APNS from the server.
+
+The initialiser for `notify_user` contains the following configuration when delivering via Houston:
+```
+# Number of connections Houston will maintain to APNS:
+config.connection_pool_size = 3
+
+# Time in seconds Houston will wait for a free connection before failing:
+config.connection_pool_timeout = 300
+```
+
+We maintain persistent connections to APNS via background workers, and these values will allow you to configure how many connections the workers maintain, as well as the amount of time to wait for an idle connection before timing out.
+
+You also need to provide exported versions of your push notification certificate and key as .pem files, these instructions come from the [APN on Rails](https://github.com/PRX/apn_on_rails) project on how to do that:
+
+Once you have the certificate from Apple for your application, export your key
+and the apple certificate as p12 files. Here is a quick walkthrough on how to do this:
+
+1. Click the disclosure arrow next to your certificate in Keychain Access and select the certificate and the key.
+2. Right click and choose `Export 2 items…`.
+3. Choose the p12 format from the drop down and name it `cert.p12`.
+
+Now covert the p12 file to a pem file:
+
+    $ openssl pkcs12 -in cert.p12 -out apple_push_notification.pem -nodes -clcerts
+
+`notify_user` will look for your pem files within `"#{Rails.root}/config/keys/`, named `development_push.pem` and `production_push`, for the development and production APNS gateways respectively.
+
+## The Device model
+
+When delivering via Houston, we also need access to a model which has access to device tokens that is related to your notification target. i.e. Assuming your notification target is a User:
+
+```
+class User < ActiveRecord::Base
+  has_many :devices
+end
+
+class Device < ActiveRecord::Base
+  belongs_to :user
+
+  validates :token, presence:true # A string representation of your device's token, the only thing need to delivery push notifications.
+end
+```
+
+A gem that provides such a model is [arcade](https://github.com/Papercloud/arcade), a mountable Rails engine that lets you flag a model (e.g. `User`) as a device owner and provides a number of routes to allow device registration.
+
+By default, we assume the relation is named `:devices`, but this can be passed through when enabling APNS for a notification if you want to use something else:
+
+```
+channel :apns,
+  aggregate_per: false,
+  device_method: :some_other_method
+```
+
 ##Web interface
 Display a list of notifications for a logged in user
 ```
@@ -69,7 +124,7 @@ config.action_mailer.default_url_options = { :host => "http://example.com" }
 ```
 
 ##Subscriptions
-Unsubscribing from a notification type, first add it to the notify_user.rb initilizer 
+Unsubscribing from a notification type, first add it to the notify_user.rb initilizer
 ```
 # Override the default notification type
 config.unsubscribable_notifications = ['NewPostNotification','NewSale']
@@ -90,19 +145,19 @@ Unsubscribe link helper - add this to your views/notify_user/layouts/action_mail
 ##Upgrading to JSON params data type
 Run json_update generator which generates the migrations to change the params datatype to json as well as convert the current data to json
 ```
-rails generate notify_user:json_update 
+rails generate notify_user:json_update
 rake db:migrate
 ```
 
 ##Changes
 Notification description and aggregates has changed syntax slighly from
 ```
-@@description = "please override this type description" 
+@@description = "please override this type description"
 @@aggregate_per = 10.minutes
 ```
-to 
+to
 ```
-self.description = "please override this type description" 
+self.description = "please override this type description"
 self.aggregate_per = 10.minutes
 ```
 

data/app/models/notify_user/houston.rb

@@ -36,8 +36,11 @@ module NotifyUser
     def setup_options
       space_allowance = PAYLOAD_LIMIT - used_space
 
+      mobile_message = @notification.mobile_message(space_allowance)
+      mobile_message.gsub!('\n', "\n")
+
       push_options = {
-        alert: @notification.mobile_message(space_allowance),
+        alert: mobile_message,
         badge: @notification.count_for_target,
         category: @notification.params[:category] || @notification.type,
         custom_data: @notification.params,

data/lib/generators/notify_user/install/templates/initializer.rb

@@ -21,7 +21,4 @@ NotifyUser.setup do |config|
   # Time in seconds Houston will wait for a free connection before failing:
   config.connection_pool_timeout = 300
 
-  # Number of times a device can fail to send via APNS:
-  config.failure_tolerance = 5
-
 end

data/lib/notify_user/version.rb

@@ -1,3 +1,3 @@
 module NotifyUser
-  VERSION = "0.0.29"
+  VERSION = "0.0.30"
 end

data/lib/notify_user.rb

@@ -28,10 +28,6 @@ module NotifyUser
   mattr_accessor :connection_pool_timeout
   @@connection_pool_timeout = nil
 
-  # Number of times Houston can fail to send via APNS:
-  mattr_accessor :failure_tolerance
-  @@failure_tolerance = nil
-
   # Used to set up NotifyUser from the initializer.
   def self.setup
     yield self

data/spec/dummy/rails-3.2.17/app/notifications/new_post_notification.rb

@@ -4,8 +4,12 @@ class NewPostNotification < NotifyUser::BaseNotification
         subject: "Rails3217: You have a new Newpostnotification notification.",
         aggregate: {
           subject: "Rails3217: You have new Newpostnotification notifications."
-        }  
+        }
 
-  self.description = "please override this type description" 
+  self.description = "please override this type description"
   self.aggregate_per = 10.minutes
+
+  def message
+    "New Post Notification happened with #{params.as_json}"
+  end
 end

data/spec/dummy/rails-3.2.17/config/initializers/secret_token.rb

@@ -4,4 +4,4 @@
 # If you change this key, all old signed cookies will become invalid!
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-Rails3217::Application.config.secret_token = '6f62fb4392bcb002b5b74bde5adcb036ce557f73e10ad6c5134e9dcd48a6397c5bfc48784b029d84bff50a0c40441fdd75cb644a4e75eef23c811d22e1494ef7'
+Rails3217::Application.config.secret_token = 'e441b89f2f6bd8a3c835b54c996970a8de238ccb26501de6ee386f8d57de3f5fd59d2b587aecf4fe5351f468cdd78973a55910b443480692115383f855780d96'

data/spec/dummy/rails-3.2.17/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20150106040854862862248000) do
+ActiveRecord::Schema.define(:version => 20141102231353651651843000) do
 
   create_table "notify_user_notifications", :force => true do |t|
     t.string   "type"