pushmeup 0.1.4.hf1 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTgxOGQzMTRiNmVlZTlkOWRiOTMyZTk2NDA4YzU3MmEwMWEzNDU0Nw==
+  data.tar.gz: !binary |-
+    OGM3MzgwOWQ2ODhlNDc1ZWZjNTM5MmIzNDJlOTcxYzFhMWNiZGU1YQ==
+SHA512:
+  metadata.gz: !binary |-
+    YjVmZmM1NDM5Mzc4YWQ3N2I5MTFmOTRhMzI5YmY0N2E4YmM2YTgyZTRkNWZj
+    YjE5ZWE5ZDRiYWQxMDAwMjA4OGZmZWJiMTRjZTJhNWIyOTUxYzU1M2U1ZGFh
+    OGY1OTMyMjM3NzUwYmU4YzM1YTg0MWNmYjA1Mjc4OGRkYzk4YmQ=
+  data.tar.gz: !binary |-
+    MjYwZTI4ZGM2OWRjNWYzNGM5NDVkYzI2NjZlNzdlMGZmOWExZTVkMTllOWQ5
+    ZTlhOTUyMzBhYzM2YTM1ZTMyOTdjNTdjYTA0ZDQxNzcxZDg0NmFiMWVkMGVh
+    ZTMwMzI5OGQ5ZmZiMjExMTBmOTgwY2JiNGU4N2VmNDY4NGRmMGQ=

data/.ruby-gemset

@@ -0,0 +1 @@
+pushmeup

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/.travis.yml

@@ -1,11 +1,7 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - jruby-18mode # JRuby in 1.8 mode
+  - 2.0.0
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
 # uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+# script: bundle exec rspec spec

data/README.md

@@ -41,14 +41,15 @@ and install it with
 3. After you have created your ``pem`` file. Set the host, port and certificate file location on the APNS class. You just need to set this once:
 
         APNS.host = 'gateway.push.apple.com' 
-        # gateway.sandbox.push.apple.com is default
+        # gateway.sandbox.push.apple.com is default and only for development
+        # gateway.push.apple.com is only for production
         
         APNS.port = 2195 
         # this is also the default. Shouldn't ever have to set this, but just in case Apple goes crazy, you can.
-
+        
         APNS.pem  = '/path/to/pem/file'
         # this is the file you just created
-
+        
         APNS.pass = ''
         # Just in case your pem need a password
 
@@ -56,25 +57,49 @@ and install it with
 
 #### Sending a single notification:
 
