Class: Messaging::Adapters::Postgres::Store

Inherits:
Object
  • Object
show all
Defined in:
lib/messaging/adapters/postgres/store.rb

Overview

Message store adapter using Postgres and ActiveRecord. Prefer accessing the message store through Messaging.message_store instead of using it directly.

Examples:

Using Postgres as the default message store adapter:

# Put this in an initializer
Messaging.setup do |config|
  config.message_store.adapter = :postgres
end

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Store

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Should not be used directly. Access the store though Messaging.message_store or Messaging::Adapters::Store



28
29
30
 
# File 'lib/messaging/adapters/postgres/store.rb', line 28

def initialize
  @streams = Streams.new
end

Instance Attribute Details

#streams ⇒ Streams (readonly)

Returns all the streams in the store.

Returns:

  • (Streams) —

    all the streams in the store

See Also:



23
24
25
 
# File 'lib/messaging/adapters/postgres/store.rb', line 23

def streams
  @streams
end

Instance Method Details

#call(message) ⇒ Messaging::Message

Writes the message to Postgres Skips messages that hasn't defined a stream name We do this to begin with so PG is opt-in per message

Parameters:

Returns:

  • (Messaging::Message) —

    A new copy of the message with the stream position added (if persisted)



82
83
84
85
86
 
# File 'lib/messaging/adapters/postgres/store.rb', line 82

def call(message)
  return message unless message.stream_name

  SerializedMessage.create!(message: message).to_message
end

#categories ⇒ Categories

Returns all the stream categories in the store.

Returns:

  • (Categories) —

    all the stream categories in the store

See Also:



41
42
43
 
# File 'lib/messaging/adapters/postgres/store.rb', line 41

def categories
  Categories.new
end

#category(name) ⇒ Category

Get a specific category by name

Returns:

See Also:



48
49
50
 
# File 'lib/messaging/adapters/postgres/store.rb', line 48

def category(name)
  categories[name]
end

#messages ⇒ SerializedMessage

Access to all messages. Use with caution in production as there are probably a lot of messages so queries could take a long time or timeout.

Examples:

Check that a message has been added to the store with Rspec

expect do
  # Your code that should add a message to the store
end.to change { Messaging.message_store.messages.count }.from(0).to(1)

Returns:



62
63
64
 
# File 'lib/messaging/adapters/postgres/store.rb', line 62

def messages
  SerializedMessage
end

#messages_in_streams(*streams) ⇒ ActiveRecord::Relation

Access to all messages in the given streams

Parameters:

  • streams (Array<String, Stream>) —

    List of one or more streams to get messages from

Returns:

  • (ActiveRecord::Relation)

See Also:



71
72
73
 
# File 'lib/messaging/adapters/postgres/store.rb', line 71

def messages_in_streams(*streams)
  SerializedMessage.where(stream: streams.flatten.map(&:to_s)).order(:id)
end

#stream(name) ⇒ Stream

Get a specific stream by name

Returns:

See Also:



35
36
37
 
# File 'lib/messaging/adapters/postgres/store.rb', line 35

def stream(name)
  streams[name]
end