ass 0.0.2 → 0.0.9

data/README.md

@@ -1,21 +1,18 @@
 ass
 =======
-Apple Service Server written with Sinatra and Sequel(Sqlite3) with apple push notification and in app purchase support.
+####Apple Service Server was written with Ruby/Sinatra and Sequel(Sqlite3), it provides push notification and in app purchase service.####
 
 Feature:
 =======
 
-1.  rubygem, simple to install.
-2.  provide pem file is the only requirement.
-3.  no need to setup database, using sqlite3.
+1.  'ass' 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(ass.yml) with default value.
 
-Requirement
+Sqlite3 Installation
 =======
 
-Sqlite3
--------
-
 CentOS/Redhat:
 
     $ yum install sqlite3
@@ -31,8 +28,8 @@ FreeBSD:
 
 Mac:
 
-    $ brew install sqlite3 # Homebrew
-    $ port install sqlite3 # Macport
+    $ brew install sqlite # Homebrew
+    $ port install sqlite # Macport
 
 Installation
 =======
@@ -41,16 +38,87 @@ 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))
 
-2.  edit ass.yml. (when you run ass first time, it will generate this file) ([Check this link](https://raw.github.com/eiffelqiu/ass/master/ass.yml))
+Prepare pem file:
+
+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))
+
+	cert.pem:
+		openssl x509 -in aps_development.cer -inform der -out cert.pem
+
+	key.pem:
+		$ openssl pkcs12 -nocerts -in key.p12 -out key.pem
+		$ Enter Import Password: 
+		$ MAC verified OK
+		$ Enter PEM pass phrase: 
+		$ Verifying - Enter PEM pass phrase: 
+
+	Development Profile:
+		cat cert.pem key.pem > appid_development.pem
+
+	Distribution Profile:
+		cat cert.pem key.pem > appid_production.pem
 
-3.  provide a cron script under current directory, default named "cron" according to ass.yml
 
