oracle_ows 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce372d91dfb83a8c32a81b57731df0c80460ac439b21bbf3591505b6de8424bf
+  data.tar.gz: 54cd96415f562f88ddc692db212742d5e30676ae37736dce9e52ec67e96fbc0e
+SHA512:
+  metadata.gz: 1f45f472cefefba5ea8e8e54db5eb0dce589d9242b5cee32755ada0972c77168da42cd5094b2a7b25da0e7951cb6327cbd57d6d133e9daa13aaf8518aa552a74
+  data.tar.gz: 44322bda7acec1c7239669190e482a60c6be79d36625a34e081b4bf26f9e14bc0ab9c886e5bf664f475632473ff4062e24701e09c978f57ac4facd7253803ae2

data/lib/config/dotenv.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# If any of the configuration keys above are not set, your application will
+# raise an error during initialization. This method is preferred because it
+# prevents runtime errors in a production application due to improper
+# configuration.
+Dotenv.require_keys('URL', 'USERNAME', 'PASSWORD')

data/lib/oracle_ows.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# environment
+require 'dotenv/load'
+# load config for gem
+require 'config/dotenv'
+
+# gem components
+#
+# base components
+require 'oracle_ows/base'
+require 'oracle_ows/error'
+
+# feature components
+#
+require 'oracle_ows/guest_services'
+require 'oracle_ows/house_keeping'
+require 'oracle_ows/information'
+require 'oracle_ows/reservation'
+require 'oracle_ows/resv_advanced'
+require 'oracle_ows/version'

data/lib/oracle_ows/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'oracle_ows/common'
+
+#
+# Oracle Hospitality OPERA Web Self-Service
+# (Specifications)[https://docs.oracle.com/cd/E90572_01/index.html]
+#
+module OracleOWS
+  #
+  # OracleOws::Base stores basic parameters to connect to the service
+  #
+  class Base
+    include OracleOWS::Common
+
+    #
+    # Instantiates the OracleOWS::Base object
+    #
+    # @param [Hash] options contains a hash of parameters to beused for every API call
+    # @option options [String] :url base URL of the SOAP API endpoint
+    # @option options [String] :username login username
+    # @option options [String] :password password to use
+    # @option options [Hash] :namespaces a hash of XML namespaces to use as headers
+    #
+    def initialize(options = {})
+      # { url: 'http://some.domain/path/' }
+      @url = options[:url]
+      # { username: 'abc' }
+      @username = options[:username]
+      # { password: 'abc' }
+      @password = options[:password]
+      # basic namespaces required at least, to begin with
+      @namespaces = {
+        'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
+        'xmlns:cor' => 'http://webservices.micros.com/og/4.3/Core/'
+      }
+      # merge any additional given namespaces
+      @namespaces.merge!(options[:namespaces] || {})
+    end
+  end
+end

data/lib/oracle_ows/common.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'savon'
+
+#
+# OracleOws::Common
+#
+module OracleOWS
+  # common methods to include in all classes
+  module Common
+    # @return [String] url => base URL for the API endpoint
+    # @return [String] username => login to use like ENV['ORACLE_OWS_LOGIN']
+    # @return [String] password => password to use like ENV['ORACLE_OWS_PASSWORD']
+    # @return [Hash] namespaces => a hash of XML namespaces for SOAP header
+    #
+    #   Example:
+    #   !{
+    #     'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
+    #     'xmlns:cor' => 'http://webservices.micros.com/og/4.3/Core/'
+    #   }
+    attr_accessor :url, :username, :password
+    # # @return [OracleOws::Base] base class object holds connection parameters
+    # attr_accessor :base
+    # @return [Hash] XML namesspaces as hash
+    # {#namespaces=} writer method adds more namespaces to the hash
+    attr_reader :namespaces
+
+    #
+    # Merges existing namespaces hash with additional values
+    #
+    # @param [Hash] hash of XML namespaces to be used additionally
+    #
+    # @return [Hash] hash of all namespaces merged together
+    #
+    def namespaces=(hash = {})
+      hash = {} unless hash.is_a? Hash
+
+      @namespaces ||= {}
+      @namespaces.merge!(hash)
+    end
+
+    private
+
+    #
+    # soap client object to make API calls
+    #
+    # @return [Savon::Client] client object ready to make calls
+    #
+    def soap_client
+      # authentication
+      credentials = { 'cor:UserName' => username, 'cor:UserPassword' => password }
+      # required SOAP header
+      soap_header = { 'cor:OGHeader' => { 'cor:Authentication' => { 'cor:UserCredentials' => credentials } } }
+      # logging options
+      log_options = { log_level: :debug, log: true, pretty_print_xml: true }
+      # class name of caller object
+      klass_name = self.class.name.split('::').last
+      # WSDL endpoint is derived from ClassName
+      options = { wsdl: "#{url}/#{klass_name}.asmx?WSDL", namespaces: namespaces, soap_header: soap_header }
+      # SOAP client
+      Savon.client(options.merge(log_options))
+    end
+  end
+end

data/lib/oracle_ows/error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# OracleOws::Error handler for the gem
+#
+module OracleOWS
+  #
+  # Custom error handling
+  #
+  class Error < StandardError; end
+  # Error handling code goes here...
+end

data/lib/oracle_ows/guest_services.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'oracle_ows/base'
+
+#
+# OracleOws::GuestServices
+#
+module OracleOWS
+  #
+  # [Guest Services Web Service]
+  # {https://docs.oracle.com/cd/E90572_01/docs/Guest%20Services%20Web%20Service%20Specification.htm}
+  #
+  class GuestServices < Base
+    #
+    # Initialize
+    #
+    # @param [Hash] object with connection parameters
+    #
+    def initialize(options = {})
+      # call the parent method, all arguments passed
+      super
+
+      # we need these for API calls
+      more_namespaces = {
+        'xmlns:gue' => 'http://webservices.micros.com/og/4.3/GuestServices/',
+        'xmlns:hot' => 'http://webservices.micros.com/og/4.3/HotelCommon/'
+      }
+      # merge base + additional namespaces
+      @namespaces.merge!(more_namespaces)
+    end
+
+    #
+    # Update Room Status
+    #
+    # @param [Hash] options to update the room status
+    # @option options [String] :hotel_code code of the hotel
+    # @option options [Numeric, String] :room number to update
+    #
+    # @return [Hash] result hash extracted from the deply nested XML
+    #
+    def update_room_status(options = {})
+      # save resources if we have nothing to do
+      return {} if options.blank?
+
+      # make the SOAP API call
+      response = soap_client.call(
+        # endpoint action
+        :update_room_status,
+        # payload
+        message: {
+          'HotelReference' => {
+            '@hotelCode' => options[:hotel_code]
+          },
+          'RoomNumber' => options[:room],
+          'RoomStatus' => 'Clean',
+          'TurnDownStatus' => 'Completed',
+          'GuestServiceStatus' => 'DoNotDisturb'
+        }
+      )
+
+      # fetch the response safely (without exception or too many conditional blocks)
+      response.body.dig(:update_room_status_response, :result)
+
+    # handle exceptions gracefully
+    rescue OracleOWS::Error => e
+      # handle exception gracefully
+    ensure
+      {} # at least return a blank hash
+    end
+
+    #
+    # Wake Up Call
+    #
+    # @param [Hash] options parameters
+    # @option options [String] :hotel_code is the code of the hotel
+    # @option options [Numeric, String] :room number
+    #
+    # @return [Hash] result hash from the deeply nested XML response
+    #
+    def wake_up_call(options = {})
+      return {} if options.blank?
+
+      response = soap_client.call(
+        :wake_up_call,
+        message: {
+          'HotelReference' => { '@hotelCode' => options[:hotel_code] },
+          'RoomNumber' => options[:room]
+        }
+      )
+
+      # fetch the response safely (without exception or too many conditional blocks)
+      response.body.dig(:wake_up_call_response, :result)
+
+    # handle exceptions gracefully
+    rescue OracleOWS::Error => e
+      # handle exception gracefully
+    ensure
+      {} # at least return a blank hash
+    end
+  end
+  # class Hosuekeeping
+end
+# module OracleOws

