quicktravel_client 1.0.2

data/lib/quick_travel/property_facility.rb

@@ -0,0 +1,7 @@
+require 'quick_travel/adapter'
+
+module QuickTravel
+  class PropertyFacility < Adapter
+    attr_accessor :id, :property_id, :category_id, :created_at, :name, :position, :property_facility_id, :updated_at
+  end
+end

data/lib/quick_travel/property_type.rb

@@ -0,0 +1,20 @@
+require 'quick_travel/adapter'
+require 'quick_travel/cache'
+
+module QuickTravel
+  class PropertyType < Adapter
+    include Cache
+
+    attr_accessor :id, :name, :position
+
+    def self.first(_id = nil)
+      generic_first('/property_types.json')
+    end
+
+    def self.all
+      QuickTravel::Cache.cache 'all_property_types' do
+        self.find_all!('/property_types.json')
+      end
+    end
+  end
+end

data/lib/quick_travel/region.rb

@@ -0,0 +1,21 @@
+require 'quick_travel/adapter'
+require 'quick_travel/cache'
+
+module QuickTravel
+  class Region < Adapter
+    include Cache
+
+    attr_accessor :id, :name, :location_ids
+
+    self.api_base = '/regions'
+    self.lookup = true
+
+    def self.first
+      generic_first '/regions.json'
+    end
+
+    def locations
+      Location.all.select { |l| location_ids.include?(l.id) }
+    end
+  end
+end

data/lib/quick_travel/reservation.rb

@@ -0,0 +1,110 @@
+require 'quick_travel/adapter'
+require 'quick_travel/adjustment'
+require 'quick_travel/resource'
+
+module QuickTravel
+  class Reservation < Adapter
+    attr_accessor :id, :booking_id,
+                  :gross_in_cents, :commission_in_cents, :cost_in_cents, :pre_adjusted_gross_in_cents,
+                  :pre_adjusted_gross_including_packaged_item_in_cents, :gross_including_packaged_item_in_cents, :price_rules,
+                  :first_travel_date, :last_travel_date, :checkout_date, :created_at, :start_time, :end_time,
+                  :resource_id, :resource_class_name, :product_type_id, :product_type_name,
+                  :bed_configuration_id, :inventory_type, :quantity,
+                  :comment, :selection_name,
+                  :service_ids,
+                  :vehicle_splits, :passenger_splits,
+                  :adjustments_attributes,
+                  :inverse_reservation_id,
+                  :from_route_stop_attributes, :to_route_stop_attributes,
+                  :route_id, :trip_id, :route_path, :pick_up_information, :drop_off_information,
+                  :complete, :enough_time_before_travel_to_edit
+
+    money :gross, :commission, :cost, :pre_adjusted_gross, :gross_including_packaged_item, :pre_adjusted_gross_including_packaged_item
+
+    def self.create(options)
+      json = post_and_validate('/api/reservations.json', options, expect: :json)
+      new(json)
+    end
+
+    def self.destroy(id)
+      delete_and_validate("/api/reservations/#{id}.json")
+    end
+
+    def adjustments
+      @adjustments_attributes.map { |adjustment| Adjustment.new(adjustment) }
+    end
+
+    def resource
+      @resource ||= QuickTravel::Resource.find(resource_id) if resource_id
+    end
+
+    def start_date_time
+      start_time.to_time.on(first_travel_date) if start_time
+    end
+
+    def end_date_time
+      end_time.to_time.on(last_travel_date) if end_time
+    end
+
+    def to_route_stop
+      QuickTravel::RouteStop.new(@to_route_stop_attributes) if @to_route_stop_attributes
+    end
+
+    def from_route_stop
+      QuickTravel::RouteStop.new(@from_route_stop_attributes) if @from_route_stop_attributes
+    end
+
+    # it send API request for Resource show. and cache the data.
+    # i think now this method is not required because now booking show api call have display_text for every reservation
+    def details
+      if @_resource.blank?
+        @_resource = Resource.find(@resource_id) unless @resource_id.blank?
+      end
+      @_resource
+    end
+
+    def sub_reservations
+      @sub_reservations ||= Array(@sub_reservations_attributes).map do |attributes|
+        Reservation.new(attributes)
+      end
+    end
+
+    def passengers_count_string(booking)
+      passengers_count(booking).join(', ')
+    end
+
+    def passengers_count(booking)
+      passenger_type_count = {}
+      if passenger_splits.present?
+        passenger_splits.each do |p|
+          passenger = booking.find_passenger_by_id(p['consumer_id'])
+
+          if passenger.present?
+            passenger_type_count[passenger.passenger_type_id] ||= 0
+            passenger_type_count[passenger.passenger_type_id] += 1
+          end
+        end
+      end
+      PassengerType.passenger_counts(passenger_type_count)
+    end
+
+    def vehicle_count_string(booking)
+      vehicles_count(booking).to_sentence
+    end
+
+    def vehicles_count(booking)
+      vehicle_splits.map do|v|
+        vehicle = booking.find_vehicle_by_id(v['consumer_id'])
+        "#{vehicle.length}m #{vehicle.vehicle_type.name}"
+      end
+    end
+
+    def duration
+      (last_travel_date - first_travel_date + 1).to_i
+    end
+
+    def adjusted?
+      pre_adjusted_gross_including_packaged_item != gross_including_packaged_item
+    end
+  end
+end

