This repository has been archived by the owner on May 12, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 258
/
api.py
282 lines (221 loc) · 11.1 KB
/
api.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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
from __future__ import division
import base64
import datetime
import requests
import json
import logging
import os
import platform
import paypalrestsdk.util as util
from paypalrestsdk import exceptions
from paypalrestsdk.config import __version__, __endpoint_map__
class Api(object):
# User-Agent for HTTP request
library_details = "requests %s; python %s" % (requests.__version__, platform.python_version())
user_agent = "PayPalSDK/PayPal-Python-SDK %s (%s)" % (__version__, library_details)
def __init__(self, options=None, **kwargs):
"""Create API object
Usage::
>>> import paypalrestsdk
>>> api = paypalrestsdk.Api(mode="sandbox", client_id='CLIENT_ID', client_secret='CLIENT_SECRET',
ssl_options={"cert": "/path/to/server.pem"})
"""
kwargs = util.merge_dict(options or {}, kwargs)
self.mode = kwargs.get("mode", "sandbox")
self.endpoint = kwargs.get("endpoint", self.default_endpoint())
self.token_endpoint = kwargs.get("token_endpoint", self.endpoint)
self.client_id = kwargs["client_id"] # Mandatory parameter, so not using `dict.get`
self.client_secret = kwargs["client_secret"] # Mandatory parameter, so not using `dict.get`
self.proxies = kwargs.get("proxies", None)
self.token_hash = None
self.token_request_at = None
# setup SSL certificate verification if private certificate provided
ssl_options = kwargs.get("ssl_options", {})
if "cert" in ssl_options:
os.environ["REQUESTS_CA_BUNDLE"] = ssl_options["cert"]
if kwargs.get("token"):
self.token_hash = {"access_token": kwargs["token"], "token_type": "Bearer"}
self.options = kwargs
def default_endpoint(self):
return __endpoint_map__.get(self.mode)
def basic_auth(self):
"""Find basic auth, and returns base64 encoded
"""
credentials = "%s:%s" % (self.client_id, self.client_secret)
return base64.b64encode(credentials.encode('utf-8')).decode('utf-8').replace("\n", "")
def get_token_hash(self, authorization_code=None, refresh_token=None):
"""Generate new token by making a POST request
1. By using client credentials if validate_token_hash finds
token to be invalid. This is useful during web flow so that an already
authenticated user is not reprompted for login
2. Exchange authorization_code from mobile device for a long living
refresh token that can be used to charge user who has consented to future
payments
3. Exchange refresh_token for the user for a access_token of type Bearer
which can be passed in to charge user
"""
path = "/v1/oauth2/token"
payload = "grant_type=client_credentials"
if authorization_code is not None:
payload = "grant_type=authorization_code&response_type=token&redirect_uri=urn:ietf:wg:oauth:2.0:oob&code=" + authorization_code
elif refresh_token is not None:
payload = "grant_type=refresh_token&refresh_token=" + refresh_token
else:
self.validate_token_hash()
if self.token_hash is not None:
return self.token_hash
else:
self.token_request_at = datetime.datetime.now()
self.token_hash = self.http_call(
util.join_url(self.token_endpoint, path), "POST",
data=payload,
headers={
"Authorization": ("Basic %s" % self.basic_auth()),
"Content-Type": "application/x-www-form-urlencoded",
"Accept": "application/json", "User-Agent": self.user_agent
})
return self.token_hash
def validate_token_hash(self):
"""Checks if token duration has expired and if so resets token
"""
if self.token_request_at and self.token_hash and self.token_hash.get("expires_in") is not None:
delta = datetime.datetime.now() - self.token_request_at
duration = (delta.microseconds + (delta.seconds + delta.days * 24 * 3600) * 10 ** 6) / 10 ** 6
if duration > self.token_hash.get("expires_in"):
self.token_hash = None
def get_access_token(self, authorization_code=None, refresh_token=None):
"""Wraps get_token_hash for getting access token
"""
return self.get_token_hash(authorization_code, refresh_token)['access_token']
def get_refresh_token(self, authorization_code=None):
"""Exchange authorization code for refresh token for future payments
"""
if authorization_code is None:
raise exceptions.MissingConfig("Authorization code needed to get new refresh token. \
Refer to https://developer.paypal.com/docs/integration/mobile/make-future-payment/#get-an-auth-code")
return self.get_token_hash(authorization_code)["refresh_token"]
def request(self, url, method, body=None, headers=None, refresh_token=None):
"""Make HTTP call, formats response and does error handling. Uses http_call method in API class.
Usage::
>>> api.request("https://api.sandbox.paypal.com/v1/payments/payment?count=10", "GET", {})
>>> api.request("https://api.sandbox.paypal.com/v1/payments/payment", "POST", "{}", {} )
"""
http_headers = util.merge_dict(self.headers(refresh_token=refresh_token), headers or {})
if http_headers.get('PayPal-Request-Id'):
logging.info('PayPal-Request-Id: %s' % (http_headers['PayPal-Request-Id']))
try:
return self.http_call(url, method, data=json.dumps(body), headers=http_headers)
# Format Error message for bad request
except exceptions.BadRequest as error:
return {"error": json.loads(error.content)}
# Handle Expired token
except exceptions.UnauthorizedAccess as error:
if(self.token_hash and self.client_id):
self.token_hash = None
return self.request(url, method, body, headers)
else:
raise error
def http_call(self, url, method, **kwargs):
"""Makes a http call. Logs response information.
"""
logging.info('Request[%s]: %s' % (method, url))
start_time = datetime.datetime.now()
response = requests.request(method, url, proxies=self.proxies, **kwargs)
duration = datetime.datetime.now() - start_time
logging.info('Response[%d]: %s, Duration: %s.%ss.' % (response.status_code, response.reason, duration.seconds, duration.microseconds))
debug_id = response.headers.get('PayPal-Debug-Id')
if debug_id:
logging.debug('debug_id: %s' % debug_id)
return self.handle_response(response, response.content.decode('utf-8'))
def handle_response(self, response, content):
"""Validate HTTP response
"""
status = response.status_code
if status in (301, 302, 303, 307):
raise exceptions.Redirection(response, content)
elif 200 <= status <= 299:
return json.loads(content) if content else {}
elif status == 400:
raise exceptions.BadRequest(response, content)
elif status == 401:
raise exceptions.UnauthorizedAccess(response, content)
elif status == 403:
raise exceptions.ForbiddenAccess(response, content)
elif status == 404:
raise exceptions.ResourceNotFound(response, content)
elif status == 405:
raise exceptions.MethodNotAllowed(response, content)
elif status == 409:
raise exceptions.ResourceConflict(response, content)
elif status == 410:
raise exceptions.ResourceGone(response, content)
elif status == 422:
raise exceptions.ResourceInvalid(response, content)
elif 401 <= status <= 499:
raise exceptions.ClientError(response, content)
elif 500 <= status <= 599:
raise exceptions.ServerError(response, content)
else:
raise exceptions.ConnectionError(response, content, "Unknown response code: #{response.code}")
def headers(self, refresh_token=None):
"""Default HTTP headers
"""
token_hash = self.get_token_hash(refresh_token=refresh_token)
return {
"Authorization": ("%s %s" % (token_hash['token_type'], token_hash['access_token'])),
"Content-Type": "application/json",
"Accept": "application/json",
"User-Agent": self.user_agent
}
def get(self, action, headers=None):
"""Make GET request
Usage::
>>> api.get("v1/payments/payment?count=1")
>>> api.get("v1/payments/payment/PAY-1234")
"""
return self.request(util.join_url(self.endpoint, action), 'GET', headers=headers or {})
def post(self, action, params=None, headers=None, refresh_token=None):
"""Make POST request
Usage::
>>> api.post("v1/payments/payment", { 'indent': 'sale' })
>>> api.post("v1/payments/payment/PAY-1234/execute", { 'payer_id': '1234' })
"""
return self.request(util.join_url(self.endpoint, action), 'POST', body=params or {}, headers=headers or {}, refresh_token=refresh_token)
def put(self, action, params=None, headers=None, refresh_token=None):
"""Make PUT request
Usage::
>>> api.put("v1/invoicing/invoices/INV2-RUVR-ADWQ", { 'id': 'INV2-RUVR-ADWQ', 'status': 'DRAFT'})
"""
return self.request(util.join_url(self.endpoint, action), 'PUT', body=params or {}, headers=headers or {}, refresh_token=refresh_token)
def patch(self, action, params=None, headers=None, refresh_token=None):
"""Make PATCH request
Usage::
>>> api.patch("v1/payments/billing-plans/P-5VH69258TN786403SVUHBM6A", { 'op': 'replace', 'path': '/merchant-preferences'})
"""
return self.request(util.join_url(self.endpoint, action), 'PATCH', body=params or {}, headers=headers or {}, refresh_token=refresh_token)
def delete(self, action, headers=None):
"""Make DELETE request
"""
return self.request(util.join_url(self.endpoint, action), 'DELETE', headers=headers or {})
__api__ = None
def default():
"""Returns default api object and if not present creates a new one
By default points to developer sandbox
"""
global __api__
if __api__ is None:
try:
client_id = os.environ["PAYPAL_CLIENT_ID"]
client_secret = os.environ["PAYPAL_CLIENT_SECRET"]
except KeyError:
raise exceptions.MissingConfig("Required PAYPAL_CLIENT_ID and PAYPAL_CLIENT_SECRET. \
Refer https://github.com/paypal/rest-api-sdk-python#configuration")
__api__ = Api(mode=os.environ.get("PAYPAL_MODE", "sandbox"), client_id=client_id, client_secret=client_secret)
return __api__
def set_config(options=None, **config):
"""Create new default api object with given configuration
"""
global __api__
__api__ = Api(options or {}, **config)
return __api__
configure = set_config