quicktravel_client 3.7.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b60bf00c1c2d71210f2d1f462986abba8859b7acd216b13d68c8d4ad2c475e9d
-  data.tar.gz: 79cb1bad6bdd5a2178577824c1196ff9e5728beda74e5474bac7f9e53e63c053
+  metadata.gz: 1bba05a60170b4b63f097183048b5c1bc8c73192631268c47bad3bf75999851c
+  data.tar.gz: 637a0c94cd80217ddbe580c77ad5ef6ac2ef99d1465c870762f1686660967fcb
 SHA512:
-  metadata.gz: 205130ad17115f1f0491351af5b76242a8b67a1f384912708fa4ebad3211d428e83284c41aa8c024d82b1004371415848d47a7fd44bd86fcd375952c5eb68737
-  data.tar.gz: b0cca6ec2c7b5dd695112ba71d112f7593c8bc174070c380aade2d3ddd5aed23b9a44eec3796c207b65ef3d87c6f6bd2f02ced5c3248e58a505907ddfcb2c1f4
+  metadata.gz: 295a00c7ed151281f4a406fea28804ad3318f55ba998350c8dd887666dc11f79038e0c381bc16e9f9f8bc2dfb07cc6fd3085ebeea02f9fa3ae4fa84f26926a38
+  data.tar.gz: aee796df5056e802266ebe1962ca9b882992cd8c77066ec27c97e0b36ae045ad2827485b19f8893dac75a61fe3f6a692e0d8fa4af751b4173b442c8a1e1e1ee0

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.7.1

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
-  - 2.4
   - 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,6 +3,36 @@ 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.1.0]
+### Added
+- [TT-7788] Add API namespace to vehicle_types endpoint
+
+## [4.0.0]
+- [TT-7385] Update Money dependency, test against Ruby 2.7 / Rails 6
+
+## [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

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,6 +34,7 @@ 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'

data/lib/quick_travel/adapter.rb

@@ -65,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
@@ -80,10 +80,6 @@ module QuickTravel
       put_and_validate("#{api_base}/#{id}.json", options)
     end
 
-    def to_hash
-      instance_values
-    end
-
     def to_s
       if defined? @to_s
         @to_s
@@ -102,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)
@@ -202,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)
@@ -215,12 +209,11 @@ module QuickTravel
 
     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.
@@ -230,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
@@ -256,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/booking.rb

@@ -13,7 +13,7 @@ module QuickTravel
     end
 
     def self.find_by_reference(reference)
-      find_all!("#{api_base}/reference/#{URI.escape(reference)}.json").first
+      find_all!("#{api_base}/reference/#{URI.encode_www_form_component(reference)}.json").first
     end
 
     def documents(regenerate = false)
@@ -157,10 +157,6 @@ module QuickTravel
       reserve(:packages, options)
     end
 
-    def delete_reservations
-      delete_and_validate("#{api_base}/#{@id}/reservations")
-    end
-
     # Delete a reservation
     #
     # Returns current booking object after deleting the reservation
@@ -300,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['successful']
+      attrs[:completed] = attrs['progress'] == 'completed'
       attrs[:successful] = attrs[:completed]
       attrs
     rescue AdapterError => e

data/lib/quick_travel/client.rb

@@ -1,7 +1,15 @@
+# frozen_string_literal: true
+
+require 'quick_travel/adapter'
 require 'quick_travel/init_from_hash'
 
 module QuickTravel
-  class Client
+  class Client < Adapter
     include QuickTravel::InitFromHash
+    self.api_base = '/api/clients'
+
+    def templates
+      get_and_validate("/api/clients/#{id}/templates")
+    end
   end
 end

data/lib/quick_travel/init_from_hash.rb

@@ -28,6 +28,10 @@ module QuickTravel
         end
       end
     end
+
+    def to_hash
+      instance_values
+    end
   end
 
   class Parser

data/lib/quick_travel/package.rb

@@ -0,0 +1,13 @@
+require 'quick_travel/adapter'
+
+module QuickTravel
+  class Package < Adapter
+    attr_reader :error_message
+
+    self.api_base = '/api/packages'
+
+    def product_type
+      QuickTravel::ProductType.find(product_type_id)
+    end
+  end
+end

data/lib/quick_travel/passenger_type.rb

@@ -13,7 +13,7 @@ module QuickTravel
     end
 
     def self.pluralize(count, singular, plural = nil)
-      "#{count || 0} " + ((count == 1 || count =~ /^1(\.0+)?$/) ? singular : (plural || singular.pluralize))
+      "#{count || 0} " + ((count == 1) ? singular : (plural || singular.pluralize))
     end
   end
 end

data/lib/quick_travel/product_configuration.rb

@@ -31,7 +31,7 @@ module QuickTravel
     end
 
     def priced?
-      @product.pricing_details.present?
+      @product.try(:pricing_details).present?
     end
 
     def price

data/lib/quick_travel/products/base.rb

@@ -7,13 +7,13 @@ module QuickTravel
         bookable || exception_type == 'inventory'
       end
 
-      def self.find(search_params = {})
-        find_for_type(@reservation_for_type, search_params)
+      def self.find(search_params = {}, opts = {})
+        find_for_type(@reservation_for_type, search_params, opts)
       end
 
-      def self.find_for_type(type, search_params = {})
+      def self.find_for_type(type, search_params = {}, opts = {})
         url = "/reservation_for/#{type}/find_services_for.json"
-        product_maps = post_and_validate(url, search_params)
+        product_maps = post_and_validate(url, search_params, opts)
         product_maps.map { |product_map| new(product_map) }
       end
     end

data/lib/quick_travel/reservation.rb

@@ -42,7 +42,7 @@ module QuickTravel
       passenger_type_count = {}
       if passenger_splits.present?
         passenger_splits.each do |p|
-          passenger = booking.find_passenger_by_id(p['consumer_id'])
+          passenger = booking.find_passenger_by_id(p.consumer_id)
 
           if passenger.present?
             passenger_type_count[passenger.passenger_type_id] ||= 0

data/lib/quick_travel/resource.rb

@@ -13,7 +13,7 @@ module QuickTravel
 
     def self.all_with_price(opts)
       cache_key = GenerateCacheKey.new(name, opts).call
-      find_all!("/api/resources/index_with_price.json", opts.merge(cache: cache_key))
+      find_all!("/api/resources/index_with_price.json", opts.merge(cache_key: cache_key))
     end
 
     def product_type

data/lib/quick_travel/route.rb

@@ -17,7 +17,7 @@ module QuickTravel
     # All routes for a given product type
     def self.all(product_type_id)
       find_all!("/product_types/#{product_type_id}/routes.json",
-                cache: "QuickTravel::Route.all-#{product_type_id}-attrs")
+                cache_key: "QuickTravel::Route.all-#{product_type_id}-attrs")
     end
 
     def self.find(routes_list, route_id)

data/lib/quick_travel/route_stop.rb

@@ -5,7 +5,14 @@ module QuickTravel
     include QuickTravel::InitFromHash
 
     def stop
-      Stop.new({ id: stop_id, name: name, code: code, address: address })
+      Stop.new({
+        id: stop_id,
+        name: name,
+        code: code,
+        address: address,
+        longitude: longitude,
+        latitude: latitude
+      })
     end
   end
 

data/lib/quick_travel/vehicle_type.rb

@@ -2,7 +2,7 @@ require 'quick_travel/adapter'
 
 module QuickTravel
   class VehicleType < Adapter
-    self.api_base = '/vehicle_types'
+    self.api_base = '/api/vehicle_types'
     self.lookup = true
   end
 end

data/lib/quick_travel/version.rb

@@ -1,3 +1,3 @@
 module QuickTravel
-  VERSION = '3.7.0'
+  VERSION = '4.1.0'
 end

data/quicktravel_client.gemspec

@@ -16,14 +16,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'httparty', '0.15.7' # Bug in >16 relating to nested parameters
-  spec.add_dependency 'json'
-  spec.add_dependency 'activesupport', '>= 2.0.0'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'activesupport', '>= 5.0.0'
   spec.add_dependency 'facets'
-  spec.add_dependency 'money', '>= 3.0', '< 6.0' # 6.0 starts to deprecate/split
+  spec.add_dependency 'money', '>= 6.0'
+  spec.add_dependency 'money_extensions', '>= 1.0'
   spec.add_dependency 'will_paginate'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'