hostconnect 0.1.7

data/lib/hostconnect/coercion.rb

@@ -0,0 +1,50 @@
+module HostConnect
+  # Coercion
+  #
+  # Possible Types:
+  # * String
+  # * Strings with multiple lines (don't know yet if these must be handled specifically)
+  # * Boolean (Y/N)
+  # * Date (yyyy-mm-dd)
+  # * Time (hhmm)
+  # * Integer
+  # * Integer list (In an integer list, a single space is used to separate integer values.)
+  # * Price (Prices returned are Tourplan prices multiplied by 100, + currency stuff..)
+  #
+  # It must be possible to convert this data from/to native Ruby objects
+  class Coercion
+    # Convert HostConnect formatted data to Ruby objects
+    def self.from_hc(data)
+      case data
+      when /^[0-9]+\d*$/           then data.to_i
+      when /^(\d+\s){2,}[0-9 ]*$/  then data.split.collect { |i| i.to_i }
+      when /^\s*$/                 then nil
+      when /\d{4}-\d\d-\d\d/       then Date.parse(data)
+      when "Y"                     then true
+      when "N"                     then false
+      else                         data.strip
+      end
+    end
+
+    # Convert Ruby objects to HostConnect formatted data
+    def self.to_hc(data)
+      case data
+      when Integer                 then data.to_s
+      when Date                    then data.to_s
+      when nil                     then ""
+      when true                    then "Y"
+      when false                   then "N"
+      else                         data.strip
+      end
+    end
+
+    # Time strings are i.e "2310"
+    def self.time(string)
+      Time.parse(string[0,2] << ":" << string[2,4])
+    end
+
+    def self.price(string)
+     (string.to_f / 100).round
+    end
+  end
+end

data/lib/hostconnect/core_extensions/string.rb

