quicktravel_client 1.1.2 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: badf664a3d19487397626b95ca573f2feb995944
+  data.tar.gz: 11cd881dc671aa773918e21789acbc173ca8f7e6
+SHA512:
+  metadata.gz: be1c4c52240989bcefa2c3a5b9155f9edf11f112fa73f52a9e23bcb15fe8e3d485961f3641865172253377898954f5bf0ea7f611190fe4badc6f80d5aaa1c51b
+  data.tar.gz: a49216933d018771fd9a8f885818d990179a7377c6b71eabf6d4be19b84c481fd6587b083addbc55fdc587c6854ecdfa5d2e5a61ab175f982b42ac523f230ad9

data/.gitignore

@@ -23,3 +23,8 @@ tmp
 /tags
 /.tags
 /TAGS
+
+# Gems
+/vendor/ruby
+.bundle
+

data/.ruby-version

@@ -1 +1 @@
-ruby-1.9.3-p551
+2.2.4

data/.travis.yml

@@ -1,12 +1,24 @@
 language: ruby
 rvm:
   - 1.9
-script: "bundle && bundle exec rake coverage"
+  - 2.2
+  - 2.3.0
+script: bundle && bundle exec rake spec
 gemfile:
   - gemfiles/rails2.gemfile
+  - gemfiles/rails4.gemfile
 matrix:
   exclude:
+    - rvm: 1.9
+      gemfile: gemfiles/rails4.gemfile
+    - rvm: 2.2
+      gemfile: gemfiles/rails2.gemfile
+    - rvm: 2.3.0
+      gemfile: gemfiles/rails2.gemfile
 notifications:
   email:
     - support@travellink.com.au
-  flowdock: e69dcafad1fea15c6b8c76e9ced965af
+  flowdock:
+    secure: tIc3OVnTl83tGjhjzBSPk7AMRHVta4zAdacBDWOVA3s/YpDoa1wCMaq7xfG7GlEgHtPscvucSKbxoLocBd5d54jQVx3X9q9OrQ91D6h6tbTOK8ZTh1vTdSfMkIoxNjnVJ9KyZYJ3zy44DzfzgmcgqesshqSrXAgcpSvxkEcjAz8=
+sudo: false
+cache: bundler

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # 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/).
 
-## [Unreleased]
-###
-- [DC-2147] Update resources api for CCC
+## [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/Gemfile

@@ -1,5 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-
-# TODO: Give money extensions proper versioning and release it
-gem 'money_extensions', github: 'sealink/money_extensions', branch: 'master'

data/Rakefile

@@ -10,9 +10,3 @@ RSpec::Core::RakeTask.new do |t|
   t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
   # Put spec opts in a file named .rspec in root
 end
-
-desc "Generate SimpleCov test coverage and open in your browser"
-task :coverage do
-  ENV['COVERAGE'] = 'true'
-  Rake::Task['spec'].invoke
-end

data/examples/login_example.rb

@@ -14,7 +14,7 @@ password = gets.chomp
 puts "Ok #{login}, just a tick..."
 result = begin
   QuickTravel::Party.login(login: login, password: password)
-rescue QuickTravel::AdapterException
+rescue QuickTravel::AdapterError
   nil
 end
 

data/gemfiles/rails4.gemfile

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

data/lib/quick_travel.rb

@@ -8,8 +8,9 @@ module QuickTravel
   require 'quick_travel/cache'
   require 'quick_travel/config'
   require 'quick_travel/adapter'
-  require 'quick_travel/adapter_exception'
+  require 'quick_travel/adapter_error'
   require 'quick_travel/connection_error'
+  require 'quick_travel/status'
 
   # Don't include this guy: pull the pieces into the classes that use it, or ref
   require 'quick_travel/constants'

data/lib/quick_travel/accommodation.rb

@@ -4,21 +4,7 @@ require 'quick_travel/room_facility'
 
 module QuickTravel
   class Accommodation < Adapter
-    # TODO: find a dynamic way to provide getter/setters for all data members instead of writing all of them.
-
-    attr_accessor :book_before_level, :book_before_units, :bookable_individually, :bookable_online, :booking_notes, :code, :created_at
-    attr_accessor :days_before_inventory_expires, :default_capacity, :deposit_id, :disclaimer_id, :expiry_level, :expiry_units, :fare_basis_pointer_id
-    attr_accessor :frequent_traveller_points_multiplier, :guardian_minimum_age, :id, :inline_cost_in_cents, :inline_price_in_cents, :inline_pricing
-    attr_accessor :inventory_type, :active, :location_id, :masterpoint_resource_id, :maximum_occupancy, :maximum_passengers, :maximum_passengers_online
-    attr_accessor :maximum_weight, :minimum_age, :minimum_passengers, :name, :no_expiry, :non_commissionable, :on_request_after_inventory_expiration
-    attr_accessor :overriding_passenger_ticket_format_id, :overriding_reservation_ticket_format_id, :overriding_vehicle_ticket_format_id
-    attr_accessor :product_type_id, :property_id, :property_type_id, :reason_required, :report_changes, :required_number_of_vehicles
-    attr_accessor :resource_category_id, :restrict_to_client_types, :star_rating, :type, :unlimited_uses, :updated_at, :uses, :vendor_id
-    attr_accessor :availability, :minimum_bookable_duration, :description,
-                  :minimum_price, :nightly_price
-    attr_accessor :on_request
-    attr_accessor :error
-
+    attr_reader :error
     attr_reader :bed_configurations, :room_facilities
 
     MAX_DAYS = 8

