Class: Webhookdb::Replicator::ShopifyOrderV1

Inherits:
Base
  • Object
show all
Includes:
Appydays::Loggable, ShopifyV1Mixin
Defined in:
lib/webhookdb/replicator/shopify_order_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 included from ShopifyV1Mixin

#_fetch_backfill_page, #_resource_and_event, #_timestamp_column_name, #_verify_backfill_401_err_msg, #_verify_backfill_403_err_msg, #_verify_backfill_err_msg, #_webhook_response, #calculate_backfill_state_machine, #calculate_webhook_state_machine, #process_state_change

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_and_event, #_resource_to_data, #_store_enrichment_body?, #_timestamp_column_name, #_to_json, #_upsert_update_expr, #_upsert_webhook, #_verify_backfill_err_msg, #_webhook_response, #_webhook_state_change_fields, #admin_dataset, #backfill, #backfill_not_supported_message, #calculate_and_backfill_state_machine, #calculate_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, #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:



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/webhookdb/replicator/shopify_order_v1.rb', line 11

def self.descriptor
  return Webhookdb::Replicator::Descriptor.new(
    name: "shopify_order_v1",
    ctor: ->(sint) { Webhookdb::Replicator::ShopifyOrderV1.new(sint) },
    feature_roles: [],
    resource_name_singular: "Shopify Order",
    supports_webhooks: true,
    supports_backfill: true,
    api_docs_url: "https://shopify.dev/docs/api/admin-rest/2023-10/resources/order",
  )
end

Instance Method Details

#_denormalized_columns ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/webhookdb/replicator/shopify_order_v1.rb', line 27

def _denormalized_columns
  return [
    Webhookdb::Replicator::Column.new(:app_id, TEXT),
    Webhookdb::Replicator::Column.new(:cancelled_at, TIMESTAMP, index: true),
    Webhookdb::Replicator::Column.new(:cart_token, TEXT),
    Webhookdb::Replicator::Column.new(:checkout_token, TEXT),
    Webhookdb::Replicator::Column.new(:closed_at, TIMESTAMP, index: true),
    Webhookdb::Replicator::Column.new(:created_at, TIMESTAMP, index: true),
    Webhookdb::Replicator::Column.new(:customer_id, TEXT,
                                      index: true, data_key: ["customer", "id"], optional: true,),
    Webhookdb::Replicator::Column.new(:email, TEXT, index: true),
    Webhookdb::Replicator::Column.new(:name, TEXT),
    Webhookdb::Replicator::Column.new(:order_number, INTEGER, index: true),
    Webhookdb::Replicator::Column.new(:phone, TEXT, index: true),
    Webhookdb::Replicator::Column.new(:token, TEXT),
    Webhookdb::Replicator::Column.new(:updated_at, TIMESTAMP, index: true),
    Webhookdb::Replicator::Column.new(:user_id, TEXT, index: true),
  ]
end

#_mixin_backfill_hashkey ⇒ Object 



55
56
57
 
# File 'lib/webhookdb/replicator/shopify_order_v1.rb', line 55

def _mixin_backfill_hashkey
  return "orders"
end

#_mixin_backfill_url ⇒ Object 



51
52
53
 
# File 'lib/webhookdb/replicator/shopify_order_v1.rb', line 51

def _mixin_backfill_url
  return "/admin/api/2021-04/orders.json?status=any"
end

#_mixin_backfill_warning ⇒ Object 



59
60
61
62
63
 
# File 'lib/webhookdb/replicator/shopify_order_v1.rb', line 59

def _mixin_backfill_warning
  return %(Note that Shopify only allows access to orders made in the last 60 days,
so this history will not be comprehensive.
Please email #{Webhookdb.support_email} if you need a complete history backfill.)
end

#_remote_key_column ⇒ Object 



23
24
25
 
# File 'lib/webhookdb/replicator/shopify_order_v1.rb', line 23

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

#_update_where_expr ⇒ Object 



47
48
49
 
# File 'lib/webhookdb/replicator/shopify_order_v1.rb', line 47

def _update_where_expr
  return self.qualified_table_sequel_identifier[:updated_at] < Sequel[:excluded][:updated_at]
end