Class: Webhookdb::Replicator::PostmarkInboundMessageV1

Inherits:
Base
  • Object
show all
Includes:
Appydays::Loggable
Defined in:
lib/webhookdb/replicator/postmark_inbound_message_v1.rb

Constant Summary

Constants inherited from Base

Base::MAX_INDEX_NAME_LENGTH

Constants included from DBAdapter::ColumnTypes

DBAdapter::ColumnTypes::BIGINT, DBAdapter::ColumnTypes::BIGINT_ARRAY, DBAdapter::ColumnTypes::BOOLEAN, DBAdapter::ColumnTypes::COLUMN_TYPES, DBAdapter::ColumnTypes::DATE, DBAdapter::ColumnTypes::DECIMAL, DBAdapter::ColumnTypes::DOUBLE, DBAdapter::ColumnTypes::FLOAT, DBAdapter::ColumnTypes::INTEGER, DBAdapter::ColumnTypes::INTEGER_ARRAY, DBAdapter::ColumnTypes::OBJECT, DBAdapter::ColumnTypes::TEXT, DBAdapter::ColumnTypes::TEXT_ARRAY, DBAdapter::ColumnTypes::TIMESTAMP, DBAdapter::ColumnTypes::UUID

Instance Attribute Summary

Attributes inherited from Base

#service_integration

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#_any_subscriptions_to_notify?, #_backfill_state_change_fields, #_backfillers, #_clear_backfill_information, #_clear_webook_information, #_coalesce_excluded_on_update, #_enqueue_backfill_jobs, #_extra_index_specs, #_fetch_enrichment, #_find_dependency_candidate, #_notify_dependents, #_parallel_backfill, #_publish_rowupsert, #_resource_to_data, #_store_enrichment_body?, #_to_json, #_upsert_update_expr, #_upsert_webhook, #_verify_backfill_err_msg, #_webhook_state_change_fields, #admin_dataset, #backfill, #calculate_and_backfill_state_machine, #calculate_backfill_state_machine, #calculate_dependency_state_machine_step, #calculate_preferred_create_state_machine, chunked_row_update_bounds, #clear_backfill_information, #clear_webhook_information, #create_table, #create_table_modification, #data_column, #dbadapter_table, #denormalized_columns, #descriptor, #dispatch_request_to, #documentation_url, #enqueue_sync_targets, #enrichment_column, #ensure_all_columns, #ensure_all_columns_modification, #find_dependent, #find_dependent!, #indices, #initialize, #on_backfill_error, #on_dependency_webhook_upsert, #preferred_create_state_machine_method, #preprocess_headers_for_logging, #primary_key_column, #process_state_change, #process_webhooks_synchronously?, #qualified_table_sequel_identifier, #readonly_dataset, #remote_key_column, #requires_sequence?, #resource_name_plural, #resource_name_singular, #schema_and_table_symbols, #storable_columns, #synchronous_processing_response_body, #timestamp_column, #upsert_has_deps?, #upsert_webhook, #upsert_webhook_body, #verify_backfill_credentials, #webhook_endpoint, #webhook_response

Constructor Details

This class inherits a constructor from Webhookdb::Replicator::Base

Class Method Details

.descriptor ⇒ Webhookdb::Replicator::Descriptor

Returns:



9
10
11
12
13
14
15
16
17
18
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 9

def self.descriptor
  return Webhookdb::Replicator::Descriptor.new(
    name: "postmark_inbound_message_v1",
    ctor: ->(sint) { Webhookdb::Replicator::PostmarkInboundMessageV1.new(sint) },
    feature_roles: [],
    resource_name_singular: "Postmark Inbound Message",
    supports_webhooks: true,
    api_docs_url: "https://postmarkapp.com/developer/user-guide/inbound/parse-an-email",
  )
end

Instance Method Details

#_denormalized_columns ⇒ Object 



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 24

def _denormalized_columns
  col = Webhookdb::Replicator::Column
  return [
    col.new(:from_email, TEXT, index: true, data_key: ["FromFull", "Email"]),
    col.new(:to_email, TEXT, index: true, data_key: ["ToFull", 0, "Email"]),
    col.new(:subject, TEXT, index: true, data_key: "Subject"),
    col.new(:timestamp, TIMESTAMP, index: true, data_key: "Date"),
    col.new(:tag, TEXT, index: true, data_key: "Tag"),
  ]
end

#_prepare_for_insert ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 35

def _prepare_for_insert(*)
  h = super
  ts_str = h[:timestamp]
  # We get some weird time formats, like 'Wed, 05 Jul 2023 22:27:31 +0000 (UTC)'.
  # Ruby can parse these, but PG cannot, so sanitize the ' (UTC)' out of here.
  # Depending on what other random stuff we see, we can make this more general later.
  h[:timestamp] = ts_str.gsub(/ \(UTC\)$/, "")
  return h
end

#_remote_key_column ⇒ Object 



20
21
22
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 20

def _remote_key_column
  return Webhookdb::Replicator::Column.new(:message_id, TEXT, data_key: "MessageID")
end

#_resource_and_event(request) ⇒ Object 



49
50
51
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 49

def _resource_and_event(request)
  return request.body, nil
end

#_timestamp_column_name ⇒ Object 



45
46
47
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 45

def _timestamp_column_name
  return :timestamp
end

#_update_where_expr ⇒ Object 



53
54
55
56
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 53

def _update_where_expr
  # These are immutable events, not updates, so never update after inserted.
  return Sequel[false]
end

#_webhook_response(request) ⇒ Object 



58
59
60
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 58

def _webhook_response(request)
  return Webhookdb::Postmark.webhook_response(request)
end

#backfill_not_supported_message ⇒ Object 



88
89
90
91
92
93
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 88

def backfill_not_supported_message
  return %(We don't yet support backfilling Postmark Inbound Messages.
File an issue at #{Webhookdb.oss_repo_url} or email [email protected] to let us know if this is something you want!

Run `webhookdb integration reset #{self.service_integration.opaque_id}` to go through webhook setup.)
end

#calculate_webhook_state_machine ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/webhookdb/replicator/postmark_inbound_message_v1.rb', line 62

def calculate_webhook_state_machine
  step = Webhookdb::Replicator::StateMachineStep.new
  if self.service_integration.webhook_secret.blank?
    step.output = %(You are about to set up webhooks for Postmark Inbound Messages.
When emails are sent to the email address configured in Postmark,
they will show up in WebhookDB automatically.

1. Go to https://account.postmarkapp.com/servers
2. Choose the server you want to replicator.
3. Choose the Inbound Stream to replicate.
2. Go to the 'Settings' tab.
3. Use this Webhook URL: #{self.webhook_endpoint}
5. Hit 'Check' and verify it works. If it does not, double check your settings.
6. Hit 'Save Webhook'.)
    step.set_prompt("Press Enter after Save Webhook succeeds:")
    step.transition_field(self.service_integration, "noop_create")
    self.service_integration.update(webhook_secret: "placeholder")
    return step
  end
  step.output = %(
All set! Inbound Messages will be synced as they come in.

#{self._query_help_output})
  return step.completed
end