-        device_token = '123abc456def'
-        APNS.send_notification(device_token, 'Hello iPhone!' )
-        APNS.send_notification(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
+    device_token = '123abc456def'
+    APNS.send_notification(device_token, 'Hello iPhone!' )
+    APNS.send_notification(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
 
 #### Sending multiple notifications
 
-        device_token = '123abc456def'
-        n1 = APNS::Notification.new(device_token, 'Hello iPhone!' )
-        n2 = APNS::Notification.new(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
-        APNS.send_notifications([n1, n2])
+    device_token = '123abc456def'
+    n1 = APNS::Notification.new(device_token, 'Hello iPhone!' )
+    n2 = APNS::Notification.new(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
+    APNS.send_notifications([n1, n2])
+        
+> All notifications passed as a parameter will be sent on a single connection, this is done to improve
+> reliability with APNS servers.
+
+#### Another way to send multiple notifications is to send notifications in a persistent connection (thread safe)
+
+    # Define that you want persistent connection
+    APNS.start_persistence
+
+    device_token = '123abc456def'
+    
+    # Send single notifications
+    APNS.send_notification(device_token, 'Hello iPhone!' )
+    APNS.send_notification(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
+    
+    # Send multiple notifications
+    n1 = APNS::Notification.new(device_token, 'Hello iPhone!' )
+    n2 = APNS::Notification.new(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default')
+    APNS.send_notifications([n1, n2])
+    
+    ...
+    
+    # Stop persistence, from this point each new push will open and close connections
+    APNS.stop_persistence
 
 #### Sending more information along
 
-        APNS.send_notification(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default', 
-                                            :other => {:sent => 'with apns gem', :custom_param => "value"})
+    APNS.send_notification(device_token, :alert => 'Hello iPhone!', :badge => 1, :sound => 'default', 
+                                        :other => {:sent => 'with apns gem', :custom_param => "value"})
                                             
 this will result in a payload like this:
 
-        {"aps":{"alert":"Hello iPhone!","badge":1,"sound":"default"},"sent":"with apns gem", "custom_param":"value"}
+    {"aps":{"alert":"Hello iPhone!","badge":1,"sound":"default"},"sent":"with apns gem", "custom_param":"value"}
 
 ### Getting your iOS device token
 
@@ -187,7 +212,9 @@ You can use multiple keys to send notifications, to do it just do this changes i
 
 ## Status
 
-#### Build Status [![Build Status](https://secure.travis-ci.org/NicosKaralis/pushmeup.png?branch=master)](http://travis-ci.org/NicosKaralis/pushmeup) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/NicosKaralis/pushmeup)
+#### Build Status 
+[![Build Status](https://travis-ci.org/NicosKaralis/pushmeup.png?branch=master)](https://travis-ci.org/NicosKaralis/pushmeup)
+[![Code Climate](https://codeclimate.com/github/NicosKaralis/pushmeup.png)](https://codeclimate.com/github/NicosKaralis/pushmeup)
 
 #### Dependency Status [![Dependency Status](https://gemnasium.com/NicosKaralis/pushmeup.png?travis)](https://gemnasium.com/NicosKaralis/pushmeup)
 
@@ -202,3 +229,7 @@ Currently we need a lot of testing so if you are good at writing tests please he
 Pushmeup is released under the MIT license:
 
 http://www.opensource.org/licenses/MIT
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/NicosKaralis/pushmeup/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/lib/pushmeup/apns/core.rb

@@ -10,24 +10,41 @@ module APNS
   @pem = nil # this should be the path of the pem file not the contentes
   @pass = nil
   
+  @persistent = false
+  @mutex = Mutex.new
+  @retries = 3 # TODO: check if we really need this
+  
+  @sock = nil
+  @ssl = nil
+  
   class << self
     attr_accessor :host, :pem, :port, :pass
   end
   
+  def self.start_persistence
+    @persistent = true
+  end
+  
+  def self.stop_persistence
+    @persistent = false
+    
+    @ssl.close
+    @sock.close
+  end
+  
   def self.send_notification(device_token, message)
     n = APNS::Notification.new(device_token, message)
     self.send_notifications([n])
   end
   
   def self.send_notifications(notifications)
-    sock, ssl = self.open_connection
-    
-    notifications.each do |n|
-        ssl.write(n.packaged_notification)
+    @mutex.synchronize do
+      self.with_connection do
+        notifications.each do |n|
+          @ssl.write(n.packaged_notification)
+        end
       end
-
-    ssl.close
-    sock.close
+    end
   end
   
   def self.feedback
@@ -47,8 +64,38 @@ module APNS
     return apns_feedback
   end
   
-  protected
-
+protected
+  
+  def self.with_connection
+    attempts = 1
+  
+    begin      
+      # If no @ssl is created or if @ssl is closed we need to start it
+      if @ssl.nil? || @sock.nil? || @ssl.closed? || @sock.closed?
+        @sock, @ssl = self.open_connection
+      end
+    
+      yield
+    
+    rescue StandardError, Errno::EPIPE
+      raise unless attempts < @retries
+    
+      @ssl.close
+      @sock.close
+    
+      attempts += 1
+      retry
+    end
+  
+    # Only force close if not persistent
+    unless @persistent
+      @ssl.close
+      @ssl = nil
+      @sock.close
+      @sock = nil
+    end
+  end
+  
   def self.open_connection
     raise "The path to your pem file is not set. (APNS.pem = /path/to/cert.pem)" unless self.pem
     raise "The path to your pem file does not exist!" unless File.exist?(self.pem)
@@ -73,7 +120,6 @@ module APNS
     context.key  = OpenSSL::PKey::RSA.new(File.read(self.pem), self.pass)
     
     fhost = self.host.gsub('gateway','feedback')
-    puts fhost
     
     sock         = TCPSocket.new(fhost, 2196)
     ssl          = OpenSSL::SSL::SSLSocket.new(sock, context)

data/lib/pushmeup/apns/notification.rb

@@ -1,7 +1,7 @@
 module APNS
   class Notification
     attr_accessor :device_token, :alert, :badge, :sound, :other
-    
+
     def initialize(device_token, message)
       self.device_token = device_token
       if message.is_a?(Hash)
@@ -12,28 +12,36 @@ module APNS
       elsif message.is_a?(String)
         self.alert = message
       else
-        raise "Notification needs to have either a hash or string"
+        raise "Notification needs to have either a Hash or String"
       end
     end
-        
+
     def packaged_notification
       pt = self.packaged_token
       pm = self.packaged_message
       [0, 0, 32, pt, 0, pm.bytesize, pm].pack("ccca*cca*")
     end
-  
+
     def packaged_token
       [device_token.gsub(/[\s|<|>]/,'')].pack('H*')
     end
-  
+
     def packaged_message
       aps = {'aps'=> {} }
       aps['aps']['alert'] = self.alert if self.alert
       aps['aps']['badge'] = self.badge if self.badge
       aps['aps']['sound'] = self.sound if self.sound
       aps.merge!(self.other) if self.other
-      aps.to_json
+      aps.to_json.gsub(/\\u([\da-fA-F]{4})/) {|m| [$1].pack("H*").unpack("n*").pack("U*")}
     end
-    
+
+    def ==(that)
+      device_token == that.device_token &&
+      alert == that.alert &&
+      badge == that.badge &&
+      sound == that.sound &&
+      other == that.other
+    end
+
   end
 end

data/lib/pushmeup/gcm/core.rb

@@ -4,14 +4,14 @@ require 'json'
 
 module GCM
   include HTTParty
-  
+
   @host = 'https://android.googleapis.com/gcm/send'
   @format = :json
   @key = nil
 
   class << self
     attr_accessor :host, :format, :key
-    
+
     def key(identity = nil)
       if @key.is_a?(Hash)
         raise %{If your key is a hash of keys you'l need to pass a identifier to the notification!} if identity.nil?
@@ -20,7 +20,7 @@ module GCM
         return @key
       end
     end
-    
+
     def key_identities
       if @key.is_a?(Hash)
         return @key.keys
@@ -29,12 +29,12 @@ module GCM
       end
     end
   end
-  
+
   def self.send_notification(device_tokens, data = {}, options = {})
     n = GCM::Notification.new(device_tokens, data, options)
     self.send_notifications([n])
   end
-  
+
   def self.send_notifications(notifications)
     responses = []
     notifications.each do |n|
@@ -44,7 +44,7 @@ module GCM
   end
 
   private
-  
+
   def self.prepare_and_send(n)
     if n.device_tokens.count < 1 || n.device_tokens.count > 1000
       raise "Number of device_tokens invalid, keep it betwen 1 and 1000"
@@ -55,7 +55,7 @@ module GCM
     if @key.is_a?(Hash) && n.identity.nil?
       raise %{If your key is a hash of keys you'l need to pass a identifier to the notification!}
     end
-    
+
     if self.format == :json
       self.send_push_as_json(n)
     elsif self.format == :text
@@ -64,7 +64,7 @@ module GCM
       raise "Invalid format"
     end
   end
-  
+
   def self.send_push_as_json(n)
     headers = {
       'Authorization' => "key=#{ self.key(n.identity) }",
@@ -79,7 +79,7 @@ module GCM
     }
     return self.send_to_server(headers, body.to_json)
   end
-  
+
   def self.send_push_as_plain_text(n)
     raise "Still has to be done: http://developer.android.com/guide/google/gcm/gcm.html"
     headers = {
@@ -89,13 +89,13 @@ module GCM
     }
     return self.send_to_server(headers, body)
   end
-  
+
   def self.send_to_server(headers, body)
     params = {:headers => headers, :body => body}
-    response = self.post('https://android.googleapis.com/gcm/send', params)
+    response = self.post(self.host, params)
     return build_response(response)
   end
-  
+
   def self.build_response(response)
     case response.code
       when 200
@@ -110,5 +110,5 @@ module GCM
         {:response => 'Server is temporarily unavailable.', :status_code => response.code}
     end
   end
-  
+
 end

data/lib/pushmeup/gcm/notification.rb

@@ -1,39 +1,39 @@
 module GCM
   class Notification
     attr_accessor :device_tokens, :data, :collapse_key, :time_to_live, :delay_while_idle, :identity
-    
+
     def initialize(tokens, data, options = {})
       self.device_tokens = tokens
       self.data = data
-      
+
       @collapse_key = options[:collapse_key]
       @time_to_live = options[:time_to_live]
       @delay_while_idle = options[:delay_while_idle]
       @identity = options[:identity]
     end
-    
+
     def device_tokens=(tokens)
       if tokens.is_a?(Array)
         @device_tokens = tokens
       elsif tokens.is_a?(String)
         @device_tokens = [tokens]
       else
-        raise "device_tokens needs to be either a hash or string"
+        raise "device_tokens needs to be either a Hash or String"
       end
     end
-    
+
     def data=(data)
       if data.is_a?(Hash)
         @data = data
       else
-        raise "data parameter must be the tpe of Hash"
+        raise "data parameter must be the type of Hash"
       end
     end
-    
+
     def delay_while_idle=(delay_while_idle)
       @delay_while_idle = (delay_while_idle == true || delay_while_idle == :true)
     end
-    
+
     def time_to_live=(time_to_live)
       if time_to_live.is_a?(Integer)
         @time_to_live = time_to_live
@@ -41,6 +41,15 @@ module GCM
         raise %q{"time_to_live" must be seconds as an integer value, like "100"}
       end
     end
-    
+
+    def ==(that)
+      device_tokens == that.device_tokens &&
+      data == that.data &&
+      collapse_key == that.collapse_key &&
+      time_to_live == that.time_to_live &&
+      delay_while_idle == that.delay_while_idle &&
+      identity == that.identity
+    end
+
   end
-end
+end

data/lib/pushmeup/version.rb

@@ -1,3 +1,3 @@
 module Pushmeup
-  VERSION = "0.1.4.hf1"
+  VERSION = "0.2.0"
 end

data/spec/lib/pushmeup_spec.rb

@@ -5,23 +5,37 @@ describe Pushmeup do
     it "should have a APNS object" do
       defined?(APNS).should_not be_false
     end
-    
+
     it "should not forget the APNS default parameters" do
       APNS.host.should == "gateway.sandbox.push.apple.com"
       APNS.port.should == 2195
       APNS.pem.should be_equal(nil)
       APNS.pass.should be_equal(nil)
     end
-    
+
+    describe "Notifications" do
+
+      describe "#==" do
+
+        it "should properly equate objects without caring about object identity" do
+          a = APNS::Notification.new("123", {:alert => "hi"})
+          b = APNS::Notification.new("123", {:alert => "hi"})
+          a.should eq(b)
+        end
+
+      end
+
+    end
+
   end
-  
+
   describe "GCM" do
     it "should have a GCM object" do
       defined?(GCM).should_not be_false
     end
-    
+
     describe "Notifications" do
-      
+
       before do
         @options = {:data => "dummy data"}
       end
@@ -38,20 +52,30 @@ describe Pushmeup do
       end
 
       it "should allow only notifications with data as hash with :data root" do
-        n = GCM::Notification.new("id", {:data => "data"})
-        
+        n = GCM::Notification.new("id", { :data => "data" })
+
         n.data.is_a?(Hash).should be_true
         n.data.should == {:data => "data"}
 
         n.data = {:a => ["a", "b", "c"]}
         n.data.is_a?(Hash).should be_true
         n.data.should == {:a => ["a", "b", "c"]}
-        
+
         n.data = {:a => "a"}
         n.data.is_a?(Hash).should be_true
         n.data.should == {:a => "a"}
       end
-      
+
+      describe "#==" do
+
+        it "should properly equate objects without caring about object identity" do
+          a = GCM::Notification.new("id", { :data => "data" })
+          b = GCM::Notification.new("id", { :data => "data" })
+          a.should eq(b)
+        end
+
+      end
+
     end
   end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: pushmeup
 version: !ruby/object:Gem::Version
-  version: 0.1.4.hf1
-  prerelease: 6
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicos Karalis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -88,7 +79,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - Gemfile
 - Keychain Access.jpg
@@ -108,30 +100,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/NicosKaralis/pushmeup
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -548351084538645532
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: pushmeup
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Send push notifications to Apple devices through ANPS and Android devices
   through GCM
 test_files:

data/.rvmrc

@@ -1,48 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3-p125@pushmeup"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.11.5 (master)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
-    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-# If you use bundler, this might be useful to you:
-if [[ -s Gemfile ]] && {
-  ! builtin command -v bundle >/dev/null ||
-  builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
-}
-then
-  printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-  gem install bundler
-fi
-if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-then
-  bundle install | grep -vE '^Using|Your bundle is complete'
-fi