siba_api 0.1.0

data/lib/siba_api/api.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require_relative 'api_exceptions'
+require_relative 'configuration'
+require_relative 'constants'
+require_relative 'http_status_codes'
+
+module SIBAApi
+  # Core class responsible for api interface operations
+  class API
+    include ApiExceptions
+    include Constants
+    include HttpStatusCodes
+
+    attr_reader(*SIBAApi.configuration.property_names)
+
+    attr_accessor :current_options, :last_response
+
+    # Callback to update current configuration options
+    class_eval do
+      SIBAApi.configuration.property_names.each do |key|
+        define_method "#{key}=" do |arg|
+          instance_variable_set("@#{key}", arg)
+          current_options.merge!({ "#{key}": arg })
+        end
+      end
+    end
+
+    API_WSDL = 'https://siba.sef.pt/bawsdev/boletinsalojamento.asmx?wsdl'
+    HTTP_STATUS_MAPPING = {
+      HTTP_BAD_REQUEST_CODE => BadRequestError,
+      HTTP_UNAUTHORIZED_CODE => UnauthorizedError,
+      HTTP_FORBIDDEN_CODE => ForbiddenError,
+      HTTP_NOT_FOUND_CODE => NotFoundError,
+      HTTP_UNPROCESSABLE_ENTITY_CODE => UnprocessableEntityError,
+      'default' => ApiError
+    }.freeze
+
+    # Create new API
+    #
+    # @api public
+    def initialize(options = {}, &block)
+      opts = SIBAApi.configuration.fetch.merge(options)
+      @current_options = opts
+
+      SIBAApi.configuration.property_names.each do |key|
+        send("#{key}=", opts[key])
+      end
+
+      yield_or_eval(&block) if block_given?
+    end
+
+    # Call block with argument
+    #
+    # @api private
+    def yield_or_eval(&block)
+      return unless block
+
+      block.arity.positive? ? yield(self) : instance_eval(&block)
+    end
+
+    private
+
+    def client
+      @client ||= Savon.client do |globals|
+        globals.wsdl @wsdl
+        globals.log true
+        globals.log_level :debug
+        globals.convert_request_keys_to :camelcase
+      end
+    end
+
+    def request(operation:, params: {})
+      default_params = {
+        UnidadeHoteleira: @current_options[:hotel_unit],
+        Estabelecimento: @current_options[:establishment],
+        ChaveAcesso: @current_options[:access_key]
+      }
+
+      response = client.call(operation.to_sym, message: default_params.merge(params))
+      self.last_response = response
+
+      if response_successful?(response)
+        result = response.body["#{operation}_response".to_sym]["#{operation}_result".to_sym]
+        return response if result == '0'
+
+        parsed_response = parse_response(result)
+        raise error_class(response.http.code), "Code: #{parsed_response[:codigo_retorno]}, response: #{response.body}, description: #{parsed_response[:descricao]}"
+      end
+
+      raise error_class(response.http.code), "Code: #{response.http.code}, response: #{response.body}"
+    end
+
+    # Error:
+    # {:erros_ba=>
+    #   {:retorno_ba=>
+    #     {:linha=>"0",
+    #      :codigo_retorno=>"75",
+    #      :descricao=>
+    #       "Linha XML 6. -->The element 'Unidade_Hoteleira' in namespace 'http://sef.pt/BAws' has incomplete content. List of possible elements expected: 'Abreviatura' in namespace 'http://sef.pt/BAws'."},
+    #    :@xmlns=>"http://www.sef.pt/BAws"}}
+    #
+    # Success:
+    #
+    def parse_response(result)
+      inner_response = Nori.new(convert_tags_to: ->(tag) { tag.snakecase.to_sym }).parse(
+        result
+      )
+      return inner_response[:erros_ba][:retorno_ba] if inner_response[:erros_ba]
+
+      inner_response
+    end
+
+    def error_class(error_code)
+      if HTTP_STATUS_MAPPING.include?(error_code)
+        HTTP_STATUS_MAPPING[error_code]
+      else
+        HTTP_STATUS_MAPPING['default']
+      end
+    end
+
+    def response_successful?(response)
+      response.successful? and (response.http.code == HTTP_OK_CODE)
+    end
+
+    # Responds to attribute query or attribute clear
+    #
+    # @api private
+    def method_missing(method_name, *args, &block)
+      # :nodoc:
+      case method_name.to_s
+      when /^(.*)\?$/
+        !!send(Regexp.last_match(1).to_s)
+      when /^clear_(.*)$/
+        send("#{Regexp.last_match(1)}=", nil)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.start_with?('clear_') || super
+    end
+  end
+end

