hotel_beds 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: def94cec45be31dc8a52150ee27a4d4ed43715c0
-  data.tar.gz: 9c608ab58056fc0906845519db57a6f48aec545f
+  metadata.gz: f4e1d67927848975b80e7a3dc3cd80654105e485
+  data.tar.gz: 65aadd0fb3f316987e34d5aa83dbe4c3d50319a6
 SHA512:
-  metadata.gz: 13fdfea5ec248841401c034cf574b0f349780b482a4ebbb1a70ce355e197c783a40b8cf2befe163a2e751bdd6c533767920454ac5200ba54abfe09f80e2ffad1
-  data.tar.gz: f49794c9d02dce57bc3d7c88b1e4ecd3468423e0bf20aa1687d2657ac2ecc3e112fda4efc1e84874b4b70f4e5f6ecfdb4dbb3bcfd63bd977ac9acf846a075b48
+  metadata.gz: 7a795daa686af484ce5bede7955a7133dddeece24b065f4da8c0d372c03671c9e3f3d311ed52b872bccda910524b5d4a8295d9320fcb5e14619ea2d6c45c5a6c
+  data.tar.gz: 5ba1daeadd74a320a985378997bd8f0cc9f670fd5f78051404dc0adf4fee4b8a29af12293d6e3ce66af91f6e9c56a68a21f66850fdd98f7d72e9354630d503fa

data/.tm_properties

@@ -0,0 +1,5 @@
+exclude = '{$exclude,tmp,pkg,Gemfile.lock,*.gem}'
+TM_STRIP_WHITESPACE_ON_SAVE = true
+
+tabSize = 2
+softTabs = true

data/INTERNALS.md

@@ -0,0 +1,9 @@
+# Grouping results
+
+The process we use to group results is as follows:
+
+1) Group the available rooms (AR) by occupants (OK)
+2) Expand the rooms (AR) in the array to illustrate the availability of each room (limit to a max of 5, as we don't support searches of more than 5 rooms)
+3) Group the count of each requested room (RC) by occupants (OK)
+4) For each group, determine all combinations of the available rooms (AR) for the given count (RC), this gives us the search results per room group (RSRG)
+5) Find all combinations of the search results per room group, giving us unique search results (SR)

data/README.md

@@ -18,7 +18,7 @@ Manually, via command line:
 
     # create the connection to HotelBeds
     client = HotelBeds::Client.new(endpoint: :test, username: "user", password: "pass")
-    
+
     # perform the search
     search = client.perform_hotel_search({
       check_in_date: Date.today,
@@ -26,7 +26,7 @@ Manually, via command line:
       rooms: [{ adult_count: 2 }],
       destination: "SYD"
     })
-    
+
     # inspect the response
     puts search.response.hotels
     # => [<HotelBeds::Model::Hotel>, <HotelBeds::Model::Hotel>]
@@ -35,6 +35,24 @@ Manually, via command line:
     puts search.response.current_page
     # => 1
 
+### Options
+
+The HotelBeds API will return individual rooms, rather than being grouped by what you searched for (e.g. 2 rooms, 1 with 2 adults, 1 with 1 adult and 1 child). To fix this issue, you can enable result grouping by adding `group_results: true` to the `perform_hotel_search` call.
+
+Example:
+
+    # perform the search
+    search = client.perform_hotel_search({
+      check_in_date: Date.today,
+      check_out_date: Date.today + 1,
+      rooms: [
+        { adult_count: 2 },
+        { adult_count: 1, child_count: 1, child_ages: [7] }
+      ],
+      destination: "SYD",
+      group_results: true
+    })
+
 ## Contributing
 
 1. [Fork it](https://github.com/platformq/hotel_beds/fork)

data/lib/hotel_beds/hotel_search/envelope.rb

@@ -12,7 +12,7 @@ module HotelBeds
           OccupancyList: occupancy_list
         }.merge(Hash(destination)).merge(Hash(hotels)).merge(Hash(extra_params))
       end
