crusade_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 667a327626f4b01ed39136f2f80d48d9adb43ee2
+  data.tar.gz: ee77ad2e8b097a26761baeb8b44cf9b93ba5f9b1
+SHA512:
+  metadata.gz: 3a05c52203dd4d1ddafbb7d8ecc04482deff5cae6eae91ae155f4214afcee1f8da5685418c86672b0967766c41d993500edabf940bcd5e851419d265187cdea7
+  data.tar.gz: 16f7b9c8411de096b05af79de79931e45edfe50b36a665d444e56f243fa121029ec4027f3735091f4007091f7514b1674dfa1f8a0cc23990cc82febd1726058a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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 @@
+= CrusadeRails
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,48 @@
+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    = 'CrusadeRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_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
+
+desc 'Print out all defined routes in match order, with names. Target specific controller with CONTROLLER=x.'
+task routes: :environment do
+  all_routes = CrusadeRails::Engine.routes.routes
+  require 'action_dispatch/routing/inspector'
+  inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+  puts inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, ENV['CONTROLLER'])
+end
+
+desc "Run the javascript specs"
+task :teaspoon => :environment do |t, args|
+  require "teaspoon/console"
+  files = ENV['files'].nil? ? [] : ENV['files'].split(',')
+  fail if Teaspoon::Console.new({suite: ENV["suite"], driver_cli_options: ENV["driver_cli_options"]}, files ).execute
+end
+
+task default: :test

data/app/assets/javascripts/crusade.js

@@ -0,0 +1,15 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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.
+//
+//= jquery
+//= require ./crusade_rails/configuration
+//= require_tree ./crusade_rails

data/app/assets/javascripts/crusade_rails/configuration.js.coffee.erb

@@ -0,0 +1,4 @@
+
+window.crusade =
+  pushId:        '<%= Rails.application.config.crusade.push_id %>'
+  webserviceUrl: '<%= Rails.application.config.crusade.webservice_url %>'

data/app/assets/javascripts/crusade_rails/crusade.js.coffee

@@ -0,0 +1,46 @@
+
+class @Crusade
+
+  requestPermission: (userId) ->
+    promise = $.Deferred((defer) =>
+      permission = currentPermission()
+
+      resolve(permission, defer, userId)
+
+    ).promise()
+
+    promise.granted = promise.done
+    promise.denied  = promise.fail
+
+    promise
+
+  checkPermission: ->
+    currentPermission()
+
+  currentPermission = ->
+    wrapPermission window.safari.pushNotification.permission(window.crusade.pushId)
+
+  wrapPermission = (safariPermission) ->
+    new NotificationPermission safariPermission
+
+  requestNewPemission = (userId) ->
+    $.Deferred((defer) =>
+      window.safari.pushNotification.requestPermission(
+        window.crusade.webserviceUrl
+        window.crusade.pushId
+        { userId: userId }
+        (safariPermission) =>
+          permission = wrapPermission safariPermission
+
+          resolve(permission, defer, userId)
+      )
+    ).promise()
+
+   resolve = (permission, defer, userId) ->
+      switch permission.permission
+        when 'granted' then defer.resolve(permission)
+        when 'denied'  then defer.reject(permission)
+        when 'default'
+          requestNewPemission(userId).
+            done((permission) -> defer.resolve(permission)).
+            fail((permission) -> defer.reject(permission))

data/app/assets/javascripts/crusade_rails/notification_permission.js.coffee

@@ -0,0 +1,13 @@
+class @NotificationPermission
+
+  constructor: (safariPermission) ->
+    safariPermission = defaultPermission() unless safariPermission
+
+    @permission  = safariPermission.permission
+    @deviceToken = safariPermission.deviceToken
+
+  isGranted: ->
+    @permission == "granted"
+
+  defaultPermission = ->
+    { permission: "default", deviceToken: null }

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/crusade_rails/apns/v1/log_controller.rb

@@ -0,0 +1,13 @@
+module CrusadeRails
+  module Apns
+    module V1
+      class LogController < CrusadeRails::ApplicationController
+        def create
+          Rails.logger.error JSON.pretty_generate json
+
+          render nothing: true, status: 204
+        end
+      end
+    end
+  end
+end

data/app/controllers/crusade_rails/apns/v1/push_package_controller.rb

@@ -0,0 +1,23 @@
+module CrusadeRails
+  module Apns
+    module V1
+      class PushPackageController < CrusadeRails::ApplicationController
+        skip_before_action :verify_authenticity_token
+
+        def create
+          generator = Crusade::APNS::PushPackageGenerator.new Rails.application.config.crusade
+          user_id = json['user']
+
+          Rails.logger.debug "requesting push package for user #{user_id}"
+          user_token, push_package = generator.generate(user_id)
+
+          Rails.logger.debug "registering push package #{user_id} - #{user_token}"
+          CrusadeRails::UserSubscriptionService.new.register user_id, user_token
+
+          Rails.logger.debug "Generation done. sending the file"
+          send_data File.read(push_package), type: 'application/zip'
+        end
+      end
+    end
+  end
+end

data/app/controllers/crusade_rails/apns/v1/subscription_controller.rb

@@ -0,0 +1,37 @@
+module CrusadeRails
+  module Apns
+    module V1
+      class SubscriptionController < CrusadeRails::ApplicationController
+        def create
+          Rails.logger.debug "registring push notification #{user_token} - #{device_token}"
+
+          user_service.subscribe user_token, device_token
+
+          render nothing: true, status: 200
+        end
+
+        def delete
+          Rails.logger.debug "unregistring push notification #{user_token} - #{device_token}"
+
+          user_service.unsubscribe user_token, device_token
+
+          render nothing: true, status: 200
+        end
+
+        private
+
+        def device_token
+          params[:device_token]
+        end
+
+        def user_token
+          request.headers['Authorization'].gsub 'ApplePushNotifications ', ''
+        end
+
+        def user_service
+          @service ||= CrusadeRails::UserSubscriptionService.new
+        end
+      end
+    end
+  end
+end

data/app/controllers/crusade_rails/application_controller.rb

@@ -0,0 +1,14 @@
+module CrusadeRails
+  class ApplicationController < ActionController::Base
+
+    protected
+
+    def body
+      request.body.read
+    end
+
+    def json
+      JSON.parse body
+    end
+  end
+end

data/app/helpers/crusade_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module CrusadeRails
+  module ApplicationHelper
+  end
+end

data/app/models/crusade_rails/user_subscription.rb

@@ -0,0 +1,4 @@
+module CrusadeRails
+  class UserSubscription < ActiveRecord::Base
+  end
+end

data/app/services/crusade_rails/notification_service.rb

@@ -0,0 +1,36 @@
+module CrusadeRails
+  class NotificationService
+    attr_reader :push_notification
+
+    def initialize push_notification = nil
+      push_notification = default_push_notification unless push_notification
+      self.push_notification = push_notification
+    end
+
+    def send_notification user_id, notification_attrs
+      subscription = UserSubscription.where(user_id: user_id).first
+
+      return unless subscription && subscription.active?
+
+      send build_notification(notification_attrs, subscription)
+    end
+
+    private
+
+    attr_writer :push_notification
+
+    def send notification
+      push_notification.send notification
+    end
+
+    def build_notification notification_attrs, subscription
+       Crusade::APNS::Notification.new notification_attrs.merge(
+          device_token: subscription.device_token
+        )
+    end
+
+    def default_push_notification
+      Crusade::APNS::PushNotification.new(Rails.application.config.crusade)
+    end
+  end
+end

data/app/services/crusade_rails/user_subscription_service.rb

@@ -0,0 +1,36 @@
+module CrusadeRails
+  class UserSubscriptionService
+    def register user_id, user_token
+      subscription = CrusadeRails::UserSubscription.new({
+        user_token: user_token,
+        user_id: user_id
+      })
+      subscription.save
+    end
+
+    def subscribe user_token, device_token
+      subscription = find_subscription_by_user_token user_token
+      subscription.update_attributes({
+        device_token: device_token,
+        active: true
+      })
+      subscription.save
+    end
+
+    def unsubscribe user_token, device_token
+      subscription = find_subscription_by_user_token user_token
+      subscription.update_attributes({
+        active: false
+      })
+      subscription.save
+    end
+
+    private
+
+    attr_accessor :user_id
+
+    def find_subscription_by_user_token(user_token)
+      CrusadeRails::UserSubscription.where(user_token: user_token).first
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>CrusadeRails</title>
+  <%= stylesheet_link_tag    "crusade_rails/application", media: "all" %>
+  <%= javascript_include_tag "crusade_rails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/teaspoon.rb