@@ -0,0 +1,18 @@
+class String  
+  def requestify
+    self.gsub(/Id$/, 'ID')
+  end
+  
+  # Useful for heredocs - removes whitespace margin.
+  def margin
+    lines = self.dup.split($/)
+    
+    min_margin = 0
+    lines.each do |line|
+      if line =~ /^(\s+)/ && (min_margin == 0 || $1.size < min_margin)
+        min_margin = $1.size
+      end
+    end
+    lines.map { |line| line.sub(/^\s{#{min_margin}}/, '') }.join($/)
+  end
+end

data/lib/hostconnect/core_extensions/symbol.rb

@@ -0,0 +1,9 @@
+class Symbol
+  def classify
+    ActiveSupport::Inflector.classify(self.to_s)
+  end
+
+  def camelize
+    ActiveSupport::Inflector.camelize(self.to_s)
+  end
+end

data/lib/hostconnect/response.rb

@@ -0,0 +1,119 @@
+module HostConnect
+  # Abstract response class. Each subclass takes the XML responses and turns them into
+  # a basic datastructure, with each element available as an attribute.
+  class AbstractResponse
+    # Yields each element
+    def each
+      elements.each { |e| yield e }
+    end
+
+    # Returns the first element
+    def first
+      elements.first
+    end
+
+    # Returns the last element
+    def last
+      elements.last
+    end
+
+    # Act like an array
+    def [](num)
+      elements[num]
+    end
+
+    # Exposes the element-array of responses which consists of multiple elements.
+    # Raises an error if used on non-collection responses (Ping etc).
+    def elements
+      (@elements.blank?) ? raise(ArgumentError, "Not a collection") : @elements
+    end
+
+    protected
+    def parse(xml)
+      @data = Hpricot.XML xml
+      error_reply = @data.search("/Reply/ErrorReply/Error")
+      unless error_reply.blank?
+        error_msg = error_reply.innerHTML
+        error_code = error_msg[0..3].to_i
+
+        # See http://www.tourplan.com/support/Connector/ErrorMessages.html
+        error_description = case error_code
+                            when 1000 then "General error."
+                            when 1001 then "Missing input."
+                            when 1002 then "Illegal input."
+                            when 1003 then "Data communications link within iCom failed."
+                            when 1004 then "A timeout occurred while an iCom component was waiting for something to happen."
+                            when 1005 then "A database access error occurred within an iCom component."
+                            when 1006 then "An error occurred when an iCom component attempted a file access of some sort."
+                            when 1007 then "Data servlet cache not loaded."
+                            when 1008 then "An error was reported by the iCom booking engine."
+                            when 1009 then "The booking engine is currently off-line."
+                            when 1040 then "No merchant account."
+                            when 1050 then "Booking not found."
+                            when 1051 then "Agent not found (or wrong password given)."
+                            when 1052 then "Option not found."
+                            when 1053 then "Service line not found."
+                            when 1054 then "Operation is illegal on a read-only booking."
+                            when 1055 then "Operation is illegal for an agent over their credit limit."
+                            when 1056 then "Operation is illegal for this service line."
+                            when 1057 then "Permission denied for this operation."
+                            when 1058 then "The object the request is trying to create already exists."
+                            when 1059 then "Supplier not found."
+                            when 1060 then "Database record not found."
+                            when 1061 then "Supplier exists."
+                            when 1062 then "Option exists."
+                            when 1063 then "Agent exists, but has no default currency (iS iCom only)."
+                            when 1064 then "Operation is illegal on a non-iCom booking."
+                            when 1065 then "Login failed; two or more agents have this login."
+                            when 2000 then "Credit card expired."
+                            when 2001 then "Credit card number invalid (is non-numeric, or fails validation check)."
+                            when 2002 then "Card wrong type (card type does not match the specified card type)."
+                            when 2006 then "Operation requested is not valid for a confirmed booking."
+                            when 2007 then "Operation requested is not valid for a quote."
+                            when 2008 then "Error accessing external card payment system."
+                            when 2009 then "Transaction refused by external card payment system."
+                            when 2010 then "All services already cancelled."
+                            when 2011 then "Attempt to add service violates a MinSCU requirement at the option rate level."
+                            when 2050 then "Connector refused request. No valid hostConnect or webConnect entry was found that permitted the specfied request by the specified agent from the source IP address of the request."
+                            when 5000 then "The specified BookingUpdateCount is no longer valid; request rejected."
+                            when 5001 then "The specified ServiceLineUpdateCount is no longer valid; request rejected."
+                            else           "Unknown error."
+                            end
+
+        HostConnect.logger.fatal "Exception thrown: " + error_description
+        raise ArgumentError, error_msg << " (" << error_description << ")"
+      end
+    end
+
+    private
+    def initialize(xml)
+      parse xml
+      private_methods.include?("populate") ? populate : set_attrs
+    end
+
+    # Sets all instance variables. This only works for the simple requests.
+    # For convenience, query methods gets defined for booleans.
+    def set_attrs
+      reply_name = ActiveSupport::Inflector.demodulize(self.class) << "Reply"
+      @data.search("/Reply/" << reply_name) do |n|
+        n.containers.each do |e|
+          var = e.name.underscore
+
+          # Special treatment for variables that end with "_price"
+          if var =~ /_price$/
+            value = Coercion.price(Hpricot.uxs(e.innerHTML))
+          else
+            value = Coercion.from_hc(Hpricot.uxs(e.innerHTML))
+          end
+
+          if value.kind_of?(FalseClass) || value.kind_of?(TrueClass)
+            eval "def #{var}?; #{var}; end"
+          end
+
+          instance_variable_set("@#{var}", value)
+          self.class.class_eval "attr_reader :#{var}"
+        end
+      end
+    end
+  end
+end

data/lib/hostconnect/responses/add_service.rb

@@ -0,0 +1,4 @@
+module HostConnect
+  class AddService < AbstractResponse
+  end
+end

data/lib/hostconnect/responses/agent_info.rb

@@ -0,0 +1,7 @@
+module HostConnect
+  class AgentInfo < AbstractResponse
+    def to_s
+      name
+    end
+  end
+end

data/lib/hostconnect/responses/get_booking.rb

@@ -0,0 +1,20 @@
+module HostConnect
+  class GetBooking < AbstractResponse
+    private
+    def populate
+      set_attrs
+
+      @services = []
+      @data.search("/Reply/GetBookingReply/Services/Service").each do |service|
+        s = Struct.new(:service_line_id, :service_line_update_count, :opt,
+                       :status).new
+        s.service_line_id = (service/"ServiceLineId").innerHTML.to_i
+        s.service_line_update_count = (service/"ServiceLineUpdateCount").innerHTML.to_i
+        s.opt = (service/"Opt").innerHTML
+        s.status = (service/"Status").innerHTML
+
+        @services << s
+      end
+    end
+  end
+end

data/lib/hostconnect/responses/get_booking_payment_summary.rb

@@ -0,0 +1,21 @@
+module HostConnect
+  class GetBookingPaymentSummary < AbstractResponse
+    private
+    def populate
+      @data.search("/Reply/GetBookingPaymentSummaryReply") do |n|
+        n.containers.each do |e|
+          var = e.name.underscore
+
+          if var == "currency"
+            value = Hpricot.uxs(e.innerHTML)
+          else
+            value = Coercion.price(Hpricot.uxs(e.innerHTML))
+          end
+
+          instance_variable_set("@#{var}", value)
+          self.class.class_eval "attr_reader :#{var}"
+        end
+      end
+    end
+  end
+end

data/lib/hostconnect/responses/get_locations.rb

@@ -0,0 +1,21 @@
+module HostConnect
+  class GetLocations < AbstractResponse
+    include Enumerable
+    
+    def size
+      @size ||= @data.search("/Reply/GetLocationsReply/Locations/Location").size
+    end
+    
+    private
+    def populate
+      @elements = []
+      
+      @data.search("/Reply/GetLocationsReply/Locations/Location").each do |location|
+        s = Struct.new(:code, :name).new
+        s.code = (location/"Code").innerHTML
+        s.name = (location/"Name").innerHTML
+        @elements << s
+      end
+    end
+  end
+end

data/lib/hostconnect/responses/get_services.rb

@@ -0,0 +1,21 @@
+module HostConnect
+  class GetServices < AbstractResponse
+    include Enumerable
+    
+    def size
+      @size ||= @data.search("/Reply/GetServicesReply/TPLServices/TPLService").size
+    end
+    
+    private
+    def populate
+      @elements = []
+      
+      @data.search("/Reply/GetServicesReply/TPLServices/TPLService").each do |location|
+        s = Struct.new(:code, :name).new
+        s.code = (location/"Code").innerHTML
+        s.name = (location/"Name").innerHTML
+        @elements << s
+      end
+    end
+  end
+end

data/lib/hostconnect/responses/get_system_settings.rb

@@ -0,0 +1,24 @@
+module HostConnect
+  class GetSystemSettings < AbstractResponse
+    private
+    def populate
+      set_attrs
+
+      @countries = []
+      @data.search("/Reply/GetSystemSettingsReply/Countries/Country").each do |country|
+        c = Struct.new(:country_name, :destination_names).new
+        c.country_name = (country/"CountryName").innerHTML
+
+        c.destination_names = []
+
+        (country/"DestinationNames/DestinationName").each do |destination_name|
+          d = Struct.new(:destination_name).new
+          d.destination_name = destination_name.innerHTML
+          c.destination_names << d
+        end
+
+        @countries << c
+      end
+    end
+  end
+end

data/lib/hostconnect/responses/list_bookings.rb

@@ -0,0 +1,14 @@
+module HostConnect
+  class ListBookings < AbstractResponse
+    include Enumerable
+    
+    def size
+      @size ||= @data.search("/Reply/ListBookingsReply/*").size
+    end
+    
+    private
+    def populate
+      @elements = []
+    end
+  end
+end

data/lib/hostconnect/responses/option_info.rb

@@ -0,0 +1,60 @@
+module HostConnect
+  class OptionInfo < AbstractResponse
+    include Enumerable
+
+    def size
+      @size ||= @data.search("/Reply/OptionInfoReply/Option").size
+    end
+
+    private
+    def populate
+      @elements = []
+      @data.search("/Reply/OptionInfoReply/Option").each do |option|
+        s = OpenStruct.new
+        s.opt = Coercion.from_hc((option/"Opt").innerHTML)
+        s.option_number = Coercion.from_hc((option/"OptionNumber").innerHTML)
+
+        general = (option/"OptGeneral")
+        unless general.blank?
+          r = Struct.new(:description, :comment, :periods).new
+          r.description = (general/"Description").first.innerHTML
+          r.comment = (general/"Comment").innerHTML
+          r.periods = (general/"Periods").innerHTML.to_i
+
+          s.general = r
+        end
+
+        stay_results = (option/"OptStayResults")
+        unless stay_results.blank?
+          r = Struct.new(:availability, :currency, :total_price, :rate_name,
+                         :rate_text).new
+          r.availability = (stay_results/"Availability").innerHTML
+          r.currency = (stay_results/"Currency").innerHTML
+          r.total_price = Coercion.price((stay_results/"TotalPrice").innerHTML)
+          r.rate_name = (stay_results/"RateName").innerHTML
+          r.rate_text = (stay_results/"RateText").innerHTML
+
+          s.stay_results = r
+        end
+
+        rates = (option/"OptRates")
+        unless rates.blank?
+          r = OpenStruct.new
+          r.currency = (rates/"Currency").innerHTML
+
+          room_rates = Struct.new(:single_rate, :double_rate, :twin_rate, :triple_rate).new
+          room_rates.single_rate = Coercion.price((rates/"RoomRates/SingleRate").innerHTML)
+          room_rates.double_rate = Coercion.price((rates/"RoomRates/DoubleRate").innerHTML)
+          room_rates.twin_rate = Coercion.price((rates/"RoomRates/TwinRate").innerHTML)
+          room_rates.triple_rate = Coercion.price((rates/"RoomRates/TripleRate").innerHTML)
+
+          r.rate = OpenStruct.new
+          r.rate.room_rates = room_rates
+          s.rates = r
+        end
+
+        @elements << s
+      end
+    end
+  end
+end

data/lib/hostconnect/responses/ping.rb

@@ -0,0 +1,7 @@
+module HostConnect
+  class Ping < AbstractResponse
+    def to_s
+      backend << " " << version
+    end
+  end
+end

data/lib/hostconnect/responses/record_booking_payment.rb

@@ -0,0 +1,4 @@
+module HostConnect
+  class RecordBookingPayment < AbstractResponse
+  end
+end

data/lib/hostconnect/responses/supplier_info.rb

@@ -0,0 +1,31 @@
+module HostConnect
+  class SupplierInfo < AbstractResponse
+    include Enumerable
+
+    def size
+      @size ||= @data.search("/Reply/SupplierInfoReply/Suppliers/Supplier").size
+    end
+
+    private
+    def populate
+      @elements = []
+
+      @data.search("/Reply/SupplierInfoReply/Suppliers/Supplier").each do |supplier|
+        s = Struct.new(:supplier_id, :supplier_code, :name, :address1, :address2,
+                       :address3, :address4, :address5, :post_code, :supplier_note).new
+        s.supplier_id = (supplier/"SupplierId").innerHTML
+        s.supplier_code = (supplier/"SupplierCode").innerHTML
+        s.name = (supplier/"Name").innerHTML
+        s.address1 = (supplier/"Address1").innerHTML
+        s.address2 = (supplier/"Address2").innerHTML
+        s.address3 = (supplier/"Address3").innerHTML
+        s.address4 = (supplier/"Address4").innerHTML
+        s.address5 = (supplier/"Address5").innerHTML
+        s.post_code = (supplier/"PostCode").innerHTML
+        s.supplier_note = (supplier/"SupplierNotes"/"SupplierNote"/"NoteText").innerHTML
+
+        @elements << s
+      end
+    end
+  end
+end

data/lib/hostconnect/rtf_document.rb

@@ -0,0 +1,19 @@
+module HostConnect
+  # For setting up simple RTF Documents
+  class RtfDocument
+    def initialize(paragraphs)
+      @document = RTF::Document.new(RTF::Font.new(RTF::Font::ROMAN, 'Times New Roman'))
+      paragraphs.each do |p|
+        @document.paragraph << p
+      end
+    end
+
+    def to_rtf
+      @document.to_rtf
+    end
+
+    def to_s
+      @document.to_s
+    end
+  end
+end

data/lib/hostconnect/translation.rb

@@ -0,0 +1,22 @@
+module HostConnect
+  # Translate to/from HostConnect codes
+  class Translation
+    GRAMMAR = {
+      "SG"   => "Single",
+      "TW"   => "Twin",
+      "DB"   => "Double",
+      "TR"   => "Triple",
+      "QD"   => "Quad",
+      "CF"   => "Confirmed",
+      "CX"   => "Cancelled",
+      "FQ"   => "FIT Quote",
+      "IN"   => "Internet Booking",
+      "RQ"   => "Request",
+      "CRCD" => "Credit Card Payment"
+    }
+
+    def self.translate(string)
+      (string =~ /^[A-Z]{2}$/) ? GRAMMAR[string] : GRAMMAR.invert[string]
+    end
+  end
+end

data/lib/hostconnect.rb

@@ -0,0 +1,58 @@
+# This file begins the loading sequence.
+pwd = File.dirname(__FILE__)
+
+# This line just let's us require anything in the +lib+ sub-folder
+# without specifying a full path.
+$LOAD_PATH.unshift(pwd)
+
+# Require dependencies
+%w[rubygems net/https builder date time ostruct hpricot rtf
+   active_support yaml logger].each { |lib| require lib }
+
+# Require HostConnect files
+%w[client response builder rtf_document translation
+   coercion].each { |lib| require "#{pwd}/hostconnect/#{lib}" }
+
+Dir.glob("#{pwd}/hostconnect/builders/*.rb").each { |file| require file }
+Dir.glob("#{pwd}/hostconnect/responses/*.rb").each { |file| require file }
+Dir.glob("#{pwd}/hostconnect/core_extensions/*.rb").each { |file| require file }
+
+module HostConnect
+  extend self
+
+  module Version
+    MAJOR = '0'
+    MINOR = '1'
+    REVISION = '6'
+    def self.combined
+      [MAJOR, MINOR, REVISION].join('.')
+    end
+  end
+
+  def setup(env, config)
+    config[:dtd] =
+      'http://www.tourplan.com/support/Connector/hostConnect_' + config[:version] + '.dtd'
+    @@config = OpenStruct.new config
+
+    log_level = case env
+                when :test         then Logger::WARN
+                when :development  then Logger::DEBUG
+                when :production   then Logger::ERROR
+                else               raise ArgumentError, 'Incorrect environment: ' + env.to_s
+                end
+
+    log_path = config[:log_path] || "log/"
+    @@logger = Logger.new(log_path + env.to_s + ".log")
+    @@logger.level = log_level
+    @@logger.formatter = Logger::Formatter.new
+    @@logger.datetime_format = "%Y-%d-%m %H:%M:%S"
+  end
+
+  def config
+    @@config
+  end
+
+  def logger
+    @@logger
+  end
+end

data/spec/builders/add_service_builder_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe HostConnect::AddServiceBuilder do
+  before(:each) do
+    @xml = File.read("./spec/fixtures/requests/add_service_request/hotel_booking.xml")
+  end
+
+  it "should produce xml" do
+    req = AddServiceBuilder.new(:agent_id => "EURTAT", :password => "EURTAT")
+
+    req.new_booking_info = NewBookingInfoBuilder.new(:name => "Jessop Mr/Mrs", :qb => "B")
+
+    pax1 = PaxDetailsBuilder.new(:title => "Mr", :forename => "Rob",
+                                 :surname => "Jardim", :pax_type => "A",
+                                 :date_of_birth => "1980-12-24")
+    pax2 = PaxDetailsBuilder.new(:title => "Mrs", :forename => "Sally",
+                                 :surname => "Jardim", :pax_type => "A",
+                                 :date_of_birth => "1980-12-24")
+
+    room = RoomConfigBuilder.new(:adults => 2, :room_type => "TW",
+                                 :pax_list => [ pax1, pax2 ])
+    req.room_configs = [ room ]
+
+    req.opt = "LONACCUMLONSTDBCB"
+    req.date_from = "2007-10-07"
+    req.scu_qty = "2"
+
+    req.ud_text1 = "+4799999999"
+    req.ud_text2 = "contact@email.net"
+    req.ud_text3 = "Norway"
+    req.ud_text4 = false
+    req.ud_text5 = "Smoking"
+
+    req.to_s.should == @xml
+  end
+end

data/spec/builders/agent_info_builder_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe HostConnect::AgentInfoBuilder do
+  before(:each) do
+    @xml = File.read("./spec/fixtures/requests/agent_info.xml")
+  end
+
+  it "should produce xml" do
+    req = AgentInfoBuilder.new(:agent_id => "EURTAT", :password => "EURTAT")
+    
+    req.to_s.should == @xml
+  end
+end

data/spec/builders/get_locations_builder_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe HostConnect::GetLocationsBuilder do
+  before(:each) do
+    @xml = File.read("./spec/fixtures/requests/get_locations.xml")
+  end
+
+  it "should produce xml" do
+    req = GetLocationsBuilder.new(:agent_id => "EURTAT", :password => "EURTAT")
+    
+    req.to_s.should == @xml
+  end
+end

data/spec/builders/new_booking_info_builder_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe HostConnect::NewBookingInfoBuilder do
+  before(:each) do
+    @xml = <<-END
+    <NewBookingInfo>
+      <Name>Jessop Mr/Mrs</Name>
+      <QB>B</QB>
+    </NewBookingInfo>
+END
+  end
+
+  it "should produce correct xml" do
+    req = NewBookingInfoBuilder.new(:name => "Jessop Mr/Mrs", :qb => "B")
+
+    req.to_s.should == @xml
+  end
+
+  it "should be possible to set and change the attributes directly" do
+    req = NewBookingInfoBuilder.new
+    req.name = "Jessop Mr/Mrs"
+    req.qb   = "B"
+
+    req.to_s.should == @xml
+
+    req.qb = "X"
+    req.to_s.should_not == @xml
+  end
+
+  it "should return a XML Builder object" do
+    req = NewBookingInfoBuilder.new({})
+    req.to_xml.should respond_to(:target!)
+  end
+end