siba_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0407b762bb94232363d947d76afaead1441da284c7b7e1aab71a8d9cb4322604
-  data.tar.gz: ca5290b3e621ada85990432ccb2544ee5d2548a9369e4e0d1ddf1368ccb89603
+  metadata.gz: 2929ab1ae6f928a97b601d83ea4d871b1959e2848a2bc92b0399246fc14363bc
+  data.tar.gz: a31566a2a8674a88f43ae8d5165767f5ec46e9df0a8b026a8bf3a675e2adfcf1
 SHA512:
-  metadata.gz: 551cb36918ce40eaf0f8cfa53cd1c874049f3ce68115f051366d2ad667ec73df669457eff3900f696b9fad2deaaae3b8deab5a4ac744313ec31ca0305ed549c6
-  data.tar.gz: a6d141af352dfc63ca5b73955ff68746244387581a807262e0736b535762505aba82efb4cb9637e1d4b97406645396f8074f11efc18dfdff99606d1a226fbac9
+  metadata.gz: 1438b3ca259ab15f0af6cf20c14107aaddc0a4dabfec1efb8456517d83bd0d9a819fc5781c8b213f2032dfd66f035f96482101a74cb6e53b02b762ad1227c6f5
+  data.tar.gz: 177a6e089009cbad1efe1cf4b02b861ffd9208e19274976c7db0669dd522ad8f9c26cdd38e4c36d796146717378764e678455a2342eb96d4a482925703e33dd2

data/Gemfile

@@ -5,8 +5,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in siba_api.gemspec
 gemspec
 
-gem 'dotenv', '~> 2.7'
-
 group :test do
   gem 'rake', '~> 13.0'
   gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,62 +1,68 @@
 PATH
   remote: .
   specs:
-    siba_api (0.1.0)
-      gyoku (~> 1.0)
-      savon (~> 2.12)
+    siba_api (0.1.1)
+      dry-configurable (~> 0.12)
+      gyoku (~> 1.4.0)
+      savon (~> 2.13)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     akami (1.3.1)
       gyoku (>= 0.4.0)
       nokogiri
     ast (2.4.2)
     builder (3.2.4)
+    concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
-    dotenv (2.7.6)
+    diff-lcs (1.5.0)
+    dry-configurable (0.16.1)
+      dry-core (~> 0.6)
+      zeitwerk (~> 2.6)
+    dry-core (0.9.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
     gyoku (1.4.0)
       builder (>= 2.1.2)
       rexml (~> 3.0)
     hashdiff (1.0.1)
-    httpi (2.5.0)
+    httpi (3.0.1)
       rack
-      socksify
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     mini_mime (1.1.2)
-    nokogiri (1.13.8-aarch64-linux)
+    nokogiri (1.13.9-aarch64-linux)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-linux)
+    nokogiri (1.13.9-x86_64-linux)
       racc (~> 1.4)
     nori (2.6.0)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
+    public_suffix (5.0.0)
     racc (1.6.0)
-    rack (2.2.4)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rack (3.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
@@ -66,10 +72,10 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    savon (2.13.0)
+    savon (2.13.1)
       akami (~> 1.2)
       builder (>= 2.1.2)
       gyoku (~> 1.2)
@@ -78,24 +84,23 @@ GEM
       nokogiri (>= 1.8.1)
       nori (~> 2.4)
       wasabi (~> 3.4)
-    socksify (1.7.1)
-    unicode-display_width (1.7.0)
-    vcr (6.0.0)
-    wasabi (3.7.0)
+    unicode-display_width (1.8.0)
+    vcr (6.1.0)
+    wasabi (3.8.0)
       addressable
-      httpi (~> 2.0)
+      httpi (~> 3.0)
       nokogiri (>= 1.4.2)
-    webmock (3.12.2)
-      addressable (>= 2.3.6)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.1)
 
 PLATFORMS
   aarch64-linux
   x86_64-linux
 
 DEPENDENCIES
-  dotenv (~> 2.7)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.80)

data/lib/siba_api/api.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require_relative 'api_exceptions'
-require_relative 'configuration'
 require_relative 'constants'
 require_relative 'http_status_codes'
+require 'dry-configurable'
 
 module SIBAApi
   # Core class responsible for api interface operations
@@ -11,22 +11,8 @@ module SIBAApi
     include ApiExceptions
     include Constants
     include HttpStatusCodes
+    include Dry::Configurable
 
-    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,
@@ -36,15 +22,42 @@ module SIBAApi
       'default' => ApiError
     }.freeze
 
+    setting :follow_redirects, default: true
+
+    # The value sent in the http header for 'User-Agent' if none is set
+    setting :user_agent, default: "SIBAApi API Ruby Gem #{SIBAApi::VERSION}"
+
+    # By default uses the Faraday connection options if none is set
+    setting :connection_options, default: {}
+
+    # Add Faraday::RackBuilder to overwrite middleware
+    setting :stack
+
+    # WSDL to use for SIBA API
+    setting :wsdl, default: API_WSDL, reader: true
+
+    # Hotel unit
+    setting :hotel_unit, default: API_HOTEL_UNIT, reader: true
+
+    # API Key
+    setting :access_key, default: API_ACCESS_KEY, reader: true
+
+    # Establishment to use
+    setting :establishment, default: API_ESTABLISHMENT, reader: true
+
+    # Hotel Unit complete information
+    setting :hotel_unit_info, default: API_HOTEL_UNIT_INFO, reader: true
+
+    attr_accessor :last_response
+
     # 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])
+      configure do |c|
+        options.each_key do |key|
+          c.send("#{key}=", options[key])
+        end
       end
 
       yield_or_eval(&block) if block_given?
@@ -63,7 +76,7 @@ module SIBAApi
 
     def client
       @client ||= Savon.client do |globals|
-        globals.wsdl @wsdl
+        globals.wsdl config.wsdl
         globals.log true
         globals.log_level :debug
         globals.convert_request_keys_to :camelcase
@@ -72,9 +85,9 @@ module SIBAApi
 
     def request(operation:, params: {})
       default_params = {
-        UnidadeHoteleira: @current_options[:hotel_unit],
-        Estabelecimento: @current_options[:establishment],
-        ChaveAcesso: @current_options[:access_key]
+        UnidadeHoteleira: config.hotel_unit,
+        Estabelecimento: config.establishment,
+        ChaveAcesso: config.access_key
       }
 
       response = client.call(operation.to_sym, message: default_params.merge(params))
@@ -112,24 +125,5 @@ module SIBAApi
     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).nil?
-      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/client.rb

@@ -86,7 +86,7 @@ module SIBAApi
     #     <Email_Contacto>teste.teste@sef.pt</Email_Contacto>
     #   </Unidade_Hoteleira>
     def build_hotel_unit
-      @hotel_unit_info
+      config.hotel_unit_info
     end
 
     #     <Numero_Ficheiro>97</Numero_Ficheiro>

data/lib/siba_api/constants.rb

@@ -58,5 +58,29 @@ module SIBAApi
     PARAM_START_PAGE = 'start_page'
 
     PARAM_INCLUDE_RELATED = 'include_related_objects'
+
+    # Default API config constants
+    API_WSDL = 'https://siba.sef.pt/bawsdev/boletinsalojamento.asmx?wsdl'
+
+    API_HOTEL_UNIT = '121212121'
+
+    API_HOTEL_UNIT_INFO = {
+      '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'
+    }.freeze
+
+    API_ACCESS_KEY = '999999999'
+
+    API_ESTABLISHMENT = '00'
   end
 end

data/lib/siba_api/version.rb

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

data/lib/siba_api.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'savon'
 require_relative 'siba_api/version'
+require 'savon'
 
 # Base module for SIBA API Wrapper
 module SIBAApi
@@ -12,35 +12,6 @@ module SIBAApi
   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
@@ -69,20 +40,15 @@ module SIBAApi
     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)
+      new.respond_to?(method_name, include_private) || super(method_name, include_private)
     end
   end
 end
 
 require_relative 'siba_api/client'
-require_relative 'siba_api/configuration'

data/siba_api.gemspec

@@ -30,10 +30,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency 'gyoku', '~> 1.0'
-  spec.add_dependency 'savon', '~> 2.12'
+  spec.add_dependency 'gyoku', '~> 1.4.0'
+  spec.add_dependency 'savon', '~> 2.13'
 
-  # spec.add_dependency 'dry-configurable', '~> 0.12.1'
+  spec.add_dependency 'dry-configurable', '~> 0.12'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: siba_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dinis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gyoku
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 description: A gem that implements functions from the SIBA API.
 email:
 - dinis@lage.pw
@@ -64,12 +78,8 @@ files:
 - docker-compose.yml
 - lib/siba_api.rb
 - lib/siba_api/api.rb
-- lib/siba_api/api/config.rb
-- lib/siba_api/api/config/property.rb
-- lib/siba_api/api/config/property_set.rb
 - lib/siba_api/api_exceptions.rb
 - lib/siba_api/client.rb
-- lib/siba_api/configuration.rb
 - lib/siba_api/constants.rb
 - lib/siba_api/http_status_codes.rb
 - lib/siba_api/version.rb

data/lib/siba_api/api/config/property.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module SIBAApi
-  class API
-    class Config
-      # Property objects provide an interface for configuration options
-      class Property
-        attr_reader :name, :default, :required
-
-        def initialize(name, options)
-          @name = name
-          @default = options.fetch(:default, nil)
-          @required = options.fetch(:required, nil)
-          @options = options
-        end
-
-        # @api private
-        def define_accessor_methods(properties)
-          properties.define_reader_method(self, name, :public)
-          properties.define_writer_method(self, "#{name}=", :public)
-        end
-      end
-    end
-  end
-end

