Class: Webhookdb::Replicator::EmailOctopusCampaignV1

Inherits:
Base
  • Object
show all
Includes:
Appydays::Loggable
Defined in:
lib/webhookdb/replicator/email_octopus_campaign_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, #_prepare_for_insert, #_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, #backfill_not_supported_message, #calculate_and_backfill_state_machine, #calculate_dependency_state_machine_step, #calculate_preferred_create_state_machine, #calculate_webhook_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, #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
19
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 9

def self.descriptor
  return Webhookdb::Replicator::Descriptor.new(
    name: "email_octopus_campaign_v1",
    ctor: ->(sint) { Webhookdb::Replicator::EmailOctopusCampaignV1.new(sint) },
    feature_roles: [],
    resource_name_singular: "Email Octopus Campaign",
    dependency_descriptor: Webhookdb::Replicator::EmailOctopusListV1.descriptor,
    supports_backfill: true,
    api_docs_url: "https://emailoctopus.com/api-documentation",
  )
end

Instance Method Details

#_denormalized_columns ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 25

def _denormalized_columns
  return [
    Webhookdb::Replicator::Column.new(:name, TEXT),
    Webhookdb::Replicator::Column.new(:created_at, TIMESTAMP, index: true, converter: :time),
    Webhookdb::Replicator::Column.new(:sent_at, TIMESTAMP, index: true, converter: :time),
    Webhookdb::Replicator::Column.new(:status, TEXT),
    Webhookdb::Replicator::Column.new(:from_name, TEXT, data_key: ["from", "name"]),
    Webhookdb::Replicator::Column.new(:from_email_address, TEXT, data_key: ["from", "email_address"]),
    Webhookdb::Replicator::Column.new(:subject, TEXT),
    Webhookdb::Replicator::Column.new(:row_updated_at, TIMESTAMP, defaulter: :now, optional: true),
  ]
end

#_fetch_backfill_page(pagination_token) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 70

def _fetch_backfill_page(pagination_token, **)
  api_key = self.service_integration.depends_on.replicator.backfill_key!
  limit = Webhookdb::EmailOctopus.page_size
  base_url = "https://emailoctopus.com"
  endpoint_path = pagination_token || "/api/1.6/campaigns?api_key=#{api_key}&limit=#{limit}"
  response = Webhookdb::Http.get(
    base_url + endpoint_path,
    logger: self.logger,
    timeout: Webhookdb::EmailOctopus.http_timeout,
  )
  data = response.parsed_response
  next_page_link = data.dig("paging", "next")
  return data["data"], next_page_link
end

#_remote_key_column ⇒ Object 



21
22
23
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 21

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

#_resource_and_event(request) ⇒ Object 



38
39
40
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 38

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

#_timestamp_column_name ⇒ Object 



46
47
48
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 46

def _timestamp_column_name
  return :row_updated_at
end

#_update_where_expr ⇒ Object 



42
43
44
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 42

def _update_where_expr
  return self.qualified_table_sequel_identifier[:data] !~ Sequel[:excluded][:data]
end

#_webhook_response(_request) ⇒ Object 



50
51
52
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 50

def _webhook_response(_request)
  return Webhookdb::WebhookResponse.ok
end

#calculate_backfill_state_machine ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/webhookdb/replicator/email_octopus_campaign_v1.rb', line 58

def calculate_backfill_state_machine
  if (step = self.calculate_dependency_state_machine_step(dependency_help: ""))
    return step
  end
  step = Webhookdb::Replicator::StateMachineStep.new
  # We're using the API Key from the dependency, we don't need to ask for it here
  step.output = %(Great! We are going to start replicating your #{self.resource_name_plural}.
#{self._query_help_output}
  )
  return step.completed
end

#on_dependency_webhook_upsert(_replicator, _payload) ⇒ Object 



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

def on_dependency_webhook_upsert(_replicator, _payload, *)
  return
end