pushable-engine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f783392e8da04c06a3cf2010367d2195e5e4254c
+  data.tar.gz: d57ae0a99b17ee6d8a13a2475b93dd1af644e836
+SHA512:
+  metadata.gz: 6ae97afddbb464f47b9dfe6a70512c6615e526cb50773a834d2d2289b89dafab8b667c5330df8a43fc4934c641fce55ef3198bf968e3bb0df97df3ad0feb911f
+  data.tar.gz: c5c249919a83db077c8b309155655ad4485f961fbc49a920c672228185382f367be3fb9a17a976184b903b9484a21ba37b32d689a5ba6ac59dc2a4dff16dbcbc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Logan Serman
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Pushable
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,26 @@
+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    = 'Pushable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/pushable/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/pushable/consoles.js

@@ -0,0 +1,11 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+$(document).on('ready page:load', function() {
+  $('#console_push_klass').on('change', function() {
+    var klass = $(this).val();
+     $('.form-group[data-klass] input:not([type="hidden"])').val('');
+    $('.form-group[data-klass]').addClass('hide');
+    $('.form-group[data-klass="' + klass + '"]').removeClass('hide');
+  });
+});

data/app/assets/stylesheets/pushable/application.css

@@ -0,0 +1,25 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+* {
+  font-family: 'Helvetica', sans-serif;
+  font-size: 14px;
+}
+
+.alert {
+  margin: 20px 0 0 0 !important;
+  text-align: center;
+}

data/app/assets/stylesheets/pushable/consoles.css

@@ -0,0 +1,16 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+form.console {
+  margin-top: 20px;
+  padding: 20px;
+  background-color: #fafafa;
+  border: 1px solid #ccc;
+  border-radius: 5px;
+}
+
+.form-group[data-klass] input {
+  margin-bottom: 10px;
+}

data/app/controllers/concerns/pushable/controller.rb

@@ -0,0 +1,34 @@
+module Pushable
+  module Controller
+    extend ActiveSupport::Concern
+
+    def create
+      if @device = user_has_device_already?
+        update_token_expiration
+      else
+        @device = create_device_token
+      end
+      respond_with @device
+    end
+
+    private
+
+      def user_has_device_already?
+        current_user.devices.find_by token: params[:device][:token]
+      end
+
+      def update_token_expiration
+        @device.reset_token_expiry
+        @device.save
+      end
+
+      def create_device_token
+        current_user.devices.create permitted_params
+      end
+
+      def permitted_params
+        params.require(:device).permit :token, :platform
+      end
+
+  end
+end

data/app/controllers/pushable/consoles_controller.rb

@@ -0,0 +1,30 @@
+module Pushable
+  class ConsolesController < ::ActionController::Base
+    layout 'pushable/application'
+
+    def show
+      @push = Pushable::ConsolePush.new
+      @stubs = Pushable::Console.stubs
+      @klasses = @stubs.map(&:klass)
+    end
+
+    def push
+      @push = Pushable::ConsolePush.new permitted_params
+      if @push.valid? && @push.deliver
+        flash[:notice] = "Push delivered (sent to #{@push.sent_count} recipient(s))."
+      else
+        flash[:alert] = "Push failed! #{@push.errors.full_messages.to_sentence}."
+      end
+      show
+      render :show
+    end
+
+    private
+
+      def permitted_params
+        klass = params[:console_push][:klass]
+        params[:console_push].slice(:device_token, :klass).merge (params[:console_push][klass] || {})
+      end
+
+  end
+end

data/app/models/concerns/pushable/model.rb

@@ -0,0 +1,10 @@
+module Pushable
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :devices, class_name: 'Pushable::Device', as: :pushable
+    end
+
+  end
+end

data/app/models/pushable/console_push.rb

@@ -0,0 +1,50 @@
+module Pushable
+  class ConsolePush
+    include ActiveModel::Model
+
+    attr_accessor :device_token, :klass, :data, :sent_count
+
+    validates :klass, :device_token, presence: true
+
+    def initialize(attributes = {})
+      super
+      @sent_count = 0
+    end
+
+    def deliver
+      data.each do |name, info|
+        setter = "#{name}="
+        if message.respond_to?(setter)
+          value = info['value']
+          value = value.to_i if info['type'] == 'integer'
+          message.send setter, value
+        end
+      end
+
+      devices.each do |device|
+        if recipient = device.pushable
+          response = message.send_to recipient
+          self.sent_count += 1
+        end
+      end
+    end
+
+    private
+
+      def devices
+        @_devices ||= Pushable::Device.where(token: device_token)
+      end
+
+      def message
+        @_message ||= begin
+          _class = Class.new(klass.constantize) do
+            def initialize
+            end
+          end
+
+          _class.new
+        end
+      end
+
+  end
+end

