quicktravel_client 4.4.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e129c681ca2ddcb9dd7e16bec7c20abf68d521e97772a014084eafff9012d59a
-  data.tar.gz: 4b2616b1833da92d728e068855ef45d079dee130917d069dc0392fca3c4cf29a
+  metadata.gz: 6a4c632cfbc39ba8572be2c7639245838e24d9cb5cb182e6cf5447fb86d5d2c4
+  data.tar.gz: f2e51c60d7283dbeec9d0b6c0ce43569a5b65cbea9707781d5ffacbd78fa7a40
 SHA512:
-  metadata.gz: 7583c89610fb8f7b5807446638dd0eac84773fc7007be819f6ef410121eca3a00bf6dba6db78373ea067804ae73fe39afa3951c15a9d9456ff7865167735367c
-  data.tar.gz: 5ca4f5155bf9130c355c9a11620af95914e84276d382eff6f80b97a28fa98000ec055afc18c0f35ebbee6d9bec5f0a9a8ea9d0148c8a708b15b7e59644f60a13
+  metadata.gz: 9beee45dae9c6c32bf87276f1ef6ce859e4ee0cfb68f2c12011ec74efd96381cc71bb0261deb47b875665f9e78f814a4cdebe7a6ecbc610e27fe1412d851c622
+  data.tar.gz: bb5e864e91e579703a980facef1fbcb741b13314f3b25dd997379c730efadba52663df4bbac26498823b4f28d2d637763a794c41fec8d79e95ea6572fe57381e

data/.github/workflows/ruby.yml

@@ -5,8 +5,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        gemfile: [rails60, rails61]
-        ruby: ["2.6", "2.7", "3.0"]
+        gemfile: [rails60, rails61, rails70]
+        ruby: ["3.0", "3.1", "3.2"]
     runs-on: ubuntu-latest
     env:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile

data/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.2.0

data/CHANGELOG.md

@@ -1,47 +1,75 @@
 # Change Log
+
 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/).
 
+## 4.6.0
+
+- [PLAT-1175] Update to Ruby 3.2
+
+## 4.5.0
+
+- [TT-9346] Support injection of additional headers in requests to quicktravel
+- [TT-9331] Cache resources to reduce unnecessary API requests
+
 ## 4.4.0
+
 - [TT-8615] Update to build with github actions / ruby 3.0 / rails 6.1
 
 ## [4.3.2]
+
 ### Fixed
+
 - [TT-8511] Revert party lookup via the API endpoint
 
 ## [4.3.1]
+
 ### Fixed
+
 - [TT-8471] Fix missing QuickTravel:VERSION const error
 
 ## [4.3.0]
+
 ### Changed
+
 - [TT-8142] Add suitable user-agent header
 - [TT-8379] Switch to using api/parties endpoint
 
 ## [4.2.0]
+
 ### Changed
+
 - [TT-7969] Update cassettes to work with HttpParty >= 0.18.1
 - [TT-7912] Update api status endpoint to the new response format
 
 ## [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
@@ -49,154 +77,217 @@ This changelog adheres to [Keep a CHANGELOG](http://keepachangelog.com/).
 - [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
 
 ## [3.5.0]
+
 ###
+
 - [TT-3147] Remove unused payment methods
 - [TT-3278] Add full_response option to booking update
 
 ## [3.4.0]
+
 ###
+
 - Properties now return their associated location and types
 
 ## [3.3.0]
+
 ### Added
+
 - Price change reasons are now passed as an array
 
 ## [3.2.0]
+
 ### Changed
+
 - Return status with QuickTravel::AdapterError
 
 ## [3.1.0]
+
 ### Added
+
 - API to cancel a booking
 
 ## [3.0.0]
+
 ### Fixed
+
 - Allow zero pricing for extra pick items
 
 ### Changed
+
 - Use new reset password url
 
 ### Added
+
 - Setting API
 
 ### Removed
+
 - Removed geocode function on address
 
 ## [2.9.0]
+
 ### Changed
+
 - Use new API login
 
 ### Removed
+
 - Remove unused constants and default referral code
 
 ## [2.8.0]
+
 ### Changed
+
 - @booking.accommodation_reserve now expects to be passed the adjusted last_travel_date
 
 ## [2.7.0]
+
 ### Added
+
 - can_choose_stops? to check if a route has more than two stops
 
 ## [2.6.0]
+
 ### Removed
+
 - Stop passing last_travel_date
 
 ## [2.5.0]
+
 ### Added
+
 - Add call to get client token
 
 ## [2.4.1]
+
 ### Changed
+
 - Handle nil values for empty lists
 
 ## [2.4.0]
+
 ### Changed
+
 - Improve error handling when non JSON response
 - Update test cassettes due to API changes
 - Update test data due to new bootstrap.sql
 
 ## [2.3.1]
+
 ### Fixed
+
 - Omits empty array parameters
 
 ## [2.3.0]
+
 ### Changed
+
 - Change cache expiries
 - Adds support for passing dates to Resource#all_with_price
 
 ### Fixed
+
 - Fixes issue with HTTParty ~> 0.14
 - Updates HTTParty dependency to ~> 0.14
 
 ## [2.2.2]
+
 ### Changed
+
 - Deprecates Booking#calculate_price_quote
 - Fix when money is nil from QT
 
 ## [2.2.1] - 2016-04-18
+
 ### Fixed
+
 - Adds missing require for PriceQuote adapter
 
 ## [2.2.0] - 2016-04-18
+
 ### Added
+
 - PriceQuote adapter
 
 ## [2.1.0] - 2016-04-13
+
 ### Added
+
 - Resource categories
 - Products
 
 ## [2.0.0] - 2016-04-08
+
 ### Added
+
 - This changelog
 - Support for new ProductType API
 
 ### Changed
+
 - Discount API renamed Price Change API
 - Multiple internal refactorings and cleanups
 - Changes Price Quotes API to support non segment based products
 
 ## [1.1.1] - 2015-06-22
+
 ### Fixed
+
 - Fixed issue with Checkout API
 
 ## [1.1.0] - 2015-06-19
+
 ### Added
+
 - Checkout API
 
 ## [1.0.2] - 2015-06-01
+
 ### Fixed
+
 - Fixed issue with payment type code format
 
 ### Added
+
 - Code attribute to passenger type
 
 ## [1.0.1] - 2015-03-04
+
 ### Fixed
+
 - Fixed conflict between active_support and facets underscore method
 
 ## [1.0.0] - 2015-03-03
+
 - Initial public release

data/gemfiles/rails70.gemfile

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

data/lib/quick_travel/adapter.rb

@@ -216,6 +216,7 @@ module QuickTravel
       http_params[:headers]['Content-length'] = '0' if http_params[:body].blank?
       http_params[:headers]['x-api-key'] = QuickTravel.config.access_key
       http_params[:headers]['user-agent'] = 'quicktravel_client/' + QuickTravel::VERSION;
+      http_params[:headers].merge!(extra_headers) if extra_headers
 
       expect = http_params.delete(:expect)
 
@@ -254,6 +255,10 @@ module QuickTravel
       response
     end
 
+    def self.extra_headers
+      QuickTravel.config.extra_headers
+    end
+
     # Do standard validations on response
     #
     # Firstly, check if a valid HTTP code was returned

data/lib/quick_travel/config.rb

@@ -2,7 +2,7 @@ require 'quick_travel/adapter'
 
 module QuickTravel
   class Configuration
-    attr_accessor :url, :access_key, :version
+    attr_accessor :url, :access_key, :version, :extra_headers
 
     def url=(url)
       @url = url

data/lib/quick_travel/resource.rb

@@ -11,6 +11,11 @@ module QuickTravel
       Resource.find_all!('/api/resources.json', parent_resource_id: @id)
     end
 
+    def self.find(id, opts = {})
+      opts = { cache_key: "resource:#{id}", cache_options: { expires_in: 1.hour } }.merge(opts)
+      super(id, opts)
+    end
+
     def self.all_with_price(opts)
       cache_key = GenerateCacheKey.new(name, opts).call
       find_all!("/api/resources/index_with_price.json", opts.merge(cache_key: cache_key))

data/lib/quick_travel/version.rb

@@ -1,3 +1,3 @@
 module QuickTravel
-  VERSION = '4.4.0'
+  VERSION = '4.6.0'
 end

data/quicktravel_client.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.add_dependency 'httparty', '>= 0.18.1'
   spec.add_dependency 'activesupport', '>= 5.0.0'
@@ -30,7 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'coverage-kit'
   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 'webmock'

data/spec/adapter_spec.rb

@@ -83,4 +83,28 @@ describe QuickTravel::Adapter do
       specify { expect(api).to have_received(:call_and_validate).twice }
     end
   end
+
+  context 'extra headers defined' do
+    let(:url) { 'http://test.quicktravel.com.au' }
+    let(:query) { {} }
+    let(:change_config) { }
+    let(:useragent) { 'rspec' }
+
+    before do
+      change_config
+      QuickTravel::Adapter.post_and_validate(url, query)
+    end
+
+    let(:expected_params) { a_hash_including(headers: a_hash_including('user-agent' => useragent)) }
+
+    specify { expect(QuickTravel::Api).to have_received(:post).with(url, expected_params) }
+
+    context 'and the config is changed' do
+      let(:useragent) { 'newspec' }
+      let(:change_config) {
+        QuickTravel.config.extra_headers = { 'user-agent' => 'newspec' }
+      }
+      specify { expect(QuickTravel::Api).to have_received(:post).with(url, expected_params) }
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -22,6 +22,7 @@ qt_keys = ENV['QT_KEYS'].split(',')
 QuickTravel.configure do |c|
   c.url = 'http://test.qt.sealink.com.au:8080'
   c.access_key = qt_keys[0]
+  c.extra_headers = { 'user-agent' => 'rspec' }
 end
 
 require 'quick_travel/connection_error'

data/spec/support/coverage_loader.rb

@@ -1,4 +1,3 @@
 require 'simplecov-rcov'
-require 'coveralls'
 require 'coverage/kit'
-Coverage::Kit.setup(minimum_coverage: 83.2)
+Coverage::Kit.setup(minimum_coverage: 83.7)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quicktravel_client
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Michael Noack
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -180,20 +180,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: stamp
   requirement: !ruby/object:Gem::Requirement
@@ -286,6 +272,7 @@ files:
 - examples/login_example.rb
 - gemfiles/rails60.gemfile
 - gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
 - lib/extensions.rb
 - lib/quick_travel.rb
 - lib/quick_travel/accommodation.rb
@@ -452,14 +439,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Booking process using QuickTravel API