-4.  start ass server, default port is 4567(sinatra's default port)
+* start ass server, default port is 4567 (sinatra's default port)
 
 ![ass usage](https://raw.github.com/eiffelqiu/ass/master/doc/capture1.png)
 
+Configuration (ass.yml)
+=======
+
+when you run 'ass' first time, it will generate 'ass.yml' config file under current directory. ([Check this link](https://raw.github.com/eiffelqiu/ass/master/ass.yml))
+	
+	port: 4567  ## ASS 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, ASS server will generate a demo 'cron' file for demostration only under 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, ASS Server can give push notification support for many iOS apps, just list the appid here.
+
+
+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 ass
 =======
  
@@ -65,5 +133,5 @@ Contributing to ass
 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.0.2
+0.0.9

data/ass.yml

@@ -1,11 +1,6 @@
 port: 4567
 mode: development
 cron: cron
-timer: 0	# minute
-development:
-    - certificate   : ck_dev.pem
-production:
-    - certificate   : ck_prod.pem
+timer: 0
 apps:
 - app1
-- app2

data/lib/ass.rb

@@ -15,20 +15,20 @@ require 'yaml'
 ############################################################
 ## Initilization Setup
 ############################################################
-lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
-root_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-unless $LOAD_PATH.include?(lib_dir)
-  $LOAD_PATH << lib_dir
+LIBDIR = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+ROOTDIR = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+unless $LOAD_PATH.include?(LIBDIR)
+  $LOAD_PATH << LIBDIR
 end
 
 unless File.exist?("#{Dir.pwd}/ass.yml") then
   puts 'create config file: ass.yml'
-  system "cp #{root_dir}/ass.yml #{Dir.pwd}/ass.yml"
+  system "cp #{ROOTDIR}/ass.yml #{Dir.pwd}/ass.yml"
 end
 
 unless File.exist?("#{Dir.pwd}/cron") then
   puts "create a demo 'cron' script"
-  system "cp #{root_dir}/cron #{Dir.pwd}/cron"
+  system "cp #{ROOTDIR}/cron #{Dir.pwd}/cron"
 end
 
 ############################################################
@@ -36,21 +36,37 @@ end
 ############################################################
 env = ENV['SINATRA_ENV'] || "development"
 config = YAML.load_file("#{Dir.pwd}/ass.yml")
-$timer = config['timer'] || 1
+$timer = "#{config['timer']}".to_i
 $cron = config['cron'] || 'cron'
 $port = config['port'] || 4567
 $mode = config['mode'] || env
-$certificate = config["#{$mode}"][0]['certificate'] || 'ck.pem'
-ROOTDIR = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-VERSION = File.open("#{ROOTDIR}/VERSION", "rb").read
+$VERSION = File.open("#{ROOTDIR}/VERSION", "rb").read
 $apps = config['apps'] || []
 
 ############################################################
 ## Certificate Key Setup
 ############################################################
 
-unless File.exist?("#{Dir.pwd}/#{$certificate}") then
-  puts "1: please provide certificate key pem file under current directory"
+$certkey = {}
+def check_cert
+  $apps.each { |app|
+    unless File.exist?("#{Dir.pwd}/#{app}_#{$mode}.pem") then
+      puts "Please provide #{app}_#{$mode}.pem under '#{Dir.pwd}/' directory"
+      return false;
+    else
+      puts "'#{app}'s #{$mode} PEM: (#{app}_#{$mode}.pem)"
+      certfile = File.read("#{Dir.pwd}/#{app}_#{$mode}.pem")
+      openSSLContext = OpenSSL::SSL::SSLContext.new
+      openSSLContext.cert = OpenSSL::X509::Certificate.new(certfile)
+      openSSLContext.key = OpenSSL::PKey::RSA.new(certfile)   
+      $certkey["#{app}"] = openSSLContext       
+    end
+  }  
+  return true
+end
+
+unless check_cert then
+  puts "1: please provide certificate key pem file under current directory, name should be: appid_dev.pem for development and appid_prod.pem for production"
   puts "2: edit your ass.yml under current directory"
   puts "3: run ass"
   puts "4: iOS Client: in AppDelegate file, didRegisterForRemoteNotificationsWithDeviceToken method should access url below:"
@@ -61,91 +77,103 @@ unless File.exist?("#{Dir.pwd}/#{$certificate}") then
   exit
 else
   puts "*"*80
-  puts "Simple Push Notification Server is Running (#{VERSION}) ..."
+  puts "Apple Service Server(#{$VERSION}) is Running ..."
+  puts "Push Notification Service: Enabled"
   puts "Mode: #{$mode}"
   puts "Port: #{$port}"
-  puts "Certificate File: '#{Dir.pwd}/#{$certificate}'"
-  puts "Cron Job: '#{Dir.pwd}/#{$cron}' script is running every #{$timer} #{($timer == 1) ? 'minute' : 'minutes'} " unless "#{$timer}".squeeze.strip == "0"
+  puts "Cron Job: '#{Dir.pwd}/#{$cron}' script is running every #{$timer} #{($timer == 1) ? 'minute' : 'minutes'} " unless "#{$timer}".to_i == 0
   puts "*"*80
 end
 
-$cert = File.read("#{Dir.pwd}/#{$certificate}")
-$openSSLContext = OpenSSL::SSL::SSLContext.new
-$openSSLContext.cert = OpenSSL::X509::Certificate.new($cert)
-$openSSLContext.key = OpenSSL::PKey::RSA.new($cert)
-
 ############################################################
 ## Sequel Database Setup
 ############################################################
 
-DB = nil;
-
-unless File.exist?("#{Dir.pwd}/push.db") then
-  DB = Sequel.connect("sqlite://#{Dir.pwd}/push.db")
+unless File.exist?("#{Dir.pwd}/ass.db") then
+  $DB = Sequel.connect("sqlite://#{Dir.pwd}/ass.db")
 
-  DB.create_table :tokens do
+  $DB.create_table :tokens do
     primary_key :id
-    String :app, :unique => true, :null => false
+    String :app, :unique => false, :null => false
     String :token, :unique => true, :null => false, :size => 100
     index [:app, :token]
   end
 
-  DB.create_table :pushes do
+  $DB.create_table :pushes do
     primary_key :id
     String :pid, :unique => true, :null => false, :size => 100
     index :pid
   end
 else
-  DB = Sequel.connect("sqlite://#{Dir.pwd}/push.db")
+  $DB = Sequel.connect("sqlite://#{Dir.pwd}/ass.db")
 end
 
-Token = DB[:tokens]
-Push = DB[:pushes]
+Token = $DB[:tokens]
+Push = $DB[:pushes]
 
 ############################################################
 ## Timer Job Setup
 ############################################################
 scheduler = Rufus::Scheduler.start_new
 
-unless "#{$timer}".squeeze.strip == "0"
+unless $timer == 0 then
   scheduler.every "#{$timer}m" do
     puts "running job: '#{Dir.pwd}/#{$cron}' every #{$timer} #{($timer == 1) ? 'minute' : 'minutes'}"
     system "./#{$cron}"
   end
 else
+  puts "1: How to register notification? (Client Side)"
   puts
-  puts "*"*80
-  puts "How to register notification?"
-  puts
-  puts "iOS Client: in AppDelegate file, didRegisterForRemoteNotificationsWithDeviceToken method should access url below:"
+  puts "In AppDelegate file, inside didRegisterForRemoteNotificationsWithDeviceToken method access url below to register device token:"
   $apps.each { |app|
     puts "'#{app}'s registration url:  http://serverIP:#{$port}/v1/apps/#{app}/DeviceToken"
   }
   puts
-  puts "How to send push notification?"
+  puts "2: How to send push notification? (Server Side)"
   puts
   $apps.each { |app|
     puts "curl http://localhost:#{$port}/v1/apps/#{app}/push/{message}/{pid}"
   }
   puts
   puts "Note:"
-  puts "message: notification message you want to send, remember the message should be html escaped"
-  puts "pid: unique id that you mark the message, for example current timestamp"
+  puts "param1 (message): push notification message you want to send, remember the message should be html escaped"
+  puts "param2 (pid    ): unique string to mark the message, for example current timestamp or md5/sha1 digest"
   puts
   puts "*"*80
-  puts
 end
 
 ############################################################
-## Simple Push Notification Server based on Sinatra
+## Apple Service Server based on Sinatra
 ############################################################
 
 class App < Sinatra::Base
 
   set :port, "#{$port}".to_i
+  
+  if "#{$mode}".strip == 'development' then
+    set :show_exceptions, true
+    set :dump_errors, true
+  else
+    set :show_exceptions, false
+    set :dump_errors, false      
+  end
 
   get '/' do
-    puts "Simple Push Notification Server"
+    o = "Apple Service Server #{$VERSION} <br/><br/>" + 
+    "author: Eiffel(Q) <br/>email: eiffelqiu@gmail.com<br/><br/>"
+    o += "1: How to register notification? (Client Side)<br/><br/>"
+    o += "In AppDelegate file, inside didRegisterForRemoteNotificationsWithDeviceToken method access url below to register device token:<br/><br/>"
+    $apps.each { |app|
+      o += "'#{app}':  http://serverIP:#{$port}/v1/apps/#{app}/DeviceToken<br/>"
+    }
+    o += "<br/>2: How to send push notification? (Server Side)<br/><br/>"
+    $apps.each { |app|
+      o += "curl http://localhost:#{$port}/v1/apps/#{app}/push/{message}/{pid}<br/>"
+    }
+    o +=  "<br/>Note:<br/>"
+    o +=  "param1 (message): push notification message you want to send, remember the message should be html escaped<br/>"
+    o +=  "param2 (pid    ): unique string to mark the message, for example current timestamp or md5/sha1 digest<br/>"  
+    o
   end
 
   $apps.each { |app|
@@ -170,6 +198,7 @@ class App < Sinatra::Base
       @exist = Push.first(:pid => pid)
 
       unless @exist
+        openSSLContext = $certkey["#{app}"]
         # Connect to port 2195 on the server.
         sock = nil
         if $mode == 'production' then
@@ -178,7 +207,7 @@ class App < Sinatra::Base
           sock = TCPSocket.new('gateway.sandbox.push.apple.com', 2195)
         end
         # do our SSL handshaking
-        sslSocket = OpenSSL::SSL::SSLSocket.new(sock, $openSSLContext)
+        sslSocket = OpenSSL::SSL::SSLSocket.new(sock, openSSLContext)
         sslSocket.connect
         #Push.create( :pid => pid )
         Push.insert(:pid => pid)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ass
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +187,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -251,7 +299,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.2.8
-description: Simple Push Notification Server written with Sinatra and Sequel(Sqlite3)
+description: Apple Service Server written with Sinatra and Sequel(Sqlite3)
 email: eiffelqiu@gmail.com
 executables:
 - ass
@@ -283,7 +331,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3175766109456070451
+      hash: -54990434379922484
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -295,5 +343,5 @@ rubyforge_project: ass
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Simple Push Notification Server
+summary: Apple Service Server
 test_files: []