Merge pull request #11 from userlist/messages

Add support for transactional messages endpoints

Author: benedikt

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - 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)
 

Gemfile

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

lib/userlist/push.rb

@@ -12,13 +12,14 @@
 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 @@ def relationships
       @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 @@ def company(payload = {})
       companies.create(payload)
     end
 
+    def message(payload = {})
+      messages.create(payload)
+    end
+
     alias track event
     alias identify user
   end

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

spec/support/active_job.rb

@@ -1,3 +1,4 @@
 require 'active_job'
 
 ActiveJob::Base.queue_adapter = :test
+ActiveJob::Base.logger = Logger.new(nil)

spec/userlist/push/message_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe Userlist::Push::Message do
+  let(:payload) do
+    {
+      template: 'template-identifier',
+      user: 'user-identifier',
+      properties: {
+        value: '$100.00'
+      }
+    }
+  end
+
+  subject { described_class.new(payload) }
+
+  it 'should raise an error when no payload is given' do
+    expect { described_class.new(nil) }.to raise_error(Userlist::ArgumentError, /payload/)
+  end
+
+  it 'should be pushable' do
+    expect(subject.push?).to be_truthy
+  end
+
+  context 'when a user hash is given' do
+    let(:payload) do
+      super().merge(
+        user: {
+          identifier: 'user-identifier',
+          email: 'foo@example.com'
+        }
+      )
+    end
+
+    it 'should convert it into a user object' do
+      expect(subject.user).to be_kind_of(Userlist::Push::User)
+    end
+
+    it 'should be pushable' do
+      expect(subject.push?).to be_truthy
+    end
+  end
+end

spec/userlist/push_spec.rb

@@ -160,4 +160,36 @@
       subject.company(payload)
     end
   end
+
+  describe '#messages' do
+    let(:relation) { subject.messages }
+
+    it 'should return a relation' do
+      expect(relation).to be_an_instance_of(Userlist::Push::Relation)
+      expect(relation.type).to eq(Userlist::Push::Message)
+    end
+
+    it 'should support the create operation' do
+      expect(relation).to be_kind_of(Userlist::Push::Operations::Create::ClassMethods)
+    end
+  end
+
+  describe '#message' do
+    let(:payload) do
+      {
+        template: 'template-identifier',
+        user: 'user-identifier',
+        properties: {
+          value: '$100.00'
+        }
+      }
+    end
+
+    let(:relation) { subject.messages }
+
+    it 'should delegate the call to the relation\'s create method' do
+      expect(relation).to receive(:create).with(payload)
+      subject.message(payload)
+    end
+  end
 end