quicktravel_client 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e129c681ca2ddcb9dd7e16bec7c20abf68d521e97772a014084eafff9012d59a
-  data.tar.gz: 4b2616b1833da92d728e068855ef45d079dee130917d069dc0392fca3c4cf29a
+  metadata.gz: e0325799c230cd8fe94a4f7454f8ff7ccb5fddb27ab18a67b9f3096d72aada02
+  data.tar.gz: 427ad145f755aa347c5ceb6d1c558b9e47392d1e61f48daeac074b933d7ded30
 SHA512:
-  metadata.gz: 7583c89610fb8f7b5807446638dd0eac84773fc7007be819f6ef410121eca3a00bf6dba6db78373ea067804ae73fe39afa3951c15a9d9456ff7865167735367c
-  data.tar.gz: 5ca4f5155bf9130c355c9a11620af95914e84276d382eff6f80b97a28fa98000ec055afc18c0f35ebbee6d9bec5f0a9a8ea9d0148c8a708b15b7e59644f60a13
+  metadata.gz: 744fc85a1f7bf032a494eb394c1573f06c0a1094608da175f7fc20c053babf78a8950bf038ff0b6dff97a0926f70492b96db2481083aa9055590f9fd8bdd33ac
+  data.tar.gz: 42f9a4aefc2150631c807a96bfaad03b8a0b6ff9c1427980435bd5a35818dadb84929b715199c47c2f02093be211b5f1565ef9957087129f5feed7398768bbae

data/CHANGELOG.md

@@ -3,6 +3,13 @@ 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.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
 

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.5.0'
 end

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,4 @@
 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.5.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: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty