pushmeup 0.0.2 → 0.0.3

data/.rvmrc

@@ -34,15 +34,15 @@ else
 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
+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

data/README.md

@@ -1,21 +1,164 @@
-# Periodic Table
+# Pushmeup
 
-[![Build Status](https://secure.travis-ci.org/NicosKaralis/pushmeup.png?branch=master)](http://travis-ci.org/NicosKaralis/pushmeup)
+### a gem for various push notification services.
+
+## Goals
+
+Pushmeup is an attempt to create an push notifications center that could send push to devices like:
+
+- Android
+- iOS
+- Mac OS X
+- Windows Phone
+- And many others
+
+Currently we have only support for ``iOS`` and ``Android`` but we are planning code for more plataforms.
 
 ## Installation
 
-    gem install pushmeup
+    $ gem install pushmeup
+    
+or add to your ``Gemfile``
+
+    gem 'pushmeup'
+    
+and install it with
+
+    $ bundle install
+
+## APNS (Apple iOS)
+
+### Configure
+
+1. In Keychain access export your certificate and your private key as a ``p12``.
+
+  ![Keychain Access](https://raw.github.com/NicosKaralis/pushmeup/master/Keychain Access.jpg)
+
+2. Run the following command to convert the ``p12`` to a ``pem`` file
+
+        $ openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts
+
+3. After you have created your ``pem`` file. Set what host, port, 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
+        
+        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
+
+### Usage
+
+#### 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')
+
+#### 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])
+
+#### Sending more information along
+
+        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"}
+
+### Getting your iOS device token
+
+    - (void)applicationDidFinishLaunching:(UIApplication *)application {
+        // Register with apple that this app will use push notification
+        ...
+        
+        [[UIApplication sharedApplication] registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeSound | UIRemoteNotificationTypeBadge)];
+        
+        ...
+        
+    }
+    
+    - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
+        // Show the device token obtained from apple to the log
+        NSLog("deviceToken: %", deviceToken);
+    }
+
+## GCM (Google Cloud Messaging)
+
+### Configure
+
+		GCM.host = 'https://android.googleapis.com/gcm/send'
+		# https://android.googleapis.com/gcm/send is default
+
+		GCM.format = :json
+		# :json is default and only available at the moment
+
+		GCM.key = "123abc456def"
+		# this is the apiKey obtained from here https://code.google.com/apis/console/
+		
+### Usage
+
+#### Sending a single notification:
+
+		destination = ["device1", "device2", "device3"]
+		# can be an string or an array of strings containing the regIds of the devices you want to send
+
+		data = {:key => "value", :key2 => ["array", "value"]}
+		# must be an hash with all values you want inside you notification
+
+		GCM.send_notification( destination )
+		# Empty notification
+
+		GCM.send_notification( destination, data )
+		# Notification with custom information
+
+		GCM.send_notification( destination, data, :collapse_key => "placar_score_global", :time_to_live => 3600, :delay_while_idle => false )
+		# Notification with custom information and parameters
+
+for more information on parameters check documentation: [GCM | Android Developers](http://developer.android.com/guide/google/gcm/gcm.html#request)
+
+#### Sending multiple notifications:
+
+		destination1 = "device1"
+		destination2 = ["device2"]
+		destination3 = ["device1", "device2", "device3"]
+		# can be an string or an array of strings containing the regIds of the devices you want to send
+
+		data1 = {:key => "value", :key2 => ["array", "value"]}
+		# must be an hash with all values you want inside you notification
+		
+		options1 = {:collapse_key => "placar_score_global", :time_to_live => 3600, :delay_while_idle => false}
+		# options for the notification
+		
+		n1 = GCM::Notification.new(destination1, data1, options1)
+		n2 = GCM::Notification.new(destination2, data2)
+		n3 = GCM::Notification.new(destination3, data3, options2)
+
+		GCM.send_notifications( [n1, n2, n3] )
+		# In this case, every notification has his own parameters
+	
+for more information on parameters check documentation: [GCM | Android Developers](http://developer.android.com/guide/google/gcm/gcm.html#request)
+
+#### Getting your Android device token (regId)
+
+Check this link [GCM: Getting Started](http://developer.android.com/guide/google/gcm/gs.html)
 
-## Usage
+## 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)
 
-    require 'pushmeup'
+## Dependency Status [![Dependency Status](https://gemnasium.com/NicosKaralis/pushmeup.png?travis)](https://gemnasium.com/NicosKaralis/pushmeup)
 
-    # TODO: Make usage cases
+## License
 
-## Contributing
+Pushmeup is released under the MIT license:
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+http://www.opensource.org/licenses/MIT

data/lib/pushmeup/android.rb

@@ -1 +1,2 @@
 require "pushmeup/gcm/core"
+require "pushmeup/gcm/notification"

data/lib/pushmeup/gcm/core.rb

@@ -1,57 +1,80 @@
 require 'httparty'
-require 'cgi'
+# require 'cgi'
 require 'json'
 
-class GCM
+module GCM
   include HTTParty
   
   @host = 'https://android.googleapis.com/gcm/send'
-  
-  @base_uri = 'https://android.googleapis.com/gcm/send'
-  @timeout = 30
   @format = :json
   @key = nil
 
   class << self
-    attr_accessor :base_uri, :timeout, :format, :key
+    attr_accessor :host, :format, :key
   end
-
-  # {
-  # "collapse_key": "score_update",
-  # "time_to_live": 108,
-  # "delay_while_idle": true,
-  # "registration_ids": ["4", "8", "15", "16", "23", "42"],
-  # "data" : {
-  # "score": "5x1",
-  # "time": "15:10"
-  # }
-  # }
-  # gcm = GCM.new(api_key)
-  # gcm.send_notification({registration_ids: ["4sdsx", "8sdsd"], data: {score: "5x1"}})
-  def self.send_notification(registration_ids, options = {})
-    post_body = build_post_body(registration_ids, options)
-
-    params = {
-      :body => post_body.to_json,
-      :headers => {
-        'Authorization' => "key=#{@key}",
-        'Content-Type' => 'application/json',
-      }
-    }
-
-    response = self.post(@base_uri, params)
-    build_response(response)
-    # {body: response.body, headers: response.headers, status: response.code}
+  
+  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|
+      responses << self.prepare_and_send(n)
+    end
+    responses
   end
 
   private
-
-  def self.build_post_body(registration_ids, options={})
-    body = {:registration_ids => registration_ids}.merge(options)
-    #p body
-    #raise exception if options[:time_to_live] && !options[:collapse_key]
+  
+  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"
+    end
+    if !n.collapse_key.nil? && n.time_to_live.nil?
+      raise %q{If you are defining a "colapse key" you need a "time to live"}
+    end
+    
+    if self.format == :json
+      self.send_push_as_json(n)
+    elsif self.format == :text
+      self.send_push_as_plain_text(n)
+    else
+      raise "Invalid format"
+    end
   end
-
+  
+  def self.send_push_as_json(n)
+    headers = {
+      'Authorization' => "key=#{self.key}",
+      'Content-Type' => 'application/json',
+    }
+    body = {
+      :registration_ids => n.device_tokens,
+      :data => n.data,
+      :collapse_key => n.collapse_key,
+      :time_to_live => n.time_to_live,
+      :delay_while_idle => n.delay_while_idle
+    }
+    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 = {
+      'Authorization' => "key=#{self.key}",
+      'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8',
+    }
+    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)
+    return build_response(response)
+  end
+  
   def self.build_response(response)
     case response.code
       when 200
@@ -66,4 +89,5 @@ class GCM
         {:response => 'Server is temporarily unavailable.', :status_code => response.code}
     end
   end
+  
 end

data/lib/pushmeup/gcm/notification.rb

@@ -0,0 +1,45 @@
+module GCM
+  class Notification
+    attr_accessor :device_tokens, :data, :collapse_key, :time_to_live, :delay_while_idle
+    
+    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]
+    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"
+      end
+    end
+    
+    def data=(data)
+      if data.is_a?(Hash)
+        @data = data
+      else
+        raise "data parameter must be the tpe 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
+      else
+        raise %q{"time_to_live" must be seconds as an integer value, like "100"}
+      end
+    end
+    
+  end
+end

data/lib/pushmeup/version.rb

@@ -1,3 +1,3 @@
 module Pushmeup
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/pushmeup.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |s|
 
   s.require_paths = ["lib"]
 
-  s.add_dependency('httparty')
-  s.add_dependency('json')
+  s.add_dependency 'httparty'
+  s.add_dependency 'json'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/spec/lib/pushmeup_spec.rb

@@ -8,7 +8,7 @@ describe Pushmeup do
     
     it "should not forget the APNS default parameters" do
       APNS.host.should == "gateway.sandbox.push.apple.com"
-      APNS.port.should be_equal(2195)
+      APNS.port.should == 2195
       APNS.pem.should be_equal(nil)
       APNS.pass.should be_equal(nil)
     end
@@ -16,8 +16,42 @@ describe Pushmeup do
   end
   
   describe "GCM" do
-    it "should have a APNS object" 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
+
+      it "should allow only notifications with device_tokens as array" do
+        n = GCM::Notification.new("id", @options)
+        n.device_tokens.is_a?(Array).should be_true
+
+        n.device_tokens = ["a" "b", "c"]
+        n.device_tokens.is_a?(Array).should be_true
+
+        n.device_tokens = "a"
+        n.device_tokens.is_a?(Array).should be_true
+      end
+
+      it "should allow only notifications with data as hash with :data root" do
+        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
+      
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushmeup
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-14 00:00:00.000000000 Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -91,6 +91,7 @@ files:
 - .rvmrc
 - .travis.yml
 - Gemfile
+- Keychain Access.jpg
 - LICENSE
 - README.md
 - Rakefile
@@ -100,6 +101,7 @@ files:
 - lib/pushmeup/apns/notification.rb
 - lib/pushmeup/apple.rb
 - lib/pushmeup/gcm/core.rb
+- lib/pushmeup/gcm/notification.rb
 - lib/pushmeup/version.rb
 - pushmeup.gemspec
 - spec/lib/pushmeup_spec.rb
@@ -118,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3467176487939634331
+      hash: 1966969484721973380
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3467176487939634331
+      hash: 1966969484721973380
 requirements: []
 rubyforge_project: pushmeup
 rubygems_version: 1.8.24