Merge pull request #25 from tommycbird/patch-0.3

Added Slowdowns with example, Make_request changes/bug fixes, testing and changes to clean_dict

Author: r4m-juan

examples/slowdowns/set_slowdowns.py

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+# codebeat:disable[SIMILARITY, LOC, ABC]
+
+import argparse
+from route4me import Route4Me
+
+from route4me.constants import (
+    ALGORITHM_TYPE,
+    OPTIMIZE,
+    DEVICE_TYPE,
+    TRAVEL_MODE,
+    DISTANCE_UNIT
+)
+
+
+def main(api_key):
+    r4m = Route4Me(api_key)
+
+    optimization = r4m.optimization
+    address = r4m.address
+    optimization.algorithm_type(ALGORITHM_TYPE.TSP)
+    optimization.share_route(0)
+    optimization.store_route(0)
+    optimization.route_time(0)
+    optimization.rt(1)
+    optimization.route_max_duration(86400)
+    optimization.vehicle_max_distance_mi(10000)
+    optimization.route_name('Single Driver Round Trip With Slowdowns - Large Slowdowns')
+    optimization.optimize(OPTIMIZE.TIME)
+    optimization.distance_unit(DISTANCE_UNIT.MI)
+    optimization.device_type(DEVICE_TYPE.WEB)
+    optimization.travel_mode(TRAVEL_MODE.DRIVING)
+
+    # Set Slowdowns
+    service_time = 20
+    travel_time = 30
+    optimization.set_slowdowns(service_time, travel_time)
+
+    address.add_address(
+        address='754 5th Ave New York, NY 10019',
+        lat=40.7636197,
+        lng=-73.9744388,
+        alias='Bergdorf Goodman',
+        is_depot=1,
+        time=0
+    )
+    address.add_address(
+        address='717 5th Ave New York, NY 10022',
+        lat=40.7669692,
+        lng=-73.9693864,
+        alias='Giorgio Armani',
+        time=0
+    )
+    address.add_address(
+        address='888 Madison Ave New York, NY 10014',
+        lat=40.7715154,
+        lng=-73.9669241,
+        alias='Ralph Lauren Women\'s and Home',
+        time=0
+    )
+    address.add_address(
+        address='1011 Madison Ave New York, NY 10075',
+        lat=40.7772129,
+        lng=-73.9669,
+        alias='Yigal Azrou\u00ebl',
+        time=0
+    )
+    address.add_address(
+        address='440 Columbus Ave New York, NY 10024',
+        lat=40.7808364,
+        lng=-73.9732729,
+        alias='Frank Stella Clothier',
+        time=0
+    )
+    address.add_address(
+        address='324 Columbus Ave #1 New York, NY 10023',
+        lat=40.7803123,
+        lng=-73.9793079,
+        alias='Liana',
+        time=0
+    )
+    address.add_address(
+        address='110 W End Ave New York, NY 10023',
+        lat=40.7753077,
+        lng=-73.9861529,
+        alias='Toga Bike Shop',
+        time=0
+    )
+    address.add_address(
+        address='555 W 57th St New York, NY 10019',
+        lat=40.7718005,
+        lng=-73.9897716,
+        alias='BMW of Manhattan',
+        time=0
+    )
+    address.add_address(
+        address='57 W 57th St New York, NY 10019',
+        lat=40.7558695,
+        lng=-73.9862019,
+        alias='Verizon Wireless',
+        time=0
+    )
+
+    response = r4m.run_optimization()
+
+    print("Optimized route:")
+    for route in response["routes"]:
+        print(route["addresses"])
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description='Single Driver Round Trip With Slowdowns - 20,30')
+    parser.add_argument('--api_key', dest='api_key', help='Route4Me API KEY',
+                        type=str, required=True)
+    args = parser.parse_args()
+    main(args.api_key)
+
+# codebeat:enable[SIMILARITY, LOC, ABC]

route4me/optimization.py

@@ -3,6 +3,7 @@
 from .api_endpoints import ADDRESS_HOST, API_HOST
 from .base import Base
 from .exceptions import ParamValueException, APIException
+from .slowdowns import Slowdowns
 
 
 class Optimization(Base):
@@ -121,3 +122,13 @@ def delete_address_from_optimization(self, **kwargs):
                 return e.to_dict()
         else:
             raise ParamValueException('params', 'Params are not complete')
+
+    def set_slowdowns(self, service_time, travel_time):
+        """
+        Set slowdowns param
+        :param service_time:
+        :param travel_time:
+        :return:
+        """
+        slowdowns = Slowdowns(service_time, travel_time)
+        self._copy_data({"slowdowns": slowdowns.to_dict()})

route4me/slowdowns.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+class Slowdowns():
+    """
+    Slowdowns Management
+    """
+
+    def __init__(self, service_time, travel_time):
+        self.validate(service_time, travel_time)
+        self.service_time = service_time
+        self.travel_time = travel_time
+
+    def validate(self, service_time, travel_time):
+        if not isinstance(service_time, int) or service_time < 0 or service_time > 50:
+            raise ValueError("Service time must be an integer between 0 and 50")
+
+        if not isinstance(travel_time, int) or travel_time < 0 or travel_time > 50:
+            raise ValueError("Travel time must be an integer between 0 and 50")
+
+    def to_dict(self):
+        return {
+            'service_time': self.service_time,
+            'travel_time': self.travel_time
+        }