data/lib/oracle_ows/house_keeping.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'oracle_ows/base'
+
+#
+# OracleOws::Housekeeping
+#
+module OracleOWS
+  #
+  # [Housekeeping Web Service]
+  # {https://docs.oracle.com/cd/E90572_01/docs/Housekeeping%20Web%20Service%20Specifications.htm}
+  #
+  class HouseKeeping < Base
+    #
+    # Initialize
+    #
+    # @param [Hash] object with connection parameters
+    #
+    def initialize(options = {})
+      # call the parent method, all arguments passed
+      super
+
+      # we need these for API calls
+      more_namespaces = {
+        'xmlns:hkeep' => 'http://webservices.micros.com/ows/5.1/HouseKeeping.wsdl',
+        'xmlns:room' => 'http://webservices.micros.com/og/4.3/HouseKeeping/'
+      }
+      # merge base + additional namespaces
+      @namespaces.merge!(more_namespaces)
+    end
+
+    #
+    # FetchHouseKeepingRoomStatus
+    #
+    # @param [Hash] options with parameters
+    # @option options [String] :hotel_code is the identifier for the hotel
+    # @option options [Hash] :room a hash of :from and :to parameters
+    # @option options [Symbol] :from parameter in :room => { :from => 1 }
+    # @option options [Symbol] :to parameter in :room => { :to => 1 }
+    #
+    # @return [Hash] of the result from deeply nested XML response
+    #
+    def room_status(options = {})
+      return {} if options.blank?
+
+      response = soap_client.call(
+        :fetch_house_keeping_room_status,
+        message: {
+          'HotelReference' => { '@hotelCode' => options[:hotel_code] },
+          'Criteria' => {
+            'FromRoom' => options[:room][:from],
+            'ToRoom' => options[:room][:to],
+            'RoomStatusList' => { 'Code' => 'CLEAN' },
+            'HKStatusList' => { 'Code' => 'VACANT' },
+            'FOStatusList' => { 'Code' => 'VACANT' },
+            'ReservationStatusList' => { 'Code' => 'STAYOVER' }
+          }
+        }
+      )
+
+      # fetch the response safely (without exception or too many conditional blocks)
+      response.body.dig(:fetch_house_keeping_room_status_response, :result)
+
+    # handle exceptions gracefully
+    rescue OracleOWS::Error => e
+      # handle exception gracefully
+    ensure
+      {} # at least return a blank hash
+    end
+  end
+  # class Hosuekeeping
+end
+# module OracleOws

data/lib/oracle_ows/information.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'oracle_ows/base'
+
+#
+# OracleOws::Information
+#
+module OracleOWS
+  # [Information Web Service]
+  # {https://docs.oracle.com/cd/E90572_01/docs/Information%20Web%20Service%20Specifications.htm}
+  class Information < Base
+    #
+    # initialize the API endpoint object
+    #
+    # @param [OracleOws::Base] base object with initial parameters
+    #
+    def initialize(options = {})
+      # call the parent method, all arguments passed
+      super
+
+      # we need these for API calls
+      more_namespaces = {
+        'xmlns:inf' => 'http://webservices.micros.com/ows/5.1/Information.wsdl'
+      }
+      # merge base + additional namespaces
+      @namespaces.merge!(more_namespaces)
+    end
+
+    # action: hotel information
+    # Usage:
+    #   hotel_information({ hotel_code: 'ABC' })
+    def hotel_information(options = {})
+      return {} if options.blank?
+
+      response = soap_client.call(
+        :query_hotel_information,
+        message: {
+          'HotelInformationQuery' => { '@hotelCode' => options[:hotel_code] }
+        }
+      )
+
+      # fetch the response safely (without exception or too many conditional blocks)
+      response.body.dig(:hotel_information_response, :result)
+
+    # handle exceptions gracefully
+    rescue OracleOWS::Error => e
+      # handle exception gracefully
+    ensure
+      {} # at least return a blank hash
+    end
+  end
+  # class
+end
+# module OracleOws

