pushing 0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pushing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails_42.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "houston", require: false
+gem "apnotic", require: false
+gem "lowdown", require: false
+gem "andpush", require: false
+gem "fcm", require: false
+gem "pry"
+gem "pry-byebug", platforms: :mri
+gem "rails", "~> 4.2.0"
+gem "actionpack", "~> 4.2.0"
+gem "actionview", "~> 4.2.0"
+gem "activejob", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_50.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "houston", require: false
+gem "apnotic", require: false
+gem "lowdown", require: false
+gem "andpush", require: false
+gem "fcm", require: false
+gem "pry"
+gem "pry-byebug", platforms: :mri
+gem "railties", "~> 5.0.0"
+gem "actionpack", "~> 5.0.0"
+gem "actionview", "~> 5.0.0"
+gem "activejob", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_51.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "houston", require: false
+gem "apnotic", require: false
+gem "lowdown", require: false
+gem "andpush", require: false
+gem "fcm", require: false
+gem "pry"
+gem "pry-byebug", platforms: :mri
+gem "railties", "~> 5.1.0"
+gem "actionpack", "~> 5.1.0"
+gem "actionview", "~> 5.1.0"
+gem "activejob", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_edge.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+git "git://github.com/rails/rails.git" do
+  gem "railties"
+  gem "actionpack"
+  gem "actionview"
+  gem "activejob"
+end
+
+gem "houston", require: false
+gem "apnotic", require: false
+gem "lowdown", require: false
+gem "andpush", require: false
+gem "fcm", require: false
+gem "pry"
+gem "pry-byebug", platforms: :mri
+
+gemspec path: "../"

data/lib/generators/pushing/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Stubs out a new notifier and its views. Passes the notifier name, either
+    CamelCased or under_scored, and an optional list of push notifications
+    as arguments.
+
+    This generates a notifier class in app/notifiers.
+
+Example:
+    rails generate pushing:notifier TweetNotifier new_mention_in_tweet
+
+    creates a TweetNotifier class and views:
+        Mailer:     app/notifiers/tweet_notifier.rb
+        Views:      app/views/tweet_notifier/new_mention_in_tweet.json+apn.jbuilder
+                    app/views/tweet_notifier/new_mention_in_tweet.json+fcm.jbuilder

data/lib/generators/pushing/notifier_generator.rb

@@ -0,0 +1,46 @@
+module Pushing
+  class NotifierGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+
+    argument :actions, type: :array, default: [], banner: "method method"
+
+    check_class_collision suffix: "Notifier"
+
+    def create_notifier_file
+      template "notifier.rb", File.join("app/notifiers", class_path, "#{file_name}_notifier.rb")
+
+      actions.each do |action|
+        template "template.json+apn.jbuilder", File.join("app/views/", "#{file_name}_notifier", "#{action}.json+apn.jbuilder")
+        template "template.json+fcm.jbuilder", File.join("app/views/", "#{file_name}_notifier", "#{action}.json+fcm.jbuilder")
+      end
+
+      in_root do
+        if behavior == :invoke && !File.exist?(application_notifier_file_name)
+          template "application_notifier.rb", application_notifier_file_name
+        end
+
+        if behavior == :invoke && !File.exist?(initializer_file_name)
+          template "initializer.rb", initializer_file_name
+        end
+      end
+    end
+
+    private
+
+    def file_name # :doc:
+      @_file_name ||= super.gsub(/_notifier/i, "")
+    end
+
+    def initializer_file_name
+      @_initializer_file_name ||= "config/initializers/pushing.rb"
+    end
+
+    def application_notifier_file_name
+      @_application_notifier_file_name ||= if mountable_engine?
+                                           "app/notifiers/#{namespaced_path}/application_notifier.rb"
+                                         else
+                                           "app/notifiers/application_notifier.rb"
+                                         end
+    end
+  end
+end

