Commit af0a274
committed
Add OAuth 2.0 Client Credentials with automatic API version detection
Implements OAuth 2.0 Client Credentials Grant (RFC 6749 Section 4.4) with
intelligent automatic version detection for Shopify API 2026-01+.
Key Features:
============
1. Automatic Version Detection
- API >= 2026-01: Automatically uses Client Credentials Grant
- API < 2026-01: Automatically uses Authorization Code Grant
- Method: Session._requires_client_credentials()
2. Smart Unified Method (RECOMMENDED)
- Session.request_access_token() - Auto-selects correct OAuth flow
- No need to know which method to use
- Works with all API versions transparently
3. Manual Client Credentials Method
- Session.request_token_client_credentials() - Explicit OAuth 2.0 flow
- Returns: {'access_token', 'scope', 'expires_in': 86399}
- Token expires after 24 hours
4. Safety Guards
- Legacy request_token() raises ValidationException for API >= 2026-01
- Clear error messages guide developers to correct method
- Prevents silent authentication failures
5. New Exception Type
- OAuthException for OAuth-specific errors
- Better error categorization and handling
Changes:
========
- Add Session.request_token_client_credentials() method (120 lines)
- Add Session.request_access_token() method with auto-detection (45 lines)
- Add Session._requires_client_credentials() version detection (20 lines)
- Add OAuthException class for OAuth errors
- Update request_token() with version check and helpful error
- Export OAuthException in shopify/__init__.py
- Add 12 comprehensive test cases
- Update CHANGELOG with detailed feature list
Implementation Details:
======================
- RFC 6749 Section 4.4 compliant
- 10-second timeout to prevent hanging
- Proper error handling for all failure scenarios
- Validates credentials before making requests
- Stores token and scopes in session automatically
- Returns full response with expiration time
- Version threshold: numeric_version >= 202601
Usage Examples:
===============
# Recommended: Automatic method
session = shopify.Session('store.myshopify.com', '2026-01')
shopify.Session.setup(api_key='client_id', secret='client_secret')
response = session.request_access_token() # Auto-detects OAuth flow
token = response['access_token']
# Explicit: Client credentials
response = session.request_token_client_credentials()
# Backward compatible: Old API versions
session = shopify.Session('store.myshopify.com', '2025-10')
token = session.request_access_token(callback_params)
Test Coverage:
==============
- OAuth success flow
- Missing credentials validation
- HTTP error handling
- Token reuse logic
- Version detection for 2026-01, 2026-04, 2025-10, 2024-10
- Old method blocking for new versions
- Automatic method selection for both flows
Statistics:
===========
- Lines added: 364
- Methods created: 3
- Tests added: 12
- Breaking changes: 0 (fully backward compatible)
Related:
========
https://shopify.dev/docs/apps/build/authentication-authorization/access-tokens/client-credentials-grant
https://datatracker.ietf.org/doc/html/rfc6749#section-4.41 parent f58c991 commit af0a274
4 files changed
Lines changed: 364 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
4 | 12 | | |
5 | 13 | | |
6 | 14 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
| 2 | + | |
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
22 | 27 | | |
23 | 28 | | |
24 | 29 | | |
| |||
53 | 58 | | |
54 | 59 | | |
55 | 60 | | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
56 | 81 | | |
57 | 82 | | |
58 | 83 | | |
| |||
63 | 88 | | |
64 | 89 | | |
65 | 90 | | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
66 | 108 | | |
67 | 109 | | |
68 | 110 | | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
69 | 119 | | |
70 | 120 | | |
71 | 121 | | |
| |||
85 | 135 | | |
86 | 136 | | |
87 | 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 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
88 | 291 | | |
89 | 292 | | |
90 | 293 | | |
| |||
0 commit comments