expo-server-sdk 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88fbd428de8ccf50c783cd846f236d259560fc6dc4eeed67f6bced8e1851dc8f
-  data.tar.gz: 6f720c4b67e2d19d75a72cce990deae055f55fecdac6d0e04fc10a3cfe6175b5
+  metadata.gz: '0935c1dadd6d4a8be6e196c2b3dea8cbb76558a8cabe65e30225771101d2b894'
+  data.tar.gz: 9f739d6f73288893da490177165d08968de65124a0504d45149060e77674dcf2
 SHA512:
-  metadata.gz: a7bfc9795ac626e819cccc0dcb023cef728fa3d4e7721a6e4f2af67c79c7bd41d5744794f1eb29571cd957ea8eaa951692db0f6b18e3c70e2f8fb456d68d6375
-  data.tar.gz: 113707ebc856f9488cde8ac359cb0e02f329a12c238c8e0bab0b89eef83a43e51339e53d4be5a02f5b6db33006f31a924845465139677f2117184abbfffbbd93
+  metadata.gz: 4c3a776c41bff8d2ccf2c839025778ce04d654be4b52c7e5a0dcf9d9b176ae2fd9fcb54e0f9ac722065052b6f5518b1d2abadc5aaefe46b11cb57bf202351e5a
+  data.tar.gz: 33af04057e1d2d4367df24bb554900e6364eec5201624ec90098fc846b7bac29eb3a1949dc9290678381547a2eac7720a7bfc1be1c881203172141abe1c1dedc

data/.gitattributes

@@ -1 +1 @@
-* text=auto eol=lf
+* text=auto eol=lf

data/Gemfile.lock

@@ -1,29 +1,29 @@
 PATH
   remote: .
   specs:
-    expo-server-sdk (0.1.4)
+    expo-server-sdk (0.1.5)
       connection_pool (~> 2.2)
       http (>= 4.0, < 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.2)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    connection_pool (2.2.5)
+    connection_pool (2.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    ffi (1.15.4-x64-mingw32)
+    ffi (1.15.5-x64-mingw32)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (5.0.4)
+    http (5.1.1)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       llhttp-ffi (~> 0.4.0)
-    http-cookie (1.0.4)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
     llhttp-ffi (0.4.0)
@@ -33,7 +33,7 @@ GEM
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
+    public_suffix (5.0.1)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
@@ -52,7 +52,7 @@ GEM
     ruby-progressbar (1.11.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8-x64-mingw32)
+    unf_ext (0.0.8.2-x64-mingw32)
     unicode-display_width (2.1.0)
 
 PLATFORMS

data/README.md

@@ -29,11 +29,15 @@ gem install expo-server-sdk
 ## Usage
 
 ```ruby
-require 'expo-server-sdk'
+# Not necessary in Rails. Zeitwerk will require this correctly for you.
+require 'expo/server/sdk'
 
 # Create a new Expo SDK client optionally providing an access token if you
 # have enabled push security
-client = Expo::Push::Client.new(accessToken: '<access-token>');
+client = Expo::Push::Client.new(access_token: '<access-token>');
+
+# If you do not have an access token, you can call it like this:
+# client = Expo::Push::Client.new
 
 # Create the messages that you want to send to clients
 messages = [];
@@ -111,7 +115,7 @@ tickets.each_error do |error|
   else
     puts error.message
     # => "This indicates the entire request had an error"
-  else
+  end
 end
 
 # Later, after the Expo push notification service has delivered the
@@ -231,6 +235,105 @@ client = Expo::Push::Client.new(
 )
 ```
 
+### Example of error handling
+
+Here is an example of error handling when using Rails, given a Rails model called `PushNotificationToken`.
+
+The most important thing is that you remove push tokens that are invalid, you fix push tokens that don't have the right experience ID and you stop sending push notifications if you're not allowed (e.g. the device is no longer registered).
+
+```ruby
+# Remove invalid push notification tokens, and remove tokens that failed
+# and contain a token (DeviceNotRegistered)
+tickets.each_error do |error|
+
+  if error.is_a?(Expo::Push::PushTokenInvalid)
+    # Destroy the tokens that match because they are not valid
+    PushNotificationToken.where(push_token: error.token).destroy_all
+  
+  elsif error.is_a?(Expo::Push::TicketsWithErrors)
+    retryable = true
+
+    error.errors.each do |error_data|
+      
+      # This block tries to fix the token experiences, and then reschedules
+      # the job. When it fixes tokens, it notifies bugsnag, so we know that
+      # this happened. If it keeps happening, there is a bug in the query
+      # or registration code.
+      if error_data['code'] == "PUSH_TOO_MANY_EXPERIENCE_IDS"
+      
+        # Go through all the details
+        error_data['details'].each do |correct_experience, tokens|
+        
+          # Find the incorrect instances
+          instances = PushNotificationToken
+            .where.not(experience_id: correct_experience)
+            .where(push_token: tokens)
+
+          next if instances.blank?
+          next unless instances.update_all(experience_id: correct_experience)
+
+          instances.each do |instance|
+            Bugsnag.notify(
+              StandardError.new(
+                format(
+                  'When trying to push, a push token (token: %s) had the wrong experience id (old: %s). ' \
+                  'It has been updated (%s).',
+                  instance.push_token,
+                  instance.experience_id_was,
+                  instance.experience_id
+                )
+              )
+            )
+          end
+        end
+        
+      # If there is a different error, report to our error tracker
+      else
+        retryable = false
+        # Otherwise, notify as actual error.
+        Bugsnag.notify(error_data)
+      end
+    end
+      
+    if retries > 10
+      return Bugsnag.notify(
+        StandardError.new(
+          'Not sending push notification because it was retried > 10 times.'
+        )
+      )
+    end
+
+    # If the error is not a fatal one, the push can be retried. This helps
+    # with making sure you always send the push notification(s) even when
+    # the service intermittendly fails.
+    if retryable
+      ScheduledPushNotificationJob
+        .set(wait: 1.minute * (retries + 1))
+        .perform_later(
+          notification: notification,
+          event: event,
+          updated_at: updated_at,
+          retries: retries + 1
+        )
+    end
+      
+  # Otherwise it's an explanable error
+  elsif error.respond_to?(:explain)
+      
+    # If the error contains a token it always needs to be removed
+    original_token = error.original_push_token
+    next unless original_token
+
+    PushNotificationToken.where(push_token: original_token).destroy_all
+  else
+    
+    # Notify us of any other type of error
+    Bugsnag.notify(error)
+  end
+end
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/expo/server/sdk/version.rb

@@ -3,7 +3,7 @@
 module Expo
   module Server
     module SDK
-      VERSION = '0.1.4'
+      VERSION = '0.1.5'
     end
   end
 

data/lib/push/notification.rb

@@ -330,8 +330,6 @@ module Expo
       end
 
       def as_json
-        puts _params
-
         { to: recipients }.merge(_params.compact)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expo-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool