mark live API tests as optional, add validation for known option fields, replace own mocks with "responses" lib

Author: raphaelhuefner

conftest.py

@@ -0,0 +1,6 @@
+import pytest
+
+# see https://docs.pytest.org/en/latest/example/simple.html#control-skipping-of-tests-according-to-command-line-option
+def pytest_addoption(parser):
+    parser.addoption('--liveapi', action='store_true',
+                     default=False, help='run some tests againts live API')

gitcoin/client.py

@@ -2,6 +2,7 @@
 
 import requests
 
+import gitcoin.validation
 
 class Config:
     """Define Base Class for API Endpoint Config."""
@@ -30,12 +31,12 @@ def __init__(self):
         """Init params container for 'bounties' filters etc."""
         super().__init__()
         self.params = {
-            'experience_level': (True, str),
-            'project_length': (True, str),
-            'bounty_type': (True, str),
+            'experience_level': (True, gitcoin.validation.experience_level),
+            'project_length': (True, gitcoin.validation.project_length),
+            'bounty_type': (True, gitcoin.validation.bounty_type),
             'bounty_owner_address': (True, str),
             'bounty_owner_github_username': (True, str),
-            'idx_status': (True, str),
+            'idx_status': (True, gitcoin.validation.idx_status),
             'network': (True, str),
             'standard_bounties_id': (True, int),
             'pk__gt': (False, int),
@@ -45,7 +46,7 @@ def __init__(self):
             'fulfiller_github_username': (False, str),
             'interested_github_username': (False, str),
             'raw_data': (True, str),
-            'order_by': (False, str),
+            'order_by': (False, gitcoin.validation.order_by),
             'limit': (False, int),
             'offset': (False, int)
         }
@@ -119,7 +120,7 @@ def all(self):
 
     def get(self, primary_key):
         """Retrieve one resource by primary key."""
-        return self._request_get('/'.join((self.url, str(primary_key))))
+        return self._request_get(''.join((self.url, str(primary_key))))
 
     def _request_get(self, url=None):
         """Fire the actual HTTP GET request as configured."""
@@ -143,7 +144,7 @@ def __init__(self):
         self.set_class('endpoint', Endpoint)
         self.set_class('bounties_list_config', BountyConfig)
         self.urls = {}
-        self.set_url('bounties', 'https://gitcoin.co/api/v0.1/bounties')
+        self.set_url('bounties', 'https://gitcoin.co/api/v0.1/bounties/')
 
     def set_class(self, cls_id, cls):
         """Inject class dependency, overriding the default class."""

gitcoin/validation.py

@@ -0,0 +1,51 @@
+
+# Valid parameter values as seen at
+# https://github.com/gitcoinco/web/blob/84babc30611c281c817582b4d677dda6366def83/app/dashboard/models.py#L119-L168
+options = {
+    'experience_level': ['Beginner', 'Advanced', 'Intermediate', 'Unknown'],
+    'project_length': ['Hours', 'Days', 'Weeks', 'Months', 'Unknown'],
+    'bounty_type': ['Bug', 'Security', 'Feature', 'Unknown'],
+    'idx_status': ['cancelled', 'done', 'expired', 'open', 'started', 'submitted', 'unknown'],
+    'order_by': [
+        'web3_type', 'title', 'web3_created', 'value_in_token', 'token_name',
+        'token_address', 'bounty_type', 'project_length', 'experience_level',
+        'github_url', 'github_comments', 'bounty_owner_address',
+        'bounty_owner_email', 'bounty_owner_github_username',
+        'bounty_owner_name', 'is_open', 'expires_date', 'raw_data', 'metadata',
+        'current_bounty', '_val_usd_db', 'contract_address', 'network',
+        'idx_experience_level', 'idx_project_length', 'idx_status',
+        'issue_description', 'standard_bounties_id', 'num_fulfillments',
+        'balance', 'accepted', 'interested', 'interested_comment',
+        'submissions_comment', 'override_status', 'last_comment_date',
+        'fulfillment_accepted_on', 'fulfillment_submitted_on',
+        'fulfillment_started_on', 'canceled_on', 'snooze_warnings_for_days',
+        'token_value_time_peg', 'token_value_in_usdt', 'value_in_usdt_now',
+        'value_in_usdt', 'value_in_eth', 'value_true', 'privacy_preferences'
+    ]
+}
+
+def _validate_options(field_name, value):
+    if value in options[field_name]:
+        return value
+    msg = 'Unknown value "{val}" for field "{name}".'
+    raise ValueError(msg.format(val=value, name=field_name))
+
+def experience_level(value):
+    return _validate_options('experience_level', value)
+
+def project_length(value):
+    return _validate_options('project_length', value)
+
+def bounty_type(value):
+    return _validate_options('bounty_type', value)
+
+def idx_status(value):
+    return _validate_options('idx_status', value)
+
+def order_by(direction):
+    if direction in options['order_by']:
+        return direction
+    if direction[0:1] == '-' and direction[1:] in options['order_by']:
+        return direction
+    msg = 'Unknown direction "{dir}" to order by.'
+    raise ValueError(msg.format(dir=direction))

requirements.txt

@@ -2,6 +2,7 @@ apipkg==1.4
 attrs==18.1.0
 certifi==2018.4.16
 chardet==3.0.4
+cookies==2.2.1
 coverage==4.5.1
 execnet==1.5.0
 flake8==3.5.0
@@ -19,6 +20,7 @@ pytest-cov==2.5.1
 pytest-isort==0.2.0
 pytest-runner==4.2
 requests==2.18.4
+responses==0.9.0
 six==1.11.0
 urllib3==1.22
 yapf==0.22.0