routific 1.1.2 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a92a096b9aa04f8eed0c72c8b45d4ca262fd6f15
-  data.tar.gz: fdfe5a0030a05a98a5427484c4368325a7b16d93
+  metadata.gz: 6449926da7cc8d2f56c751103acc80b3f4301f58
+  data.tar.gz: 3e9d86b6c6a2890ae96b0acc862b0d13dbeea134
 SHA512:
-  metadata.gz: d20604a843d68aa9a10bc72ba6e63305b7bb65f0a729c2a58e08dab12c5829ff30eadbe31076d0927c14d351ffe82edf8492ba875bad49c85d6b933afc86ee32
-  data.tar.gz: be1a38259698b29c679446377ce38f1d09497cf2be9be87f2f960bf5f9fa4a5df04781f7eab15fe7ad73b4f2c28003ee747f4cc0b84d1213453e882e3f8a077e
+  metadata.gz: 3cbed53fcca005a88e1f9a11f198d6a76928903340935d0ac0117a2e0f193d2f3b744de82ee6a5ad2ef545da4414d433cc664e1c4e1236ee90eefb42b26423ca
+  data.tar.gz: 0c4ef3aa08f1974a97b2a6325331fa6394c414b7edec36845bfcf145af95da514ce68a0cb4dafdcfd76c48c88edfdaf7d7b01474813ffa322427695ccd7c1c0f

data/README.md

@@ -1,12 +1,14 @@
 Routific Ruby Gem
 =================
 
