Skip to content

Update method table parsing to new positional arg format, type-check positional args, handle arrays #8

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

Open
alekstorm wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update method table parsing to new positional arg format, type-check positional args, handle arrays #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff4ad62
Update method table parsing to new positional argument format, type-c…
alekstorm Nov 3, 2011
d1231bf
Update tests to new positional argument format, rename mock parameter…
alekstorm Nov 4, 2011
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
37 changes: 20 additions & 17 deletions etsy/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def __init__(self):
}


def __call__(self, method, **kwargs):
def __call__(self, method, kwargs):
params = method['params']
for k, v in kwargs.items():
if k == 'includes': continue
Expand All @@ -33,7 +33,7 @@ def __call__(self, method, **kwargs):
raise ValueError('Unexpected argument: %s=%s' % (k, v))

t = params[k]
checker = self.checkers.get(t, None) or self.compile(t)
checker = self.compile(t)
ok, converted = checker(v)
if not ok:
raise ValueError(
Expand All @@ -42,12 +42,19 @@ def __call__(self, method, **kwargs):


def compile(self, t):
if t in self.checkers:
return self.checkers[t]
if t.startswith('enum'):
f = self.compile_enum(t)
else:
f = self.always_ok
self.checkers[t] = f
return f
return self.compile_enum(t)
if t.startswith('array'):
sub_t = self.compile(t[6:-1])
def check_array(array):
if not isinstance(array, list) or len(array) == 0:
return False, array
ok_elems, serialized_elems = zip(*map(sub_t, array)) if len(array) > 0 else ([], [])
return reduce(lambda a,b: a and b, ok_elems, True), ','.join(serialized_elems)
return check_array
return self.always_ok


def compile_enum(self, t):
Expand All @@ -64,13 +71,13 @@ def always_ok(self, value):
def check_int(self, value):
if isinstance(value, long):
return True, value
return isinstance(value, int), value
return isinstance(value, int), str(value)


def check_float(self, value):
if isinstance(value, int):
return True, value
return isinstance(value, float), value
return isinstance(value, float), str(value)


def check_string(self, value):
Expand Down Expand Up @@ -110,21 +117,16 @@ def __call__(self, *args, **kwargs):

def compile(self):
uri = self.spec['uri']
self.positionals = re.findall('{(.*)}', uri)
self.positionals = re.findall(':([^/]+)', uri)

for p in self.positionals:
uri = uri.replace('{%s}' % p, '%%(%s)s' % p)
uri = re.sub(':%s(?=/|$)' % p, '%%(%s)s' % p, uri)
self.uri_format = uri

self.compiled = True


def invoke(self, *args, **kwargs):
if args and not self.positionals:
raise ValueError(
'Positional argument(s): %s provided, but this method does '
'not support them.' % (args,))

if len(args) > len(self.positionals):
raise ValueError('Too many positional arguments.')

Expand All @@ -141,7 +143,8 @@ def invoke(self, *args, **kwargs):
ps[p] = kwargs[p]
del kwargs[p]

self.type_checker(self.spec, **kwargs)
self.type_checker(self.spec, ps)
self.type_checker(self.spec, kwargs)
return self.api._get(self.spec['http_method'], self.uri_format % ps, **kwargs)


Expand Down
119 changes: 58 additions & 61 deletions test/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,20 @@ def etsy_home(self):


def get_method_table(self, *args):
return [{'name': 'testMethod',
'uri': '/test/{test_id}',
'http_method': 'GET',
'params': {
'limit': 'int',
'test_id': 'user_id_or_name',
'offset': 'int',
'fizz': 'enum(foo, bar, baz)',
'buzz': 'float',
'blah': 'unknown type',
'kind': 'string',
},
'type': 'int',
'description': 'test method.'},
{'name': 'noPositionals',
'uri': '/blah',
return [{'name': 'testMethod',
'uri': '/test/:ps_arr_str',
'http_method': 'GET',
'params': {'foo': 'int'},
'params': {
'ps_arr_str': 'array(string)',
'kw_string': 'string',
'kw_int': 'int',
'kw_float': 'float',
'kw_array_int': 'array(int)',
'kw_enum': 'enum(foo, bar, baz)',
'kw_unknown': 'unknown type',
},
'type': 'int',
'description': 'no pos arguments'}]
'description': 'test method.'}]


def _get_url(self, url, http_method, content_type, body):
Expand Down Expand Up @@ -76,26 +70,26 @@ def test_method_created(self):


def test_url_params(self):
self.api.testMethod(test_id='foo')
self.api.testMethod(ps_arr_str=['a'])
self.assertEqual(self.api.last_url,
'http://host/test/foo?api_key=apikey')
'http://host/test/a?api_key=apikey')


