expo-server-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0870d677aad54e5517e91013161aedada958f24ad0437e9acda0b315b7746e80'
+  data.tar.gz: cc9ef8fd683e4e386b028dd966b108ec5f242ed8985721858103b01f53974703
+SHA512:
+  metadata.gz: a160681a4b6f96cc776d657a732ef104138da93f77bf9f3d4c6faf773b69deb5231d263202a04b4ddb858436ac1c62a8672de3afabff038714493bcda7f22bfc
+  data.tar.gz: b0b47c52921e099ef1b0cf0f434e1c1454f2398b551d85c46058c35bd06269046d3591e9df1503f3e58bc4e12c241234d0468445707c9e7763b7936a6bb323e9

data/.gitattributes

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

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.4
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.7
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at derk-jan+github@karrenbeld.info. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in expo-server-sdk.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.7'

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    expo-server-sdk (0.1.0)
+      connection_pool (~> 2.2)
+      http (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    connection_pool (2.2.5)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.0-x64-mingw32)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (5.0.4)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.5)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7-x64-mingw32)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  expo-server-sdk!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Derk-Jan Karrenbeld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,252 @@
+# Expo::Server::SDK
+
+This gem was written because of the relatively little attention and improvement [expo-server-sdk-ruby](https://github.com/expo-community/expo-server-sdk-ruby) receives.
+
+It does **not** work in the same way, so you'll want to read the documentation carefully if you intend to migrate.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'expo-server-sdk'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install expo-server-sdk
+
+## Usage
+
+```ruby
+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>');
+
+# Create the messages that you want to send to clients
+messages = [];
+
+some_push_tokens.each do |push_token|
+  # Each push token looks like ExponentPushToken[xxxxxxxxxxxxxxxxxxxxxx]
+
+  # Check that all your push tokens appear to be valid Expo push tokens.
+  # If you don't do this, this library will raise an error when trying to
+  # create the notification.
+  #
+  unless Expo::Push.expo_push_token?(push_token)
+    puts "Push token #{pushToken} is not a valid Expo push token"
+    next
+  end
+
+  # Construct a message (see https://docs.expo.io/push-notifications/sending-notifications/)
+  #
+  # Use client.notification, Expo::Push::Notification.new,
+  # or Expo::Push::Notification.to, then follow it with one or more chainable
+  # API calls, including, but not limited to:
+  #
+  # - #to: add recipient (or #add_recipient),
+  #        add recipients (or #add_recipients)
+  # - #title
+  # - #subtitle
+  # - #body (or #content)
+  # - #data
+  # - #priority
+  # - #sound
+  # - #channel_id
+  # - #category_id
+  #
+  messages << client.notification
+    .to(pushToken)
+    .sound('default')
+    .body('This is a test notification')
+    .data({ withSome: 'data' })
+end
+
+# The Expo push notification service accepts batches of notifications so that
+# you don't need to send 1000 requests to send 1000 notifications. We
+# recommend you batch your notifications to reduce the number of requests and
+# to compress them (notifications with similar content will get compressed).
+#
+# Using #send or #send! will automatically batch your messages.
+#
+# When using #send, the result is an array of tickets per batched chunk, or may
+# be an error, such as a TicketsWithErrors error. It's up to you to inspect and
+# handle those errors.
+#
+# When using #send!, all batches will first execute, and then the first error
+# received is raised.
+#
+tickets = client.send!(messages)
+
+# You can #explain(error) to attempt to explain nested errors. For example, say
+# a batch contains failed errors, or completely failed pages:
+#
+tickets.each_error do |error|
+  if error.is_a?(Error)
+    puts error.message
+    # => "This indicates the entire request had an error"
+  else
+    puts error.explain
+    # => "The device cannot receive push notifications anymore and you should
+    #     stop sending messages to the corresponding Expo push token."
+
+    puts error.message
+    # => ""ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]" is not a registered push
+    #     notification recipient"
+    #
+    # In the case of an DeviceNotRegistered, you can attempt to extract the
+    # faulty push token:
+
+    error.original_push_token
+    # => ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]
+  end
+end
+
+# Later, after the Expo push notification service has delivered the
+# notifications to Apple or Google (usually quickly, but allow the the service
+# up to 30 minutes when under load), a "receipt" for each notification is
+# created. The receipts will be available for at least a day; stale receipts
+# are deleted.
+#
+# The ID of each receipt is sent back in the response "ticket" for each
+# notification. In summary, sending a notification produces a ticket, which
+# contains a receipt ID you later use to get the receipt.
+#
+# The receipts may contain error codes to which you must respond. In
+# particular, Apple or Google may block apps that continue to send
+# notifications to devices that have blocked notifications or have uninstalled
+# your app. Expo does not control this policy and sends back the feedback from
+# Apple and Google so you can handle it appropriately.
+#
+# Note: this will silently skip over any errors encountered. Use #each_error
+#       to attempt to handle them yourself.
+receipt_ids = tickets.ids
+
+# You may want to be doing this in some job context, so this gem doesn't batch
+# and call the endpoint manually, but you can generate the batches, and send
+# then individually:
+batches = tickets.batch_ids
+
+# Now you can schedule your jobs, thread, or run this inline. All would work.
+batches.each do |receipt_ids|
+  # << schedule a job with this batch of ids >>
+  # ...
+  # inside the job or inline
+  receipts = client.receipts(receipt_ids)
+
+  # You can #explain(error) to attempt to explain receipts that have an
+  # error status.
+  #
+  receipts.each_error do |receipt|
+    puts error.explain
+    # => "The device cannot receive push notifications anymore and you should
+    #     stop sending messages to the corresponding Expo push token."
+
+    puts error.message
+    # => ""ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]" is not a registered push
+    #     notification recipient"
+    #
+    # In the case of an DeviceNotRegistered, you can attempt to extract the
+    # faulty push token:
+
+    error.original_push_token
+    # => ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]
+  end
+
+  # Because not all receipts may be returned, it is imported to schedule, or
+  # retry the unresolved receipts at a later point in time:
+  unresolved_ids = receipts.unresolved_ids
+
+  # ...
+  receipts = client.receipts(unresolved_ids) if unresolved_ids.length > 0
+end
+```
+
+### Logging
+
+It is very likely that you'll want to develop with logging turned on.
+This can be accomplished by passing in a logger instance:
+
+```ruby
+require 'logger'
+
+logger = Logger.new(STDOUT);
+client = Expo::Push::Client.new(logger: logger)
+
+# Now when doing requests like so:
+client.send(notification)
+
+# ...it will log
+#
+# I, [2021-10-25T02:16:11.284901 #16448]  INFO -- : > POST https://exp.host/--/api/v2/push/send
+# D, [2021-10-25T02:16:11.285601 #16448] DEBUG -- : Accept: application/json
+# Accept-Encoding: gzip
+# User-Agent: expo-server-sdk-ruby/0.1.0
+# Connection: Keep-Alive
+# Content-Type: application/json; charset=UTF-8
+# Host: exp.host
+#
+# [{"to":["ExpoPushToken[xxxxxxxxxxxxxxxxxxxxxx]"]}]
+```
+
+For more advanced logging, or instrumentation in general, use the Instrumentation feature.
+It expects an `ActiveSupport::Notifications`-compatible instrumenter.
+
+These are available in most Rails projects by default.
+
+```ruby
+ActiveSupport::Notifications.subscribe('start_request.http') do |name, start, finish, id, payload|
+  pp :name => name, :start => start.to_f, :finish => finish.to_f, :id => id, :payload => payload
+end
+
+client = Expo::Push::Client.new(instrumentation: true)
+
+# Now when doing requests like so:
+client.send(notification)
+
+# ...it will instrument
+# => {name: .., start: .., finish: .., id: .., payload: ..}
+```
+
+You can configure the namespace (and instrumentation):
+
+```ruby
+client = Expo::Push::Client.new(
+  instrumentation: {
+    instrumenter: ActiveSupport::Notifications.instrumenter,
+    namespace: "my_http"
+  }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SleeplessByte/expo-server-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/SleeplessByte/expo-server-sdk/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `Expo::Server::SDK` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SleeplessByte/expo-server-sdk/blob/master/CODE_OF_CONDUCT.md).
+
+```
+
+```
+
+```
+
+```

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'expo/server/sdk'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/expo-server-sdk.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/expo/server/sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'expo-server-sdk'
+  spec.version       = Expo::Server::SDK::VERSION
+  spec.authors       = ['Derk-Jan Karrenbeld']
+  spec.email         = ['derk-jan+github@karrenbeld.info']
+
+  spec.summary       = 'Modern replacement for exponent-server-sdk'
+  spec.description   = 'This gem has been written to fix shortcomings with the current community provided gem, which ' \
+                       'has many outstanding issues and open pull requests.'
+  spec.homepage      = 'https://github.com/sleeplessbyte/expo-server-sdk-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.8')
+
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'connection_pool', '~> 2.2'
+  spec.add_dependency 'http', '~> 5.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Expo
+  module Server
+    module SDK
+      VERSION = '0.1.0'
+    end
+  end
+
+  module Push
+    class Client
+      VERSION = Expo::Server::SDK::VERSION
+    end
+  end
+end

data/lib/expo/server/sdk.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'sdk/version'
+require_relative '../../push/client'
+
+module Expo
+  module Server
+    module SDK # rubocop:disable Style/Documentation
+      def self.push
+        Expo::Push::Client
+      end
+    end
+  end
+end

data/lib/push/chunk.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Expo
+  module Push
+    class Chunk # rubocop:disable Style/Documentation
+      def self.for(notifications) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        Array(notifications).each_with_object([]) do |notification, chunks|
+          # There can be at most n notifications in a chunk. This finds the last chunk,
+          # checks how much space is left, and generates a new chunk if necessary.
+          chunk = chunks.last || Chunk.new.tap { |c| chunks << c }
+
+          targets = notification.recipients.dup
+
+          while targets.length.positive?
+            chunk = Chunk.new.tap { |c| chunks << c } if chunk.remaining <= 0
+
+            # Take at most <remaining> destinations for this notificiation.
+            count = [targets.length, chunk.remaining].min
+            chunk_targets = targets.slice(0, count)
+
+            # Prepare the notification
+            chunk << notification.prepare(chunk_targets)
+
+            # Remove targets from the targets list
+            targets = targets.drop(count)
+          end
+        end
+      end
+
+      attr_reader :remaining
+
+      def initialize
+        self.notifications = []
+        self.remaining = PUSH_NOTIFICATION_CHUNK_LIMIT
+      end
+
+      def <<(notification)
+        self.remaining -= notification.count
+        notifications << notification
+
+        self
+      end
+
+      def count
+        notifications.sum(&:count)
+      end
+
+      def as_json
+        notifications.map(&:as_json)
+      end
+
+      private
+
+      attr_accessor :notifications
+      attr_writer :remaining
+    end
+  end
+end