data/lib/siba_api/api/config/property_set.rb

@@ -1,119 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module SIBAApi
-  class API
-    class Config
-      # Class responsible for storing configuration properties
-      class PropertySet
-        include Enumerable
-
-        attr_reader :parent, :properties
-
-        # Initialize an PropertySet
-        #
-        # @param [Object] parent
-        # @param [Set] properties
-        #
-        # @return [undefined]
-        #
-        # @api private
-        def initialize(parent = nil, properties = Set.new)
-          @parent = parent
-          @properties = properties
-          @map = {}
-        end
-
-        # Iterate over properties
-        #
-        # @yield [property]
-        #
-        # @yieldparam [Property] property
-        #
-        # @return [self]
-        #
-        # @api public
-        def each
-          return to_enum unless block_given?
-
-          @map.each { |name, property| yield property if name.is_a?(Symbol) }
-          self
-        end
-
-        # Adds property to the set
-        #
-        # @example
-        #   properties_set << property
-        #
-        # @param [Property] property
-        #
-        # @return [self]
-        #
-        # @api public
-        def <<(property)
-          properties << property
-          update_map(property.name, property.default)
-          property.define_accessor_methods(self)
-          self
-        end
-
-        # Access property by name
-        #
-        # @api public
-        def [](name)
-          @map[name]
-        end
-        alias fetch []
-
-        # Set property value by name
-        #
-        # @api public
-        def []=(name, property)
-          update_map(name, property)
-        end
-
-        # Update map with index
-        #
-        # @api private
-        def update_map(name, property)
-          @map[name.to_sym] = @map[name.to_s.freeze] = property
-        end
-
-        # Convert properties to a hash of property names and
-        # corresponding values
-        #
-        # @api public
-        def to_hash
-          properties.each_with_object({}) do |property, props|
-            name = property.name
-            props[name] = self[name]
-          end
-        end
-
-        # Check if properties exist
-        #
-        # @api public
-        def empty?
-          @map.empty?
-        end
-
-        # @api private
-        def define_reader_method(property, method_name, visibility)
-          property_set = self
-          parent.send(:define_method, method_name) { property_set[property.name] }
-          parent.send(visibility, method_name)
-        end
-
-        # @api private
-        def define_writer_method(property, method_name, visibility)
-          property_set = self
-          parent.send(:define_method, method_name) do |value|
-            property_set[property.name] = value
-          end
-          parent.send(visibility, method_name)
-        end
-      end
-    end
-  end
-end

data/lib/siba_api/api/config.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'config/property'
-require_relative 'config/property_set'
-
-module SIBAApi
-  class API
-    # A base class for constructing api configuration
-    class Config
-      # Defines a property on an object's class or instance
-      #
-      # @example
-      #   class Configuration < Api::Config
-      #     property :adapter, default: :net_http
-      #     property :user, required: true
-      #   end
-      #
-      # @param [Symbol] name
-      #   the name of a property
-      #
-      # @param [#to_hash] options
-      #   the extra options
-      #
-      # @return [self]
-      #
-      # @api public
-      def self.property(name, options = {})
-        property_set << Property.new(name, options)
-        update_subclasses(name, options)
-        self
-      end
-
-      def self.update_subclasses(name, options)
-        @subclasses.each { |klass| klass.property(name, options) } if defined?(@subclasses) && @subclasses
-      end
-
-      # Check if property is defined
-      #
-      # @param [Symbol] name
-      #   the name to check
-      #
-      # @return [Boolean]
-      #
-      # @api public
-      def self.property?(name)
-        property_set.include?(name)
-      end
-
-      class << self
-        attr_reader :property_set
-      end
-
-      instance_variable_set('@property_set', PropertySet.new(self))
-
-      def self.inherited(descendant)
-        super
-        (@subclasses ||= Set.new) << descendant
-        descendant.instance_variable_set(
-          '@property_set',
-          PropertySet.new(descendant, property_set.properties.dup)
-        )
-      end
-
-      def property_names
-        self.class.property_set.properties.map(&:name)
-      end
-
-      def self.property_names
-        property_set.properties.map(&:name)
-      end
-
-      # Fetch all the properties and their values
-      #
-      # @return [Hash[Symbol]]
-      #
-      # @api public
-      def fetch(value = nil)
-        if value
-          self.class.property_set[value]
-        else
-          self.class.property_set.to_hash
-        end
-      end
-
-      # Provide access to properties
-      #
-      # @example
-      #   config.call do |config|
-      #     config.adapter = :net_http
-      #   end
-      #
-      # @return [self]
-      #
-      # @api private
-      def call(&block)
-        block.call(self) if block_given?
-        self
-      end
-    end
-  end
-end

data/lib/siba_api/configuration.rb

@@ -1,48 +0,0 @@
-# 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