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
# 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)

  @custom_data = options

  @sent_at = nil
  @apns_error_code = nil
end

Instance Attribute Details

#alertObject

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

#badgeObject

Returns the value of attribute badge


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

def badge
  @badge
end

#categoryObject

Returns the value of attribute category


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

def category
  @category
end

#content_availableObject

Returns the value of attribute content_available


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

def content_available
  @content_available
end

#custom_dataObject

Returns the value of attribute custom_data


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

def custom_data
  @custom_data
end

#expiryObject

Returns the value of attribute expiry


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

def expiry
  @expiry
end

#idObject

Returns the value of attribute id


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

def id
  @id
end

#mutable_contentObject

Returns the value of attribute mutable_content


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

def mutable_content
  @mutable_content
end

#priorityObject

Returns the value of attribute priority


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

def priority
  @priority
end

#sent_atObject (readonly)

Returns the value of attribute sent_at


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

def sent_at
  @sent_at
end

#soundObject

Returns the value of attribute sound


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

def sound
  @sound
end

#tokenObject 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_argsObject

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

#errorObject


99
100
101
# File 'lib/houston/notification.rb', line 99

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

#mark_as_sent!Object


83
84
85
# File 'lib/houston/notification.rb', line 83

def mark_as_sent!
  @sent_at = Time.now
end

#mark_as_unsent!Object


87
88
89
# File 'lib/houston/notification.rb', line 87

def mark_as_unsent!
  @sent_at = nil
end

#messageObject


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

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

#payloadObject


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

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
end

#sent?Boolean

Returns:

  • (Boolean)

91
92
93
# File 'lib/houston/notification.rb', line 91

def sent?
  !!@sent_at
end

#valid?Boolean

Returns:

  • (Boolean)

95
96
97
# File 'lib/houston/notification.rb', line 95

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