Class: HiGCM::Handler

Inherits:
Object
  • Object
show all
Defined in:
lib/higcm/handler.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Handler

Returns a new instance of Handler.



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/higcm/handler.rb', line 9

def initialize
  @retry_ids   = {}
  @unreg_ids   = {}
  @fail_ids    = {}
  @success_ids = {}
  @renew_ids   = {}

  @retry_conditions      = [ 'InternalServerError', 'Timout', 'Unavailable' ]
  @unregister_conditions = [ 'NotRegistered', 'InvalidRegistration' ]
end

Instance Attribute Details

#retry_conditions ⇒ Object

Returns the value of attribute retry_conditions.



7
8
9
 
# File 'lib/higcm/handler.rb', line 7

def retry_conditions
  @retry_conditions
end

#unregister_conditions ⇒ Object

Returns the value of attribute unregister_conditions.



7
8
9
 
# File 'lib/higcm/handler.rb', line 7

def unregister_conditions
  @unregister_conditions
end

Instance Method Details

#do_fail(&block) ⇒ Object 



105
106
107
 
# File 'lib/higcm/handler.rb', line 105

def do_fail(&block)
  @do_fail = block
end

#do_renew_token(&block) ⇒ Object

renew_ids(hash)



110
111
112
 
# File 'lib/higcm/handler.rb', line 110

def do_renew_token(&block)
  @do_renew_token = block
end

#do_retry(&block) ⇒ Object

retry_ids, opts, retry_after



101
102
103
 
# File 'lib/higcm/handler.rb', line 101

def do_retry(&block)
  @do_retry = block
end

#do_success(&block) ⇒ Object

success_ids



96
97
98
 
# File 'lib/higcm/handler.rb', line 96

def do_success(&block)
  @do_success = block
end

#do_unregister_token(&block) ⇒ Object 



114
115
116
 
# File 'lib/higcm/handler.rb', line 114

def do_unregister_token(&block)
  @do_unregister_token = block
end

#handle(registration_ids, opts, response) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/higcm/handler.rb', line 20

def handle(registration_ids, opts, response)
  begin
    @code = response.code.to_i
    @body = JSON.parse(response.body)
    #Honor Retry-After
    @retry_after = (response.headers['Retry-After'].nil? ? 0 : response.headers['Retry-After'])
  rescue Exception => e
    @code = 99
    @error_message = "unexpected error, response: #{response.body}, exception: #{e.inspect}"
  end

  case @code
  when 200
    #200 Message was processed successfully. The response body will contain more details about the message status, but its format will depend whether the request was JSON or plain text. See Interpreting a success response for more details.
    # handle success case, http://developer.android.com/guide/google/gcm/gcm.html#success
    @body['results'].each_with_index do | rs, index |
      reg_id = registration_ids[index]
      #handle fail
      if rs.key?('error')
        @error_message = rs['error']
        # figure out retry stuff
        if @retry_conditions.include?(rs['error'])
          @retry_ids[reg_id] = @retry_after
          @error_message << ", retry after #{@retry_after}"
        end
        # figure out unregister stuff
        if @unregister_conditions.include?(rs['error'])
          @unreg_ids[reg_id] = rs['error']
        end
        @fail_ids[reg_id] = @error_message
      #handle success
      elsif rs.key?('message_id')
        @success_ids[reg_id] = rs['message_id']
        if rs.key?('registration_id')
          @renew_ids[reg_id] = rs['registration_id']
        end
      else
        #should not jump here
      end
    end
    @do_success.call(@success_ids, response)        if @success_ids.count > 0 && @do_success
    @do_fail.call(@fail_ids, response)              if @fail_ids.count > 0 && @do_fail
    @do_renew_token.call(@renew_ids, response)      if @renew_ids.count > 0 && @do_renew_token
    @do_retry.call(@retry_ids, opts, response)      if @retry_ids.count > 0 && @do_retry
    @do_unregister_token.call(@unreg_ids, response) if @unreg_ids.count > 0 && @do_unregister_token

  #TODO need to check what kinf of response will return
  when 400, 401
    #400 Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields (for instance, passing a string where a number was expected). The exact failure reason is described in the response and the problem should be addressed before the request can be retried.
    #401 There was an error authenticating the sender account.
    registration_ids.each do | reg_id |
      if 400 == @code
        error_message = 'request could not be parsed as JSON'
      else
        error_message = 'There was an error authenticating the sender account'
      end
      @fail_ids[reg_id] = error_message
    end
    @do_fail.call(@fail_ids, response) if @do_fail &&  @fail_ids.count > 0
  #TODO need to check what kinf of response will return
  when 500, 503
    #500 There was an internal error in the GCM server while trying to process the request. trouble shooting http://developer.android.com/guide/google/gcm/gcm.html#internal_error
    #503 Indicates that the server is temporarily unavailable (i.e., because of timeouts, etc ). Sender must retry later, honoring any Retry-After header included in the response. Application servers must implement exponential back-off. The GCM server took too long to process the request. Troubleshoot
    registration_ids.each do | reg_id |
      @retry_ids[reg_id] = @retry_after
    end
    @do_retry.call(@retry_ids, opts) if @do_retry && @retry_ids.count > 0
  else
    registration_ids.each do | reg_id |
      @fail_ids[reg_id] = @error_message
    end
    @do_fail.call(@fail_ids, response) if @do_fail && @fail_ids.count > 0
  end
end