def test_count_saved(self):
self.api.testMethod(test_id='foo')
self.api.testMethod(ps_arr_str=['a'])
self.assertTrue(self.api.count)


def test_results_returned(self):
x = self.api.testMethod(test_id='foo')
x = self.api.testMethod(ps_arr_str=['a'])
self.assertEquals(x, [3])


def test_query_params(self):
self.api.testMethod(test_id='foo', limit=1)
self.api.testMethod(ps_arr_str=['a'], kw_int=1)
self.assertEqual(self.last_query(), {
'api_key': ['apikey'],
'limit': ['1'],
'kw_int': ['1'],
})


Expand Down Expand Up @@ -143,98 +137,101 @@ def test_reading_api_key(self):

def test_unrecognized_kwarg(self):
msg = self.assertRaises(ValueError, self.api.testMethod,
test_id=1, not_an_arg=1)
ps_arr_str=['a'], not_an_arg=1)
self.assertEqual(msg, 'Unexpected argument: not_an_arg=1')


def test_unknown_parameter_type_is_passed(self):
self.api.testMethod(test_id=1, blah=1)
self.assertEqual(self.last_query()['blah'], ['1'])
self.api.testMethod(ps_arr_str=['a'], kw_unknown=1)
self.assertEqual(self.last_query()['kw_unknown'], ['1'])


def test_parameter_type_int(self):
self.api.testMethod(test_id=1, limit=5)
self.assertEqual(self.last_query()['limit'], ['5'])
self.api.testMethod(ps_arr_str=['a'], kw_int=5)
self.assertEqual(self.last_query()['kw_int'], ['5'])


def test_parameter_type_long(self):
self.api.testMethod(test_id=1L, limit=5L)
self.assertEqual(self.last_query()['limit'], ['5'])
self.api.testMethod(ps_arr_str=['a'], kw_int=5L)
self.assertEqual(self.last_query()['kw_int'], ['5'])


def bad_value_msg(self, name, t, v):
return "Bad value for parameter %s of type '%s' - %s" % (name, t, v)

def test_invalid_parameter_type_int(self):
msg = self.assertRaises(ValueError, self.api.testMethod,
test_id=1, limit=5.6)
self.assertEqual(msg, self.bad_value_msg('limit', 'int', 5.6))
msg = self.assertRaises(ValueError, self.api.testMethod,
ps_arr_str=['a'], kw_int=5.6)
self.assertEqual(msg, self.bad_value_msg('kw_int', 'int', 5.6))


def test_parameter_type_float(self):
self.api.testMethod(test_id=1, buzz=42.1)
self.assertEqual(self.last_query()['buzz'], ['42.1'])
self.api.testMethod(ps_arr_str=['a'], kw_float=42.1)
self.assertEqual(self.last_query()['kw_float'], ['42.1'])


def test_invalid_parameter_type_float(self):
msg = self.assertRaises(ValueError, self.api.testMethod,
test_id=1, buzz='x')
self.assertEqual(msg, self.bad_value_msg('buzz', 'float', 'x'))
msg = self.assertRaises(ValueError, self.api.testMethod,
ps_arr_str=['a'], kw_float='x')
self.assertEqual(msg, self.bad_value_msg('kw_float', 'float', 'x'))


def test_int_accepted_as_float(self):
self.api.testMethod(test_id=1, buzz=3)
self.assertEqual(self.last_query()['buzz'], ['3'])
self.api.testMethod(ps_arr_str=['a'], kw_int=3)
self.assertEqual(self.last_query()['kw_int'], ['3'])


def test_parameter_type_enum(self):
self.api.testMethod(test_id=1, fizz='bar')
self.assertEqual(self.last_query()['fizz'], ['bar'])
self.api.testMethod(ps_arr_str=['a'], kw_enum='bar')
self.assertEqual(self.last_query()['kw_enum'], ['bar'])


def test_invalid_parameter_type_enum(self):
msg = self.assertRaises(ValueError, self.api.testMethod,
test_id=1, fizz='goo')
ps_arr_str=['a'], kw_enum='goo')
self.assertEqual(msg, self.bad_value_msg(
'fizz', 'enum(foo, bar, baz)', 'goo'))
'kw_enum', 'enum(foo, bar, baz)', 'goo'))


def test_parameter_type_string(self):
self.api.testMethod(test_id=1, kind='blah')
self.assertEqual(self.last_query()['kind'], ['blah'])
self.api.testMethod(ps_arr_str=['a'], kw_string='blah')
self.assertEqual(self.last_query()['kw_string'], ['blah'])


def test_invalid_parameter_type_string(self):
msg = self.assertRaises(ValueError, self.api.testMethod,
test_id=1, kind=Test)
self.assertEqual(msg, self.bad_value_msg('kind', 'string', Test))
ps_arr_str=['a'], kw_string=5)
self.assertEqual(msg, self.bad_value_msg('kw_string', 'string', 5))


def test_url_arguments_work_positionally(self):
self.api.testMethod('foo')
self.api.testMethod(['foo'])
self.assertEqual(self.api.last_url,
'http://host/test/foo?api_key=apikey')

def test_invalid_positional_argument_type_arr_string(self):
msg = self.assertRaises(ValueError, self.api.testMethod,
ps_arr_str=5)
self.assertEqual(msg, self.bad_value_msg('ps_arr_str', 'array(string)', 5))

def test_method_with_no_positionals_doesnt_accept_them(self):
msg = self.assertRaises(ValueError, self.api.noPositionals, 1, 2)
self.assertEqual('Positional argument(s): (1, 2) provided, but this '
'method does not support them.', msg)
def test_invalid_empty_positional_argument_array(self):
msg = self.assertRaises(ValueError, self.api.testMethod,
ps_arr_str=[])
self.assertEqual(msg, self.bad_value_msg('ps_arr_str', 'array(string)', []))


def test_too_many_positionals(self):
msg = self.assertRaises(ValueError, self.api.testMethod, 1, 2)
msg = self.assertRaises(ValueError, self.api.testMethod, ['a'], ['a'])
self.assertEqual('Too many positional arguments.', msg)


def test_positional_argument_not_provided(self):
msg = self.assertRaises(ValueError, self.api.testMethod)
self.assertEqual("Required argument 'test_id' not provided.", msg)
self.assertEqual("Required argument 'ps_arr_str' not provided.", msg)


def test_positional_argument_duplicated_in_kwargs(self):
msg = self.assertRaises(ValueError, self.api.testMethod, 1, test_id=2)
self.assertEqual('Positional argument duplicated in kwargs: test_id',
msg = self.assertRaises(ValueError, self.api.testMethod, ['a'], ps_arr_str=['a'])
self.assertEqual('Positional argument duplicated in kwargs: ps_arr_str',
msg)


Expand Down Expand Up @@ -304,7 +301,7 @@ def get_uncached(self):


def test_no_cache_file_returns_results(self):
self.assertEqual(2, len(self.get_uncached()))
self.assertEqual(1, len(self.get_uncached()))


def test_no_cache_file_writes_cache(self):
Expand All @@ -330,7 +327,7 @@ def test_caching(self):


def test_caching_returns_results(self):
self.assertEqual(2, len(self.get_cached()))
self.assertEqual(1, len(self.get_cached()))


def test_caching_doesnt_overwrite_cache(self):
Expand Down