ghazel-em-gcm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6111301e6d59ec7719dadce064d9080c566acd4b
+  data.tar.gz: 4e693f1b0ba08d6e80aed637226f0b15cdcb8b20
+SHA512:
+  metadata.gz: fd2fefb61e21ff9a34bba5996fef11fec5332bf4895fdfe86fc5ede09f6eba5da6dba9a849f9b4f36b281c99085661bb4207a4d7985f76e03bd6eb38334f0cc6
+  data.tar.gz: 591504c0cc765b2ddf33a80ab91b423777b29d16b0d9d59842986a2e4c1c1dade7ae7e611cf1d7104703d62e9b341d6b2fa3b80ec42873969f64a064e136a8ab

data/README.md

@@ -0,0 +1,58 @@
+em-gcm
+======
+
+Google Cloud Messaging for Android for Event Machine 
+
+See [Google's Documention](http://developer.android.com/guide/google/gcm/index.html) to learn more.
+
+This project is based on groupme/em-c2dm and doesn't include spec yet
+
+## Usage
+
+    require "em-gcm"
+
+    EM::GCM.token = "abcedfg..."
+
+    EM.run do
+      #plain old c2dm compatible send
+      EM::GCM.push_plain(["registration_id"], :alert => "hi!", :collapse_key => "required")
+      #new json style send and support broadcase
+      EM::GCM.push_json(["registration_id1", "registration_id2"], :alert => "hi!", :collapse_key => "required")
+    end
+    
+### Custom Params
+
+You can add custom params (which will be converted to `data.<KEY>`):
+  
+    EM::GCM.push_plain(["registration_id"],
+      :alert        => "Hello!",
+      :collapse_key => "required",
+      :custom       => "data",
+      :awesome      => true
+    )
+            
+
+### Response Callback
+
+You can register a response callback to check success and handle errors:
+
+    EM::GCM.push_plain(["registration_id1"], :alert => "hi!") do |response|
+      if response.success?
+        puts "success! id=#{response.id}" # ID of sent message
+      else
+        case response.error
+        when "InvalidToken"
+          # reauthenticate
+        when "InvalidRegistration"
+          # clear our registration id
+        when "RetryAfter"
+          # pause sending for response.retry_after seconds
+        end        
+      end
+    end
+
+
+
+## Contributing
+
+Please feel free to fork and update this!

data/em-gcm.gemspec

@@ -0,0 +1,22 @@
+# -*- mode: ruby; encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-gcm/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ghazel-em-gcm"
+  s.version     = EventMachine::GCM::VERSION
+  s.authors     = ["Zeng Xin"]
+  s.email       = ["samuelzx@hotmail.com"]
+  s.homepage    = "https://github.com/zengxin/em-gcm"
+  s.summary     = %q{Google Cloud Messaging for Android for Event Machine}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "eventmachine", ">= 1.0.0.beta.3"
+  s.add_dependency "em-http-request", ">= 1.0.0.beta.4"
+  s.add_dependency "uuid"
+
+end

data/lib/em-gcm.rb

@@ -0,0 +1,43 @@
+$:.unshift File.dirname(__FILE__)
+
+require "eventmachine"
+require "em-http-request"
+require "logger"
+require "uuid"
+require "em-gcm/client"
+require "em-gcm/notification"
+
+$uuid = UUID.new
+
+module EventMachine
+  module GCM
+    class << self
+      def push_plain(registration_ids, options, &block)
+        notification = Notification.new(registration_ids, options)
+        Client.new(notification).deliver_plain(block)
+      end
+
+      def push_json(registration_ids, options, &block)
+        notification = Notification.new(registration_ids, options)
+        Client.new(notification).deliver_json(block)
+      end
+
+      def token=(token)
+        logger.info("setting new auth token")
+        @token = token
+      end
+
+      def token
+        @token
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def logger=(new_logger)
+        @logger = new_logger
+      end
+    end
+  end
+end

data/lib/em-gcm/client.rb

@@ -0,0 +1,64 @@
+require "em-gcm/response"
+require "em-gcm/log_message"
+
+module EventMachine
+  module GCM
+    class Client
+      URL = "https://android.googleapis.com/gcm/send"
+
+      def initialize(notification)
+        @notification = notification
+      end
+
+      def deliver_plain(block = nil)
+        verify_token
+        @start = Time.now.to_f
+
+        http = EventMachine::HttpRequest.new(URL).post(
+          :query  => @notification.params,
+          :head   => @notification.headers_plain
+        )
+
+        http.callback do
+          response = Response.new(http, @start)
+          LogMessage.new(@notification, response).log
+          block.call(response) if block          
+        end
+
+        http.errback do |e|
+          EM::GCM.logger.error(e.inspect)
+        end
+      end
+
+     def deliver_json(block = nil)
+        verify_token
+        @start = Time.now.to_f
+
+        params = {:dry_run => "true"}
+
+        http = EventMachine::HttpRequest.new(URL).post(
+          #uncomment this if you want to test send and do not want receiver to receive message
+          #:query => params,
+          :body => @notification.body,
+          :head   => @notification.headers_json
+        )
+
+        http.callback do
+          response = Response.new(http, @start, false)
+          LogMessage.new(@notification, response).log
+          block.call(response) if block
+        end
+
+        http.errback do |e|
+          EM::GCM.logger.error(e.inspect)
+        end
+      end
+
+      private
+
+      def verify_token
+        raise "token not set!" unless EM::GCM.token
+      end
+    end
+  end
+end

data/lib/em-gcm/log_message.rb

@@ -0,0 +1,30 @@
+module EventMachine
+  module GCM
+    class LogMessage
+      def initialize(notification, response)
+        @notification, @response = notification, response
+      end
+
+      def log
+        if @response.success?
+          EM::GCM.logger.info(message)
+        else
+          EM::GCM.logger.error(message)
+        end
+      end
+
+      private
+
+      def message
+        parts = [
+          "CODE=#{@response.status}",
+          "GUID=#{@notification.uuid}",
+          "TIME=#{@response.duration}",
+          "TOKEN=#{@notification.registration_ids}"
+        ]
+        parts << "ERROR=#{@response.error}" unless @response.success?
+        parts.join(" ")
+      end
+    end
+  end
+end

data/lib/em-gcm/notification.rb

@@ -0,0 +1,60 @@
+require 'json'
+
+module EventMachine
+  module GCM
+    class Notification
+      attr_reader :uuid, :options, :registration_ids
+
+      def initialize(registration_ids, options = {})
+        @registration_ids, @options = registration_ids, options
+        raise ArgumentError.new("missing options") if options.nil? || options.empty?
+        @uuid = $uuid.generate
+      end
+
+      def params
+        @params ||= generate_params
+      end
+
+      def body
+        @body ||= generate_body
+      end
+
+      def headers_plain
+        {
+          "Authorization"   => "key=#{EM::GCM.token}",
+          "Content-Type"    => "application/x-www-form-urlencoded;charset=UTF-8",
+          "User-Agent"      => "em-c2dm 1.0.0"
+        }
+      end
+
+      def headers_json
+        {
+          "Authorization"   => "key=#{EM::GCM.token}",
+          "Content-Type"    => "application/json",
+          "User-Agent"      => "em-c2dm 1.0.0"
+        }
+      end
+
+
+      private
+
+      def generate_params
+        params = { "registration_id" => @registration_ids[0] }
+        params["collapse_key"] = @options.delete(:collapse_key) || @options.delete("collapse_key")
+        @options.each do |k,v|
+          params["data.#{k}"] = v
+        end
+        params
+      end
+  
+      def generate_body
+        body_hash = {}
+        body_hash[:collapse_key] = @options.delete(:collapse_key) || @options.delete("collapse_key")
+        body_hash[:data] = @options
+        body_hash[:registration_ids] = @registration_ids
+        body_hash.to_json
+      end
+      
+    end
+  end
+end

data/lib/em-gcm/response.rb

@@ -0,0 +1,76 @@
+module EventMachine
+  module GCM
+    # Header errors
+    #   InvalidToken          - Authentication token is invalid. Reauthenticate.
+    #   Retry_After           - Service is down for maintenance. Call retry_after for seconds to wait.
+    #
+    # Body errors
+    #   Quota_Exceeded        - Too many messages sent by the sender. Retry after a while.
+    #   Device_Quota_Exceeded - Too any messages sent by the sender to a specific device. Retry after a while.
+    #   InvalidRegistration   - Missing or bad registration_id. Sender should stop sending messages to this device.
+    #   NotRegistered         - The registration_id is no longer valid, for example user has uninstalled the application or turned off notifications. Sender should stop sending messages to this device.
+    #   MessageTooBig         - The payload of the message is too big, see the limitations. Reduce the size of the message.
+    #   MissingCollapseKey    - Collapse key is required. Include collapse key in the request.
+    class Response
+      # Common
+      attr_accessor :id
+      attr_accessor :status
+      attr_accessor :duration
+      attr_accessor :error
+      attr_accessor :body
+
+      # Service-specific
+      attr_accessor :retry_after
+      
+      def initialize(http = {}, start = nil, is_plain = true)
+        @http = http
+        @duration = Time.now.to_f - start.to_f if start
+        if http.kind_of?(Hash)
+          @id           = http[:id]
+          @status       = http[:status]
+          @retry_after  = http[:retry_after]
+          @error        = http[:error]
+        else
+          parse_body(http.response)
+          parse_headers(http.response_header)
+        end
+        @is_plain = is_plain
+      end
+
+      def success?
+        @error.nil?
+      end
+
+      private
+
+      def parse_body(body)
+        if @is_plain
+          body =~ (/^id=(.*)$/)
+          @id = $1
+
+          body =~ (/^Error=(.*)$/)
+          @error = $1
+        else
+          @body = body
+        end
+      end
+
+      # These are messed up because of EM::HttpRequest's messed up parsing
+      def parse_headers(headers)
+        @status = headers.status
+        @retry_after = headers["RETRY_AFTER"].to_i
+        
+        case @status
+        when 200
+          # noop
+        when 401
+          @error = "InvalidToken"
+        when 502, 503
+          @error = "RetryAfter"
+        else
+          @error = "Unknown error: #{headers.status} (#{@http.response})"
+        end
+      end
+    end
+  end
+end

data/lib/em-gcm/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  module GCM
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: ghazel-em-gcm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zeng Xin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.3
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.4
+- !ruby/object:Gem::Dependency
+  name: uuid
+  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'
+description: 
+email:
+- samuelzx@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- em-gcm.gemspec
+- lib/em-gcm.rb
+- lib/em-gcm/client.rb
+- lib/em-gcm/log_message.rb
+- lib/em-gcm/notification.rb
+- lib/em-gcm/response.rb
+- lib/em-gcm/version.rb
+homepage: https://github.com/zengxin/em-gcm
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Google Cloud Messaging for Android for Event Machine
+test_files: []