@@ -0,0 +1,65 @@
+Teaspoon.setup do |config|
+  require 'coffee_script'
+
+  # This determines where the Teaspoon routes will be mounted. Changing this to "/jasmine" would allow you to browse to
+  # http://localhost:3000/jasmine to run your specs.
+  config.mount_at = "/teaspoon"
+
+  # This defaults to Rails.root if left nil. If you're testing an engine using a dummy application it can be useful to
+  # set this to your engines root.. E.g. `Teaspoon::Engine.root`
+  config.root = CrusadeRails::Engine.root
+
+  # These paths are appended to the Rails assets paths (relative to config.root), and by default is an array that you
+  # can replace or add to.
+  config.asset_paths = ["test/javascripts", "test/javascripts/stylesheets"]
+
+  # Fixtures are rendered through a standard controller. This means you can use things like HAML or RABL/JBuilder, etc.
+  # to generate fixtures within this path.
+  config.fixture_path = "test/javascripts/fixtures"
+
+  # You can modify the default suite configuration and create new suites here. Suites can be isolated from one another.
+  # When defining a suite you can provide a name and a block. If the name is left blank, :default is assumed. You can
+  # omit various directives and the defaults will be used.
+  #
+  # To run a specific suite
+  #   - in the browser: http://localhost/teaspoon/[suite_name]
+  #   - from the command line: rake teaspoon suite=[suite_name]
+  config.suite do |suite|
+
+    # You can specify a file matcher and all matching files will be loaded when the suite is run. It's important that
+    # these files are serve-able from sprockets.
+    #
+    # Note: Can also be set to nil.
+    suite.matcher = "{test/javascripts,app/assets}/**/*.{js,js.coffee,coffee}"
+
+    # Each suite can load a different helper, which can in turn require additional files. This file is loaded before
+    # your specs are loaded, and can be used as a manifest.
+    suite.helper = "test_helper"
+
+    # These are the core Teaspoon javascripts. It's strongly encouraged to include only the base files here. You can
+    # require other support libraries in your spec helper, which allows you to change them without having to restart the
+    # server.
+    #
+    # Available frameworks: teaspoon-jasmine, teaspoon-mocha, teaspoon-qunit
+    #
+    # Note: To use the CoffeeScript source files use `"teaspoon/jasmine"` etc.
+    suite.javascripts = ["teaspoon-jasmine"]
+
+    # If you want to change how Teaspoon looks, or include your own stylesheets you can do that here. The default is the
+    # stylesheet for the HTML reporter.
+    suite.stylesheets = ["teaspoon"]
+
+    # When running coverage reports, you probably want to exclude libraries that you're not testing.
+    # Accepts an array of filenames or regular expressions. The default is to exclude assets from vendors or gems.
+    suite.no_coverage = [%r{/lib/ruby/gems/}, %r{/vendor/assets/}, %r{/support/}, %r{/(.+)_helper.}]
+    # suite.no_coverage << "jquery.min.js" # excludes jquery from coverage reports
+
+  end
+
+  # Example suite. Since we're just filtering to files already within the root test/javascripts, these files will also
+  # be run in the default suite -- but can be focused into a more specific suite.
+  #config.suite :targeted do |suite|
+  #  suite.matcher = "spec/javascripts/targeted/*_test.{js,js.coffee,coffee}"
+  #end
+
+end if defined?(Teaspoon) && Teaspoon.respond_to?(:setup) # let Teaspoon be undefined outside of development/test/asset groups

data/config/routes.rb

@@ -0,0 +1,15 @@
+CrusadeRails::Engine.routes.draw do
+  namespace "apns" do
+    namespace "v1" do
+      post "pushPackages/#{Rails.application.config.crusade.push_id}", 
+            to: "push_package#create", as: "apns_push_package"
+
+      post   "/devices/:device_token/registrations/#{Rails.application.config.crusade.push_id}",
+              to: "subscription#create", as: "apns_push_registration"
+      delete "/devices/:device_token/registrations/#{Rails.application.config.crusade.push_id}",
+              to: "subscription#delete", as: "apns_push_unregistration"
+
+      post "log", to: "log#create", as: "apns_log"
+    end
+  end
+end

data/db/migrate/20130917203302_create_crusade_rails_user_subscriptions.rb

@@ -0,0 +1,12 @@
+class CreateCrusadeRailsUserSubscriptions < ActiveRecord::Migration
+  def change
+    create_table :crusade_rails_user_subscriptions do |t|
+      t.integer :user_id
+      t.string  :user_token
+      t.string  :device_token
+      t.boolean :active
+
+      t.timestamps
+    end
+  end
+end

data/lib/crusade_rails/configuration_loader.rb

@@ -0,0 +1,33 @@
+require 'pathname'
+
+module CrusadeRails
+  def load_configuration!(configuration_file = default_configuration_file)
+    configuration = load_configuration_file configuration_file
+    configuration = preappend_absolute_path(configuration)
+    Rails.application.config.crusade = configuration
+    configuration
+  end
+
+  extend self
+
+  private
+
+  def load_configuration_file(config_file)
+    Crusade::APNS::Configuration.load config_file
+  end
+
+  def default_configuration_file
+    File.join Rails.root, "config", "crusade.yml"
+  end
+
+  def preappend_absolute_path(config)
+    config.iconset_dir = change_path config.iconset_dir
+    config.certificate = change_path config.certificate
+    config
+  end
+
+  def change_path(path)
+    pathname = Pathname.new path
+    pathname.absolute? ? path : File.join(Rails.root, path)
+  end
+end

data/lib/crusade_rails/engine.rb

@@ -0,0 +1,9 @@
+require 'crusade/apns'
+
+module CrusadeRails
+  class Engine < ::Rails::Engine
+    isolate_namespace CrusadeRails
+  end
+end
+
+require 'crusade_rails/configuration_loader'

data/lib/crusade_rails/version.rb

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

data/lib/crusade_rails.rb

@@ -0,0 +1,4 @@
+require "crusade_rails/engine"
+
+module CrusadeRails
+end

data/lib/generators/crusade/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Install crusade engine configuration & initializer files
+
+Example:
+    rails generate crusade:install
+
+    This will create:
+        config/initializers/crusade.rb
+        config/crusade.yml

data/lib/generators/crusade/install/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+class Crusade::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer_file
+    template "initializer.rb", File.join(destination_root, "config", "initializers", "crusade.rb")
+  end
+
+  def copy_configuration_file
+    template "configuration.yml", File.join(destination_root, "config", "crusade.yml")
+  end
+
+  def update_routes
+    route 'mount CrusadeRails::Engine, at: "/push"'
+  end
+end

data/lib/generators/crusade/install/templates/configuration.yml

@@ -0,0 +1,23 @@
+default: &default
+  site_name: Apns config fixture
+  push_id: web.com.example.push.id
+  iconset_dir: lib/icon.iconset
+  certificate: config/certificate.p12
+  certificate_password: test
+
+development:
+  <<: *default
+  url_format: http://www.example.com/push/%@
+  webservice_url: https://www.example.com/push
+  allowed_domains:
+    - http://www.example.com
+    - https://www.example.com
+
+test:
+  <<: *default
+  url_format: http://localhost/push/%@
+  webservice_url: https://localhost/push
+  allowed_domains:
+    - http://localhost
+    - https://localhost
+  certificate_password:

data/lib/generators/crusade/install/templates/initializer.rb

@@ -0,0 +1,2 @@
+
+CrusadeRails.load_configuration!

data/lib/tasks/crusade_rails_tasks.rake

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

data/test/controllers/apns/v1/log_controller_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+describe CrusadeRails::Apns::V1::LogController do
+
+  before { @routes = CrusadeRails::Engine.routes }
+
+  describe "create action" do
+    let(:error) { { error: 'something went wrong' } }
+    let(:pretty_error) { "{\n  \"logs\": {\n    \"error\": \"something went wrong\"\n  }\n}" }
+
+    before do
+      request.env['RAW_POST_DATA'] = { logs: error }.to_json
+      post :create, logs: error, :format => :json
+    end
+
+    it 'renders a 204 - no content' do
+      response.status.must_equal 204
+    end
+
+    it 'renders an empty body response' do
+      response.body.blank?.must_be_true
+    end
+
+    it 'logs the error via the rails logger' do
+      mock_logger = MiniTest::Mock.new
+      mock_logger.expect(:error, nil, [pretty_error])
+
+      Rails.stub(:logger, mock_logger) do
+        post :create, :format => :json
+      end
+
+      mock_logger.verify.must_be_truthy
+    end
+  end
+end

data/test/controllers/apns/v1/push_package_controller_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+describe CrusadeRails::Apns::V1::PushPackageController do
+
+  before { @routes = CrusadeRails::Engine.routes }
+
+  describe "create action" do
+    let(:temp_file) { '/tmp/text.txt' }
+    let(:user_id)   { 10 }
+    let(:user_token) { '123zz' }
+
+    let(:service) { stub_everything(:user_service) }
+
+    before do
+      File.stubs(:read).with(temp_file).returns('test data')
+
+      generator = stub :generator
+      generator.stubs(:generate).with(user_id).returns [user_token, temp_file]
+      Crusade::APNS::PushPackageGenerator.stubs(:new).returns generator
+
+      CrusadeRails::UserSubscriptionService.stubs(:new).returns(service)
+
+      request.env['RAW_POST_DATA'] = { user: user_id }.to_json
+
+      post :create, :format => :json
+    end
+
+    it { response.status.must_equal 200 }
+    it { response.content_type.must_equal 'application/zip' }
+
+    it 'send the push package zip file' do
+      response.body.must_equal 'test data'
+    end
+
+    it 'register the user_id push package request' do
+      service.expects(:register).with(user_id, user_token)
+
+      post :create, :format => :json
+    end
+  end
+end