pushing 0.1.0

data/lib/pushing/log_subscriber.rb

@@ -0,0 +1,44 @@
+require "active_support/log_subscriber"
+require "active_support/core_ext/string/indent"
+
+module Pushing
+  # Implements the ActiveSupport::LogSubscriber for logging notifications when
+  # a push notification is delivered.
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    # A notification was delivered.
+    def deliver(event)
+      return unless logger.info?
+
+      event.payload[:notification].each do |platform, payload|
+        info do
+          recipients = payload.recipients.map {|r| r.truncate(32) }.join(", ")
+          "  #{platform.upcase}: sent push notification to #{recipients} (#{event.duration.round(1)}ms)"
+        end
+
+        next unless logger.debug?
+        debug do
+          "Payload:\n#{JSON.pretty_generate(payload.payload).indent(2)}\n".indent(2)
+        end
+      end
+    end
+
+    # A notification was generated.
+    def process(event)
+      return unless logger.debug?
+
+      debug do
+        notifier = event.payload[:notifier]
+        action   = event.payload[:action]
+
+        "#{notifier}##{action}: processed outbound push notification in #{event.duration.round(1)}ms"
+      end
+    end
+
+    # Use the logger configured for Pushing::Base.
+    def logger
+      Pushing::Base.logger
+    end
+  end
+end
+
+Pushing::LogSubscriber.attach_to :push_notification

data/lib/pushing/notification_delivery.rb

@@ -0,0 +1,79 @@
+require "delegate"
+
+module Pushing
+  class NotificationDelivery < Delegator
+    def initialize(notifier_class, action, *args) #:nodoc:
+      @notifier_class, @action, @args = notifier_class, action, args
+
+      # The notification is only processed if we try to call any methods on it.
+      # Typical usage will leave it unloaded and call deliver_later.
+      @processed_notifier = nil
+      @notification_message = nil
+    end
+
+    def __getobj__ #:nodoc:
+      @notification_message ||= processed_notifier.notification
+    end
+
+    # Unused except for delegator internals (dup, marshaling).
+    def __setobj__(notification_message) #:nodoc:
+      @notification_message = notification_message
+    end
+
+    def message
+      __getobj__
+    end
+
+    def processed?
+      @processed_notifier || @notification_message
+    end
+
+    def deliver_later!(options = {})
+      enqueue_delivery :deliver_now!, options
+    end
+
+    def deliver_now!
+      processed_notifier.handle_exceptions { do_deliver }
+    end
+
+    private
+
+    def do_deliver
+      @notifier_class.inform_interceptors(self)
+
+      responses = nil
+      @notifier_class.deliver_notification(self) do
+        responses = ::Pushing::Platforms.config.map do |platform, config|
+          Adapters.instance(config).push!(message[platform]) if message[platform]
+        end.compact
+      end
+
+      responses.each {|response| @notifier_class.inform_observers(self, response) }
+      responses
+    end
+
+    def processed_notifier
+      @processed_notifier ||= begin
+                                notifier = @notifier_class.new
+                                notifier.process @action, *@args
+                                notifier
+                              end
+    end
+
+    def enqueue_delivery(delivery_method, options = {})
+      if processed?
+        ::Kernel.raise "You've accessed the message before asking to " \
+                       "deliver it later, so you may have made local changes that would " \
+                       "be silently lost if we enqueued a job to deliver it. Why? Only " \
+                       "the notifier method *arguments* are passed with the delivery job! " \
+                       "Do not access the message in any way if you mean to deliver it " \
+                       "later. Workarounds: 1. don't touch the message before calling " \
+                       "#deliver_later, 2. only touch the message *within your notifier " \
+                       "method*, or 3. use a custom Active Job instead of #deliver_later."
+      else
+        args = @notifier_class.name, @action.to_s, delivery_method.to_s, *@args
+        ::Pushing::DeliveryJob.set(options).perform_later(*args)
+      end
+    end
+  end
+end

data/lib/pushing/platforms.rb

@@ -0,0 +1,91 @@
+# frozen-string-literal: true
+
+require 'active_support/configurable'
+require 'active_support/core_ext/hash/keys'
+
+module Pushing
+  module Platforms
+    include ActiveSupport::Configurable
+
+    config.apn = ActiveSupport::OrderedOptions.new
+    config.fcm = ActiveSupport::OrderedOptions.new
+
+    class << self
+      def lookup(platform_name)
+        const_get(:"#{platform_name.capitalize}Payload")
+      end
+    end
+
+    class ApnPayload
+      attr_reader :payload, :device_token, :environment
+
+      EMPTY_HASH = {}.freeze
+
+      def self.should_render?(options)
+        options.is_a?(Hash) ? options[:device_token].present? : options.present?
+      end
+
+      def initialize(payload, options)
+        if options.is_a?(String)
+          @device_token = options
+        else options.is_a?(Hash)
+          @device_token, @environment, @headers = options.values_at(:device_token, :environment, :headers)
+        end
+
+        @payload = payload
+        @headers ||= EMPTY_HASH
+      end
+
+      def recipients
+        Array(@device_token)
+      end
+
+      def headers
+        @normalized_headers ||= begin
+                                  h = @headers.stringify_keys.transform_keys!(&:dasherize)
+
+                                  {
+                                    authorization:      h['authorization'],
+                                    'apns-id':          h['apns-id']          || h['id'],
+                                    'apns-expiration':  h['apns-expiration']  || h['expiration'],
+                                    'apns-priority':    h['apns-priority']    || h['priority'],
+                                    'apns-topic':       h['apns-topic']       || h['topic'],
+                                    'apns-collapse-id': h['apns-collapse-id'] || h['collapse-id'],
+                                  }
+                                end
+      end
+    end
+
+    class FcmPayload
+      attr_reader :payload
+
+      def self.should_render?(options)
+        options.present?
+      end
+
+      def initialize(payload, *)
+        @payload = payload
+      end
+
+      def recipients
+        Array(payload[:to] || payload[:registration_ids])
+      end
+    end
+  end
+
+  class DeliveryError < RuntimeError
+    attr_reader :response, :notification
+
+    def initialize(message, response = nil, notification = nil)
+      super(message)
+      @response = response
+      @notification = notification
+    end
+  end
+
+  class ApnDeliveryError < DeliveryError
+  end
+
+  class FcmDeliveryError < DeliveryError
+  end
+end

data/lib/pushing/railtie.rb

@@ -0,0 +1,25 @@
+require "active_job/railtie"
+require "rails"
+
+module Pushing
+  class Railtie < Rails::Railtie # :nodoc:
+    config.eager_load_namespaces << Pushing
+
+    initializer "pushing.logger" do
+      ActiveSupport.on_load(:pushing) { self.logger ||= Rails.logger }
+    end
+
+    initializer "pushing.add_view_paths" do |app|
+      views = app.config.paths["app/views"].existent
+      if !views.empty?
+        ActiveSupport.on_load(:pushing) { prepend_view_path(views) }
+      end
+    end
+
+    initializer "pushing.compile_config_methods" do
+      ActiveSupport.on_load(:pushing) do
+        config.compile_methods! if config.respond_to?(:compile_methods!)
+      end
+    end
+  end
+end

data/lib/pushing/rescuable.rb

@@ -0,0 +1,28 @@
+require 'active_support/rescuable'
+
+module Pushing #:nodoc:
+  module Rescuable
+    extend ActiveSupport::Concern
+    include ActiveSupport::Rescuable
+
+    class_methods do
+      def handle_exception(exception) #:nodoc:
+        rescue_with_handler(exception) || raise(exception)
+      end
+    end
+
+    def handle_exceptions #:nodoc:
+      yield
+    rescue => exception
+      rescue_with_handler(exception) || raise
+    end
+
+    private
+
+    def process(*)
+      handle_exceptions do
+        super
+      end
+    end
+  end
+end

data/lib/pushing/template_handlers.rb

@@ -0,0 +1,15 @@
+# frozen-string-literal: true
+
+module Pushing
+  module TemplateHandlers
+    extend ActiveSupport::Autoload
+
+    autoload :JbuilderHandler
+
+    def self.lookup(template)
+      const_get("#{template.to_s.camelize}Handler")
+    rescue NameError
+      raise NotImplementedError.new("The template engine `#{template}' is not yet supported.")
+    end
+  end
+end

data/lib/pushing/template_handlers/jbuilder_handler.rb

@@ -0,0 +1,17 @@
+# frozen-string-literal: true
+
+require 'jbuilder/jbuilder_template'
+
+module Pushing
+  module TemplateHandlers
+    class JbuilderHandler < ::JbuilderHandler
+      def self.call(*)
+        super.gsub("json.target!", "json.attributes!").gsub("new(self)", "new(self, key_formatter: ::Pushing::TemplateHandlers::JbuilderHandler)")
+      end
+
+      def self.format(key)
+        key
+      end
+    end
+  end
+end

data/lib/pushing/version.rb

@@ -0,0 +1,3 @@
+module Pushing
+  VERSION = "0.1.0"
+end

data/pushing.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pushing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pushing"
+  spec.version       = Pushing::VERSION
+  spec.authors       = ["Yuki Nishijima"]
+  spec.email         = ["mail@yukinishijima.net"]
+  spec.summary       = %q{Push notification framework that does not hurt. finally.}
+  spec.description   = %q{Pushing is like ActionMailer, but for sending push notifications.}
+  spec.homepage      = "https://github.com/yuki24/pushing"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionpack", ">= 4.2.0"
+  spec.add_dependency "actionview", ">= 4.2.0"
+  spec.add_dependency "activejob", ">= 4.2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "jbuilder"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: pushing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuki Nishijima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pushing is like ActionMailer, but for sending push notifications.
+email:
+- mail@yukinishijima.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- certs/apns_example_production.pem.enc
+- gemfiles/rails_42.gemfile
+- gemfiles/rails_50.gemfile
+- gemfiles/rails_51.gemfile
+- gemfiles/rails_edge.gemfile
+- lib/generators/pushing/USAGE
+- lib/generators/pushing/notifier_generator.rb
+- lib/generators/pushing/templates/application_notifier.rb
+- lib/generators/pushing/templates/initializer.rb
+- lib/generators/pushing/templates/notifier.rb
+- lib/generators/pushing/templates/template.json+apn.jbuilder
+- lib/generators/pushing/templates/template.json+fcm.jbuilder
+- lib/pushing.rb
+- lib/pushing/adapters.rb
+- lib/pushing/adapters/apn/apnotic_adapter.rb
+- lib/pushing/adapters/apn/houston_adapter.rb
+- lib/pushing/adapters/apn/lowdown_adapter.rb
+- lib/pushing/adapters/fcm/andpush_adapter.rb
+- lib/pushing/adapters/fcm/fcm_gem_adapter.rb
+- lib/pushing/adapters/test_adapter.rb
+- lib/pushing/base.rb
+- lib/pushing/delivery_job.rb
+- lib/pushing/log_subscriber.rb
+- lib/pushing/notification_delivery.rb
+- lib/pushing/platforms.rb
+- lib/pushing/railtie.rb
+- lib/pushing/rescuable.rb
+- lib/pushing/template_handlers.rb
+- lib/pushing/template_handlers/jbuilder_handler.rb
+- lib/pushing/version.rb
+- pushing.gemspec
+homepage: https://github.com/yuki24/pushing
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Push notification framework that does not hurt. finally.
+test_files: []