gillbus 0.17.6 → 0.22.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 39981156aa20418b3109add8e3d94c63077bd44c
-  data.tar.gz: 50e5710aa809acc6203119011b706034fbdd100f
+SHA256:
+  metadata.gz: b85dbfeb542cb41597bcaff503e35298c94742adcf937f536f41d26849c41f0b
+  data.tar.gz: fe22b0ac687bf787630356475e001b40f8ecbeccb1f6a3560816b8663666a75d
 SHA512:
-  metadata.gz: 512923d49ef42592d7f3d1d2fbd4a6e97b888d15980cd1b1ebeee82ded1908cda2fa820e07d8a2769ebf797f2557e7d8beb1395e34dee02f54298705d2c2f4ab
-  data.tar.gz: 15d286724cead0805000c7d4d29c9abea2f7b59ca11561bc8cc6515a2e037cf616df9cbfa6284d9f90c418723de581c00ef6b3ad7d95add3171a6cb0a11c261d
+  metadata.gz: 5bdc19f44370f737270f8220415b9c6ef927a7821e08d072bf2f778c6adbfe9b847a212b53a036b7ab226772bc1459cbab5d5be29337fb16bd5de11d89d61cd0
+  data.tar.gz: 24b1d2cf5459a9f61bafa62adf9f2cdfd27c18562ca3bdb5f15afcdf306ed60e98f29e19444682f955d26380b5162adfd3b1d4d8e97c8cba11907b5d907952d0

data/.ruby-version

@@ -1 +1 @@
-2.3.2
+2.6.3

data/Gemfile

@@ -2,7 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gillbus.gemspec
 gemspec
-
-group :development do
-  gem 'ox'
-end

data/gillbus.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_dependency 'monetize'
   spec.add_dependency 'money'
-  spec.add_dependency 'multi_xml'
+  spec.add_dependency 'ox', '~> 2.9'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'minitest'

data/lib/gillbus/base_request.rb

@@ -45,6 +45,8 @@ class Gillbus
         'uk' => 'ukr',
         'th' => 'tai',
         'pl' => 'pol',
+        'cs' => 'ces',
+        'bg' => 'bul',
 
         # temporary, until changed in busfor
         'ua' => 'ukr',

data/lib/gillbus/base_response.rb

@@ -1,4 +1,4 @@
-require 'multi_xml'
+require 'ox'
 
 class Gillbus
   class BaseResponse
@@ -13,11 +13,15 @@ class Gillbus
     attr_accessor :external_error_message
     attr_accessor :request_time
 
+    attr_accessor :raw_xml # make accessible for logging and debuging
+
     def error?
       !error_code.nil?
     end
 
     def self.parse(data, instance: new, options: {})
+      instance.raw_xml = options[:raw_xml] if options[:raw_xml]
+
       # ugly
       if data['MESSAGE']
         instance.error_code = data['MESSAGE']['CODE'].to_i
@@ -32,12 +36,12 @@ class Gillbus
     end
 
     def self.parse_string(xml_string, **options)
-      xml = MultiXml.parse(xml_string)
+      xml = Ox.load(xml_string, mode: :hash, symbolize_keys: false)
       # <DATA/> is a valid response
       return ParseError.new(xml_string, 'DATA attribute missing') unless xml.key?('DATA')
       data = xml['DATA'] || {}
-      parse(data, instance: new, options: options)
-    rescue MultiXml::ParseError, ArgumentError => e
+      parse(data, instance: new, options: options.merge(raw_xml: xml_string))
+    rescue Ox::ParseError, ArgumentError => e
       ParseError.new(xml_string, e.message)
     end
   end

data/lib/gillbus/get_carriers.rb

@@ -0,0 +1,13 @@
+class Gillbus
+  module GetCarriers
+    Gillbus.register self, :get_carriers
+
+    class Request < BaseRequest
+      def path; '/online2/getCarriers' end
+    end
+
+    class Response < BaseResponse
+      field :carriers, [Carrier], key: 'CARRIER'
+    end
+  end
+end

