expo-server-sdk 0.1.0

data/lib/push/receipts.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Expo
+  module Push
+    ##
+    # A single receipt for a single notification.
+    #
+    # - In case of an #ok? receipt, no action need be taken
+    # - In case of an #error? receipt, holds the #message, #explain
+    #
+    # Some failed receipts may expose which push token is not or no longer
+    # valid. This is exposed via #original_push_token.
+    #
+    class Receipt
+      attr_reader :data, :receipt_id
+
+      def initialize(data:, receipt_id:)
+        self.data = data
+        self.receipt_id = receipt_id
+      end
+
+      def original_push_token
+        return nil if ok?
+
+        if message.include?('PushToken[')
+          return /Expo(?:nent)?PushToken\[(?:[^\]]+?)\]/.match(message) { |match| match[0] }
+        end
+
+        /\A[a-z\d]{8}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{12}\z/i.match(message) { |match| match[0] }
+      end
+
+      def message
+        data.fetch('message')
+      end
+
+      def explain
+        Expo::Push::Error.explain((data['details'] || {})['error'])
+      end
+
+      def ok?
+        data['status'] == 'ok'
+      end
+
+      def error?
+        data['status'] == 'error'
+      end
+
+      private
+
+      attr_writer :data, :receipt_id
+    end
+
+    ##
+    # Receipts represent a single call to the receipts endpoint. It holds both
+    # the successfully retrieved receipts, as well as the still unresolved IDs.
+    #
+    # You MUST iterate #each_error and first check if its an Error, which would
+    # be the case if the entire call failed. Otherwise, it will iterate through
+    # each receipt that indicates a failed push.
+    #
+    # Keep calling the receipts endpoint until #unresolved_ids is empty, or a
+    # day has passed at least.
+    #
+    # @see Receipt
+    #
+    class Receipts
+      def initialize(results:, requested_ids:)
+        self.results = results
+        self.requested_ids = requested_ids
+      end
+
+      def each
+        receipts.each do |receipt|
+          next unless receipt.ok?
+
+          yield receipt
+        end
+      end
+
+      def each_error
+        results.each do |receipt|
+          next yield receipt if receipt.is_a?(Error)
+          next unless receipt.error?
+
+          yield receipt
+        end
+      end
+
+      def unresolved_ids
+        requested_ids - results.keys
+      end
+
+      private
+
+      attr_accessor :results, :requested_ids
+    end
+  end
+end

data/lib/push/tickets.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Expo
+  module Push
+    ##
+    # A ticket represents a single receipt ticket.
+    #
+    # - In case of an #ok? ticket, holds the receipt id in #id
+    # - In case of an #error? ticket, holds the #message, #explain
+    #
+    # Some failed tickets may expose which push token is not or no longer
+    # valid. This is exposed via #original_push_token.
+    #
+    class Ticket
+      attr_reader :data
+
+      def initialize(data)
+        self.data = data
+      end
+
+      def id
+        data.fetch('id')
+      end
+
+      def original_push_token
+        return nil if ok?
+
+        if message.include?('PushToken[')
+          return /Expo(?:nent)?PushToken\[(?:[^\]]+?)\]/.match(message) { |match| match[0] }
+        end
+
+        /\A[a-z\d]{8}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{12}\z/i.match(message) { |match| match[0] }
+      end
+
+      def message
+        data.fetch('message')
+      end
+
+      def explain
+        Expo::Push::Error.explain((data['details'] || {})['error'])
+      end
+
+      def ok?
+        data['status'] == 'ok'
+      end
+
+      def error?
+        data['status'] == 'error'
+      end
+
+      private
+
+      attr_writer :data
+    end
+
+    ##
+    # Tickets are paged: each batch when sending the notifications is one
+    # tickets entry. Each tickets entry has many tickets.
+    #
+    # To ease exploration and continuation of the tickets, use the
+    # folowing methods:
+    #
+    # - #batch_ids: slices all the receipts into chunks
+    # - #each: iterates over each single ticket that is NOT an error
+    # - #each_error: iterates over each errorered batch and failed ticket
+    #
+    # You MUST handle each error, and you MUST first check if its an Error
+    # or not, because of the way an entire batch call can fail.
+    #
+    # @see Ticket
+    #
+    class Tickets
+      def initialize(results)
+        self.results = results
+      end
+
+      def ids
+        [].tap do |ids|
+          each { |ticket| ids << ticket.id }
+        end
+      end
+
+      def batch_ids
+        ids.each_slice(PUSH_NOTIFICATION_RECEIPT_CHUNK_LIMIT).to_a
+      end
+
+      def each
+        results.each do |tickets|
+          next if tickets.is_a?(Error)
+
+          tickets.each do |ticket|
+            next unless ticket.ok?
+
+            yield ticket
+          end
+        end
+      end
+
+      def each_error
+        results.each do |tickets|
+          if tickets.is_a?(Error)
+            yield tickets
+          else
+            tickets.each do |ticket|
+              next unless ticket.error?
+
+              yield ticket
+            end
+          end
+        end
+      end
+
+      private
+
+      attr_accessor :results
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: expo-server-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derk-Jan Karrenbeld
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: This gem has been written to fix shortcomings with the current community
+  provided gem, which has many outstanding issues and open pull requests.
+email:
+- derk-jan+github@karrenbeld.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- expo-server-sdk.gemspec
+- lib/expo/server/sdk.rb
+- lib/expo/server/sdk/version.rb
+- lib/push/chunk.rb
+- lib/push/client.rb
+- lib/push/notification.rb
+- lib/push/receipts.rb
+- lib/push/tickets.rb
+homepage: https://github.com/sleeplessbyte/expo-server-sdk-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sleeplessbyte/expo-server-sdk-ruby
+  source_code_uri: https://github.com/sleeplessbyte/expo-server-sdk-ruby
+  bug_tracker_uri: https://github.com/sleeplessbyte/expo-server-sdk-ruby/issues
+  changelog_uri: https://github.com/sleeplessbyte/expo-server-sdk-ruby/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Modern replacement for exponent-server-sdk
+test_files: []