rails-push-notifications 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0de203db302e805cb1ba91599cc359030a2bb27
-  data.tar.gz: e5904ff7a0ba379a794bc411fb47a5ed0438a1db
+  metadata.gz: 221e44ec52855989da2f9a2e67b70ddec144576b
+  data.tar.gz: 2cce49cbd19011f0f703f6a4199ce8f854a5cc08
 SHA512:
-  metadata.gz: 12c843c8178294da33778841bc849bdd47955c2657abd16f33876c3cdff13879652128a7609dcb9c6f270f0a42bce1da3ac29519a4d9c9169fd3b626f632d6a8
-  data.tar.gz: 8b539dcdca8a9242c952880a7f3da8776e9c7a5a257fddc75f6dd8d47745ce536b21b25aa0c7b1da587c1891ef4e2574a565dcab2ecb044986afff4702a77f1d
+  metadata.gz: 4e0c997bb94f8e50f79f6fe706793f7ecb5759e116c473c3f695a598a8ec609634441a1281bfed7ea8da911d3edf40ce9b0e3e4eb7b89cb3db51765ef77db0f2
+  data.tar.gz: ca6224bfb6e432604bed94d8fbe70c5bc69f07fa675cb583857e2fb314ac476cb479ce8e364313417786eac7a6e0e3bf0ee52d8aaea31b30c2dbcdd8b15090cd

data/README.md

@@ -1,14 +1,15 @@
 # Rpn (Ruby on Rails Push Notifications)
