route4me 1.1.0

data/examples/get_route_manifest.rb

@@ -0,0 +1,6 @@
+require 'route4me'
+
+Route4me.api_key = '11111111111111111111111111111111'
+route = Route4me::Route.get({
+  :route_id => 'AC16E7D338B551013FF34266FE81A5EE'
+})

data/examples/get_route_tracking.rb

@@ -0,0 +1,9 @@
+require 'route4me'
+
+Route4me.api_key = '11111111111111111111111111111111'
+route = Route4me::Route.get({
+  :route_id => 'AC16E7D338B551013FF34266FE81A5EE',
+  :device_tracking_history => true
+})
+
+puts route[:tracking_history]

data/examples/helper.rb

@@ -0,0 +1,7 @@
+require 'json'
+
+def addresses
+  File.open('./addresses.json', "r") do |f|
+    JSON.load(f)
+  end
+end

data/examples/multiple_depot_multiple_driver.rb

@@ -0,0 +1,20 @@
+require 'route4me'
+require './helper'
+
+Route4me.api_key = '11111111111111111111111111111111'
+problem = Route4me::OptimizationProblem.optimize(
+  :addresses => addresses,
+  :parameters => {
+    :algorithm_type          => Route4me::AlgorithmType::CVRP_TW_MD,
+    :distance_unit           => Route4me::DistanceUnit::MILES,
+    :device_type             => Route4me::DeviceType::WEB,
+    :optimize                => Route4me::OptimizationType::DISTANCE,
+    :travel_mode             => Route4me::TravelMode::DRIVING,
+    :route_max_duration      => 86400,
+    :vehicle_capacity        => 50,
+    :vehicle_max_distance_mi => 10000,
+    :parts                   => 50
+  }
+)
+
+puts problem

data/examples/multiple_depot_with_time_window.rb

@@ -0,0 +1,20 @@
+require 'route4me'
+require './helper'
+
+Route4me.api_key = '11111111111111111111111111111111'
+problem = Route4me::OptimizationProblem.optimize(
+  :addresses => addresses,
+  :parameters => {
+    :algorithm_type          => Route4me::AlgorithmType::CVRP_TW_SD,
+    :distance_unit           => Route4me::DistanceUnit::MILES,
+    :device_type             => Route4me::DeviceType::WEB,
+    :optimize                => Route4me::OptimizationType::DISTANCE,
+    :travel_mode             => Route4me::TravelMode::DRIVING,
+    :route_max_duration      => 86400,
+    :vehicle_capacity        => 50,
+    :vehicle_max_distance_mi => 10000,
+    :parts                   => 50
+  }
+)
+
+puts problem

data/examples/reoptimization.rb

@@ -0,0 +1,9 @@
+require 'route4me'
+require './helper'
+
+problem = Route4me::OptimizationProblem.update(
+  :optimization_problem_id => 'F2FEA85DA7EFCE180CAD70704816347A',
+  :parameters => { :reoptimize => true },
+  :addresses => addresses,
+  :reoptimize => true
+)

data/examples/single_driver_round_trip.rb

@@ -0,0 +1,20 @@
+require 'route4me'
+require './helper'
+
+Route4me.api_key = '11111111111111111111111111111111'
+problem = Route4me::OptimizationProblem.optimize(
+  :addresses => addresses,
+  :parameters => {
+    :algorithm_type          => Route4me::AlgorithmType::TSP,
+    :distance_unit           => Route4me::DistanceUnit::MILES,
+    :device_type             => Route4me::DeviceType::WEB,
+    :optimize                => Route4me::OptimizationType::DISTANCE,
+    :travel_mode             => Route4me::TravelMode::DRIVING,
+    :route_max_duration      => 86400,
+    :vehicle_capacity        => 1,
+    :vehicle_max_distance_mi => 10000,
+    :rt                      => true
+  }
+)
+
+puts problem

data/examples/single_driver_route_ten_stops.rb

@@ -0,0 +1,18 @@
+require 'route4me'
+require './helper'
+
+Route4me.api_key = '11111111111111111111111111111111'
+problem = Route4me::OptimizationProblem.optimize(
+  :addresses => addresses.first(10),
+  :parameters => {
+    :algorithm_type          => Route4me::AlgorithmType::TSP,
+    :distance_unit           => Route4me::DistanceUnit::MILES,
+    :device_type             => Route4me::DeviceType::WEB,
+    :optimize                => Route4me::OptimizationType::DISTANCE,
+    :travel_mode             => Route4me::TravelMode::DRIVING,
+    :vehicle_capacity        => 1,
+    :vehicle_max_distance_mi => 10000
+  }
+)
+
+puts problem

data/examples/track.rb

@@ -0,0 +1,14 @@
+require 'route4me'
+
+Route4me.api_key = '11111111111111111111111111111111'
+Route4me::Track.set(
+  format: 'json',
+  member_id: 1,
+  route_id: '0CDA1358186D616AFD39FEB579A64974',
+  course: 1,
+  speed: 120,
+  lat: 41.8927521,
+  lng: -109.0803888,
+  device_type: Route4me::DeviceType::IPHONE,
+  device_guid: '036BFC6AC46F45153D7381BE321CB9235585FD83'
+)

data/lib/route4me.rb

@@ -0,0 +1,119 @@
+# Stripe Ruby bindings
+# API spec at https://stripe.com/docs/api
+require 'cgi'
+require 'set'
+require 'openssl'
+require 'rest_client'
+require 'json'
+
+# Enums
+require 'route4me/enum/algorithm_type'
+require 'route4me/enum/distance_unit'
+require 'route4me/enum/device_type'
+require 'route4me/enum/optimization_type'
+require 'route4me/enum/travel_mode'
+require 'route4me/enum/metric'
+require 'route4me/enum/direction_method'
+require 'route4me/enum/avoid'
+
+# Errors
+require 'route4me/errors/route4me_error'
+require 'route4me/errors/api_error'
+
+# Version
+require 'route4me/version'
+
+# Util
+require 'route4me/util'
+
+# Resources
+require 'route4me/optimization_problem'
+# require 'route4me/address'
+require 'route4me/route'
+require 'route4me/track'
+
+module Route4me
+  class << self
+    attr_accessor :api_key, :api_base
+  end
+
+  @api_base = 'http://route4me.com'
+
+  def self.api_url(url='')
+    @api_base + url
+  end
+
+  def self.uri_encode(params)
+    params.map{ |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
+  end
+
+  def self.request(method, url, opts)
+    unless @api_key
+      raise ArgumentError.new('No API key provided.')
+    end
+
+    get = opts[:get] || {}
+    json = opts[:json] || {}
+
+    url = api_url(url)
+    get[:api_key] = self.api_key
+    url += "?#{uri_encode(get)}"
+
+    case method.to_s.downcase.to_sym
+    when :post, :put
+      payload = json.to_json if json && json.any?
+    else
+      payload = nil
+    end
+
+    request_opts = {
+      method: method, open_timeout: 30, url: url,
+      timeout: 80, payload: payload
+    }
+
+    begin
+      response = execute(request_opts)
+    rescue SocketError => e
+      handle_error(e)
+    rescue RestClient::ExceptionWithResponse => e
+      if rcode = e.http_code and rbody = e.http_body
+        handle_api_error(rcode, rbody)
+      else
+        handle_error(e)
+      end
+    rescue RestClient::Exception, Errno::ECONNREFUSED => e
+      handle_error(e)
+    end
+
+    Util.symbolize_names(parse(response))
+  end
+
+  def self.execute(attrs)
+    RestClient::Request.execute(attrs)
+  end
+
+  def self.parse(response)
+    begin
+      response = JSON.parse(response.body)
+    rescue JSON::ParserError
+      response = nil
+    end
+
+    response
+  end
+
+  def self.handle_error(e)
+     raise Route4meError, e.message
+  end
+
+  def self.handle_api_error(code, body)
+    begin
+      error_message = JSON.parse(body)
+      error_message = error_message['errors']
+    rescue
+      raise Route4meError
+    end
+
+    raise ApiError, code, error_message
+  end
+end

data/lib/route4me/enum/algorithm_type.rb

@@ -0,0 +1,11 @@
+module Route4me
+  module AlgorithmType
+    TSP = 1
+    VRP = 2
+    CVRP_TW_SD = 3
+    CVRP_TW_MD = 4
+    TSP_TW = 5
+    TSP_TW_CR = 6
+    BBCVRP = 7
+  end
+end

data/lib/route4me/enum/avoid.rb

@@ -0,0 +1,8 @@
+module Route4me
+  module Avoid
+    HIGHWAYS = 'Highways'
+    TOLLS = 'Tolls'
+    MINIMIZE_HIGHWAYS = 'minimizeHighways'
+    MINIMIZE_TOLLS = 'minimizeTolls'
+  end
+end

data/lib/route4me/enum/device_type.rb

@@ -0,0 +1,9 @@
+module Route4me
+  module DeviceType
+    WEB = 'web'
+    IPHONE = 'iphone'
+    IPAD = 'ipad'
+    ANDROID_PHONE = 'android_phone'
+    ANDROID_TABLET = 'android_tablet'
+  end
+end

data/lib/route4me/enum/direction_method.rb

@@ -0,0 +1,7 @@
+module Route4me
+  module DirectionMethod
+    VIRTUALEARTH = 1
+    GOOGLE = 2
+    HERE = 3
+  end
+end

data/lib/route4me/enum/distance_unit.rb

@@ -0,0 +1,6 @@
+module Route4me
+  module DistanceUnit
+    MILES = 'mi'
+    KILOMETERS = 'km'
+  end
+end

data/lib/route4me/enum/metric.rb

@@ -0,0 +1,9 @@
+module Route4me
+  module Metric
+    EUCLIDEAN = 1
+    MANHATTAN = 2
+    GEODESIC = 3
+    MATRIX = 4
+    EXACT_2D = 5
+  end
+end

data/lib/route4me/enum/optimization_type.rb

@@ -0,0 +1,7 @@
+module Route4me
+  module OptimizationType
+    DISTANCE = 'Distance'
+    TIME = 'Time'
+    TIME_WITH_TRAFFIC = 'timeWithTraffic'
+  end
+end

data/lib/route4me/enum/travel_mode.rb

@@ -0,0 +1,7 @@
+module Route4me
+  module TravelMode
+    DRIVING = 'Driving'
+    WALKING = 'Walking'
+    TRUCKING = 'Trucking'
+  end
+end

data/lib/route4me/errors/api_error.rb

@@ -0,0 +1,4 @@
+module Route4me
+  class ApiError < Route4meError
+  end
+end

data/lib/route4me/errors/route4me_error.rb

@@ -0,0 +1,16 @@
+module Route4me
+  class Route4meError < StandardError
+    attr_reader :message, :http_status, :http_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/route4me/optimization_problem.rb

@@ -0,0 +1,40 @@
+module Route4me
+  class OptimizationProblem
+    def self.url
+      '/api.v4/optimization_problem.php'
+    end
+
+    def self.get(params={})
+      get = Util.extract(params, [
+        :optimization_problem_id, :wait_for_final_state,
+        :state, :limit, :offset
+      ])
+
+      optimization = Route4me.request(:get, self.url, get: get)
+      if (optimization[:optimizations]).nil?
+        optimization
+      else
+        optimization[:optimizations]
+      end
+    end
+
+    def self.optimize(params={})
+      json = Util.extract(params, [:addresses, :parameters])
+      get = Util.extract(params, [
+        :directions, :format, :route_path_output, :optimized_callback_url
+      ])
+
+      Route4me.request(:post, self.url, get: get, json: json)
+    end
+
+    def self.update(params={})
+      json = Util.extract(params, [:addresses, :parameters])
+      get = Util.extract(params, [
+        :optimization_problem_id, :directions, :format,
+        :route_path_output, :reoptimize
+      ])
+
+      Route4me.request(:post, self.url, get: get, json: json)
+    end
+  end
+end

data/lib/route4me/route.rb

@@ -0,0 +1,21 @@
+module Route4me
+  class Route
+    def self.url
+      '/api.v4/route.php'
+    end
+
+    def self.get(params={})
+      get = Util.extract(params, [
+        :route_id, :directions, :route_path_output, :device_tracking_history,
+        :limit, :offset, :original
+      ])
+      Route4me.request(:get, self.url, get: get)
+    end
+
+    def self.delete(params={})
+      get = Util.extract(params, [:route_id])
+      status = Route4me.request(:delete, self.url, get: get)
+      status[:deleted]
+    end
+  end
+end

data/lib/route4me/track.rb

@@ -0,0 +1,17 @@
+module Route4me
+  class Track
+    def self.url
+      '/track/set.php'
+    end
+
+    def self.set(params={})
+      get = Util.extract(params, [
+        :format, :member_id, :route_id, :tx_id, :vehicle_id, :course,
+        :speed, :lat, :lng, :altitude, :device_type, :device_guid,
+        :device_timestamp, :app_version
+      ])
+
+      Route4me.request(:get, self.url, get: get)[:status]
+    end
+  end
+end

data/lib/route4me/util.rb

@@ -0,0 +1,28 @@
+module Route4me
+  module Util
+    def self.extract(params, keys)
+      s = params.select{|k,v| keys.include? k.to_sym }
+      Hash[s.map{|k, v| [k.to_sym, v] }]
+    end
+
+    def self.url_encode(key)
+      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def self.symbolize_names(object)
+      case object
+      when Hash
+        new = {}
+        object.each do |key, value|
+          key = (key.to_sym rescue key) || key
+          new[key] = symbolize_names(value)
+        end
+        new
+      when Array
+        object.map { |value| symbolize_names(value) }
+      else
+        object
+      end
+    end
+  end
+end