gillbus-v2 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e492282b609d3c3b20ad09f90a14def0027ace86577f4fc5f38152f7aef7646e
-  data.tar.gz: 4a0ab148b572b5dbb982a73d6462371070a1fec9ca8e9d83d4446bd599e338c3
+  metadata.gz: 43f5f66f49c4de6dce6487cd0cf702d49073ca1a870d1097599d5caaeef798c9
+  data.tar.gz: b413b3fb9ad9e346742bbf2566ffd6b81a2cc9f4e189b60a03d4f106eb954739
 SHA512:
-  metadata.gz: c59e9c4d3f612f2e5f01d865fabc123a20ca0d6ec7d0f77eaee5c57a6ee08efd42fbb5f7a123d6a7657600d3c54b920295d4f29a13130ebb22b2029b11685944
-  data.tar.gz: f646e149e2dda7b7f82dc0e9cf7f886aeefdc69c2e2133302ead3fa50bd01fc381dff176a6d0082353edfa22be53b509983693dd4457fc177112490ad014c9b1
+  metadata.gz: 1aad4fa134e4e69d6d3e52d9d725768c80e5abeab5055347043ad2eeb488b9506fca7d8b6da7e3b891b1d1398a9e1f098e946804ef0699b2901d8e903e8181b8
+  data.tar.gz: 18c6a257567c09351c22698c97c7376e3b4a9a5d142eeb9caa6c1547de9438f6dc502582048803f5e4cf1234c8d1cb747318ac113d74f3b19549f9193cace3da

data/README.md

@@ -150,6 +150,44 @@ Each location contains fields:
 - `modified_at` - last modification time
 - `deleted` - if true then location has been removed
 
+### Search trips
+
+Search of trips works in the same way as `get_locations`:
+
+- `search_trips` for first page
+- `search_trips_page` for other
+
+```ruby
+response = client.search_trips(
+  from_id: 111,
+  to_id: 222,
+  date: Date.today + 1,
+  back_date: Date.today + 5,
+  passengers_count: 1,
+  limit_for_page: 20,
+)
+response.trips
+
+while response.pagination.next_page
+  response = client.search_trips_page(
+    pagination_uuid: response.pagination.uuid,
+    page_number: response.pagination.next_page,
+  )
+  response.trips
+end
+```
+
+Every response contains trips and dictionaries for them:
+
+```ruby
+response.trips
+
+# dictionaries
+response.carriers
+response.vehicles
+response.points
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/gillbus-v2.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday'
+  spec.add_dependency "faraday"
+  spec.add_dependency "money"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/gillbus/v2/client.rb

@@ -62,6 +62,34 @@ module Gillbus::V2
       )
     end
 
+    # search_mode:
+    # - full - искать все рейсы (по умолчанию)
+    # - direct - искать только прямые рейсы
+    def search_trips(from_id:, to_id:, date:, back_date: nil, passengers_count: 1, search_mode: "full", limit_for_page: 20)
+      params = {
+        from_id: from_id,
+        to_id: to_id,
+        date: date.iso8601,
+        back_date: back_date&.iso8601,
+        pass_count: passengers_count,
+        search_mode: search_mode,
+        limit: limit_for_page,
+      }
+      call_api(:get, "/search/v2/trips", params,
+        response_class: Responses::SearchTrips,
+      )
+    end
+
+    def search_trips_page(pagination_uuid:, page_number:)
+      params = {
+        page_uuid: pagination_uuid,
+        number_page: page_number,
+      }
+      call_api(:get, "/search/v2/trips/page", params,
+        response_class: Responses::SearchTrips,
+      )
+    end
+
     private
 
     def call_api(http_method, url, params, auth_required: true, response_class: Responses::Base)

data/lib/gillbus/v2/parser.rb

@@ -9,7 +9,17 @@ module Gillbus::V2
           next
         end
 
-        raw_value = raw_data[field[:from]]
+        raw_value =
+          if field[:from].is_a?(Hash)
+            field[:from].map { |key, value| [key, raw_data[value]] }.to_h
+          else
+            raw_data[field[:from]]
+          end
+
+        if field[:enrich_with]
+          raw_value = enrich_data(raw_value, raw_data, field[:enrich_with])
+        end
+
         result[field[:name]] =
           if raw_value.nil?
             field[:default]
@@ -22,6 +32,23 @@ module Gillbus::V2
 
     private
 
+    def enrich_data(data, from_data, attrs_list)
+      enrich_with_data =
+        attrs_list.each_with_object({}) do |attr_name, result|
+          result[attr_name] = from_data[attr_name]
+        end
+
+      if data.is_a?(Hash)
+        data.merge(enrich_with_data)
+      elsif data.is_a?(Array) && data.all? { |item| item.is_a?(Hash) }
+        data.map do |item|
+          item.merge(enrich_with_data)
+        end
+      else
+        data
+      end
+    end
+
     def coerce_value(value, type)
       case type
       when :boolean
@@ -32,15 +59,42 @@ module Gillbus::V2
         value.to_i
       when :float
         value.to_f
-      when :date_time
+      when :date
+        Date.parse(value)
+      when :date_time_hh_mm
+        DateTime.strptime(value, '%Y-%m-%d %H:%M')
+      when :date_time_rfc3339
         DateTime.rfc3339(value)
-      when :date_time_from_timestamp
+      when :date_time_timestamp
         DateTime.strptime(value.to_s, "%s")
+      when :time_interval_from_minutes
+        value.to_i * 60
       when :translations_hash
         value.to_h
-      else
-        raise "Type #{type} not supported"
+      when Array
+        inner_type = type.first
+        if value.is_a?(Array)
+          value.map { |item| coerce_value(item, inner_type) }
+        else
+          raise "Invalid value for #{type}: #{value.class}"
+        end
+      when Structs::Base::Enum
+        type.include?(value) ? value : nil
+      when Class
+        if type < Structs::Base
+          type.from_raw_data(value)
+        elsif type <= Money
+          if value[:amount] && value[:currency]
+            Money.from_amount(value[:amount], value[:currency])
+          end
+        else
+          raise "Type #{type} not supported"
+        end
       end
+    rescue StandardError
+      # Временно игнорируем все ошибки в данных.
+      # TODO: подумать над валидацией объектов.
+      nil
     end
 
     def fetch_from_translations(translations, field_name)

data/lib/gillbus/v2/responses/authenticate.rb

@@ -6,9 +6,11 @@ module Gillbus::V2
       end
 
       def access_token
-        if json_body["access_token"]
-          Structs::AccessToken.from_raw_data(json_body)
-        end
+        return @access_token if defined?(@access_token)
+        @access_token =
+          if json_body["access_token"]
+            Structs::AccessToken.from_raw_data(json_body)
+          end
       end
     end
   end

data/lib/gillbus/v2/responses/search_trips.rb

@@ -0,0 +1,47 @@
+module Gillbus::V2
+  module Responses
+    class SearchTrips < Responses::Base
+      def trips
+        @trips ||= (json_body["trips"] || []).map do |item|
+          trip_data = item.dup
+          trip_data["direct_trip"].map! { |id| segment_data(id) }
+          trip_data["back_trip"].map! { |id| segment_data(id) }
+          Structs::Trip.from_raw_data(trip_data)
+        end
+      end
+
+      def carriers
+        @carriers ||= (json_body["carriers"] || []).map do |item|
+          Structs::Carrier.from_raw_data(item)
+        end
+      end
+
+      def vehicles
+        @vehicles ||= (json_body["vehicles"] || []).map do |item|
+          Structs::Vehicle.from_raw_data(item)
+        end
+      end
+
+      def points
+        @points ||= (json_body["points"] || []).map do |item|
+          Structs::Point.from_raw_data(item)
+        end
+      end
+
+      def pagination
+        @pagination ||=
+          if json_body["pages_info"]
+            Structs::Pagination.from_raw_data(json_body["pages_info"])
+          end
+      end
+
+      private
+
+      def segment_data(segment_id)
+        @segments_data_by_ids ||=
+          (json_body["segments"] || []).group_by { |item| item["id"] }
+        @segments_data_by_ids[segment_id]&.first
+      end
+    end
+  end
+end

data/lib/gillbus/v2/structs/access_token.rb

@@ -3,7 +3,7 @@ module Gillbus::V2
     field :access_token, :string
     field :token_type, :string, default: "Bearer"
     field :expires_in, :integer
-    field :expires_on, :date_time_from_timestamp
+    field :expires_on, :date_time_timestamp
 
     def self.from_token_string(token)
       raw_data = { "access_token" => token }

data/lib/gillbus/v2/structs/base.rb

@@ -3,6 +3,13 @@ module Gillbus::V2
     class Base
       attr_reader :raw_data
 
+      # field :my_field, Enum.("val1", "val2")
+      class Enum < Set
+        def self.call(*elements)
+          new(elements)
+        end
+      end
+
       def initialize(raw_data:, **fields)
         @raw_data = raw_data
         fields.each do |field_name, field_value|
@@ -10,14 +17,15 @@ module Gillbus::V2
         end
       end
 
-      def self.field(name, type, from: name, default: nil)
+      def self.field(name, type, from: name.to_s, default: nil, enrich_with: nil)
         attr_reader name
         @fields_settings ||= []
         @fields_settings << {
           name: name,
           type: type,
-          from: from.to_s,
+          from: from,
           default: default,
+          enrich_with: enrich_with,
         }
       end
 

data/lib/gillbus/v2/structs/carrier.rb

@@ -0,0 +1,8 @@
+module Gillbus::V2
+  class Structs::Carrier < Structs::Base
+    field :id, :string
+    field :name, :string
+    field :trade_mark, :string
+    field :logo, :string
+  end
+end

data/lib/gillbus/v2/structs/location.rb

@@ -6,7 +6,7 @@ module Gillbus::V2
     field :type_id, :integer
     field :sub_type_id, :integer, from: "subtype_id"
 
-    field :modified_at, :date_time, from: "date_modified"
+    field :modified_at, :date_time_rfc3339, from: "date_modified"
     field :deleted, :boolean
 
     field :latitude, :float

data/lib/gillbus/v2/structs/point.rb

@@ -0,0 +1,9 @@
+module Gillbus::V2
+  class Structs::Point < Structs::Base
+    field :id, :string
+    field :parent_id, :string
+
+    field :name, :string
+    field :address, :string
+  end
+end

data/lib/gillbus/v2/structs/refund_conditions.rb

@@ -0,0 +1,12 @@
+module Gillbus::V2
+  class Structs::RefundConditions < Structs::Base
+    field :time_from, :time_interval_from_minutes
+    field :time_till, :time_interval_from_minutes
+
+    field :return_percent, :float
+    field :return_amount, Money,
+      from: { amount: "return_amount", currency: "currency" }
+
+    field :description, :string, from: "condition_description"
+  end
+end

data/lib/gillbus/v2/structs/route_point.rb

@@ -0,0 +1,16 @@
+module Gillbus::V2
+  class Structs::RoutePoint < Structs::Base
+    field :point_id, :string
+    field :vehicle_id, :string
+
+    field :departure_platform, :string, from: "platform"
+
+    field :departure_date_time, :date_time_hh_mm, from: "departureDateTime"
+    field :arrival_date_time, :date_time_hh_mm, from: "arrivalDateTime"
+
+    field :check_point, :boolean
+    field :transfer_point, :boolean, from: "is_hub"
+
+    field :distance_from_start, :integer, from: "distance"
+  end
+end

data/lib/gillbus/v2/structs/seat.rb

@@ -0,0 +1,26 @@
+module Gillbus::V2
+  # TODO: use in seatmap response or remove
+  class Structs::Seat < Structs::Base
+    field :id, :string
+    field :number, :string
+
+    field :floor, :integer
+    field :col, :integer
+    field :row, :integer
+
+    field :seat_class, :string, from: "class"
+
+    field :status, Enum.(
+      "EMPTY",
+      "ORDERED",
+      "BLOCKED",
+      "FREE",
+      "BOOKED",
+      "SALED",
+      "SPESIAL",
+      "REGISTERED",
+      "TECHNICAL",
+      "PRIORITY",
+    )
+  end
+end

data/lib/gillbus/v2/structs/segment.rb

@@ -0,0 +1,48 @@
+module Gillbus::V2
+  class Structs::Segment < Structs::Base
+    field :id, :string
+    field :carrier_id, :string
+    field :vehicle_id, :string
+    field :resource_id, :string
+
+    field :price, Structs::SegmentPrice
+
+    field :travel_time, :string
+
+    field :trip_number, :string, from: "number"
+    field :trip_name, :string, from: "name"
+    field :trip_type, Enum.("international", "internal")
+
+    field :departure_point_id, :string
+    field :arrival_point_id, :string
+
+    field :departure_date_time, :date_time_hh_mm, from: "departureDateTime"
+    field :arrival_date_time, :date_time_hh_mm, from: "arrivalDateTime"
+
+    field :departure_platform, :string, from: "platform"
+
+    field :reservation_enabled, :boolean, from: "reservation_enable"
+    field :reservation_lifetime, :time_interval_from_minutes
+
+    # время до отправления рейса, после которого запрещено бронирование
+    field :stop_reservation_time, :time_interval_from_minutes
+
+    # наличие пересадки (смены автобуса)
+    field :has_transfer, :boolean, from: "has_hub"
+
+    # стоимость может измениться при продаже в случае автоматического применения льготных тарифов
+    field :can_discount, :boolean
+
+    # возможность добровольного возврата
+    field :voluntary_return_enabled, :boolean, from: "return_enable"
+
+    # Если sale_enabled == false, то необходим редирект на redirect_url
+    # (на этот рейс возможна продажа только на сайте владельца)
+    field :sale_enabled, :boolean, from: "sale_enable"
+    field :redirect_url, :string
+
+    field :options, Structs::SegmentOptions
+
+    field :route, [Structs::RoutePoint]
+  end
+end

data/lib/gillbus/v2/structs/segment_options.rb

@@ -0,0 +1,6 @@
+module Gillbus::V2
+  class Structs::SegmentOptions < Structs::Base
+    field :luggage_conditions, [:string]
+    field :special_conditions, [:string]
+  end
+end

data/lib/gillbus/v2/structs/segment_price.rb

@@ -0,0 +1,8 @@
+module Gillbus::V2
+  class Structs::SegmentPrice < Structs::Base
+    field :total, Money, from: { amount: "total", currency: "currency" }
+    field :netto, Money, from: { amount: "netto", currency: "currency" }
+
+    field :tariffs, [Structs::SegmentTariff], enrich_with: %w[currency]
+  end
+end

data/lib/gillbus/v2/structs/segment_tariff.rb

@@ -0,0 +1,20 @@
+module Gillbus::V2
+  class Structs::SegmentTariff < Structs::Base
+    field :id, :string
+    field :code, :string
+
+    field :cost, Money, from: { amount: "cost", currency: "currency" }
+
+    field :seat_class, :string, from: "class"
+
+    field :start_date, :date
+    field :end_date, :date
+
+    field :name, :string
+    field :description, :string, from: "description_tariff"
+    field :notes, :string, from: "note"
+
+    field :refund_conditions, [Structs::RefundConditions],
+      enrich_with: %w[currency]
+  end
+end

data/lib/gillbus/v2/structs/trip.rb

@@ -0,0 +1,7 @@
+module Gillbus::V2
+  class Structs::Trip < Structs::Base
+    field :id, :integer, from: "trip_id"
+    field :direct_segments, [Structs::Segment], from: "direct_trip"
+    field :back_segments, [Structs::Segment], from: "back_trip"
+  end
+end

data/lib/gillbus/v2/structs/vehicle.rb

@@ -0,0 +1,16 @@
+module Gillbus::V2
+  class Structs::Vehicle < Structs::Base
+    field :id, :string
+
+    field :model, :string
+    field :number, :string
+
+    field :capacity, :integer
+
+    field :vehicle_type, :string
+    field :vehicle_class, :string
+
+    field :picture_url, :string
+    field :tumbnail_url, :string
+  end
+end

data/lib/gillbus/v2/version.rb

@@ -1,5 +1,5 @@
 module Gillbus
   module V2
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/lib/gillbus/v2.rb

@@ -2,6 +2,7 @@ require "date"
 require "json"
 
 require "faraday"
+require "money"
 
 require "gillbus/v2/version"
 require "gillbus/v2/errors"
@@ -15,7 +16,18 @@ require "gillbus/v2/structs/location"
 require "gillbus/v2/structs/location_type"
 require "gillbus/v2/structs/location_sub_type"
 require "gillbus/v2/structs/location_additional_field"
+require "gillbus/v2/structs/refund_conditions"
+require "gillbus/v2/structs/segment_tariff"
+require "gillbus/v2/structs/segment_price"
+require "gillbus/v2/structs/segment_options"
+require "gillbus/v2/structs/route_point"
+require "gillbus/v2/structs/segment"
+require "gillbus/v2/structs/trip"
+require "gillbus/v2/structs/carrier"
+require "gillbus/v2/structs/vehicle"
+require "gillbus/v2/structs/point"
 
 require "gillbus/v2/responses/base"
 require "gillbus/v2/responses/authenticate"
 require "gillbus/v2/responses/locations"
+require "gillbus/v2/responses/search_trips"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gillbus-v2
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Roman Khrebtov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,13 +146,25 @@ files:
 - lib/gillbus/v2/responses/authenticate.rb
 - lib/gillbus/v2/responses/base.rb
 - lib/gillbus/v2/responses/locations.rb
+- lib/gillbus/v2/responses/search_trips.rb
 - lib/gillbus/v2/structs/access_token.rb
 - lib/gillbus/v2/structs/base.rb
+- lib/gillbus/v2/structs/carrier.rb
 - lib/gillbus/v2/structs/location.rb
 - lib/gillbus/v2/structs/location_additional_field.rb
 - lib/gillbus/v2/structs/location_sub_type.rb
 - lib/gillbus/v2/structs/location_type.rb
 - lib/gillbus/v2/structs/pagination.rb
+- lib/gillbus/v2/structs/point.rb
+- lib/gillbus/v2/structs/refund_conditions.rb
+- lib/gillbus/v2/structs/route_point.rb
+- lib/gillbus/v2/structs/seat.rb
+- lib/gillbus/v2/structs/segment.rb
+- lib/gillbus/v2/structs/segment_options.rb
+- lib/gillbus/v2/structs/segment_price.rb
+- lib/gillbus/v2/structs/segment_tariff.rb
+- lib/gillbus/v2/structs/trip.rb
+- lib/gillbus/v2/structs/vehicle.rb
 - lib/gillbus/v2/version.rb
 homepage: https://github.com/busfor/gillbus-v2-ruby
 licenses: