-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
source.py
235 lines (213 loc) · 9.26 KB
/
source.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
import logging
from http import HTTPStatus
from itertools import chain
from typing import Any, List, Mapping, Optional, Tuple
import requests
from airbyte_cdk.logger import AirbyteLogger
from airbyte_cdk.sources import AbstractSource
from airbyte_cdk.sources.streams import Stream
from airbyte_cdk.sources.utils.schema_helpers import ResourceSchemaLoader
from requests import HTTPError
from source_hubspot.errors import HubspotInvalidAuth
from source_hubspot.streams import (
API,
Campaigns,
Companies,
CompaniesWebAnalytics,
ContactLists,
Contacts,
ContactsListMemberships,
ContactsMergedAudit,
ContactsWebAnalytics,
CustomObject,
DealPipelines,
Deals,
DealsArchived,
DealsWebAnalytics,
EmailEvents,
EmailSubscriptions,
Engagements,
EngagementsCalls,
EngagementsCallsWebAnalytics,
EngagementsEmails,
EngagementsEmailsWebAnalytics,
EngagementsMeetings,
EngagementsMeetingsWebAnalytics,
EngagementsNotes,
EngagementsNotesWebAnalytics,
EngagementsTasks,
EngagementsTasksWebAnalytics,
Forms,
FormSubmissions,
Goals,
GoalsWebAnalytics,
LineItems,
LineItemsWebAnalytics,
MarketingEmails,
Owners,
OwnersArchived,
Products,
ProductsWebAnalytics,
PropertyHistory,
SubscriptionChanges,
TicketPipelines,
Tickets,
TicketsWebAnalytics,
WebAnalyticsStream,
Workflows,
)
class SourceHubspot(AbstractSource):
logger = AirbyteLogger()
def check_connection(self, logger: logging.Logger, config: Mapping[str, Any]) -> Tuple[bool, Optional[Any]]:
"""Check connection"""
common_params = self.get_common_params(config=config)
alive = True
error_msg = None
try:
contacts = Contacts(**common_params)
_ = contacts.properties
except HTTPError as error:
alive = False
error_msg = repr(error)
if error.response.status_code == HTTPStatus.BAD_REQUEST:
response_json = error.response.json()
error_msg = f"400 Bad Request: {response_json['message']}, please check if provided credentials are valid."
except HubspotInvalidAuth as e:
alive = False
error_msg = repr(e)
return alive, error_msg
def get_granted_scopes(self, authenticator):
try:
access_token = authenticator.get_access_token()
url = f"https://api.hubapi.com/oauth/v1/access-tokens/{access_token}"
response = requests.get(url=url)
response.raise_for_status()
response_json = response.json()
granted_scopes = response_json["scopes"]
return granted_scopes
except Exception as e:
return False, repr(e)
@staticmethod
def get_api(config: Mapping[str, Any]) -> API:
credentials = config.get("credentials", {})
return API(credentials=credentials)
def get_common_params(self, config) -> Mapping[str, Any]:
start_date = config["start_date"]
credentials = config["credentials"]
api = self.get_api(config=config)
return dict(api=api, start_date=start_date, credentials=credentials)
def streams(self, config: Mapping[str, Any]) -> List[Stream]:
credentials = config.get("credentials", {})
common_params = self.get_common_params(config=config)
streams = [
Campaigns(**common_params),
Companies(**common_params),
ContactLists(**common_params),
Contacts(**common_params),
ContactsListMemberships(**common_params),
ContactsMergedAudit(**common_params),
DealPipelines(**common_params),
Deals(**common_params),
DealsArchived(**common_params),
EmailEvents(**common_params),
EmailSubscriptions(**common_params),
Engagements(**common_params),
EngagementsCalls(**common_params),
EngagementsEmails(**common_params),
EngagementsMeetings(**common_params),
EngagementsNotes(**common_params),
EngagementsTasks(**common_params),
Forms(**common_params),
FormSubmissions(**common_params),
Goals(**common_params),
LineItems(**common_params),
MarketingEmails(**common_params),
Owners(**common_params),
OwnersArchived(**common_params),
Products(**common_params),
PropertyHistory(**common_params),
SubscriptionChanges(**common_params),
Tickets(**common_params),
TicketPipelines(**common_params),
Workflows(**common_params),
]
enable_experimental_streams = "enable_experimental_streams" in config and config["enable_experimental_streams"]
if enable_experimental_streams:
streams.extend([
ContactsWebAnalytics(**common_params),
CompaniesWebAnalytics(**common_params),
DealsWebAnalytics(**common_params),
TicketsWebAnalytics(**common_params),
EngagementsCallsWebAnalytics(**common_params),
EngagementsEmailsWebAnalytics(**common_params),
EngagementsMeetingsWebAnalytics(**common_params),
EngagementsNotesWebAnalytics(**common_params),
EngagementsTasksWebAnalytics(**common_params),
GoalsWebAnalytics(**common_params),
LineItemsWebAnalytics(**common_params),
ProductsWebAnalytics(**common_params),
])
api = API(credentials=credentials)
if api.is_oauth2():
authenticator = api.get_authenticator()
granted_scopes = self.get_granted_scopes(authenticator)
self.logger.info(f"The following scopes were granted: {granted_scopes}")
available_streams = [stream for stream in streams if stream.scope_is_granted(granted_scopes)]
unavailable_streams = [stream for stream in streams if not stream.scope_is_granted(granted_scopes)]
self.logger.info(f"The following streams are unavailable: {[s.name for s in unavailable_streams]}")
partially_available_streams = [stream for stream in streams if not stream.properties_scope_is_granted()]
required_scoped = set(chain(*[x.properties_scopes for x in partially_available_streams]))
self.logger.info(
f"The following streams are partially available: {[s.name for s in partially_available_streams]}, "
f"add the following scopes to download all available data: {required_scoped}"
)
else:
self.logger.info("No scopes to grant when authenticating with API key.")
available_streams = streams
available_streams.extend(self.get_custom_object_streams(api=api, common_params=common_params))
if enable_experimental_streams:
custom_objects_web_analytics_streams = self.get_web_analytics_custom_objects_stream(
custom_object_stream_instances=self.get_custom_object_streams(api=api, common_params=common_params),
common_params=common_params
)
available_streams.extend(custom_objects_web_analytics_streams)
return available_streams
def get_custom_object_streams(self, api: API, common_params: Mapping[str, Any]):
for entity, fully_qualified_name, schema, custom_properties in api.get_custom_objects_metadata():
yield CustomObject(
entity=entity,
schema=schema,
fully_qualified_name=fully_qualified_name,
custom_properties=custom_properties,
**common_params,
)
def get_web_analytics_custom_objects_stream(self, custom_object_stream_instances: List[CustomObject], common_params: Any) -> WebAnalyticsStream:
for custom_object_stream_instance in custom_object_stream_instances:
def __init__(self, **kwargs: Any):
parent = custom_object_stream_instance.__class__(
entity=custom_object_stream_instance.entity,
schema=custom_object_stream_instance.schema,
fully_qualified_name=custom_object_stream_instance.fully_qualified_name,
custom_properties=custom_object_stream_instance.custom_properties,
**common_params
)
super(self.__class__, self).__init__(parent=parent, **kwargs)
def get_json_schema(self):
raw_schema = {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": ["null", "object"],
"$ref": "default_event_properties.json"
}
return ResourceSchemaLoader("source_hubspot")._resolve_schema_references(raw_schema=raw_schema)
custom_web_analytics_stream_class = type(
f"{custom_object_stream_instance.name.capitalize()}WebAnalytics",
(WebAnalyticsStream,),
{
"__init__": __init__,
"get_json_schema": get_json_schema
}
)
yield custom_web_analytics_stream_class(**common_params)