data/lib/quick_travel/resource.rb

@@ -0,0 +1,50 @@
+require 'quick_travel/adapter'
+require 'quick_travel/bed_requirement'
+require 'quick_travel/passenger_price_break'
+require 'quick_travel/product_type'
+require 'quick_travel/cache'
+
+module QuickTravel
+  class Resource < Adapter
+    include QuickTravel::Cache
+    attr_accessor :id,
+                  :code,
+                  :name,
+                  :current_description,
+                  :images,
+                  :category,
+                  :property_name,
+                  :product_type_id,
+                  :package_options,
+                  :bed_requirements,
+                  :client_type_ids,
+                  :restrict_to_client_types,
+                  :type
+    self.api_base = '/resources'
+
+    def sub_resources
+      Resource.find_all!('/resources.json', parent_resource_id: @id)
+    end
+
+    def product_type
+      QuickTravel::ProductType.all.detect { |pt| pt.id == product_type_id }
+    end
+
+    # this method is also duplicated in accommodation class. because now its room facilities are now also available in property show api call
+    def room_facilities
+      if @_room_facilities.blank?
+        @_room_facilities = []
+        @room_facilities.each do |item|
+          @_room_facilities << RoomFacility.new(item['room_facility'])
+        end
+      end
+      @_room_facilities
+    end
+
+    def bed_requirements
+      @_bed_requirements ||= Array.wrap(@bed_requirements).map do |bed_requirement|
+        BedRequirement.new(bed_requirement)
+      end
+    end
+  end
+end

data/lib/quick_travel/room_facility.rb

@@ -0,0 +1,7 @@
+require 'quick_travel/adapter'
+
+module QuickTravel
+  class RoomFacility < Adapter
+    attr_accessor :id, :accommodation_id, :category_id, :created_at, :name, :position, :room_facility_id, :updated_at
+  end
+end

data/lib/quick_travel/route.rb

