quicktravel_client 3.6.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 72a489cb7817b24b10974577573ac48201ada117
-  data.tar.gz: d0588b714309e3e3cbd7425638171a32193cf615
+SHA256:
+  metadata.gz: 5007469a12b06055c4cd7b9ae331a99ffc041952348ccad994ab11de51069e79
+  data.tar.gz: e57da3eb9ef8ff2f49283a9de910d5ffbb4c424f965f96fb8175d6ea452795e1
 SHA512:
-  metadata.gz: aa65860cb328ee8428b409c33c10d42c4bc2ce838c9c53ec386da17a0350d6af2c6d0d3f08e56d8074421df5a71f63d99e57759d1448e640d6c8ff94caa462ca
-  data.tar.gz: 246af3dc7676cd28979f6e681573b2c8a893bc8c0675095d0f118b597bc20552299bbc4b911a0ea0a15a55644d7b9cda2b3f2542faac1f6e58028b2092413502
+  metadata.gz: 24d5ba5f79aedf800a3fbd40c793a13dab2bfb48f91059460293aa757e5aea062f850b290e2b3b72e83c2269de5a675e9d5dfee761ef7555ba47aa3bc24f8928
+  data.tar.gz: ecb835442572758fe0b02d953bf978f2af920396396e7d9a6937917d5636fd8663e3ce0672fbcf39fed76652acdbb7dd4582f0c0bd19b3827123cb861df77081

data/.ruby-version

@@ -1 +1 @@
-2.2.4
+2.7.1

data/.travis.yml

@@ -1,11 +1,14 @@
 language: ruby
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.5
+  - 2.6
+  - 2.7
+before_install:
+  - gem install bundler
 script: bundle && bundle exec rake spec
 gemfile:
-  - gemfiles/rails4.gemfile
   - gemfiles/rails5.gemfile
+  - gemfiles/rails6.gemfile
 notifications:
   email:
     - support@travellink.com.au

data/CHANGELOG.md

@@ -3,12 +3,45 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 This changelog adheres to [Keep a CHANGELOG](http://keepachangelog.com/).
 
-## [Unreleased]
+## [4.0.0]
+- [TT-7385] Update Money dependency, test against Ruby 2.7 / Rails 6
 
-## [3.6.1]
-###
+## [3.9.0]
+### Added
+- [DC-3115] Add customer comments method in booking
+- [DC-2942] Add package class to support quantity based package
+
+## [3.8.1]
+### Changed
+- [DC-3033] Reverse changes in checkout class to fix polipay redirection in EcomEngine
+
+## [3.8.0]
+### Added
+- [DC-1794] Update httparty to allow caching the whole response, also add namespace to cache key
+- [DC-1418] Port NRMA portal availability cache back to EcomEngine
+- [TT-4850] Added client templates
+- [DC-1692] Fix error that can be thrown when checking if a product configuration can be priced
+- [TT-6246] Remove Booking.delete_reservations method
+
+### Changed
+- [DC-2997] Remove API key from body, and move it to header
+- [DC-1767] include long/lat changes to Stop
+
+## [3.7.0]
+### Added
+- [DC-1437] Add relationship accesssor methods
+- [TT-3337] Add booking.delete_reservations method
+- [TT-3780] Add tests for Opal payments
+- [TT-3780] Add tests for Opal payment using create / update workflow
+
+### Fixed
 - [TT-3304] Handle no response in booking update API
 
+### Changed
+- [TT-3333] URL encode data sent to booking reference lookup
+- [TT-3783] Remove deprecated FixNum
+- [TT-3812] Update cassettes
+
 ## [3.6.0]
 ###
 - [ROT-114] Add drop off details

data/README.md

@@ -27,4 +27,4 @@ bundle exec puma -Ilib -p7000
 
 In QuickTravel Client:
 rm spec/support/cassettes/ -rf
-QT_KEYS=a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2,a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 bundle exec rspec
+QT_KEYS=a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2,1b0a9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a bundle exec rspec

data/gemfiles/rails6.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activesupport', '~> 6.0'
+  gem 'activerecord', '~> 6.0'
+  gem 'actionpack', '~> 6.0'
+end

data/lib/quick_travel.rb

@@ -2,6 +2,7 @@
 #
 module QuickTravel
   require 'active_support' # for .try, etc.
+  require 'money_extensions'
 
   require 'quick_travel/cache'
   require 'quick_travel/config'
@@ -33,9 +34,11 @@ module QuickTravel
   require 'quick_travel/drop_off_location'
   require 'quick_travel/drop_off_option'
   require 'quick_travel/location'
+  require 'quick_travel/package'
   require 'quick_travel/party'
   require 'quick_travel/passenger'
   require 'quick_travel/passenger_type'
+  require 'quick_travel/passenger_split'
   require 'quick_travel/payment'
   require 'quick_travel/background_check'
   require 'quick_travel/payment_type'
@@ -49,6 +52,7 @@ module QuickTravel
   require 'quick_travel/reservation'
   require 'quick_travel/resource'
   require 'quick_travel/resource_category'
+  require 'quick_travel/resource_group'
   require 'quick_travel/room_facility'
   require 'quick_travel/route_stop'
   require 'quick_travel/service'

data/lib/quick_travel/adapter.rb

@@ -25,27 +25,6 @@ module QuickTravel
     # ]
     class_attribute :object_key # Key of sub-objects (i.e. convert under a key)
 
-    def initialize(hash = {})
-      return nil if hash.blank?
-      define_readers(hash.keys)
-      super(Parser.new(hash).parsed_attributes)
-    end
-
-    def define_readers(keys)
-      keys.each do |key|
-        next if respond_to?(key)
-        define_singleton_method(key) { instance_variable_get("@#{key}") }
-        if key.to_s.ends_with? '_cents'
-          name = key.to_s.gsub(/_in_cents$/, '')
-          define_singleton_method(name) {
-            cents = instance_variable_get("@#{key}")
-            return nil unless cents
-            Money.new(cents)
-          }
-        end
-      end
-    end
-
     def self.has_many(relation_name, options = {})
       define_method relation_name do
         instance_variable_get("@#{relation_name}") || instance_variable_set(
@@ -86,7 +65,7 @@ module QuickTravel
     def self.all(opts = {})
       if lookup
         cache_name = ["#{name}.all-attrs", opts.to_param].reject(&:blank?).join('?')
-        find_all!("#{api_base}.json", opts.merge(cache: cache_name))
+        find_all!("#{api_base}.json", opts.merge(cache_key: cache_name, cache_options: { disable_namespacing: true }))
       else
         find_all!("#{api_base}.json", opts)
       end
@@ -101,8 +80,12 @@ module QuickTravel
       put_and_validate("#{api_base}/#{id}.json", options)
     end
 
-    def to_hash
-      instance_values
+    def to_s
+      if defined? @to_s
+        @to_s
+      else
+        super
+      end
     end
 
     protected
@@ -115,20 +98,14 @@ module QuickTravel
     end
 
     def self.find_all!(request_path, opts = {})
-      response = if opts.key? :cache
-        QuickTravel::Cache.cache(opts[:cache], opts[:cache_options]) {
-          get_and_validate(request_path, opts.except(:cache, :cache_options))
-        }
-      else
-        get_and_validate(request_path, opts, return_response_object: true)
-      end
-      full_response = response.respond_to? :parsed_response
-      parsed_response = full_response ? response.parsed_response : response
+      response = QuickTravel::Cache.cache(opts[:cache_key], opts[:cache_options]) {
+        get_and_validate(request_path, opts.except(:cache_key, :cache_options), return_response_object: true)
+      }
 
-      deserializer = Deserializer.new(parsed_response)
+      deserializer = Deserializer.new(response.parsed_response)
       objects = Array.wrap(deserializer.extract_under_root(self))
 
-      if full_response && response.headers['pagination'].present?
+      if response.headers['pagination'].present?
         pagination_headers = ::JSON.parse(response.headers['pagination'])
         WillPaginate::Collection.create(pagination_headers['current_page'], pagination_headers['per_page'], pagination_headers['total_entries']) do |pager|
           pager.replace(objects)
@@ -215,7 +192,11 @@ module QuickTravel
     end
 
     def self.call_and_validate(http_method, path, query = {}, opts = {})
-      Api.call_and_validate(http_method, path, query, opts)
+      response = QuickTravel::Cache.cache(opts[:cache_key], opts[:cache_options]) {
+        response_object = Api.call_and_validate(http_method, path, query, opts.except(:cache_key, :cache_options))
+        response_object = response_object.parsed_response if !opts[:cache_key] and !opts[:return_response_object]
+        response_object
+      }
     end
 
     def self.base_uri(uri = nil)
@@ -223,54 +204,16 @@ module QuickTravel
     end
   end
 
-  class Parser
-    def initialize(attributes)
-      @attributes = attributes
-    end
-
-    def attributes
-      @attributes ||= {}
-    end
-
-    def parsed_attributes
-      @parsed_attributes ||= parse_attributes
-    end
-
-    private
-
-    def parse_attributes
-      attributes.map.with_object({}) do |(attribute, value), hash|
-        hash[attribute] = parse(attribute, value)
-      end
-    end
-
-    def parse(attribute, value)
-      return nil if value.nil?
-      return convert(value, :to_date) if attribute.to_s.ends_with?('_date')
-      return convert(value, :to_date) if attribute.to_s.ends_with?('_on')
-      # to_datetime as it converts to app time zone, to_time converts to system time zone
-      return convert(value, :to_datetime) if attribute.to_s.ends_with?('_time')
-      return convert(value, :to_datetime) if attribute.to_s.ends_with?('_at')
-      value
-    end
-
-    def convert(value, conversion_method)
-      convertable_value = value.is_a?(Hash) ? value['_value'] : value
-      convertable_value.send(conversion_method)
-    end
-  end
-
   class Api
     include HTTParty
 
     def self.call_and_validate(http_method, path, query = {}, opts = {})
       http_params = opts.clone
-      return_response_object = http_params.delete(:return_response_object)
-
       # Set default token
       http_params[:query]   ||= FilterQuery.new(query).call
       http_params[:headers] ||= {}
       http_params[:headers]['Content-length'] = '0' if http_params[:body].blank?
+      http_params[:headers]['x-api-key'] = QuickTravel.config.access_key
       expect = http_params.delete(:expect)
 
       # Use :body instead of :query for put/post.
@@ -280,7 +223,6 @@ module QuickTravel
       if [:put, :post].include?(http_method.to_sym)
         http_params[:body].merge!(http_params.delete(:query))
       end
-      http_params[:body][:access_key] = QuickTravel.config.access_key
       http_params[:follow_redirects] = false
 
       begin
@@ -306,11 +248,7 @@ module QuickTravel
 
       validate!(response)
 
-      if return_response_object
-        response
-      else
-        response.parsed_response
-      end
+      response
     end
 
     # Do standard validations on response

data/lib/quick_travel/address.rb

@@ -1,7 +1,9 @@
-require 'quick_travel/adapter'
+require 'quick_travel/init_from_hash'
 
 module QuickTravel
-  class Address < Adapter
+  class Address
+    include QuickTravel::InitFromHash
+
     def country_name
       QuickTravel::Country.find(@country_id).name
     end

data/lib/quick_travel/adjustment.rb

@@ -1,6 +1,7 @@
-require 'quick_travel/adapter'
+require 'quick_travel/init_from_hash'
 
 module QuickTravel
-  class Adjustment < Adapter
+  class Adjustment
+    include QuickTravel::InitFromHash
   end
 end

data/lib/quick_travel/background_check.rb

@@ -1,7 +1,9 @@
-require 'quick_travel/adapter'
+require 'quick_travel/init_from_hash'
 
 module QuickTravel
-  class BackgroundCheck < Adapter
+  class BackgroundCheck
+    include QuickTravel::InitFromHash
+
     def self.check(options = {})
       get_and_validate('/background_check/check.json', options)
     end

data/lib/quick_travel/bed_configuration.rb

@@ -1,6 +1,7 @@
-require 'quick_travel/adapter'
+require 'quick_travel/init_from_hash'
 
 module QuickTravel
-  class BedConfiguration < Adapter
+  class BedConfiguration
+    include QuickTravel::InitFromHash
   end
 end

data/lib/quick_travel/bed_requirement.rb

@@ -1,6 +1,7 @@
-require 'quick_travel/adapter'
+require 'quick_travel/init_from_hash'
 
 module QuickTravel
-  class BedRequirement < Adapter
+  class BedRequirement
+    include QuickTravel::InitFromHash
   end
 end

data/lib/quick_travel/booking.rb

@@ -4,6 +4,7 @@ require 'quick_travel/vehicle'
 require 'quick_travel/payment'
 require 'quick_travel/payment_type'
 require 'quick_travel/price_changes'
+require 'uri'
 
 module QuickTravel
   class Booking < Adapter
@@ -12,7 +13,7 @@ module QuickTravel
     end
 
     def self.find_by_reference(reference)
-      find_all!("#{api_base}/reference/#{reference}.json").first
+      find_all!("#{api_base}/reference/#{URI.encode_www_form_component(reference)}.json").first
     end
 
     def documents(regenerate = false)
@@ -184,6 +185,10 @@ module QuickTravel
       vehicles.detect { |v| v.id.to_i == vid.to_i }
     end
 
+    def passengers
+      @passenger_objects ||= @passengers_attributes.map{ |p| Passenger.new(p) }
+    end
+
     def passenger_types_counts
       passengers.each_with_object(Hash.new(0)) do |passenger, hash|
         hash[passenger.passenger_type_id] += 1
@@ -291,6 +296,11 @@ module QuickTravel
       Encrypt.access_key(@id.to_s)
     end
 
+    def customer_comments
+      comment = comments.detect{ |comment| comment['comment_type'] == 'customer' }
+      comment.presence.try(:[], 'text') || ''
+    end
+
     protected
 
     def reserve(url, options)

data/lib/quick_travel/cache.rb

@@ -6,16 +6,27 @@ module QuickTravel
       end
     end
 
-    def self.cache(key, cache_options = {})
+    def self.cache(key, cache_options = nil)
+      return yield unless key.present?
+      cache_options ||= {}
+      key = "#{@@namespace}_#{key}" unless cache_options[:disable_namespacing]
       cached_value = cache_store.read(key)
-      return cached_value unless cached_value.nil?
+      return cached_value unless cache_empty?(cached_value)
       return nil unless block_given?
       cache_options ||= {}
       cache_options[:expires_in] = 1.day unless cache_options.key?(:expires_in)
       yield.tap { |value| cache_store.write(key, value, cache_options) }
     end
 
-    def self.delete(key)
+    def self.cache_empty?(cached_value)
+      if cached_value.respond_to?(:body)
+        return cached_value.body.nil? || cached_value.body.empty?
+      end
+      cached_value.nil?
+    end
+
+    def self.delete(key, namespace = true)
+      key = "#{@@namespace}_#{key}" if namespace
       cache_store.delete(key)
     end
 
@@ -27,8 +38,16 @@ module QuickTravel
       @@cache_store
     end
 
-    def self.cache_store=(store)
-      @@cache_store = store
+    def self.cache_store=(session)
+      @@cache_store = session
+    end
+
+    def self.namespace
+      @@namespace
+    end
+
+    def self.namespace=(namespace)
+      @@namespace = namespace
     end
   end
 end

data/lib/quick_travel/checkout.rb

@@ -46,7 +46,7 @@ module QuickTravel
     # TODO Move to an external builder?
     def self.attributes_for
       attrs = yield
-      attrs[:completed] = (attrs['progress'] == 'completed')
+      attrs[:completed] = attrs['progress'] == 'completed'
       attrs[:successful] = attrs[:completed]
       attrs
     rescue AdapterError => e