Skip to content

[Feature] Add Dynamic api versioning #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mllemango merged 6 commits into from
Jan 5, 2021
Merged

[Feature] Add Dynamic api versioning #441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e614bfa
Update api_version.py
smubbs Nov 25, 2020
44848c0
Update api_version.py
smubbs Nov 25, 2020
c84bb44
Update api_version.py
smubbs Nov 25, 2020
b27be95
Release handle will now used
smubbs Nov 25, 2020
ea84f13
json import
smubbs Nov 25, 2020
e08138a
updated test_helper.py to add a fake for the dynamic API version request
smubbs Dec 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions shopify/api_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import re

import json
from six.moves.urllib import request

class InvalidVersionError(Exception):
pass
Expand All @@ -24,11 +25,15 @@ def define_version(cls, version):

@classmethod
def define_known_versions(cls):
cls.define_version(Unstable())
cls.define_version(Release('2020-01'))
cls.define_version(Release('2020-04'))
cls.define_version(Release('2020-07'))
cls.define_version(Release('2020-10'))
req = request.urlopen("https://app.shopify.com/services/apis.json")
data = json.loads(req.read().decode("utf-8"))
for api in data['apis']:
if api['handle'] == 'admin':
for release in api['versions']:
if release['handle'] == 'unstable':
cls.define_version(Unstable())
else:
cls.define_version(Release(release['handle']))

@classmethod
def clear_defined_versions(cls):
Expand Down
1 change: 1 addition & 0 deletions test/fixtures/api_version.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"apis":[{"handle":"admin","versions":[{"handle":"2019-04","latest_supported":false,"display_name":"2019-04 (Unsupported)","supported":true},{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]},{"handle":"storefront","versions":[{"handle":"2019-07","latest_supported":false,"display_name":"2019-07 (Unsupported)","supported":true},{"handle":"2019-10","latest_supported":false,"display_name":"2019-10 (Unsupported)","supported":true},{"handle":"2020-01","latest_supported":false,"display_name":"2020-01","supported":true},{"handle":"2020-04","latest_supported":false,"display_name":"2020-04","supported":true},{"handle":"2020-07","latest_supported":false,"display_name":"2020-07","supported":true},{"handle":"2020-10","latest_supported":true,"display_name":"2020-10 (Latest)","supported":true},{"handle":"2021-01","latest_supported":false,"display_name":"2021-01 (Release candidate)","supported":false},{"handle":"unstable","latest_supported":false,"display_name":"unstable","supported":false}]}]}
19 changes: 12 additions & 7 deletions test/test_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ def setUp(self):
self.http = http_fake.TestHandler
self.http.set_response(Exception('Bad request'))
self.http.site = 'https://this-is-my-test-show.myshopify.com'
self.fake('apis',
url='https://app.shopify.com/services/apis.json',
method='GET',
code=200,
response_headers={'Content-type': 'application/json'},
body=self.load_fixture('api_version'),
has_user_agent=False
)

def load_fixture(self, name, format='json'):
with open(os.path.dirname(__file__)+'/fixtures/%s.%s' % (name, format), 'rb') as f:
Expand All @@ -35,13 +43,10 @@ def fake(self, endpoint, **kwargs):
extension = ""
else:
extension = ".%s" % (kwargs.pop('extension', 'json'))

url = "https://this-is-my-test-show.myshopify.com%s/%s%s" % (prefix, endpoint, extension)
try:
url = kwargs['url']
except KeyError:
pass

if kwargs.get('url'):
url = kwargs.get('url')
else:
url = "https://this-is-my-test-show.myshopify.com%s/%s%s" % (prefix, endpoint, extension)
headers = {}
if kwargs.pop('has_user_agent', True):
userAgent = 'ShopifyPythonAPI/%s Python/%s' % (shopify.VERSION, sys.version.split(' ', 1)[0])
Expand Down