@@ -0,0 +1,81 @@
+module QuickTravel
+  class Route < Adapter
+    attr_accessor :id, :name, :path, :position, :product_type_id, :reverse_id, :route_stops
+
+    # First route for product_type_id
+    def self.first(product_type_id)
+      generic_first("/product_types/#{product_type_id}/routes.json")
+    end
+
+    # find_by_id -- but the API only does lookup by product_type_id
+    def self.find_by_route_id_and_product_type_id(route_id, product_type_id)
+      all_by_route_ids_and_product_type_id([route_id.to_i], product_type_id).first
+    end
+
+    # Return routes that match the given ids and product_type_id
+    #
+    # Initializes with path set
+    def self.all_by_route_ids_and_product_type_id(route_ids, product_type_id)
+      all(product_type_id).select do|route|
+        route_ids.include?(route.id.to_i)
+      end
+    end
+
+    # All routes for a given product type
+    def self.all(product_type_id)
+      cache_key = "trip_routes_#{product_type_id}"
+      routes = QuickTravel::Cache.cache_store.read(cache_key)
+
+      if routes.blank? || !routes.first.instance_of?(Route) # this is hack for development env. Lazy loading is main issue with it.
+        routes = self.find_all!("/product_types/#{product_type_id}/routes.json")
+        QuickTravel::Cache.cache_store.write(
+          cache_key,
+          routes,
+          expires_in: 1440.minutes # expires_in will only work with something like Rails.cache
+        )
+      end
+
+      routes
+    end
+
+    def self.find(routes_list, route_id)
+      routes_list.detect do|route|
+        route.id.to_i == route_id.to_i
+      end
+    end
+
+    def route_stops
+      @_stops ||= @route_stops.map { |item| RouteStop.new(item) }
+    end
+
+    def get_return_route_stop!(forward_stop)
+      if forward_stop.blank?
+        fail AdapterException, 'Selected pick up/drop off stops have not been set up for the selected route.'
+      end
+
+      reverse_stop = get_reverse_route!.route_stops.detect { |route_stop| route_stop.name == forward_stop.name }
+
+      if reverse_stop.blank?
+        fail AdapterException, 'Selected pick up/drop off stops have not been setup on the reverse route.'
+      end
+      reverse_stop
+    end
+
+    def get_reverse_route!
+      if reverse_id.blank?
+        fail AdapterException, 'Reverse has not been setup for the selected route.'
+      end
+
+      reverse_route = Route.find_by_route_id_and_product_type_id(reverse_id, product_type_id)
+      if reverse_route.blank?
+        fail AdapterException, 'Reverse does not exist for the selected route.'
+      end
+
+      reverse_route
+    end
+
+    def find_route_stop_by_id(route_stop_id)
+      route_stops.detect { |route_stop| route_stop.id.to_i == route_stop_id.to_i }
+    end
+  end
+end

data/lib/quick_travel/route_stop.rb

@@ -0,0 +1,7 @@
+require 'quick_travel/adapter'
+
+module QuickTravel
+  class RouteStop < Adapter
+    attr_accessor :id, :name, :address, :code, :position, :route_id
+  end
+end

data/lib/quick_travel/search.rb

@@ -0,0 +1,14 @@
+require 'quick_travel/init_from_hash'
+
+module QuickTravel
+  class Search
+    attr_accessor :property_type_id, :property_name, :product, :last_travel_date, :location_id
+    attr_accessor :category # type of search
+    attr_accessor :way # used for one_way or two_way in "getting there search"
+    attr_accessor :route_id # for getting there search
+    attr_accessor :number_of_rooms  # required for accommodation search
+    attr_accessor :forward_connection_date, :backward_connection_date
+
+    include QuickTravel::InitFromHash
+  end
+end

data/lib/quick_travel/service.rb

@@ -0,0 +1,5 @@
+module QuickTravel
+  class Service < Adapter
+    attr_accessor :id, :capacity, :booked, :weight, :max_weight, :unit_name, :deck_services
+  end
+end

data/lib/quick_travel/trip.rb

@@ -0,0 +1,8 @@
+require 'quick_travel/adapter'
+
+module QuickTravel
+  class Trip < Adapter
+    self.api_base = '/api/trips'
+    attr_accessor :route_id
+  end
+end

data/lib/quick_travel/vehicle.rb

@@ -0,0 +1,17 @@
+require 'quick_travel/adapter'
+
+module QuickTravel
+  class Vehicle < Adapter
+    attr_accessor :id, :vehicle_type_id, :registration, :length, :linked_to, :vehicle_type_name, :details
+
+    def self.create(booking_id, vehicle_types = {})
+      options = { booking_id: booking_id, vehicle_types: vehicle_types }
+      response = post_and_validate("#{Booking.front_office_base}/#{booking_id}/vehicles.json", options)
+      fail AdapterException.new(response) unless response.key?('booking_id')
+    end
+
+    def vehicle_type
+      VehicleType.all.detect { |vt| vt.id == vehicle_type_id }
+    end
+  end
+end

data/lib/quick_travel/vehicle_type.rb

@@ -0,0 +1,11 @@
+require 'quick_travel/adapter'
+
+module QuickTravel
+  class VehicleType < Adapter
+    attr_accessor :id, :name, :position, :code, :default_weight, :description, :detail_prompt, :double_length, :fixed_length, :fixed_weight
+    attr_accessor :has_cargo,	:default, :maximum_length, :minimum_length, :trailer
+
+    self.api_base = '/vehicle_types'
+    self.lookup = true
+  end
+end