-[![Build Status](https://secure.travis-ci.org/routific/routific-gem.png)](http://travis-ci.org/routific/routific-gem)
+[![Build Status](https://travis-ci.org/routific/routific-gem.svg?branch=master)](https://travis-ci.org/routific/routific-gem)
 
 This Ruby Gem assists users to easily access the [Routific API][1], which is a practical and scalable solution to the Vehicle Routing Problem.
 
   [1]: https://routific.com/developers
 
+Please refer to the full [documentation](https://docs.routific.com) for a detailled documentation of the API.
+
 Installing
 ----------
 
@@ -14,100 +16,14 @@ Installing
 
 Usage
 -----
-Remember to require it and instantiate it with your token before using it
-
-```ruby
-require 'routific'
-routific = Routific.new(--API_KEY--)
-```
-
-### Instance methods
-
-`routific.setVisit( id, [params] )`
-
-Sets a visit for the specified location using the specified parameters
-
-Required arguments in params:
-
-- location: Object representing the location of the visit.
-  + lat: Latitude of this location
-  + lng: Longitude of this location
-  + name: (optional) Name of the location
-
-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
-
-`routific.setVehicle( id, params )`
-
-Sets a vehicle with the specified ID and parameters
-
-Required arguments in params:
-
-- start_location: Object representing the start location for this vehicle.
-  + lat: Latitude of this location
-  + lng: Longitude of this location
-  + name: (optional) Name of the location
-
-Optional arguments in params:
-
- - end_location: Object representing the end location for this vehicle.
-  + lat: Latitude of this location
-  + lng: Longitude of this location
-  + name: (optional) Name of the 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
-
-`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
-
-
-### Class methods
-
-`Routific.setToken( token )`
-
-Sets the default access token to use
-
-`Routific.getRoute( id, [params] )`
-
-Returns the route using the specified access token, network, visits and fleet information
-
-
-Both getRoute functions return the Route object, which has the following attributes:
-
- - status: A sanity check, will always be success when the HTTP code is 200
- - fitness: Total travel-time, representing the fitness score of the solution (less is better)
- - unserved: List of visits that could not be scheduled.
- - vehicleRoutes: The optimized schedule
-
-Examples
---------
-Example 1:
+Remember to require it and set your token before using it
 
 ```ruby
 require 'routific'
+Routific.set_token("YOUR_API_KEY_HERE")
+routific = Routific.new
 
-routific = Routific.new(--API_KEY--)
-
-routific.setVisit("order_1", {
+routific.set_visit("order_1", {
   "start" => "9:00",
   "end" => "12:00",
   "duration" => 10,
@@ -118,7 +34,18 @@ routific.setVisit("order_1", {
   }
 })
 
-routific.setVehicle("vehicle_1", {
+routific.set_visit("order_2", {
+  "start" => "9:00",
+  "end" => "12:00",
+  "duration" => 10,
+  "location" => {
+    "name"=> "3780 Arbutus",
+    "lat"=> 49.2474624,
+    "lng"=> -123.1532338
+  }
+})
+
+routific.set_vehicle("vehicle_1", {
   "start_location" => {
     "name" => "800 Kingsway",
     "lat" => 49.2553636,
@@ -133,50 +60,120 @@ routific.setVehicle("vehicle_1", {
   "shift_end" => "12:00",
 })
 
-route = routific.getRoute()
+route = routific.get_route()
+
+
+puts route.status # => "success"
+puts route.total_travel_time # => 29
+
+vehicle_routes = route.vehicle_routes
+
+v1_route = vehicle_routes["vehicle_1"]
+puts v1_route.length # => 4 (start -> order_1 -> order_2 -> end)
+
+v1_route.each do |w|
+  puts "#{w.location_id}: #{w.arrival_time} ~ #{w.finish_time}"
+end
+# vehicle_1_start: 08:49 ~
+# order_1: 09:00 ~ 09:10
+# order_2: 09:18 ~ 09:28
+# vehicle_1_end: 09:38 ~
+
 ```
 
-Example 2:
+### Class methods
 
-```ruby
-require 'routific'
+`Routific.set_token( token )` sets the authentication token to use.
 
-Routific.setToken(--API_KEY--)
-
-visits = {
-  "order_1" => {
-    "start" => "9:00",
-    "end" => "12:00",
-    "duration" => 10,
-    "location" => {
-      "name" => "6800 Cambie",
-      "lat" => 49.227107,
-      "lng" => -123.1163085
-    }
-  }
-}
-
-fleet = {
-  "vehicle_1" => {
-    "start_location" => {
-      "name" => "800 Kingsway",
-      "lat" => 49.2553636,
-      "lng" => -123.0873365
-    },
-    "end_location" => {
-      "name" => "800 Kingsway",
-      "lat" => 49.2553636,
-      "lng" => -123.0873365
-    },
-    "shift_start" => "8:00",
-    "shift_end" => "12:00"
-  }
-}
+### Instance methods
+
+#### `routific.set_visit( id, params )`
 
-data = {
-  visits: visits,
-  fleet: fleet
-}
+Sets a visit with the specified id and parameters:
 
-route = Routific.getRoute(data)
+- `location` (*required*): Object representing the location of the visit.
+  + lat: Latitude of this location
+  + lng: Longitude of this location
+  + name: (optional) Name of the location
+- `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
+- `priority`: higher priority visits are more likely to be served
+- `type`: restrict the vehicle that can serve this visit
+- `time_windows`: specify different time-windows for serving the visit.
+It should be an array of hashes: `[ { "start" => "08:00", "end" => "12:00" } ]`
+
+#### `routific.set_vehicle( id, params )`
+
+Sets a vehicle with the specified ID and parameters:
+- `start_location` (*required*): Object representing the start location for this vehicle.
+  + lat: Latitude of this location
+  + lng: Longitude of this location
+  + name: (optional) Name of the location
+- `end_location`: Object representing the end location for this vehicle.
+  + lat: Latitude of this location
+  + lng: Longitude of this location
+  + name: (optional) Name of the 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
+- `type`: restrict the visit this vehicle can serve
+- `speed`: vehicle speed
+- `min_visits`: minimum number of visits that should be assigned to this vehicle
+- `strict_start`: force the departure time to be `shift_start`
+- `breaks`: specify breaks for the driver.
+It should be an array of hashes: `[ { "id" => "lunch", "start" => "12:00", "end" => "12:30" } ]`
+
+#### `routific.set_options( 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`
+- `squash_duration`
+- `max_vehicle_overtime`
+- `max_visit_lateness`
+
+#### `routific.get_route()`
+
+Returns an optimized route using the previously provided visits, fleet and options.
+The request may timeout if the problem is too large.
+
+It returns a route object with the following attributes:
+- `status`: A sanity check
+- `unserved`: List of visits that could not be scheduled.
+- `vehicle_routes`: The optimized schedule
+- other attributes that you can find in the [full documentation](https://docs.routific.com)
+
+The `vehicle_routes` attribute is a hash mapping vehicle ID to the corresponding route, represented as an array of waypoints: `{ "vehicle_1" => [ way_point_1, way_point_2, way_point_3, way_point_4 ] }`
+
+The waypoint object has the following attributes:
+- `location_id`
+- `arrival_time`
+- `finish_time`
+- other attributes that you can find in the [full documentation](https://docs.routific.com)
+
+#### `routific.get_route_async()`
+
+For requests with 60 visits and more, it is recommended to make asynchronous call to the API.
+
+```ruby
+job = routific.get_route_async()
+puts job.status # => "pending"
+sleep 5
+job.fetch
+puts job.status # => "finished"
+route = job.route
 ```
+
+It returns a job object with the following attibutes:
+- `status`: status of the task ('pending', 'processing', 'finished', 'error')
+- `id`: a unique identifier for the task
+- `created_at`, `finished_at`: creation and finish times
+- `input`: the data used for the request
+- `route`: a route object

data/lib/routific.rb

@@ -1,21 +1,22 @@
-require 'rest-client'
-require 'json'
-
 require_relative './routific/location'
 require_relative './routific/visit'
+require_relative './routific/break'
 require_relative './routific/vehicle'
 require_relative './routific/route'
 require_relative './routific/way_point'
 require_relative './routific/options'
+require_relative './routific/job'
+
+require_relative './util'
 
 # Main class of this gem
 class Routific
-  attr_reader :token, :visits, :fleet, :options
+  attr_reader :visits, :fleet, :options
+  @@token = nil
 
   # Constructor
-  # token: Access token for Routific API
-  def initialize(token)
-    @token = token
+  def initialize()
+    Routific.validate_token
     @visits = {}
     @fleet = {}
     @options = {}
@@ -24,75 +25,61 @@ class Routific
   # 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={})
+  def set_visit(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)
+  def set_vehicle(id, params)
     fleet[id] = RoutificApi::Vehicle.new(id, params)
   end
 
   # Sets options with the specified params
   # params: parameters for these options
-  def setOptions(params)
+  def set_options(params)
     @options = RoutificApi::Options.new(params)
   end
 
   # Returns the route using the previously provided visits and fleet information
-  def getRoute
+  def get_route
     data = {
       visits: visits,
       fleet: fleet
     }
 
     data[:options] = options if options
-    Routific.getRoute(data, token)
+    result = Util.send_request("POST", "vrp", Routific.token, data)
+    RoutificApi::Route.parse(result)
+  end
+
+  def get_route_async
+    data = {
+      visits: visits,
+      fleet: fleet
+    }
+
+    data[:options] = options if options
+    result = Util.send_request("POST", "vrp-long", Routific.token, data)
+    RoutificApi::Job.new(result["job_id"], data)
   end
 
   class << self
     # Sets the default access token to use
-    def setToken(token)
+    def set_token(token)
       @@token = token
+      validate_token
+      @@token = Util.prefix_token(@@token)
     end
 
     def token
       @@token
     end
 
-    # Returns the route using the specified access token, visits and fleet information
-    # If no access token is provided, the default access token previously set is used
-    # If the default access token either is nil or has not been set, an ArgumentError is raised
-    def getRoute(data, token = @@token)
-      if token.nil?
-        raise ArgumentError, "access token must be set"
-      end
-
-      # Prefix the token with "bearer " if missing during assignment
-      prefixed_token = (/bearer /.match(token).nil?) ? "bearer #{token}" : token
-
-      begin
-        # Sends HTTP request to Routific API server
-        response = RestClient.post('https://api.routific.com/v1/vrp',
-          data.to_json,
-          'Authorization' => prefixed_token,
-          content_type: :json,
-          accept: :json
-          )
-
-        # Parse the HTTP request response to JSON
-        jsonResponse = JSON.parse(response)
-
-        # Parse the JSON representation into a RoutificApi::Route object
-        RoutificApi::Route.parse(jsonResponse)
-      rescue => e
-        puts e
-        errorResponse = JSON.parse e.response.body
-        puts "Received HTTP #{e.message}: #{errorResponse["error"]}"
-        nil
-      end
+    def validate_token
+      raise ArgumentError, "access token must be set" if @@token.nil?
     end
+
   end
 end

data/lib/routific/break.rb

@@ -0,0 +1,59 @@
+module RoutificApi
+  # This class represent a vehicle break
+  class Break
+    REQUIRED_PARAMS = %w{ id start end }
+
+    attr_reader *REQUIRED_PARAMS
+    attr_reader :in_transit
+
+    # Constructor
+    #
+    # Required arguments in params:
+    # id: unique identifier for the break (e.g. 'lunch-break')
+    # start: start time of the break (e.g. '12:00')
+    # end: end time of the break (e.g. '12:30')
+    #
+    # Optional argument in params:
+    # in_transit: whether the vehicle can be in movement during the break (e.g. true). The default value is false.
+    def initialize(params)
+      validate(params)
+
+      @id = params["id"]
+      @start = params["start"]
+      @end = params["end"]
+      @in_transit = params["in_transit"] unless params["in_transit"].nil?
+    end
+
+    def ==(another_break)
+      self.id == another_break.id &&
+        self.start == another_break.start &&
+        self.end == another_break.end &&
+        self.in_transit == another_break.in_transit
+    end
+
+    def to_json(options = nil)
+      as_json(options).to_json
+    end
+
+    def as_json(options = nil)
+      jsonData = {}
+      jsonData["id"] = self.id
+      jsonData["start"] = self.start
+      jsonData["end"] = self.end
+      jsonData["in_transit"] = self.in_transit unless self.in_transit.nil?
+
+      jsonData
+    end
+
+    private
+    # Validates the parameters being provided
+    # Raises an ArgumentError if any of the required parameters is not provided.
+    def validate(params)
+      REQUIRED_PARAMS.each do |param|
+        if params[param].nil?
+          raise ArgumentError, "'#{param}' parameter must be provided in break"
+        end
+      end
+    end
+  end
+end

data/lib/routific/job.rb

@@ -0,0 +1,25 @@
+module RoutificApi
+  # This class represents a job returned by vrp-long 
+  class Job
+    FIELDS = [:status, :created_at, :finished_at]
+    attr_reader *FIELDS
+    attr_reader :input, :id, :route
+
+    # Constructor
+    def initialize(id, input)
+      @id = id
+      @input = input
+      @status = 'pending'
+    end
+
+    def fetch
+      job_data = Util.send_request("GET", "jobs/#{@id}")
+
+      FIELDS.each do |field|
+        instance_variable_set "@#{field}", job_data[field.to_s]
+      end
+      @route = RoutificApi::Route.parse(job_data["output"]) if job_data["output"]
+      job_data['status']
+    end
+  end
+end

data/lib/routific/options.rb

@@ -1,19 +1,17 @@
 module RoutificApi
   # This class represents a set of options for the request
   class Options
-    VALID_PARAMS = %w{ traffic min_visits_per_vehicle balance min_vehicles shortest_distance }
+    VALID_PARAMS = %w{ traffic min_visits_per_vehicle balance min_vehicles shortest_distance squash_durations max_vehicle_overtime max_visit_lateness }
 
     attr_reader *VALID_PARAMS
 
     def initialize(params)
       # Validates the provided parameters
       validate(params)
-
-      @traffic = params["traffic"]
-      @min_visits_per_vehicle = params["min_visits_per_vehicle"]
-      @balance = params["balance"]
-      @min_vehicles = params["min_vehicles"]
-      @shortest_distance = params["shortest_distance"]
+      
+      VALID_PARAMS.each do |param|
+        instance_variable_set "@#{param}", params[param]
+      end
     end
 
     def to_json(options)
@@ -24,19 +22,17 @@ module RoutificApi
     # def to_json(options = nil)
     def as_json(options = nil)
       jsonData = {}
-      jsonData["traffic"] = self.traffic if self.traffic
-      jsonData["min_visits_per_vehicle"] = self.min_visits_per_vehicle if self.min_visits_per_vehicle
-      jsonData["balance"] = self.balance if self.balance
-      jsonData["shortest_distance"] = self.shortest_distance if self.shortest_distance
-      jsonData["min_vehicles"] = self.min_vehicles if self.min_vehicles
-
+      
+      VALID_PARAMS.each do |param|
+        instance_var = instance_variable_get "@#{param}"
+        jsonData[param] = instance_var if instance_var
+      end
       jsonData
     end
 
     private
     # Validates the parameters being provided
     # Raises an ArgumentError if any of the provided params is not supported
-    # Supported params are traffic, min_visits_per_vehicle, and balance
     def validate(params)
       invalid = params.keys.reject { |k| VALID_PARAMS.include?(k) }
 

data/lib/routific/route.rb

@@ -1,23 +1,29 @@
 module RoutificApi
   # This class represents the resulting route returned by the Routific API
   class Route
-    attr_reader :status, :unserved, :vehicleRoutes, :total_travel_time, :total_idle_time
+    FIELDS = [
+      :status,
+      :unserved, :num_unserved,
+      :distances, :total_distance,
+      :total_working_time, :total_travel_time,
+      :total_break_time, :total_idle_time,
+      :total_visit_lateness, :num_late_visits,
+      :vehicle_overtime, :total_overtime
+    ]
+
+    attr_reader *FIELDS
+    attr_reader :vehicle_routes
 
     # Constructor
-    def initialize(status:, solution: {}, unserved: {}, total_travel_time: 0,
-    total_idle_time: 0, total_break_time: 0, total_working_time: 0)
-      @status = status
-      @unserved = unserved
-      @total_idle_time = total_idle_time
-      @total_travel_time = total_travel_time
-      @total_break_time = total_break_time
-      @total_working_time = total_working_time
-
-      add_solution(solution)
+    def initialize(data)
+      FIELDS.each do |field|
+        instance_variable_set "@#{field}", data[field]
+      end
+      add_solution(data[:solution] || {})
     end
 
     def add_solution(solution)
-      @vehicleRoutes = {}
+      @vehicle_routes = {}
 
       solution.each do |vehicle_name, way_points|
         # Get all way points for this vehicle
@@ -31,16 +37,12 @@ module RoutificApi
 
     # Adds a new way point for the specified vehicle
     def add_way_point(vehicle_name, way_point)
-      if @vehicleRoutes[vehicle_name].nil?
+      if @vehicle_routes[vehicle_name].nil?
         # No previous way point was added for the specified vehicle, so create a new array
-        @vehicleRoutes[vehicle_name] = []
+        @vehicle_routes[vehicle_name] = []
       end
       # Adds the provided way point for the specified vehicle
-      @vehicleRoutes[vehicle_name] << way_point
-    end
-
-    def number_of_unserved
-      @number_of_unserved ||= unserved.count
+      @vehicle_routes[vehicle_name] << way_point
     end
 
     class << self
@@ -54,10 +56,6 @@ module RoutificApi
         hash.keys.each do |key|
           hash[(key.to_sym rescue key) || key] = hash.delete(key)
         end
-
-        hash.delete(:num_unserved)
-        hash.delete(:unserved) if hash[:unserved] == nil
-
         hash
       end
     end

data/lib/routific/vehicle.rb

@@ -1,7 +1,10 @@
+require_relative './break'
+
 module RoutificApi
   # This class represents a vehicle in the fleet
   class Vehicle
-    attr_accessor :id, :start_location, :end_location, :shift_start, :shift_end, :capacity
+    attr_accessor :id, :start_location, :end_location, :shift_start,
+      :shift_end, :capacity, :strict_start, :min_visits, :speed, :breaks, :type
 
     # Constructor
     #
@@ -24,6 +27,13 @@ module RoutificApi
       @shift_start = params["shift_start"]
       @shift_end = params["shift_end"]
       @capacity = params["capacity"]
+      @strict_start = params["strict_start"]
+      @min_visits = params["min_visits"]
+      @speed = params["speed"]
+      @type = params["type"]
+      if params["breaks"]
+        @breaks = params["breaks"].map{ |brk| RoutificApi::Break.new(brk) }
+      end
     end
 
     def to_json(options=nil)
@@ -33,14 +43,21 @@ module RoutificApi
     # 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
+      json_data = {}
+      json_data["start_location"] = self.start_location.as_json
+      json_data["end_location"] = self.end_location.as_json if self.end_location
+      json_data["shift_start"] = self.shift_start if self.shift_start
+      json_data["shift_end"] = self.shift_end if self.shift_end
+      json_data["capacity"] = self.capacity if self.capacity
+      json_data["strict_start"] = self.strict_start if not self.strict_start.nil?
+      json_data["min_visits"] = self.min_visits if self.min_visits
+      json_data["speed"] = self.speed if self.speed
+      json_data["type"] = self.type if self.type
+      if self.breaks
+        json_data["breaks"] = self.breaks.map{ |brk| brk.as_json }
+      end
+
+      json_data
     end
 
 

data/lib/routific/visit.rb

@@ -1,7 +1,8 @@
 module RoutificApi
   # This class represents a location to be visited
   class Visit
-    attr_reader :id, :start, :end, :duration, :demand, :location
+    attr_reader :id, :start, :end, :duration, :demand, :location, :priority,
+      :time_windows, :type
 
     # Constructor
     #
@@ -19,6 +20,11 @@ module RoutificApi
       @duration = params["duration"]
       @demand = params["demand"]
       @location = RoutificApi::Location.new(params["location"])
+      @priority = params["priority"]
+      @type = params["type"]
+      if params["time_windows"]
+        @time_windows = params["time_windows"].map{ |tw| TimeWindow.new(tw) }
+      end
     end
 
     def to_json(options)
@@ -28,14 +34,19 @@ module RoutificApi
     # 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
+      json_data = {}
+      json_data["start"] = self.start if self.start
+      json_data["end"] = self.end if self.end
+      json_data["duration"] = self.duration if self.duration
+      json_data["demand"] = self.demand if self.demand
+      json_data["location"] = self.location.as_json
+      json_data["priority"] = self.priority if self.priority
+      json_data["type"] = self.type if self.type
+      if self.time_windows
+        json_data["time_windows"] = self.time_windows.map{ |tw| tw.as_json }
+      end
+
+      json_data
     end
 
     private
@@ -47,5 +58,33 @@ module RoutificApi
         raise ArgumentError, "'location' parameter must be provided"
       end
     end
+
+    public
+    class TimeWindow
+      attr_reader :start, :end
+
+      # Constructor
+      #
+      # Optional arguments
+      # start: start of the time-window
+      # end: end of the time-window
+      def initialize(params)
+        @start = params["start"]
+        @end = params["end"]
+      end
+
+      def ==(another_tw)
+        self.start == another_tw.start &&
+          self.end == another_tw.end
+      end
+
+      def as_json
+        json_data = {}
+        json_data["start"] = self.start if self.start
+        json_data["end"] = self.end if self.end
+
+        json_data
+      end
+    end
   end
 end

data/lib/routific/way_point.rb

@@ -1,14 +1,20 @@
 module RoutificApi
   # This class represents a location to visit in the route
   class WayPoint
-    attr_reader :location_id, :arrival_time, :finish_time, :location_name
+    FIELDS = [
+      :location_id, :location_name,
+      :arrival_time, :finish_time,
+      :id, :break, :start, :end, :in_transit, # breaks
+      :late_by # visit lateness
+    ]
+
+    attr_reader *FIELDS
 
     # Constructor
     def initialize(options = {})
-      @location_id = options['location_id']
-      @arrival_time = options['arrival_time']
-      @finish_time = options['finish_time']
-      @location_name = options['location_name']
+      FIELDS.each do |field|
+        instance_variable_set "@#{field}", options[field.to_s]
+      end
     end
   end
 end

data/lib/util.rb

@@ -0,0 +1,41 @@
+require 'rest-client'
+require 'json'
+
+module Util
+  BASE_URL = 'https://api.routific.com/v1/'
+
+  ##
+  # method: "GET", "POST"
+  # endpoint: "vrp", "vrp-long", "job"
+  # token: if nil, raise ArgumentError; if missing "bearer", prefix
+  # data: only for POST requests
+  #
+  def self.send_request(method, endpoint, token = nil, data = nil)
+    url = BASE_URL + endpoint
+    headers = {
+      content_type: :json,
+      accept: :json
+    }
+    headers['Authorization'] = token if token
+    begin
+      # Sends HTTP request to Routific API server
+      response = nil
+      if method == 'GET'
+        response = RestClient.get(url, headers)
+      elsif method == 'POST'
+        response = RestClient.post(url, data.to_json, headers)
+      end
+
+      return JSON.parse(response)
+    rescue => e
+      puts e
+      errorResponse = JSON.parse e.response.body
+      puts "Received HTTP #{e.message}: #{errorResponse["error"]}"
+      nil
+    end
+  end
+
+  def self.prefix_token(token)
+    (/bearer /.match(token).nil?) ? "bearer #{token}" : token
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routific
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.7.1
 platform: ruby
 authors:
-- Marc Kuo
-- Andre Soesilo
+- Routific
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -57,16 +56,16 @@ dependencies:
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.6.2
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -82,19 +81,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.11'
 description: Gem to use Routific API
-email: andre@routific.com
+email: support@routific.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - lib/routific.rb
+- lib/routific/break.rb
+- lib/routific/job.rb
 - lib/routific/location.rb
 - lib/routific/options.rb
 - lib/routific/route.rb
 - lib/routific/vehicle.rb
 - lib/routific/visit.rb
 - lib/routific/way_point.rb
+- lib/util.rb
 homepage: https://routific.com/
 licenses:
 - MIT
@@ -116,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: routific API