data/lib/gillbus/get_required_fields.rb

@@ -16,6 +16,7 @@ class Gillbus
 
     class Response < BaseResponse
       field :dictionary, :bool_dict
+      field :luggage, Luggage, key: 'BAGGAGE'
 
       parser do
         def bool_dict(val)

data/lib/gillbus/get_trip_seats.rb

@@ -21,6 +21,11 @@ class Gillbus
       # Только для железнодорожных рейсов.
       attr_accessor :back_carriage_id
 
+      # floorNumber
+      # Номер этажа автобуса, если указан, то возвращается карта мест указанного этажа.
+      # Если задан неверно или не указан, то возвращается вся карта мест.
+      attr_accessor :floor_number
+
       # segment0carriageId...segmentNcarriageId (не обязательный)
       # ИД вагона сегмента рейса с порядковым нормеом 0...N, для которого нужно получить карту мест.
       # По-умолчанию первый попавшийся. Только для железнодорожных рейсов.
@@ -30,6 +35,7 @@ class Gillbus
           tripId: trip_id,
           carriageId: carriage_id,
           backCarriageId: back_carriage_id,
+          floorNumber: floor_number,
         )
       end
     end
@@ -38,6 +44,7 @@ class Gillbus
       SEGMENT_REGEX = /SEGMENT_(?<number>\d+)_SEAT/
 
       field :seats, [Seat], key: 'SEAT'
+      field :back_seats, [Seat], key: 'BACK_SEAT' # для round_trip offers
 
       field :segments, :segments, key: SEGMENT_REGEX
 

data/lib/gillbus/helpers/parser.rb

@@ -3,6 +3,13 @@ require 'active_support/time'
 
 class Gillbus
   class Parser
+    NULL_CONST = 'null'.freeze
+    TRUE_CONST = 'true'.freeze
+    YES_CONST = 'Y'.freeze
+    DATE_FORMAT_CONST = '%d.%m.%Y'.freeze
+    TIME_FORMAT_REGEXP = /^ ( \d\d:\d\d ) (?: :\d\d )? $/x.freeze
+    DEFAULT_TIMEZONE = 'Europe/Kiev'.freeze
+
     attr_accessor :doc
     attr_accessor :instance
     attr_accessor :fields
@@ -33,18 +40,43 @@ class Gillbus
     private
 
     def fetch_value(key:, root:)
+      target_doc = root ? doc[root] : doc
+      return unless target_doc
+
       if key.is_a?(Regexp)
-        doc.select { |k| k =~ key }
-      elsif root
-        doc[root] && doc[root][key]
+        target_doc.select { |k| k =~ key }
+      elsif key.is_a?(Array)
+        key.map { |k| ensure_array(target_doc[k]) }.inject(&:+)
+      else
+        target_doc[key]
+      end
+    end
+
+    # Нужно удостовериться, что элемент завёрнут в массив,
+    # чтобы дальше эти массивы сложить в методе fetch_value.
+    # Есть нюанс, что при сложении ['Item'] + [{'ID'=>'1'}, 'Subitem'] получается
+    # ['Item', {'ID'=>'1'}, 'Subitem'], а нам надо ['Item', [{'ID'=>'1'}, 'Subitem']]
+    # Поэтому item_with_id заворачиваем во внешний массив
+    def ensure_array(val)
+      if is_item_with_id?(val)
+        [val]
       else
-        doc[key]
+        Array(val)
       end
     end
 
+    # Детектит элементы вида <CRITICAL_INF ID="1">Text</CRITICAL_INF>,
+    # которые парсятся как [{'ID'=>'1'}, 'Text']
+    def is_item_with_id?(val)
+      val.is_a?(Array) && val.size == 2 && val.first.is_a?(Hash) && val.first.keys == ['ID']
+    end
+
     def make_one_or_many(type, val)
       # [:type]
       if type.is_a? Array