data/lib/quick_travel/version.rb

@@ -0,0 +1,3 @@
+module QuickTravel
+  VERSION = '1.0.2'
+end

data/lib/quick_travel.rb

@@ -0,0 +1,59 @@
+# QuickTravel
+#
+module QuickTravel
+  VERSION = '0.0.2'
+
+  require 'active_support' # for .try, etc.
+
+  require 'quick_travel/cache'
+  require 'quick_travel/config'
+  require 'quick_travel/adapter'
+  require 'quick_travel/adapter_exception'
+  require 'quick_travel/connection_error'
+
+  # Don't include this guy: pull the pieces into the classes that use it, or ref
+  require 'quick_travel/constants'
+
+  require 'quick_travel/product'
+  require 'quick_travel/product_configuration'
+  require 'quick_travel/search'
+
+  # QuickTravel models
+  require 'quick_travel/graphic'
+  require 'quick_travel/accommodation'
+  require 'quick_travel/adapter'
+  require 'quick_travel/address'
+  require 'quick_travel/bed_configuration'
+  require 'quick_travel/booking'
+  require 'quick_travel/client'
+  require 'quick_travel/client_type'
+  require 'quick_travel/contact'
+  require 'quick_travel/country'
+  require 'quick_travel/document'
+  require 'quick_travel/document_group'
+  require 'quick_travel/location'
+  require 'quick_travel/party'
+  require 'quick_travel/passenger'
+  require 'quick_travel/passenger_type'
+  require 'quick_travel/payment'
+  require 'quick_travel/background_check'
+  require 'quick_travel/payment_type'
+  require 'quick_travel/product_type'
+  require 'quick_travel/property'
+  require 'quick_travel/property_facility'
+  require 'quick_travel/property_type'
+  require 'quick_travel/route'
+  require 'quick_travel/region'
+  require 'quick_travel/reservation'
+  require 'quick_travel/resource'
+  require 'quick_travel/room_facility'
+  require 'quick_travel/route_stop'
+  require 'quick_travel/service'
+  require 'quick_travel/trip'
+  require 'quick_travel/vehicle'
+  require 'quick_travel/vehicle_type'
+
+  require 'quick_travel/product_passenger_search_criteria'
+  require 'money'
+  require 'extensions'
+end

data/lib/quicktravel_client.rb

@@ -0,0 +1 @@
+require 'quick_travel'

data/quicktravel_client.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quick_travel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'quicktravel_client'
+  spec.version       = QuickTravel::VERSION
+  spec.authors       = ['Michael Noack', 'Adam Davies', 'Alessandro Berardi']
+  spec.email         = 'support@travellink.com.au'
+  spec.description   = 'For integrating with QuickTravel API'
+  spec.summary       = 'Booking process using QuickTravel API'
+  spec.homepage      = 'https://bitbucket.org/team-sealink/quicktravel_client'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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 'httparty'
+  spec.add_dependency 'geokit', '~> 1.8.3' # used in address model
+  spec.add_dependency 'activesupport', '>= 2.0.0'
+  spec.add_dependency 'money_extensions'
+  spec.add_dependency 'facets'
+  spec.add_dependency 'money', '>= 3.0', '< 6.0' # 6.0 starts to deprecate/split
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'stamp' # Used to send appropriate dates to API's
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'fakeweb'
+  spec.add_development_dependency 'rubocop'
+end

data/spec/booking_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'quick_travel/booking'
+require 'quick_travel/document'
+
+describe QuickTravel::Booking do
+  before(:each) do
+    @booking = QuickTravel::Booking.new(gross_in_cents: 500)
+  end
+
+  it 'should show me the money' do
+    expect(@booking.gross).to be_an_instance_of Money
+    expect(@booking.gross).to eq 5.to_money
+    expect(@booking.gross_in_cents).to eq 500
+  end
+end
+
+describe QuickTravel::Booking, '#on_account_payment_type' do
+  subject(:booking) { QuickTravel::Booking.new }
+  before { allow(booking).to receive(:payment_types) { payment_types } }
+  let(:reference)  { double(code: 'on_account_with_reference') }
+  let(:on_account) { double(code: 'on_account_without_reference') }
+  let(:cash)       { double(code: 'Cash') }
+
+  context 'when no on account types are applicable' do
+    let(:payment_types) { [cash] }
+    its(:on_account_payment_type) { should be nil }
+  end
+
+  context 'when only reference required' do
+    let(:payment_types) { [cash, reference] }
+    its(:on_account_payment_type) { should eq reference }
+  end
+
+  context 'when both on account and reference required' do
+    let(:payment_types) { [cash, reference, on_account] }
+    its(:on_account_payment_type) { should be on_account }
+  end
+end
+
+describe QuickTravel::Booking do
+  before(:each) do
+    VCR.use_cassette('booking_create') do
+      QuickTravel.config.version = 4
+      @booking = QuickTravel::Booking.create
+    end
+  end
+
+  it 'should find a first instance of booking with given booking.id from QuickTravel' do
+    VCR.use_cassette('booking_show') do
+      b = QuickTravel::Booking.find(@booking.id)
+      expect(b).to be_an_instance_of QuickTravel::Booking
+      expect(b.id).to eq @booking.id
+    end
+  end
+
+  it 'should be able to return its assigned reservations' do
+    VCR.use_cassette('booking_show') do
+      b = QuickTravel::Booking.find(@booking.id)
+      expect(b.reservations).to be_an_instance_of Array
+      expect(b.reservations.size).to eq 0
+    end
+  end
+
+  it 'should be able to update the booking' do
+    VCR.use_cassette('booking_update') do
+      response = @booking.update(customer_contact_name: 'John')
+      expect(response.class).to eq QuickTravel::Booking
+    end
+  end
+
+  it 'should not have booking documents' do
+    VCR.use_cassette('booking_documents') do
+      expect(@booking.documents.size).to eq 0
+    end
+  end
+end
+
+describe QuickTravel::Booking do
+  let(:booking) { QuickTravel::Booking.find(1) }
+  it 'should have booking documents' do
+    VCR.use_cassette('booking_with_documents') do
+      expect(booking.documents.size).to eq 1
+    end
+  end
+end
+
+describe QuickTravel::Booking do
+  let(:booking) { QuickTravel::Booking.find(1) }
+  subject(:consumer) { booking.passengers.first }
+  it 'should updated nested attributes' do
+    updated_booking = nil
+    VCR.use_cassette('booking_with_nested_attributes') do
+      expect(booking.customer_contact_name).to be nil
+      expect(consumer.id).to eq 1
+      expect(consumer.title).to be nil
+      expect(consumer.first_name).to be nil
+      updated_booking = booking.update_with_nested_attributes!(
+        customer_contact_name: 'New Name',
+        consumers: [{id: 1, title: 'Mr', first_name: 'New', last_name: 'Name'}]
+      )
+    end
+    updated_consumer = updated_booking.passengers.first
+    expect(updated_booking.customer_contact_name).to eq 'New Name'
+    expect(updated_consumer.title).to eq 'Mr'
+    expect(updated_consumer.first_name).to eq 'New'
+  end
+end

data/spec/country_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'quick_travel/country'
+
+describe QuickTravel::Country do
+  before do
+    VCR.use_cassette('country_all') do
+      @countries = QuickTravel::Country.all
+    end
+  end
+
+  it 'should fetch all countries' do
+    expect(@countries).to_not be_empty
+    au = @countries.detect { |c| c.iso_3166_code == 'AU' }
+    expect(au.name).to eq 'Australia'
+    au.id
+    expect(QuickTravel::Country.find(au.id).name).to eq 'Australia'
+  end
+end

data/spec/credit_card_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'quick_travel/credit_card'
+
+describe QuickTravel::CreditCard do
+  it 'determine the correct payment type for credit card number' do
+    expect(QuickTravel::CreditCard.type_from_number('4000123456780123')).to eq 'visa'
+    expect(QuickTravel::CreditCard.type_from_number('5400123456780123')).to eq 'master'
+    expect(QuickTravel::CreditCard.type_from_number('3600123456780123')).to eq 'diners_club'
+    expect(QuickTravel::CreditCard.type_from_number('3400123456780123')).to eq 'american_express'
+  end
+end