routific 0.0.4 → 1.0.0a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 340ed36c4db7569fd0679c3e58431486ecfaeaf9
-  data.tar.gz: f4b9bc9f9b6b9dd71a7a4224e6d375838e1df543
+  metadata.gz: c43eb62c5c532be88022366d509eb35ed7d9bf06
+  data.tar.gz: 2d6d5a8452eeab57ff608196bcf48fc19de7eda6
 SHA512:
-  metadata.gz: 3e7e5acc2e1c239251fc6cf0dae6898a1b47a2b3870500f1df6d068ed61a73bc1e252a92f5ed896b35862e115def1638750d15baaf89e162c7ce74741f09f4e6
-  data.tar.gz: ddde157979fa350588935653e8ae63e2197fe685e5352f65c4c6e76cedfbf0b3fb4b79d7de5519daa1bfe28377b30b474382e47236fc800161c90256e83f9ef6
+  metadata.gz: df8cea59d6224904a54e20ac9c13e222b66c074e85e2abbcb5a4029244e150ddf4126fbed2ad2e3b36913af2ec0eeb0efa63b0961ed9306e6426dfd0bb230746
+  data.tar.gz: 93f6fcf341e85634b8f055b848013679a0c41c629ab2996a1440595966279763c147c9e549de8b5101ed1620878dbc2d0cf4c16a2f55d70c81d7e99d711bfc5a

data/README.md

@@ -23,22 +23,16 @@ routific = Routific.new(--API_KEY--)
 
 ### Instance methods
 
-`routific.setLocation( id, params )`
+`routific.setVisit( id, [params] )`
 
-Sets a location with the specified ID and parameters
+Sets a visit for the specified location using the specified parameters
 
 Required arguments in params:
 
- - lat: Latitude of this location
- - lng: Longitude of this location
-
-Optional arguments in params:
-
- - name: Name of this location
-
-`routific.setVisit( id, [params] )`
-
-Sets a visit for the specified location using the specified parameters
+- 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:
 
@@ -53,11 +47,18 @@ Sets a vehicle with the specified ID and parameters
 
 Required arguments in params:
 
- - start_location: ID of start location for this vehicle
+- 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: ID of end location for this vehicle
+ - 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
@@ -94,27 +95,28 @@ require 'routific'
 
 routific = Routific.new(--API_KEY--)
 
-routific.setLocation("order_1", {
-  "name" => "6800 Cambie",
-  "lat" => 49.227107,
-  "lng" => -123.1163085,
-})
-
-routific.setLocation("depot", {
-  "name" => "800 Kingsway",
-  "lat" => 49.2553636,
-  "lng" => -123.0873365,
-})
-
 routific.setVisit("order_1", {
   "start" => "9:00",
   "end" => "12:00",
   "duration" => 10,
+  "location" => {
+    "name" => "6800 Cambie",
+    "lat" => 49.227107,
+    "lng" => -123.1163085,
+  }
 })
 
 routific.setVehicle("vehicle_1", {
-  "start_location" => "depot",
-  "end_location" => "depot",
+  "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",
 })
@@ -129,38 +131,37 @@ require 'routific'
 
 Routific.setToken(--API_KEY--)
 
-network = {
-  "order_1" => {
-    "name" => "6800 Cambie",
-    "lat" => 49.227107,
-    "lng" => -123.1163085
-  },
-  "depot" => {
-    "name" => "800 Kingsway",
-    "lat" => 49.2553636,
-    "lng" => -123.0873365
-  }
-}
-
 visits = {
   "order_1" => {
     "start" => "9:00",
     "end" => "12:00",
-    "duration" => 10
+    "duration" => 10,
+    "location" => {
+      "name" => "6800 Cambie",
+      "lat" => 49.227107,
+      "lng" => -123.1163085
+    }
   }
 }
 
 fleet = {
   "vehicle_1" => {
-    "start-location" => "depot",
-    "end-location" => "depot",
-    "shift-start" => "8:00",
-    "shift-end" => "12:00"
+    "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"
   }
 }
 
 data = {
-  network: network,
   visits: visits,
   fleet: fleet
 }

data/lib/routific.rb

@@ -9,42 +9,33 @@ require_relative './routific/way_point'
 
 # Main class of this gem
 class Routific
-  attr_reader :token, :network, :visits, :fleet
+  attr_reader :token, :visits, :fleet
 
   # Constructor
   # token: Access token for Routific API
   def initialize(token)
     @token = token
-    @network = {}
     @visits = {}
     @fleet = {}
   end
 
-  # Sets a location with the specified ID and parameters
-  # id: location ID
-  # params: parameters for this location
-  def setLocation(id, params)
-    network[id] = Location.new(params)
-  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(params)
+    visits[id] = 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(params)
+    fleet[id] = Vehicle.new(id, params)
   end
 
-  # Returns the route using the previously provided network, visits and fleet information
+  # Returns the route using the previously provided visits and fleet information
   def getRoute
     data = {
-      network: network,
       visits: visits,
       fleet: fleet
     }
@@ -62,7 +53,7 @@ class Routific
       @@token
     end
 
-    # Returns the route using the specified access token, network, visits and fleet information
+    # 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)
@@ -75,7 +66,7 @@ class Routific
 
       begin
         # Sends HTTP request to Routific API server
-        response = RestClient.post('https://routific.com/api/vrp',
+        response = RestClient.post('https://api.routific.com/v1/vrp',
           data.to_json,
           'Authorization' => prefixed_token,
           content_type: :json,
@@ -88,6 +79,7 @@ class Routific
         # Parse the JSON representation into a Route object
         Route.parse(jsonResponse)
       rescue => e
+        puts e
         errorResponse = JSON.parse e.response.body
         puts "Received HTTP #{e.message}: #{errorResponse["error"]}"
         nil

data/lib/routific/location.rb

@@ -19,6 +19,12 @@ class Location
     @name = params["name"]
   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
@@ -43,4 +49,4 @@ class Location
       raise ArgumentError, "'lat' and 'lng' parameters must be provided"
     end
   end
-end
+end

data/lib/routific/route.rb

@@ -34,10 +34,9 @@ class Route
         way_points.each do |waypoint_info|
           # Get all information for this way point
           location_id = waypoint_info["location_id"]
-          location_name = waypoint_info["location_name"]
           arrival_time = waypoint_info["arrival_time"]
           finish_time = waypoint_info["finish_time"]
-          way_point = WayPoint.new(location_id, location_name, arrival_time, finish_time)
+          way_point = WayPoint.new(location_id, arrival_time, finish_time)
           route.addWayPoint(vehicle_name, way_point)
         end
       end
@@ -46,4 +45,4 @@ class Route
       route
     end
   end
-end
+end

data/lib/routific/vehicle.rb

@@ -1,23 +1,25 @@
 # This class represents a vehicle in the fleet
 class Vehicle
-  attr_accessor :start_location, :end_location, :shift_start, :shift_end, :capacity
+  attr_accessor :id, :start_location, :end_location, :shift_start, :shift_end, :capacity
 
   # Constructor
   #
   # Required arguments in params:
-  # start_location: ID of start location for this vehicle
+  # start_location: start location for this vehicle. Instance of Location
   #
   # Optional arguments in params:
-  # end_location: ID of end location for this vehicle
+  # 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(params)
-    # Validates the provided parameters
+  def initialize(id, params)
     validate(params)
 
-    @start_location = params["start_location"]
-    @end_location = params["end_location"]
+    @id = id
+    @start_location = Location.new(params["start_location"])
+    if params["end_location"]
+      @end_location = Location.new(params["end_location"])
+    end
     @shift_start = params["shift_start"]
     @shift_end = params["shift_end"]
     @capacity = params["capacity"]
@@ -31,22 +33,23 @@ class Vehicle
   # def to_json(options = nil)
   def as_json(options = nil)
     jsonData = {}
-    jsonData["start-location"] = self.start_location
-    jsonData["end-location"] = self.end_location 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["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
 
+
   private
   # Validates the parameters being provided
   # Raises an ArgumentError if any of the required parameters is not provided.
-  # Required parameter is: start_location
+  # Required parameters are: location
   def validate(params)
-    if(params["start_location"].nil?)
-      raise ArgumentError, "'start_location' parameter must be provided"
+    if params["start_location"].nil?
+      raise ArgumentError, "'start-location' parameter must be provided"
     end
   end
-end
+end

data/lib/routific/visit.rb

@@ -1,6 +1,6 @@
 # This class represents a location to be visited
 class Visit
-  attr_reader :start, :end, :duration, :demand
+  attr_reader :id, :start, :end, :duration, :demand, :location
 
   # Constructor
   #
@@ -9,11 +9,15 @@ class Visit
   # 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
-  def initialize(params = {})
+  # 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
 
   def to_json(options)
@@ -28,7 +32,18 @@ class Visit
     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
-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"
+    end
+  end
+end

data/lib/routific/way_point.rb

@@ -1,12 +1,11 @@
 # This class represents a location to visit in the route
 class WayPoint
-  attr_reader :location_id, :location_name, :arrival_time, :finish_time
+  attr_reader :location_id, :arrival_time, :finish_time
 
   # Constructor
-  def initialize(location_id, location_name, arrival_time, finish_time)
+  def initialize(location_id, arrival_time, finish_time)
     @location_id = location_id
-    @location_name = location_name
     @arrival_time = arrival_time
     @finish_time = finish_time
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routific
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0a
 platform: ruby
 authors:
 - Marc Kuo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -139,12 +139,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: routific API