routific 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5a8db035d39a7c9b994a84f4d3663c4218c32d0
-  data.tar.gz: 935947c6fdf1628778c239986b2516061ca29a36
+  metadata.gz: 1ea5df053d952f0517202e18e26493a3d986b739
+  data.tar.gz: 5b13d657ff00d3d4bc930a9e9f0191ac1b009226
 SHA512:
-  metadata.gz: 1798aea34b4919f234e532141bd9e593e3b786da101b36e2f2c0f36ad7af614b84ac73a0d4c7a0ca8da1fbc91eb3025e5f3ab43fb59a7ff75a4237e50e0df784
-  data.tar.gz: ddd45e67797e9b066fee1a6fd4fc86939cc682590529c30cff529f329e881441120ead3a48a5f686d680b9fbd3912848c142487f2f09c75f5c2777fe202f453f
+  metadata.gz: de46d973cc679f1cfe20d1bd3fdd6a9699ba25fb8bb777da63237a8aa4d6d29315af89b8c348c721ce5a4f05ef361d77c6180688b9241ded509d7acb338d1415
+  data.tar.gz: 0e322fc0e842a8df2335e955ab89a66eb38349e15038aff18f570c09074a6ce7da0b971dd074d34a0880b49beb04d72c7a1d6c0bcad04ee8d45cc9d127f9dd79

data/README.md

@@ -63,6 +63,18 @@ Optional arguments in params:
  - shift_end: this vehicle's end shift time (e.g. '17:00'). Default value is 23:59, if not specified.
  - capacity: the capacity that this vehicle can load
 
+`routific.setOptions( params )`
+
+Sets optional options onto the route requests.
+
+Optional arguments must be one of the following:
+
+- traffic
+- min_visits_per_vehicle
+- balance
+- min_vehicles
+- shortest_distance
+
 `routific.getRoute()`
 
 Returns the route using the previously provided network, visits and fleet information

data/lib/routific.rb

@@ -6,10 +6,11 @@ require_relative './routific/visit'
 require_relative './routific/vehicle'
 require_relative './routific/route'
 require_relative './routific/way_point'
+require_relative './routific/options'
 
 # Main class of this gem
 class Routific
-  attr_reader :token, :visits, :fleet
+  attr_reader :token, :visits, :fleet, :options
 
   # Constructor
   # token: Access token for Routific API
@@ -17,20 +18,27 @@ class Routific
     @token = token
     @visits = {}
     @fleet = {}
+    @options = {}
   end
 
   # Sets a visit for the specified location using the specified parameters
   # id: ID of location to visit
   # params: parameters for this visit
   def setVisit(id, params={})
-    visits[id] = Visit.new(id, params)
+    visits[id] = RoutificApi::Visit.new(id, params)
   end
 
   # Sets a vehicle with the specified ID and parameters
   # id: vehicle ID
   # params: parameters for this vehicle
   def setVehicle(id, params)
-    fleet[id] = Vehicle.new(id, params)
+    fleet[id] = RoutificApi::Vehicle.new(id, params)
+  end
+
+  # Sets options with the specified params
+  # params: parameters for these options
+  def setOptions(params)
+    @options = RoutificApi::Options.new(params)
   end
 
   # Returns the route using the previously provided visits and fleet information
@@ -40,6 +48,7 @@ class Routific
       fleet: fleet
     }
 
+    data[:options] = options if options
     Routific.getRoute(data, token)
   end
 
@@ -76,8 +85,8 @@ class Routific
         # Parse the HTTP request response to JSON
         jsonResponse = JSON.parse(response)
 
-        # Parse the JSON representation into a Route object
-        Route.parse(jsonResponse)
+        # Parse the JSON representation into a RoutificApi::Route object
+        RoutificApi::Route.parse(jsonResponse)
       rescue => e
         puts e
         errorResponse = JSON.parse e.response.body

data/lib/routific/location.rb

@@ -1,52 +1,54 @@
-# This class represents a location in the network
-class Location
-  attr_accessor :name, :lat, :lng
+module RoutificApi
+  # This class represents a location in the network
+  class Location
+    attr_accessor :name, :lat, :lng
 
