spns 0.2.15 → 0.2.16

data/README.md

@@ -1,38 +1,39 @@
 spns
 =======
-Simple Push Notification Server written with Sinatra and Sequel(Sqlite3)
+###Simple Push Notification Server written with Ruby/Sinatra and Sequel(Sqlite3)###
 
 Feature:
 =======
 
-1.  rubygem, simple to install.
-2.  provide pem file is the only requirement.
-3.  no need to setup database, using sqlite3.
-4.  provide default config file(spns.yml) with default value.
+###1.  'spns' is a rubygem, simple to install.###
+###2.  only need to provide pem file.###
+###3.  no need to setup database(using sqlite3).###
+###4.  provide default config file(spns.yml) with default value.###
 
-Requirement
+Sqlite3 Installation
 =======
 
-Sqlite3
--------
-
 CentOS/Redhat:
+-------
 
     $ yum install sqlite3
 
 Debian/Ubuntu:
+-------
 
     $ apt-get install sqlite3
 
 FreeBSD:
+-------
 
     $ cd /usr/ports/databases/sqlite34
     $ sudo make install clean
 
 Mac:
+-------
 
-    $ brew install sqlite3 # Homebrew
-    $ port install sqlite3 # Macport
+    $ brew install sqlite # Homebrew
+    $ port install sqlite # Macport
 
 Installation
 =======
@@ -41,16 +42,64 @@ Installation
 	
 Usage
 =======
-1.  under the current directory, provide single pem file combined with certificate and key, HOWTO ([Check this link](http://www.raywenderlich.com/3443/apple-push-notification-services-tutorial-part-12))
+###1.  under the current directory, provide single pem file combined with certificate and key(name pattern: appid_mode.pem), HOWTO ([Check this link](http://www.raywenderlich.com/3443/apple-push-notification-services-tutorial-part-12))###
 
-2.  edit spns.yml. (when you run spns first time, it will generate this file) ([Check this link](https://raw.github.com/eiffelqiu/spns/master/spns.yml))
+###2.  edit spns.yml. (when you run spns first time, it will generate this file) ([Check this link](https://raw.github.com/eiffelqiu/spns/master/spns.yml))###
 
-3.  provide a cron script under current directory, default named "cron" according to spns.yml
+	port: 4567  ## SPNS server port, default is sinatra's port number: 4567
+	mode: development ## 'development' or 'production' mode, you should provide pem file ({appid}_{mode}.pem) accordingly(such as, app1_development.pem, app1_production.pem). 
+	cron: cron  ## cron job file name, SPNS server will generate a demo 'cron' file for demostration only in current directory.
+	timer: 0	# how often you run the cron job, unit: minute. when set with 0, means no cron job execute.
+	apps:
+	- app1 ## appid you want to supprt APNS, SPNS Server can give push notification support for many iOS apps, just list the appid here.
 
-4.  start spns server, default port is 4567(sinatra's default port)
+###3.  start spns server, default port is 4567(sinatra's default port)###
 
 ![spns usage](https://raw.github.com/eiffelqiu/spns/master/doc/capture1.png)
 
+
+FAQ:
+=======
+
+1.  How to register notification? (Client Side)
+-------
+
+###In AppDelegate file, add methods below to register device token###
+
+	- (void)application:(UIApplication*)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData*)deviceToken
+	{
+	    NSString * tokenAsString = [[[deviceToken description] 
+	                                 stringByTrimmingCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:@"<>"]] 
+	                                stringByReplacingOccurrencesOfString:@" " withString:@""];    
+	    NSString *urlAsString = [NSString stringWithFormat:@"http://serverIP:4567/v1/apps/app1/%@", token];
+	    NSURL *url = [NSURL URLWithString:urlAsString];
+	    NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:url]; 
+	    [urlRequest setTimeoutInterval:30.0f];
+	    [urlRequest setHTTPMethod:@"GET"];
+	    NSOperationQueue *queue = [[[NSOperationQueue alloc] init] autorelease];
+	    [NSURLConnection sendAsynchronousRequest:urlRequest queue:queue completionHandler:nil]; 
+	}
+
+	- (void)application:(UIApplication*)application didFailToRegisterForRemoteNotificationsWithError:(NSError*)error
+	{
+		NSLog(@"Failed to get token, error: %@", error);
+	}
+	
+2. How to send push notification? (Server Side)
+-------
+
+###run **curl** command to send push notification message, whatever shell.###
+
+	$ curl http://localhost:4567/v1/apps/app1/push/{message}/{pid}
+	
+###Note:###
+
+###param1 (message): push notification message you want to send, remember the message should be html escaped###
+
+###param2 (pid ): unique string to mark the message, for example current timestamp or md5/sha1 digest###
+
+
+
 Contributing to spns
 =======
  
@@ -65,5 +114,5 @@ Contributing to spns
 Copyright
 =======
 
-Copyright (c) 2012 Eiffel Qiu. See LICENSE.txt for further details.
+###Copyright (c) 2012 Eiffel Qiu. See LICENSE.txt for further details.###
 

data/VERSION

@@ -1 +1 @@
-0.2.15
+0.2.16

data/spns.yml

@@ -1,6 +1,6 @@
-port: 4567
+port: 54188
 mode: development
 cron: cron
-timer: 0	# minute
+timer: 0
 apps:
 - app1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spns
 version: !ruby/object:Gem::Version
-  version: 0.2.15
+  version: 0.2.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -314,7 +314,8 @@ files:
 - cron
 - lib/spns.rb
 - spns.yml
-- bin/spns
+- !binary |-
+  YmluL3NwbnM=
 homepage: http://github.com/eiffelqiu/spns
 licenses:
 - MIT
@@ -330,7 +331,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1342246939591537697
+      hash: 2005448441526104093
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -339,7 +340,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: spns
-rubygems_version: 1.8.24
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Simple Push Notification Server