push-core 0.0.1.pre → 0.0.1.pre2

data/README.md

@@ -1,3 +1,88 @@
 # Push
 
-This project rocks and uses MIT-LICENSE.
+## Installation
+
+Add to your `GemFile`
+
+    gem push-core
+
+and add the push provider to you Gemfile:
+
+For __APNS__ (iOS: Apple Push Notification Services):
+
+    gem push-apns
+    
+For __C2DM__ (Android: Cloud to Device Messaging):
+
+    gem push-c2dm
+
+And run `bundle install` to install the gems.
+
+To generate the migration and the configuration files run:
+
+    rails g push
+    bundle exec rake db:migrate
+
+## Configuration
+A default configuration file looks like this:
+```ruby
+Push::Daemon::Builder.new do
+  daemon({ :poll => 2, :pid_file => "tmp/pids/push.pid", :airbrake_notify => false })
+
+  provider :apns,
+  {
+    :certificate => "production.pem",
+    :certificate_password => "",
+    :sandbox => false,
+    :connections => 3,
+    :feedback_poll => 60
+  }
+
+  provider :c2dm,
+  {
+    :connections => 2,
+    :email => "",
+    :password => ""
+  }
+end
+```
+Remove the provider you're not using. Add your email and password to enable C2DM. For APNS follow the 'Generating Certificates' below.
+
+
+### Generating Certificates
+
+1. Open up Keychain Access and select the `Certificates` category in the sidebar.
+2. Expand the disclosure arrow next to the iOS Push Services certificate you want to export.
+3. Select both the certificate and private key.
+4. Right click and select `Export 2 items...`.
+5. Save the file as `cert.p12`, make sure the File Format is `Personal Information Exchange (p12)`.
+6. If you decide to set a password for your exported certificate, please read the Configuration section below.
+7. Convert the certificate to a .pem, where `<environment>` should be `development` or `production`, depending on the certificate you exported.
+
+    `openssl pkcs12 -nodes -clcerts -in cert.p12 -out <environment>.pem`
+      
+8. Move the .pem file into your Rails application under `config/push`.
+
+
+## Daemon
+
+To start the daemon:
+
+    bundle exec push <environment> <options>
+    
+Where `<environment>` is your Rails environment and `<options>` can be `--foreground`, `--version` or `--help`.
+
+## Sending notifications
+APNS:
+```ruby
+Push::MessageApns.new(device: "<APNS device_token here>", alert: 'Hello World', expiry: 1.day.to_i, attributes_for_device: {key: 'MSG'}).save
+```
+C2DM:
+```ruby
+Push::MessageC2dm.new(device: "<C2DM registration_id here>", payload: { message: "Hello World" }, collapse_key: "MSG").save
+```
+
+## Thanks
+
+This project started as a fork of Ian Leitch [RAPNS](https://github.com/ileitch/rapns) project. The differences between this project and RAPNS is the support for C2DM and the modularity of the push providers.
+    

data/lib/push-core.rb

@@ -0,0 +1 @@
+require 'push/railtie' if defined?(Rails)

data/lib/push/daemon/feeder.rb

@@ -29,7 +29,7 @@ module Push
         begin
           with_database_reconnect_and_retry(name) do
             if Push::Daemon.delivery_queue.notifications_processed?
-              Push::Message.ready_for_delivery.each do |notification|
+              Push::Message.ready_for_delivery.find_each do |notification|
                 Push::Daemon.delivery_queue.push(notification)
               end
             end

data/lib/push/daemon/logger.rb

@@ -3,8 +3,9 @@ module Push
     class Logger
       def initialize(options)
         @options = options
-        log_path = File.join(Rails.root, 'log', 'push.log')
-        @logger = ActiveSupport::BufferedLogger.new(log_path, Rails.logger.level)
+        log_file = File.open(File.join(Rails.root, 'log', 'push.log'), 'w')
+        log_file.sync = true
+        @logger = ActiveSupport::BufferedLogger.new(log_file, Rails.logger.level)
         @logger.auto_flushing = Rails.logger.respond_to?(:auto_flushing) ? Rails.logger.auto_flushing : true
       end
 

data/lib/push/railtie.rb

@@ -0,0 +1,11 @@
+require 'push'
+require 'rails'
+module Push
+  class Railtie < Rails::Railtie
+    railtie_name :push
+
+    rake_tasks do
+      load 'tasks/push_tasks.rake'
+    end
+  end
+end

data/lib/push/version.rb

@@ -1,3 +1,3 @@
 module Push
-  VERSION = "0.0.1.pre"
+  VERSION = "0.0.1.pre2"
 end

data/lib/tasks/push_tasks.rake

@@ -0,0 +1,11 @@
+# Push Rake Tasks
+namespace :push do
+  desc "Delete all push messages and feedback older than 7 days or DAYS=x if defined (where x is an integer)"
+  task :clean => :environment do
+    days = ENV["DAYS"].to_i || 7
+    puts "Removing #{days} days of push messages and feedback"
+    feedback = Push::Feedback.where("created_at < ?", days.days.ago).delete_all
+    messages = Push::Message.where("created_at < ?", days.days.ago).delete_all
+    puts "Done, messages=#{messages} feedback=#{feedback}"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: push-core
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.1.pre2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-15 00:00:00.000000000 Z
+date: 2012-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70154092596240 !ruby/object:Gem::Requirement
+  requirement: &70357910508440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70154092596240
+  version_requirements: *70357910508440
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70154092595780 !ruby/object:Gem::Requirement
+  requirement: &70357910506440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70154092595780
+  version_requirements: *70357910506440
 description: Push daemon for push notification services like APNS and C2DM.
 email:
 - tom@tnux.net
@@ -46,6 +46,7 @@ files:
 - lib/generators/templates/development.rb
 - lib/generators/templates/production.rb
 - lib/generators/templates/staging.rb
+- lib/push-core.rb
 - lib/push.rb
 - lib/push/daemon.rb
 - lib/push/daemon/builder.rb
@@ -62,7 +63,9 @@ files:
 - lib/push/daemon/pool.rb
 - lib/push/feedback.rb
 - lib/push/message.rb
+- lib/push/railtie.rb
 - lib/push/version.rb
+- lib/tasks/push_tasks.rake
 - README.md
 - MIT-LICENSE
 - bin/push