data/lib/oracle_ows/reservation.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'oracle_ows/base'
+
+#
+# OracleOws::Reservation
+#
+module OracleOWS
+  # [Reservation Web Service]
+  # {https://docs.oracle.com/cd/E90572_01/docs/Reservation%20Web%20Service%20Specifications.htm}
+  class Reservation < Base
+    #
+    # initialize
+    #
+    # @param [Hash] options for connection
+    #
+    def initialize(options = {})
+      # call the parent method, all arguments passed
+      super
+
+      # we need these for API calls
+      more_namespaces = {
+        'xmlns:res' => 'http://webservices.micros.com/ows/5.1/Reservation.wsdl',
+        'xmlns:res1' => 'http://webservices.micros.com/og/4.3/Reservation/'
+      }
+      # merge base + this API namespaces
+      @namespaces.merge!(more_namespaces)
+    end
+
+    #
+    # PreCheckin
+    #
+    # @param [Hash] options of parameters for the API call
+    # @option options [String] :hotel_code to identify the hotel
+    # @option options [String] :chain_code to identify the chain of hotels it belongs to
+    # @option options [String] :confirmation number of the check in
+    #
+    # @return [Hash] result hash from the deeply nested XML response
+    #
+    def pre_checkin(options = {})
+      return {} if options.blank?
+
+      response = soap_client.call(
+        :pre_checkin,
+        message: {
+          'HotelReference' => {
+            '@hotelCode' => options[:hotel_code],
+            '@chainCode' => options[:chain_code]
+          },
+          'ConfirmationNumber' => options[:confirmation]
+        }
+      )
+
+      # fetch the response safely (without exception or too many conditional blocks)
+      response.body.dig(:pre_checkin_response, :result)
+
+    # handle exceptions gracefully
+    rescue OracleOWS::Error => e
+      # handle exception gracefully
+    ensure
+      {} # at least return a blank hash
+    end
+
+    # Usage:
+    #   method({ hotel_code: 'ABC', type: 'ABC', source: 'ABC' })
+    def fetch_booked_inventory_items(options = {})
+      return {} if options.blank?
+
+      response = soap_client.call(
+        :fetch_booked_inventory_items,
+        message: {
+          'HotelReference' => { '@hotelCode' => options[:hotel_code] } #,
+          # 'ConfirmationNumber' => { '@type' => options[:type], '@source' => options[:source] }
+        }
+      )
+
+      # fetch the response safely (without exception or too many conditional blocks)
+      response.body.dig(:fetch_booked_inventory_items_response, :result)
+
+    # handle exceptions gracefully
+    rescue OracleOWS::Error => e
+      # handle exception gracefully
+    ensure
+      {} # at least return a blank hash
+    end
+  end
+  # class
+end
+# module OracleOws

