userlist 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 569696fa5acbb7f0c5520aff129c6418666e4006039e128dbbe97590a74d10ae
-  data.tar.gz: 73a0880766c7e8a17f9a0cae70eb07afdef8a202202f4ab17d4888d8e3ea459f
+  metadata.gz: 4b77ff6c1af95fbe8c6e90914fc03840ca25c53b5fa1cafd0e5f50c670f41117
+  data.tar.gz: 51f8e21e0641f04f1e33f52f97d86ae11935bb8d6596dec3acc3b8b9708a15ea
 SHA512:
-  metadata.gz: 9f63af4821d7d61af74c0c593ce97a597a6aa1c647b3d61b81fd69e9973daa4d9aedb6cc2a5744bb6fbae2170814e7955e3ff97b59a216146ecf1254be84cc35
-  data.tar.gz: 8ec2008d7bf08e60b0d4dc0f43586e9dc62a17dea20f8c704efd8d186236683c4b2a4fd624b99f839247ef22d255f23bf258282d7ea52e7cfe31bcf97171b556
+  metadata.gz: dcd7b3e74eb02dad0b26682a8f35ca34c90511059d43c867e6b0c7ef6c051d1c8f45d9e57e9be88a40a24af3980f33a326239f541254806cf4da9fd7fb6db4f3
+  data.tar.gz: 62d43c452750bfca92a29c18ee1ff4f20fd924b18bc26afbe535567bdd159fde9bfbd8c33f25a53b6b6c3b0ca5ae5617f11077dadfeafafde0c352debdad3af8

data/.github/workflows/test.yml

@@ -8,9 +8,11 @@ jobs:
           - 3.0
           - 3.1
           - 3.2
+          - 3.3
+          - 3.4
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Userlist for Ruby Changelog
 
+## Unreleased (main)
+
+## v1.0.0 (2025-04-08)
+
+- Updates ActiveJob Worker to retry on errors with polynomially longer wait times, up to 10 attempts
+- Improve internal error handling to rely on exceptions
+- Adds support for messages
+
 ## v0.9.0 (2024-03-19)
 
 - Allows deleteing resources by using other identifiers (like email)

data/Gemfile

@@ -11,3 +11,5 @@ gem 'rubocop', '~> 1.45'
 gem 'sidekiq'
 gem 'activejob'
 gem 'uri'
+gem 'irb'
+gem 'mail'

data/README.md

@@ -1,4 +1,4 @@
-# Userlist for Ruby  [![Build Status](https://github.com/userlist/userlist-ruby/workflows/Tests/badge.svg)](https://github.com/userlist/userlist-ruby)
+# Userlist for Ruby [![Build Status](https://github.com/userlist/userlist-ruby/workflows/Tests/badge.svg)](https://github.com/userlist/userlist-ruby)
 
 This gem helps with integrating [Userlist](https://userlist.com) into Ruby applications.
 
@@ -186,6 +186,23 @@ Userlist::Push.events.push(
 )
 ```
 
+### Sending Transactional Messages
+
+To send transactional messages, use the `Userlist::Push.messages.push` method.
+
+```ruby
+message = {
+  user: 'user-1',
+  template: 'welcome-email',
+  properties: {
+    account_name: 'Example, Inc.',
+    billing_plan: 'Pro'
+  }
+}
+
+Userlist::Push.messages.push(message)
+```
+
 ### Tokens for in-app messages
 
 In order to use in-app messages, you must create a JWT token for the currently signed in user on the server side. To do this, please configure both the `push_key` and the `push_id` configuration variables. Afterwards, you can use the `Userlist::Token.generate` method to get a signed token for the given user identifier.

data/lib/userlist/delivery_method.rb

@@ -0,0 +1,52 @@
+class Userlist::DeliveryMethod
+  attr_reader :userlist, :settings
+
+  def initialize(settings = {})
+    @settings = settings
+
+    @userlist = Userlist::Push.new(settings)
+  end
+
+  def deliver!(mail)
+    message = serialize(mail)
+
+    userlist.messages.push(message.merge(theme: nil))
+  end
+
+private
+
+  def serialize(mail)
+    {
+      to: serialize_address(mail.to),
+      from: serialize_address(mail.from),
+      subject: mail.subject,
+      body: serialize_body(mail.body)
+    }.compact
+  end
+
+  def serialize_address(address)
+    Array(address).map(&:to_s)
+  end
+
+  def serialize_body(body)
+    return if body.nil?
+
+    if body.multipart?
+      parts = body.parts.filter_map { |part| serialize_part(part) }
+
+      return parts.first if parts.size == 1
+
+      { type: :multipart, content: parts }
+    else
+      { type: :text, content: body.decoded }
+    end
+  end
+
+  def serialize_part(part)
+    if part.content_type.start_with?('text/html')
+      { type: :html, content: part.decoded }
+    elsif part.content_type.start_with?('text/plain')
+      { type: :text, content: part.decoded }
+    end
+  end
+end

data/lib/userlist/push/client.rb

@@ -49,18 +49,35 @@ module Userlist
       end
 
       def request(method, path, payload = nil)
+        request = build_request(method, path, payload)
+
+        logger.debug "Sending #{request.method} to #{URI.join(endpoint, request.path)} with body #{request.body}"
+
+        response = process_request(request)
+
+        logger.debug "Recieved #{response.code} #{response.message} with body #{response.body}"
+
+        handle_response(response)
+      end
+
+      def build_request(method, path, payload)
         request = method.new(path)
         request['Accept'] = 'application/json'
         request['Authorization'] = "Push #{token}"
         request['Content-Type'] = 'application/json; charset=UTF-8'
         request.body = JSON.generate(payload) if payload
+        request
+      end
 
-        logger.debug "Sending #{request.method} to #{URI.join(endpoint, request.path)} with body #{request.body}"
-
+      def process_request(request)
         http.start unless http.started?
-        response = http.request(request)
+        http.request(request)
+      rescue Timeout::Error => e
+        raise Userlist::TimeoutError, e.message
+      end
 
-        logger.debug "Recieved #{response.code} #{response.message} with body #{response.body}"
+      def handle_response(response)
+        raise(Userlist::RequestError, response) if response.code.to_i >= 400
 
         response
       end

data/lib/userlist/push/message.rb

@@ -0,0 +1,19 @@
+module Userlist
+  class Push
+    class Message < Resource
+      include Operations::Create
+
+      has_one :user, type: 'Userlist::Push::User'
+
+      def initialize(payload = {}, config = Userlist.config)
+        raise Userlist::ArgumentError, 'Missing required payload' unless payload
+
+        super
+      end
+
+      def push?
+        super && (user.nil? || user.push?)
+      end
+    end
+  end
+end

data/lib/userlist/push/strategies/active_job/worker.rb

@@ -5,6 +5,8 @@ module Userlist
     module Strategies
       class ActiveJob
         class Worker < ::ActiveJob::Base
+          retry_on Userlist::TimeoutError, Userlist::RequestError, wait: :polynomially_longer, attempts: 10
+
           def perform(method, *args)
             client = Userlist::Push::Client.new
             client.public_send(method, *args)

data/lib/userlist/push/strategies/direct.rb

@@ -19,11 +19,7 @@ module Userlist
         end
 
         def retryable
-          @retryable ||= Userlist::Retryable.new do |response|
-            status = response.code.to_i
-
-            status >= 500 || status == 429
-          end
+          @retryable ||= Userlist::Retryable.new
         end
       end
     end

data/lib/userlist/push/strategies/threaded/worker.rb

@@ -46,11 +46,7 @@ module Userlist
           end
 
           def retryable
-            @retryable ||= Userlist::Retryable.new do |response|
-              status = response.code.to_i
-
-              status >= 500 || status == 429
-            end
+            @retryable ||= Userlist::Retryable.new
           end
         end
       end

data/lib/userlist/push.rb

@@ -12,13 +12,14 @@ require 'userlist/push/user'
 require 'userlist/push/company'
 require 'userlist/push/relationship'
 require 'userlist/push/event'
+require 'userlist/push/message'
 
 require 'userlist/push/serializer'
 
 module Userlist
   class Push
     class << self
-      [:event, :track, :user, :identify, :company, :users, :events, :companies, :relationships].each do |method|
+      [:event, :track, :user, :identify, :company, :message, :users, :events, :companies, :relationships, :messages].each do |method|
         define_method(method) { |*args| default_push_instance.send(method, *args) }
       end
 
@@ -52,6 +53,10 @@ module Userlist
       @relationships ||= Relation.new(self, Relationship, [Operations::Create, Operations::Delete])
     end
 
+    def messages
+      @messages ||= Relation.new(self, Message, [Operations::Create])
+    end
+
     def event(payload = {})
       events.create(payload)
     end
@@ -64,6 +69,10 @@ module Userlist
       companies.create(payload)
     end
 
+    def message(payload = {})
+      messages.create(payload)
+    end
+
     alias track event
     alias identify user
   end

data/lib/userlist/retryable.rb

@@ -7,12 +7,24 @@ module Userlist
     MULTIPLIER = 2
     MAX_DELAY = 10_000
 
+    DEFAULT_RETRY_CHECK = lambda do |error|
+      case error
+      when Userlist::RequestError
+        status = error.status
+        status >= 500 || status == 429
+      when Userlist::TimeoutError
+        true
+      else
+        false
+      end
+    end
+
     def initialize(retries: RETRIES, delay: DELAY, max_delay: MAX_DELAY, multiplier: MULTIPLIER, &retry_check)
       @retries = retries
       @delay = delay
       @max_delay = max_delay
       @multiplier = multiplier
-      @retry_check = retry_check
+      @retry_check = retry_check || DEFAULT_RETRY_CHECK
     end
 
     def retry?(value)
@@ -21,15 +33,17 @@ module Userlist
 
     def attempt
       (0..@retries).each do |attempt|
-        if attempt.positive?
-          milliseconds = delay(attempt)
-          logger.debug "Retrying in #{milliseconds}ms, #{@retries - attempt} retries left"
-          sleep(milliseconds / 1000.0)
+        begin
+          if attempt.positive?
+            milliseconds = delay(attempt)
+            logger.debug "Retrying in #{milliseconds}ms, #{@retries - attempt} retries left"
+            sleep(milliseconds / 1000.0)
+          end
+
+          return yield
+        rescue Userlist::Error => e
+          raise e unless retry?(e)
         end
-
-        result = yield
-
-        return result unless retry?(result)
       end
 
       logger.debug 'Retries exhausted, giving up'

data/lib/userlist/version.rb

@@ -1,3 +1,3 @@
 module Userlist
-  VERSION = '0.9.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/userlist.rb

@@ -6,6 +6,7 @@ require 'userlist/logging'
 require 'userlist/retryable'
 require 'userlist/push'
 require 'userlist/token'
+require 'userlist/delivery_method'
 
 module Userlist
   class Error < StandardError; end
@@ -18,7 +19,7 @@ module Userlist
     def initialize(key)
       @key = key.to_sym
 
-      super <<~MESSAGE
+      super(<<~MESSAGE)
         Missing required configuration value for `#{key}`
 
         Please set a value for `#{key}` using an environment variable:
@@ -34,6 +35,22 @@ module Userlist
     end
   end
 
+  class TimeoutError < Error; end
+
+  class RequestError < Error
+    attr_reader :response
+
+    def initialize(response)
+      super("Request failed with status #{response.code}: #{response.body}")
+
+      @response = response
+    end
+
+    def status
+      @response.code.to_i
+    end
+  end
+
   class << self
     def config
       @config ||= Userlist::Config.new

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: userlist
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Benedikt Deicke
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2025-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +79,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.18'
-description:
 email:
 - benedikt@userlist.com
 executables: []
@@ -102,11 +100,13 @@ files:
 - bin/setup
 - lib/userlist.rb
 - lib/userlist/config.rb
+- lib/userlist/delivery_method.rb
 - lib/userlist/logging.rb
 - lib/userlist/push.rb
 - lib/userlist/push/client.rb
 - lib/userlist/push/company.rb
 - lib/userlist/push/event.rb
+- lib/userlist/push/message.rb
 - lib/userlist/push/operations/create.rb
 - lib/userlist/push/operations/delete.rb
 - lib/userlist/push/relation.rb
@@ -133,7 +133,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby wrapper for the Userlist API
 test_files: []