data/lib/siba_api/api_exceptions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SIBAApi
+  module ApiExceptions
+    APIExceptionError = Class.new(StandardError)
+    BadRequestError = Class.new(APIExceptionError)
+    UnauthorizedError = Class.new(APIExceptionError)
+    ForbiddenError = Class.new(APIExceptionError)
+    ApiRequestsQuotaReachedError = Class.new(APIExceptionError)
+    NotFoundError = Class.new(APIExceptionError)
+    UnprocessableEntityError = Class.new(APIExceptionError)
+    ApiError = Class.new(APIExceptionError)
+  end
+end

data/lib/siba_api/client.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'base64'
+require_relative 'api'
+
+# Implementation of available methods for SIBA API
+module SIBAApi
+  # Main client class that implements communication with the API
+  # global_params:
+  # - include_related_objects: int	0-1	0
+  # - page: int	positive	1
+  # - per_page: int	positive	20
+  class Client < API
+    # SIBAApi::Client.new.calendar(38859, '2022-01-01', '2022-07-31')
+    #          <sef:UnidadeHoteleira>?</sef:UnidadeHoteleira>
+    #          <sef:Estabelecimento>?</sef:Estabelecimento>
+    #          <!--Optional:-->
+    #          <sef:ChaveAcesso>?</sef:ChaveAcesso>
+    #          <!--Optional:-->
+    #          <sef:Boletins>?</sef:Boletins>
+    # Boletins:
+    # <sef:Apelido>Apelido</sef:Apelido>
+    # <sef:Nome>Teste</sef:Nome>
+    # <sef:Nacionalidade>DZA</sef:Nacionalidade>
+    # <sef:Data_Nascimento>2000-01-01</sef:Data_Nascimento>
+    # <sef:Local_Nascimento></sef:Local_Nascimento>
+    # <sef:Documento_Identificacao></sef:Documento_Identificacao>
+    # <sef:Pais_Emissor_Documento></sef:Pais_Emissor_Documento>
+    # <sef:Tipo_Documento></sef:Tipo_Documento>
+    # <sef:Pais_Residencia_Origem></sef:Pais_Residencia_Origem>
+    # <sef:Data_Entrada></sef:Data_Entrada>
+    # <sef:Data_Saida></sef:Data_Saida>
+    # <sef:Local_Residencia_Origem></sef:Local_Residencia_Origem>
+    #
+    #     'Apelido' => 'Surname',
+    #     'Nome' => 'Name',
+    #     'Nacionalidade' => 'VEN',
+    #     'Data_Nascimento' => '19990101',
+    #     'Local_Nascimento' => 'Place of Birth',
+    #     'Documento_Identificacao' => '123456789',
+    #     'Pais_Emissor_Documento' => 'YEM',
+    #     'Tipo_Documento' => 'P',
+    #     'Pais_Residencia_Origem' => 'ZMB',
+    #     'Data_Entrada' => '20220801',
+    #     'Data_Saida' => '20220831',
+    #     'Local_Residencia_Origem' => 'Place of Residence',
+    def deliver_bulletins(file_number, bulletins = [], _global_params = {})
+      logger = Logger.new $stderr
+      logger.level = Logger::DEBUG
+      bulletins_xml = Gyoku.xml(
+        {
+          'MovimentoBAL' => {
+            'Unidade_Hoteleira' => build_hotel_unit,
+            'Boletim_Alojamento' => build_bulletins(bulletins),
+            'Envio' => build_control_data(file_number),
+            :@xmlns => 'http://sef.pt/BAws'
+          }
+        },
+        pretty_print: true
+      )
+      logger.debug(bulletins_xml)
+      bulletins_encoded = Base64.encode64(bulletins_xml)
+      response = request(
+        operation: :entrega_boletins_alojamento,
+        params: {
+          Boletins: bulletins_encoded
+        }
+      )
+      process_response(response)
+    end
+
+    protected
+
+    #   <Unidade_Hoteleira>
+    #     <Codigo_Unidade_Hoteleira>121212121</Codigo_Unidade_Hoteleira>
+    #     <Estabelecimento>00</Estabelecimento>
+    #     <Nome>Hotel teste</Nome>
+    #     <Abreviatura>teste</Abreviatura>
+    #     <Morada>Rua da Alegria, 172</Morada>
+    #     <Localidade>Portalegre</Localidade>
+    #     <Codigo_Postal>1000</Codigo_Postal>
+    #     <Zona_Postal>234</Zona_Postal>
+    #     <Telefone>214017744</Telefone>
+    #     <Fax>214017766</Fax>
+    #     <Nome_Contacto>Nuno teste</Nome_Contacto>
+    #     <Email_Contacto>teste.teste@sef.pt</Email_Contacto>
+    #   </Unidade_Hoteleira>
+    def build_hotel_unit
+      @hotel_unit_info
+    end
+
+    #     <Numero_Ficheiro>97</Numero_Ficheiro>
+    #     <Data_Movimento>2008-05-20T00:00:00</Data_Movimento>
+    def build_control_data(file_number)
+      {
+        'Numero_Ficheiro' => file_number,
+        'Data_Movimento' => DateTime.now.strftime('%FT%T')
+      }
+    end
+
+    def build_bulletins(bulletins = [])
+      translation_hash = {
+        surname: 'Apelido',
+        name: 'Nome',
+        nationality: 'Nacionalidade',
+        birthdate: 'Data_Nascimento',
+        place_of_birth: 'Local_Nascimento',
+        id_document: 'Documento_Identificacao',
+        document_country: 'Pais_Emissor_Documento',
+        document_type: 'Tipo_Documento',
+        start_date: 'Data_Entrada',
+        end_date: 'Data_Saida',
+        origin_country: 'Pais_Residencia_Origem',
+        origin_place: 'Local_Residencia_Origem'
+      }
+      translated_bulletins = []
+      bulletins.each do |b|
+        bt = {}
+        translation_hash.each_key do |k|
+          bt[translation_hash[k]] = b[k]
+        end
+        translated_bulletins.push(bt)
+      end
+      translated_bulletins
+    end
+
+    def process_response(response)
+      result = response
+      case result
+      when Hash
+        result.transform_keys!(&:to_sym)
+        result.each_value do |r|
+          process_response(r)
+        end
+      when Array
+        result.each do |r|
+          process_response(r)
+        end
+      end
+      result
+    end
+  end
+end

data/lib/siba_api/configuration.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'api/config'
+require_relative 'version'
+
+module SIBAApi
+  # Stores the configuration
+  class Configuration < API::Config
+    property :follow_redirects, default: true
+
+    # The value sent in the http header for 'User-Agent' if none is set
+    property :user_agent, default: "SIBAApi API Ruby Gem #{SIBAApi::VERSION}"
+
+    # By default uses the Faraday connection options if none is set
+    property :connection_options, default: {}
+
+    # Add Faraday::RackBuilder to overwrite middleware
+    property :stack
+
+    # WSDL to use for SIBA API
+    property :wsdl, default: 'https://siba.sef.pt/bawsdev/boletinsalojamento.asmx?wsdl'
+
+    # Hotel unit
+    property :hotel_unit, default: '121212121'
+
+    # API Key
+    property :access_key, default: '999999999'
+
+    # Establishment to use
+    property :establishment, default: '00'
+
+    # Hotel Unit complete information
+    property :hotel_unit_info, default: {
+      'Codigo_Unidade_Hoteleira' => '121212121',
+      'Estabelecimento' => '00',
+      'Nome' => 'Hotel teste',
+      'Abreviatura' => 'teste',
+      'Morada' => 'Rua da Alegria, 172',
+      'Localidade' => 'Portalegre',
+      'Codigo_Postal' => '1000',
+      'Zona_Postal' => '234',
+      'Telefone' => '214017744',
+      'Fax' => '214017766',
+      'Nome_Contacto' => 'Nuno teste',
+      'Email_Contacto' => 'teste.teste@sef.pt'
+    }
+  end
+end

data/lib/siba_api/constants.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module SIBAApi
+  # Constants
+  module Constants
+    # Response headers
+    RATELIMIT_REMAINING = 'X-RateLimit-Remaining'
+
+    RATELIMIT_LIMIT = 'X-RateLimit-Limit'
+
+    RATELIMIT_RESET = 'X-RateLimit-Reset'
+
+    CONTENT_TYPE = 'Content-Type'
+
+    CONTENT_LENGTH = 'content-length'
+
+    CACHE_CONTROL = 'cache-control'
+
+    ETAG = 'ETag'
+
+    SERVER = 'Server'
+
+    DATE = 'Date'
+
+    LOCATION = 'Location'
+
+    USER_AGENT = 'User-Agent'
+
+    ACCEPT = 'Accept'
+
+    ACCEPT_CHARSET = 'Accept-Charset'
+
+    OAUTH_SCOPES = 'X-OAuth-Scopes'
+
+    ACCEPTED_OAUTH_SCOPES = 'X-Accepted-Oauth-Scopes'
+
+    # Link headers
+    HEADER_LINK = 'Link'
+
+    HEADER_NEXT = 'X-Next'
+
+    HEADER_LAST = 'X-Last'
+
+    META_REL = 'rel'
+
+    META_LAST = 'last'
+
+    META_NEXT = 'next'
+
+    META_FIRST = 'first'
+
+    META_PREV = 'prev'
+
+    PARAM_PAGE = 'page'
+
+    PARAM_PER_PAGE = 'per_page'
+
+    PARAM_START_PAGE = 'start_page'
+
+    PARAM_INCLUDE_RELATED = 'include_related_objects'
+  end
+end

data/lib/siba_api/http_status_codes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SIBAApi
+  module HttpStatusCodes
+    HTTP_OK_CODE = 200
+
+    HTTP_BAD_REQUEST_CODE = 400
+    HTTP_UNAUTHORIZED_CODE = 401
+    HTTP_FORBIDDEN_CODE = 403
+    HTTP_NOT_FOUND_CODE = 404
+    HTTP_UNPROCESSABLE_ENTITY_CODE = 429
+  end
+end

data/lib/siba_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SIBAApi
+  VERSION = '0.1.0'
+end

data/lib/siba_api.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'savon'
+require_relative 'siba_api/version'
+
+# Base module for SIBA API Wrapper
+module SIBAApi
+  class Error < StandardError; end
+
+  LIBNAME = 'siba_api'
+
+  LIBDIR = File.expand_path(LIBNAME.to_s, __dir__)
+
+  class << self
+    # The client configuration
+    #
+    # @return [Configuration]
+    #
+    # @api public
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias config configuration
+
+    # Configure options
+    #
+    # @example
+    #   SIBAApi.configure do |c|
+    #     c.some_option = true
+    #   end
+    #
+    # @yield the configuration block
+    # @yieldparam configuration [SIBAApi::Configuration]
+    #   the configuration instance
+    #
+    # @return [nil]
+    #
+    # @api public
+    def configure
+      yield configuration
+    end
+
+    # Alias for SIBAApi::Client.new
+    #
+    # @param [Hash] options
+    #   the configuration options
+    #
+    # @return [SEFApi::Client]
+    #
+    # @api public
+    def new(options = {}, &block)
+      Client.new(options, &block)
+    end
+
+    # Default middleware stack that uses default adapter as specified
+    # by configuration setup
+    #
+    # @return [Proc]
+    #
+    # @api private
+    def default_middleware(options = {})
+      Middleware.default(options)
+    end
+
+    # Delegate to SIBAApi::Client
+    #
+    # @api private
+    def method_missing(method_name, *args, &block)
+      if new.respond_to?(method_name)
+        new.send(method_name, *args, &block)
+      elsif configuration.respond_to?(method_name)
+        SIBAApi.configuration.send(method_name, *args, &block)
+      else
+        super.respond_to_missing?
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      new.respond_to?(method_name, include_private) ||
+        configuration.respond_to?(method_name) ||
+        super(method_name, include_private)
+    end
+  end
+end
+
+require_relative 'siba_api/client'
+require_relative 'siba_api/configuration'