hotel_beds 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d1e73612f9067924e5217e9a6ac519114c3c0f
-  data.tar.gz: 3d73a53b48fc47773dc9d11b54f1d2d97862586c
+  metadata.gz: b442fa8e1dd84060190628131cdc1411cd170780
+  data.tar.gz: 3f0e1420814abb2208119060056f66f813ef32e2
 SHA512:
-  metadata.gz: fcd299beabb15ae42f27b1398fb88db2d4901ab80a06987b35182d0fc494421377b7d8abf3d6d496627c0af469e98994c32c91ba79c5a8e89ad1d239caa311c9
-  data.tar.gz: 6613c409737fc9b5b75d946a7681e1ee5555bef3a9422d2e5e128d9c77945db776e89c93abbb72d61bbd2ce9d7de4e6c2ecaeb947b7785eec97dea84959b6a6c
+  metadata.gz: 873348c0c1b44e5218efd5f0f784cf6c235ea9e61327f312b40e474925e99a04d7406fcf882ecafa447d4bed2742fc4687a4247293824898c763608eb2f9bd48
+  data.tar.gz: 9405c30f24d1b2fd0e4428f70ed96205059ed97dd4b0f3143fa6d4036d7dd8f960c5e6a62da847621c17d5af6d251b138983bbbcc2adda9dfaef2bb69a7e71b2

data/INTERNALS.md

@@ -7,3 +7,9 @@ The process we use to group results is as follows:
 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)
+
+# Basket
+
+HotelBeds effectively has a basket system (known as the "ServiceAdd" API), as it covers more than just hotel rooms.
+
+The "contract remarks" or terms and conditions it returns must be presented to the customer before the basket is checked-out.

data/README.md

@@ -16,24 +16,48 @@ Manually, via command line:
 
 ## Usage
 
-    # 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,
-      check_out_date: Date.today + 1,
-      rooms: [{ adult_count: 2 }],
-      destination: "SYD"
-    })
-
-    # inspect the response
-    puts search.response.hotels
-    # => [<HotelBeds::Model::Hotel>, <HotelBeds::Model::Hotel>]
-    puts search.response.total_pages
-    # => 10
-    puts search.response.current_page
-    # => 1
+```ruby
+# 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,
+  check_out_date: Date.today + 1,
+  rooms: [{ adult_count: 2 }],
+  destination: "SYD"
+})
+
+# inspect the response
+puts search.response.hotels
+# => [<HotelBeds::Model::Hotel>, <HotelBeds::Model::Hotel>]
+puts search.response.total_pages
+# => 10
+puts search.response.current_page
+# => 1
+
+# place a booking
+booking = client.perform_hotel_booking({
+  room_ids: [search.response.hotels.first.results.first.id],
+  people: [
+    { title: "Mr", name: "David Smith", type: :adult },
+    { title: "Mrs", name: "Jane Smith", type: :adult }
+  ],
+  address: {
+    line_1: "123 Some Street",
+    city: "Townsville",
+    state: "New Statestown",
+    postcode: "NS1 1AB"
+    country: "UK"
+  },
+  phone_number: "+44 1234 567 890",
+  email: "david.smith@example.com"
+})
+
+# inspect the response
+puts booking.response.reference
+# => "ABC-123"
+```
 
 ### Options
 
@@ -41,17 +65,19 @@ The HotelBeds API will return individual rooms, rather than being grouped by wha
 
 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
