pushlet 0.2.3 → 0.2.5

data/README.md

@@ -29,7 +29,7 @@ Then, setup a `config.ru` with the following. Setup an HTTP Auth so that you can
 Pushlet is **thread optimized**, so use a threaded web server. I highly recommend using [Puma](http://puma.io), which is designed for threaded applications. You can add it by putting `gem 'puma'` in your Gemfile:
 
     $ bundle exec puma
-    
+
 You can also use `rackup`:
 
     $ bundle exec rackup -s puma
@@ -56,7 +56,7 @@ GCM does not have a concept of a "message" field. You are given a data input tha
 
     curl http://127.0.0.1:9292/send_notification -d "device_token=YOUR_GCM_DEVICE_KEY&gcm_api_key=YOUR_GCM_API_KEY&data=%7B%22text%22%3A%22hello%22%7D"
 
-## POST /application_feedback
+## POST /application\_feedback
 
 Returns the feedback information from Apple. Not required for GCM.
 
@@ -87,18 +87,18 @@ Returns the feedback information from Apple. Not required for GCM.
     }
 
     {
-      "error": "application_not_found", 
+      "error": "application_not_found",
       "message": "no application found for the provided application_id"
     }
 
-## POST /register_application
+## POST /register\_application
 
 Registers the APNS application with a certificate. This will create a socket connection when the first message is sent, providing a persistent connection to the Apple push servers.
 
-* application_id - a unique identifier for this application. If none is provided, a UUID-based one will be generated and returned to you, and you will need to store it somewhere to use the connection.
+* application\_id - a unique identifier for this application. If none is provided, a UUID-based one will be generated and returned to you, and you will need to store it somewhere to use the connection.
 * apns\_p12 - Apple certificate in P12 format. Either this or apns\_pem are required.
 * apns\_pem - Apple certificate in PEM format. Either this or apns\_p12 are required.
-* apns_mode - toggles whether to use sandbox mode or not. If set to "development", the sandbox is used. Defaults to production.
+* apns\_mode - toggles whether to use sandbox mode or not. If set to "development", the sandbox is used. Defaults to production.
 * apns\_p12\_pass - password for P12. Optional.
 
 ### Example Response
@@ -120,13 +120,13 @@ Registers the APNS application with a certificate. This will create a socket con
     }
 
 
-## POST /send_notification
+## POST /send\_notification
 
 Sends a message to either the GCM REST service or the APNS application socket.
 
 * type - "apns" or "gcm". Required.
 * application\_id - application\_id provided for registered APNS application. Either this or gcm\_api\_key are required.
-* gcm\_api\_key - GCM secret key from Google. Either this or application_id are required.
+* gcm\_api\_key - GCM secret key from Google. Either this or application\_id are required.
 * device\_token - the device push token provided by the phone for your application. Required.
 * data - the generic data JSON payload to send to either APNS or GCM.
 
@@ -160,27 +160,27 @@ APNS specific:
       "error": "missing_identifier",
       "message": "an application_id or gcm_api_key are required for this call"
     }
-    
+
     {
       "error": "device_token_required",
       "message": "device_token is required, which is registed with the application on your phone"
     }
-    
+
     {
       "error": "application_not_found",
       "message": "no application found for the provided application_id"
     }
-    
+
     {
       "error": "invalid_data_json",
       "message": "data could not be converted to json: ERROR_MESSAGE_FROM_JSON_PARSER"
     }
-    
+
     {
       "error": "invalid_data_json",
       "message": "data could not be converted to json: ERROR_MESSAGE_FROM_JSON_PARSER"
     }
-    
+
     {
       "error": "invalid_gcm_credentials",
       "message": "the provided credentials were rejected by google servers"

data/lib/pushlet/apns_gateway.rb

@@ -53,7 +53,7 @@ module Pushlet
       end
 
       payload = {}
-      
+
       [:device_token, :alert, :badge, :sound, :expiry, :identifier].each do |a|
         if a == :expiry
           payload[a] = args[a] || Time.now + 60*10

data/lib/pushlet/auth_middleware.rb

@@ -1,4 +1,4 @@
-module Pushlet  
+module Pushlet
   class AuthMiddleware
     def initialize(app, username, password)
       @app = app
@@ -26,4 +26,4 @@ module Pushlet
       [200, {'Content-Type' => 'application/json', 'Content-Length' => payload.length.to_s}, [payload]]
     end
   end
-end
+end

data/lib/pushlet/gateway_pool.rb

@@ -1,4 +1,4 @@
-module Pushlet  
+module Pushlet
   class GatewayPool
     def initialize
       @mutex = Mutex.new
@@ -27,4 +27,4 @@ module Pushlet
       @mutex.synchronize { yield }
     end
   end
-end
+end

data/lib/pushlet/version.rb

@@ -3,6 +3,6 @@ module Pushlet
   #
   # @return [String]
   def self.version
-    '0.2.3'
+    '0.2.5'
   end
 end

data/pushlet.gemspec

@@ -15,11 +15,9 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'json'
   s.add_dependency 'httpclient'
-  s.add_dependency 'sinatra'
   s.add_dependency 'sinatra-jsonapi'
   s.add_dependency 'escape'
   s.add_dependency 'running'
-  s.add_dependency 'httpclient'
   s.add_dependency 'uuid'
   s.add_dependency 'grocer'
   s.add_dependency 'puma'

data/test/gcm_push_test.rb

@@ -12,21 +12,21 @@ describe 'send gcm push' do
   end
 
   it 'should fail gracefully for invalid key' do
-    
+
   end
 
   it 'works' do
-    
+
     stub_request(:post, "https://android.googleapis.com/gcm/send").
       with(:body => "{\"registration_ids\":[\"1234\"],\"data\":{\"text\":\"hello\"},\"collapse_key\":null,\"delay_while_idle\":null,\"time_to_live\":null,\"dry_run\":null}",
            :headers => {'Authorization'=>'key=ABCD', 'Content-Type'=>'application/json'}).
       to_return(:status => 200, :body => %{{"multicast_id":6782339717028231855,"success":0,"failure":1,"canonical_ids":0,"results":[{"error":"InvalidRegistration"}]}})
-    
+
     post '/send_notification', gcm_api_key: 'ABCD', data: {text: 'hello'}, device_tokens: ['1234']
-    
-  
+
+
 
   # binding.pry
-    
+
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushlet
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-04 00:00:00.000000000 Z
+date: 2012-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -44,22 +44,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  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-jsonapi
   requirement: !ruby/object:Gem::Requirement
@@ -108,22 +92,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  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: uuid
   requirement: !ruby/object:Gem::Requirement
@@ -281,7 +249,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- SPEC-OLD.md
 - lib/pushlet.rb
 - lib/pushlet/api.rb
 - lib/pushlet/apns_gateway.rb

data/SPEC-OLD.md

@@ -1,238 +0,0 @@
-# `POST /register_application`
-
-TODO: Update spec with updated parameter names.
-
-TODO: feedback_url not yet implemented.
-
-* app_id: Required. A unique identifier for this application.
-* feedback\_url: http://yoursite.com/notification_errors
-* mode: development or production. Only applies to apple.
-
-Provide either a P12 certificate or a Google GCM API Key
-
-* p12: The P12 certificate as a string
-* gcm\_api\_key: sefsdjfsdlkfj
-
-## Response
-
-```
-{
-  "application_id": "a9b20610187a0130d39614109feae54c"
-}
-```
-
-## Errors
-
-### /application_feedback
-
-```
-{
-  "error": "missing_identifier",
-  "message": "an application\_id or gcm\_api\_key are required for this call"
-}
-```
-
-```
-{
-  "error": "application\_not\_found", 
-  "message": "no application found for the provided application_id"
-}
-```
-
-```
-{
-  "error": "expired_certificate",
-  "message": "The certificate provided has expired. Please generate a new certificate."
-}
-```
-
-
-# `/send_notification?type=apns`
-
-TODO: Explain why the "device_token" parameter implemented but not the plural version.
-
-* device_tokens - array or string. Apple does not support multiple, so just loop for that case.x
-* alert         - "text message to send or see apple docs for other options"
-* badge         - example: 5
-* sound         - "soundfile.aiff"
-* identifier    - unique key for message. enforce as a 32 bit integer if grocer does not
-* data          - JSON to dump in the root with the aps payload.
-
-## Errors
-
-```
-{
-  "error": "invalid_input", 
-  "message": "badge must be an integer"
-}
-```
-
-```
-{
-  "error": "missing_application", 
-  "message": "The application could not be found. Register the application first using POST /register\_application"
-}
-```
-
-### APNS Error Codes
-
-TODO: Error responses are not sent back from the send_notification endpoint. Why not?
-
-* 1: processing error
-* 2: missing device token
-* 3: missing topic
-* 4: missing payload
-* 5: invalid token size
-* 6: invalid topic size
-* 7: invalid payload size
-* 8: invalid token
-* 255: unknown
-
-```
-{
-  "error": "missing_topic", 
-  "code": 3, 
-  "device_token": "b85a40425e91a68512259b40f480a2a645efd185106dc66a3e73f6c89e95c963", 
-  "identifier": "asdjfhd"
-}
-```
-
-## APNS Payload Examples (Internal use only)
-
-### Send text:
-```
-{
-  "aps": {
-    "alert": "hello"
-  }
-}
-```
-
-### Set number on badge:
-```
-{
-  "aps": {
-    "badge": 9
-  }
-}
-```
-
-### Sound (plays sound)
-```
-{
-  "aps": {
-    "sound": "ping.aiff"
-  }
-}
-```
-
-All three of these parameters can be combined. You can also send a push notification with custom data and leave out the standard "aps" keys.
-
-Other keys can be sent outside of the aps root. Example: 
-
-```
-{
-  "aps": {
-    "alert": "hello"
-  }, 
-  "hello": "kitty"
-}
-```
-
-
-# `/send_notification?type=gcm`
-
-* app_id OR gcm\_api\_key
-* device_tokens - json array or string (one device)
-* data - the notification payload
-* collapse\_key - if you send multiple pushes with the same collapse\_key, only the last will be delivered when the phone comes back online
-* delay\_while\_idle - this will send the message when the device comes back from idle. Default: false
-* time\_to\_live - number of seconds the message should be kept if the device is offline. Default: 4 weeks
-* dry\_run - default: false
-
-## Input/Format Errors
-
-```
-{
-  "error": "missing_input", 
-  "message": "data is required"
-}
-```
-
-```
-{
-  "error": "missing_input", 
-  "message": "device_tokens is required"
-}
-```
-
-```
-{
-  "error": "missing_input", 
-  "message": "app_id OR gcm_api_key is required"
-}
-```
-
-These errors will come from the GCM service
-
-`{"error": "message_too_big"}`
-
-`{"error": "invalid_data_key"}`
-
-`{"error": "invalid_ttl"}`
-
-## Error format for multiple responses
-
-If the input format is valid, the service will attempt to send the notification. The results of sending each notification will be returned in "results".
-
-```
-{
-  "results": [
-    {"device_token": "fsdsfegr", "error": "invalid_registration"},
-    {"device_token": "dsdfdgfg", "success": true}
-  ]
-}
-```
-
-## Other possbile errors from the GCM service
-
-* 401: "Invalid API Key"
-* MissingRegistration
-* InvalidRegistration
-* MismatchSenderId
-* NotRegistered
-* MessageTooBig
-* InvalidDataKey
-* InvalidTtl
-* InternalServerError
-
-{"type": "MissingRegistration", device_token: "sdfsdf"} <- maybe convert to undercase?
-
-## GCM Documentation
-
-* http://developer.android.com/guide/google/gcm/index.html
-* http://developer.android.com/guide/google/gcm/adv.html
-
-
-# `apns\_feedback`
-
-TODO: Update this explanation with a reason why this was implemented as a GET API 
-method instead of as described below.
-
-The Pushlet service will periodically check the APNS feedback service for errors. If any 
-errors are reported by Apple, Pushlet will deliver a POST to the registered `callback_url`
-for the application. 
-
-The feedback payload will contain the device token and the timestamp of the error.
-
-
-```
-{
-  "app_id": "14002",
-  "type": "feedback",
-  "device_token": "b85a40425e91a68512259b40f480a2a645efd185106dc66a3e73f6c89e95c963", 
-  "timestamp": 1352502272
-}
-```
-
-