gillbus 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abd154225fa9cf95e090acd4e225b7793933afe3
+  data.tar.gz: df33244cd12c9948e297301164d27ab7a8c6eb50
+SHA512:
+  metadata.gz: 2faa23383a71fe67e11161f9a60b758a8c1020fcf64e0f046c1b2a882eac85ee306d3d46ef72126268a54c79264a621a4a2071bde00119cf07f638ad4fea0e0c
+  data.tar.gz: 0b8b35d7b404a02e9ee6ebcdcf9dbc4c97383c07f3b05cbef6ef5ddfd3fc572d2f3ca53aa2ad626d416cda1347144ac647678fdcbb95d3e91fb829c79b879121

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.2.4

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gillbus.gemspec
+gemspec
+
+group :development do
+  gem 'guard', github: 'guard/guard'
+  gem 'guard-minitest', github: 'guard/guard-minitest'
+  gem 'ox'
+end

data/Guardfile

@@ -0,0 +1,29 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) BUSFOR LLC (2014-2016)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# Gillbus
+
+Gillbus IDS "online2" API wrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gillbus'
+
+## Public API
+
+We're trying hard not to raise exceptions.
+Each call to Gillbus instance returns response object, which responds to #error?
+if #error? is true, you can use #error_message and #error_code
+for exact details
+
+## Workflow
+
+* login (sessionLogin/online)
+* /online2/getCountries
+* /online2/getCities
+* /online2/searchTrips
+* /online2/getTrips
+* /online2/getTripSeats
+* /online2/lockSeats
+* /online2/ticketsBooking
+* /online2/buyTickets
+* /online2/getOrderTicket
+* /online2/logout
+
+## Quoting API documentation
+
+* Entering the system
+  /online2/login/online/
+  User authorization
+  skipped as obsolete
+
+* Entering the system (second way)
+  online2/sessionLogin/online/
+  User authorization
+
+* Get trips’ schedule
+  /online2/getTimeTable
+  Returns trips schedule
+
+* Get country list
+  /online2/getCountries
+  Returns available countries’ list
+
+* Get available  localities’ list
+  /online2/getCities
+  Returns available localities’ list
+
+* Get available departure dates’ list
+  /online2/getDates
+  Returns available departure dates’ list
+
+* Get parameterized trips’ list
+  /online2/searchTrips
+  Returns parameterized trips’ list
+
+* Get trips’ list
+  /online2/getTrips
+  Returns trips’ list
+
+* Get seats' map
+  /online2/getTripSeats
+  Returns seats' map of the vehicle
+
+* Locks seats for sale
+  /online2/lockSeats
+  Locks seats for sale
+
+* Unlocks seats for sale
+  /online2/unlockSeats
+  Unlocks seats for sale
+
+* Postponed (unconfirmed) tickets sale
+  /online2/bookTickets
+  Performs the postponed tickets sale, that waits for the confirmation
+
+* Postponed tickets sale (second way)
+  /online2/ticketsBooking
+  Performs the postponed tickets sale, that waits for the confirmation
+
+* Sale confirmation
+  /online2/buyTickets
+  Confirms the earlier postponed tickets sale
+
+* Get the ticket of the order
+  /online2/getOrderTicket
+  Generates the ticket of the order
+
+* Reserve the ticket
+  /online2/reserveTickets
+  Makes the ticket reservation
+
+* Reserved tickets’ search
+  /online2/findBooking
+  Performs parameterized reserved tickets' search
+
+* "Reserved tickets’ search (second way)"
+  /online2/findReservation
+  Performs parameterized reserved tickets' search
+
+* Buyout the reserved ticket
+  /online2/buyBooking
+  Buyout the earlier reserved ticket
+
+* #cancel_order Order cancellation
+  /online2/cancelOrder
+  Cancels the order
+
+
+* Returns the item, that had been sold
+  /online2/returnPosition
+  Returns the item, that had been previously sold
+
+* Orders’ search
+  /online2/findOrder
+  Returns found order's data
+
+* Logout
+  /online2/logout
+  Closes current session
+
+* Reporting
+  /online2/getReport
+  Outputs the reports in the Microsoft Excel format
+
+* Get the trips’ list for the date changing
+  /online2/getTripsForChange
+  Returns the list of trips that are like the assigned trip which has booked ticket, but for the different date.
+
+* Departure date change
+  /online2/changeTripDate
+  Changes the departure date for the passenger
+
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+
+task :default => :test

data/gillbus.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gillbus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gillbus"
+  spec.version       = Gillbus::VERSION
+  spec.authors       = [%q{Alexey "codesnik" Trofimenko}, %q{Kirill Platonov}]
+  spec.email         = ["aronaxis@gmail.com", "mail@kirillplatonov.com"]
+  spec.summary       = %q{Driver for Gillbus IDS API}
+  # spec.description   = %q{gillbus.com}
+  spec.homepage      = "http://gillbus.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'multi_xml'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'money'
+  spec.add_dependency 'monetize'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+end

data/lib/gillbus/base_request.rb

@@ -0,0 +1,99 @@
+require 'date'
+
+class Gillbus
+  class BaseRequest
+
+    def initialize(attrs={})
+      attrs.each do |k, v|
+        send "#{k}=", v
+      end
+    end
+
+    def path
+      raise NotImplementedError, 'you need to define "path" method'
+    end
+
+    def params
+      {}
+    end
+
+    private
+
+    def list(items)
+      return if items.nil?
+      Array(items).join(";")
+    end
+
+    def date(date)
+      return if date.nil?
+      date.strftime("%d.%m.%Y")
+    end
+
+    def bool(bool)
+      return if bool.nil?
+      bool ? "1" : "0"
+    end
+
+    def translated_locale(locale)
+      return if locale.nil?
+      {
+        "ru" => "rus",
+        "en" => "lat",
+        "uk" => "ukr",
+        "th" => "tai",
+        "pl" => "pol",
+        
+        # temporary, until changed in busfor
+        "ua" => "ukr",
+      }[ locale.to_s ] || locale.to_s
+    end
+
+    MODES = {
+      # 0 – искать все виды транспорта;
+      all: 0,
+      # 1 – искать автобусные рейсы;
+      bus: 1,
+      # 2 - искать такси (только searchTransfersTrips?)
+      taxi: 2,
+      # 3 – искать авиационные рейсы;
+      avia: 3,
+      # 4 – искать авиационные чартерные рейсы;
+      charter: 4,
+      # 6 – рейсы водного транспорта;
+      boat: 6,
+      # 31 – искать авиационные рейсы эконом-класса;
+      avia_economy: 31,
+      # 32 – искать авиационные рейсы бизнес-класса;
+      avia_business: 32,
+      # 51 – искать железнодорожные рейсы;
+      train: 51,
+      # 8 – искать рейсы с пересадками;
+      connections: 8,
+      # 9 – искать рейсы только с пересадками.
+      connections_only: 9,
+      # 13 - автобусно-лодочный микс
+      bus_boat: 13,
+    }
+
+    def modes(items)
+      list(
+        Array(items).map { |item|
+          if item.is_a? Symbol
+            MODES[item] or
+              fail ArgumentError, "unknown search mode #{item.inspect}", caller
+          else
+            item
+          end
+        }
+      )
+    end
+
+    def compact(hash)
+      hash.each do |k,v|
+        hash.delete k if v.nil?
+      end
+      hash
+    end
+
+  end
+end

data/lib/gillbus/base_response.rb

@@ -0,0 +1,43 @@
+require 'multi_xml'
+
+class Gillbus
+  class BaseResponse
+
+    extend Fields
+    include UpdateAttrs
+
+    attr_accessor :data
+    attr_accessor :session_id
+
+    attr_accessor :error_code
+    attr_accessor :error_message
+
+    def error?
+      ! error_code.nil?
+    end
+
+    def self.parse(data, instance=new)
+      # ugly
+      if data["MESSAGE"]
+        instance.error_code = data["MESSAGE"]["CODE"].to_i
+        instance.error_message = data["MESSAGE"]["TEXT"]
+      else
+        super(data, instance)
+      end
+      # for debugging?
+      instance.data = data
+      instance
+    end
+
+    def self.parse_string(xml_string)
+      xml = MultiXml.parse(xml_string)
+      # <DATA/> is a valid response
+      xml.key?("DATA") or return ParseError.new(xml_string)
+      data = xml["DATA"] || {}
+      parse(data)
+    rescue MultiXml::ParseError
+      ParseError.new(xml_string)
+    end
+
+  end
+end

data/lib/gillbus/buy_booking.rb

@@ -0,0 +1,74 @@
+class Gillbus
+  module BuyBooking
+
+    Gillbus.register self, :buy_booking
+
+    class Request < BaseRequest
+
+      def path; '/online2/buyBooking' end
+
+      # paymentMethod (не обязательный)
+      # Способ оплаты заказа.
+      attr_accessor :payment_method
+
+      # 1 – наличный;
+      METHOD_CASH = 1
+      # 2 – кредитной карточкой;
+      METHOD_CARD = 2
+      # 3 – безналичный;
+      METHOD_NOCASH = 3
+      # 4 – сервисный;
+      METHOD_SERVICE = 4
+      # 5 – эквайринг.
+      METHOD_ACQUIRING = 5
+      # По умолчанию 3.
+
+      # ticketCount
+      # Кол-во выкупаемых билетов. 1..k
+      attr_accessor :ticket_count
+
+      # Номера билетов с порядковым номером
+      attr_accessor :ticket_numbers
+
+      attr_accessor :order_ids
+
+      def params
+        numbers = ticket_numbers.map.with_index do |num, i|
+          [:"ticketNumber#{i}", num]
+        end.to_h
+
+        orders = order_ids.map.with_index do |val, i|
+          [:"orderId#{i}", val]
+        end.to_h
+
+        compact(
+          paymentMethod: payment_method,
+          ticketCount: ticket_count,
+          **numbers,
+          **orders
+        )
+      end
+
+    end
+
+    class Response < BaseResponse
+
+      class TicketConfirmation
+
+        extend Fields
+
+        field :number, :int
+        # String. пока не выяснится, в какой таймзоне это значение и зачем
+        field :date
+        field :order_id
+        field :confirmation, :yesno_bool
+        field :position_numbers, [:int], key: 'POSITION_NUMBER'
+
+      end
+
+      field :ticket, TicketConfirmation
+
+    end
+
+  end
+end

data/lib/gillbus/buy_tickets.rb

@@ -0,0 +1,36 @@
+class Gillbus
+  module BuyTickets
+
+    Gillbus.register self, :buy_tickets
+
+    class Request < BaseRequest
+
+      def path; '/online2/buyTickets' end
+
+      # orderId
+      # Уникальный ИД заказа, переданный при отложенной продаже.
+      attr_accessor :order_id
+
+      def params
+        {orderId: order_id}
+      end
+    end
+
+    class Response < BaseResponse
+
+      class TicketConfirmation
+
+        extend Fields
+        # String. пока не выяснится, в какой таймзоне это значение и зачем
+        field :date
+        field :order_id
+        field :confirmation, :yesno_bool
+
+      end
+
+      field :ticket, TicketConfirmation
+
+    end
+
+  end
+end

data/lib/gillbus/cancel_order.rb

@@ -0,0 +1,55 @@
+class Gillbus
+  module CancelOrder
+
+    Gillbus.register self, :cancel_order
+
+    class Request < BaseRequest
+
+      def path; '/online2/cancelOrder' end
+
+      # orderNumber
+      # The order number
+      attr_accessor :order_number
+
+      # cancelReason
+      # Cancellation reason
+      attr_accessor :cancel_reason
+
+      def params
+        compact(
+          orderNumber: order_number,
+          cancelReason: cancel_reason,
+        )
+      end
+
+    end
+
+
+    class Response < BaseResponse
+
+      class OrderCancel
+
+        extend Fields
+
+        # The order number
+        field :number
+
+        # The cancellation reason
+        field :reason
+
+        # The flag, which indicates successful order cancellation.
+        field :confirmation, :yesno_bool
+
+        # The request’s performing date
+        # String. FIXME (Kiiv timezone?)
+        field :date
+
+      end
+
+      field :order_cancel, OrderCancel
+
+    end
+
+  end
+
+end

data/lib/gillbus/drivers/faraday_response_file_logger.rb

@@ -0,0 +1,19 @@
+class Gillbus
+  class FaradayResponseFileLogger < Faraday::Middleware
+
+    def initialize(app, dir = '.')
+      @dir = dir
+      super(app)
+    end
+
+    def call(env)
+      path = env.url.path
+      @app.call(env).on_complete do |environment|
+        sanitized_path = path.gsub(/[^A-Za-z0-9_-]+/, '_').gsub(/^_|_$/, '')
+        sanitized_path = '_' if sanitized_path == ''
+        File.write(@dir + '/' + sanitized_path, env.body) if env.body != ''
+      end
+    end
+
+  end
+end

data/lib/gillbus/find_order.rb

@@ -0,0 +1,37 @@
+class Gillbus
+  module FindOrder
+
+    Gillbus.register self, :find_order
+
+    class Request < BaseRequest
+
+      def path; '/online2/findOrder' end
+
+      # orderId
+      # Уникальный ИД заказа, переданный при отложенной продаже.
+      attr_accessor :order_id
+
+      # orderNumber
+      # Номер заказа полученный при создании отложенной продажи.
+      attr_accessor :order_number
+
+      # Язык формирования данных.
+      attr_accessor :locale
+
+      def params
+        compact(
+          orderId: order_id,
+          orderNumber: order_number,
+          locale: translated_locale(locale),
+        )
+      end
+
+    end
+
+    class Response < BaseResponse
+      field :tickets, [Ticket], key: 'TICKET'
+    end
+
+  end
+
+end

data/lib/gillbus/get_all_cities.rb

@@ -0,0 +1,24 @@
+class Gillbus
+  module GetAllCities
+
+    Gillbus.register self, :get_all_cities
+
+    class Request < BaseRequest
+      def path; '/online2/getAllCities' end
+    end
+
+    class City
+      extend Fields
+      include UpdateAttrs
+      field :id
+      field :name
+      field :country_id
+      field :country_name
+    end
+
+    class Response < BaseResponse
+      field :cities, [City], key: 'CITY'
+    end
+
+  end
+end