quicktravel_client 4.2.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91f206668887a5c5fae84eceedf3aff502b18e7fe9128c532f2945c1103e8d22
-  data.tar.gz: 46897c6a9d0bf5934c1c6f0c9333c33ddce9d9e8412f8551a089c041f181ed8f
+  metadata.gz: e0325799c230cd8fe94a4f7454f8ff7ccb5fddb27ab18a67b9f3096d72aada02
+  data.tar.gz: 427ad145f755aa347c5ceb6d1c558b9e47392d1e61f48daeac074b933d7ded30
 SHA512:
-  metadata.gz: 49878c0a691f3794d4fc840d81078099c5235f18845405e1bd1868f1737aec01e25bda51766ed020c27d2e95cb4086d2ddba6f854048c324e4da1b2ab7bb3bf2
-  data.tar.gz: 31ab91f4e630f3d5a5e8c04a2ae159fab5a555ed937ecd1880a852955201b26e83f5a86659d31d36b9e68c502c31e0e69cd779f4290f7f850ed98ed436664d7b
+  metadata.gz: 744fc85a1f7bf032a494eb394c1573f06c0a1094608da175f7fc20c053babf78a8950bf038ff0b6dff97a0926f70492b96db2481083aa9055590f9fd8bdd33ac
+  data.tar.gz: 42f9a4aefc2150631c807a96bfaad03b8a0b6ff9c1427980435bd5a35818dadb84929b715199c47c2f02093be211b5f1565ef9957087129f5feed7398768bbae

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec rake
+
+  release:
+    needs: build
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Generate Changelog
+        run: |
+          # Get version from github ref (remove 'refs/tags/' and prefix 'v')
+          version="${GITHUB_REF#refs/tags/v}"
+          npx changelog-parser CHANGELOG.md | jq -cr ".versions | .[] | select(.version == \"$version\") | .body" > ${{ github.workflow }}-CHANGELOG.txt
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: ${{ github.workflow }}-CHANGELOG.txt
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: [build, release]
+    name: Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,19 @@
+name: Build and Test
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: [rails60, rails61]
+        ruby: ["2.6", "2.7", "3.0"]
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.0

data/CHANGELOG.md

@@ -3,6 +3,29 @@ 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
+
+## [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

data/README.md

@@ -1,10 +1,8 @@
-QuickTravel
-===========
+# QuickTravel
 
 [![Gem Version](https://badge.fury.io/rb/quicktravel_client.svg)](http://badge.fury.io/rb/quicktravel_client)
-[![Build Status](https://travis-ci.org/sealink/quicktravel_client.svg?branch=master)](https://travis-ci.org/sealink/quicktravel_client)
+[![Build Status](https://github.com/sealink/quicktravel_client/workflows/Build%20and%20Test/badge.svg?branch=master)](https://github.com/sealink/quicktravel_client/actions)
 [![Coverage Status](https://coveralls.io/repos/sealink/quicktravel_client/badge.svg)](https://coveralls.io/r/sealink/quicktravel_client)
-[![Dependency Status](https://gemnasium.com/sealink/quicktravel_client.svg)](https://gemnasium.com/sealink/quicktravel_client)
 [![Code Climate](https://codeclimate.com/github/sealink/quicktravel_client/badges/gpa.svg)](https://codeclimate.com/github/sealink/quicktravel_client)
 
 # DESCRIPTION
@@ -14,17 +12,38 @@ Gives models that are integrated with the QuickTravel API
 # INSTALLATION
 
 Add to your Gemfile:
+
+```
 gem 'quicktravel_client'
+```
 
 # REGENERATE CASSETTES
 
 In QuickTravel:
+```
 mysql quicktravel_test < ../quicktravel_test/bootstrap.sql
 TIMECOP=1 WEBMOCK=0 QUICKTRAVEL_CONFIG_DIR=spec/support/config RAILS_ENV=test bundle exec rails s -p8080
+```
 
 In Payment Service: (if needing to generate checkout cassettes):
+```
 bundle exec puma -Ilib -p7000
+```
 
 In QuickTravel Client:
+```
 rm spec/support/cassettes/ -rf
 QT_KEYS=a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2,1b0a9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a bundle exec rspec
+```
+
+# RELEASE
+
+To publish a new version of this gem the following steps must be taken.
+
+* Update the version in the following files
+  ```
+    CHANGELOG.md
+    lib/quick_travel/version.rb
+  ````
+* Create a tag using the format v0.1.0
+* Follow build progress in GitHub actions

data/gemfiles/rails61.gemfile

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

data/lib/quick_travel/adapter.rb

@@ -9,6 +9,7 @@ require 'facets/hash/delete_values'
 require 'quick_travel/config'
 require 'quick_travel/adapter_error'
 require 'quick_travel/init_from_hash'
+require 'quick_travel/version'
 
 module QuickTravel
   class Adapter
@@ -214,6 +215,9 @@ module QuickTravel
       http_params[:headers] ||= {}
       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)
 
       # Use :body instead of :query for put/post.
@@ -251,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/party.rb

@@ -7,9 +7,10 @@ module QuickTravel
 
     def initialize(hash = {})
       super
-      if type.blank?
-        @type = 'Person'
-      end
+      # TODO Fix the QT endpoint to actual return the type, first step
+      # is to revert it so we can fix the pacts, than we can update the
+      # expectations to include a return value
+      @type = 'Person'
     end
 
     self.api_base = '/parties'
@@ -18,6 +19,10 @@ module QuickTravel
       get_and_validate('/parties/find_by_login.json', options)
     end
 
+    def self.create(options = {})
+      post_and_validate("/api/parties.json", options)
+    end
+
     # Asks QuickTravel to check the credentials
     #
     # @returns: Party: Valid Credentials

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.2.0'
+  VERSION = '4.5.0'
 end

data/quicktravel_client.gemspec

@@ -15,6 +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.add_dependency 'httparty', '>= 0.18.1'
   spec.add_dependency 'activesupport', '>= 5.0.0'
@@ -34,5 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'travis'
+  spec.add_development_dependency 'pry'
 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.2.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Michael Noack
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -251,7 +251,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: travis
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -270,11 +270,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -282,8 +284,8 @@ files:
 - Rakefile
 - examples/example_config.rb
 - examples/login_example.rb
-- gemfiles/rails5.gemfile
-- gemfiles/rails6.gemfile
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
 - lib/extensions.rb
 - lib/quick_travel.rb
 - lib/quick_travel/accommodation.rb
@@ -450,14 +452,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Booking process using QuickTravel API

data/.travis.yml

@@ -1,16 +0,0 @@
-language: ruby
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-before_install:
-  - gem install bundler
-script: bundle && bundle exec rspec spec
-gemfile:
-  - gemfiles/rails5.gemfile
-  - gemfiles/rails6.gemfile
-notifications:
-  email:
-    - support@travellink.com.au
-sudo: false
-cache: bundler

data/gemfiles/rails5.gemfile

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