-  # Constructor
-  #
-  # Required arguments in params:
-  # lat: Latitude of this location
-  # lng: Longitude of this location
-  #
-  # Optional arguments in params:
-  # name: Name of this location
-  def initialize(params)
-    # Validates the parameters provided
-    validate(params)
+    # Constructor
+    #
+    # Required arguments in params:
+    # lat: Latitude of this location
+    # lng: Longitude of this location
+    #
+    # Optional arguments in params:
+    # name: Name of this location
+    def initialize(params)
+      # Validates the parameters provided
+      validate(params)
 
-    @lat = params["lat"]
-    @lng = params["lng"]
-    @name = params["name"]
-  end
+      @lat = params["lat"]
+      @lng = params["lng"]
+      @name = params["name"]
+    end
 
-  def ==(another_location)
-    self.name == another_location.name &&
-      self.lat == another_location.lat &&
-      self.lng == another_location.lng
-  end
+    def ==(another_location)
+      self.name == another_location.name &&
+        self.lat == another_location.lat &&
+        self.lng == another_location.lng
+    end
 
-  def to_json(options = nil)
-    as_json(options).to_json
-  end
+    def to_json(options = nil)
+      as_json(options).to_json
+    end
 
-  # Returns the JSON representation of this object
-  # def to_json(options = nil)
-  def as_json(options = nil)
-    jsonData = {}
-    jsonData["name"] = self.name if self.name
-    jsonData["lat"] = self.lat
-    jsonData["lng"] = self.lng
+    # Returns the JSON representation of this object
+    # def to_json(options = nil)
+    def as_json(options = nil)
+      jsonData = {}
+      jsonData["name"] = self.name if self.name
+      jsonData["lat"] = self.lat
+      jsonData["lng"] = self.lng
 
-    jsonData
-  end
+      jsonData
+    end
 
-  private
-  # Validates the parameters being provided
-  # Raises an ArgumentError if any of the required parameters is not provided.
-  # Required parameters are: latitude and longitude
-  def validate(params)
-    if(params["lat"].nil? || params["lng"].nil?)
-      raise ArgumentError, "'lat' and 'lng' parameters must be provided"
+    private
+    # Validates the parameters being provided
+    # Raises an ArgumentError if any of the required parameters is not provided.
+    # Required parameters are: latitude and longitude
+    def validate(params)
+      if(params["lat"].nil? || params["lng"].nil?)
+        raise ArgumentError, "'lat' and 'lng' parameters must be provided"
+      end
     end
   end
 end

data/lib/routific/route.rb

@@ -1,48 +1,47 @@
-# This class represents the resulting route returned by the Routific API
-class Route
-  attr_reader :status, :fitness, :unserved, :vehicleRoutes
+module RoutificApi
+  # This class represents the resulting route returned by the Routific API
+  class Route
+    attr_reader :status, :fitness, :unserved, :vehicleRoutes
 
-  # Constructor
-  def initialize(status, fitness, unserved)
-    @status = status
-    @fitness = fitness
-    @unserved = unserved
-    @vehicleRoutes = Hash.new()
-  end
+    # Constructor
+    def initialize(status, fitness, unserved)
+      @status = status
+      @fitness = fitness
+      @unserved = unserved
+      @vehicleRoutes = Hash.new()
+    end
 
-  # Adds a new way point for the specified vehicle
-  def addWayPoint(vehicle_name, way_point)
-    if @vehicleRoutes[vehicle_name].nil?
-      # No previous way point was added for the specified vehicle, so create a new array
-      @vehicleRoutes[vehicle_name] = []
+    # Adds a new way point for the specified vehicle
+    def addWayPoint(vehicle_name, way_point)
+      if @vehicleRoutes[vehicle_name].nil?
+        # No previous way point was added for the specified vehicle, so create a new array
+        @vehicleRoutes[vehicle_name] = []
+      end
+      # Adds the provided way point for the specified vehicle
+      @vehicleRoutes[vehicle_name] << way_point
     end
-    # Adds the provided way point for the specified vehicle
-    @vehicleRoutes[vehicle_name] << way_point
-  end
 
-  class << self
-    # Parse the JSON representation of a route, and return it as a Route object
-    def parse(routeJson)
-      status = routeJson["status"]
-      fitness = routeJson["fitness"]
-      unserved = routeJson["unserved"]
-      route = Route.new(status, fitness, unserved)
+    class << self
+      # Parse the JSON representation of a route, and return it as a Route object
+      def parse(routeJson)
+        status = routeJson["status"]
+        fitness = routeJson["fitness"]
+        unserved = routeJson["unserved"]
+        route = RoutificApi::Route.new(status, fitness, unserved)
 
-      # Get way points for each vehicles
-      routeJson["solution"].each do |vehicle_name, way_points|
-        # Get all way points for this vehicle
-        way_points.each do |waypoint_info|
-          # Get all information for this way point
-          location_id = waypoint_info["location_id"]
-          arrival_time = waypoint_info["arrival_time"]
-          finish_time = waypoint_info["finish_time"]
-          way_point = WayPoint.new(location_id, arrival_time, finish_time)
-          route.addWayPoint(vehicle_name, way_point)
+        # Get way points for each vehicles
+        routeJson["solution"].each do |vehicle_name, way_points|
+          # Get all way points for this vehicle
+          way_points.each do |waypoint_info|
+            # Get all information for this way point
+            way_point = RoutificApi::WayPoint.new(waypoint_info)
+            route.addWayPoint(vehicle_name, way_point)
+          end
         end
-      end
 
-      # Return the resulting Route object
-      route
+        # Return the resulting Route object
+        route
+      end
     end
   end
 end

data/lib/routific/vehicle.rb

@@ -1,55 +1,57 @@
-# This class represents a vehicle in the fleet
-class Vehicle
-  attr_accessor :id, :start_location, :end_location, :shift_start, :shift_end, :capacity
+module RoutificApi
+  # This class represents a vehicle in the fleet
+  class Vehicle
+    attr_accessor :id, :start_location, :end_location, :shift_start, :shift_end, :capacity
 
-  # Constructor
-  #
-  # Required arguments in params:
-  # start_location: start location for this vehicle. Instance of Location
-  #
-  # Optional arguments in params:
-  # end_location: end location for this vehicle. Instance of Location
-  # shift_start: this vehicle's start shift time (e.g. '08:00'). Default value is 00:00, if not specified.
-  # shift_end: this vehicle's end shift time (e.g. '17:00'). Default value is 23:59, if not specified.
-  # capacity: the capacity that this vehicle can load
-  def initialize(id, params)
-    validate(params)
+    # Constructor
+    #
+    # Required arguments in params:
+    # start_location: start location for this vehicle. Instance of Location
+    #
+    # Optional arguments in params:
+    # end_location: end location for this vehicle. Instance of Location
+    # shift_start: this vehicle's start shift time (e.g. '08:00'). Default value is 00:00, if not specified.
+    # shift_end: this vehicle's end shift time (e.g. '17:00'). Default value is 23:59, if not specified.
+    # capacity: the capacity that this vehicle can load
+    def initialize(id, params)
+      validate(params)
 
-    @id = id
-    @start_location = Location.new(params["start_location"])
-    if params["end_location"]
-      @end_location = Location.new(params["end_location"])
+      @id = id
+      @start_location = RoutificApi::Location.new(params["start_location"])
+      if params["end_location"]
+        @end_location = RoutificApi::Location.new(params["end_location"])
+      end
+      @shift_start = params["shift_start"]
+      @shift_end = params["shift_end"]
+      @capacity = params["capacity"]
     end
-    @shift_start = params["shift_start"]
-    @shift_end = params["shift_end"]
-    @capacity = params["capacity"]
-  end
 
-  def to_json(options=nil)
-    as_json(options).to_json
-  end
+    def to_json(options=nil)
+      as_json(options).to_json
+    end
 
-  # Returns the JSON representation of this object
-  # def to_json(options = nil)
-  def as_json(options = nil)
-    jsonData = {}
-    jsonData["start_location"] = self.start_location.as_json
-    jsonData["end_location"] = self.end_location.as_json if self.end_location
-    jsonData["shift_start"] = self.shift_start if self.shift_start
-    jsonData["shift_end"] = self.shift_end if self.shift_end
-    jsonData["capacity"] = self.capacity if self.capacity
+    # Returns the JSON representation of this object
+    # def to_json(options = nil)
+    def as_json(options = nil)
+      jsonData = {}
+      jsonData["start_location"] = self.start_location.as_json
+      jsonData["end_location"] = self.end_location.as_json if self.end_location
+      jsonData["shift_start"] = self.shift_start if self.shift_start
+      jsonData["shift_end"] = self.shift_end if self.shift_end
+      jsonData["capacity"] = self.capacity if self.capacity
 
-    jsonData
-  end
+      jsonData
+    end
 
 
-  private
-  # Validates the parameters being provided
-  # Raises an ArgumentError if any of the required parameters is not provided.
-  # Required parameters are: location
-  def validate(params)
-    if params["start_location"].nil?
-      raise ArgumentError, "'start-location' parameter must be provided"
+    private
+    # Validates the parameters being provided
+    # Raises an ArgumentError if any of the required parameters is not provided.
+    # Required parameters are: location
+    def validate(params)
+      if params["start_location"].nil?
+        raise ArgumentError, "'start-location' parameter must be provided"
+      end
     end
   end
 end

data/lib/routific/visit.rb

@@ -1,49 +1,51 @@
-# This class represents a location to be visited
-class Visit
-  attr_reader :id, :start, :end, :duration, :demand, :location
+module RoutificApi
+  # This class represents a location to be visited
+  class Visit
+    attr_reader :id, :start, :end, :duration, :demand, :location
 
-  # Constructor
-  #
-  # Optional arguments in params:
-  # start: the earliest time for this visit. Default value is 00:00, if not specified.
-  # end: the latest time for this visit. Default value is 23:59, if not specified.
-  # duration: the length of this visit in minutes
-  # demand: the capacity that this visit requires
-  # location: the location of the visit. Instance of Location
-  def initialize(id, params = {})
-    validate(params)
-    @id = id
-    @start = params["start"]
-    @end = params["end"]
-    @duration = params["duration"]
-    @demand = params["demand"]
-    @location = Location.new(params["location"])
-  end
+    # Constructor
+    #
+    # Optional arguments in params:
+    # start: the earliest time for this visit. Default value is 00:00, if not specified.
+    # end: the latest time for this visit. Default value is 23:59, if not specified.
+    # duration: the length of this visit in minutes
+    # demand: the capacity that this visit requires
+    # location: the location of the visit. Instance of Location
+    def initialize(id, params = {})
+      validate(params)
+      @id = id
+      @start = params["start"]
+      @end = params["end"]
+      @duration = params["duration"]
+      @demand = params["demand"]
+      @location = RoutificApi::Location.new(params["location"])
+    end
 
-  def to_json(options)
-    as_json(options).to_json
-  end
+    def to_json(options)
+      as_json(options).to_json
+    end
 
-  # Returns the JSON representation of this object
-  # def to_json(options = nil)
-  def as_json(options = nil)
-    jsonData = {}
-    jsonData["start"] = self.start if self.start
-    jsonData["end"] = self.end if self.end
-    jsonData["duration"] = self.duration if self.duration
-    jsonData["demand"] = self.demand if self.demand
-    jsonData["location"] = self.location.as_json
+    # Returns the JSON representation of this object
+    # def to_json(options = nil)
+    def as_json(options = nil)
+      jsonData = {}
+      jsonData["start"] = self.start if self.start
+      jsonData["end"] = self.end if self.end
+      jsonData["duration"] = self.duration if self.duration
+      jsonData["demand"] = self.demand if self.demand
+      jsonData["location"] = self.location.as_json
 
-    jsonData
-  end
+      jsonData
+    end
 
-  private
-  # Validates the parameters being provided
-  # Raises an ArgumentError if any of the required parameters is not provided.
-  # Required parameters are: location
-  def validate(params)
-    if params["location"].nil?
-      raise ArgumentError, "'location' parameter must be provided"
+    private
+    # Validates the parameters being provided
+    # Raises an ArgumentError if any of the required parameters is not provided.
+    # Required parameters are: location
+    def validate(params)
+      if params["location"].nil?
+        raise ArgumentError, "'location' parameter must be provided"
+      end
     end
   end
 end

data/lib/routific/way_point.rb

@@ -1,11 +1,14 @@
-# This class represents a location to visit in the route
-class WayPoint
-  attr_reader :location_id, :arrival_time, :finish_time
+module RoutificApi
+  # This class represents a location to visit in the route
+  class WayPoint
+    attr_reader :location_id, :arrival_time, :finish_time, :location_name
 
-  # Constructor
-  def initialize(location_id, arrival_time, finish_time)
-    @location_id = location_id
-    @arrival_time = arrival_time
-    @finish_time = finish_time
+    # Constructor
+    def initialize(options = {})
+      @location_id = options['location_id']
+      @arrival_time = options['arrival_time']
+      @finish_time = options['finish_time']
+      @location_name = options['location_name']
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routific
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Marc Kuo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -81,34 +81,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 description: Gem to use Routific API
 email: asoesilo@live.com
 executables: []