routific 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2e7ffe5c2bb636a3ab3c1e594516b763d2e8197
-  data.tar.gz: be71b166f79ade2947066ab085952980b04b5a5d
+  metadata.gz: 816c3c547394292568835be244e80f7e3042a2bf
+  data.tar.gz: 7699025ca637127d31938cf3f0737ff14a881ef7
 SHA512:
-  metadata.gz: ef023e2e3aca0209ded96748d90bc1cc158f05d819a057ad16a4d71fde24c9a113e4ee084ab388c4bcdc51bec5f51553dde2d9a1bff7bdabc0b604fe68b62caa
-  data.tar.gz: 007e6e6b7a0b5cbb8873aa25257835425f7ae0822d9afaa90a66f6cdac2f96341a9c0a3ccc366cddd57219c04a08029fbb3466059586623343ec55e455f50cd2
+  metadata.gz: ca55300f37e6c0659b33c89d6bd57eba44b2e80eefc668bad6f1c38bf8817d7ffa144d8f8b99c0598bbb2c61f0ef3699c61b9ebcaa4284cfcbda26b389a1ea88
+  data.tar.gz: fffe66b45b0f2f52b0c8882f328c7960c6637c5fb963f1d924ef902db9c539e0e4b6b3db2a4725d70407a65b4d8f2dffb044476b57041b3c53d64878cd24d1b7

data/README.md

@@ -1,150 +1,169 @@
 Routific Ruby 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.
-
-Logistics companies struggle with this challenge every day; most of them are still manually scheduling their fleet with a team of dispatchers.
-
-Routific can automate this process, and optimize it. The savings are tremendous: less fuel, and fewer vehicles, drivers and dispatchers.
+[![Build Status](https://secure.travis-ci.org/asoesilo/routific-gem.png)](http://travis-ci.org/asoesilo/routific-gem)
 
-In the U.S., 1/8th of all fuel is consumed by trucks - that's 50 billion gallons a year. Our optimization algorithms will reduce that number by 20%!
+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
+  [1]: https://routific.com/developers
 
 Installing
 ----------
 
-> gem install routific
+`gem install routific`
 
 Usage
 -----
-Remember to require it before using it
+Remember to require it and instantiate it with your token before using it
+
+```ruby
+require 'routific'
+routific = Routific.new(--API_KEY--)
+```
+
+### Instance methods
+
+`routific.setLocation( id, params )`
+
+Sets a location with the specified ID and parameters
+
+Required arguments in params:
+
+ - lat: Latitude of this location
+ - lng: Longitude of this location
+
+Optional arguments in params:
 
-> require 'routific'
+ - name: Name of this location
 
-The following instance methods are available:
+`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:
 
-    Optional arguments in params:
-     - name: Name of this 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
 
-   > routific.setLocation( id, params )
+`routific.setVehicle( id, params )`
 
- - Sets a visit for the specified location using the specified parameters
+Sets a vehicle with the specified ID and parameters
 
-    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
+Required arguments in params:
 
-   > routific.setVisit( id, [params] )
+ - start_location: ID of start location for this vehicle
 
- - Sets a vehicle with the specified ID and parameters
- 
-    Required arguments in params:
-     - start_location: ID of start location for this vehicle
+Optional arguments in params:
 
-    Optional arguments in params:
-     - end_location: ID of end location for this vehicle
-     - 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
+ - end_location: ID of end location for this vehicle
+ - 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.setVehicle( id, params )
+`routific.getRoute()`
 
- - Returns the route using the previously provided network, visits and
-   fleet information
-   > routific.getRoute()
+Returns the route using the previously provided network, visits and fleet information
 
-The following class methods are available:
 
- - Sets the default access token to use
-   > Routific.setToken( token )
+### Class methods
 
- - Returns the route using the specified access token, network, visits and fleet information
-   > Routific.getRoute( id, [params] )
+`Routific.setToken( token )`
 
-Both getRoute functions return the Route object, which has the following methods:
+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. 
+ - unserved: List of visits that could not be scheduled.
  - vehicleRoutes: The optimized schedule
 
 Examples
 --------
 Example 1:
 
-    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,
-    })
-    
-    routific.setVehicle("vehicle_1", {
-      "start_location" => "depot",
-      "end_location" => "depot",
-      "shift_start" => "8:00",
-      "shift_end" => "12:00",
-    })
-    
+```ruby
+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,
+})
+
+routific.setVehicle("vehicle_1", {
+  "start_location" => "depot",
+  "end_location" => "depot",
+  "shift_start" => "8:00",
+  "shift_end" => "12:00",
+})
+
+route = routific.getRoute()
+```
+
 Example 2:
 
-    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
-        }
-    }
-    fleet = {
-        "vehicle_1" => {
-          "start-location" => "depot",
-          "end-location" => "depot",
-          "shift-start" => "8:00",
-          "shift-end" => "12:00"
-        }
-    }
-    @data = {
-        network: network,
-        visits: visits,
-        fleet: fleet
-    }
-    Routific.getRoute(@data)
+```ruby
+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
+  }
+}
+
+fleet = {
+  "vehicle_1" => {
+    "start-location" => "depot",
+    "end-location" => "depot",
+    "shift-start" => "8:00",
+    "shift-end" => "12:00"
+  }
+}
+
+data = {
+  network: network,
+  visits: visits,
+  fleet: fleet
+}
+
+route = Routific.getRoute(data)
+```

data/lib/routific/location.rb

@@ -19,14 +19,19 @@ class Location
     @name = params["name"]
   end
 
-  # Returns the JSON representation of this object
   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
 
-    jsonData.to_json
+    jsonData
   end
 
   private

data/lib/routific/vehicle.rb

@@ -23,8 +23,13 @@ class Vehicle
     @capacity = params["capacity"]
   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 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
@@ -32,7 +37,7 @@ class Vehicle
     jsonData["shift-end"] = self.shift_end if self.shift_end
     jsonData["capacity"] = self.capacity if self.capacity
 
-    jsonData.to_json
+    jsonData
   end
 
   private

data/lib/routific/visit.rb

@@ -16,14 +16,19 @@ class Visit
     @demand = params["demand"]
   end
 
+  def to_json(options)
+    as_json(options).to_json
+  end
+
   # Returns the JSON representation of this object
-  def to_json(options = nil)
+  # 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.to_json
+    jsonData
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routific
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Marc Kuo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client