Merge pull request #22 from gabrnavarro/add_milestone_get

amitsaha · web-flow · commit a336b94d0897 · 2018-03-02T13:50:52.000+11:00
Added get_milestones() function, examples
diff --git a/README.rst b/README.rst
@@ -98,6 +98,8 @@ All the examples below recognizes two environment variables:
    request <examples/cancel_milestone_payment.py>`__
 -  `Request a Milestone payment
    release <examples/request_release_milestone_payment.py>`__
+-  `Retrieve project milestones <examples/get_milestones.py>`__
+-  `Retrieve a milestone by ID <examples/get_specific_milestone.py>`__
 
 **Messaging**
 
diff --git a/examples/get_milestones.py b/examples/get_milestones.py
@@ -0,0 +1,42 @@
+from freelancersdk.session import Session
+from freelancersdk.resources.projects.projects import get_milestones
+from freelancersdk.resources.projects.exceptions import \
+    MilestonesNotFoundException
+from freelancersdk.resources.users.helpers import (
+    create_get_users_details_object
+)
+import os
+
+
+def sample_get_milestones():
+    url = os.environ.get('FLN_URL')
+    oauth_token = os.environ.get('FLN_OAUTH_TOKEN')
+    session = Session(oauth_token=oauth_token, url=url)
+
+    get_milestones_data = {
+        'project_ids': [
+            101,
+            102,
+        ],
+        'limit': 10,
+        'offset': 0,
+        'user_details': create_get_users_details_object(
+            country=True,
+            profile_description=True
+        )
+    }
+
+    try:
+        milestones = get_milestones(session, **get_milestones_data)
+    except MilestonesNotFoundException as e:
+        print('Error message: {}'.format(e.message))
+        print('Server response: {}'.format(e.error_code))
+        return None
+    else:
+        return milestones
+
+
+result = sample_get_milestones()
+
+if result:
+    print('Found milestones: {}'.format(len(result['milestones'])))
diff --git a/examples/get_specific_milestone.py b/examples/get_specific_milestone.py
@@ -0,0 +1,34 @@
+from freelancersdk.session import Session
+from freelancersdk.resources.projects.projects import get_milestone_by_id
+from freelancersdk.resources.projects.exceptions import \
+    MilestonesNotFoundException
+from freelancersdk.resources.users.helpers import (
+    create_get_users_details_object
+)
+
+import os
+
+
+def sample_get_specific_milestone(milestone_id):
+    url = os.environ.get('FLN_URL')
+    oauth_token = os.environ.get('FLN_OAUTH_TOKEN')
+    session = Session(oauth_token=oauth_token, url=url)
+    user_details = create_get_users_details_object(
+        country=True,
+        profile_description=True
+    )
+    try:
+        milestone = get_milestone_by_id(session, milestone_id, user_details)
+    except MilestonesNotFoundException as e:
+        print('Error message: {}'.format(e.message))
+        print('Server response: {}'.format(e.error_code))
+        return None
+    else:
+        return milestone
+
+
+milestone_id = 15323050
+result = sample_get_specific_milestone(milestone_id)
+
+if result:
+    print('Found milestone: {}'.format(result['milestones'][str(milestone_id)]))
diff --git a/freelancersdk/resources/projects/exceptions.py b/freelancersdk/resources/projects/exceptions.py
@@ -70,6 +70,15 @@ def __init__(self, message, error_code):
         self.error_code = error_code
 
 
+class MilestonesNotFoundException(Exception):
+    """
+    Milestone could not be found
+    """
+    def __init__(self, message, error_code):
+        super(MilestonesNotFoundException, self).__init__(message)
+        self.error_code = error_code
+
+
 class MilestoneNotCreatedException(Exception):
     """
     Milestone could not be created
diff --git a/freelancersdk/resources/projects/helpers.py b/freelancersdk/resources/projects/helpers.py
@@ -10,7 +10,7 @@
 
 # Make API calls
 # /api/projects/0.1/<specific_endpoint>
-def make_get_request(session, endpoint, params_data):
+def make_get_request(session, endpoint, params_data=None):
     url = urljoin(session.url, '{}/{}/'.format(projects_endpoint, endpoint))
     return session.session.get(url, params=params_data, verify=True)
 
diff --git a/freelancersdk/resources/projects/projects.py b/freelancersdk/resources/projects/projects.py
@@ -14,9 +14,14 @@
     MilestoneNotRequestedReleaseException, MilestoneNotCancelledException,
     MilestoneRequestNotCreatedException, MilestoneRequestNotAcceptedException,
     MilestoneRequestNotRejectedException, MilestoneRequestNotDeletedException,
+    MilestonesNotFoundException,
     ReviewNotPostedException,
     JobsNotFoundException
 )
+
+from freelancersdk.resources.projects.helpers import (
+    create_get_projects_user_details_object
+)
 from freelancersdk.resources.projects import (
     make_get_request, make_post_request, make_put_request,
 )
@@ -222,7 +227,53 @@ def get_bids(session, project_ids=[], bid_ids=[], limit=10, offset=0):
         return json_data['result']
     else:
         raise BidsNotFoundException(
-            message=json_data['message'], error_code=json_data['error_code'])
+            message=json_data['message'], error_code=json_data['error_code']
+        )
+
+
+def get_milestones(session, project_ids=[], milestone_ids=[], user_details=None, limit=10, offset=0):
+    """
+    Get the list of milestones
+    """
+    get_milestones_data = {}
+    if milestone_ids:
+        get_milestones_data['milestones[]'] = milestone_ids
+    if project_ids:
+        get_milestones_data['projects[]'] = project_ids
+    get_milestones_data['limit'] = limit
+    get_milestones_data['offset'] = offset
+
+    # Add projections if they exist
+    if user_details:
+        get_milestones_data.update(user_details)
+
+    # GET /api/projects/0.1/milestones/
+
+    response = make_get_request(session, 'milestones', params_data=get_milestones_data)
+    json_data = response.json()
+    if response.status_code == 200:
+        return json_data['result']
+    else:
+        raise MilestonesNotFoundException(
+            message=json_data['message'], error_code=json_data['error_code']
+        )
+
+
+def get_milestone_by_id(session, milestone_id, user_details=None):
+    """
+    Get a specific milestone
+    """
+    # GET /api/projects/0.1/milestones/{milestone_id}/
+    endpoint = 'milestones/{}'.format(milestone_id)
+
+    response = make_get_request(session, endpoint, params_data=user_details)
+    json_data = response.json()
+    if response.status_code == 200:
+        return json_data['result']
+    else:
+        raise MilestonesNotFoundException(
+            message=json_data['message'], error_code=json_data['error_code']
+        )
 
 
 def award_project_bid(session, bid_id):
@@ -244,8 +295,10 @@ def award_project_bid(session, bid_id):
         return json_data['status']
     else:
         json_data = response.json()
-        raise BidNotAwardedException(message=json_data['message'],
-                                    error_code=json_data['error_code'])
+        raise BidNotAwardedException(
+            message=json_data['message'],
+            error_code=json_data['error_code']
+        )
 
 
 def revoke_project_bid(session, bid_id):
diff --git a/tests/test_projects.py b/tests/test_projects.py
@@ -9,7 +9,7 @@
     request_release_milestone_payment, cancel_milestone_payment,
     create_milestone_request, accept_milestone_request,
     reject_milestone_request, delete_milestone_request,
-    get_jobs
+    get_jobs, get_milestones, get_milestone_by_id
 )
 from freelancersdk.resources.projects.helpers import (
     create_budget_object, create_currency_object, create_job_object,
@@ -145,6 +145,54 @@ def json(self):
         }
 
 
+class FakeGetMilestonesGetResponse:
+    
+    status_code = 200
+
+    def json(self):
+        return {
+            'status': 'success',
+            'result': {
+                'milestones': {
+                    '101': {
+                        'status': 'cleared',
+                        'bidder_id': 100,
+                        'project_id': 102,
+                        'transaction_id': 101
+                    },
+                    '201': {
+                        'status': 'cleared',
+                        'bidder_id': 200,
+                        'project_id': 202,
+                        'transaction_id': 201
+                    }
+                },
+                'users': None,
+            },
+        }
+
+
+class FakeGetMilestoneByIDGetResponse:
+
+    status_code = 200
+
+    def json(self):
+        return {
+            'status': 'success',
+            'result': {
+                'milestones': {
+                    '101': {
+                        'status': 'cleared',
+                        'bidder_id': 100,
+                        'project_id': 102,
+                        'transaction_id': 101
+                    }
+                },
+                'users': None,
+            },
+        }
+
+
 class FakeGetBidsGetResponse:
 
     status_code = 200
@@ -508,6 +556,54 @@ def test_get_bids(self):
             verify=True)
         self.assertEquals(len(j['bids']), 5)
 
+    def test_get_milestones(self):
+        # Dictionary being passed to the python get_milestone function
+        user_details = create_get_projects_user_details_object(
+            country=True,
+            profile_description=True
+        )
+        get_milestones_data = {
+            'milestone_ids': [
+                101,
+                102,
+            ],
+            'limit': 20,
+            'offset': 10,
+            'user_details': user_details
+        }
+
+        self.session.session.get = Mock()
+        self.session.session.get.return_value = FakeGetMilestonesGetResponse()
+        response = get_milestones(self.session, **get_milestones_data)
+
+        # Transforms the dictionary into the actual request sent by the function
+        get_milestones_data.update({'milestones[]': get_milestones_data['milestone_ids']})
+        get_milestones_data.update(user_details)
+        del(get_milestones_data['milestone_ids'])
+        del(get_milestones_data['user_details'])
+
+        self.session.session.get.assert_called_once_with(
+            'https://fake-fln.com/api/projects/0.1/milestones/',
+            params=get_milestones_data,
+            verify=True
+        )
+        self.assertEquals(len(response['milestones']), 2)
+
+    def test_get_milestone(self):
+        milestone_id = 101
+        user_details = create_get_projects_user_details_object(
+            country=True,
+            profile_description=True
+        )
+        self.session.session.get = Mock()
+        self.session.session.get.return_value = FakeGetMilestoneByIDGetResponse()
+        get_milestone_by_id(self.session, milestone_id, user_details)
+        self.session.session.get.assert_called_once_with(
+            'https://fake-fln.com/api/projects/0.1/milestones/{}/'.format(milestone_id),
+            params=user_details,
+            verify=True
+        )
+
     def test_award_project_bid(self):
         bid_data = {
             'bid_id': 1,
