brasilapi 0.8.0 → 0.9.0

data/lib/brasil_api/tuss.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
+module BrasilAPI
+  # Terminologia Unificada da Saúde Suplementar.
+  #
+  # @see https://brasilapi.com.br/docs#tag/TUSS
+  class TUSS < Base
+    # Filtros de listagem, busca e autocompletar, e o nome enviado na query.
+    #
+    # @return [Hash{Symbol=>Symbol}]
+    PARAMS = {
+      query: :q,
+      name: :name,
+      code: :tuss,
+      match: :match,
+      sort: :sort,
+      order: :order,
+      fields: :fields,
+      limit: :limit,
+      offset: :offset
+    }.freeze
+
+    class << self
+      # Lista procedimentos da TUSS.
+      #
+      # @param filters [Hash] filtros opcionais
+      # @option filters [String] :query texto livre (+q+)
+      # @option filters [String] :name nome do procedimento
+      # @option filters [String] :code código TUSS (+tuss+)
+      # @option filters [String] :match modo de correspondência
+      # @option filters [String] :sort campo de ordenação
+      # @option filters [String] :order direção da ordenação
+      # @option filters [String] :fields campos devolvidos
+      # @option filters [Integer] :limit quantidade máxima de itens
+      # @option filters [Integer] :offset deslocamento da página
+      # @return [Hash] total e lista de procedimentos
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Primeiro procedimento
+      #   BrasilAPI::TUSS.all(limit: 1)
+      # @see https://brasilapi.com.br/docs#tag/TUSS
+      def all(**filters)
+        get("/tuss/v1", translate(filters, PARAMS))
+      end
+
+      # Busca um procedimento pelo código TUSS.
+      #
+      # @param code [String, Integer] código do procedimento
+      # @return [Hash] descrição do procedimento
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando o código não existe
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example Consulta em consultório
+      #   BrasilAPI::TUSS.find_by_code("10101012")
+      # @see https://brasilapi.com.br/docs#tag/TUSS
+      def find_by_code(code)
+        get("/tuss/v1/#{code}")
+      end
+
+      # Procura procedimentos por texto e filtros.
+      #
+      # @param filters [Hash] filtros opcionais; as chaves são as de {PARAMS}
+      # @option filters [String] :query texto livre (+q+)
+      # @option filters [String] :name nome do procedimento
+      # @option filters [String] :code código TUSS (+tuss+)
+      # @option filters [String] :match modo de correspondência
+      # @option filters [String] :sort campo de ordenação
+      # @option filters [String] :order direção da ordenação
+      # @option filters [String] :fields campos devolvidos
+      # @option filters [Integer] :limit quantidade máxima de itens
+      # @option filters [Integer] :offset deslocamento da página
+      # @return [Hash] total e procedimentos encontrados
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::TUSS.search(query: "consulta", limit: 1)
+      # @see https://brasilapi.com.br/docs#tag/TUSS
+      def search(**filters)
+        get("/tuss/v1/search", translate(filters, PARAMS))
+      end
+
+      # Sugere procedimentos a partir de um prefixo.
+      #
+      # @param filters [Hash] filtros opcionais; as chaves são as de {PARAMS}
+      # @option filters [String] :query texto livre (+q+)
+      # @option filters [String] :name nome do procedimento
+      # @option filters [String] :code código TUSS (+tuss+)
+      # @option filters [String] :match modo de correspondência
+      # @option filters [String] :sort campo de ordenação
+      # @option filters [String] :order direção da ordenação
+      # @option filters [String] :fields campos devolvidos
+      # @option filters [Integer] :limit quantidade máxima de itens
+      # @option filters [Integer] :offset deslocamento da página
+      # @return [Hash] sugestões de procedimentos
+      # @raise [BrasilAPI::BadRequest] quando a BrasilAPI responde 400
+      # @raise [BrasilAPI::NotFound] quando a BrasilAPI responde 404
+      # @raise [BrasilAPI::ServerError] quando a BrasilAPI responde 5xx
+      # @raise [BrasilAPI::Timeout] quando a requisição estoura o tempo limite
+      # @raise [BrasilAPI::Error] em outras respostas de erro
+      # @example
+      #   BrasilAPI::TUSS.autocomplete(query: "cons", limit: 5)
+      # @see https://brasilapi.com.br/docs#tag/TUSS
+      def autocomplete(**filters)
+        get("/tuss/v1/autocomplete", translate(filters, PARAMS))
+      end
+    end
+  end
+end

data/lib/brasil_api/version.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
 module BrasilAPI
-  VERSION = "0.8.0"
+  # Versão publicada da gem, no formato +MAJOR.MINOR.PATCH+.
+  VERSION = "0.9.0"
 end

data/lib/brasil_api.rb

@@ -1,5 +1,15 @@
 # frozen_string_literal: true
 
+# Cliente Ruby da {https://brasilapi.com.br BrasilAPI}.
+#
+# Cada família de endpoint é uma classe com métodos de classe.
+#
+# @example Bancos participantes do STR
+#   BrasilAPI::Bank.all
+# @see https://brasilapi.com.br/docs
+module BrasilAPI
+end
+
 require_relative "brasil_api/version"
 require_relative "brasil_api/configuration"
 require_relative "brasil_api/error"
@@ -17,3 +27,16 @@ require_relative "brasil_api/ncm"
 require_relative "brasil_api/pix"
 require_relative "brasil_api/registrobr"
 require_relative "brasil_api/taxas"
+require_relative "brasil_api/b3"
+require_relative "brasil_api/business_days"
+require_relative "brasil_api/cambio"
+require_relative "brasil_api/cid10"
+require_relative "brasil_api/cpf"
+require_relative "brasil_api/ddd"
+require_relative "brasil_api/geolocation"
+require_relative "brasil_api/hospital"
+require_relative "brasil_api/ibpt"
+require_relative "brasil_api/igpm"
+require_relative "brasil_api/solar"
+require_relative "brasil_api/status"
+require_relative "brasil_api/tuss"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brasilapi
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Dayvid Emerson
@@ -26,6 +26,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -35,21 +36,34 @@ files:
 - Rakefile
 - lib/brasil_api.rb
 - lib/brasil_api/address.rb
+- lib/brasil_api/b3.rb
 - lib/brasil_api/bank.rb
 - lib/brasil_api/base.rb
+- lib/brasil_api/business_days.rb
+- lib/brasil_api/cambio.rb
+- lib/brasil_api/cid10.rb
 - lib/brasil_api/company.rb
 - lib/brasil_api/configuration.rb
+- lib/brasil_api/cpf.rb
 - lib/brasil_api/cptec.rb
 - lib/brasil_api/cvm.rb
+- lib/brasil_api/ddd.rb
 - lib/brasil_api/error.rb
 - lib/brasil_api/fipe.rb
+- lib/brasil_api/geolocation.rb
 - lib/brasil_api/holiday.rb
+- lib/brasil_api/hospital.rb
 - lib/brasil_api/ibge.rb
+- lib/brasil_api/ibpt.rb
+- lib/brasil_api/igpm.rb
 - lib/brasil_api/isbn.rb
 - lib/brasil_api/ncm.rb
 - lib/brasil_api/pix.rb
 - lib/brasil_api/registrobr.rb
+- lib/brasil_api/solar.rb
+- lib/brasil_api/status.rb
 - lib/brasil_api/taxas.rb
+- lib/brasil_api/tuss.rb
 - lib/brasil_api/version.rb
 - lib/brasilapi.rb
 homepage: https://brasilapi.com.br
@@ -59,6 +73,7 @@ metadata:
   homepage_uri: https://brasilapi.com.br
   source_code_uri: https://github.com/dayvidemerson/brasilapi-rb
   changelog_uri: https://github.com/dayvidemerson/brasilapi-rb/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/brasilapi
   rubygems_mfa_required: 'true'
   github_repo: ssh://github.com/dayvidemerson/brasilapi-rb
 rdoc_options: []