data/lib/generators/pushing/templates/application_notifier.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class ApplicationNotifier < Pushing::Base
+end
+<% end %>

data/lib/generators/pushing/templates/initializer.rb

@@ -0,0 +1,10 @@
+Pushing::Platforms.configure do |config|
+  config.fcm.adapter    = Rails.env.test? ? :test : :andpush
+  config.fcm.server_key = 'YOUR_FCM_TEST_SERVER_KEY'
+
+  config.apn.environment          = Rails.env.production? ? :production : :development
+  config.apn.adapter              = Rails.env.test? ? :test : :apnotic
+  config.apn.topic                = 'com.awesomecompany.app'
+  config.apn.certificate_path     = '/config/your_certificate.pem'
+  config.apn.certificate_password = 'PASSWORD_FOR_CERT'
+end

data/lib/generators/pushing/templates/notifier.rb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Notifier < ApplicationNotifier
+<% actions.each do |action| -%>
+  def <%= action %>
+    @greeting = "Hi"
+
+    push apn: "device-token", fcm: true
+  end
+<% end -%>
+end
+<% end -%>

data/lib/generators/pushing/templates/template.json+apn.jbuilder

@@ -0,0 +1,53 @@
+# In this file you can customize the APN payload. For more details about key preference, see
+# Apple's offitial documentation here: http://bit.ly/apns-doc
+
+# the JSON dictionary can include custom keys and values with your app-specific content.
+# json.custom_data1 'content1...'
+# json.custom_data2 'content2...'
+
+# The aps dictionary contains the keys used by Apple to deliver the notification to the user's device.
+json.aps do
+
+  # Include this key when you want the system to display a standard alert or a banner (Dictionary or String).
+  # json.alert 'REPLACE_WITH_ACTUAL_TITLE'
+  json.alert do
+    # A short string describing the purpose of the notification.
+    json.title 'REPLACE_WITH_ACTUAL_TITLE'
+
+    # The text of the alert message.
+    json.body 'REPLACE_WITH_ACTUAL_BODY'
+
+    # The key to a title string in the Localizable.strings file for the current localization.
+    # json.set! 'title-loc-key', 'key in Localizable.strings'
+
+    # Variable string values to appear in place of the format specifiers in 'title-loc-key'.
+    # json.set! 'title-loc-args', ['arg1', 'arg2']
+
+    # If a string is specified, the system displays an alert that includes the Close and View buttons.
+    # json.set! 'action-loc-key', 'key in Localizable.strings'
+
+    # A key to an alert-message string in a Localizable.strings file for the current localization.
+    # json.set! 'loc-key', 'key in Localizable.strings'
+
+    # Variable string values to appear in place of the format specifiers in loc-key.
+    # json.set! 'loc-args', ['arg1', 'arg2']
+
+    # The filename of an image file in the app bundle, with or without the filename extension.
+    # json.set! 'launch-image', 'your_launch_iamge.png'
+  end
+
+  # Include this key when you want the system to modify the badge of your app icon.
+  json.badge 1
+
+  # Include this key when you want the system to play a sound.
+  json.sound 'bingbong.aiff'
+
+  # Provide this key with a string value that represents the notification's type.
+  # json.category 'your-category-type', 'CATEGORY-TYPE'
+
+  # Include this key with a value of 1 to configure a silent notification.
+  # json.set! 'content-available', 1
+
+  # Provide this key with a string value that represents the app-specific identifier for grouping notifications.
+  # json.set! 'thread-id', 'THREAD-ID'
+end

data/lib/generators/pushing/templates/template.json+fcm.jbuilder

@@ -0,0 +1,75 @@
+# In this file you can customize the FCM payload. For more details about Firebase Cloud Messaging HTTP Protocol, see
+# Google's offitial documentation here: https://goo.gl/tgssxy
+
+# The recipient of a message. The value can be a device's registration token, a device group's notification key, or a
+# single topic (prefixed with /topics/). Either the 'to' or 'registration_ids' key should be present.
+json.to 'REPLACE_WITH_ACTUAL_REGISTRATION_ID_OR_TOPIC'
+
+# The recipient of a multicast message, a message sent to more than one registration token. Either the 'to' or
+# 'registration_ids' key should be present.
+# json.registration_ids 'REPLACE_WITH_ACTUAL_REGISTRATION_IDS_OR_TOPIC'
+
+# A logical expression of conditions that determine the message target.
+# json.condition 'Topic'
+
+# This parameter identifies a group of messages (e.g., with collapse_key:
+# "Updates Available") that can be collapsed.
+# json.collapse_key "Updates Available"
+
+# Sets the priority of the message. Valid values are "normal" and "high".
+# json.priority "high"
+
+# How long (in seconds) the message should be kept in FCM storage if the device is offline.
+# json.time_to_live 4.weeks.to_i
+
+# The package name of the application where the registration tokens must match in order to receive the message.
+# json.restricted_package_name 'com.yourdomain.app'
+
+# This parameter, when set to true, allows developers to test a request without actually sending a message.
+# json.dry_run true
+
+# The custom key-value pairs of the message's payload.
+# json.data do
+#   json.custom_data "data..."
+# end
+
+# The predefined, user-visible key-value pairs of the notification payload. 
+json.notification do
+  # The notification's title.
+  json.title 'REPLACE_WITH_ACTUAL_TITLE'
+
+  # The notification's body text.
+  json.body 'REPLACE_WITH_ACTUAL_BODY'
+
+  # The notification's channel id (new in Android O).
+  # json.android_channel_id "my_channel_01"
+
+  # The notification's icon.
+  json.icon 1
+
+  # The sound to play when the device receives the notificatio
+  json.sound 'default'
+
+  # Identifier used to replace existing notifications in the notification drawer.
+  # json.tag 'tag-name'
+
+  # The notification's icon color, expressed in #rrggbb format.
+  # json.color "#ffffff"
+
+  # The action associated with a user click on the notification.
+  # json.click_action "OPEN_ACTIVITY_1"
+
+  # The key to the body in the app's string resources to use to localize the body to the user's current localization.
+  # json.body_loc_key 'key in Localizable.strings'
+
+  # String values to be used in place of the format specifiers in 'body_loc_key' to use to localize the body to the
+  # user's current localization.
+  # json.body_loc_args ['arg1', 'arg2']
+
+  # The key to the title in the app's string resources to use to localize the title to the user's current localization.
+  # json.title_loc_key 'key in Localizable.strings'
+
+  # String values to be used in place of the format specifiers in title_loc_key to use to localize the title text to
+  # the user's current localization.
+  # json.title_loc_args ['arg1', 'arg2']
+end

data/lib/pushing.rb

@@ -0,0 +1,16 @@
+require "active_support/dependencies/autoload"
+require "pushing/version"
+
+module Pushing
+  extend ::ActiveSupport::Autoload
+
+  autoload :Adapters
+  autoload :Base
+  autoload :DeliveryJob
+  autoload :NotificationDelivery
+  autoload :Platforms
+end
+
+if defined?(Rails)
+  require 'pushing/railtie'
+end

data/lib/pushing/adapters.rb

