Class: Parse::PushStatus

Inherits:
Object show all
Defined in:
lib/parse/model/classes/push_status.rb

Overview

Note:

This collection requires master key access

This class represents the data and columns contained in the standard Parse ‘_PushStatus` collection. Push status records track the delivery status and metrics of push notifications sent through Parse Server.

Push status records are created automatically when a push is sent and are updated as the push progresses through the delivery pipeline.

Status lifecycle: pending → scheduled → running → succeeded/failed

The default schema for the PushStatus class is as follows:

class Parse::PushStatus < Parse::Object
   # See Parse::Object for inherited properties...

   property :push_hash        # Unique hash identifying the push
   property :query, :object   # The query used to target installations
   property :payload, :object # The push payload that was sent
   property :source           # "rest" or "webUI"
   property :status           # "pending", "scheduled", "running", "succeeded", "failed"
   property :num_sent, :integer
   property :num_failed, :integer
   property :sent_per_type, :object
   property :failed_per_type, :object
   property :sent_per_utc_offset, :object
   property :failed_per_utc_offset, :object
   property :count, :integer  # Total installations targeted
   property :push_time, :date # When the push was/will be sent
   property :expiry, :date    # When the push expires
end

Examples:

Checking push status

status = Parse::PushStatus.find(push_id)
puts "Sent: #{status.num_sent}, Failed: #{status.num_failed}"
puts "Status: #{status.status}"

Querying recent pushes

recent = Parse::PushStatus.recent.limit(10).all
recent.each { |s| puts "#{s.status}: #{s.num_sent} sent" }

See Also:

Constant Summary

Constants inherited from Object

Object::BUILTIN_PARSE_CLASS_NAMES, Object::IDENTIFICATION_FIELDS, Object::VALID_ACL_POLICIES

Constants included from Core::Schema

Core::Schema::DEFAULT_PUBLIC_CLP, Core::Schema::SCHEMA_READONLY_CLASSES

Constants included from Core::Describe

Core::Describe::ALL_SECTIONS, Core::Describe::CORE_FIELD_KEYS, Core::Describe::LOCAL_SECTIONS, Core::Describe::NETWORK_SECTIONS

Constants included from Core::Indexing

Core::Indexing::MAX_INDEXES_PER_COLLECTION, Core::Indexing::PARSE_MANAGED_ARRAY_FIELDS, Core::Indexing::SENSITIVE_FIELDS

Constants included from Core::SearchIndexing

Core::SearchIndexing::ALLOWED_INDEX_TYPES, Core::SearchIndexing::INDEX_NAME_PATTERN

Constants included from Core::Fetching

Core::Fetching::NON_SERIALIZABLE_IVARS

Constants included from Core::ParseReference

Core::ParseReference::OBJECT_ID_LENGTH, Core::ParseReference::SEPARATOR

Constants included from Core::FieldGuards

Core::FieldGuards::GUARD_MODES

Constants included from Properties

Parse::Properties::BASE, Parse::Properties::BASE_FIELD_MAP, Parse::Properties::BASE_KEYS, Parse::Properties::CORE_FIELDS, Parse::Properties::DELETE_OP, Parse::Properties::PROTECTED_INITIALIZE_KEYS, Parse::Properties::PROTECTED_MASS_ASSIGNMENT_KEYS, Parse::Properties::TYPES

Constants inherited from Pointer

Parse::Pointer::ATTRIBUTES, Parse::Pointer::OBJECT_ID_FORMAT

Constants inherited from Model

Model::CLASS_AUDIENCE, Model::CLASS_INSTALLATION, Model::CLASS_JOB_SCHEDULE, Model::CLASS_JOB_STATUS, Model::CLASS_PRODUCT, Model::CLASS_PUSH_STATUS, Model::CLASS_ROLE, Model::CLASS_SCHEMA, Model::CLASS_SESSION, Model::CLASS_USER, Model::ID, Model::KEY_CLASS_NAME, Model::KEY_CREATED_AT, Model::KEY_OBJECT_ID, Model::KEY_UPDATED_AT, Model::OBJECT_ID, Model::TYPE_ACL, Model::TYPE_BYTES, Model::TYPE_DATE, Model::TYPE_FIELD, Model::TYPE_FILE, Model::TYPE_GEOPOINT, Model::TYPE_NUMBER, Model::TYPE_OBJECT, Model::TYPE_POINTER, Model::TYPE_POLYGON, Model::TYPE_RELATION

Instance Attribute Summary collapse

Attributes inherited from Object

#acl, #created_at, #id, #updated_at

Attributes inherited from Pointer

#id, #parse_class

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#[], #[]=, #__type, #_resolve_acl_owner_id, #_resolve_default_acl, #acl_changed?, acl_owner_field, acl_policy, acl_policy_setting, #acl_was, #acl_will_change!, #after_create, #after_destroy, #after_save, #after_update, #after_validation, #apply_defaults!, #around_create, #around_destroy, #around_save, #around_update, #around_validation, #as_json, #autofetch_disabled?, #before_create, #before_destroy, #before_save, #before_update, #before_validation, build, #changed, #changed?, class_permissions, #clear_attribute_change!, #clear_changes!, #clear_partial_fetch_state!, default_acls, describe_access, #disable_autofetch!, #enable_autofetch!, #existed?, fetch_clp, #fetched?, #fetched_keys, #fetched_keys=, #field_was_fetched?, #filter_for_user, filter_results_for_user, #fully_fetched?, #has?, #has_selective_keys?, #initialize, #keys, master_only_class!, #nested_fetched_keys, #nested_fetched_keys=, #nested_keys_for, #new?, #parse_class, #partially_fetched?, #persisted?, pointer, #pretty, private_acl!, protect_fields, #reload!, roles_for_user, #rollback!, #run_after_create_callbacks, #run_after_delete_callbacks, #run_after_save_callbacks, #schema, set_class_access, set_clp, set_default_acl, set_default_clp, set_read_user_fields, set_write_user_fields, #twin, unlistable_class!, update_clp!, #updates, #valid?, #validate!, webhook, webhook_function

Methods included from Core::Querying

#all, #count_distinct, #cursor, #distinct, #each, #find, #find_cached, #first, #last_updated, #latest, #literal_where, #newest, #oldest, #scope, #subscribe

Methods included from Core::Schema

#_default_class_level_permissions_for_upgrade, #auto_upgrade!, #create_schema, #fetch_schema, #reset_clp!, #schema, #update_schema

Methods included from Core::Describe

#describe

Methods included from Core::Indexing

#apply_indexes!, #indexes_plan, #mongo_geo_index, #mongo_index, #mongo_index_declarations, #mongo_relation_index

Methods included from Core::SearchIndexing

#apply_search_indexes!, #mongo_search_index, #mongo_search_index_declarations, #search_indexes_plan

Methods included from Agent::MetadataDSL

#agent_description, #agent_methods, included, #property_descriptions, #property_enum_descriptions

Methods included from Core::Actions

#_deleted?, #change_requests, #changes_applied!, #changes_payload, #create, #destroy, #destroy_request, #op_add!, #op_add_relation!, #op_add_unique!, #op_destroy!, #op_increment!, #op_remove!, #op_remove_relation!, #operate_field!, #prepare_save!, #relation_change_operations, #save, #save!, #set_attributes!, #update, #update!, #update_relations, #uri_path

Methods included from Core::Fetching

#autofetch!, #fetch, #fetch!, #fetch_cache!, #fetch_json, #fetch_object, #prepare_for_dirty_tracking!

Methods included from Associations::HasMany

has_many, #relation_changes?, #relation_updates, #relations

Methods included from Associations::BelongsTo

belongs_to, #key?

Methods included from Associations::HasOne

has_one

Methods included from Core::ParseReference

format, generate_object_id, parse

Methods included from Core::FieldGuards

#apply_field_guards!

Methods included from Core::EnhancedChangeTracking

included

Methods included from Properties

#apply_attributes!, #attribute_changes?, #attribute_updates, #attributes, #attributes=, #field_map, #fields, #format_operation, #format_value

Methods inherited from Pointer

#==, #[], #[]=, #__type, #attributes, #className, #fetch, #fetch_cache!, #fetch_json, #fetch_object, #fetched?, #hash, #initialize, #json_hash, #method_missing, #pointer, #pointer?, #present?, #respond_to_missing?, #sig

Methods inherited from Model

#dirty?, find_class

Methods included from Client::Connectable

#client

Constructor Details

This class inherits a constructor from Parse::Object

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Parse::Pointer

Instance Attribute Details

#count ⇒ Integer

Total number of installations targeted by this push.

Returns:

  • (Integer) —

    The target count.



115
 
# File 'lib/parse/model/classes/push_status.rb', line 115

property :count, :integer

#error_message ⇒ String?

Error message if the push failed.

Returns:

  • (String, nil) —

    The error message or nil.



130
 
# File 'lib/parse/model/classes/push_status.rb', line 130

property :error_message

#expiry ⇒ Parse::Date

When the push expires and will no longer be delivered.

Returns:



125
 
# File 'lib/parse/model/classes/push_status.rb', line 125

property :expiry, :date

#failed_per_type ⇒ Hash

Breakdown of failed sends by device type.

Returns:

  • (Hash) —

    Device type to count mapping.



98
 
# File 'lib/parse/model/classes/push_status.rb', line 98

property :failed_per_type, :object

#failed_per_utc_offset ⇒ Hash

Breakdown of failed sends by UTC timezone offset.

Returns:

  • (Hash) —

    UTC offset to count mapping.



110
 
# File 'lib/parse/model/classes/push_status.rb', line 110

property :failed_per_utc_offset, :object

#num_failed ⇒ Integer

The number of notifications that failed to send.

Returns:

  • (Integer) —

    The failure count.



86
 
# File 'lib/parse/model/classes/push_status.rb', line 86

property :num_failed, :integer

#num_sent ⇒ Integer

The number of notifications successfully sent.

Returns:

  • (Integer) —

    The success count.



81
 
# File 'lib/parse/model/classes/push_status.rb', line 81

property :num_sent, :integer

#payload ⇒ Hash

The push payload that was sent.

Returns:

  • (Hash) —

    The payload data.



65
 
# File 'lib/parse/model/classes/push_status.rb', line 65

property :payload, :object

#push_hash ⇒ String

A unique hash identifying this push notification.

Returns:



55
 
# File 'lib/parse/model/classes/push_status.rb', line 55

property :push_hash

#push_time ⇒ Parse::Date

When the push was/will be sent. For scheduled pushes, this is the future time.

Returns:



120
 
# File 'lib/parse/model/classes/push_status.rb', line 120

property :push_time, :date

#query ⇒ Hash

The query constraints used to target installations.

Returns:

  • (Hash) —

    The query constraint hash.



60
 
# File 'lib/parse/model/classes/push_status.rb', line 60

property :query, :object

#sent_per_type ⇒ Hash

Breakdown of successful sends by device type (ios, android, etc.).

Examples:

status.sent_per_type  # => {"ios" => 800, "android" => 450}

Returns:

  • (Hash) —

    Device type to count mapping.



93
 
# File 'lib/parse/model/classes/push_status.rb', line 93

property :sent_per_type, :object

#sent_per_utc_offset ⇒ Hash

Breakdown of successful sends by UTC timezone offset.

Examples:

status.sent_per_utc_offset  # => {"-8" => 500, "0" => 300, "5" => 200}

Returns:

  • (Hash) —

    UTC offset to count mapping.



105
 
# File 'lib/parse/model/classes/push_status.rb', line 105

property :sent_per_utc_offset, :object

#source ⇒ String

The source of the push (“rest” for API, “webUI” for dashboard).

Returns:

  • (String) —

    The push source.



70
 
# File 'lib/parse/model/classes/push_status.rb', line 70

property :source

#status ⇒ String

The current status of the push. One of: “pending”, “scheduled”, “running”, “succeeded”, “failed”

Returns:

  • (String) —

    The push status.



76
 
# File 'lib/parse/model/classes/push_status.rb', line 76

property :status

Class Method Details

.failed ⇒ Parse::Query

Query for failed pushes.

Returns:



163
164
165
 
# File 'lib/parse/model/classes/push_status.rb', line 163

def failed
  query(status: "failed")
end

.pending ⇒ Parse::Query

Query for pending pushes (not yet started).

Returns:



139
140
141
 
# File 'lib/parse/model/classes/push_status.rb', line 139

def pending
  query(status: "pending")
end

.recent ⇒ Parse::Query

Query for recent pushes, ordered by creation time descending.

Returns:



169
170
171
 
# File 'lib/parse/model/classes/push_status.rb', line 169

def recent
  query.order(:created_at.desc)
end

.running ⇒ Parse::Query

Query for running pushes (currently being sent).

Returns:



151
152
153
 
# File 'lib/parse/model/classes/push_status.rb', line 151

def running
  query(status: "running")
end

.scheduled ⇒ Parse::Query

Query for scheduled pushes (waiting for push_time).

Returns:



145
146
147
 
# File 'lib/parse/model/classes/push_status.rb', line 145

def scheduled
  query(status: "scheduled")
end

.succeeded ⇒ Parse::Query

Query for succeeded pushes.

Returns:



157
158
159
 
# File 'lib/parse/model/classes/push_status.rb', line 157

def succeeded
  query(status: "succeeded")
end

Instance Method Details

#complete? ⇒ Boolean

Check if the push is complete (either succeeded or failed).

Returns:

  • (Boolean) —

    true if the push has finished



210
211
212
 
# File 'lib/parse/model/classes/push_status.rb', line 210

def complete?
  succeeded? || failed?
end

#failed? ⇒ Boolean

Check if the push failed.

Returns:

  • (Boolean) —

    true if status is “failed”



204
205
206
 
# File 'lib/parse/model/classes/push_status.rb', line 204

def failed?
  status == "failed"
end

#failure_rate ⇒ Float

Get the failure rate as a percentage.

Returns:

  • (Float) —

    the failure rate (0.0 to 100.0)



242
243
244
 
# File 'lib/parse/model/classes/push_status.rb', line 242

def failure_rate
  100.0 - success_rate
end

#in_progress? ⇒ Boolean

Check if the push is still in progress.

Returns:

  • (Boolean) —

    true if pending, scheduled, or running



216
217
218
 
# File 'lib/parse/model/classes/push_status.rb', line 216

def in_progress?
  !complete?
end

#pending? ⇒ Boolean

Check if the push is pending (not yet started).

Returns:

  • (Boolean) —

    true if status is “pending”



180
181
182
 
# File 'lib/parse/model/classes/push_status.rb', line 180

def pending?
  status == "pending"
end

#running? ⇒ Boolean

Check if the push is currently running.

Returns:

  • (Boolean) —

    true if status is “running”



192
193
194
 
# File 'lib/parse/model/classes/push_status.rb', line 192

def running?
  status == "running"
end

#scheduled? ⇒ Boolean

Check if the push is scheduled (waiting for push_time).

Returns:

  • (Boolean) —

    true if status is “scheduled”



186
187
188
 
# File 'lib/parse/model/classes/push_status.rb', line 186

def scheduled?
  status == "scheduled"
end

#succeeded? ⇒ Boolean

Check if the push succeeded.

Returns:

  • (Boolean) —

    true if status is “succeeded”



198
199
200
 
# File 'lib/parse/model/classes/push_status.rb', line 198

def succeeded?
  status == "succeeded"
end

#success_rate ⇒ Float

Get the success rate as a percentage.

Examples:

status.success_rate  # => 98.5

Returns:

  • (Float) —

    the success rate (0.0 to 100.0)



234
235
236
237
238
 
# File 'lib/parse/model/classes/push_status.rb', line 234

def success_rate
  total = total_attempted
  return 0.0 if total == 0
  ((num_sent || 0).to_f / total * 100).round(2)
end

#summary ⇒ Hash

Get a summary of the push metrics.

Examples:

status.summary
# => { status: "succeeded", sent: 1250, failed: 12, success_rate: 99.05 }

Returns:

  • (Hash) —

    summary hash with key metrics



251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/parse/model/classes/push_status.rb', line 251

def summary
  {
    status: status,
    sent: num_sent || 0,
    failed: num_failed || 0,
    total_targeted: count || 0,
    success_rate: success_rate,
    sent_per_type: sent_per_type || {},
    failed_per_type: failed_per_type || {},
  }
end

#total_attempted ⇒ Integer

Get the total number of notifications attempted (sent + failed).

Returns:

  • (Integer) —

    the total count



226
227
228
 
# File 'lib/parse/model/classes/push_status.rb', line 226

def total_attempted
  (num_sent || 0) + (num_failed || 0)
end