-    })
+```ruby
+# 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
 

data/lib/hotel_beds/client.rb

@@ -1,6 +1,7 @@
 require "hotel_beds/configuration"
 require "hotel_beds/connection"
 require "hotel_beds/hotel_search/operation"
+require "hotel_beds/hotel_basket_add/operation"
 
 module HotelBeds
   class Client
@@ -12,13 +13,20 @@ module HotelBeds
       self.connection = Connection.new(configuration)
       freeze
     end
-    
-    # builds and performs a hotel search, returning an operation object which
-    # contains both the request and response objects.
+
+    # each method returns an operation object which contains both the
+    # request and response objects.
+
     def perform_hotel_search(*args)
       HotelSearch::Operation.new(*args).perform(
         connection: connection
       )
     end
+
+    def add_hotel_room_to_basket(*args)
+      HotelBasketAdd::Operation.new(*args).perform(
+        connection: connection
+      )
+    end
   end
 end

data/lib/hotel_beds/connection.rb

@@ -18,7 +18,6 @@ module HotelBeds
         :"@xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
         :"@xsi:schemaLocation" => "http://www.hotelbeds.com/schemas/2005/06/messages #{namespace}.xsd",
         :@echoToken => SecureRandom.hex[0..15],
-        :@sessionId => SecureRandom.hex[0..15],
         :Credentials => {
           User: configuration.username,
           Password: configuration.password
@@ -34,7 +33,7 @@ module HotelBeds
         message: message
       })
     end
-    
+
     private
     def initialize_client
       Savon::Client.new do |config|
@@ -70,4 +69,4 @@ module HotelBeds
       end
     end
   end
-end
+end

data/lib/hotel_beds/hotel_basket_add/envelope.rb

@@ -0,0 +1,71 @@
+require "delegate"
+
+module HotelBeds
+  module HotelBasketAdd
+    class Envelope < SimpleDelegator
+      def attributes
+        {
+          Language: language,
+          Service: {
+            :"@xsi:type" => "ServiceHotel",
+            :"@availToken" => service.availability_token,
+            :ContractList => { Contract: {
+              Name: service.contract_name,
+              IncomingOffice: { :@code => service.contract_incoming_office_code }
+            } },
+            :DateFrom => { :@date => service.check_in_date.strftime("%Y%m%d") },
+            :DateTo => { :@date => service.check_out_date.strftime("%Y%m%d") },
+            :HotelInfo => {
+              Code: service.hotel_code,
+              Destination: {
+                :@code => service.destination_code,
+                :@type => "SIMPLE"
+              }
+            },
+            :AvailableRoom => available_rooms
+          }
+        }
+      end
+
+      private
+      def available_rooms
+        Array(service.rooms).group_by(&:group_key).values.map do |rooms|
+          {
+            HotelOccupancy: build_room(rooms),
+            HotelRoom: {
+              Board: {
+                :@code => rooms.first.board_code,
+                :@type => "SIMPLE"
+              },
+              RoomType: {
+                :@code => rooms.first.room_type_code,
+                :@characteristic => rooms.first.room_type_characteristic,
+                :@type => "SIMPLE"
+              },
+            }
+          }
+        end
+      end
+
+      def build_room(rooms)
+        child_ages = rooms.map(&:child_ages).inject(Array.new, :+)
+        adult_count = rooms.map(&:adult_count).inject(0, :+)
+        child_count = rooms.map(&:child_count).inject(0, :+)
+        {
+          RoomCount: rooms.size,
+          Occupancy: {
+            AdultCount: adult_count,
+            ChildCount: child_count,
+            GuestList: {
+              Customer: (1..adult_count).map {
+                { :@type => "AD" }
+              } + (1..child_count).map { |i|
+                { :@type => "CH", :Age => Integer(child_ages[i - 1]) }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/hotel_beds/hotel_basket_add/operation.rb

@@ -0,0 +1,36 @@
+require_relative "request"
+require_relative "response"
+require_relative "envelope"
+
+module HotelBeds
+  module HotelBasketAdd
+    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(request, retrieve(connection))
+          self.errors = response.errors
+        else
+          self.errors = request.errors
+        end
+        freeze
+        self
+      end
+
+      private
+      def retrieve(connection)
+        connection.call({
+          method: :serviceAdd,
+          namespace: :ServiceAddRQ,
+          data: Envelope.new(request).attributes
+        })
+      end
+    end
+  end
+end

data/lib/hotel_beds/hotel_basket_add/request.rb

@@ -0,0 +1,49 @@
+require "securerandom"
+require "hotel_beds/model"
+require "hotel_beds/model/available_room"
+
+module HotelBeds
+  module HotelBasketAdd
+    class Request
+      class HotelService
+        include HotelBeds::Model
+
+        # attributes
+        attribute :availability_token, String
+        attribute :contract_name, String
+        attribute :contract_incoming_office_code, String
+        attribute :check_in_date, Date
+        attribute :check_out_date, Date
+        attribute :hotel_code, String
+        attribute :destination_code, String
+        attribute :rooms, Array[HotelBeds::Model::AvailableRoom]
+
+        # validation
+        validates :destination_code, length: { is: 3 }
+        validates :rooms, length: { minimum: 1, maximum: 5 }
+        validates :session_id, :availability_token, :contract_name,
+          :contract_incoming_office_code, :check_in_date, :check_out_date,
+          :hotel_code, presence: true
+        validate do |service|
+          unless (1..5).cover?(service.rooms.size)
+            service.errors.add(:rooms, "quantity must be between 1 and 5")
+          end
+          unless service.rooms.all?(&:valid?)
+            service.errors.add(:rooms, "are invalid")
+          end
+        end
+      end
+
+      include HotelBeds::Model
+
+      # attributes
+      attribute :session_id, String, default: SecureRandom.hex[0..15]
+      attribute :language, String, default: "ENG"
+      attribute :service, HotelService
+
+      # validation
+      validates :language, length: { is: 3 }
+      validates :session_id, :service, presence: true
+    end
+  end
+end

data/lib/hotel_beds/hotel_basket_add/response.rb

@@ -0,0 +1,66 @@
+require "active_model/errors"
+require "hotel_beds/model/purchase"
+
+module HotelBeds
+  module HotelBasketAdd
+    class 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(:service_add))
+        self.errors = ActiveModel::Errors.new(self).tap do |errors|
+          if response.http_error?
+            errors.add(:base, "HTTP error")
+          elsif response.soap_fault?
+            errors.add(:base, "SOAP error")
+          elsif !response.success?
+            errors.add(:base, "Request failed")
+          end
+
+          body.css("ErrorList Error").each do |error|
+            errors.add(:base, [
+              (sm = error.at_css("Message")) && sm.content,
+              (dm = error.at_css("DetailedMessage")) && dm.content
+            ].compact.join("\n"))
+          end
+        end
+        freeze
+      end
+
+      def inspect
+        "<#{self.class.name} errors=#{errors.inspect} headers=#{headers.inspect} body=#{body.to_s}>"
+      end
+
+      def session_id
+        request.session_id
+      end
+
+      def success?
+        errors.empty?
+      end
+
+      def purchase
+        purchase = body.at_css("Purchase")
+        HotelBeds::Model::Purchase.new({
+          id: purchase.attr("purchaseToken"),
+          currency: purchase.at_css("Currency").attr("code"),
+          amount: purchase.at_css("TotalPrice").content,
+          services: purchase.css("ServiceList Service").map { |service|
+            {
+              id: service.attr("SPUI"),
+              contract_name: service.at_css("Contract Name").content,
+              contract_incoming_office_code: service.at_css("Contract IncomingOffice").attr("code"),
+              check_in_date: Date.parse(service.at_css("DateFrom").attr("date")),
+              check_out_date: Date.parse(service.at_css("DateTo").attr("date")),
+              currency: service.at_css("Currency").attr("code"),
+              amount: service.at_css("TotalAmount").content
+            }
+          }
+        })
+      end
+    end
+  end
+end

data/lib/hotel_beds/hotel_search/envelope.rb

@@ -5,11 +5,12 @@ module HotelBeds
     class Envelope < SimpleDelegator
       def attributes
         {
-          PaginationData: pagination_data,
-          Language: language,
-          CheckInDate: check_in_date,
-          CheckOutDate: check_out_date,
-          OccupancyList: occupancy_list
+          :@sessionId => session_id,
+          :PaginationData => pagination_data,
+          :Language => language,
+          :CheckInDate => check_in_date,
+          :CheckOutDate => check_out_date,
+          :OccupancyList => occupancy_list
         }.merge(Hash(destination)).merge(Hash(hotels)).merge(Hash(extra_params))
       end
 
@@ -63,20 +64,28 @@ module HotelBeds
       end
 
       def occupancy_list
-        { 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)
-            })
+        grouped_rooms = Array(rooms).group_by(&:group_key).values
+        { HotelOccupancy: grouped_rooms.map(&method(:build_room)) }
+      end
+
+      def build_room(rooms)
+        child_ages = rooms.map(&:child_ages).inject(Array.new, :+)
+        adult_count = rooms.map(&:adult_count).inject(0, :+)
+        child_count = rooms.map(&:child_count).inject(0, :+)
+        {
+          RoomCount: rooms.size,
+          Occupancy: {
+            AdultCount: adult_count,
+            ChildCount: child_count,
+            GuestList: {
+              Customer: (1..adult_count).map {
+                { :@type => "AD" }
+              } + (1..child_count).map { |i|
+                { :@type => "CH", :Age => Integer(child_ages[i - 1]) }
+              }
+            }
           }
-        } }
+        }
       end
     end
   end