-      
+
       private
       def extra_params
         { ExtraParamList: {
@@ -27,7 +27,7 @@ module HotelBeds
           }]
         } }
       end
-      
+
       def pagination_data
         { :@pageNumber => Integer(page_number) }
       end
@@ -52,7 +52,7 @@ module HotelBeds
           } }
         end
       end
-      
+
       def hotels
         if Array(__getobj__.hotels).any?
           { HotelCodeList: {
@@ -61,20 +61,22 @@ module HotelBeds
           } }
         end
       end
-      
+
       def occupancy_list
-        Array(rooms).map do |room|
-          { HotelOccupancy: {
-            RoomCount: Integer(room.adult_count) + Integer(room.child_count),
-            Occupancy: {
+        { HotelOccupancy: Array(rooms).map { |room|
+          guest_list = if room.child_count > 0
+            { GuestList: { Customer: Array(room.child_ages).map { |age|
+              { :@type => "CH", :Age => Integer(age) }
+            } } }
+          end
+          {
+            RoomCount: 1,
+            Occupancy: (guest_list || Hash.new).merge({
               AdultCount: Integer(room.adult_count),
               ChildCount: Integer(room.child_count)
-            },
-            GuestList: Array(room.child_ages).each { |age|
-              { Customer: { :@type => "CH", :Age => Integer(age) } }
-            }
-          } }
-        end
+            })
+          }
+        } }
       end
     end
   end

data/lib/hotel_beds/hotel_search/operation.rb

@@ -7,14 +7,14 @@ module HotelBeds
     class Operation
       attr_accessor :request, :response, :errors
       private :request=, :response=, :errors=
-      
+
       def initialize(*args)
         self.request = Request.new(*args)
       end
-      
+
       def perform(connection:)
         if request.valid?
-          self.response = Response.new(retrieve(connection))
+          self.response = Response.new(request, retrieve(connection))
           self.errors = response.errors
         else
           self.errors = request.errors
@@ -22,11 +22,11 @@ module HotelBeds
         freeze
         self
       end
-      
+
       private
       def retrieve(connection)
         connection.call({
-          method: :getHotelValuedAvail, 
+          method: :getHotelValuedAvail,
           namespace: :HotelValuedAvailRQ,
           data: Envelope.new(request).attributes
         })

data/lib/hotel_beds/hotel_search/request.rb

@@ -3,14 +3,14 @@ require "hotel_beds/model"
 module HotelBeds
   module HotelSearch
     class Request
-      class Room    
+      class Room
         include HotelBeds::Model
-  
+
         # attributes
         attribute :adult_count, Integer, default: 0
         attribute :child_count, Integer, default: 0
         attribute :child_ages, Array[Integer], default: Array.new
-  
+
         # validation
         validates :adult_count, :child_count, numericality: {
           greater_than_or_equal_to: 0,
@@ -23,7 +23,7 @@ module HotelBeds
           end
         end
       end
-      
+
       include HotelBeds::Model
 
       # attributes
@@ -34,7 +34,8 @@ module HotelBeds
       attribute :destination, String
       attribute :hotels, Array[Integer]
       attribute :rooms, Array[Room]
-      
+      attribute :group_results, Virtus::Attribute::Boolean, default: false
+
       # validation
       validates :language, :destination, length: { is: 3 }
       validates :check_in_date, :check_out_date, presence: true

data/lib/hotel_beds/hotel_search/response.rb

@@ -1,13 +1,16 @@
 require "active_model/errors"
 require "hotel_beds/model/hotel"
+require "hotel_beds/model/available_room"
+require_relative "room_grouper"
 
 module HotelBeds
   module HotelSearch
     class Response
-      attr_accessor :headers, :body, :errors
-      private :headers=, :body=, :errors=
-      
-      def initialize(response)
+      attr_accessor :request, :headers, :body, :errors
+      private :request=, :headers=, :body=, :errors=
+
+      def initialize(request, response)
+        self.request = request
         self.headers = response.header
         self.body = Nokogiri::XML(response.body.fetch(:get_hotel_valued_avail))
         self.errors = ActiveModel::Errors.new(self).tap do |errors|
@@ -28,11 +31,11 @@ module HotelBeds
         end
         freeze
       end
-      
+
       def inspect
         "<#{self.class.name} errors=#{errors.inspect} headers=#{headers.inspect} body=#{body.to_s}>"
       end
-      
+
       def current_page
         if data = pagination_data
           Integer(data.attr("currentPage"))
@@ -40,7 +43,7 @@ module HotelBeds
           0
         end
       end
-      
+
       def total_pages
         if data = pagination_data
           Integer(data.attr("totalPages"))
@@ -48,7 +51,7 @@ module HotelBeds
           0
         end
       end
-      
+
       def hotels
         body.css("ServiceHotel").lazy.map do |hotel|
           HotelBeds::Model::Hotel.new({
@@ -57,37 +60,39 @@ module HotelBeds
             images: hotel.css("HotelInfo ImageList Image Url").map(&:content),
             latitude: hotel.at_css("HotelInfo Position").attr("latitude"),
             longitude: hotel.at_css("HotelInfo Position").attr("longitude"),
-            results: parse_available_rooms(hotel.css("AvailableRoom"))
+            results: generate_results(hotel.css("AvailableRoom"))
           })
         end
       end
-      
+
       private
       def pagination_data
         body.at_css("PaginationData")
       end
-          
-      def parse_available_rooms(rooms)
-        Array(rooms).map do |room|
-          {
-            adult_count: room.at_css("HotelOccupancy AdultCount").content,
-            child_count: room.at_css("HotelOccupancy ChildCount").content,
-            rooms: parse_hotel_rooms(room.css("HotelRoom"))
-          }
+
+      def generate_results(rooms)
+        parsed_rooms = parse_available_rooms(rooms)
+        if request.group_results?
+          parsed_rooms = RoomGrouper.new(request.rooms, parsed_rooms).results
+        end
+        parsed_rooms.map do |rooms|
+          HotelBeds::Model::SearchResult.new(rooms: Array(rooms))
         end
       end
 
-      def parse_hotel_rooms(rooms)
+      def parse_available_rooms(rooms)
         Array(rooms).map do |room|
-          {
-            number_available: room.attr("availCount"),
-            id: room.attr("SHRUI"),
-            description: room.at_css("RoomType").content,
-            board: room.at_css("Board").content,
-            price: ((room > "Price") > "Amount").first.content,
+          HotelBeds::Model::AvailableRoom.new({
+            id: room.at_css("HotelRoom").attr("SHRUI"),
+            adult_count: room.at_css("HotelOccupancy AdultCount").content,
+            child_count: room.at_css("HotelOccupancy ChildCount").content,
+            number_available: room.at_css("HotelRoom").attr("availCount"),
+            description: room.at_css("HotelRoom RoomType").content,
+            board: room.at_css("HotelRoom Board").content,
             currency: body.at_css("Currency").attr("code"),
+            price: ((room.at_css("HotelRoom") > "Price") > "Amount").first.content,
             rates: parse_price_list(room.css("Price PriceList Price"))
-          }
+          })
         end
       end
 

data/lib/hotel_beds/hotel_search/room_grouper.rb

@@ -0,0 +1,64 @@
+require "hotel_beds/model/search_result"
+
+# see INTERNALS.md for comment symbols
+module HotelBeds
+  module HotelSearch
+    class RoomGrouper < Struct.new(:requested_rooms, :response_rooms)
+      def results
+        if requested_rooms.size == 1
+          response_rooms.map { |room| [room] }
+        else
+          combined_available_rooms
+        end
+      end
+
+      private
+      # returns an array of room combinations for all rooms
+      def combined_available_rooms
+        room_groups = combine_available_rooms_by_occupants.values
+        head, *rest = room_groups
+        head.product(*rest).map { |rooms| rooms.flatten.sort_by(&:id) }.uniq
+      end
+
+      # returns a hash of OK => RSRG
+      def combine_available_rooms_by_occupants
+        group_requested_room_count_by_occupants.to_a.inject(Hash.new) do |result, (key, count)|
+          result[key] = group_rooms_by_occupants.fetch(key).combination(count).to_a
+          result
+        end
+      rescue KeyError => e
+        Hash.new
+      end
+
+      # returns a hash of OK => RC
+      def group_requested_room_count_by_occupants
+        requested_rooms.inject(Hash.new) do |result, room|
+          key = occupant_key(room)
+          result[key] ||= 0
+          result[key] += 1
+          result
+        end
+      end
+
+      # returns a hash of OK => AR
+      def group_rooms_by_occupants
+        @frozen_rooms ||= response_rooms.inject(Hash.new) do |result, room|
+          key = occupant_key(room)
+          result[key] ||= Array.new
+          1.upto([room.number_available, 5].min) do |i|
+            result[key].push(room)
+          end
+          result
+        end.freeze
+      end
+
+      # returns an OK for a given room
+      def occupant_key(room)
+        {
+          adult_count: room.adult_count,
+          child_count: room.child_count
+        }
+      end
+    end
+  end
+end

data/lib/hotel_beds/model.rb

@@ -5,6 +5,7 @@ module HotelBeds
   module Model
     def self.included(base)
       base.class_eval do
+        include Comparable
         include Virtus.model
         include ActiveModel::Validations
       end

data/lib/hotel_beds/model/available_room.rb

@@ -1,15 +1,25 @@
 require "hotel_beds/model"
-require_relative "hotel_room"
 
 module HotelBeds
   module Model
     class AvailableRoom
       include HotelBeds::Model
-    
+
       # attributes
-      attribute :rooms, Array[HotelRoom]
+      attribute :id, Integer
       attribute :adult_count, Integer
       attribute :child_count, Integer
+      attribute :description, String
+      attribute :board, String
+      attribute :price, BigDecimal
+      attribute :currency, String
+      attribute :number_available, Integer
+      attribute :rates, Hash[Date => BigDecimal]
+
+      # compare based on id
+      def <=>(other)
+        id == other.id && !id.nil?
+      end
     end
   end
 end

data/lib/hotel_beds/model/hotel.rb

@@ -1,5 +1,5 @@
 require "hotel_beds/model"
-require_relative "available_room"
+require_relative "search_result"
 
 module HotelBeds
   module Model
@@ -13,7 +13,7 @@ module HotelBeds
       attribute :stars, Integer
       attribute :longitude, BigDecimal
       attribute :latitude, BigDecimal
-      attribute :results, Array[AvailableRoom]
+      attribute :results, Array[SearchResult]
     end
   end
-end
+end

data/lib/hotel_beds/model/search_result.rb

@@ -0,0 +1,19 @@
+require "hotel_beds/model"
+require_relative "available_room"
+
+module HotelBeds
+  module Model
+    class SearchResult
+      include HotelBeds::Model
+
+      # attributes
+      attribute :rooms, Array[AvailableRoom]
+      attribute :currency, String
+
+      # results are purely based upon their combination of rooms
+      def <=>(other)
+        rooms.map(&:id).sort == other.rooms.map(&:id).sort
+      end
+    end
+  end
+end

data/lib/hotel_beds/version.rb

@@ -1,3 +1,3 @@
 module HotelBeds
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/features/grouped_hotel_search_spec.rb

@@ -0,0 +1,67 @@
+require "hotel_beds"
+
+RSpec.describe "performing a grouped hotel search" do
+  describe "#response" do
+    before(:all) do
+      @client = HotelBeds::Client.new({
+        endpoint: :test,
+        username: ENV.fetch("HOTEL_BEDS_USERNAME"),
+        password: ENV.fetch("HOTEL_BEDS_PASSWORD"),
+        proxy: ENV.fetch("HOTEL_BEDS_PROXY", nil)
+      })
+      @check_in_date = Date.today + 28 + rand(10)
+      @check_out_date = @check_in_date + rand(3) + rand(2) + 1
+      @operation = @client.perform_hotel_search({
+        check_in_date: @check_in_date,
+        check_out_date: @check_out_date,
+        rooms: [
+          { adult_count: 2 },
+          { adult_count: 1, child_count: 1, child_ages: [rand(17)] }
+        ],
+        destination: "SYD",
+        group_results: true
+      })
+      if @operation.errors.any?
+        raise StandardError, @operation.errors.full_messages.join("\n")
+      end
+      @response = @operation.response
+    end
+
+    let(:check_in_date) { @check_in_date }
+    let(:check_out_date) { @check_out_date }
+    let(:response) { @response }
+
+    describe "#errors" do
+      subject { response.errors }
+
+      it "should be empty" do
+        expect(subject).to be_empty
+      end
+    end
+
+    describe "#hotels" do
+      subject { response.hotels }
+
+      it "should have room counts to match the searched room count" do
+        room_counts = subject.map { |h| h.results.map { |r| r.rooms.size } }
+        expect(room_counts.to_a.flatten.uniq).to eq([response.request.rooms.size])
+      end
+    end
+
+    describe "#current_page" do
+      subject { response.current_page }
+
+      it "should return '1'" do
+        expect(subject).to eq(1)
+      end
+    end
+
+    describe "#total_pages" do
+      subject { response.total_pages }
+
+      it "should be greater or equal to current page" do
+        expect(subject).to be >= response.current_page
+      end
+    end
+  end
+end

data/spec/features/hotel_search_spec.rb

@@ -25,12 +25,12 @@ RSpec.describe "performing a hotel search" do
 
     describe "#errors" do
       subject { response.errors }
-      
+
       it "should be empty" do
         expect(subject).to be_empty
       end
     end
-    
+
     describe "#hotels" do
       subject { response.hotels }
 
@@ -39,18 +39,23 @@ RSpec.describe "performing a hotel search" do
         expect(subject.to_a).to_not be_empty
         expect(subject.first).to be_kind_of(HotelBeds::Model::Hotel)
       end
-      
+
       it "should parse the rates correctly" do
         room = subject.first.results.first.rooms.first
         expect(room.price).to eq(room.rates.values.inject(:+))
       end
-      
+
       it "should have the same number of rates as nights requested" do
         room = subject.first.results.first.rooms.first
         expect(room.rates.size).to eq(check_out_date - check_in_date)
       end
+
+      it "should only have one room per result" do
+        room_counts = subject.map { |h| h.results.map { |r| r.rooms.size } }
+        expect(room_counts.to_a.flatten.uniq).to eq([1])
+      end
     end
-  
+
     describe "#current_page" do
       subject { response.current_page }
 
@@ -58,7 +63,7 @@ RSpec.describe "performing a hotel search" do
         expect(subject).to eq(1)
       end
     end
-  
+
     describe "#total_pages" do
       subject { response.total_pages }
 

data/spec/lib/hotel_beds/hotel_search/room_grouper_spec.rb

@@ -0,0 +1,45 @@
+require "hotel_beds/hotel_search/room_grouper"
+
+RSpec.describe HotelBeds::HotelSearch::RoomGrouper do
+  subject { described_class.new(requested_rooms, response_rooms).results }
+
+  context "when asking for 2 rooms (2 adults & 1 adult, 1 child)" do
+    let(:requested_rooms) do
+      [
+        double(:requested_room, adult_count: 2, child_count: 0),
+        double(:requested_room, adult_count: 1, child_count: 1)
+      ]
+    end
+
+    let(:response_rooms) do
+      [
+        double(:response_room_1, id: "room_1", adult_count: 2, child_count: 0, number_available: 1),
+        double(:response_room_2, id: "room_2", adult_count: 2, child_count: 0, number_available: 1),
+        double(:response_room_3, id: "room_3", adult_count: 1, child_count: 1, number_available: 2),
+        double(:response_room_4, id: "room_4", adult_count: 1, child_count: 1, number_available: 1),
+        double(:response_room_5, id: "room_5", adult_count: 2, child_count: 0, number_available: 2)
+      ]
+    end
+
+    it "should return 6 results" do
+      expect(subject.size).to eq(6)
+    end
+  end
+
+  context "when asking for 1 rooms (1 adult, 1 child)" do
+    let(:requested_rooms) do
+      [double(:requested_room, adult_count: 1, child_count: 1)]
+    end
+
+    let(:response_rooms) do
+      [
+        double(:response_room_1, id: "room_1", adult_count: 1, child_count: 1, number_available: 2),
+        double(:response_room_2, id: "room_2", adult_count: 1, child_count: 1, number_available: 1)
+      ]
+    end
+
+    it "should return 2 results" do
+      expect(subject.size).to eq(2)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotel_beds
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryan Townsend
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -162,8 +162,10 @@ files:
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".tm_properties"
 - Gemfile
 - Guardfile
+- INTERNALS.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -176,16 +178,19 @@ files:
 - lib/hotel_beds/hotel_search/operation.rb
 - lib/hotel_beds/hotel_search/request.rb
 - lib/hotel_beds/hotel_search/response.rb
+- lib/hotel_beds/hotel_search/room_grouper.rb
 - lib/hotel_beds/model.rb
 - lib/hotel_beds/model/available_room.rb
 - lib/hotel_beds/model/hotel.rb
-- lib/hotel_beds/model/hotel_room.rb
+- lib/hotel_beds/model/search_result.rb
 - lib/hotel_beds/version.rb
+- spec/features/grouped_hotel_search_spec.rb
 - spec/features/hotel_search_spec.rb
 - spec/lib/hotel_beds/client_spec.rb
 - spec/lib/hotel_beds/configuration_spec.rb
 - spec/lib/hotel_beds/connection_spec.rb
 - spec/lib/hotel_beds/hotel_search/request_spec.rb
+- spec/lib/hotel_beds/hotel_search/room_grouper_spec.rb
 - spec/lib/hotel_beds/version_spec.rb
 - spec/spec_helper.rb
 homepage: https://www.hotelsindex.com/open-source
@@ -213,10 +218,12 @@ signing_key:
 specification_version: 4
 summary: Interfaces with the HotelBeds SOAP API to book hotel rooms
 test_files:
+- spec/features/grouped_hotel_search_spec.rb
 - spec/features/hotel_search_spec.rb
 - spec/lib/hotel_beds/client_spec.rb
 - spec/lib/hotel_beds/configuration_spec.rb
 - spec/lib/hotel_beds/connection_spec.rb
 - spec/lib/hotel_beds/hotel_search/request_spec.rb
+- spec/lib/hotel_beds/hotel_search/room_grouper_spec.rb
 - spec/lib/hotel_beds/version_spec.rb
 - spec/spec_helper.rb

data/lib/hotel_beds/model/hotel_room.rb

@@ -1,18 +0,0 @@
-require "hotel_beds/model"
-
-module HotelBeds
-  module Model
-    class HotelRoom
-      include HotelBeds::Model
-
-      # attributes
-      attribute :id, Integer
-      attribute :description, String
-      attribute :board, String
-      attribute :price, BigDecimal
-      attribute :currency, String
-      attribute :number_available, Integer
-      attribute :rates, Hash[Date => BigDecimal]
-    end
-  end
-end