pntfr 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 693c8a96d8ba9566c1dcabf08581f5aa52297368
-  data.tar.gz: 663dfc03af01428078af0881658a08ac89cdff24
+  metadata.gz: 1ea2c676227f8cb47624247e7b17c1b23ca4f807
+  data.tar.gz: b959760dd664b66b8e7fac4cc2047fd0d160964e
 SHA512:
-  metadata.gz: ea273a1aab3b8dae07502577d848e112605be360c7f57c10054efbd61ad1685f2c17f801a9e23cd3e293262385e2c79f5f9acb54a23b24f42cd472afcbaa0d1e
-  data.tar.gz: e1f4b171c3933cb6348f01566f923619786720c2ec74f7c9306ef9a43ec85f54ab6cac204c2b6b4c14a65721074ec2b076435683055e57c86231e673260f4a7a
+  metadata.gz: 8be443994f430f303904e47b2b10b537923470b59b1a0a4be8b9c877c7afa7646c8b9b5406397f9bacb1ecca94f95d680cb45348609c2ee9f248504982849dca
+  data.tar.gz: 4a0fbc47b6eed0cdb7c6f14092e2008da382a8301f65e757fed60a6ec80d3e5e59545adf5a88491a4ea2bf24e8a08d499ed3134e851b1a45c235356d1749596a

data/Gemfile.lock

@@ -1,23 +1,23 @@
 PATH
   remote: .
   specs:
-    pntfr (0.2.0)
-      apns (~> 1.0, >= 1.0.0)
+    pntfr (0.5.3)
+      apns2 (~> 0.0, >= 0.0.1)
       gcm (~> 0.0, >= 0.0.9)
       json (~> 1.8, >= 1.8.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    apns (1.0.0)
+    apns2 (0.0.1)
     gcm (0.1.0)
       httparty
       json
-    httparty (0.13.4)
+    httparty (0.13.7)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
-    json (1.8.2)
-    minitest (5.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
     multi_xml (0.5.5)
     rake (10.4.2)
 
@@ -26,6 +26,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.6)
-  minitest (~> 5.7.0)
+  minitest (~> 5.8, >= 5.8.3)
   pntfr!
   rake

data/README.md

@@ -116,7 +116,7 @@ msg[:custom]= {
     :'last-extra' => {lastkey: 'last value'}
   }
 
-# SETTING ANPS AND GCN CREDENTIALS ON EACH NOTIFICATION
+# SETTING ANPS AND GCM CREDENTIALS ON EACH NOTIFICATION
 # using different configuration on each call
 credentials= {
   # for ios you select what you override, in this case host and port will be
@@ -132,6 +132,30 @@ notifier= Pntfr::Notifier.new( credentials )
 notifier.update_devices(device).msg({:title => 'Title', :description => 'Description'}).notify
 # of course the device's push_id and credentials should belong to the same application.
 ```
+## Apns Feedback
+This is specific of the Apple Push Notification Service.
+To clean the database from bad devices that will slow down batch notification sendings,
+one must check which devices caused error on the past and remove them from the database.
+
+The process is easy, simply ask the Apns service for the list of bad devices,
+and then do the cleaning.
+
+```ruby
+feedback= Pntfr::Feedback.new
+bad_devices= feedback.bad_devices
+
+# do the cleaning of your database, for example
+bad_devices.each do |bad_device|
+  d= Device.find_by_platform_and_push_id(Pntfr::Platforms.IOS, bad_device.push_id)
+  d.destroy
+end
+```
+
++bad_devices+ is an Array of Pntfr::BadDevice objects with the two attributes returned
+by the apns feedback service: timestamp and push_id.
+
+It is recommended to do a feedback cleaning once a day.
+
 # Testing
 For testing, one can check the messages sent to each device the same way
 that Rails ActiveMailer works: messages are stacked into `Pntfr.deliveries[push_id]`,
@@ -141,7 +165,6 @@ notifications are not sent, only stored in the stack.
 
 # Further development (roadmap)
 - Update cannonical push id when required for gcm.
-- Retrieve feedback on sent messages for apns.
 
 # Resources
 - Depends on APNS gem: https://rubygems.org/gems/apns

data/lib/pntfr.rb

@@ -1,6 +1,7 @@
 require 'pntfr/version'
 require 'pntfr/platforms'
 require 'pntfr/notifier'
+require 'pntfr/feedback'
 
 module Pntfr
   def self.test_env?

data/lib/pntfr/apns_configurator.rb

@@ -0,0 +1,15 @@
+module Pntfr
+  module ApnsConfigurator
+    def configure_apns config_override
+      config= Pntfr.config.apns
+      unless config_override.nil?
+        config= config.clone.merge(config_override)
+      end
+      APNS.host = config[:host]
+      APNS.pem  = config[:pem]
+      APNS.port = config[:port]
+      APNS.pass = config[:pass]
+      @apns= APNS
+    end
+  end
+end

data/lib/pntfr/base_service.rb

@@ -0,0 +1,28 @@
+module Pntfr
+  class BaseService
+    def initialize credentials
+      validate_credentials(credentials)
+      @credentials= credentials || {}
+    end
+
+    #--------------------------------------------
+    private
+    #--------------------------------------------
+    def andr_session
+      @andr_session||= Pntfr::Session::Android.new(@credentials[:andr])
+    end
+    def ios_session
+      @ios_session||= Pntfr::Session::Ios.new(@credentials[:ios])
+    end
+    def validate_credentials(credentials)
+      return if credentials.nil?
+      if !credentials.is_a?(Hash)
+        raise ArgumentError.new('Credentials should be a Hash with either :andr or :ios keys!')
+      end
+      if !(credentials.has_key?(:andr) or credentials.has_key?(:ios))
+        raise ArgumentError.new('Either :andr or :ios service credentials should have been provided!')
+      end
+    end
+
+  end
+end

data/lib/pntfr/feedback.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/base_service'
+require 'apns'
+require 'pntfr/apns_configurator'
+
+module Pntfr
+  class Feedback < BaseService
+    include Pntfr::ApnsConfigurator
+
+    def initialize credentials=nil
+      super
+      configure_apns(credentials[:ios])
+    end
+
+    def bad_devices
+      feedback= ::APNS.feedback
+      feedback.collect do |rs|
+        bd= BadDevice.new(rs.last)
+        bd.timestamp= rs.first
+        bd
+      end
+    end
+
+  end
+
+  class BadDevice
+    attr_accessor :timestamp
+    attr_accessor :push_id
+    def initialize(push_id)
+      @push_id= push_id
+    end
+  end
+end

data/lib/pntfr/notifier.rb

@@ -1,9 +1,10 @@
+require File.dirname(__FILE__) + '/base_service'
 require File.dirname(__FILE__) + '/session/base'
 require File.dirname(__FILE__) + '/notification'
 
 module Pntfr
 
-  class Notifier
+  class Notifier < BaseService
     def self.to devices, credentials=nil
       notif= Notifier.new(credentials)
       notif.update_devices(devices)
@@ -25,8 +26,7 @@ module Pntfr
     #  }
     #
     def initialize credentials=nil
-      validate_credentials(credentials)
-      @credentials= credentials || {}
+      super
 
       @andr_responses=[]
       @ios_responses= []
@@ -79,15 +79,6 @@ module Pntfr
     def ios_session
       @ios_session||= Pntfr::Session::Ios.new(@credentials[:ios])
     end
-    def validate_credentials(credentials)
-      return if credentials.nil?
-      if !credentials.is_a?(Hash)
-        raise ArgumentError.new('Credentials should be a Hash with either :andr or :ios keys!')
-      end
-      if !(credentials.has_key?(:andr) or credentials.has_key?(:ios))
-        raise ArgumentError.new('Either :andr or :ios service credentials should have been provided!')
-      end
-    end
 
   end
 

data/lib/pntfr/session/ios.rb

@@ -2,9 +2,12 @@
 # Session implementation for iOS
 #
 require 'apns'
+require 'pntfr/apns_configurator'
+
 module Pntfr
   module Session
     class Ios < Pntfr::Session::Base
+      include Pntfr::ApnsConfigurator
 
       attr_reader :apns
 
@@ -47,17 +50,6 @@ module Pntfr
         device.methods.include?(:num_notifs)
       end
 
-      def configure_apns config_override
-        config= Pntfr.config.apns
-        unless config_override.nil?
-          config= config.clone.merge(config_override)
-        end
-        APNS.host = config[:host]
-        APNS.pem  = config[:pem]
-        APNS.port = config[:port]
-        APNS.pass = config[:pass]
-        @apns= APNS
-      end
     end
   end
 end

data/lib/pntfr/version.rb

@@ -2,6 +2,10 @@
 # Let's follow Semantic Versioning: http://semver.org/
 #
 module Pntfr
+  #
+  # PATCH v0.6.0
+  # - [FEATURE] Retrieve feedback on bad devices for apns.
+  # - Depend on minitest for development.
   #
   # PATCH v0.5.3
   # - [FIX] Depend on apns2 gem to be connection failure tolerant during big batches.
@@ -28,5 +32,5 @@ module Pntfr
   # - Allow overriding general configuration credentials when instantiating each
   # Notifier (on both platforms).
   # - Internal refactoring.
-  VERSION = '0.5.3'
+  VERSION = '0.6.0'
 end

data/pntfr.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.1'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.8', '>= 5.8.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pntfr
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apns2
@@ -98,6 +98,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.3
 description: One single API to send push notifications to Android and iOS devices.
 email:
 - oliver.hv@coditramuntana.com
@@ -113,6 +133,9 @@ files:
 - README.md
 - Rakefile
 - lib/pntfr.rb
+- lib/pntfr/apns_configurator.rb
+- lib/pntfr/base_service.rb
+- lib/pntfr/feedback.rb
 - lib/pntfr/notification.rb
 - lib/pntfr/notifier.rb
 - lib/pntfr/platforms.rb