data/lib/oracle_ows/resv_advanced.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'oracle_ows/base'
+
+#
+# OracleOws::ReservationAdvanced
+#
+module OracleOWS
+  # [Reservation Advanced Web Service]
+  # {https://docs.oracle.com/cd/E90572_01/docs/Reservation%20Advanced%20Web%20Service%20Specifications.htm}
+  class ResvAdvanced < Base
+    #
+    # initialize the object
+    #
+    # @param [OracleOws::Base] base parameters
+    #
+    def initialize(options = {})
+      # call the parent method, all arguments passed
+      super
+
+      # we need these for API calls
+      more_namespaces = {
+        'xmlns:rsa' => 'http://webservices.micros.com/og/4.3/ResvAdvanced/',
+        'xmlns:com' => 'http://webservices.micros.com/og/4.3/Common/',
+        'xmlns:hot' => 'http://webservices.micros.com/og/4.3/HotelCommon/',
+        'xmlns:res' => 'http://webservices.micros.com/og/4.3/Reservation/'
+      }
+      # merge base + additional namespaces
+      @namespaces.merge!(more_namespaces)
+    end
+
+    #
+    # CheckIn
+    #
+    # @param [Hash] options for API call
+    # @option options [String] :hotel_code to identify the hotel
+    # @option options [String] :key_1 Key #1
+    # @option options [String] :key_2 Key #2
+    # @option options [String] :key_3 Key #3
+    # @option options [String] :key_4 Key #4
+    #
+    # @return [Hash] result hash from deeply nested XML Response
+    #
+    def checkin(options = {})
+      return {} if options.blank?
+
+      response = soap_client.call(
+        :check_in,
+        message: {
+          'ReservationRequest' => {
+            'HotelReference' => { '@hotelCode' => options[:hotel_code] },
+            'KeyTrack' => {
+              '@Key1Track' => options[:key_1],
+              '@Key2Track' => options[:key_2],
+              '@Key3Track' => options[:key_3],
+              '@Key4Track' => options[:key_4]
+            }
+          }
+        }
+      )
+
+      # fetch the response safely (without exception or too many conditional blocks)
+      response.body.dig(:check_in_response, :result)
+
+    # handle exceptions gracefully
+    rescue OracleOWS::Error => e
+      # handle exception gracefully
+    ensure
+      {} # at least return a blank hash
+    end
+
+    #
+    # CheckOut
+    #
+    # @param [Hash] options for API call
+    # @option options [String] :hotel_code to identify the hotel
+    # @option options [String] :key_1 Key #1
+    # @option options [String] :key_2 Key #2
+    # @option options [String] :key_3 Key #3
+    # @option options [String] :key_4 Key #4
+    #
+    # @return [Hash] result hash from deeply nested XML Response
+    #
+    def checkout(options = {})
+      return {} if options.blank?
+
+      response = soap_client.call(
+        :check_out,
+        message: {
+          'ReservationRequest' => {
+            'HotelReference' => { '@hotelCode' => options[:hotel_code] },
+            'KeyTrack' => {
+              '@Key1Track' => options[:key_1],
+              '@Key2Track' => options[:key_2],
+              '@Key3Track' => options[:key_3],
+              '@Key4Track' => options[:key_4]
+            }
+          }
+        }
+      )
+
+      # fetch the response safely (without exception or too many conditional blocks)
+      response.body.dig(:check_out_response, :result)
+
+    # handle exceptions gracefully
+    rescue OracleOWS::Error => e
+      # handle exception gracefully
+    ensure
+      {} # at least return a blank hash
+    end
+  end
+  # class
+end
+# module OracleOws

data/lib/oracle_ows/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+#
+# Version of this gem
+#
+module OracleOWS
+  VERSION = '0.2.1'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: oracle_ows
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Ram
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: Oracle Hospitality OPERA Web Self-Service
+email:
+- RamOnRails@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/config/dotenv.rb
+- lib/oracle_ows.rb
+- lib/oracle_ows/base.rb
+- lib/oracle_ows/common.rb
+- lib/oracle_ows/error.rb
+- lib/oracle_ows/guest_services.rb
+- lib/oracle_ows/house_keeping.rb
+- lib/oracle_ows/information.rb
+- lib/oracle_ows/reservation.rb
+- lib/oracle_ows/resv_advanced.rb
+- lib/oracle_ows/version.rb
+homepage: https://github.com/ramonrails/oracle_ows
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ramonrails/oracle_ows
+  source_code_uri: https://github.com/ramonrails/oracle_ows
+  changelog_uri: https://github.com/ramonrails/oracle_ows/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Oracle OWS
+test_files: []