handy_apn 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e01a9c1ab9a2c9d7d5d1c3b48c6ae08a9adcdde
-  data.tar.gz: e77a6a449c25ce239f71744fbffe2a1f9ab690f2
+  metadata.gz: cb19442dc04a53bac67cae07ba2d52fbef8ffd0f
+  data.tar.gz: 344d067ee973b39b894f16aa536ba3c27c462501
 SHA512:
-  metadata.gz: 4067f2d2d0d3ad5c6d9cb56e53621d16c046407d86a365bae823453f0d644ea2cfc3c14820284a2bad34980683dbb4973f0a84ab4772ebe0842329ae568f9cae
-  data.tar.gz: f1a0c08576572c0578dff02c6b86cdf01eaeb553e460264fc532b54e66919884dc4c4ff3940b96a92aca6294dd2a176b55fb9b77b8f4efd4e07ad733e2e483ee
+  metadata.gz: 6f89a39b01053e293c6855fc6c016a29d507793ae2c9561bb593e5e522f50120279a0e6c1ecf3a64333497a900cffefb78970ccc32bc2c21e0da43dd73911a23
+  data.tar.gz: c6202cecd97ad5bdbb7a07048d4854cc47fc50c9f63c348d6d250dca6fb9d0bd35933f9d4c9b752d79357f35cd628143d733bc68ccebae4e2e1e6d5306ebc161

data/README.md

@@ -18,26 +18,86 @@ Or install it yourself as:
 
 ## Usage
 
-	$ require 'handy_apn'
-	$ rake --tasks
-	$ rake apn:send_push_notification[full_file_path_to_dot_pem,pass_phrase_for_certificate,device_token,is_dev_or_prod]
-
-Note:
-
-* full_file_path_to_dot_cer - absolute location of the file along with file name and should be for .pem
-
-* device_token - should be separated by space after 8 characters as shown in example below.
-
-* is_dev_or_prod - false - connects to APN-Dev service - gateway.sandbox.push.apple.com
-
-
-	$ rake apn:send_push_notification["/Users/blah/apn_certificates/aps_development.pem","blah","eb8328c8 3f42a4dd e7eb8e96 5535b0c7 653032eb 070e54d9 c55133a6 da32c94f",false]
+### Command Line
+  The handy_apn gem provides a command-line option (```handy_apn```) to test your certificates by sending message to the device.
+  
+  To lists the commands available:
+  ```sh
+  $ handy_apn -h
+  ```
+  
+  To send message to a device:
+  ```sh
+  $ handy_apn -h push
+
+  push
+
+  Usage: handy_apn push TOKEN [...]
+
+  Examples:
+        
+    # description
+    handy_apn push <token> -m "Hello, World"
+        
+  Options:
+    -m, --alert ALERT    Body of the alert to send in the push notification 
+    -e, --environment ENV Environment to send push notification (production or development (default)) 
+    -c, --certificate CERTIFICATE Path to certificate (.pem) file 
+    -p, --[no]-passphrase Prompt for a certificate passphrase 
+  ```
+  
+  To send the message "Hello world" to the device using the production apple push notification service using the prodution pem file.
+  ```sh
+  $ handy_apn push "f2ecca82 b48b7a38 5b838ece 3079ee6f 29f27163 d8407c1f 01f7298c 0a74bd7c" -m "Hello world" -e production -c aps_production.pem -p
+  ```
+
+### Rakefile
+  The handy_apn gem also provides a rake task to test your certificates by sending a message to the device.
+  
+  Create a Rakefile:
+  ```sh
+  $ vi Rakefile
+  ```
+  Add the following code to the Rakefile.
+  ```ruby
+  require "handy_apn/Rakefile"
+  ```
+  
+  Now lists the rake tasks
+  ```sh
+  $ rake --tasks
+  $ rake apn:send_message[apn_pem_file_path,apn_pass_phrase,device_token,should_send_message_to_apn_prod,message_text]
+  ```
+Params:
+
+* apn_pem_file_path - absolute location of the file along with file name
+* apn_pass_phrase - passphrase for your pem file
+* device_token - should be formed of 64 alphanumeric characters and separated by space after 8 characters as shown in example below.
+* should_send_message_to_apn_prod - true would send to apple's production push notification service.
+* message_text - Message you want to send
+
+Example to test development certificate:
+```sh
+$ rake apn:send_message["/Users/blah/apn_certificates/aps_development.pem","blah","eb8328c8 3f42a4dd e7eb8e96 5535b0c7 653032eb 070e54d9 c55133a6 da32c94f",false,"Hello world"]
+```
 
 ## How to create apple push notification certificate
 
- I have referred to instructions from raywenderlich.
+1. Open you Keychain and request for a CertificateSigningRequest(CSR): 
+![alt tag](https://github.com/sushmasatish/handy_apn/blob/master/docs/CSRRequest.png)
+2. Create your CSR and **save it disk**:![alt tag](https://github.com/sushmasatish/handy_apn/blob/master/docs/CSRCreation.png)
+3. Open **apple developer portal**, open your app id and enable push notification:![alt tag](https://github.com/sushmasatish/handy_apn/blob/master/docs/AppleDeveloper_EnablePushNotification.png)
+4. In apple developer portal, To create push notification developer certificate, Click Certificate, you will see this page, click Continue here:![alt tag](https://github.com/sushmasatish/handy_apn/blob/master/docs/AppleInstructionsOnCreatingCSR.png)
+5. Now upload the CSR created in step 2:![alt tag](https://github.com/sushmasatish/handy_apn/blob/master/docs/generating_certificate.png)
+6. Once generated, click on download and save the file. The saved file would be named: "aps_development.cer":![alt tag](https://github.com/sushmasatish/handy_apn/blob/master/docs/click_download.png)
+7. Open the downloaded aps_development.cer file by double clicking. This would add the .cer to keychain. Now Select the **private key** and the **certificate** and right click and select ```Export 2 items```:![alt tag](https://github.com/sushmasatish/handy_apn/blob/master/docs/ExportingPrivateKeyAndAPNDevCerTogether.png)
+8. Selecting Export 2 items, will export it as .p12 file:![alt tag](https://github.com/sushmasatish/handy_apn/blob/master/docs/ExportingPrivateKeyDevCerTogether.png)
+9. Now execute the following ```openssl``` command on the ```AppDemoPrivateKeyDevCerTogether.p12```:
+
+```sh
+$ openssl pkcs12 -in AppDemoPrivateKeyDevCerTogether.p12 -out push_notification_demo_apn_dev.pem -nodes -clcerts
+```
 
-http://www.raywenderlich.com/32960/apple-push-notification-services-in-ios-6-tutorial-part-1
 
 ## Development
 

data/handy_apn.gemspec

@@ -17,13 +17,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "coloured_logger"
   spec.add_dependency "commander", "~> 4.1"
   spec.add_dependency "json"
-  spec.add_dependency "houston"
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths  = ["lib"]

data/lib/handy_apn/version.rb

@@ -1,3 +1,3 @@
 module HandyApn
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: handy_apn
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sushma Satish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configatron
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: houston
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement