userlist 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b77ff6c1af95fbe8c6e90914fc03840ca25c53b5fa1cafd0e5f50c670f41117
-  data.tar.gz: 51f8e21e0641f04f1e33f52f97d86ae11935bb8d6596dec3acc3b8b9708a15ea
+  metadata.gz: 9ed2e089f640ba0d4865236a53b5744e9edfbbe4400337b789c6e09c80474870
+  data.tar.gz: ce7ad3b24cc47645ee91d69aa27f312628f840c427c52f49ae38823abf9ad1d8
 SHA512:
-  metadata.gz: dcd7b3e74eb02dad0b26682a8f35ca34c90511059d43c867e6b0c7ef6c051d1c8f45d9e57e9be88a40a24af3980f33a326239f541254806cf4da9fd7fb6db4f3
-  data.tar.gz: 62d43c452750bfca92a29c18ee1ff4f20fd924b18bc26afbe535567bdd159fde9bfbd8c33f25a53b6b6c3b0ca5ae5617f11077dadfeafafde0c352debdad3af8
+  metadata.gz: 6c0b7d45d3edcb1a07e10e759b6d3911ff594f6feceadc7fb17eef9961ea693853e570e9223ce837cc11cc04b025fd227ed42ba4c5e35501406f9a636d39f22b
+  data.tar.gz: 64146b1ba4fda2069e74e230e81c7d1447166b03775fe048ba821d7ec04702ab69ea85a116ffb0243f4f3a4e01b83e7e53c28fef7813f9351851428bd6343743

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.0
   NewCops: enable
   Exclude:
     - 'bin/*'

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased (main)
 
+## v1.1.0 (2025-10-17)
+
+- Allow specifying companies in messages
+- Add reply_to support to DeliveryMethod for ActionMailer integration
+- Fixes issue with deleting resources when they are not pushed by default
+
 ## v1.0.0 (2025-04-08)
 
 - Updates ActiveJob Worker to retry on errors with polynomially longer wait times, up to 10 attempts

data/Gemfile

@@ -4,6 +4,11 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
+gem 'jwt', '~> 2.2'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'webmock', '~> 3.18'
+
 gem 'guard-rspec', '~> 4.7'
 gem 'guard-rubocop', '~> 1.3'
 gem 'rubocop', '~> 1.45'

data/lib/userlist/config.rb

@@ -75,12 +75,12 @@ module Userlist
       key?(name.to_sym) || super
     end
 
-    def method_missing(name, *args, &block)
+    def method_missing(name, ...)
       if respond_to_missing?(name)
         name = name.to_s
         method = name =~ /=$/ ? :[]= : :[]
         name = name.sub(/=$/, '').to_sym
-        send(method, name, *args, &block)
+        send(method, name, ...)
       else
         super
       end

data/lib/userlist/delivery_method.rb

@@ -19,12 +19,15 @@ private
     {
       to: serialize_address(mail.to),
       from: serialize_address(mail.from),
+      reply_to: serialize_address(mail.reply_to),
       subject: mail.subject,
       body: serialize_body(mail.body)
     }.compact
   end
 
   def serialize_address(address)
+    return if address.nil? || Array(address).empty?
+
     Array(address).map(&:to_s)
   end
 

data/lib/userlist/push/company.rb

@@ -1,7 +1,7 @@
 module Userlist
   class Push
     class Company < Resource
-      include Operations::Create
+      include Operations::Push
       include Operations::Delete
 
       def self.endpoint

data/lib/userlist/push/event.rb

@@ -1,7 +1,7 @@
 module Userlist
   class Push
     class Event < Resource
-      include Operations::Create
+      include Operations::Push
 
       has_one :user, type: 'Userlist::Push::User'
       has_one :company, type: 'Userlist::Push::Company'

data/lib/userlist/push/message.rb

@@ -1,9 +1,10 @@
 module Userlist
   class Push
     class Message < Resource
-      include Operations::Create
+      include Operations::Push
 
       has_one :user, type: 'Userlist::Push::User'
+      has_one :company, type: 'Userlist::Push::Company'
 
       def initialize(payload = {}, config = Userlist.config)
         raise Userlist::ArgumentError, 'Missing required payload' unless payload

data/lib/userlist/push/operations/delete.rb

@@ -5,8 +5,9 @@ module Userlist
         module ClassMethods
           def delete(payload = {}, config = self.config)
             return false unless resource = from_payload(payload, config)
+            return false unless resource.delete?
 
-            strategy.call(:delete, endpoint, resource) if resource.delete?
+            strategy.call(:delete, endpoint, resource.for_context(:delete))
           end
         end
 

data/lib/userlist/push/operations/{create.rb → push.rb}

@@ -1,24 +1,22 @@
 module Userlist
   class Push
     module Operations
-      module Create
+      module Push
         module ClassMethods
-          def create(payload = {}, config = self.config)
+          def push(payload = {}, config = self.config)
             return false unless resource = from_payload(payload, config)
+            return false unless resource.push?
 
-            strategy.call(:post, endpoint, resource) if resource.create?
+            strategy.call(:post, endpoint, resource.for_context(:push))
           end
 
-          alias push create
+          alias create push
+          alias update push
         end
 
         def self.included(base)
           base.extend(ClassMethods)
         end
-
-        def create?
-          push?
-        end
       end
     end
   end

data/lib/userlist/push/relationship.rb

@@ -1,7 +1,7 @@
 module Userlist
   class Push
     class Relationship < Resource
-      include Operations::Create
+      include Operations::Push
       include Operations::Delete
 
       has_one :user, type: 'Userlist::Push::User'

data/lib/userlist/push/resource.rb

@@ -19,18 +19,18 @@ module Userlist
           new(payload, config)
         end
 
-        def relationship_names
-          @relationship_names ||= relationships.keys
+        def association_names
+          @association_names ||= associations.keys
         end
 
-        def relationships
-          @relationships ||= {}
+        def associations
+          @associations ||= {}
         end
 
       protected
 
         def has_one(name, type:) # rubocop:disable Naming/PredicateName
-          relationships[name.to_sym] = { type: type }
+          associations[name.to_sym] = { type: type }
 
           generated_methods.class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{name}                                        # def company
@@ -40,14 +40,14 @@ module Userlist
         end
 
         def has_many(name, **options) # rubocop:disable Naming/PredicateName
-          relationships[name.to_sym] = options
+          associations[name.to_sym] = options
 
           generated_methods.class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{name}                                                             # def companies
-              relationship = self.class.relationships[:#{name}]                     #   relationship = self.class.relationships[:companies]
+              associations = self.class.associations[:#{name}]                     #   associations = self.class.associations[:companies]
                                                                                     #
-              ResourceCollection.new(payload[:#{name}], relationship, self, config) # ResourceCollection.new(payload[:companies], relationship, self, config)
-            end                                                                     #
+              ResourceCollection.new(payload[:#{name}], associations, self, config) #   ResourceCollection.new(payload[:companies], associations, self, config)
+            end                                                                     # end
           RUBY
         end
 
@@ -58,13 +58,14 @@ module Userlist
         end
       end
 
-      attr_reader :payload, :config
+      attr_reader :payload, :config, :context
 
       def initialize(payload = {}, config = Userlist.config)
         raise Userlist::ArgumentError, 'Missing required payload' unless payload
 
         @payload = payload
         @config = config
+        @context = :push
       end
 
       def respond_to_missing?(method, include_private = false)
@@ -73,7 +74,7 @@ module Userlist
       end
 
       def to_hash
-        Serializer.serialize(self)
+        Serializer.serialize(self, context: context)
       end
       alias to_h to_hash
 
@@ -95,17 +96,23 @@ module Userlist
       alias == eql?
 
       def attribute_names
-        payload.keys.map(&:to_sym) - relationship_names
+        payload.keys.map(&:to_sym) - association_names
       end
 
-      def relationship_names
-        self.class.relationship_names.to_a
+      def association_names
+        self.class.association_names.to_a
       end
 
       def push?
         true
       end
 
+      def for_context(context)
+        dup.tap do |instance|
+          instance.instance_variable_set(:@context, context)
+        end
+      end
+
     private
 
       def method_missing(method, *args, &block)

data/lib/userlist/push/serializer.rb

@@ -3,8 +3,14 @@ require 'set'
 module Userlist
   class Push
     class Serializer
-      def self.serialize(resource)
-        new.serialize(resource)
+      def self.serialize(resource, **options)
+        new(**options).serialize(resource)
+      end
+
+      attr_reader :context
+
+      def initialize(context:)
+        @context = context
       end
 
       def serialize(resource)
@@ -12,6 +18,13 @@ module Userlist
         resource
       end
 
+      def serialize?(resource)
+        method_name = "#{context}?"
+
+        resource.respond_to?(method_name) &&
+          resource.public_send(method_name)
+      end
+
     private
 
       def serialize_resource(resource)
@@ -19,7 +32,7 @@ module Userlist
 
         serialized_resources << resource
 
-        return unless resource.push?
+        return unless serialize?(resource)
 
         serialized = {}
 
@@ -27,8 +40,8 @@ module Userlist
           serialized[name] = resource.send(name)
         end
 
-        resource.relationship_names.each do |name|
-          next unless result = serialize_relationship(resource.send(name))
+        resource.association_names.each do |name|
+          next unless result = serialize_association(resource.send(name))
 
           serialized[name] = result
         end
@@ -36,22 +49,22 @@ module Userlist
         serialized
       end
 
-      def serialize_relationship(relationship)
-        return unless relationship
+      def serialize_association(association)
+        return unless association
 
-        case relationship
+        case association
         when Userlist::Push::ResourceCollection
-          serialize_collection(relationship)
+          serialize_collection(association)
         when Userlist::Push::Resource
-          serialize_resource(relationship)
+          serialize_resource(association)
         else
-          raise "Cannot serialize relationship type: #{relationship.class}"
+          raise "Cannot serialize association type: #{association.class}"
         end
       end
 
       def serialize_collection(collection)
         serialized = collection
-          .map(&method(:serialize_relationship))
+          .map(&method(:serialize_association))
           .compact
           .reject(&:empty?)
 

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

@@ -27,7 +27,7 @@ module Userlist
         def options
           @options ||= begin
             options = config.push_strategy_options || {}
-            options.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+            options.transform_keys(&:to_sym)
           end
         end
 

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

@@ -25,7 +25,7 @@ module Userlist
         def options
           @options ||= begin
             options = config.push_strategy_options || {}
-            options.each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+            options.transform_keys(&:to_s)
           end
         end
 

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

@@ -18,14 +18,12 @@ module Userlist
             logger.info 'Starting worker thread...'
 
             loop do
-              begin
-                method, *args = *queue.pop
-                break if method == :stop
-
-                retryable.attempt { client.public_send(method, *args) }
-              rescue StandardError => e
-                logger.error "Failed to deliver payload: [#{e.class.name}] #{e.message}"
-              end
+              method, *args = *queue.pop
+              break if method == :stop
+
+              retryable.attempt { client.public_send(method, *args) }
+            rescue StandardError => e
+              logger.error "Failed to deliver payload: [#{e.class.name}] #{e.message}"
             end
 
             logger.info "Worker thread exited with #{queue.size} tasks still in the queue..."

data/lib/userlist/push/user.rb

@@ -1,7 +1,7 @@
 module Userlist
   class Push
     class User < Resource
-      include Operations::Create
+      include Operations::Push
       include Operations::Delete
 
       has_many :relationships, type: 'Userlist::Push::Relationship', inverse: :user

data/lib/userlist/push.rb

@@ -5,7 +5,7 @@ require 'userlist/push/resource'
 require 'userlist/push/resource_collection'
 require 'userlist/push/relation'
 
-require 'userlist/push/operations/create'
+require 'userlist/push/operations/push'
 require 'userlist/push/operations/delete'
 
 require 'userlist/push/user'
@@ -38,39 +38,39 @@ module Userlist
     attr_reader :config, :strategy
 
     def events
-      @events ||= Relation.new(self, Event, [Operations::Create])
+      @events ||= Relation.new(self, Event, [Operations::Push])
     end
 
     def users
-      @users ||= Relation.new(self, User, [Operations::Create, Operations::Delete])
+      @users ||= Relation.new(self, User, [Operations::Push, Operations::Delete])
     end
 
     def companies
-      @companies ||= Relation.new(self, Company, [Operations::Create, Operations::Delete])
+      @companies ||= Relation.new(self, Company, [Operations::Push, Operations::Delete])
     end
 
     def relationships
-      @relationships ||= Relation.new(self, Relationship, [Operations::Create, Operations::Delete])
+      @relationships ||= Relation.new(self, Relationship, [Operations::Push, Operations::Delete])
     end
 
     def messages
-      @messages ||= Relation.new(self, Message, [Operations::Create])
+      @messages ||= Relation.new(self, Message, [Operations::Push])
     end
 
     def event(payload = {})
-      events.create(payload)
+      events.push(payload)
     end
 
     def user(payload = {})
-      users.create(payload)
+      users.push(payload)
     end
 
     def company(payload = {})
-      companies.create(payload)
+      companies.push(payload)
     end
 
     def message(payload = {})
-      messages.create(payload)
+      messages.push(payload)
     end
 
     alias track event

data/lib/userlist/retryable.rb

@@ -33,17 +33,15 @@ module Userlist
 
     def attempt
       (0..@retries).each do |attempt|
-        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)
+        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
 
       logger.debug 'Retries exhausted, giving up'

data/lib/userlist/version.rb

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

data/userlist.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['benedikt@userlist.com']
 
   spec.summary       = 'Ruby wrapper for the Userlist API'
-  spec.homepage      = 'http://github.com/userlistio/userlist-ruby'
+  spec.homepage      = 'http://github.com/userlist/userlist-ruby'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -19,13 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4'
-
-  spec.add_development_dependency 'bundler', '>= 1.15'
-  spec.add_development_dependency 'jwt', '~> 2.2'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.18'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.metadata = { 'rubygems_mfa_required' => 'true' }
 end

metadata

@@ -1,84 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userlist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Benedikt Deicke
 bindir: exe
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: jwt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.18'
+date: 2025-10-17 00:00:00.000000000 Z
+dependencies: []
 email:
 - benedikt@userlist.com
 executables: []
@@ -107,8 +37,8 @@ files:
 - 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/operations/push.rb
 - lib/userlist/push/relation.rb
 - lib/userlist/push/relationship.rb
 - lib/userlist/push/resource.rb
@@ -128,7 +58,7 @@ files:
 - lib/userlist/token.rb
 - lib/userlist/version.rb
 - userlist.gemspec
-homepage: http://github.com/userlistio/userlist-ruby
+homepage: http://github.com/userlist/userlist-ruby
 licenses:
 - MIT
 metadata:
@@ -140,7 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="