hotel_beds 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee35be3ac5b6c786cf81e423804de3fb925c32a7
-  data.tar.gz: b9f28db962220a6b808fc2c5d3c7fed476d3fedb
+  metadata.gz: 7c3bea539610e13aca6d457ae561d8c62c5b52d0
+  data.tar.gz: 3b8365b3312998149cfa8bb1ede6a90aa5360525
 SHA512:
-  metadata.gz: a5a5fd5bd3cc26f982de37ba7f34fedb03a9b0c43f841146e43d81d31b11a2cac08d5baa04ba691cc110b500662420810963ceda565a2e5a6a222146dafa9066
-  data.tar.gz: 6ad26f49b7bb40ac1ac51ad4f6aec8dfaf39fa205ef92bc4e2e6cfad74eba043c2ff02427b959da7b44009a3dc4748c8d254e11b9547ec002cab532c3dbccde6
+  metadata.gz: 756489f73cc0a066d6771508404a01c01710a75fd32f73664d44e8a9f0d73f87d48db06fa626a64a0c6e3eb5c74ac74bf0b6bda0944f1b1b5f03058cb72117b7
+  data.tar.gz: 0fda52e2b50755e68809154ae0094239c94ae2c63c488686acfa550fd2c39920fb45187ad05e2e9018c49a7418bf1e95b2b9ae81eccab2fb8836f725bb644d85

data/README.md

@@ -1,4 +1,4 @@
-[![Codeship Status](https://www.codeship.io/projects/808271e0-e973-0131-1052-5240ebfefa5a/status)](https://www.codeship.io/projects/26188) [![Gem Version](https://badge.fury.io/rb/hotel_beds.svg)](https://rubygems.org/gems/hotel_beds) [![Code Climate](https://codeclimate.com/github/platformq/hotel_beds.png)](https://codeclimate.com/github/platformq/hotel_beds) [![Code Climate](https://codeclimate.com/github/platformq/hotel_beds/coverage.png)](https://codeclimate.com/github/platformq/hotel_beds)
+[![Codeship Status](https://www.codeship.io/projects/808271e0-e973-0131-1052-5240ebfefa5a/status)](https://www.codeship.io/projects/26188) [![Gem Version](https://badge.fury.io/rb/hotel_beds.svg)](https://rubygems.org/gems/hotel_beds) [![Code Climate](https://codeclimate.com/github/platformq/hotel_beds/badges/gpa.svg)](https://codeclimate.com/github/platformq/hotel_beds) [![Code Climate](https://codeclimate.com/github/platformq/hotel_beds/badges/coverage.svg)](https://codeclimate.com/github/platformq/hotel_beds)
 
 The `hotel_beds` gem interfaces with the [HotelBeds.com](http://www.hotelbeds.com/) SOAP API to search for and book hotel rooms.
 
@@ -18,6 +18,8 @@ Manually, via command line:
 
 ## Usage
 
+It's best to check the [feature specs](https://github.com/platformq/hotel_beds/tree/master/spec/features) to see up-to-date examples, but a basic search example is below:
+
 ```ruby
 # create the connection to HotelBeds
 client = HotelBeds::Client.new(endpoint: :test, username: "user", password: "pass")
@@ -27,7 +29,7 @@ search = client.perform_hotel_search({
   check_in_date: Date.today,
   check_out_date: Date.today + 1,
   rooms: [{ adult_count: 2 }],
-  destination: "SYD"
+  destination_code: "SYD"
 })
 
 # inspect the response
@@ -37,48 +39,6 @@ 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
-
-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:
-
-```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/basket_remove/envelope.rb

@@ -0,0 +1,16 @@
+require "delegate"
+
+module HotelBeds
+  module BasketRemove
+    class Envelope < SimpleDelegator
+      def attributes
+        {
+          :Language => language,
+          :@SPUI => service_id,
+          :@version => "2013/12",
+          :@purchaseToken => purchase_token
+        }
+      end
+    end
+  end
+end

data/lib/hotel_beds/basket_remove/operation.rb

@@ -0,0 +1,36 @@
+require_relative "request"
+require_relative "response"
+require_relative "envelope"
+
+module HotelBeds
+  module BasketRemove
+    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: :serviceRemove,
+          namespace: :ServiceRemoveRQ,
+          data: Envelope.new(request).attributes
+        })
+      end
+    end
+  end
+end

data/lib/hotel_beds/basket_remove/request.rb

@@ -0,0 +1,19 @@
+require "hotel_beds/model"
+
+module HotelBeds
+  module BasketRemove
+    class Request
+      include HotelBeds::Model
+
+      # attributes
+      attribute :language, String, default: "ENG"
+      attribute :purchase_token, String
+      attribute :service_id, String
+
+
+      # validation
+      validates :language, length: { is: 3 }
+      validates :service_id, :purchase_token, presence: true
+    end
+  end
+end

data/lib/hotel_beds/basket_remove/response.rb

@@ -0,0 +1,31 @@
+require "hotel_beds/parser/errors"
+require "hotel_beds/parser/purchase"
+
+module HotelBeds
+  module BasketRemove
+    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_remove))
+        self.errors = HotelBeds::Parser::Errors.new(response).to_model(self)
+        freeze
+      end
+
+      def inspect
+        "<#{self.class.name} errors=#{errors.inspect} headers=#{headers.inspect} body=#{body.to_s}>"
+      end
+
+      def success?
+        errors.empty?
+      end
+
+      def purchase
+        HotelBeds::Parser::Purchase.new(body.at_css("Purchase")).to_model
+      end
+    end
+  end
+end

data/lib/hotel_beds/client.rb

@@ -2,6 +2,9 @@ require "hotel_beds/configuration"
 require "hotel_beds/connection"
 require "hotel_beds/hotel_search/operation"
 require "hotel_beds/hotel_basket_add/operation"
+require "hotel_beds/purchase_confirm/operation"
+require "hotel_beds/purchase_flush/operation"
+require "hotel_beds/basket_remove/operation"
 
 module HotelBeds
   class Client
@@ -28,5 +31,23 @@ module HotelBeds
         connection: connection
       )
     end
