ruby_ptv_api 0.1.0

data/lib/ruby_ptv_api/model/x_tour/sequencing_tour_result.rb

@@ -0,0 +1,38 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingTourResult < RubyPtvApi::Model::Base
+        property 'period'
+        property 'drivingPeriod'
+        property 'distance'
+        property 'distanceFromFirstToLastTransportPoint'
+        property 'maxDistanceBetweenTransportPoints'
+        property 'servicePeriod'
+        property 'restPeriod'
+        property 'breakPeriod'
+        property 'earliness'
+        property 'waitingPeriod'
+        property 'transportPointCount'
+        property 'startTime'
+        property 'startTimeLatest'
+        property 'coDriverRequired'
+        property 'totalCosts'
+        property 'pickupQuantities'
+        property 'deliveryQuantities'
+        property 'maxQuantities'
+        property 'depotUploadingPeriod'
+        property 'depotUnloadingPeriod'
+        property 'depotAvailabilityForDeliveries'
+        property 'depotAvailabilityForPickups'
+        property 'tourChanged'
+        property 'violations'
+        property 'remainingPeriods'
+        
+        coerce_key :totalCosts, TotalCosts
+        coerce_key :pickupQuantities, Quantities
+        coerce_key :deliveryQuantities, Quantities
+        coerce_key :maxQuantities, Quantities
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/sequencing_transport_depot.rb

@@ -0,0 +1,19 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingTransportDepot < SequencingTransportOrder
+        property 'transportPoint'
+        property 'pickupQuantities'
+        property 'deliveryQuantities'
+        property 'maxTransportPeriodForDeliveries'
+        property 'maxTransportPeriodForPickups'
+        property 'depotAvailabilityForDeliveries'
+        property 'depotAvailabilityForPickups'
+
+        coerce_key :transportPoint, TransportPoint
+        coerce_key :pickupQuantities, Quantities
+        coerce_key :deliveryQuantities, Quantities
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/sequencing_transport_order.rb

@@ -0,0 +1,9 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingTransportOrder < AbstractTransportOrder
+     
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/sequencing_vehicle.rb

@@ -0,0 +1,8 @@
+ module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingVehicle < BaseVehicle
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/standard_params.rb

@@ -0,0 +1,22 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class StandardParams < PlanningParams
+        property 'startSequencingStep'
+        property 'constructionStep'
+        property 'middleSequencingStep'
+        property 'tourReductionStep'
+        property 'improvementStep'
+        property 'endSequencingStep'
+        property 'availableMachineTime'
+        property 'maximumNumberOfUnscheduledOrdersToBeAnalyzed'
+        property 'goalImportance'
+        property 'basicConstructionMethod'
+        property 'improvementMethod'
+        property 'sequencingMethod'
+
+        coerce_key :goalImportance, GoalImportance
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/total_costs.rb

@@ -0,0 +1,10 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TotalCosts < AbstractCosts
+        property 'costsPerHour'
+        property 'totalCosts'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/tour.rb

@@ -0,0 +1,26 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Tour < AbstractTour
+        property 'id'
+        property 'description'
+        property 'trailerId'
+        property 'trainId'
+        property 'tourPointFixation', transform_with: ->(value) do 
+          RubyPtvApi::Constant.validate(RubyPtvApi::Constant::TOUR_POINT_FIXATION, value)
+        end
+        property 'vehicleFixed'
+        property 'trailerFixed'
+        property 'areaNumber'
+        property 'ignoreIntermediatePeriodOfPreviousTour'
+        property 'restrictions'
+        property 'tourPoints'
+        property 'result'
+        
+        coerce_key :restrictions, TourRestrictions
+        coerce_key :tourPoints, Array[TourPoint]
+        coerce_key :result, TourResult
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/tour_event.rb

@@ -0,0 +1,14 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TourEvent < RubyPtvApi::Model::Base
+        property 'logisticPointId'
+        property 'startTime'
+        property 'period'
+        property 'descriptions'
+        property 'violations'
+        property 'tourIndex'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/tour_point.rb

@@ -0,0 +1,10 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TourPoint < AbstractTourPoint 
+        property 'tourFixed'
+        property 'remainPlanned'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/tour_point_result.rb

@@ -0,0 +1,28 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TourPointResult < RubyPtvApi::Model::Base
+        property 'orderId'
+        property 'arrivalTime'
+        property 'startServiceTime'
+        property 'endServiceTime'
+        property 'departureTime'
+        property 'drivingPeriod'
+        property 'waitingPeriod'
+        property 'servicePeriod'
+        property 'breakPeriodOnRoad'
+        property 'breakPeriodAtTourPoint'
+        property 'restPeriodOnRoad'
+        property 'restPeriodAtTourPoint'
+        property 'earliness'
+        property 'delay'
+        property 'startDistance'
+        property 'drivingDistance'
+        property 'currentQuantities'
+        property 'tourPointViolations'
+
+        coerce_key :currentQuantities, Quantities
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/tour_restrictions.rb

@@ -0,0 +1,13 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TourRestrictions < RubyPtvApi::Model::Base
+        property 'maxPeriod'
+        property 'maxDrivingPeriod'
+        property 'maxDistance'
+        property 'maxDistanceFromFirstToLastTransportPoint'
+        property 'maxDistanceBetweenTransportPoints'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/tour_result.rb

@@ -0,0 +1,17 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TourResult < AbstractTourResult
+        property 'vehicleRequirements'
+        property 'vehicleExclusions'
+        property 'trainDescription'
+        property 'trailerDescription'
+        property 'maxLoadingArea'
+        property 'minLoadingArea'
+        
+        coerce_key :maxLoadingArea, LoadingArea
+        coerce_key :minLoadingArea, LoadingArea
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/tour_violations.rb

@@ -0,0 +1,10 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TourViolations < RubyPtvApi::Model::Base
+        property 'tourId'
+        property 'violations'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/trailer.rb

@@ -0,0 +1,10 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Trailer < RubyPtvApi::Model::Base
+        property 'id'
+        property 'description'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/train.rb

@@ -0,0 +1,26 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Train < RubyPtvApi::Model::Base
+        property 'id'
+        property 'description'
+        property 'vehicleIds'
+        property 'trailerIds'
+        property 'capacities'
+        property 'costs'
+        property 'dimaId'
+        property 'minLoadingArea'
+        property 'maxLoadingArea'
+        property 'category'
+        property 'drivingPeriodFactor'
+        property 'transportEquipments'
+        property 'maxTransportPointCountPerTour'
+        
+        coerce_key :capacities, Capacities
+        coerce_key :costs, Costs
+        coerce_key :minLoadingArea, LoadingArea
+        coerce_key :maxLoadingArea, LoadingArea
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/transport_depot.rb

@@ -0,0 +1,20 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TransportDepot < TransportOrder
+        property 'depotIds'
+        property 'transportPoint'
+        property 'pickupQuantities'
+        property 'deliveryQuantities'
+        property 'maxTransportPeriodForDeliveries'
+        property 'maxTransportPeriodForPickups'
+        property 'depotAvailabilityForDeliveries'
+        property 'depotAvailabilityForPickups'
+
+        coerce_key :transportPoint    , TransportPoint
+        coerce_key :pickupQuantities  , Quantities
+        coerce_key :deliveryQuantities, Quantities
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/transport_order.rb

@@ -0,0 +1,19 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TransportOrder < AbstractTransportOrder
+        property 'vehicleId'
+        property 'vehicleCategories'
+        property 'vehicleRequirements'
+        property 'vehicleExclusions'
+        property 'areaNumber'
+        property 'minLoadingArea'
+        property 'maxLoadingArea'
+        property 'trailerLoadingForbidden'
+
+        coerce_key :minLoadingArea, LoadingArea
+        coerce_key :maxLoadingArea, LoadingArea
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/transport_point.rb

@@ -0,0 +1,17 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class TransportPoint < LogisticPoint
+        property 'tourSection', default: 0
+        property 'servicePeriod', default: 0
+        property 'useServicePeriodForRecreation', default: false
+        property 'allowServiceSplit', default: false
+        property 'openingIntervalConstraint', default: :START_OF_SERVICE, transform_with: ->(value) do 
+          RubyPtvApi::Constant.validate(RubyPtvApi::Constant::OPENING_INTERVAL_CONTRAINT, value)
+        end
+        property 'areaNumberPosition'
+        property 'coDriverRequired', default: false
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/unscheduled_order_analysis_result.rb

@@ -0,0 +1,15 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class UnscheduledOrderAnalysisResult < RubyPtvApi::Model::Base
+        property 'orderId'
+        property 'status'
+        property 'vehicleViolations'
+        property 'tourViolations'
+
+        coerce_key :vehicleViolations, Array[VehicleViolations]
+        coerce_key :tourViolations, Array[TourViolations]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/vehicle.rb

@@ -0,0 +1,27 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Vehicle < BaseVehicle
+        property 'id'
+        property 'description'
+        property 'category'
+        property 'transportEquipments'
+        property 'areaNumbers'
+        property 'intermediatePeriod'
+        property 'startLocation'
+        property 'endLocation'
+        property 'restrictions'
+        property 'minLoadingArea'
+        property 'maxLoadingArea'
+        property 'ignoreIntermediatePeriodBeforeFirstTour'
+        
+        coerce_key :startLocation , RubyPtvApi::Model::Point
+        coerce_key :endLocation   , RubyPtvApi::Model::Point
+        coerce_key :restrictions  , VehicleRestrictions
+        coerce_key :minLoadingArea, LoadingArea
+        coerce_key :maxLoadingArea, LoadingArea
+        
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/vehicle_costs.rb

@@ -0,0 +1,9 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class VehicleCosts < RubyPtvApi::Model::Base
+        property 'costsPerChain'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/vehicle_restrictions.rb

@@ -0,0 +1,11 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class VehicleRestrictions < RubyPtvApi::Model::Base
+        property 'maxTransportPointCountPerTour'
+        property 'maxDrivingPeriodPerChain'
+        property 'maxTourCountPerChain'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/vehicle_violations.rb

@@ -0,0 +1,12 @@
+module RubyPtvApi
+  module Model
+    module XTour
+      class VehicleViolations < RubyPtvApi::Model::Base
+        property 'vehicleId'
+        property 'trailerId'
+        property 'trainId'
+        property 'violations'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+module RubyPtvApi
+  module Operation
+    module XLocate
+      class Base < RubyPtvApi::Base
+        attr_reader :search_option_base_array, :sort_option_array, :result_field_array
+
+        def ptv_path
+          'xlocate/rs/XLocate'
+        end
+
+        def call(options: nil, sorting: nil, additional_fields: nil)
+          extra_params(options, sorting, additional_fields)
+          response = post(params)
+          parse_response(response)
+        end
+
+        def options=(opts)
+          raise 'Not implemented'
+          @search_option_base_array = opts
+        end
+
+        def options
+          @search_option_base_array || []
+        end
+
+        def sorting=(array)
+          raise "Required SortOption Model class" unless array.map{|k| k.is_a?(RubyPtvApi::Model::XLocate::SortOption)}.inject(:&)
+          @sort_option_array = array
+        end
+
+        def sorting
+          @sort_option_array || []
+        end
+
+        def additional_fields=(array)
+          check_additional_fields(array)
+          @result_field_array = array
+        end
+
+        def additional_fields 
+          @result_field_array || []
+        end
+
+        def extra_params(opts, sort, fields)
+          self.options = opts if opts
+          self.sorting = sort if sort
+          self.additional_fields = fields if fields
+        end
+
+        protected
+
+          def response_class
+            RubyPtvApi::Model::XLocate::AddressResponse
+          end
+
+        private 
+
+          def check_additional_fields(values)
+            values.each do |value|
+              unless RubyPtvApi::Constant::RESULT_FIELD.include?(value.to_sym)
+                raise WrongParameterFormat.new("Value #{value} is not a additional fields accepted value #{RubyPtvApi::Constant::RESULT_FIELD}")
+              end
+            end
+          end 
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module RubyPtvApi
+  module Operation
+    module XLocate
+      class FindAddress < RubyPtvApi::Operation::XLocate::Base
+        attr_reader :address
+
+        def initialize(address)
+          @address = address
+        end
+
+        def ptv_function
+          'findAddress'
+        end
+
+        def params
+          { 
+            addr: address,
+            options: options,
+            sorting: sorting,
+            additionalFields: additional_fields
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module RubyPtvApi
+  module Operation
+    module XLocate
+      class FindAddressByText < RubyPtvApi::Operation::XLocate::Base
+        attr_reader :text, :country
+
+        def initialize(text, country)
+          @text    = text
+          @country = country
+        end
+
+        def ptv_function
+          'findAddressByText'
+        end
+
+        def params
+          { 
+            address: text,
+            country: country,
+            options: options,
+            sorting: sorting,
+            additionalFields: additional_fields
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RubyPtvApi
+  module Operation
+    module XLocate
+      class FindAddresses < RubyPtvApi::Operation::XLocate::Base
+        attr_reader :addresses
+
+        def initialize(addresses)
+          raise 'Use FindAddress for single address' unless addresses.is_a? Array
+          @addresses = addresses
+        end
+
+        def ptv_function
+          'findAddresses'
+        end
+
+        def params
+          { 
+            addrs: addresses,
+            options: options,
+            sorting: sorting,
+            additionalFields: additional_fields
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module RubyPtvApi
+  module Operation
+    module XLocate
+      class FindCombinedTransportByLocation < RubyPtvApi::Operation::XLocate::Base
+        attr_reader :location
+
+        def initialize(location)
+          @location = location
+        end
+
+        def ptv_function
+          'findCombinedTransportByLocation'
+        end
+
+        def params
+          { 
+            location: location,
+            options: options,
+            additionalFields: additional_fields
+          }
+        end
+
+        protected
+
+          def response_class
+            RubyPtvApi::Model::XLocate::CombinedTransportResponse
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module RubyPtvApi
+  module Operation
+    module XLocate
+      class FindLocation < RubyPtvApi::Operation::XLocate::Base
+        attr_reader :location
+
+        def initialize(location)
+          @location = location
+        end
+
+        def ptv_function
+          'findLocation'
+        end
+
+        def params
+          { 
+            location: location,
+            options: options,
+            sorting: sorting,
+            additionalFields: additional_fields
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RubyPtvApi
+  module Operation
+    module XLocate
+      class FindLocations < RubyPtvApi::Operation::XLocate::Base
+        attr_reader :locations
+
+        def initialize(locations)
+          raise 'Use FindLocation for single address' unless locations.is_a? Array
+          @locations = locations
+        end
+
+        def ptv_function
+          'findLocations'
+        end
+
+        def params
+          { 
+            location: locations,
+            options: options,
+            sorting: sorting,
+            additionalFields: additional_fields
+          }
+        end
+      end
+    end
+  end
+end