+        if val.is_a?(Array) && val[0].is_a?(Hash) && !val[0].has_key?('__content__')
+          val = [val] if val[1].is_a?(String) # hack to handle attribute parsing by Ox
+        end
         array(val).map { |v| make_one type.first, v }
       # :type
       else
@@ -70,16 +102,18 @@ class Gillbus
     end
 
     def string(val)
-      return if val == 'null'
+      return if val == NULL_CONST
+      # если это тег с атрибутами - возвращаем только содержимое тега
+      return val.last if val.is_a?(Array) && val.size == 2
       val
     end
 
     def bool(val)
-      val == 'true'
+      val == TRUE_CONST
     end
 
     def yesno_bool(val)
-      val == 'Y'
+      val == YES_CONST
     end
 
     def int(val)
@@ -87,12 +121,12 @@ class Gillbus
     end
 
     def date(val)
-      Date.strptime(val, '%d.%m.%Y')
+      Date.strptime(val, DATE_FORMAT_CONST)
     end
 
     # rubocop:disable Style/GuardClause, Style/IfUnlessModifier
     def time(val)
-      if val =~ /^ ( \d\d:\d\d ) (?: :\d\d )? $/x
+      if val =~ TIME_FORMAT_REGEXP
         $1
       end
     end
@@ -109,11 +143,11 @@ class Gillbus
     end
 
     def default_timezone
-      @options[:timezone] || 'Europe/Kiev'
+      @options[:timezone] || DEFAULT_TIMEZONE
     end
 
     def decimal(val)
-      BigDecimal.new(val)
+      BigDecimal(val)
     end
   end
 end

data/lib/gillbus/return_position.rb

@@ -33,6 +33,8 @@ class Gillbus
         field :reason_id
         field :date
         field :failures
+        field :returned_amount
+        field :detained_amount
       end
 
       field :return_positions, [ReturnPosition], key: 'RETURN_POSITION'

data/lib/gillbus/return_position_forced.rb

@@ -0,0 +1,16 @@
+class Gillbus
+  module ReturnPositionForced
+    Gillbus.register self, :return_position_forced
+
+    class Request < ::Gillbus::ReturnPosition::Request
+      def path; '/online2/ReturnPositionForced'; end
+    end
+
+    class Response < ::Gillbus::ReturnPosition::Response
+      class ReturnPositionForced < ::Gillbus::ReturnPosition::Response::ReturnPosition
+      end
+
+      field :return_positions, [::Gillbus::ReturnPosition::Response::ReturnPosition], key: 'RETURN_POSITION'
+    end
+  end
+end

data/lib/gillbus/search_nearby_trips.rb

@@ -0,0 +1,39 @@
+class Gillbus
+  module SearchTripNearbyCities
+    Gillbus.register self, :search_nearby_cities_trips
+
+    class Request < BaseRequest
+      def path; '/online2/searchTripNearbyCities' end
+
+      # startCityId
+      # ИД пункта отправления
+      attr_accessor :start_city_id
+
+      # endCityId
+      # ИД пункта прибытия
+      attr_accessor :end_city_id
+
+      # startDateSearch
+      # Дата отправления, на которую будет произведен поиск рейсов.
+      attr_accessor :start_date_search
+
+      # ticketCount
+      # Количество оформляемых билетов. От 1 до k.
+      attr_accessor :ticket_count
+
+      def params
+        compact(
+          startCityId: start_city_id,
+          endCityId: end_city_id,
+          startDateSearch: date(start_date_search),
+          ticketCount: ticket_count,
+        )
+      end
+    end
+
+    class Response < BaseResponse
+      field :completed, :bool
+      field :trips, [NearbyCitiesTrip], key: 'TRIP', root: 'NEARBY_CITIES'
+    end
+  end
+end