+
+    def confirm_purchase(*args)
+      PurchaseConfirm::Operation.new(*args).perform(
+        connection: connection
+      )
+    end
+
+    def flush_purchase(*args)
+      PurchaseFlush::Operation.new(*args).perform(
+        connection: connection
+      )
+    end
+
+    def remove_service_from_basket(*args)
+      BasketRemove::Operation.new(*args).perform(
+        connection: connection
+      )
+    end
   end
 end

data/lib/hotel_beds/hotel_basket_add/request.rb

@@ -19,7 +19,7 @@ module HotelBeds
         attribute :rooms, Array[HotelBeds::Model::AvailableRoom]
 
         # validation
-        validates :destination_code, length: { is: 3 }
+        validates :destination_code, length: { is: 3, allow_blank: false }
         validates :rooms, length: { minimum: 1, maximum: 5 }
         validates :session_id, :availability_token, :contract_name,
           :contract_incoming_office_code, :check_in_date, :check_out_date,

data/lib/hotel_beds/hotel_basket_add/response.rb

@@ -1,5 +1,5 @@
-require "active_model/errors"
-require "hotel_beds/model/purchase"
+require "hotel_beds/parser/errors"
+require "hotel_beds/parser/purchase"
 
 module HotelBeds
   module HotelBasketAdd
@@ -11,22 +11,7 @@ module HotelBeds
         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
+        self.errors = HotelBeds::Parser::Errors.new(response).to_model(self)
         freeze
       end
 
@@ -43,23 +28,7 @@ module HotelBeds
       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
-            }
-          }
-        })
+        HotelBeds::Parser::Purchase.new(body.at_css("Purchase")).to_model
       end
     end
   end

data/lib/hotel_beds/hotel_search/envelope.rb

@@ -30,7 +30,10 @@ module HotelBeds
       end
 
       def pagination_data
-        { :@pageNumber => Integer(page_number) }
+        {
+          :@pageNumber => Integer(page_number),
+          :@itemsPerPage => Integer(items_per_page)
+        }
       end
 
       def language
@@ -46,19 +49,17 @@ module HotelBeds
       end
 
       def destination
-        if __getobj__.destination
-          { Destination: {
-            :@code => String(__getobj__.destination).upcase,
-            :@type => "SIMPLE"
-          } }
-        end
+        { Destination: {
+          :@code => String(__getobj__.destination_code).upcase,
+          :@type => "SIMPLE"
+        } }
       end
 
       def hotels