data/lib/quick_travel/adapter.rb

@@ -3,17 +3,14 @@ require 'pp'
 require 'json'
 require 'active_support/core_ext'
 require 'money'
-require 'money_extensions/money_field'
 
 require 'quick_travel/config'
-require 'quick_travel/adapter_exception'
+require 'quick_travel/adapter_error'
 require 'quick_travel/init_from_hash'
 
 module QuickTravel
   class Adapter
-    include HTTParty
     include QuickTravel::InitFromHash
-    include MoneyField
 
     class_attribute :api_base, :lookup
 
@@ -28,10 +25,25 @@ module QuickTravel
 
     def initialize(hash = {})
       return nil if hash.blank?
+      define_readers(hash.keys)
       super(Parser.new(hash).parsed_attributes)
     end
 
+    def define_readers(keys)
+      keys.each do |key|
+        next if respond_to?(key)
+        define_singleton_method(key) { instance_variable_get("@#{key}") }
+        if key.to_s.ends_with? '_cents'
+          name = key.to_s.gsub(/_in_cents$/, '')
+          define_singleton_method(name) {
+            Money.new(instance_variable_get("@#{key}"))
+          }
+        end
+      end
+    end
+
     def self.find(id, opts = {})
+      check_id!(id)
       if lookup
         all.detect { |o| o.id == id.to_i }
       else
@@ -41,9 +53,7 @@ module QuickTravel
 
     def self.all(opts = {})
       if lookup
-        QuickTravel::Cache.cache("#{name}.all") {
-          find_all!("#{api_base}.json", opts)
-        }
+        find_all!("#{api_base}.json", opts.merge(cache: "#{name}.all-attrs"))
       else
         find_all!("#{api_base}.json", opts)
       end
@@ -54,6 +64,7 @@ module QuickTravel
     end
 
     def self.update(id, options = {})
+      check_id!(id)
       put_and_validate("#{api_base}/#{id}.json", options)
     end
 
@@ -72,18 +83,28 @@ module QuickTravel
 
     protected
 
-    # Find first
-    def self.generic_first(request_path, opts = {})
-      find_all!(request_path, opts).first
+    def self.check_id!(id)
+      Integer(id)
+    rescue ArgumentError, # if invalid string
+           TypeError # if nil
+      fail ArgumentError, 'id must be an integer'
     end
 
     def self.find_all!(request_path, opts = {})
-      response = get_and_validate(request_path, opts, return_response_object: true)
+      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
 
-      deserializer = Deserializer.new(response.parsed_response)
+      deserializer = Deserializer.new(parsed_response)
       objects = Array.wrap(deserializer.extract_under_root(self))
 
-      if response.headers['pagination'].present?
+      if full_response && 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)
@@ -112,18 +133,16 @@ module QuickTravel
         self.class.extract(collection_data, klass, opts)
       end
 
-      def self.extract(objects, klass, opts = {})
-        objects = Array.wrap(objects)
-        objects.map! { |item| item[opts[:object_key_name]] } if opts[:object_key_name]
-        objects.map! { |item| klass.new(item) }
-
-        # if opts[:page] && opts[:per_page]
-        # objects = WillPaginate::Collection.create(opts[:page], opts[:per_page], opts).replace(objects)
-        objects
+      def self.extract(raw_objects, klass, opts = {})
+        objects = Array.wrap(raw_objects)
+        if opts[:object_key_name]
+          objects = objects.map { |item| item[opts[:object_key_name]] }
+        end
+        objects.map { |item| klass.new(item) }
       end
     end
 
-    # The above generic_first find_all and the above find
+    # The above find_all and the above find
     # all suck
     #
     # We should make it standard behaviour that objects
@@ -171,10 +190,58 @@ module QuickTravel
       call_and_validate(:delete, path, query, opts)
     end
 