data/app/models/pushable/device.rb

@@ -0,0 +1,40 @@
+module Pushable
+  class Device < ActiveRecord::Base
+    belongs_to :pushable, polymorphic: true
+
+    validates :token, presence: true, uniqueness: { scope: :pushable }
+    validates :platform, inclusion: { in: %w(ios android) }
+
+    before_save :reset_token_expiry
+
+    def reset_token_expiry
+      self.token_expires_at = Time.current + expire_token_in
+    end
+
+    def expire_token_in
+      14.days
+    end
+
+    def token_expired?
+      token_expires_at.nil? || token_expires_at.past?
+    end
+
+    def self.android
+      where(platform: 'android')
+    end
+
+    def self.ios
+      where(platform: 'ios')
+    end
+
+    def self.owned_by(pushable)
+      klass = pushable.klass.name
+      table = pushable.table.name
+      joins("JOIN #{table} ON #{table}.id = pushable_devices.pushable_id").
+        where(pushable_type: klass).
+        merge(pushable).
+        uniq
+    end
+
+  end
+end

data/app/models/pushable/message.rb

@@ -0,0 +1,50 @@
+module Pushable
+  class Message
+    MAX_TOKENS_AT_ONCE = 999
+
+    def send_to(pushable)
+      if pushable.is_a? ActiveRecord::Relation
+        enqueue Device.android.owned_by(pushable), format(:android)
+        enqueue Device.ios.owned_by(pushable), format(:ios)
+      elsif pushable.is_a?(ActiveRecord::Base)
+        enqueue pushable.devices.android, format(:android)
+        enqueue pushable.devices.ios, format(:ios)
+      else
+        raise ArgumentError.new('#send_to only accepts an ActiveRecord Relation or ActiveRecord object!')
+      end
+    end
+
+    def enqueue(devices, payload)
+      devices.pluck(:id).each_slice(MAX_TOKENS_AT_ONCE) do |tokens|
+        Pushable::Messenger.perform_later tokens, payload.deep_stringify_keys
+      end
+    end
+
+    def alert
+      ''
+    end
+
+    def badge
+      1
+    end
+
+    def sound
+      'default'
+    end
+
+    def other
+      {}
+    end
+
+    private
+
+      def format(platform)
+        if platform == :ios
+          { alert: alert, badge: badge, sound: sound, other: other }
+        elsif platform == :android
+          { alert: alert }.merge(data: other)
+        end
+      end
+
+  end
+end

data/app/models/pushable/messenger.rb

@@ -0,0 +1,24 @@
+module Pushable
+  class Messenger < ActiveJob::Base
+
+    def perform(device_ids, payload)
+      send_gcm  Device.android.where(id: device_ids).pluck(:token), payload
+      send_apns Device.ios.where(id: device_ids).pluck(:token), payload
+    end
+
+    def send_gcm(tokens, payload)
+      return unless tokens.any?
+      service = GCM::Service.new
+      notification = GCM::Notification.new(payload)
+      service.deliver notification, tokens
+    end
+
+    def send_apns(tokens, payload)
+      return unless tokens.any?
+      service = APNS::Service.new
+      notification = APNS::Notification.new(payload)
+      service.deliver notification, tokens
+    end
+
+  end
+end

data/app/views/layouts/pushable/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Pushable</title>
+  <%= stylesheet_link_tag    "//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css" %>
+  <%= stylesheet_link_tag    "pushable/application", media: "all" %>
+  <%= javascript_include_tag "//code.jquery.com/jquery-2.1.3.min.js" %>
+  <%= javascript_include_tag "pushable/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/pushable/consoles/show.html.erb

@@ -0,0 +1,26 @@
+<div class="container">
+  <% flash.each do |k, v| %>
+    <% klass = { notice: 'success', alert: 'danger' }.fetch(k.intern, 'info') %>
+    <div class="alert alert-<%= klass %>" role="alert"><%= v %></div>
+  <% end %>
+  <%= form_for @push, url: push_path, html: { class: 'console form col-md-6 col-md-offset-3' } do |f| %>
+    <div class="form-group">
+      <%= f.label :device_token %>
+      <%= f.text_field :device_token, class: 'form-control' %>
+    </div>
+    <div class="form-group">
+      <%= f.label :klass, 'Message' %>
+      <%= f.select :klass, ['', @klasses].flatten, {}, class: 'form-control' %>
+    </div>
+    <% @stubs.each do |stub| %>
+      <div class="form-group hide" data-klass="<%= stub.klass %>">
+        <%= f.label :data %>
+        <% stub.fields.each do |field, type| %>
+          <%= text_field_tag "console_push[#{stub.klass}][data][#{field}][value]", nil, placeholder: field, class: 'form-control' %>
+          <%= hidden_field_tag "console_push[#{stub.klass}][data][#{field}][type]", type.to_s %>
+        <% end %>
+      </div>
+    <% end %>
+    <%= f.submit 'Push', class: 'btn btn-primary' %>
+  <% end %>
+</div>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Pushable::Engine.routes.draw do
+  post 'consoles/push', to: 'consoles#push', as: :push
+  root to: 'consoles#show'
+end

data/db/migrate/20150302191320_create_pushable_devices.rb

@@ -0,0 +1,12 @@
+class CreatePushableDevices < ActiveRecord::Migration
+  def change
+    create_table :pushable_devices do |t|
+      t.string :token
+      t.string :platform
+      t.references :pushable, polymorphic: true, index: true
+      t.datetime :token_expires_at
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/pushable/console.rb

@@ -0,0 +1,17 @@
+module Pushable
+  class Console
+
+    def self.stubs
+      @@stubs ||= []
+    end
+
+    def self.<<(stub)
+      stubs << stub
+    end
+
+    def self.reset
+      @@stubs = []
+    end
+
+  end
+end

data/lib/pushable/engine.rb

@@ -0,0 +1,9 @@
+module Pushable
+  class Engine < ::Rails::Engine
+    isolate_namespace Pushable
+
+    require 'responders'
+    require 'mercurius'
+
+  end
+end

data/lib/pushable/stub.rb

@@ -0,0 +1,20 @@
+module Pushable
+  class Stub
+    attr_reader :klass, :fields
+
+    def initialize(klass, fields = {})
+      @klass = klass
+      @fields = fields
+      validate
+    end
+
+    private
+
+      def validate
+        fields.each do |k, v|
+          raise ArgumentError.new("Field types must be in: [:string, :integer]") if ![:string, :integer].include?(v)
+        end
+      end
+
+  end
+end

data/lib/pushable/version.rb

@@ -0,0 +1,3 @@
+module Pushable
+  VERSION = "0.0.1"
+end

data/lib/pushable-engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+require 'pushable/engine'
+require 'pushable/console'
+require 'pushable/stub'
+
+module Pushable
+end

data/lib/tasks/pushable_tasks.rake

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

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: pushable-engine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Logan Serman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mercurius
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.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: capybara
+  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: capybara-webkit
+  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: launchy
+  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: Rails engine to manage device tokens and push messaging.
+email:
+- logan.serman@metova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/assets/javascripts/pushable/application.js
+- app/assets/javascripts/pushable/consoles.js
+- app/assets/stylesheets/pushable/application.css
+- app/assets/stylesheets/pushable/consoles.css
+- app/controllers/concerns/pushable/controller.rb
+- app/controllers/pushable/consoles_controller.rb
+- app/models/concerns/pushable/model.rb
+- app/models/pushable/console_push.rb
+- app/models/pushable/device.rb
+- app/models/pushable/message.rb
+- app/models/pushable/messenger.rb
+- app/views/layouts/pushable/application.html.erb
+- app/views/pushable/consoles/show.html.erb
+- config/routes.rb
+- db/migrate/20150302191320_create_pushable_devices.rb
+- lib/pushable-engine.rb
+- lib/pushable/console.rb
+- lib/pushable/engine.rb
+- lib/pushable/stub.rb
+- lib/pushable/version.rb
+- lib/tasks/pushable_tasks.rake
+homepage: https://github.com/lserman/pushable-engine
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rails engine to manage device tokens and push messaging.
+test_files: []
+has_rdoc: