ruby_ptv_api 0.1.0

data/lib/ruby_ptv_api/operation/x_locate/find_suggestion.rb

@@ -0,0 +1,36 @@
+module RubyPtvApi
+  module Operation
+    module XLocate
+      class FindSuggestion < RubyPtvApi::Operation::XLocate::Base
+        attr_reader :text, :country, :state
+
+        def initialize(text:, country: "", state: "")
+          @text    = text
+          @country = country
+          @state   = state
+        end
+
+        def ptv_function
+          'findSuggestion'
+        end
+
+        def params
+          { 
+            text: text,
+            country: country,
+            state: state,
+            options: options,
+            sorting: sorting,
+            additionalFields: additional_fields
+          }
+        end
+
+      protected
+
+          def response_class
+            RubyPtvApi::Model::XLocate::SuggestionResponse
+          end
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/operation/x_route/base.rb

@@ -0,0 +1,25 @@
+module RubyPtvApi
+  module Operation
+    module XRoute
+      class Base < RubyPtvApi::Base
+        attr_reader :search_option_base_array, :sort_option_array, :result_field_array
+
+        def ptv_path
+          'xroute/rs/XRoute'
+        end
+
+        def call #(options: nil, sorting: nil, additional_fields: nil)
+          response = post(params)
+          parse_response(response)
+        end
+
+        protected
+
+          def response_class
+            raise 'not implemented'
+          end
+
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/operation/x_route/calculate_reachable_objects.rb

@@ -0,0 +1,38 @@
+module RubyPtvApi
+  module Operation
+    module XRoute
+      class CalcutateReachableObjects < Base
+        attr_reader :sink, :binaryPathDesc, :locations, :options, :expansionDesc
+
+        def initialize(binaryPathDesc:, locations:, expansionDesc:, sink: nil, options: [])
+          @sink = sink
+          @binaryPathDesc = binaryPathDesc
+          @locations = locations
+          @options = options
+          @expansionDesc = expansionDesc
+        end
+
+        def ptv_function
+          'calculateReachableObjects'
+        end
+
+        def params
+          prms = { 
+            binaryPathDesc: binaryPathDesc,
+            locations: locations,
+            options: options,
+            expansionDesc: expansionDesc,
+          }
+          prms.merge!({ sink: sink }) if sink
+          prms
+        end
+
+        protected
+
+          def response_class
+            RubyPtvApi::Model::XRoute::Reach
+          end
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/operation/x_route/calculate_route.rb

@@ -0,0 +1,35 @@
+module RubyPtvApi
+  module Operation
+    module XRoute
+      class CalcutateRoute < Base
+        attr_reader :waypoints, :options, :exceptionPaths, :details
+
+        def initialize(waypoints:, options:, exceptionPaths: , details:)
+          @waypoints = waypoints
+          @options = options
+          @exceptionPaths = exceptionPaths
+          @details = details
+        end
+
+        def ptv_function
+          'calculateRoute'
+        end
+
+        def params
+          { 
+            waypoints: waypoints,
+            options: options,
+            exceptionPaths: exceptionPaths,
+            details: details
+          }
+        end
+
+        protected
+
+          def response_class
+            RubyPtvApi::Model::XRoute::Route
+          end
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/operation/x_route/calculate_route_info.rb

@@ -0,0 +1,33 @@
+module RubyPtvApi
+  module Operation
+    module XRoute
+      class CalcutateRouteInfo < Base
+        attr_reader :waypoints, :options, :exceptionPaths
+
+        def initialize(waypoints:, options: [], exceptionPaths: [])
+          @waypoints = waypoints
+          @options = options
+          @exceptionPaths = exceptionPaths
+        end
+
+        def ptv_function
+          'calculateRouteInfo'
+        end
+
+        def params
+          { 
+            waypoints: waypoints,
+            options: options,
+            exceptionPaths: exceptionPaths
+          }
+        end
+
+        protected
+
+          def response_class
+            RubyPtvApi::Model::XRoute::RouteInfo
+          end
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/operation/x_tour/base.rb

@@ -0,0 +1,24 @@
+module RubyPtvApi
+  module Operation
+    module XTour
+      class Base < RubyPtvApi::Base
+        attr_reader :search_option_base_array, :sort_option_array, :result_field_array
+
+        def ptv_path
+          'xtour/rs/XTour'
+        end
+
+        def call
+          response = post(params)
+          parse_response(response)
+        end
+
+        protected
+
+          def response_class
+            raise 'not implemented'
+          end
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/operation/x_tour/plan_basic_tours.rb

@@ -0,0 +1,48 @@
+module RubyPtvApi
+  module Operation
+    module XTour
+      class PlanBasicTours < Base
+        attr_reader :transport_orders, :depots, :fleet
+
+        def initialize(transport_orders:, depots:, fleet:)
+          @transport_orders = transport_orders
+          @depots = depots
+          @fleet = fleet
+        end
+
+        def ptv_function
+          'planBasicTours'
+        end
+
+        def planning_params
+          RubyPtvApi::Model::XTour::StandardParams.new({
+            "coDriverTransportPointsInSeparateTours" => false,
+            'distanceMatrixCalculation' => [
+                RubyPtvApi::Model::XTour::DistanceMatrixByRoad.new({
+                'dimaId' => 1,
+                'deleteBeforeUsage' => true,
+                'deleteAfterUsage' => true
+              })                
+            ]
+          })
+        end
+
+        def params
+          { 
+            transportOrders: transport_orders,
+            depots: depots,
+            fleet: fleet,
+            planningParams: planning_params,
+            inputPlan: nil
+          }
+        end
+
+        protected
+
+          def response_class
+            RubyPtvApi::Model::XTour::Plan
+          end
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/operation/x_tour/plan_sequence.rb

@@ -0,0 +1,52 @@
+module RubyPtvApi
+  module Operation
+    module XTour
+      class PlanSequence < Base
+        attr_reader :transport_orders, :depots, :vehicle
+
+        def initialize(transport_orders:, depots:, vehicle:)
+          @transport_orders = transport_orders
+          @depots = depots
+          @vehicle = vehicle
+          @dimaId = 1
+        end
+
+        def ptv_function
+          'planSequence'
+        end
+
+        def sequencing_params
+          RubyPtvApi::Model::XTour::SequencingParams.new({
+            'coDriverTransportPointsInSeparateTours' => false,
+            'distanceMatrixCalculation' => 
+              [
+                  RubyPtvApi::Model::XTour::DistanceMatrixByRoad.new({
+                  'dimaId' => 1,
+                  'deleteBeforeUsage' => true,
+                  'deleteAfterUsage' => true
+                })                
+              ]
+          })
+        end
+
+        def params
+          { 
+            transportOrders: transport_orders,
+            depots: depots,
+            vehicle: vehicle,
+            sequencingParams: sequencing_params,
+            inputPlan: nil
+          }
+        end
+
+        protected
+
+          def response_class
+            RubyPtvApi::Model::XTour::SequencingPlan
+          end
+
+        
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/version.rb

@@ -0,0 +1,3 @@
+module RubyPtvApi
+  VERSION = "0.1.0"
+end

data/lib/ruby_ptv_api/x_tour.rb

@@ -0,0 +1,94 @@
+module RubyPtvApi
+  module XTour
+    class << self
+      def plan_sequence(points, garage)
+        required_keys = [:uuid, :latitude, :longitude]
+        raise "garage has to include the  keys #{required_keys}" unless (required_keys - garage.methods).empty?
+
+        dimaId = 1
+        id_manager = RubyPtvApi::IdManager.new
+        depot = RubyPtvApi::Model::XTour::Depot.new(
+          'id' => id_manager.add(garage.uuid), 
+          'location' => RubyPtvApi::Model::Point.new(
+            'point' => RubyPtvApi::Model::PlainPoint.new(
+              'x' => RubyPtvApi.cast_coordinate(garage.longitude),
+              'y' => RubyPtvApi.cast_coordinate(garage.latitude)
+            )
+          )
+        ) 
+        depot.openingIntervals = [
+            RubyPtvApi::Model::XTour::Interval.new(
+            'from' => garage.interval.first.to_i,
+            'till' => garage.interval.last.to_i
+          )
+        ] if garage.interval
+        
+        sequencing_transport_depots = []
+        vehicle = RubyPtvApi::Model::XTour::SequencingVehicle.new(
+          'dimaId' => dimaId, 
+          'depotIdStart' => depot.id,
+          'depotIdEnd' => depot.id, 
+          'isPreloaded' => true, 
+          'ignoreTransportPointServicePeriod' => false,
+          'coDriverStatus' => :NEVER,
+          'toursMustFitIntoSingleOperatingInterval' => true
+        ) 
+        vehicle.operatingIntervals = [
+            RubyPtvApi::Model::XTour::Interval.new(
+            'from' => garage.interval.first.to_i,
+            'till' => garage.interval.last.to_i
+          )
+        ] if garage.interval
+
+        points.each do |point|
+          raise "each point has to include the keys #{required_keys}" unless (required_keys - point.methods).empty?
+          sequencing_transport_depots << create_sequencing_transport_depot(
+            uuid: point.uuid,
+            latitude:  RubyPtvApi.cast_coordinate(point.latitude),
+            longitude: RubyPtvApi.cast_coordinate(point.longitude),
+            interval:  point.interval,
+            id_manager: id_manager
+          )
+        end
+        function = RubyPtvApi::Operation::XTour::PlanSequence.new(
+          transport_orders: sequencing_transport_depots, 
+          depots: [depot], 
+          vehicle: vehicle
+        )
+        response = function.call
+        sequence = response.tour.tourPoints ? response.tour.tourPoints.map{|tp| id_manager.uuid(tp.id.to_i)} : []
+        unmanaged_list = response.result.unscheduledOrderIds ? response.result.unscheduledOrderIds.map{|id| id_manager.uuid(id)} : []
+        hash = Hash[points.map{|e| [e.uuid, e]}]
+        {
+          sequence: sequence.map{|e| hash[e]}.compact,
+          unmanaged: unmanaged_list.map{|e| hash[e]},
+          raw_response: response
+        }
+      end
+
+      def create_sequencing_transport_depot(uuid:, id_manager:, latitude:, longitude:, interval:)
+        transport_point = RubyPtvApi::Model::XTour::TransportPoint.new(
+          'id' => id_manager.add(uuid),
+          'location' => RubyPtvApi::Model::Point.new(
+            'point' => RubyPtvApi::Model::PlainPoint.new(
+              'x' => longitude,
+              'y' => latitude
+            )
+          )
+        )
+        transport_point.openingIntervals = [
+            RubyPtvApi::Model::XTour::Interval.new(
+            'from' => interval.first.to_i,
+            'till' => interval.last.to_i
+          )
+        ] if interval
+        
+        std = RubyPtvApi::Model::XTour::SequencingTransportDepot.new(
+          'id' => id_manager.add(uuid),          
+          'transportPoint' => transport_point
+        )
+        std
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api.rb

@@ -0,0 +1,202 @@
+require 'oj'
+require 'hashie'
+require 'faraday'
+
+require "ruby_ptv_api/base"
+require "ruby_ptv_api/constant"
+require "ruby_ptv_api/version"
+
+require "ruby_ptv_api/model/base"
+require "ruby_ptv_api/model/plain_point"
+require "ruby_ptv_api/model/point"
+
+require "ruby_ptv_api/model/x_locate/address"
+require "ruby_ptv_api/model/x_locate/result_address"
+require "ruby_ptv_api/model/x_locate/address_response"
+require "ruby_ptv_api/model/x_locate/location"
+require "ruby_ptv_api/model/x_locate/sort_option"
+require "ruby_ptv_api/model/x_locate/additional_field"
+require "ruby_ptv_api/model/x_locate/combined_transport_location"
+require "ruby_ptv_api/model/x_locate/result_combined_transport"
+require "ruby_ptv_api/model/x_locate/combined_transport_response"
+require "ruby_ptv_api/model/x_locate/suggestion"
+require "ruby_ptv_api/model/x_locate/suggestion_response"
+
+require "ruby_ptv_api/model/x_tour/abstract_transport_order.rb"
+require "ruby_ptv_api/model/x_tour/quantities.rb"
+require "ruby_ptv_api/model/x_tour/capacities.rb"
+require "ruby_ptv_api/model/x_tour/interval.rb"
+require "ruby_ptv_api/model/x_tour/maximum_tour_period_restriction.rb"
+require "ruby_ptv_api/model/x_tour/driver_settings.rb"
+require "ruby_ptv_api/model/x_tour/tour_restrictions.rb"
+require "ruby_ptv_api/model/x_tour/restrictions.rb"
+require "ruby_ptv_api/model/x_tour/quantity_dependent_periods.rb"
+require "ruby_ptv_api/model/x_tour/loading_function.rb"
+require "ruby_ptv_api/model/x_tour/distance_matrix_calculation.rb"
+require "ruby_ptv_api/model/x_tour/distance_matrix_by_road.rb"
+require "ruby_ptv_api/model/x_tour/product_incompatibility.rb"
+require "ruby_ptv_api/model/x_tour/goal_importance.rb"
+require "ruby_ptv_api/model/x_tour/planning_params.rb"
+require "ruby_ptv_api/model/x_tour/standard_params.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_params.rb"
+require "ruby_ptv_api/model/x_tour/abstract_costs.rb"
+require "ruby_ptv_api/model/x_tour/total_costs.rb"
+require "ruby_ptv_api/model/x_tour/abstract_tour.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_tour_result.rb"
+require "ruby_ptv_api/model/x_tour/tour_point_result.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_tour_point.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_tour.rb"
+require "ruby_ptv_api/model/x_tour/tour_event.rb"
+require "ruby_ptv_api/model/x_tour/vehicle_violations.rb"
+require "ruby_ptv_api/model/x_tour/tour_violations.rb"
+require "ruby_ptv_api/model/x_tour/unscheduled_order_analysis_result.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_plan_result.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_plan.rb"
+require "ruby_ptv_api/model/x_tour/vehicle_costs.rb"
+require "ruby_ptv_api/model/x_tour/abstract_vehicle.rb"
+require "ruby_ptv_api/model/x_tour/base_vehicle.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_vehicle.rb"
+require "ruby_ptv_api/model/x_tour/logistic_point.rb"
+require "ruby_ptv_api/model/x_tour/depot.rb"
+require "ruby_ptv_api/model/x_tour/transport_point.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_transport_order.rb"
+require "ruby_ptv_api/model/x_tour/sequencing_transport_depot.rb"
+require "ruby_ptv_api/model/x_tour/loading_area.rb"
+require "ruby_ptv_api/model/x_tour/transport_order.rb"
+require "ruby_ptv_api/model/x_tour/transport_depot.rb"
+require "ruby_ptv_api/model/x_tour/vehicle_restrictions.rb"
+require "ruby_ptv_api/model/x_tour/vehicle.rb"
+require "ruby_ptv_api/model/x_tour/abstract_tour_point.rb"
+require "ruby_ptv_api/model/x_tour/chain_result.rb"
+require "ruby_ptv_api/model/x_tour/tour_point.rb"
+require "ruby_ptv_api/model/x_tour/abstract_tour_result.rb"
+require "ruby_ptv_api/model/x_tour/tour_result.rb"
+require "ruby_ptv_api/model/x_tour/tour.rb"
+require "ruby_ptv_api/model/x_tour/chain.rb"
+require "ruby_ptv_api/model/x_tour/plan_result.rb"
+require "ruby_ptv_api/model/x_tour/plan.rb"
+require "ruby_ptv_api/model/x_tour/trailer.rb"
+require "ruby_ptv_api/model/x_tour/costs.rb"
+require "ruby_ptv_api/model/x_tour/train.rb"
+require "ruby_ptv_api/model/x_tour/fleet.rb"
+require "ruby_ptv_api/model/x_tour/loading_area.rb"
+require "ruby_ptv_api/model/x_tour/plan_result.rb"
+require "ruby_ptv_api/model/x_tour/plan.rb"
+require "ruby_ptv_api/model/x_tour/transport_order.rb"
+require "ruby_ptv_api/model/x_tour/vehicle_restrictions.rb"
+require "ruby_ptv_api/model/x_tour/vehicle.rb"
+
+require "ruby_ptv_api/model/x_route/bounding_rectangle.rb"
+require "ruby_ptv_api/model/x_route/brunnel_manoeuvre.rb"
+require "ruby_ptv_api/model/x_route/cen_emissions.rb"
+require "ruby_ptv_api/model/x_route/cen_emission_configuration.rb"
+require "ruby_ptv_api/model/x_route/cen_emission_conversion_factors.rb"
+require "ruby_ptv_api/model/x_route/cen_emission_scenarios.rb"
+require "ruby_ptv_api/model/x_route/commuter_travel_trend.rb"
+require "ruby_ptv_api/model/x_route/detail_description_option.rb"
+require "ruby_ptv_api/model/x_route/dynamic_info.rb"
+require "ruby_ptv_api/model/x_route/emission_type.rb"
+require "ruby_ptv_api/model/x_route/emissions.rb"
+require "ruby_ptv_api/model/x_route/unique_geo_id.rb"
+require "ruby_ptv_api/model/x_route/plain_geometry_base.rb"
+require "ruby_ptv_api/model/x_route/klm.rb"
+require "ruby_ptv_api/model/x_route/encoded_geometry.rb"
+require "ruby_ptv_api/model/x_route/plain_line_string.rb"
+require "ruby_ptv_api/model/x_route/line_string.rb"
+require "ruby_ptv_api/model/x_route/exception_path.rb"
+require "ruby_ptv_api/model/x_route/feauture_description.rb"
+require "ruby_ptv_api/model/x_route/hbefa_type.rb"
+require "ruby_ptv_api/model/x_route/manoeuvre_attr.rb"
+require "ruby_ptv_api/model/x_route/manoeuvre_group.rb"
+require "ruby_ptv_api/model/x_route/norm_speed.rb"
+require "ruby_ptv_api/model/x_route/result_list_options.rb"
+require "ruby_ptv_api/model/x_route/segment_attributes.rb"
+require "ruby_ptv_api/model/x_route/speed_limit.rb"
+require "ruby_ptv_api/model/x_route/speed_limits.rb"
+require "ruby_ptv_api/model/x_route/urban_manoeuvre.rb"
+require "ruby_ptv_api/model/x_route/vehicle_option.rb"
+require "ruby_ptv_api/model/x_route/via_type.rb"
+require "ruby_ptv_api/model/x_route/way_point.rb"
+require "ruby_ptv_api/model/x_route/routing_option.rb"
+require "ruby_ptv_api/model/x_route/waypoint_desc.rb"
+require "ruby_ptv_api/model/x_route/route_info.rb"
+require "ruby_ptv_api/model/x_route/route_list_segment.rb"
+require "ruby_ptv_api/model/x_route/route_manoeuvre.rb"
+require "ruby_ptv_api/model/x_route/route.rb"
+require "ruby_ptv_api/model/x_route/expansion_description.rb"
+require "ruby_ptv_api/model/x_route/reach_info.rb"
+require "ruby_ptv_api/model/x_route/reach.rb"
+
+require "ruby_ptv_api/operation/x_locate/base"
+require "ruby_ptv_api/operation/x_locate/find_address"
+require "ruby_ptv_api/operation/x_locate/find_addresses"
+require "ruby_ptv_api/operation/x_locate/find_location"
+require "ruby_ptv_api/operation/x_locate/find_locations"
+require "ruby_ptv_api/operation/x_locate/find_combined_transport_by_location"
+require "ruby_ptv_api/operation/x_locate/find_address_by_text"
+require "ruby_ptv_api/operation/x_locate/find_suggestion"
+
+require "ruby_ptv_api/operation/x_tour/base"
+require "ruby_ptv_api/operation/x_tour/plan_sequence"
+require "ruby_ptv_api/operation/x_tour/plan_basic_tours"
+
+require "ruby_ptv_api/operation/x_route/base"
+require "ruby_ptv_api/operation/x_route/calculate_route"
+require "ruby_ptv_api/operation/x_route/calculate_route_info"
+require "ruby_ptv_api/operation/x_route/calculate_reachable_objects"
+
+require "ruby_ptv_api/id_manager"
+require "ruby_ptv_api/x_tour"
+
+module RubyPtvApi
+  
+  # Class method to set up configuration parameters
+  #
+  # @example
+  #   RubyPtvApi.configure do |c|
+  #     c.x_locate_endpoint = "http://..."
+  #   end
+  #
+  def self.configure(&block)
+    Oj.default_options = { :mode => :compat }
+    yield @config ||= Configuration.new
+  end
+
+  # Return configuration parameters
+  #
+  # @example
+  #   RubyPtvApi.config.x_locate_endpoint
+  #
+  def self.config
+    if @config.nil? or @config.instance_variables.count != 3
+      raise 'RubyPtvApi gem uncompleted config'
+    end
+    @config
+  end
+
+  # Container for configuration parameters
+  #
+  class Configuration
+    attr_accessor :x_locate_endpoint, :x_route_endpoint, :x_tour_endpoint
+  end
+
+  # Exception raised for connection error
+  #  
+  class BadResponse < Exception; end
+
+  # Exception raised when a mandatory parameter is missing
+  #  
+  class MissingParameter < Exception; end
+
+  # Exception raised when more than one require parameter is given
+  #  
+  class TooManyParameters < Exception; end
+
+  # Exception raised when a parameter is in the wrong format
+  #  
+  class WrongParameterFormat < Exception; end
+
+  def self.cast_coordinate(coord)
+    coord.to_i.to_s.size != 7 ? (coord * 100000).to_i : coord
+  end
+end

data/ruby_ptv_api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_ptv_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_ptv_api"
+  spec.version       = RubyPtvApi::VERSION
+  spec.authors       = ["Leanbit srl"]
+  spec.email         = ["info@leanbit.it"]
+  spec.licenses      = ['MIT']
+  spec.summary       = "Unofficial PVT ruby client"
+  spec.description   = "PTV client, incomplete implementation of x_route, x_locate, x_tour"
+  spec.homepage      = "https://github.com/satelicom/ruby-ptv-api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", '~> 0.9'
+  spec.add_dependency "oj", '~> 2.16'
+  spec.add_dependency "hashie", '~> 3.4'
+  
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard", "~> 2.13"
+  spec.add_development_dependency "guard-rspec", "~> 4.6"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "factory_girl", "~> 4.5"
+end