Module: Webhookdb::Replicator::IntercomV1Mixin

Included in:
IntercomContactV1, IntercomConversationV1
Defined in:
lib/webhookdb/replicator/intercom_v1_mixin.rb

Instance Method Summary collapse

Instance Method Details

#_fetch_backfill_page(pagination_token, **_kwargs) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 74

def _fetch_backfill_page(pagination_token, **_kwargs)
  unless self.auth_credentials?
    raise Webhookdb::Replicator::CredentialsMissing,
          "This integration requires that the Intercom Auth integration has a valid Auth Token"
  end

  query = {per_page: Webhookdb::Intercom.page_size}
  # Intercom started 500ing with this set to empty.
  query[:starting_after] = pagination_token if pagination_token
  begin
    response = Webhookdb::Http.get(
      self._mixin_backfill_url,
      query:,
      headers: self.intercom_auth_headers,
      logger: self.logger,
      timeout: Webhookdb::Intercom.http_timeout,
    )
  rescue Webhookdb::Http::Error => e
    #  We are looking to catch the "api plan restricted" error. This is always a 403 and every
    # 403 will be an "api plan restricted" error according to the API documentation. Because we
    # specify the API version in our headers we can expect that this won't change.
    raise e unless e.status == 403
    self.logger.warn("intercom_api_restricted", intercom_error: e.body)
    # We should basically noop here, i.e. pretend that the page is empty, so that we don't trigger
    # a TypeError in the backfiller.
    return [], nil
  end
  data = response.parsed_response.fetch("data", [])
  starting_after = response.parsed_response.dig("pages", "next", "starting_after")
  return data, starting_after
end

#_mixin_backfill_url ⇒ Object

Raises:

  • (NotImplementedError) 


70
71
72
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 70

def _mixin_backfill_url
  raise NotImplementedError
end

#_resource_and_event(request) ⇒ Object 



27
28
29
30
31
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 27

def _resource_and_event(request)
  body = request.body
  return body.fetch("data").fetch("item"), body if body.fetch("type") == "notification_event"
  return body, nil
end

#_timestamp_column_name ⇒ Object 



37
38
39
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 37

def _timestamp_column_name
  return :updated_at
end

#_update_where_expr ⇒ Object 



33
34
35
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 33

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

#_webhook_response(request) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 41

def _webhook_response(request)
  # info for debugging
  intercom_auth = request.env["HTTP_X_HUB_SIGNATURE"]

  return Webhookdb::WebhookResponse.error("missing hmac") if intercom_auth.nil?
  request.body.rewind
  request_data = request.body.read
  verified = Webhookdb::Intercom.verify_webhook(request_data, intercom_auth)
  return Webhookdb::WebhookResponse.ok if verified
  return Webhookdb::WebhookResponse.error("invalid hmac")
end

#auth_credentials? ⇒ Boolean

Returns:

  • (Boolean) 


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

def auth_credentials?
  auth = self.find_auth_integration
  return auth.backfill_key.present?
end

#calculate_backfill_state_machine ⇒ Webhookdb::Replicator::StateMachineStep

Returns:



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 54

def calculate_backfill_state_machine
  # can inherit credentials from the auth dependency
  if (step = self.calculate_dependency_state_machine_step(dependency_help: ""))
    return step
  end
  step = Webhookdb::Replicator::StateMachineStep.new
  step.output = %(We will start replicating #{self.resource_name_singular} information into your WebhookDB database.

#{self._query_help_output(prefix: "Once data is available, you can query #{self.resource_name_plural}.")})
  return step.completed
end

#find_auth_integration ⇒ Object

Quick note on these Intercom integrations: although we will technically be bringing in information from webhooks, all webhooks for the WebhookDB app will use a single endpoint and we use the WebhookDB app’s Client Secret for webhook verification, which means that webhooks actually don’t require any setup on the integration level. Thus, ‘supports_webhooks` is false.



10
11
12
13
14
15
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 10

def find_auth_integration
  # rubocop:disable Naming/MemoizedInstanceVariableName
  return @auth ||= Webhookdb::Replicator.find_at_root!(self.service_integration,
                                                       service_name: "intercom_marketplace_root_v1",)
  # rubocop:enable Naming/MemoizedInstanceVariableName
end

#intercom_auth_headers ⇒ Object 



17
18
19
20
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 17

def intercom_auth_headers
  root_sint = self.find_auth_integration
  return Webhookdb::Intercom.auth_headers(root_sint.backfill_key)
end

#on_dependency_webhook_upsert(_replicator, _payload) ⇒ Object 



66
67
68
 
# File 'lib/webhookdb/replicator/intercom_v1_mixin.rb', line 66

def on_dependency_webhook_upsert(_replicator, _payload, *)
  return
end