data/lib/gillbus/search_trips.rb

@@ -44,6 +44,11 @@ class Gillbus
       # Если false, то будут искаться рейсы только в одну сторону.
       attr_accessor :round_trip
 
+      # limitSegmentTripShow (опциональный параметр)
+      # Ограничение максимального количества сегментных рейсов.
+      # Если ничего не передано или передано число -1, то выдача не ограничена.
+      attr_accessor :limit_segment_trip_show
+
       # backStartDateSearch (обязательный если roundTrip=true)
       # Дата отправления, на которую будет произведен поиск обратных рейсов.
       attr_accessor :back_start_date_search
@@ -93,20 +98,21 @@ class Gillbus
 
       def params
         compact(
-          selectedModes:       modes(selected_modes),
-          connectionIds:       list(connection_ids),
-          tripFullSale:        bool(trip_full_sale),
-          fullSearch:          bool(full_search),
-          startCityId:         start_city_id,
-          endCityId:           end_city_id,
-          startDateSearch:     date(start_date_search),
-          roundTrip:           bool(round_trip),
+          selectedModes: modes(selected_modes),
+          connectionIds: list(connection_ids),
+          tripFullSale: bool(trip_full_sale),
+          fullSearch: bool(full_search),
+          startCityId: start_city_id,
+          endCityId: end_city_id,
+          startDateSearch: date(start_date_search),
+          roundTrip: bool(round_trip),
+          limitSegmentTripShow: limit_segment_trip_show,
           backStartDateSearch: date(back_start_date_search),
-          ticketCount:         ticket_count,
-          waitTimeout:         wait_timeout,
-          onlyBranded:         bool(only_branded),
-          tripOptions:         bool(trip_options),
-          insuranceId:         insurance_id,
+          ticketCount: ticket_count,
+          waitTimeout: wait_timeout,
+          onlyBranded: bool(only_branded),
+          tripOptions: bool(trip_options),
+          insuranceId: insurance_id,
           **passengers_data,
         )
       end
@@ -132,6 +138,7 @@ class Gillbus
     class Response < BaseResponse
       field :completed, :bool
       field :trips, [Trip], key: 'TRIP'
+      field :back_trips, [Trip], key: 'BACK_TRIP'
     end
   end
 end

data/lib/gillbus/structs/carrier.rb

@@ -0,0 +1,11 @@
+class Gillbus
+  class Carrier
+    extend Fields
+    include UpdateAttrs
+
+    field :id, key: 'CARRIER_ID'
+    field :name, key: 'CARRIER_NAME'
+    field :legal_name, key: 'CARRIER_LEGAL_NAME'
+    field :inn
+  end
+end

data/lib/gillbus/structs/luggage.rb

@@ -0,0 +1,19 @@
+class Gillbus
+  class Luggage
+    extend Fields
+
+    # => "0"
+    field :segment_number, :int
+
+    # => "true"
+    field :is_buy, :bool
+
+    # => "50.5"
+    field :luggage_tariff, :decimal, key: 'BAGGAGE_TARIFF'
+
+    # => "2"
+    field :luggage_limit, :int, key: 'BAGGAGE_LIMIT'
+
+    field :segments, [Luggage], key: 'SEGMENT'
+  end
+end

data/lib/gillbus/structs/nearby_cities_trip.rb

@@ -0,0 +1,61 @@
+# результаты поиска по соседним городам, берется из кеша и содержит меньше данных, чем поездка из выдачи
+class Gillbus
+  class NearbyCitiesTrip
+    extend Fields
+    include UpdateAttrs
+
+    # => "Москва"
+    field :start_city_name
+
+    # => "A7CD147C07E7CD1BE040A8C0630328EC"
+    field :start_city_guid
+
+    # => "Europe/Moscow"
+    field :start_timezone
+
+    # => 20
+    field :distance_to_start
+
+    # => "Смоленск"
+    field :end_city_name
+
+    # => "DD253CDEE7D1555EE040B8596052093F"
+    field :end_city_guid
+
+    # => "Europe/Moscow"
+    field :end_timezone
+
+    # => 0
+    field :distance_to_end
+
+    # => "22:50"
+    field :start_time, :time # XXX
+
+    # => "08:00"
+    field :end_time, :time # XXX
+
+    # => ""Автофлот Автоколонна-1601" ООО"
+    field :carrier_name # XXX
+
+    # => "RU "Автофлот Автоколонна-1601" ООО"
+    field :carrier_legal_name # XXX
+
+    # => "390"
+    field :time_in_road
+
+    # => "1100"
+    field :total_cost, :money
+
+    # => "RUB"
+    field :currency
+
+    parser do
+      def money(val)
+        Monetize.parse(val, doc['CURRENCY'])
+      end
+    end
+
+    # to hold unserialized data
+    attr_accessor :data
+  end
+end

data/lib/gillbus/structs/point.rb

@@ -33,5 +33,7 @@ class Gillbus
     # Признак наличия пересадки в пункте
     # => "false"
     field :transfer_point, :bool
+
+    field :distance, :int
   end
 end

data/lib/gillbus/structs/return_cause.rb

@@ -14,7 +14,7 @@ class Gillbus
 
     parser do
       def money(val)
-        Monetize.parse(val, doc[:_currency])
+        Monetize.parse(val, parent.sale_cur_code)
       end
     end
   end

data/lib/gillbus/structs/seat.rb

@@ -24,6 +24,7 @@ class Gillbus
 
     field :x, :int
     field :y, :int
+    field :z, :int
 
     def free?
       type == 3 || type == 9

data/lib/gillbus/structs/segment.rb

@@ -67,6 +67,24 @@ class Gillbus
     # => "RU \"ПЕТРОКОМ - АВТО ПЛЮС\" ООО"
     field :carrier_name
 
+    # => "RU \"Еременчук Е.А.\" ИП"
+    field :carrier_legal_name
+
+    # => "260802027265"
+    field :carrier_inn
+
+    # => "г СНТ Лилия, Московская, Наро-фоминский"
+    field :carrier_address_fact
+
+    # => "г СНТ Лилия, Московская, Наро-фоминский"
+    field :carrier_address_leg
+
+    # => "316265100057314"
+    field :carrier_egrul_egis
+
+    # => "2514411332"
+    field :carrier_ogrn
+
     # => "09:10"
     field :time_in_road, :time
 
@@ -130,6 +148,15 @@ class Gillbus
     # => "1100"
     field :total_cost, :money
 
+    # => "1300"
+    field :original_amount, :money
+
+    # => "200"
+    field :discount_value, :money
+
+    # => "13.57"
+    field :discount_percentage
+
     # => "RUB"
     field :currency
 

data/lib/gillbus/structs/tariff/return_cause.rb

@@ -1,6 +1,8 @@
 class Gillbus
   class Tariff
     class ReturnCause
+      LOSSLESS = 'lossless'.freeze
+
       extend Fields
       include UpdateAttrs
 
@@ -10,10 +12,13 @@ class Gillbus
 
       # rubocop:disable Lint/UnusedMethodArgument
       def self.parse(doc, instance: nil, parent: nil, options: {})
-        instance = super
-        if doc.is_a? Hash
+        instance = new
+        if doc.is_a?(Array) && doc.size == 2 && doc.first.is_a?(Hash) && doc.last.is_a?(String)
+          instance.lossless = doc.first[LOSSLESS] == Parser::TRUE_CONST
+          instance.cause = doc.last
+        elsif doc.is_a?(Hash) && doc.has_key?('__content__')
+          instance.lossless = (doc['lossless'] == 'true')
           instance.cause = doc['__content__']
-          instance.lossless = doc['lossless'] == 'true'
         else
           instance.cause = doc
           instance.lossless = false

data/lib/gillbus/structs/ticket.rb

@@ -1,5 +1,17 @@
 class Gillbus
   class Ticket
+    STATUS_MAPPING = {
+      '0' => :voiding,         # ticket in processing, interim status during refund;
+      '1' => :reserved,        # ticket booked;
+      '2' => :ticketed,        # ticket sold;
+      '3' => :ordered,         # the booking, that waiting for the confirmation;
+      '4' => :returned,        # ticket returned;
+      '5' => :canceled,        # booking canceled;
+      '6' => :voided,          # ticket canceled;
+      '8' => :booked,          # the sale, that waiting for the confirmation;
+      'e' => :ticketing_error, # resource failed to process this ticket;
+    }.freeze
+
     extend Fields
     include UpdateAttrs
 
@@ -22,8 +34,8 @@ class Gillbus
     # :ticketed    2 – ticket sold;
     # :ordered     3 – the booking, that waiting for the confirmation;
     # :returned    4 – ticket returned;
-    # :canceled    5 – booking cancelled;
-    # :voided      6 – ticket cancelled;
+    # :canceled    5 – booking canceled;
+    # :voided      6 – ticket canceled;
     # :booked      8 – the sale, that waiting for the confirmation
     field :ticket_status, :ticket_status
 
@@ -256,7 +268,7 @@ class Gillbus
     # Array of commissions only for us (with additional fields)
     field :all_commissions, [Commission], key: 'COMMISSION', root: 'ALL_COMMISSIONS'
 
-    field :return_causes, [:return_cause], key: 'RETURN_CAUSE'
+    field :return_causes, [ReturnCause], key: 'RETURN_CAUSE'
 
     # Date to pay reserved ticket
     field :date_to_pay, :datetime
@@ -271,17 +283,22 @@ class Gillbus
 
     field :end_at, :datetime_combined, key: 'END'
 
+    field :is_online_refund, :bool
+
+    field :is_luggage, :bool, key: 'IS_BAGGAGE'
+
+    # => '3257025789'
+    field :supplier_inn
+
+    # => '"Клен 2" ООО'
+    field :supplier_name
+
+    # => "+79065002926"
+    field :supplier_phone
+
     parser do
       def ticket_status(value)
-        {
-          '1' => :reserved,     # ticket booked;
-          '2' => :ticketed,     # ticket sold;
-          '3' => :ordered,      # the booking, that waiting for the confirmation;
-          '4' => :returned,     # ticket returned;
-          '5' => :canceled,     # booking cancelled;
-          '6' => :voided,       # ticket cancelled;
-          '8' => :booked,       # the sale, that waiting for the confirmation
-        }[value]
+        ::Gillbus::Ticket::STATUS_MAPPING[value]
       end
 
       def money(val)

data/lib/gillbus/structs/tickets_option.rb

@@ -0,0 +1,29 @@
+class Gillbus
+  class TicketsOption
+    extend Fields
+    include UpdateAttrs
+
+    # идентификатор опции
+    field :id, :int, key: 'ID'
+
+    # текст опции
+    field :text, :string, key: :__content__
+
+    def self.parse(doc, instance: nil, parent: nil, options: {})
+      instance = new
+      if doc.is_a?(String)
+        instance.text = doc
+      elsif doc.is_a?(Array)
+        raise ArgumentError, "Unable to parse TicketsOption: #{doc.inspect}" unless doc.size == 2
+        instance.id = doc.first.fetch('ID').to_i
+        instance.text = doc.last
+      elsif doc.is_a?(Hash) #legacy data made with MultiXML
+        instance.id = doc.fetch('ID')
+        instance.text = doc.fetch('__content__')
+      else
+        raise ArgumentError, "Unable to parse TicketsOption: #{doc.inspect}"
+      end
+      instance
+    end
+  end
+end