@@ -0,0 +1,43 @@
+# frozen-string-literal: true
+
+module Pushing
+  module Adapters
+    extend ActiveSupport::Autoload
+
+    autoload :HoustonAdapter, 'pushing/adapters/apn/houston_adapter'
+    autoload :ApnoticAdapter, 'pushing/adapters/apn/apnotic_adapter'
+    autoload :LowdownAdapter, 'pushing/adapters/apn/lowdown_adapter'
+    autoload :AndpushAdapter, 'pushing/adapters/fcm/andpush_adapter'
+    autoload :FcmGemAdapter,  'pushing/adapters/fcm/fcm_gem_adapter'
+    autoload :TestAdapter
+
+    # Hash object that holds referenses to adapter instances.
+    ADAPTER_INSTANCES = {}
+
+    # Mutex object used to ensure the +instance+ method creates a singleton object.
+    MUTEX = Mutex.new
+
+    private_constant :ADAPTER_INSTANCES, :MUTEX
+
+    class << self
+      ##
+      # Returns the constant for the specified adapter name.
+      #
+      #   Pushing::Adapters.lookup(:apnotic)
+      #   # => Pushing::Adapters::ApnoticAdapter
+      def lookup(name)
+        const_get("#{name.to_s.camelize}Adapter")
+      end
+
+      ##
+      # Provides an adapter instance specified in the +configuration+. If the adapter is not found in
+      # +ADAPTER_INSTANCES+, it'll look up the adapter class and create a new instance using the
+      # +configuration+.
+      def instance(configuration)
+        ADAPTER_INSTANCES[configuration.adapter] || MUTEX.synchronize do
+          ADAPTER_INSTANCES[configuration.adapter] ||= lookup(configuration.adapter).new(configuration)
+        end
+      end
+    end
+  end
+end

data/lib/pushing/adapters/apn/apnotic_adapter.rb

@@ -0,0 +1,86 @@
+# frozen-string-literal: true
+
+require 'apnotic'
+
+module Pushing
+  module Adapters
+    class ApnoticAdapter
+      APS_DICTIONARY_KEYS = %i[
+        alert
+        badge
+        sound
+        content_available
+        category
+        url_args
+        mutable_content
+      ].freeze
+
+      DEFAULT_ADAPTER_OPTIONS = {
+        size: Process.getrlimit(Process::RLIMIT_NOFILE).first / 8
+      }.freeze
+
+      attr_reader :environment, :topic, :connection_pool
+
+      def initialize(apn_settings)
+        @environment = apn_settings.environment.to_sym
+        @topic       = apn_settings.topic
+
+        options = {
+          cert_path: apn_settings.certificate_path,
+          cert_pass: apn_settings.certificate_password
+        }
+
+        @connection_pool = {
+          development: Apnotic::ConnectionPool.development(options, DEFAULT_ADAPTER_OPTIONS),
+          production: Apnotic::ConnectionPool.new(options, DEFAULT_ADAPTER_OPTIONS),
+        }
+      end
+
+      def push!(notification)
+        message = Apnotic::Notification.new(notification.device_token)
+        json    = notification.payload
+
+        if aps = json.delete(:aps)
+          APS_DICTIONARY_KEYS.each {|key| message.instance_variable_set(:"@#{key}", aps[key]) }
+        end
+
+        message.custom_payload = json
+
+        message.apns_id          = notification.headers[:'apns-id'] || message.apns_id
+        message.expiration       = notification.headers[:'apns-expiration'].to_i
+        message.priority         = notification.headers[:'apns-priority']
+        message.topic            = notification.headers[:'apns-topic'] || topic
+        message.apns_collapse_id = notification.headers[:'apns-collapse-id']
+
+        response = connection_pool[notification.environment || environment].with {|connection| connection.push(message) }
+
+        if !response
+          raise "Timeout sending a push notification"
+        elsif response.status != '200'
+          raise response.body.to_s
+        end
+
+        ApnResponse.new(response)
+      rescue => cause
+        response = response ? ApnResponse.new(response) : nil
+        error    = Pushing::ApnDeliveryError.new("Error while trying to send push notification: #{cause.message}", response, notification)
+
+        raise error, error.message, cause.backtrace
+      end
+
+      class ApnResponse < SimpleDelegator
+        def code
+          __getobj__.status.to_i
+        end
+        alias status code
+
+        def json
+          @json ||= __getobj__.body.symbolize_keys if !__getobj__.body.empty?
+        end
+        alias body json
+      end
+
+      private_constant :ApnResponse
+    end
+  end
+end