-[![Build Status](https://travis-ci.org/calonso/rails-push-notifications.svg)](https://travis-ci.org/calonso/rails-push-notifications) [![Code Climate](https://codeclimate.com/github/calonso/rails-push-notifications/badges/gpa.svg)](https://codeclimate.com/github/calonso/rails-push-notifications)[![Test Coverage](https://codeclimate.com/github/calonso/rails-push-notifications/badges/coverage.svg)](https://codeclimate.com/github/calonso/rails-push-notifications/coverage)
+[![Build Status](https://travis-ci.org/calonso/rails-push-notifications.svg)](https://travis-ci.org/calonso/rails-push-notifications) [![Code Climate](https://codeclimate.com/github/calonso/rails-push-notifications/badges/gpa.svg)](https://codeclimate.com/github/calonso/rails-push-notifications) [![Test Coverage](https://codeclimate.com/github/calonso/rails-push-notifications/badges/coverage.svg)](https://codeclimate.com/github/calonso/rails-push-notifications/coverage)
 ## Professional iOS, Android and Windows Phone push notifications for Ruby on Rails
 
-Rpn is an intuitive and easy to use gem that will allow you to easily add Push Notifications to your project.
+RailsPushNotifications is an intuitive and easy to use gem that will allow you to easily add Push Notifications to your project.
 
-Rpn supports:
+RailsPushNotifications key features:
 
 * Multiple Apple/Android/WinPhone applications/configurations
 * Single and Bulk notifications
 * Fully customizable notification's contents
+* Detailed feedback on each individual notification's push results.
 
 ## Live example
 
@@ -20,7 +21,7 @@ The source code for that project is here: [https://github.com/calonso/rails_push
 ## Installation
 To install the gem simply add this line to your Gemfile
 
-    gem 'rails-push-notifications', '~> 0.2'
+    gem 'rails-push-notifications', '~> 0.2.0'
 
 and then install it by running
 
@@ -136,7 +137,8 @@ any improvement/bug you may find.
 Please, feel free to contribute in building any of those or adding more stuff to this list!
 
 * Better generation of the data for each kind of notification. Hiding the particulars
-to avoid bugs
+to avoid bugs.
+* Rake task to push all notifications from all applications.
 
 ## Contributing
 

data/Rakefile

@@ -1,4 +1,7 @@
+require "rubygems"
+require "bundler/setup"
 require 'bundler'
+require 'appraisal'
 
 require 'rspec/core/rake_task'
 
@@ -6,3 +9,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default => :appraisal
+end
+

data/lib/generators/rails-push-notifications/USAGE

@@ -1,6 +1,6 @@
 Description:
-    Generate migrations needed to create RPN tables
+    Generate migrations needed to create RailsPushNotifications tables
 
 Example:
-    rails generate ror_push_notifications:migrations
+    rails generate rails_push_notifications:migrations
 

data/lib/rails-push-notifications/apps/apns_app.rb

@@ -1,22 +1,34 @@
 module RailsPushNotifications
+  #
+  # This class represents an Apple iOS application.
+  #
+  # @author Carlos Alonso
+  #
   class APNSApp < BaseApp
     self.table_name = 'rails_push_notifications_apns_apps'
 
+    # Requires a development certificate
     validates :apns_dev_cert, presence: true
+    # Requires a production certificate
     validates :apns_prod_cert, presence: true
 
     before_validation { |app| app.sandbox_mode = true if app.sandbox_mode.nil? }
 
     private
 
+    # @return [String] the certificate(dev or prod) to use
     def cert
       sandbox_mode ? apns_dev_cert : apns_prod_cert
     end
 
+    # @return [RubyPushNotifications::APNS::APNSPusher] configured and
+    #   ready to push
     def build_pusher
       RubyPushNotifications::APNS::APNSPusher.new cert, sandbox_mode
     end
 
+    # @return [RubyPushNotifications::APNS::APNSNotification]. The type of
+    #   notifications this app manages
     def notification_type
       RubyPushNotifications::APNS::APNSNotification
     end

data/lib/rails-push-notifications/apps/base_app.rb

@@ -1,10 +1,20 @@
 module RailsPushNotifications
+  #
+  # Abstract. This class is the base of all application entity type.
+  #
+  # @author Carlos Alonso
+  #
   class BaseApp < ActiveRecord::Base
 
     self.abstract_class = true
 
+    # has_many notifications
     has_many :notifications, as: :app
 
+    #
+    # This method will find all notifications owned by this app and
+    # push them.
+    #
     def push_notifications
       pending = find_pending
       to_send = pending.map do |notification|
@@ -19,6 +29,9 @@ module RailsPushNotifications
 
     protected
 
+    #
+    # Method that searches the owned notifications for those not yet sent
+    #
     def find_pending
       notifications.where sent: false
     end

data/lib/rails-push-notifications/apps/gcm_app.rb

@@ -1,15 +1,25 @@
 module RailsPushNotifications
+  #
+  # This class represents an Android GCM application.
+  #
+  # @author Carlos Alonso
+  #
   class GCMApp < BaseApp
     self.table_name = 'rails_push_notifications_gcm_apps'
 
+    # Requires a gcm_key
     validates :gcm_key, presence: true
 
     private
 
+    # @return [RubyPushNotifications::GCM::GCMPusher] configured and
+    #   ready to push
     def build_pusher
       RubyPushNotifications::GCM::GCMPusher.new gcm_key
     end
 
+    # @return [RubyPushNotifications::GCM::GCMNotification]. The type of
+    #   notifications this app manages
     def notification_type
       RubyPushNotifications::GCM::GCMNotification
     end

data/lib/rails-push-notifications/apps/mpns_app.rb

@@ -1,15 +1,25 @@
 module RailsPushNotifications
+  #
+  # This class represents an Windows Phone application.
+  #
+  # @author Carlos Alonso
+  #
   class MPNSApp < BaseApp
     self.table_name = 'rails_push_notifications_mpns_apps'
 
+    # Requires the certificate
     validates :cert, presence: true
 
     private
 
+    # @return [RubyPushNotifications::MPNS::MPNSPusher] configured and
+    #   ready to push
     def build_pusher
       RubyPushNotifications::MPNS::MPNSPusher.new cert
     end
 
+    # @return [RubyPushNotifications::MPNS::MPNSNotification]. The type of
+    #   notifications this app manages
     def notification_type
       RubyPushNotifications::MPNS::MPNSNotification
     end

data/lib/rails-push-notifications/notification.rb

@@ -1,23 +1,36 @@
 module RailsPushNotifications
+  #
+  # This class represents the Notification Entity.
+  #
+  # @author Carlos Alonso
+  #
   class Notification < ActiveRecord::Base
 
     self.table_name = 'rails_push_notifications_notifications'
 
+    # belongs_to an app
     belongs_to :app, polymorphic: true
 
+    # Requires an app
     validates :app, presence: true
+    # Requires data
     validates :data, presence: true
+    # Requires at least one destination
     validates :destinations, presence: true, length: { minimum: 1 }
 
     serialize :data, Hash
     serialize :destinations, Array
     serialize :results
 
+    # Automatically manages the sent flag, setting it to true as soon as
+    # it is assigned results.
     before_save do |record|
       record.sent = !record.results.nil?
       true
     end
 
+    # Automatically manages the success and failed fields, setting them to the
+    # value specified by the results assigned.
     before_save do |record|
       if record.results_changed? && record.results
         record.success = record.results.success

data/lib/rails-push-notifications/rails_push_notifications_railtie.rb

@@ -1,4 +1,9 @@
 module RailsPushNotifications
+  #
+  # This class exports the migrations generator to Rails
+  #
+  # @author Carlos Alonso
+  #
   class RailsPushNotificationsRailtie < Rails::Railtie
     generators do
       require 'generators/rails-push-notifications/migrations_generator'

data/lib/rails-push-notifications/version.rb

@@ -1,3 +1,3 @@
 module RailsPushNotifications
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/notification_spec.rb

@@ -40,6 +40,7 @@ module RailsPushNotifications
       it 'has to be a Hash' do
         expect do
           notification.data = 'dummy text'
+          notification.save
         end.to raise_error ActiveRecord::SerializationTypeMismatch
       end
     end
@@ -53,6 +54,7 @@ module RailsPushNotifications
       it 'has to be an array' do
         expect do
           notification.destinations = 'dummy destinations'
+          notification.save
         end.to raise_error ActiveRecord::SerializationTypeMismatch
       end
 

data/spec/rails_apps/rails3_2.rb

@@ -0,0 +1,47 @@
+require 'rails'
+require 'rails/all'
+require 'action_view/testing/resolvers'
+require 'rails/test_help'
+
+require 'rails-push-notifications'
+
+class RailsPushNotificationsApp < Rails::Application
+  config.root = File.expand_path("../../..", __FILE__)
+  config.cache_classes = true
+
+  config.eager_load = false
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.action_dispatch.show_exceptions = false
+
+  config.action_controller.allow_forgery_protection = false
+
+  config.active_support.deprecation = :stderr
+
+  config.middleware.delete "Rack::Lock"
+  config.middleware.delete "ActionDispatch::Flash"
+  config.middleware.delete "ActionDispatch::BestStandardsSupport"
+  config.secret_token = "49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk"
+  routes.append do
+    get "/" => "welcome#index"
+  end
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  layout 'application'
+  self.view_paths = [ActionView::FixtureResolver.new(
+    "layouts/application.html.erb" => '<%= yield %>',
+    "welcome/index.html.erb"=> 'Hello from index.html.erb',
+  )]
+
+  def index
+  end
+
+end
+
+RailsPushNotificationsApp.initialize!

data/spec/spec_helper.rb

@@ -4,24 +4,34 @@ CodeClimate::TestReporter.start
 
 Bundler.setup
 
+require 'rails'
+
 ENV['RAILS_ENV'] = 'test'
-ENV['DATABASE_URL'] = 'sqlite3::memory:'
 
-require 'rails_apps/rails4'
-require 'rspec/rails'
-Bundler.require :default, :development
+case "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}"
+when '3.2'
+  ENV['DATABASE_URL'] = 'sqlite3://localhost/:memory:'
+  require 'rails_apps/rails3_2'
+  require 'active_record/migration'
+when '4.0'
+  ENV['DATABASE_URL'] = 'sqlite3://localhost/:memory:'
+  require 'rails_apps/rails4'
+when '4.1', '4.2'
+  ENV['DATABASE_URL'] = 'sqlite3::memory:'
+  require 'rails_apps/rails4'
+else
+  raise NotImplementedError.new "Rails Friendly URLs gem doesn't support Rails #{Rails.version}"
+end
+
+Bundler.require :default
+Bundler.require :development
+
 require 'webmock/rspec'
+require 'rspec/rails'
 require 'ruby-push-notifications'
 
 Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
 
-require 'rails-push-notifications'
-
-ActiveRecord::Base.establish_connection(
- :adapter => 'sqlite3',
- :database => ':memory:'
-)
-
 files = Dir.glob(File.join(File.dirname(__FILE__), '..', 'lib', 'generators', 'rails-push-notifications', 'templates', 'migrations', '*.rb'))
 
 migrations = []
@@ -35,7 +45,13 @@ end
 
 migrations.sort_by(&:version)
 
-ActiveRecord::Migrator.new(:up, migrations).migrate
+migrator = ActiveRecord::Migrator.new(:up, migrations)
+
+if Rails::VERSION::MAJOR == 3
+  migrator.instance_variable_set(:@migrations, migrations)
+end
+
+migrator.migrate
 
 RSpec.configure do |config|
   config.use_transactional_fixtures = true

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rails-push-notifications
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Carlos Alonso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: ruby-push-notifications
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +153,7 @@ files:
 - spec/generators/migrations_generator_spec.rb
 - spec/log/test.log
 - spec/notification_spec.rb
+- spec/rails_apps/rails3_2.rb
 - spec/rails_apps/rails4.rb
 - spec/spec_helper.rb
 - spec/support/factory_girl.rb
@@ -190,6 +191,7 @@ test_files:
 - spec/generators/migrations_generator_spec.rb
 - spec/log/test.log
 - spec/notification_spec.rb
+- spec/rails_apps/rails3_2.rb
 - spec/rails_apps/rails4.rb
 - spec/spec_helper.rb
 - spec/support/factory_girl.rb