Class: Houston::Notification

Inherits:
Object
  • Object
show all
Defined in:
lib/houston/notification.rb

Defined Under Namespace

Classes: APNSError

Constant Summary collapse

MAXIMUM_PAYLOAD_SIZE = 
2048

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Notification

Returns a new instance of Notification.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/houston/notification.rb', line 40

def initialize(options = {})
  @token = options.delete(:token) || options.delete(:device)
  @alert = options.delete(:alert)
  @badge = options.delete(:badge)
  @sound = options.delete(:sound)
  @category = options.delete(:category)
  @expiry = options.delete(:expiry)
  @id = options.delete(:id)
  @priority = options.delete(:priority)
  @content_available = options.delete(:content_available)
  @mutable_content = options.delete(:mutable_content)
  @url_args = options.delete(:url_args)
  @thread_id = options.delete(:thread_id)

  @custom_data = options

  @sent_at = nil
  @apns_error_code = nil
end

Instance Attribute Details

#alert ⇒ Object

Returns the value of attribute alert.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def alert
  @alert
end

#apns_error_code=(value) ⇒ Object (writeonly)

Sets the attribute apns_error_code

Parameters:

  • value —

    the value to set the attribute apns_error_code to.



35
36
37
 
# File 'lib/houston/notification.rb', line 35

def apns_error_code=(value)
  @apns_error_code = value
end

#badge ⇒ Object

Returns the value of attribute badge.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def badge
  @badge
end

#category ⇒ Object

Returns the value of attribute category.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def category
  @category
end

#content_available ⇒ Object

Returns the value of attribute content_available.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def content_available
  @content_available
end

#custom_data ⇒ Object

Returns the value of attribute custom_data.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def custom_data
  @custom_data
end

#expiry ⇒ Object

Returns the value of attribute expiry.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def expiry
  @expiry
end

#id ⇒ Object

Returns the value of attribute id.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def id
  @id
end

#mutable_content ⇒ Object

Returns the value of attribute mutable_content.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def mutable_content
  @mutable_content
end

#priority ⇒ Object

Returns the value of attribute priority.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def priority
  @priority
end

#sent_at ⇒ Object (readonly)

Returns the value of attribute sent_at.



34
35
36
 
# File 'lib/houston/notification.rb', line 34

def sent_at
  @sent_at
end

#sound ⇒ Object

Returns the value of attribute sound.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def sound
  @sound
end

#thread_id ⇒ Object

Returns the value of attribute thread_id.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def thread_id
  @thread_id
end

#token ⇒ Object Also known as: device

Returns the value of attribute token.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def token
  @token
end

#url_args ⇒ Object

Returns the value of attribute url_args.



32
33
34
 
# File 'lib/houston/notification.rb', line 32

def url_args
  @url_args
end

Instance Method Details

#error ⇒ Object 



101
102
103
 
# File 'lib/houston/notification.rb', line 101

def error
  APNSError.new(@apns_error_code) if @apns_error_code && @apns_error_code.nonzero?
end

#mark_as_sent! ⇒ Object 



85
86
87
 
# File 'lib/houston/notification.rb', line 85

def mark_as_sent!
  @sent_at = Time.now
end

#mark_as_unsent! ⇒ Object 



89
90
91
 
# File 'lib/houston/notification.rb', line 89

def mark_as_unsent!
  @sent_at = nil
end

#message ⇒ Object 



76
77
78
79
80
81
82
83
 
# File 'lib/houston/notification.rb', line 76

def message
  data = [device_token_item,
          payload_item,
          identifier_item,
          expiration_item,
          priority_item].compact.join
  [2, data.bytes.count, data].pack('cNa*')
end

#payload ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/houston/notification.rb', line 60

def payload
  json = {}.merge(@custom_data || {}).inject({}) { |h, (k, v)| h[k.to_s] = v; h }

  json['aps'] ||= {}
  json['aps']['alert'] = @alert if @alert
  json['aps']['badge'] = @badge.to_i rescue 0 if @badge
  json['aps']['sound'] = @sound if @sound
  json['aps']['category'] = @category if @category
  json['aps']['content-available'] = 1 if @content_available
  json['aps']['mutable-content'] = 1 if @mutable_content
  json['aps']['url-args'] = @url_args if @url_args
  json['aps']['thread-id'] = @thread_id if @thread_id

  json
end

#sent? ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/houston/notification.rb', line 93

def sent?
  !!@sent_at
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/houston/notification.rb', line 97

def valid?
  payload.to_json.bytesize <= MAXIMUM_PAYLOAD_SIZE
end