acts_as_pushable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed12f0e669f857b1557bfd63ceaf0b707666202e
+  data.tar.gz: 82c4bbdfc796f1c940a6a0f1d4fa3eb89ee7b5c5
+SHA512:
+  metadata.gz: cc1fda57e9415e2492820c26a233311c0d6eea4886dde6112d98b8f2a56482ddfe2e2220ffb6c7699808ecf4633e84ef788ad23dd2bb49c739b0be8e5abf200d
+  data.tar.gz: a8f27a82cd72ef09e38750ae37f5d1b722fb16f988be7b0b9abae1fd8ef23f186a302cbb217de5487f2b6a0d3f6723ab4a44b5084951e6ba65a02d7a49e8457c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Adam Butler
+
+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,156 @@
+# ActsAsPushable
+
+[![Build Status](https://semaphoreci.com/api/v1/projects/28a53ae7-389f-4d93-9f8a-51c4b0756cf7/840599/badge.svg)](https://semaphoreci.com/simpleweb/acts_as_pushable)
+[![Gem Version](https://badge.fury.io/rb/acts_as_pushable.svg)](https://badge.fury.io/rb/acts_as_pushable)
+
+A gem for Ruby on Rails that makes managing devices and push notifications for both iOS and Android easy and reliable.
+
+## Setup
+
+Add ActsAsPushable to your Gemfile
+
+  ```shell
+  gem 'acts_as_pushable'
+  bundle install
+  ```
+
+or just install it -
+
+  ```shell
+  gem install acts_as_pushable
+  ```
+
+## Quick start
+
+Run the generator to create the migrations and initializer template -
+
+  ```shell
+  rails generate act_as_pushable
+  ```
+
+This a file at `config/initializers/acts_as_pushable.rb` that you can modify to match your settings. Follow the quick start guides for the platforms that you want to support.
+
+Next add `acts_as_pushable` the following to the model that you want to have devices, this is usually the `User` model. It should look something like this -
+
+  ```ruby
+  class User < ActiveRecord::Base
+    acts_as_pushable
+  end
+  ```
+
+## Quick start - iOS
+
+Before we start you'll need a push certificate for both APN Development and APN Production. You can find instructions on how to do this [here](https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppDistributionGuide/AddingCapabilities/AddingCapabilities.html#//apple_ref/doc/uid/TP40012582-CH26-SW11).
+
+> **Important:** You should do both production and development and include them in all deployment environments. These relate to the two environments that Apple provide rather than your environments.
+
+Once you have the certificate from Apple, you will need to export your key and the installed certificate as p12 files. Here how you do this -
+
+1. In Keychain Access find your installed certificate
+2. Right click the certificate, it should have an arrow next to it if install correctly, then export it.
+  ![export](https://cloud.githubusercontent.com/assets/1238468/15851982/5a9bb9e0-2c97-11e6-8407-2e4797673dff.jpg)
+3. Next convert the p12 file to a pem file by running the following command.
+  ```
+  $ openssl pkcs12 -in cert.p12 -out apple_push_notification.pem -nodes -clcerts
+  ```
+4. The output pem file should be put in one of the following locations depending on it's type -
+  - `config/acts_as_pushable/apn/production.pem`
+  - `config/acts_as_pushable/apn/development.pem`
+
+> Note: You can change the location that the pem file is loaded stored in the `acts_as_pushable.rb` initializer.
+
+## Quick start - Android
+
+1. Register for GCM (Google Cloud Messaging) at [developers.google.com](https://developers.google.com/cloud-messaging/).
+2. Enter your key into the `acts_as_pushable.rb` initializer. You can get this from the [Google API Developer Console](https://console.developers.google.com). It should be entered as such -
+
+  ```ruby
+  ActsAsPushable.configure do |config|
+    config.gcm_key = 'replace_me_with_your_api_key'
+  end
+  ```
+
+## Add a device
+
+You can add a device to any model with `acts_as_pushable`. In these examples we'll use a model named `User` as an example.
+
+  ```ruby
+  user = User.create
+  user.add_device({
+    token: 'the_token_generated_by_the_device',
+    platform: "ios",
+    platform_version: "9.3",
+    push_environment: "development",
+  })
+  ```
+
+## Send a push notification to a user
+
+Sending a push notification to a user will send the message to all of their valid device tokens both on iOS & Android
+
+  ```ruby
+  user = User.find(id)
+  user.send_push_notification(title: 'My App', message: 'this is a test', options)
+  ```
+
+> You might want to consider doing this inside a worker.
+
+## Send a push notification to a specific device
+
+  ```ruby
+  user = User.find(id)
+  device = user.devices.first
+
+  case device.platform
+  when "ios"
+    # iOS does not support titles
+    user.send_push_notification(message: 'this is a test', options)
+  when "android"
+    user.send_push_notification(message: 'this is a test', options)
+  end
+  ```
+
+> You might want to consider doing this inside a worker.
+
+## Apple Feedback Service
+
+Occasionally you'll want to cleanup old tokens that have been invalidated for various reasons. You can do this by running -
+
+```
+ActsAsPushable::APN::FeedbackService.run
+```
+
+We'd recommnd running this on a daily/weekly cron job.
+
+> Note: With Android this happens at the time of sending a notification, no action is required.
+
+---
+
+## Setup for development
+
+Clone the repository -
+
+  ```shell
+  git clone git@github.com:simpleweb/acts_as_pushable.git
+  cd acts_as_pushable
+  bundle install
+  ```
+
+#### Run the specs with RSpec
+
+  ```
+  rspec
+  ```
+
+## Other useful resources
+
+- [Bullet Proof Push](https://www.youtube.com/watch?v=k5J6t-y1bws) _15 minute talk by [Adam Butler](http://twitter.com/labfoo)_ - The ideas that this gem is based on.
+- [simpleweb/ios-development-for-teams](https://github.com/simpleweb/ios-development-for-teams) - A guide by the author of this gem on setting up Certificates, ID's and Provisioning profiles that work well for teams.
+- [nomad/houston](https://github.com/nomad/houston) - Powers the APN part of this gem
+- [spacialdb/gcm](https://github.com/spacialdb/gcm) - Powers the GCM part of this gem.
+
+## Contributing
+
+This project follows the [GitHub Flow workflow](https://guides.github.com/introduction/flow/). All contributions should be provided as descriptive atomic pull requests.
+
+The gem should be versioned in accordance to [Semantic Versioning 2.0.0](http://semver.org/).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsPushable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/acts_as_pushable/active_record/device.rb

@@ -0,0 +1,46 @@
+module ActsAsPushable
+  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
+
+    scope :active, -> { where(invalidated_at: nil, active: true) }
+
+    default_scope { active }
+
+    def ios?
+      platform == 'ios'
+    end
+
+    def android?
+      platform == 'android'
+    end
+
+    def deactivate
+      self.update_attributes({
+        active: false,
+        deactivated_at: Time.now,
+      })
+    end
+
+    def send_push_notification(message:, **options)
+      case platform
+      when 'ios'
+        ActsAsPushable::APN::Notification.send(device: self, message: message, **options)
+      when 'android'
+        raise ArgumentError, 'missing keyword: title' unless options.key? :title
+        ActsAsPushable::GCM::Notification.send(device: self, title: options[:title], message: message, **options)
+      end
+    end
+
+    private
+
+    def set_valid_at
+      self.valid_at = Time.now
+    end
+  end
+end

data/lib/acts_as_pushable/apn/feedback_service.rb

@@ -0,0 +1,22 @@
+require 'houston'
+
+module ActsAsPushable
+  module APN
+    class FeedbackService
+      def self.run
+        development_apn = Houston::Client.development
+        production_apn = Houston::Client.production
+
+        development_apn.certificate = ActsAsPushable.configuration.apn_development_certificate_file
+        production_apn.certificate = ActsAsPushable.configuration.apn_production_certificate_file
+
+        devices = development_apn.devices + production_apn.devices
+
+        devices.each do |device|
+          device = ActsAsPushable::Device.find_by_token(device)
+          device.update_attribute('invalidated_at', Time.now) if device
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_pushable/apn/notification.rb

@@ -0,0 +1,38 @@
+require 'houston'
+
+module ActsAsPushable
+  module APN
+    class Notification
+      def self.send(device:, message:, **options)
+        development_apn = Houston::Client.development
+        production_apn = Houston::Client.production
+
+        development_apn.certificate = ActsAsPushable.configuration.apn_development_certificate_file
+        production_apn.certificate = ActsAsPushable.configuration.apn_production_certificate_file
+
+        payload = {
+          popup: options.fetch('popup', true),
+          popup_title: options.fetch('popup_title', nil),
+          popup_body: options.fetch('popup_body', nil),
+          popup_type: options.fetch('popup_type', 'alert'),
+          popup_ok_button_text: options.fetch('popup_ok_button_text', 'Ok'),
+          popup_cancel_button_text: options.fetch('popup_cancel_button_text', 'Cancel'),
+          navigate_to_view: options.fetch('navigate_to_view', nil),
+          navigate_to_view_as_modal: options.fetch('navigate_to_view_as_modal', true),
+          navigate_to_view_parameters: options.fetch('navigate_to_view_parameters', {}),
+        }
+
+        notification = Houston::Notification.new(device: device.token)
+        notification.alert = message
+        notification.badge = options.fetch('count', nil)
+        notification.custom_data = payload
+
+        if device.push_environment == 'development'
+          development_apn.push(notification)
+        else
+          production_apn.push(notification)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_pushable/configuration.rb

@@ -0,0 +1,18 @@
+module ActsAsPushable
+  class Configuration
+    attr_accessor :apn_development_certificate_path, :apn_production_certificate_path, :gcm_key
+
+    def initialize
+      self.apn_development_certificate_path = Rails.root.join('config', 'acts_as_pushable', 'apn', 'development.pem')
+      self.apn_production_certificate_path = Rails.root.join('config', 'acts_as_pushable', 'apn', 'production.pem')
+    end
+
+    def apn_development_certificate_file
+      File.read(apn_development_certificate_path)
+    end
+
+    def apn_production_certificate_file
+      File.read(apn_production_certificate_path)
+    end
+  end
+end

data/lib/acts_as_pushable/gcm/notification.rb

@@ -0,0 +1,35 @@
+require 'gcm'
+
+module ActsAsPushable
+  module GCM
+    class Notification
+      def self.send(device:, title:, message:, **options)
+        payload = {
+          popup: options.fetch("popup", true),
+          popup_title: options.fetch("popup_title", nil),
+          popup_body: options.fetch("popup_body", nil),
+          popup_type: options.fetch("popup_type", 'alert'),
+          popup_ok_button_text: options.fetch("popup_ok_button_text", 'Ok'),
+          popup_cancel_button_text: options.fetch("popup_cancel_button_text", 'Cancel'),
+          navigate_to_view: options.fetch("navigate_to_view", nil),
+          navigate_to_view_as_modal: options.fetch("navigate_to_view_as_modal", true),
+          navigate_to_view_parameters: options.fetch("navigate_to_view_parameters", {}),
+        }
+
+        gcm = ::GCM.new(ActsAsPushable.configuration.gcm_key)
+
+        gcm_options = {
+          data: {
+            title: title,
+            message: message,
+          }.merge(payload)
+        }
+
+        response = gcm.send([device.token], gcm_options)
+        if response[:not_registered_ids].include? device.token
+          device.update_attribute 'invalidated_at', Time.now
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_pushable/pushable.rb

@@ -0,0 +1,47 @@
+module ActsAsPushable
+  module Pushable
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    module ClassMethods
+      def acts_as_pushable(options = {})
+        has_many :devices, as: :parent, class_name: 'ActsAsPushable::Device'
+      end
+    end
+
+    def ios_devices
+      devices.where(platform: 'ios')
+    end
+
+    def android_devices
+      devices.where(platform: 'android')
+    end
+
+    def add_device(device_params)
+      device = build_device(device_params)
+      device.save
+    end
+
+    def add_device!(device_params)
+      device = build_device(device_params)
+      device.save!
+    end
+
+    def send_push_notification(title:, message:, **options)
+      devices.each do |device|
+        device.send_push_notification(title: title, message: message, **options)
+      end
+    end
+
+    private
+
+    def build_device(device_params)
+      self.devices.build(device_params)
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsPushable::Pushable

data/lib/acts_as_pushable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsPushable
+  VERSION = '0.1.1'
+end

data/lib/acts_as_pushable.rb

@@ -0,0 +1,30 @@
+require 'acts_as_pushable/version'
+require 'acts_as_pushable/configuration'
+
+require 'acts_as_pushable/active_record/device.rb'
+require 'acts_as_pushable/pushable'
+
+require 'acts_as_pushable/apn/notification'
+require 'acts_as_pushable/apn/feedback_service'
+require 'acts_as_pushable/gcm/notification'
+
+module ActsAsPushable
+  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 ||= ActsAsPushable::Configuration.new }
+    end
+  end
+end

data/lib/generators/acts_as_pushable/install_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/migration'
+
+module ActsAsPushable
+  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_pushable.rb"
+      end
+
+      def copy_migration_files
+        migration_template "migration/devices.rb", "db/migrate/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_pushable/templates/initializer.rb

@@ -0,0 +1,7 @@
+ActsAsPushable.configure do |config|
+  # Defaults
+  # config.apn_development_certificate_path = Rails.root.join('config', 'acts_as_pushable', 'apn', 'development.pem')
+  # config.apn_production_certificate_path = Rails.root.join('config', 'acts_as_pushable', 'apn', 'production.pem')
+
+  config.gcm_key = "replace_me_with_your_gcm_api_key"
+end

data/lib/generators/acts_as_pushable/templates/migration/devices.rb

@@ -0,0 +1,21 @@
+class Devices < 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

data/lib/tasks/acts_as_pushable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_pushable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_pushable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Adam Butler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: houston
+  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: gcm
+  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: sqlite3
+  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: rspec-rails
+  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: fuubar
+  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: timecop
+  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: pry
+  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: simplecov
+  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: A gem for Ruby on Rails that makes managing devices and push notifications
+  for both iOS and Android easy and reliable.
+email:
+- adam@simpleweb.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/acts_as_pushable.rb
+- lib/acts_as_pushable/active_record/device.rb
+- lib/acts_as_pushable/apn/feedback_service.rb
+- lib/acts_as_pushable/apn/notification.rb
+- lib/acts_as_pushable/configuration.rb
+- lib/acts_as_pushable/gcm/notification.rb
+- lib/acts_as_pushable/pushable.rb
+- lib/acts_as_pushable/version.rb
+- lib/generators/acts_as_pushable/install_generator.rb
+- lib/generators/acts_as_pushable/templates/initializer.rb
+- lib/generators/acts_as_pushable/templates/migration/devices.rb
+- lib/tasks/acts_as_pushable_tasks.rake
+homepage: https://github.com/simpleweb/acts_as_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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Add iOS & Android device and push notification support in your Rails application.
+test_files: []