push-gcm 0.0.1.pre

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# PushGCM
+
+Please see [push-core](https://github.com/tompesman/push-core) for more information.

data/lib/push-gcm.rb

@@ -0,0 +1,9 @@
+require 'net/http'
+require 'net/https'
+require 'push-gcm/version'
+require 'push/message'
+require 'push/message_gcm'
+require 'push/feedback'
+require 'push/feedback_gcm'
+require 'push/daemon/gcm'
+require 'push/daemon/gcm_support/connection_gcm'

data/lib/push-gcm/version.rb

@@ -0,0 +1,3 @@
+module PushGcm
+  VERSION = "0.0.1.pre"
+end

data/lib/push/daemon/gcm.rb

@@ -0,0 +1,24 @@
+module Push
+  module Daemon
+    class Gcm
+      attr_accessor :configuration
+      def initialize(options)
+        self.configuration = options
+      end
+
+      def pushconnections
+        self.configuration[:connections]
+      end
+
+      def totalconnections
+        pushconnections
+      end
+
+      def connectiontype
+        GcmSupport::ConnectionGcm
+      end
+
+      def stop; end
+    end
+  end
+end

data/lib/push/daemon/gcm_support/connection_gcm.rb

@@ -0,0 +1,75 @@
+module Push
+  module Daemon
+    module GcmSupport
+      class ConnectionGcm
+        attr_reader :response, :name
+        PUSH_URL = "https://android.googleapis.com/gcm/send"
+        IDLE_PERIOD = 5.minutes
+
+        def initialize(provider, i)
+          @provider = provider
+          @name = "ConnectionGcm #{i}"
+        end
+
+        def connect
+          @last_use = Time.now
+          uri = URI.parse(PUSH_URL)
+          @connection = open_http(uri.host, uri.port)
+          @connection.start
+          Push::Daemon.logger.info("[#{@name}] Connected to #{PUSH_URL}")
+        end
+
+        def write(data)
+          @response = notification_request(data)
+
+          # if @response.code.eql? "200"
+          #   puts "success, but can have an exception in "
+          # elsif @response.code.eql? "400"
+          #   puts "formatting exception"
+          # elsif @response.code.eql? "401"
+          #   puts "authentication exception"
+          # elsif @response.code.eql? "500"
+          #   puts "internal error GCM server"
+          # elsif response.code.eql? "503"
+          #   puts "service un-available: exponential back-off"
+          #
+          #   # do not retry for now
+          #
+          #   # @response.header.each_header do |key, value|
+          #   #   if key.capitalize == "Retry-After".capitalize
+          #   #     # TODO USE DELAY
+          #   #     @delay_by = value
+          #   #   end
+          #   # end
+          #   # TODO or exponentional back-off
+          # end
+        end
+
+        private
+
+        def open_http(host, port)
+          http = Net::HTTP.new(host, port)
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          return http
+        end
+
+        def notification_request(data)
+          headers = { "Authorization" => "key=#{@provider.configuration[:key]}",
+                     "Content-type" => "application/json",
+                     "Content-length" => "#{data.length}" }
+          uri = URI.parse(PUSH_URL)
+
+          # Timeout on the http connection is 5 minutes, reconnect after 5 minutes
+          if @last_use + IDLE_PERIOD < Time.now
+            @connection.finish
+            @connection.start
+          end
+          @last_use = Time.now
+
+          @connection.post(uri.path, data, headers)
+        end
+      end
+    end
+  end
+end

data/lib/push/feedback_gcm.rb

@@ -0,0 +1,5 @@
+module Push
+  class FeedbackGcm < Push::Feedback
+
+  end
+end

data/lib/push/message_gcm.rb

@@ -0,0 +1,60 @@
+module Push
+  class MessageGcm < Push::Message
+    validates :collapse_key, :presence => true
+    # TODO: validates max size -> The message size limit is 4096 bytes.
+    # The total size of the payload data that is included in a message can't exceed 4096 bytes.
+    # Note that this includes both the size of the keys as well as the values.
+
+    store :properties, accessors: [:collapse_key, :delay_when_idle, :time_to_live, :payload]
+    attr_accessible :device, :collapse_key, :delay_when_idle, :time_to_live, :payload
+
+    def to_message
+      hsh = Hash.new
+      hsh['registration_ids'] = [device]
+      hsh['collapse_key'] = collapse_key
+      hsh['delay_when_idle'] = delay_when_idle if delay_when_idle
+      hsh['time_to_live'] = time_to_live if time_to_live
+      hsh['data'] = payload
+      MultiJson.dump(hsh)
+    end
+
+    def use_connection
+      Push::Daemon::GcmSupport::ConnectionGcm
+    end
+
+    private
+
+    def check_for_error(connection)
+      response = connection.response
+
+      if response.code.eql? "200"
+        hsh = MultiJson.load(response.body)
+        if hsh["failure"] == 1
+          msg = hsh["results"][0]["error"]
+
+          # MissingRegistration, handled by validation
+          # MismatchSenderId, configuration error by client
+          # MessageTooBig, TODO: add validation
+
+          if msg == "NotRegistered" or msg == "InvalidRegistration"
+            with_database_reconnect_and_retry(connection.name) do
+              Push::FeedbackGcm.create!(:failed_at => Time.now, :device => device) # follow-up: delete device
+            end
+          end
+
+          Push::Daemon.logger.error("[#{connection.name}] Error received.")
+          raise Push::DeliveryError.new(response.code, id, msg, "GCM")
+        elsif hsh["canonical_ids"] == 1
+          # success, but update device token
+          # follow-up: delete device
+          # with_database_reconnect_and_retry(connection.name) do
+          #   Push::FeedbackGcm.create!(:failed_at => Time.now, :device => device) # follow-up: update device
+          # end
+        end
+      else
+        Push::Daemon.logger.error("[#{connection.name}] Error received.")
+        raise Push::DeliveryError.new(response.code, id, response.body, "GCM")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: push-gcm
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Tom Pesman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70315674133460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70315674133460
+- !ruby/object:Gem::Dependency
+  name: push-core
+  requirement: &70315674131040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.0.1.pre2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70315674131040
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70315674130040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70315674130040
+description: GCM support for the modular push daemon.
+email:
+- tom@tnux.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/push-gcm.rb
+- lib/push-gcm/version.rb
+- lib/push/daemon/gcm.rb
+- lib/push/daemon/gcm_support/connection_gcm.rb
+- lib/push/feedback_gcm.rb
+- lib/push/message_gcm.rb
+- README.md
+- MIT-LICENSE
+homepage: https://github.com/tompesman/push-gcm
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: GCM (Android) part of the modular push daemon.
+test_files: []