acts_as_hoc_pushable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d00454537e4bab721f743e015a0480f109ee6b18
+  data.tar.gz: f52dc1694290daf75ac9f576b903a5ef08164afa
+SHA512:
+  metadata.gz: 6ca7e19d67c12c9371bab1f1c33a3273f162c22640abeebdef5a25b44dd1bcb66ac2a80a9de421bc28ac6679e799f5c10a78f2599de5d724e7aee6ccc444e4c7
+  data.tar.gz: 80f7a7592b607a4b67dabf21710fabc397a2a40819c75e83e962e25355def575d609061379d4d05a632f612ee55b5b43c65cb61e2f1b1abec4682fd56f6d6f69

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in acts_as_hoc_pushable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Gert Lavsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# ActsAsHocPushable
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/acts_as_hoc_pushable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_hoc_pushable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_hoc_pushable
+
+## Usage
+
+### Make application ready for acts_as_hoc_pushable
+Install by running:
+
+    $ rails generate acts_as_hoc_pushable:install
+
+This will create, models, migrations and initializer
+
+### Extend model
+Add the `acts_as_hoc_pushable` to the model you want to be extended with push functionallity - eg. user.
+
+```ruby
+#app/models/user.rb
+class User < ApplicationRecord
+  acts_as_hoc_pushable
+end
+```
+
+now you have the following functionallity added to the model
+
+* Add a device to an user
+  `user.add_device(token:, platform:, platform_version:, push_environment:)`
+  `user.add_device(params)`
+  `user.add_device!(params)`
+* Get active devices
+  `user.active_devices`
+* Get platform specific devices
+  `user.ios_devices`
+  `user.android_devices`
+* Send push notification
+  `user.send_push_notification(title:, message:, **data)`
+* Send silent push notification
+  `send_silent_push_notification(**data)`
+
+
+### Other functions
+
+#### Send to topic:
+You can send push notifications to a topic with:
+```ruby
+  ActsAsHocPushable::PushNotification.send_push_notification_to_topic(topic:, title: nil, message: nil, **data)
+```
+or for silent notification:
+```ruby
+  ActsAsHocPushable::PushNotification.send_silent_push_notification_to_topic(topic:, **data)
+```
+#### Send to many devices:
+```ruby
+  ActsAsHocPushable::PushNotification.send_push_notification(devices:, title: nil, message: nil, **data)
+```
+or for silent notification:
+```ruby
+  ActsAsHocPushable::PushNotification.send_silent_push_notification(devices:, **data)
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/acts_as_hoc_pushable.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "acts_as_hoc_pushable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_hoc_pushable"
+  spec.version       = ActsAsHocPushable::VERSION
+  spec.authors       = ["Gert Lavsen"]
+  spec.email         = ["gert@houseofcode.io"]
+
+  spec.summary       = "Add push tokens to model"
+  spec.description   = "Add push tokens to model"
+  spec.homepage      = "https://github.com/lavsen/acts_as_hoc_pushable"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "fcm"
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acts_as_hoc_pushable"
+
+# 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/lib/acts_as_hoc_pushable.rb

@@ -0,0 +1,25 @@
+require 'acts_as_hoc_pushable/version'
+require 'acts_as_hoc_pushable/acts_as_hoc_pushable'
+require 'acts_as_hoc_pushable/configuration'
+require 'acts_as_hoc_pushable/push_notification'
+require 'acts_as_hoc_pushable/active_record/device.rb'
+
+module ActsAsHocPushable
+  LOCK = Mutex.new
+  class << self
+    def configure(config_hash=nil)
+      if config_hash
+        config_hash.each do |k,v|
+          configuration.send("#{k}=", v) rescue nil if configuration.respond_to?("#{k}=")
+        end
+      end
+
+      yield(configuration) if block_given?
+    end
+
+    def configuration
+      @configuration = nil unless defined?(@configuration)
+      @configuration || LOCK.synchronize { @configuration ||= ActsAsHocPushable::Configuration.new }
+    end
+  end
+end

data/lib/acts_as_hoc_pushable/active_record/device.rb

@@ -0,0 +1,52 @@
+module ActsAsHocPushable
+  class Device < ActiveRecord::Base
+    belongs_to :parent, polymorphic: true
+
+    validates :token, :platform, :valid_at, :parent, :platform_version, :push_environment, presence: true
+    validates :token, uniqueness: true
+    validates :active, inclusion: { in: [true, false] }
+
+    before_validation :set_valid_at, on: :create
+    before_validation :strip_spaces_from_token, on: :create, if: :token
+
+    scope :active, -> { where(invalidated_at: nil, active: true) }
+    scope :ios, -> { where(platform: "ios") }
+    scope :android, -> { where(platform: "ios") }
+
+    default_scope { active }
+
+    def ios?
+      platform == 'ios'
+    end
+
+    def android?
+      platform == 'android'
+    end
+
+    def invalidate
+      update_attributes(invalidated_at: Time.current)
+    end
+
+    def deactivate
+      update_attributes(active: false, deactivated_at: Time.current)
+    end
+
+    def send_notification(title:, message:, **data)
+      ActsAsHocPushable::PushNotification.send_push_notification(devices: [self], title: title, message: message, **data)
+    end
+
+    def send_silent_notification(**data)
+      ActsAsHocPushable::PushNotification.send_silent_push_notification(devices: [self], **data)
+    end
+
+    private
+
+    def set_valid_at
+      self.valid_at = Time.current
+    end
+
+    def strip_spaces_from_token
+      self.token = token.delete(' ')
+    end
+  end
+end

data/lib/acts_as_hoc_pushable/acts_as_hoc_pushable.rb

@@ -0,0 +1,59 @@
+module ActsAsHocPushable
+  extend ActiveSupport::Concern
+
+  included do
+  end
+
+  module ClassMethods
+    def acts_as_hoc_pushable(_options = {})
+      has_many :devices, as: :parent, class_name: 'ActsAsHocPushable::Device', dependent: :destroy
+    end
+  end
+
+  def active_devices
+    devices.active
+  end
+
+  def ios_devices
+    devices.ios
+  end
+
+  def android_devices
+    devices.android
+  end
+
+
+  def add_device(token:, platform:, platform_version:, push_environment:)
+    device = devices.new(token: token, platform: platform, platform_version: platform_version, push_environment: push_environment)
+    return device if device.save
+    device.errors.each do |attribute, message|
+      errors.add(:devices, "#{attribute} #{message}")
+    end
+    nil
+  end
+
+  def add_device(device_params)
+    device = devices.new(device_params)
+    return device if device.save
+    device.errors.each do |attribute, message|
+      errors.add(:devices, "#{attribute} #{message}")
+    end
+    nil
+  end
+
+  def add_device!(device_params)
+    device = devices.new(device_params)
+    device.save!
+    device
+  end
+
+  def send_push_notification(title:, message:, **data)
+    ActsAsHocPushable::PushNotification.send_push_notification(devices: devices, title: title, message: message, **data)
+  end
+
+  def send_silent_push_notification(**data)
+    ActsAsHocPushable::PushNotification.send_silent_push_notification(devices: devices, **data)
+  end
+
+end
+ActiveRecord::Base.send :include, ActsAsHocPushable

data/lib/acts_as_hoc_pushable/configuration.rb

@@ -0,0 +1,7 @@
+module ActsAsHocPushable
+  class Configuration
+    attr_accessor :firebase_key, :debug_firebase_response
+    def initialize
+    end
+  end
+end

data/lib/acts_as_hoc_pushable/push_notification.rb

@@ -0,0 +1,92 @@
+require 'json'
+require 'fcm'
+module ActsAsHocPushable
+  class PushNotification
+
+    attr_accessor :devices, :title, :message, :data
+
+    def initialize(devices:, title:, message:, **data)
+      @devices = devices
+      @title = title
+      @message = message
+      @data = data
+    end
+
+    def self.send_push_notification_to_topic(topic:, title: nil, message: nil, **data)
+      new(devices: nil, title: title, message: message, **data).perform_topic(topic: topic)
+    end
+
+    def self.send_silent_push_notification_to_topic(topic:, **data)
+      silent_data = data.merge({ content_avaiable: true })
+      new(devices: nil, title: nil, message: nil, **silent_data).perform_topic(topic: topic)
+    end
+
+    def self.send_push_notification(devices:, title: nil, message: nil, **data)
+      new(devices: devices, title: title, message: message, **data).perform
+    end
+
+    def self.send_silent_push_notification(devices:, **data)
+      silent_data = data.merge({ content_avaiable: true })
+      new(devices: devices, title: nil, message: nil, **silent_data).perform
+    end
+
+    def perform_topic(topic:)
+      response = client.send_to_topic(topic, push_options)
+      handle_response(response)
+    end
+
+    def perform
+      tokens = @devices.map {|d| d.token }
+      response = client.send(tokens, push_options)
+      handle_response(response)
+    end
+
+    protected
+
+    def title
+      @title ||= ""
+    end
+
+    def push_options(options = {})
+      options = {
+        priority: 'high',
+        data: data
+      }.merge(options)
+      options[:notification] = { body: @message, title: title } unless @message.nil?
+      options
+    end
+
+    private
+
+    def client
+      FCM.new(ActsAsHocPushable.configuration.firebase_key)
+    end
+
+
+
+    # Handles the response from firebase. Invalidates failed tokens
+    def handle_response(response)
+      Rails.logger.info "Raw response from fcm: #{response}" if (ActsAsHocPushable.configuration.debug_firebase_response ||= false)
+      body = parse_json(response[:body])
+      return if body.nil?
+      Rails.logger.info "Parsed response from fcm: #{body}" if (ActsAsHocPushable.configuration.debug_firebase_response ||= false)
+      failure = body['failure'].to_i
+      if failure > 0
+        i = 1
+        results = body['results']
+        results.each do |r|
+          invalidate_token_at_pos(i) if r.has_key? 'error'
+          i += 1
+        end
+      end
+    end
+
+    def parse_json(json)
+      JSON.parse(json) rescue nil if json && json.length >= 2
+    end
+
+    def invalidate_token_at_pos(pos)
+      @devices.first(pos).last.invalidate if pos <= @devices.count
+    end
+  end
+end

data/lib/acts_as_hoc_pushable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsHocPushable
+  VERSION = "1.0.0"
+end

data/lib/generators/acts_as_hoc_pushable/install_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/migration'
+
+module ActsAsHocPushable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer_file
+        template "initializer.rb", "config/initializers/acts_as_hoc_pushable.rb"
+      end
+
+      def copy_migration_files
+        migration_template "migration/create_devices.rb", "db/migrate/create_devices.rb"
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          sleep 1 # make sure each time we get a different timestamp
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+ActsAsHocPushable.configure do |config|
+  config.firebase_key = "replace_me_with_your_firebase_api_key"
+  config.debug_firebase_response = false
+end

data/lib/generators/acts_as_hoc_pushable/templates/migration/create_devices.rb

@@ -0,0 +1,21 @@
+class CreateDevices < ActiveRecord::Migration
+  def change
+    create_table :devices do |t|
+      t.string :token
+      t.integer :parent_id
+      t.string :parent_type
+      t.string :platform
+      t.boolean :active, default: true
+      t.datetime :valid_at
+      t.datetime :invalidated_at
+      t.datetime :deleted_at
+      t.string :platform_version
+      t.string :platform_type
+      t.string :push_environment
+      t.datetime :deactivated_at
+      t.timestamps
+    end
+
+    add_index :devices, :token, unique: true
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_hoc_pushable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gert Lavsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fcm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Add push tokens to model
+email:
+- gert@houseofcode.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_hoc_pushable.gemspec
+- bin/console
+- bin/setup
+- lib/acts_as_hoc_pushable.rb
+- lib/acts_as_hoc_pushable/active_record/device.rb
+- lib/acts_as_hoc_pushable/acts_as_hoc_pushable.rb
+- lib/acts_as_hoc_pushable/configuration.rb
+- lib/acts_as_hoc_pushable/push_notification.rb
+- lib/acts_as_hoc_pushable/version.rb
+- lib/generators/acts_as_hoc_pushable/install_generator.rb
+- lib/generators/acts_as_hoc_pushable/templates/initializer.rb
+- lib/generators/acts_as_hoc_pushable/templates/migration/create_devices.rb
+homepage: https://github.com/lavsen/acts_as_hoc_pushable
+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.13
+signing_key: 
+specification_version: 4
+summary: Add push tokens to model
+test_files: []