-        if Array(__getobj__.hotels).any?
+        if Array(__getobj__.hotel_codes).any?
           { HotelCodeList: {
             :@withinResults => "Y",
-            :ProductCode => Array(__getobj__.hotels)
+            :ProductCode => Array(__getobj__.hotel_codes)
           } }
         end
       end

data/lib/hotel_beds/hotel_search/request.rb

@@ -10,16 +10,18 @@ module HotelBeds
       # attributes
       attribute :session_id, String, default: SecureRandom.hex[0..15]
       attribute :page_number, Integer, default: 1
+      attribute :items_per_page, Integer, default: 50
       attribute :language, String, default: "ENG"
       attribute :check_in_date, Date
       attribute :check_out_date, Date
-      attribute :destination, String
-      attribute :hotels, Array[Integer]
+      attribute :destination_code, String
+      attribute :hotel_codes, Array[Integer]
       attribute :rooms, Array[HotelBeds::Model::RequestedRoom]
-      attribute :group_results, Virtus::Attribute::Boolean, default: false
 
       # validation
-      validates :language, :destination, length: { is: 3 }
+      validates :language, :destination_code, length: {
+        is: 3, allow_blank: false
+      }
       validates :session_id, :check_in_date, :check_out_date, presence: true
       validates :rooms, length: { minimum: 1, maximum: 5 }
       validates :page_number, numericality: {

data/lib/hotel_beds/hotel_search/response.rb

@@ -1,6 +1,5 @@
-require "hotel_beds/model/hotel"
-require "hotel_beds/hotel_search/parser/errors"
-require "hotel_beds/hotel_search/parser/hotel"
+require "hotel_beds/parser/errors"
+require "hotel_beds/parser/hotel"
 
 module HotelBeds
   module HotelSearch
@@ -12,7 +11,7 @@ module HotelBeds
         self.request = request
         self.headers = response.header
         self.body = Nokogiri::XML(response.body.fetch(:get_hotel_valued_avail))
-        self.errors = HotelBeds::HotelSearch::Parser::Errors.call(response, body)
+        self.errors = HotelBeds::Parser::Errors.new(response).to_model(self)
         freeze
       end
 
@@ -46,11 +45,7 @@ module HotelBeds
 
       def hotels
         body.css("ServiceHotel").lazy.map do |hotel|
-          HotelBeds::HotelSearch::Parser::Hotel.call(
-            hotel: hotel,
-            currency: currency,
-            request: request
-          )
+          HotelBeds::Parser::Hotel.new(hotel).to_model
         end
       end
 

data/lib/hotel_beds/model/available_room.rb

@@ -1,5 +1,7 @@
 require "hotel_beds/model/room"
+require "hotel_beds/model/price"
 require "hotel_beds/model/cancellation_policy"
+require "hotel_beds/model/customer"
 
 module HotelBeds
   module Model
@@ -15,8 +17,27 @@ module HotelBeds
       attribute :price, BigDecimal
       attribute :number_available, Integer
       attribute :rates, Hash[Date => BigDecimal]
-      attribute :cancellation_policies, Array[CancellationPolicy],
+      attribute :cancellation_policies, Array[HotelBeds::Model::CancellationPolicy],
         default: Array.new
+      attribute :customers, Array[HotelBeds::Model::Customer],
+        default: Array.new
+
+      def rates=(values)
+        if values.kind_of?(Array)
+          prices = values.map do |attrs|
+            HotelBeds::Model::Price.new(attrs)
+          end
+          hash = prices.inject(Hash.new) do |result, price|
+            price.dates.each do |date|
+              result.merge!(date => price.amount)
+            end
+            result
+          end
+          super(hash)
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/hotel_beds/model/cancellation_policy.rb

@@ -8,7 +8,6 @@ module HotelBeds
       # attributes
       attribute :amount, BigDecimal
       attribute :from, Time
-      attribute :to, Date
     end
   end
 end

data/lib/hotel_beds/model/comment.rb

@@ -0,0 +1,13 @@
+require "hotel_beds/model"
+
+module HotelBeds
+  module Model
+    class Comment
+      include HotelBeds::Model
+
+      # attributes
+      attribute :type, String
+      attribute :content, String
+    end
+  end
+end