quicktravel_client 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b60bf00c1c2d71210f2d1f462986abba8859b7acd216b13d68c8d4ad2c475e9d
-  data.tar.gz: 79cb1bad6bdd5a2178577824c1196ff9e5728beda74e5474bac7f9e53e63c053
+  metadata.gz: f0ed55eb639dbe01ac2b6781edfccbc34b720ea04c6b8239830bf60b86406f5f
+  data.tar.gz: 776482e19be6a3df01a7e0f2670fda08d5a1a73d3e4fbc0429867126b2385c7b
 SHA512:
-  metadata.gz: 205130ad17115f1f0491351af5b76242a8b67a1f384912708fa4ebad3211d428e83284c41aa8c024d82b1004371415848d47a7fd44bd86fcd375952c5eb68737
-  data.tar.gz: b0cca6ec2c7b5dd695112ba71d112f7593c8bc174070c380aade2d3ddd5aed23b9a44eec3796c207b65ef3d87c6f6bd2f02ced5c3248e58a505907ddfcb2c1f4
+  metadata.gz: '098cd8f377681060a0656ac2759730d816d55b3a7e37484d0577d5644ada764566a32911909ead40a61a5f455d0a52690e4a9a29e5b551af44e4a954141a5cec'
+  data.tar.gz: 6efb0debce10413a072952301ba5c8fc3a2826ecd3e67a0d94550b0ff1671105e392f351e8485e29488cb6d56ad1a1be222cdcd6dc302ef887e3d9b57e8304d9

data/.travis.yml

@@ -4,6 +4,8 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+before_install:
+  - gem install bundler --version "1.17.3"
 script: bundle && bundle exec rake spec
 gemfile:
   - gemfiles/rails4.gemfile

data/CHANGELOG.md

@@ -3,6 +3,18 @@ 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/).
 
+## [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/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

@@ -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

data/lib/quick_travel/cache.rb

@@ -6,7 +6,10 @@ 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 nil unless block_given?
@@ -15,7 +18,8 @@ module QuickTravel
       yield.tap { |value| cache_store.write(key, value, cache_options) }
     end
 
-    def self.delete(key)
+    def self.delete(key, namespace = true)
+      key = "#{@@namespace}_#{key}" if namespace
       cache_store.delete(key)
     end
 
@@ -27,8 +31,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,8 @@ 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[:completed] = attrs['successful'] if attrs['successful'].present?
       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/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/version.rb

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

data/quicktravel_client.gemspec

@@ -16,7 +16,7 @@ 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 'httparty', '~> 0.17'
   spec.add_dependency 'json'
   spec.add_dependency 'activesupport', '>= 2.0.0'
   spec.add_dependency 'facets'

data/spec/adapter_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'quick_travel/adapter'
 
 describe QuickTravel::Adapter do
-  let(:response) { double code: 200, parsed_response: parsed_response }
+  let(:response) { double code: 200, parsed_response: parsed_response, headers: {} }
   let(:parsed_response) { { test: true } }
 
   before do
@@ -26,8 +26,7 @@ describe QuickTravel::Adapter do
     let(:expected_body) {
       {
         test: true,
-        sub_hash: { id: 42 },
-        access_key: an_instance_of(String)
+        sub_hash: { id: 42 }
       }
     }
 
@@ -52,4 +51,36 @@ describe QuickTravel::Adapter do
       )
     end
   end
+
+  context 'when cache options present' do
+    subject(:all) do
+      QuickTravel::Adapter.call_and_validate(:get, 'some_path', {}, { cache_key: 'test_key', cache_options: { expires_in: 3.minutes } })
+    end
+    let(:api) { double }
+
+    before do
+      QuickTravel::Cache.cache_store.clear
+      stub_const('QuickTravel::Api', api)
+      allow(api).to receive(:call_and_validate) { [{id: 1}, {id: 2}] }
+      all
+    end
+
+    specify { expect(api).to have_received(:call_and_validate).once }
+
+    context 'when called again' do
+      before do
+        QuickTravel::Adapter.call_and_validate(:get, 'some_path', {}, { cache_key: 'test_key', cache_options: { expires_in: 3.minutes } })
+      end
+
+      specify { expect(api).to have_received(:call_and_validate).once } # not called again
+    end
+
+    context 'when called with different key' do
+      before do
+        QuickTravel::Adapter.call_and_validate(:get, 'some_path', {}, { cache_key: 'test_key1', cache_options: { expires_in: 3.minutes } })
+      end
+
+      specify { expect(api).to have_received(:call_and_validate).twice }
+    end
+  end
 end

data/spec/clients_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'quick_travel/client'
+
+describe QuickTravel::Client do
+  context '#find' do
+    let(:templates) do
+      VCR.use_cassette('client_templates') do
+        QuickTravel::Client.find(2).templates
+      end
+    end
+    it 'should find the templates correctly' do
+      expect(templates['vehicle_templates']).to eq([
+        {
+          'id' => 1,
+          'length' => 5.0,
+          'height' => 1.5,
+          'width' => 1.8,
+          'weight' => 1000.0,
+          'details' => 'Holden Commodore',
+          'registration' => 'ABC123',
+          'cargo' => 'None',
+          'vehicle_type_id' => 1,
+          'party_id' => 9
+        }
+      ])
+      expect(templates['passenger_templates']).to eq([
+        {
+          'id' => 1,
+          'age' => 30,
+          'title' => 'Mr',
+          'first_name' => 'Homer',
+          'last_name' => 'Simpson',
+          'gender' => 'Male',
+          'passenger_type_id' => 1,
+          'party_id' => 9
+        }
+      ])
+    end
+  end
+end

data/spec/passenger_type_spec.rb

@@ -39,7 +39,7 @@ describe QuickTravel::PassengerType do
 
     before do
       stub_const('QuickTravel::Api', api)
-      allow(api).to receive(:call_and_validate) { [{id: 1}, {id: 2}] }
+      allow(api).to receive(:call_and_validate) { double(parsed_response: [{id: 1}, {id: 2}], headers: {}) }
     end
     
     context 'when called the first time' do

data/spec/product_configuration_spec.rb

@@ -127,6 +127,17 @@ describe QuickTravel::ProductConfiguration do
       let(:pricing_details) { nil }
       it { is_expected.not_to be_priced }
     end
+
+    context 'when pricing details are omitted' do
+      let(:product) do
+        double(
+          extras: extras,
+          available?: available
+        )
+      end
+
+      it { is_expected.not_to be_priced }
+    end
   end
 
   context '#price' do

data/spec/reservation_spec.rb

@@ -48,3 +48,23 @@ describe QuickTravel::Reservation do
     expect(@reservation.gross_including_packaged_item).to be_an_instance_of Money
   end
 end
+
+describe QuickTravel::Reservation do
+  before(:each) do
+    VCR.use_cassette('reservation_with_extra_picks') do
+      @booking = QuickTravel::Booking.find(1)
+      @reservation = @booking.reservations.first
+    end
+  end
+
+  it 'should convert hash to objects' do
+    expect(@reservation.passenger_splits.first).to be_an_instance_of QuickTravel::PassengerSplit
+  end
+
+  let(:test_type) { double(name: 'test') }
+
+  it 'should not raise error in passenger count' do
+    allow(QuickTravel::PassengerType).to receive(:find).and_return(test_type)
+    expect{ @reservation.passengers_count(@booking) }.not_to raise_error
+  end
+end