arcgis_vrps 0.0.2.1 → 0.0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efed1acbb3635ceace46ddc8f06f8f2e6b693154
-  data.tar.gz: e60638a995344f0ee9fb9a165d2d98ab285e03af
+  metadata.gz: d3af625d3074f6f84386182d7b120aa4a57c0d99
+  data.tar.gz: 2f2d8fd5876c98473a09c5ba532d4b3c81be802c
 SHA512:
-  metadata.gz: 2c33fc1bdc389abc94fb995155a14827946de2cdbcc0554adbce10392e037177671096d01288c70b4107064cdce09862e54a022d0450610d49c686037353da7d
-  data.tar.gz: 5fbaea051725e894cb647c21ad30dc16c8e56a24b339b6cf4777048659022af027cfa2cb2963bd7c2ef39cae337b9c9df21f052ea0b41fa9125b0fd8e7c9c12b
+  metadata.gz: 2c67e0d567464c17c154c44ec418ad0ff9fcf3ad9021ec9f8defd751005faaee6aed6a72fe3da0ef0ea927e284d5f17d27fb03a79e74fd54d628e3b70964d311
+  data.tar.gz: 66e43e5f763b7b51399bb11c17e69b0486ad63be53d55e6e011072fc33527cb84e3057a123ae0aad2d0b6db37ae48c0e643999c057ee37205c983c1e7f15ecf8

data/README.md

@@ -0,0 +1,18 @@
+# Overview #
+A ruby gem as an interface for ArcGIS (platform of Esri) Vehicle Routing Problem service REST API
+
+You can install this gem by:
+
+    gem install arcgis_vrps
+
+If at any moment you get the error similar to:
+
+    SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed
+
+Please follow the steps outlined [here](https://gist.github.com/fnichol/867550)
+
+
+To debug / test the gem do the following on the command line:
+
+ - irb -Ilib -rarcgis_vrps
+ - a=Arcgis_Vrps.new

data/lib/arcgis_vrps.rb

@@ -1,10 +1,549 @@
+# This require has to be below cause the above is using it.
+# Else, you'll get error: Uninitialized constant
+require 'json'
+require 'net/http'
+require 'arcgis_vrps/orders'
+require 'arcgis_vrps/depots'
+require 'arcgis_vrps/routes'
+require 'arcgis_vrps/auth'
+require 'test/data_load'
+
 class Arcgis_Vrps
-	def self.hi(language = "english")
-	    translator = Translator.new(language)
-    	translator.hi
+	# Use for testing for now
+	# def initialize()
+	# 	auth = Auth.new("rdvAIjUCEMegkoId", "a22acf9678c24b34960c320dddfe96cc")
+	# 	@token = auth.generateToken
+
+	# 	puts
+	# 	puts "Token generated #{@token}"
+	# 	puts
+
+	# 	loadSampleData(false) # This will get coordinates from MapSynq for all McD and write to /lib/test/sample_data/coordinateArray file. Change to true if the file don't exist
+	# 	# mockCase1() # Routes without any start & end time (Basic routing)
+	# 	mockCase2(5) # 9 locations with set times that vehicles must reach (no overlapping time)
+	# 	# mockCase3() # 8 locations with set times that vehicles must reach (with overlapping time)
+	# 	# mockCase4() # Same as use case 3 but with more overlapping times than routes available
+		
+	# 	# getOutputRoutes("jf163f4d4f7874fd69b4f6f90e2d5d9aa")
+	# 	# getOutputOrders("jf163f4d4f7874fd69b4f6f90e2d5d9aa")
+	# end
+
+	# def initialize(client_id, client_secret)
+		auth = Auth.new(client_id, client_secret)
+		@token = auth.generateToken
+		
+		# puts
+		# puts "Token generated #{@token}"
+		# puts
+		
 	end
-end
 
-# This require has to be below cause the above is using it.
-# Else, you'll get error: Uninitialized constant
-require 'arcgis_vrps/sample'
+	def submitJob(ordersObj, depotsObj, routesObj, timer) # TODO: Check to decide whether to use synchronous or async
+
+		puts "Submitting job"
+		
+		jobStatusNoOfCalls = 0
+
+		t1 = Time.now
+
+		submitJobUrl = 'https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem/submitJob'
+
+		params = {
+					orders: ordersObj.to_json,
+					depots: depotsObj.to_json,
+					routes: routesObj.to_json,
+					default_date: (Time.now.to_f * 1000).to_i,
+					# default_date: 1441933200000,
+					token: @token,
+					f: 'json',
+					time_units: 'Seconds',
+					distance_units: 'Meters'
+				}
+
+		res = Net::HTTP.post_form(URI(submitJobUrl), params)
+
+		@jobId = JSON.parse(res.body)["jobId"]
+		
+
+		if @jobId.nil?
+			raise "Error! #{res.body}"
+		else
+			puts "Received job ID: #{@jobId}"
+			print "Getting job status..."
+
+			if timer.nil?
+				timer = 1 # Timer of 500ms to constantly check for updates
+			end
+
+			start_time = Time.now
+			end_time = start_time+timer
+
+			completed = false
+
+			begin
+				while completed == false
+					print "."
+					jobStatusNoOfCalls += 1
+					while Time.now < end_time
+					end
+
+					completed = getJobStatus()
+				end
+				print "Completed!\n" 
+				puts
+				# puts completed.to_s
+				# puts
+
+				t2 = Time.now
+
+				time_jobStatusIsComplete = t2-t1
+
+				puts "Time taken for job to be completed: #{time_jobStatusIsComplete}"
+				puts
+
+				routesReceived = getOutputRoutes(nil).to_json
+				routesReceived = "Routes received: \n #{routesReceived}"
+				ordersReceived = getOutputOrders(nil).to_json
+				ordersReceived = "Orders received: \n #{ordersReceived}"
+
+				t3 = Time.now
+
+				time_fullJobComplete = t3-t1
+
+				extraContent = "Total time taken for getting routes and orders: #{time_fullJobComplete} \nNumber of calls to jobStatus: #{jobStatusNoOfCalls} \n\n"
+				
+				puts extraContent
+				puts
+
+				return extraContent, routesReceived, ordersReceived
+			rescue Exception => e 
+				puts 
+				puts e
+				puts
+			end
+		end
+	end
+
+	def getJobStatus
+		urlWithJobId = 'https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem/jobs/'+@jobId
+		res = Net::HTTP.post_form URI(urlWithJobId),
+					token: @token,
+					returnMessages: true,
+					f: 'json'
+
+		status = JSON.parse(res.body)["jobStatus"]
+		# puts res.body
+		# puts
+
+		if status == "esriJobSucceeded"
+			return res.body
+		elsif status == "esriJobFailed"
+			raise "\nJob failed with the following message stack:\n #{res.body}"
+		else
+			return false
+		end
+	end
+
+	def getOutputRoutes(jobId)
+		unless jobId.nil?
+			@jobId = jobId
+		end
+
+		urlWithJobId = 'https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem/jobs/'+@jobId+'/results/out_routes'
+		
+		res = Net::HTTP.post_form URI(urlWithJobId),
+					token: @token,
+					f: 'json'
+
+		# We return the entire string is because it have meta data about the geometry type, spatial reference, etc
+		routesFeatures = JSON.parse(res.body)
+		# JSON.parse(res.body)["value"]["features"]["geometry"]["paths"] will return an array of coordinates in the following format: [longitude, latitude]
+		# routesFeatures = JSON.parse(res.body)["value"]["features"]
+
+		if routesFeatures.nil?
+			routesFeatures = res.body
+		end
+
+		return routesFeatures
+	end
+
+	def getOutputOrders(jobId)
+		unless jobId.nil?
+			@jobId = jobId
+		end
+
+		urlWithJobId = 'https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblem/GPServer/SolveVehicleRoutingProblem/jobs/'+@jobId+'/results/out_stops'
+		
+		res = Net::HTTP.post_form URI(urlWithJobId),
+					token: @token,
+					f: 'json'
+
+		# We return the entire string is because it have meta data about the geometry type, spatial reference, etc
+		ordersFeatures = JSON.parse(res.body)
+		# ordersFeatures = JSON.parse(res.body)["value"]["features"]
+
+		if ordersFeatures.nil?
+			ordersFeatures = res.body
+		end
+
+		return ordersFeatures
+	end
+
+	def loadSampleData(loadFromFile)
+		@loadData = Data_Load.new()
+
+		if loadFromFile
+			@loadData.getCoordinateFromMapSynq()
+			@loadData.writeCoordinateToFile()
+		end
+	end
+
+	def mockCase1(numberOfVehicles) # Routes without any start & end time (Basic routing)
+
+		puts "Setting up orders"
+
+		@loadData.getCoordinateFromFile()
+		coordinate = @loadData.coordinateArrayFromFile
+
+		ord = Orders.new()
+
+		i = 0
+		coordinate.each do |coor|
+			store_name = "Store_"+i.to_s
+
+			orderAttributeObj = ord.getBasicOrderAttributeObj(store_name)
+			ord.addOrders(coor[0], coor[1], orderAttributeObj)
+
+			if i == 50
+				break
+			end
+
+			i += 1
+		end
+		
+		ordersObj = ord.getOrderObj(nil)
+
+		puts "Setting up depots"
+
+		dep = Depots.new()
+		deportAttributeObj = dep.getDepotAttributeObj("depot_1")
+		dep.addDepots(103.848427, 1.277751, deportAttributeObj)
+		depotsObj = dep.getDepotObj(nil)
+		
+		puts "Setting up routes"
+
+		route = Routes.new()
+		
+		startDateTime = (Time.now.to_f * 1000).to_i
+
+		for i in 1..numberOfVehicles
+			truck_name = "Truck_#{i}"
+			route.addRoutes(truck_name, "depot_1", startDateTime, startDateTime)
+		end
+		
+		routesObj = route.getRouteObj()
+
+		begin
+			contents = submitJob(ordersObj, depotsObj, routesObj, nil)
+
+			writeToFile("Mock Case 1 - #{numberOfVehicles}.json", contents)
+		rescue Exception => e  
+			puts
+			puts e
+			puts
+		end
+	end
+
+	def mockCase2(numberOfVehicles) # 9 locations with set times that vehicles must reach (no overlapping time)
+		
+		puts "Setting up orders"
+
+		@loadData.getCoordinateFromFile()
+		coordinate = @loadData.coordinateArrayFromFile
+
+		ord = Orders.new()
+
+		i = 0
+
+		minutesInSeconds = 1800000 # 30 minutes in milliseconds
+		timeWindowStart1 = 1441933200000 # Default date time: 11th Sept 2015, 9:00:00 AM in milliseconds
+		timeWindowEnd1 = timeWindowStart1 + minutesInSeconds # Add 30 minutes every run
+
+		coordinate.each do |coor|
+			store_name = "Store_"+i.to_s
+			serviceTime = 30
+
+			if i < 9 && i >= 0
+				if i < 5 && i >= 1 # Can reach later than the set time here
+					timeWindowStart1 += (minutesInSeconds*2) # Add 1 hour every run
+					timeWindowEnd1 = timeWindowStart1 + minutesInSeconds # Add 30 minutes every run
+					maxViolationTime1 = nil
+				elsif i < 9 && i >= 5 # Can reach later than the set time based on the x minute set by MaxViolationTime1
+					timeWindowStart1 += (minutesInSeconds*2) # Add 1 hour every run
+					timeWindowEnd1 = timeWindowStart1 + minutesInSeconds # Add 30 minutes every run
+					maxViolationTime1 = 0
+				end
+				orderAttributeObj = ord.getOrderAttributeObj(store_name, serviceTime, timeWindowStart1, timeWindowEnd1, maxViolationTime1)
+			elsif i >= 9
+				timeWindowStart1 = nil
+				timeWindowEnd1 = nil
+				maxViolationTime1 = nil
+				orderAttributeObj = ord.getBasicOrderAttributeObj(store_name)
+			end		
+
+			ord.addOrders(coor[0], coor[1], orderAttributeObj)
+
+			if i == 49
+				break 
+			end
+
+			i += 1
+		end
+		
+		ordersObj = ord.getOrderObj(nil)
+
+		puts "Setting up depots"
+
+		dep = Depots.new()
+		deportAttributeObj = dep.getDepotAttributeObj("depot_1")
+		dep.addDepots(103.848427, 1.277751, deportAttributeObj)
+		depotsObj = dep.getDepotObj(nil)
+		
+		puts "Setting up routes"
+
+		route = Routes.new()
+		
+		startDateTime = 1441933200000
+		for i in 1..numberOfVehicles
+			truck_name = "Truck_#{i}"
+			route.addRoutes(truck_name, "depot_1", startDateTime, startDateTime)
+		end
+		
+		routesObj = route.getRouteObj()
+
+		# puts
+		# puts ordersObj.to_json
+		# puts
+		# puts depotsObj.to_json
+		# puts
+		# puts routesObj.to_json
+		# puts
+
+		begin
+			contents = submitJob(ordersObj, depotsObj, routesObj, nil)
+
+			writeToFile("Mock Case 2 - #{numberOfVehicles}.json", contents)
+		rescue Exception => e  
+			puts
+			puts e
+			puts
+		end
+	end
+
+	def mockCase3(numberOfVehicles) # 8 locations with set times that vehicles must reach (with overlapping time)
+		
+		puts "Setting up orders"
+
+		@loadData.getCoordinateFromFile()
+		coordinate = @loadData.coordinateArrayFromFile
+
+		ord = Orders.new()
+
+		i = 0
+
+		minutesInSeconds = 1800000 # 30 minutes in milliseconds
+		timeWindowStart1 = 1441933200000 # Default date time: 11th Sept 2015, 9:00:00 AM in milliseconds
+		timeWindowEnd1 = timeWindowStart1 + minutesInSeconds # Add 30 minutes every run
+
+		countThree = 0
+		countFive = 0
+
+		coordinate.each do |coor|
+			store_name = "Store_"+i.to_s
+			serviceTime = 30
+
+			if ((i%3 == 0 || i%5 == 0) && (countThree < 4 || countFive < 4))
+				if timeWindowStart1.nil? || timeWindowStart1 >= 1441944000000
+					timeWindowStart1 = 1441933200000
+				end
+
+				if i%3 == 0 && countThree < 4
+					timeWindowStart1 += (minutesInSeconds*2) # Add 1 hour every run
+					timeWindowEnd1 = timeWindowStart1 + minutesInSeconds # Add 30 minutes every run
+					maxViolationTime1 = nil
+					countThree += 1
+				elsif i%5 == 0 && countFive < 4
+					timeWindowStart1 += (minutesInSeconds*2) # Add 1 hour every run
+					timeWindowEnd1 = timeWindowStart1 + minutesInSeconds # Add 30 minutes every run
+					maxViolationTime1 = 0
+					countFive += 1
+				end
+				orderAttributeObj = ord.getOrderAttributeObj(store_name, serviceTime, timeWindowStart1, timeWindowEnd1, maxViolationTime1)
+			else
+				timeWindowStart1 = nil
+				timeWindowEnd1 = nil
+				maxViolationTime1 = nil
+				orderAttributeObj = ord.getBasicOrderAttributeObj(store_name)
+			end		
+
+			ord.addOrders(coor[0], coor[1], orderAttributeObj)
+
+			if i == 49
+				break 
+			end
+
+			i += 1
+		end
+		
+		ordersObj = ord.getOrderObj(nil)
+
+		puts "Setting up depots"
+
+		dep = Depots.new()
+		deportAttributeObj = dep.getDepotAttributeObj("depot_1")
+		dep.addDepots(103.848427, 1.277751, deportAttributeObj)
+		depotsObj = dep.getDepotObj(nil)
+		
+		puts "Setting up routes"
+
+		route = Routes.new()
+		
+		startDateTime = 1441933200000
+		for i in 1..numberOfVehicles
+			truck_name = "Truck_#{i}"
+			route.addRoutes(truck_name, "depot_1", startDateTime, startDateTime)
+		end
+		
+		routesObj = route.getRouteObj()
+
+		# puts
+		# puts ordersObj.to_json
+		# puts
+		# puts depotsObj.to_json
+		# puts
+		# puts routesObj.to_json
+		# puts
+
+		begin
+			contents = submitJob(ordersObj, depotsObj, routesObj, nil)
+
+			writeToFile("Mock Case 3 - #{numberOfVehicles}.json", contents)
+		rescue Exception => e  
+			puts
+			puts e
+			puts
+		end	
+	end
+
+	def mockCase4(numberOfVehicles) # Same as use case 3 but with more overlapping times than routes available
+		
+		puts "Setting up orders"
+
+		@loadData.getCoordinateFromFile()
+		coordinate = @loadData.coordinateArrayFromFile
+
+		ord = Orders.new()
+
+		i = 0
+
+		minutesInSeconds = 1800000 # 30 minutes in milliseconds
+		timeWindowStart1 = 1441933200000 # Default date time: 11th Sept 2015, 9:00:00 AM in milliseconds
+		timeWindowEnd1 = timeWindowStart1 + minutesInSeconds # Add 30 minutes every run
+
+		countThree = 0
+		countFive = 0
+
+		coordinate.each do |coor|
+			store_name = "Store_"+i.to_s
+			serviceTime = 30
+
+			if i < 6
+				# This if block is to set 3 with MaxViolationTime1 and 3 without
+				# if i < 3 && i >= 0
+				# 	maxViolationTime1 = nil
+				# elsif i < 6 && i >= 3
+				# 	maxViolationTime1 = 0
+				# end
+				maxViolationTime1 = 0 # This is to set all 6 with MaxViolationTime1
+				orderAttributeObj = ord.getOrderAttributeObj(store_name, serviceTime, timeWindowStart1, timeWindowEnd1, maxViolationTime1)
+			else
+				timeWindowStart1 = nil
+				timeWindowEnd1 = nil
+				maxViolationTime1 = nil
+				orderAttributeObj = ord.getBasicOrderAttributeObj(store_name)
+			end		
+
+			ord.addOrders(coor[0], coor[1], orderAttributeObj)
+
+			if i == 49
+				break 
+			end
+
+			i += 1
+		end
+		
+		ordersObj = ord.getOrderObj(nil)
+
+		puts "Setting up depots"
+
+		dep = Depots.new()
+		deportAttributeObj = dep.getDepotAttributeObj("depot_1")
+		dep.addDepots(103.848427, 1.277751, deportAttributeObj)
+		depotsObj = dep.getDepotObj(nil)
+		
+		puts "Setting up routes"
+
+		route = Routes.new()
+		
+		startDateTime = 1441933200000
+		for i in 1..numberOfVehicles
+			truck_name = "Truck_#{i}"
+			route.addRoutes(truck_name, "depot_1", startDateTime, startDateTime)
+		end
+		
+		routesObj = route.getRouteObj()
+
+		# puts
+		# puts ordersObj.to_json
+		# puts
+		# puts depotsObj.to_json
+		# puts
+		# puts routesObj.to_json
+		# puts
+
+		begin
+			contents = submitJob(ordersObj, depotsObj, routesObj, nil)
+
+			writeToFile("Mock Case 4 - location - 6.json", contents)
+		rescue Exception => e  
+			puts
+			puts e
+			puts
+		end	
+	end
+
+	def writeCoordinateToFile
+		@loadData.getCoordinateFromFile(true)
+		coordinate = @loadData.coordinateArrayFromFile
+		writeToFile("coordinateArray", coordinate.to_json);
+	end
+
+	def writeToFile(filename, contents)
+		puts "Writing to file #{filename}"
+
+		File.open("lib/test/sample_data/#{filename}", "w") do |file|
+			if contents.kind_of?(Array)
+				contents.each do |content|
+					file.puts content
+					file.puts
+				end
+			else
+				file.puts contents
+				file.puts
+			end
+		end
+
+		puts "Done writing to file #{filename}"
+		puts
+	end
+end

data/lib/arcgis_vrps/auth.rb

@@ -0,0 +1,29 @@
+require 'json'
+require 'net/http'
+
+class Auth
+	def initialize(client_id, client_secret)
+		if client_id.nil? || client_id.empty? || client_secret.nil? || client_secret.empty?
+	        raise ArgumentError, "Both Client ID & Client Secret has to be set"
+	    end
+
+		@client_id = client_id
+		@client_secret = client_secret
+	end
+
+	def generateToken
+	    begin
+		    res = Net::HTTP.post_form URI('https://www.arcgis.com/sharing/rest/oauth2/token'),
+						f: 'json',
+						client_id: @client_id,
+						client_secret: @client_secret,
+						grant_type: 'client_credentials'
+			
+			token = JSON.parse(res.body)['access_token']
+			# puts "\n"+res.body
+			return token
+		rescue => e
+			puts e
+		end
+	end
+end

data/lib/arcgis_vrps/depots.rb

@@ -0,0 +1,57 @@
+class Depots
+	# Longitude => xCoordinate, Latitude => yCoordinate
+	def addDepots (xCoordinate, yCoordinate, depotAttributeObj)
+		my_depot = {
+					:geometry => {
+			          :x => xCoordinate,
+			          :y => yCoordinate
+			        },
+			        :attributes => depotAttributeObj
+		    	}
+		if @depotArr.nil?
+			@depotArr = []
+		end
+		
+		@depotArr.push(my_depot)
+	end
+
+	def getDepotArr
+		return @depotArr
+	end
+
+	def getDepotAttributeObj(depotName)
+		depotAttributeObj =	{
+			:Name => depotName
+		}
+
+		return depotAttributeObj
+	end
+
+	# Get the Orders Attribute Object from the param passed in
+	# def getDepotAttributeObj(depotName, timeStart1, timeEnd1)
+	# 	depotAttributeObj =	{
+	# 		:Name => depotName,
+	# 		:TimeWindowStart1 => timeStart1,
+	# 		:TimeWindowEnd1 => timeEnd1
+	# 	}
+
+	# 	return depotAttributeObj
+	# end
+
+	def getDepotObj (wkid)
+		if wkid.nil?
+			depotObj = {
+				:features => @depotArr
+			}
+		else
+			depotObj = {
+				:spatialReference => {
+					:wkid => wkid
+				},
+				:features => @depotArr
+			}
+		end
+
+		return depotObj
+	end
+end

data/lib/arcgis_vrps/orders.rb

@@ -0,0 +1,85 @@
+class Orders
+	# Longitude => xCoordinate, Latitude => yCoordinate
+	def addOrders (xCoordinate, yCoordinate, orderAttributeObj)
+		my_order = {
+					:geometry => {
+			          :x => xCoordinate,
+			          :y => yCoordinate
+			        },
+			        :attributes => orderAttributeObj
+		    	}
+		if @orderArr.nil?
+			@orderArr = []
+		end
+		
+		@orderArr.push(my_order)
+	end
+
+	def getOrderArr
+		return @orderArr
+	end
+
+	# Get basic Orders Attribute Object from the param passed in
+	def getBasicOrderAttributeObj (orderName)
+		orderAttributeObj =	{
+			:Name => orderName
+		}
+
+		return orderAttributeObj
+	end
+
+	# Get orders attribute object from the param passed in
+	# timeWindow* refers to the time that the service
+	def getOrderAttributeObj (orderName, serviceTime, timeWindowStart1, timeWindowEnd1, maxViolationTime1)
+		if maxViolationTime1.nil?
+			orderAttributeObj =	{
+				:Name => orderName,
+				:ServiceTime => serviceTime,
+				:TimeWindowStart1 => timeWindowStart1,
+				:TimeWindowEnd1 => timeWindowEnd1
+			}
+		else
+			orderAttributeObj =	{
+				:Name => orderName,
+				:ServiceTime => serviceTime,
+				:TimeWindowStart1 => timeWindowStart1,
+				:TimeWindowEnd1 => timeWindowEnd1,
+				:MaxViolationTime1 => maxViolationTime1
+			}
+		end
+		
+
+		return orderAttributeObj
+	end
+
+	# Get the Orders Attribute Object from the param passed in
+	# def getOrderAttributeObj (orderName, deliveryQty, serviceTime, timeStart1, timeEnd1, maxViolationTime)
+	# 	orderAttributeObj =	{
+	# 		:Name => orderName,
+	# 		:DeliveryQuantities => deliveryQty,
+	# 		:ServiceTime => serviceTime,
+	# 		:TimeWindowStart1 => timeStart1,
+	# 		:TimeWindowEnd1 => timeEnd1,
+	# 		:MaxViolationTime1 => maxViolationTime
+	# 	}
+
+	# 	return orderAttributeObj
+	# end
+
+	def getOrderObj (wkid)
+		if wkid.nil?
+			orderObj = {
+				:features => @orderArr
+			}
+		else
+			orderObj = {
+				:spatialReference => {
+					:wkid => wkid
+				},
+				:features => @orderArr
+			}
+		end
+
+		return orderObj
+	end
+end

data/lib/arcgis_vrps/routes.rb

@@ -0,0 +1,56 @@
+class Routes
+	def addRoutes (routeName, startDepotName, earliestStartTime, latestStartTime)
+		my_route = {
+			        :attributes => {
+			          :Name => routeName,
+			          :StartDepotName => startDepotName, # Either this or EndDepotName must be present. This is a foreign key to the "Name" attribute in the depots param. Thus, the values MUST match
+			          :EarliestStartTime  => earliestStartTime,
+			          :LatestStartTime => latestStartTime
+			        }
+		    	}
+
+		if @routeArr.nil?
+			@routeArr = []
+		end
+		
+		@routeArr.push(my_route)
+	end
+
+	# def addRoutes (routeName, startDepotName, endDepotName, startDepotServiceTime, earliestStartTime, latestStartTime, capacities, costPerUnitTime, costPerUnitDistance, maxOrderCount, maxTotalTime, maxTotalTravelTime, maxTotalDistance)
+	# 	my_route = {
+	# 		        :attributes => {
+	# 		          :Name => routeName,
+	# 		          :StartDepotName => startDepotName, # Either this or EndDepotName must be present. This is a foreign key to the "Name" attribute in the depots param. Thus, the values MUST match
+	# 		          :EndDepotName => endDepotName,
+	# 		          :StartDepotServiceTime => startDepotServiceTime,
+	# 		          :EarliestStartTime => earliestStartTime,
+	# 		          :LatestStartTime => latestStartTime,
+	# 		          :Capacities => capacities,
+	# 		          :CostPerUnitTime => costPerUnitTime,
+	# 		          :CostPerUnitDistance => costPerUnitDistance,
+	# 		          :MaxOrderCount => maxOrderCount,
+	# 		          :MaxTotalTime => maxTotalTime,
+	# 		          :MaxTotalTravelTime => maxTotalTravelTime,
+	# 		          :MaxTotalDistance => maxTotalDistance
+	# 		        }
+	# 	    	}
+
+	# 	if @routeArr.nil?
+	# 		@routeArr = []
+	# 	end
+		
+	# 	@routeArr.push(my_route)
+	# end
+
+	def getRouteArr
+		return @routeArr
+	end
+
+	def getRouteObj
+		routeObj = {
+			:features => @routeArr
+		}
+
+		return routeObj
+	end
+end

data/lib/test/data_load.rb

@@ -0,0 +1,116 @@
+require 'net/http'
+
+class Data_Load
+	attr_accessor :coordinateArrayFromFile, :postcodeArrayFromFile, :coordinateArrayFromServer
+
+	def initialize
+		# Will there be an instance where @postcodeArrayFromFile is nil?
+		if @postcodeArrayFromFile.nil?
+				@postcodeArrayFromFile = []
+		end
+
+		if @coordinateArrayFromServer.nil?
+			@coordinateArrayFromServer = []
+		end
+
+		if @coordinateArrayFromFile.nil?
+			@coordinateArrayFromFile = []
+		end
+	end
+
+	def getCoordinateFromMapSynq
+		puts "Getting postcodes from file..."
+
+		getPostcodeFromFile()
+
+		print "Requesting coordinates from server..."
+
+		@postcodeArrayFromFile.each do |postcode|
+			print "."
+
+			mapsynqUrl = "http://www.mapsynq.com/home/search1?q=#{postcode}&lat=&lon=&page=1"
+
+			begin
+				url = URI.parse(mapsynqUrl)
+				req = Net::HTTP::Get.new(url.to_s)
+				res = Net::HTTP.start(url.host, url.port) {|http|
+				  http.request(req)
+				}
+
+				result = JSON.parse(res.body)["result"]
+				
+				unless result.empty?
+					yCoordinate = result[0]["true_latitude"]
+					xCoordinate = result[0]["true_longitude"]
+					coordinate = "#{xCoordinate}-#{yCoordinate}"
+
+					coordinateArrayFromServer.push(coordinate)
+				end
+			rescue
+				puts $!, $@
+				puts
+				next
+			end
+		end
+		print "\n"
+		puts "Done requesting coordinates from server"
+		puts
+	end
+
+	def getPostcodeFromFile
+		puts "Getting postcodes from file"
+
+		File.open("lib/test/sample_data/postcodes", "r") do |file|
+			while line = file.gets
+				@postcodeArrayFromFile.push(line.strip)
+			end
+		end
+
+		puts "Done getting postcodes from file"
+		puts
+	end
+
+	def getCoordinateFromFile(convertToNumbers = nil)
+		puts "Getting coordinates from file"
+		if convertToNumbers.nil?
+			convertToNumbers = false
+		end
+
+		File.open("lib/test/sample_data/coordinates", "r") do |file|
+			while line = file.gets
+				coordinate = line.strip.split("-")
+				if convertToNumbers == true
+					if coordinate[0].is_number? && coordinate[1].is_number?
+						coordinate[0] = coordinate[0].to_f
+						coordinate[1] = coordinate[1].to_f
+					else
+						raise "Error! #{coordinate[0]} & #{coordinate[1]} is not a number!"
+					end
+				end
+				@coordinateArrayFromFile.push(coordinate)
+			end
+		end
+
+		puts "Done getting coordinates from file"
+		puts
+	end
+
+	def writeCoordinateToFile
+		puts "Writing coordinates to file"
+
+		File.open("lib/test/sample_data/coordinates", "w") do |file|
+			@coordinateArrayFromServer.each do |coordinate|
+				file.puts coordinate
+			end
+		end
+
+		puts "Done writing coordinates to file"
+		puts
+	end
+end
+
+class String
+  def is_number?
+    true if Float(self) rescue false
+  end
+end

data/lib/test/sample_data/postcodes

@@ -0,0 +1,129 @@
+018954
+237978
+098138
+731678
+259727
+569922
+560163
+560448
+567740
+329783
+588177
+469661
+467360
+460539
+470632
+470744
+330022
+579837
+569981
+048508
+188024
+188426
+650632
+659841
+650152
+650374
+677743
+738099
+819643
+819633
+486038
+680624
+680623
+689812
+689810
+680533
+768677
+688892
+208539
+120451
+129588
+545078
+528833
+519498
+629117
+670445
+258748
+238884
+179097
+640762
+380113
+237994
+099253
+530208
+538692
+530684
+538766
+099010
+188067
+609601
+209037
+609731
+608549
+618640
+649849
+600256
+649520
+648886
+649296
+397726
+760846
+229899
+179030
+238868
+510258
+238863
+039594
+138588
+569830
+637331
+117587
+556083
+188721
+769098
+188307
+449408
+519640
+059108
+640638
+238839
+350148
+119963
+828815
+149066
+149053
+179103
+159460
+545082
+797653
+540118
+544964
+550267
+555951
+455871
+138651
+609081
+757713
+520513
+520512
+529341
+529510
+529284
+529705
+529757
+168732
+319515
+310490
+310109
+319387
+609971
+307591
+208767
+126844
+738931
+730900
+730768
+758382
+760293
+769027

metadata

@@ -1,47 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: arcgis_vrps
 version: !ruby/object:Gem::Version
-  version: 0.0.2.1
+  version: 0.0.2.2
 platform: ruby
 authors:
 - Kiong
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-09-08 00:00:00.000000000 Z
-dependencies: []
-description: "A ruby gem interface for ArcGIS (platform of Esri) Vehicle Routing Problem
-  service REST API\n\n  You can find the code here => https://github.com/tlkiong/arcgis_vrps\n
-  \ "
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  name: json
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: A ruby gem interface for ArcGIS (platform of Esri) Vehicle Routing Problem service REST API
 email: kiong90@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
-- lib/arcgis_vrps.rb
-- lib/arcgis_vrps/sample.rb
+- ./lib/arcgis_vrps.rb
+- ./lib/arcgis_vrps/auth.rb
+- ./lib/arcgis_vrps/depots.rb
+- ./lib/arcgis_vrps/orders.rb
+- ./lib/arcgis_vrps/routes.rb
+- ./lib/test/data_load.rb
+- ./lib/test/sample_data/postcodes
+- README.md
 homepage: http://rubygems.org/gems/arcgis_vrps
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code: https://github.com/tlkiong/arcgis_vrps
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.3
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
-summary: An interface for ArcGIS Vehicle Routing Problem service REST API
+summary: ArcGIS Vehicle Routing Problem service API
 test_files: []

data/lib/arcgis_vrps/sample.rb

@@ -1,14 +0,0 @@
-class Arcgis_Vrps::Translator
-  def initialize(language)
-    @language = language
-  end
-
-  def hi
-    case @language
-    when "spanish"
-      "hola mundo"
-    else
-      "hello world"
-    end
-  end
-end