+    def self.call_and_validate(http_method, path, query = {}, opts = {})
+      Api.call_and_validate(http_method, path, query, opts)
+    end
+
+    def self.base_uri(uri = nil)
+      Api.base_uri uri
+    end
+  end
+
+  class Parser
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def attributes
+      @attributes ||= {}
+    end
+
+    def parsed_attributes
+      @parsed_attributes ||= parse_attributes
+    end
+
+    private
+
+    def parse_attributes
+      attributes.map.with_object({}) do |(attribute, value), hash|
+        hash[attribute] = parse(attribute, value)
+      end
+    end
+
+    def parse(attribute, value)
+      return nil if value.nil?
+      return convert(value, :to_date) if attribute.to_s.ends_with?('_date')
+      return convert(value, :to_date) if attribute.to_s.ends_with?('_on')
+      # to_datetime as it converts to app time zone, to_time converts to system time zone
+      return convert(value, :to_datetime) if attribute.to_s.ends_with?('_time')
+      return convert(value, :to_datetime) if attribute.to_s.ends_with?('_at')
+      value
+    end
+
+    def convert(value, conversion_method)
+      convertable_value = value.is_a?(Hash) ? value['_value'] : value
+      convertable_value.send(conversion_method)
+    end
+  end
+
+  class Api
+    include HTTParty
+
     def self.call_and_validate(http_method, path, query = {}, opts = {})
       http_params = opts.clone
       return_response_object = http_params.delete(:return_response_object)
-      klass = self
 
       # Set default token
       http_params[:query] ||= query
@@ -193,7 +260,7 @@ module QuickTravel
       http_params[:follow_redirects] = false
 
       begin
-        response = klass.send(http_method, path, http_params)
+        response = self.send(http_method, path, http_params)
       rescue Errno::ECONNREFUSED
         raise ConnectionError.new('Connection refused')
       rescue SocketError
@@ -203,7 +270,7 @@ module QuickTravel
       end
 
       if expect && expect == :json && !response.is_a?(Hash)
-        fail AdapterException, <<-FAIL
+        fail AdapterError, <<-FAIL
           Request expected to be json but failed. Debug information below:
           http_method: #{http_method.inspect}
           path: #{path.inspect}
@@ -213,7 +280,7 @@ module QuickTravel
         FAIL
       end
 
-      klass.validate!(response)
+      validate!(response)
 
       if return_response_object
         response
@@ -228,14 +295,14 @@ module QuickTravel
     # Secondly, check for presence of "error" key in returned hash
     def self.validate!(response)
       case response.code
-        when 300..399 # redirects
-          fail ConnectionError.new('We were redirected. QT YML configuration appears to be incorrect. Verify your URL and API.')
-        when 400..599 # client and server errors
-          fail AdapterException.new(response)
+      when 300..399 # redirects
+        fail ConnectionError.new('We were redirected. QT YML configuration appears to be incorrect. Verify your URL and API.')
+      when 400..599 # client and server errors
+        fail AdapterError.new(response)
       end
 
       if response_contains_error?(response)
-        fail AdapterException, response
+        fail AdapterError, response
       end
     end
 
@@ -244,40 +311,4 @@ module QuickTravel
       parsed_response.is_a?(Hash) && parsed_response.key?('error')
     end
   end
-
-  class Parser
-    def initialize(attributes)
-      @attributes = attributes
-    end
-
-    def attributes
-      @attributes ||= {}
-    end
-
-    def parsed_attributes
-      @parsed_attributes ||= parse_attributes
-    end
-
-    private
-
-    def parse_attributes
-      attributes.map.with_object({}) do |(attribute, value), hash|
-        hash[attribute] = parse(attribute, value)
-      end
-    end
-
-    def parse(attribute, value)
-      return nil if value.nil?
-      return convert(value, :to_date) if attribute.to_s.ends_with?('_date')
-      # to_datetime as it converts to app time zone, to_time converts to system time zone
-      return convert(value, :to_datetime) if attribute.to_s.ends_with?('_time')
-      return convert(value, :to_datetime) if attribute.to_s.ends_with?('_at')
-      value
-    end
-
-    def convert(value, conversion_method)
-      convertable_value = value.is_a?(Hash) ? value['_value'] : value
-      convertable_value.send(conversion_method)
-    end
-  end
 end

data/lib/quick_travel/{adapter_exception.rb → adapter_error.rb}

@@ -1,5 +1,5 @@
 module QuickTravel
-  class AdapterException < Exception
+  class AdapterError < StandardError
     attr_reader :response
 
     def initialize(response)

data/lib/quick_travel/address.rb

@@ -3,13 +3,8 @@ require 'geokit'
 
 module QuickTravel
   class Address < Adapter
-    attr_accessor :address_line1, :address_line2, :city, :country_id, :id, :post_code, :state, :country_name
-
-    def initialize(hash)
-      super(hash)
-      if @country_id == AUSTRALIA_COUNTRY_ID
-        @country_name = 'Australia'
-      end
+    def country_name
+      QuickTravel::Country.find(@country_id).name
     end
 
     def geocode