sticapi_client 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48caaaaffe66f9c25ae03f590c3aaa053e7729eb3ade07af54df87e433e121a2
-  data.tar.gz: d68331e63db55c4264396f6bc9854717135cf01b35d4a4d4a1ec51dd58e023e3
+  metadata.gz: e81aef01f67335dc98ecc3836815760957fbdeb1b6fe7e7e0c28e5128a72f8b9
+  data.tar.gz: 000520ffeb54d0aecdf29c4d62e0b7e6530f086ff69272f470e4bb1162ccbef2
 SHA512:
-  metadata.gz: 583ec402bdbf5a96e16915a29cc0ca7ebb9e410f232ad103c14c4c2971e5ab715099006130d60cc3087a669c8e26c12d40ae8ba19657a6358f7106b1e26d275f
-  data.tar.gz: 4e345a62081344d11cc13538da994ad831e79ceaa7f7c0a219cab238adf80a7301c384f106e34c12176462f29c876391ebd53b53d7e39d502819d9cfc3420cb5
+  metadata.gz: 0f502a4f7c80b676b1cc05c2b2afee530e7fb037218a3f9d45d48951e67d5c98834eb7f1c551c0a010d2a464946e7028769fd0edd2cc17ad788d8c99115d31c0
+  data.tar.gz: a75a05d28e4d2c3a6a3f7ff1f6f39018c344813b82b648622b407ee655873e94c7887233effcb72f69ca9d191dbfeb2dd3e87a8ee0a7da69ef875287be2beddc

data/lib/sticapi_client/diario.rb

@@ -1,27 +1,76 @@
 module SticapiClient
   class Diario
-    def self.list(q = {}, page = 1)
-      Sticapi::SticapiClient.instance.sticapi_request("/diarios", q: q, kind: 'get', page: page)
+    # Pesquisa textual no diario
+    # Parâmetro q [Hash] parâmetros de busca
+    # Parâmetro page [Integer] Página das matérias (padrão 1) (de 25 em 25)
+    # Retorno [JSON] Dados do diário
+    #   campos: [id dataDisponibilizacao dataPublicacao nomeArquivo numero idStatusHistoricoAtual materia_id texto titulo]
+    def self.list(options = {})
+      options[:kind] = 'get'
+      options[:q] ||= {}
+      options[:page] ||= 1
+      Sticapi::SticapiClient.instance.sticapi_request("/diarios", options)
     end
 
-    def self.show(id, legacy = false)
-      Sticapi::SticapiClient.instance.sticapi_request("/diarios/#{id}", legacy: legacy, kind: 'get')
+    # Consulta a um diário específico
+    # Parâmetro id [Integer] ID do diário
+    # Parâmetro legacy [Boolean] diário antigo? (padrão false) (antes de 03/02/2016)
+    # Retorno [JSON] Dados do diário
+    #   campos: [id dataDisponibilizacao dataPublicacao nomeArquivo numero idStatusHistoricoAtual]
+    def self.show(options = {})
+      options[:kind] = 'get'
+      options[:legacy] ||= false
+      if (options[:id])
+        Sticapi::SticapiClient.instance.sticapi_request("/diarios/#{options[:id]}", options)
+      else
+        {}
+      end
     end
 
-    def self.materias(id, page)
-      Sticapi::SticapiClient.instance.sticapi_request("/diarios/#{id}/materias", page: page, kind: 'get')
+    # Consulta as matérias de um diário específico
+    # Parâmetro id [Integer] ID do diário
+    # Parâmetro page [Integer] Página das matérias (padrão 1) (de 25 em 25)
+    # Retorno [JSON] Dados do diário
+    #   campos: [pagina strMunicipio strVaraOuCamara texto titulo desc_secao idSecao id]
+    def self.materias(options = {})
+      options[:kind] = 'get'
+      options[:page] ||= 1
+      if (options[:id])
+        Sticapi::SticapiClient.instance.sticapi_request("/diarios/#{options[:id]}/materias", options)
+      else
+        {}
+      end
     end
     
-    def self.find_by_date_and_number(date=Date.today, number=1)
-      Sticapi::SticapiClient.instance.sticapi_request("/diarios/find_by_date_and_number", date: date, number: number, kind: 'post')
+    # Consulta o diário por data e ID
+    # Parâmetro date [Date] Data do diário (padrão hoje)
+    # Parâmetro number [Date] ID do diário
+    # Retorno [JSON] Dados do diário
+    #   campos: [id dataPublicacao numero url]
+    def self.find_by_date_and_number(options = {})
+      options[:date] ||= Date.today
+      Sticapi::SticapiClient.instance.sticapi_request("/diarios/find_by_date_and_number", options)
     end
 
-    def self.feriados(inicio: Date.today, fim: 1.month.after)
-      Sticapi::SticapiClient.instance.sticapi_request('/diarios/feriados', inicio: inicio, fim: fim)
+    # Calcula os feriados entre duas datas
+    # Parâmetro inicio [Date] Data inicial (padrão data corrente)
+    # Parâmetro fim [Date] Data final (padrão data corrente + 1 mês)
+    # Retorno [JSON] Dados do período buscado
+    #   campos: [inicio fim feriados lista_feriados lista_feriados_formatados]
+    def self.feriados(options = {})
+      options[:inicio] ||= Date.today
+      options[:fim] ||= 1.month.after
+      options[:ibge] ||= '2211001'
+      Sticapi::SticapiClient.instance.sticapi_request('/diarios/feriados', options)
     end
 
-    def self.proximo_dia_util(inicio: Date.today)
-      Sticapi::SticapiClient.instance.sticapi_request("/diarios/proximo_dia_util", inicio: inicio)
+    # Calcula o pŕoximo dia últil a partir de uma data
+    # Parâmetro inicio [Date] Data inicial (padrão data corrente)
+    # Retorno [JSON] Dados do período buscado
+    #   campos: [inicio dia_formatado dia datas feriados fins_de_semana lista_fins_de_semana lista_feriados]
+    def self.proximo_dia_util(options = {})
+      options[:inicio] ||= Date.today
+      Sticapi::SticapiClient.instance.sticapi_request("/diarios/proximo_dia_util", options)
     end
   end
 end

data/lib/sticapi_client/etjpi.rb

@@ -1,11 +1,23 @@
 module SticapiClient
   class Etjpi
-    def self.id_to_processo(id)
-      Sticapi::SticapiClient.instance.sticapi_request("/etjpi/#{id}/id_to_processo")
+    # Buscar o número de um processo do eTJPI
+    # Parâmetro id [Integer] ID do processo
+    # Retorno [JSON] Números do processo
+    #  campos: [id_processo num_processo]
+    def self.id_to_processo(options = {})
+      options[:kind] = 'get'
+      if (options[:id])
+        Sticapi::SticapiClient.instance.sticapi_request("/etjpi/#{options[:id]}/id_to_processo", options)
+      else
+        nil
+      end
     end
-
+    
+    # Buscar a lista de processos sobrestados no eTJPI
+    # Retorno [JSON] Lista de processos
+    #  campos: [num_processo cod_classe_cnj classe num_unico tema tipo orgao data]
     def self.sobrestamentos
-      Sticapi::SticapiClient.instance.sticapi_request("/etjpi/sobrestamentos")
+      Sticapi::SticapiClient.instance.sticapi_request("/etjpi/sobrestamentos", kind: 'get')
     end
   end
 end

data/lib/sticapi_client/intranet.rb

@@ -1,39 +1,136 @@
 module SticapiClient
   class Intranet
-    def self.tipo_usuario(username)
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/tipo_usuario', username: username)
+    # Consulta a dados do usuário do Intranet
+    # Parâmetro username [String] Nome do usuário
+    # Retorno [JSON] Dados básicos da pessoa
+    #   campos: [login cpf matricula rgNumero rgOrgaoExpedidor rgDataEmissao rgOrgaoExpedidorUF_sigla nomeCompleto sexo nascimentoData categoria foto url_foto]
+    def self.tipo_usuario(options = {})
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/tipo_usuario', options)
     end
-
-    def self.cpfs_deferidos
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/cpfs_deferidos')
+    
+    # Grau judicial do usuário do Intranet
+    # Parâmetro cpf [String] CPF do usuário
+    # Retorno [JSON] Dados da pessoa com grau judicial
+    #   campos: [id nascimentoData nomeCompleto rgDataEmissao rgNumero rgOrgaoExpedidor sexo cpf rgOrgaoExpedidorUF_sigla matricula categoria competenciaJudicial grauJudicial]
+    def self.grau_usuario(options = {})
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/grau_usuario', options)
     end
-
-    def self.pessoa_info(cpf)
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/pessoa_info', cpf: cpf)
+    
+    # Dados básicos dos usuário ativos do Intranet
+    # Retorno [JSON] Dados dos usuários ativos
+    #   campos: [id nascimentoData sexo cpf nome email data_posse_efetivo categoria cargo_efetivo_id cargo_efetivo_descricao cargo_comissionado_id cargo_comissionado_descricao]
+    def self.servidor
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/servidor')
     end
-
-    def self.pre_pessoa_info(cpf)
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/pre_pessoa_info', cpf: cpf)
+    
+    # Lista de servidores para o odoo
+    # Parâmetro cpf [String] CPF do usuário
+    # Parâmetro matricula [Integer] Matrícula do usuário
+    # Retorno [JSON] Dados da pessoa
+    #   campos: [id estadoCivil nascimentoData nomeCompleto sexo cpf user_login matricula logradouro bairro cep cidade sigla email cargo_id cargo ativo orgao_id orgao_caminho orgao_descricao orgao_sigla cidade_lotacao cidade_lotacao_estado cidade_lotacao_ibge foto url_foto email_pessoal competenciaJudicial grauJudicial categoria dataExercicio dataNomeacao dataInicio gestor_cpf gestor_nomeCompleto funcao funcao_abreviada funcao_terceirizado]
+    def self.odoo_servidor(options = {})
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/odoo_servidor', options)
     end
-
-    def self.unidade_info(id)
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/unidade_info', id: id)
+    
+    # Lista de dependentes de um servidor para o odoo
+    # Parâmetro cpf [String] CPF do usuário
+    # Retorno [JSON] Dados dos dependentes da pessoa
+    #   campos: [{id ctpsNumero ctpsSerie docMilitarCat docMilitarNumero docMilitarSerie docMilitarUnidade escolaridade estadoCivil filiacaoAvoFMaterno filiacaoAvoFPaterno filiacaoAvoMMaterno filiacaoAvoMPaterno filiacaoMae filiacaoMaeCPF filiacaoPai filiacaoPaiCPF momentoCadastro nascimentoData nitPisPasepNum nomeCompleto rgDataEmissao rgNumero rgOrgaoExpedidor sexo tituloEleitorNumero tituloEleitorSecao tituloEleitorZona cpf endereco_id rgOrgaoExpedidorUF_sigla nascimentoCidade_id tituloEleitorCidade_id obitoData racaCor nomeSocial emUniaoEstavel enderecoSecundario_id ctpsDigital tipo}]
+    def self.odoo_servidor_dependentes(options = {})
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/odoo_servidor_dependentes')
     end
     
-    def self.prazo(inicio: Date.today, prazo: 15, ibge: '2211001')
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/prazo', inicio: inicio, prazo: prazo, ibge: ibge)
+    # Lista de afastaentos de um servidor para o odoo
+    # Parâmetro cpf [String] CPF do usuário
+    # Parâmetro inicio [Date] Início do período
+    # Parâmetro fim [Date] Fim do período
+    # Retorno [JSON] Dados dos afastamentos da pessoa
+    #   campos: [{id pessoa_id pessoa_nome pessoa_cpf afastamento inicio fim fim_vinculo tipo_desvinculacao}]
+    def self.odoo_afastamentos(cpf: nil, inicio: nil, fim: nil)
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/odoo_afastamentos', cpf: cpf, inicio: inicio, fim: fim)
     end
-
-    def self.prazo_anterior(inicio: Date.today, prazo: 15, ibge: '2211001')
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/prazo_anterior', inicio: inicio, prazo: prazo, ibge: ibge)
+    
+    # Calcula o prazo em dias úteis a partir de uma data
+    # Parâmetro inicio [Date] Data inicial (padrão data corrente)
+    # Parâmetro prazo [Integer] Quantidade de dias úteis (padrão 15)
+    # Parâmetro ibge [String] Código IBGE da cidade (padrão 2211001, Teresina)
+    # Retorno [JSON] Dados do período buscado
+    #   campos: { cidade: {nome nomeBusca ibge pais_sigla gentilico estado_sigla} inicio prazo fim datas:[] feriados fins_de_semana lista_fins_de_semana:[] lista_feriados: []}
+    def self.prazo(options = {})
+      options[:inicio] ||= Date.today
+      options[:prazo] ||= 15
+      options[:ibge] ||= '2211001'
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/prazo', options)
     end
-
-    def self.dias_uteis(inicio: Date.today, fim: Date.tomorrow, ibge: '2211001')
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/dias_uteis', inicio: inicio, fim: fim, ibge: ibge)
+    
+    # Calcula o prazo anterior em dias úteis a partir de uma data 
+    # Parâmetro inicio [Date] Data inicial (padrão data corrente)
+    # Parâmetro prazo [Integer] Quantidade de dias úteis (padrão 15)
+    # Parâmetro ibge [String] Código IBGE da cidade (padrão 2211001, Teresina)
+    # Retorno [JSON] Dados do período buscado
+    #   campos: { cidade: {nome nomeBusca ibge pais_sigla gentilico estado_sigla} inicio prazo fim datas:[] feriados fins_de_semana lista_fins_de_semana:[] lista_feriados: []}
+    def self.prazo_anterior(options = {})
+      options[:inicio] ||= Date.today
+      options[:prazo] ||= 15
+      options[:ibge] ||= '2211001'
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/prazo_anterior', options)
+    end
+    
+    # Calcula os dias úteis num intervalo de datas
+    # Parâmetro inicio [Date] Data inicial (padrão data corrente)
+    # Parâmetro fim [Date] Data final (padrão data corrente + 1)
+    # Parâmetro ibge [String] Código IBGE da cidade (padrão 2211001, Teresina)
+    # Retorno [JSON] Dados do período buscado
+    #   campos: { cidade: {nome nomeBusca ibge pais_sigla gentilico estado_sigla} inicio prazo fim datas:[] feriados fins_de_semana lista_fins_de_semana:[] lista_feriados: []}
+    def self.dias_uteis(options = {})
+      options[:inicio] ||= Date.today
+      options[:fim] ||= Date.tomorrow
+      options[:ibge] ||= '2211001'
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/dias_uteis', options)
+    end
+    
+    # Calcula os feriados entre duas datas
+    # Parâmetro inicio [Date] Data inicial (padrão data corrente)
+    # Parâmetro fim [Date] Data final (padrão data corrente + 1 mês)
+    # Parâmetro ibge [String] Código IBGE da cidade (padrão 2211001, Teresina)
+    # Retorno [JSON] Dados do período buscado
+    #   campos: { cidade: {nome nomeBusca ibge pais_sigla gentilico estado_sigla} inicio fim feriados lista_feriados: []}
+    def self.feriados(options = {})
+      options[:inicio] ||= Date.today
+      options[:fim] ||= 1.month.after
+      options[:ibge] ||= '2211001'
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/feriados', options)
+    end
+    
+    # Dados de uma unidade do intranet
+    # Parâmetro id [Integer] Id da unidade no intranet
+    # Retorno [JSON] Dados da unidade
+    #   campos: grauJudicial mesmoEnteFederado global_unidadeorganizacional:{id ativo caminho descricao descricaoAbreviada permiteLotacao sigla} global_contatos:[{id obs pessoal tipo valor valorComplemento global_tipoorgao:{id adjetivoGestor adjetivoSubgestor assessoria caraterPermanente grupoConceitual permiteMembros unidadeSuperior_id global_unidadeorganizacional:{id ativo caminho descricao descricaoAbreviada permiteLotacao sigla}]
+    def self.unidade_info(options = {})
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/unidade_info', options)
+    end
+    
+    # Lista de CPFs deferidos ndo intranet
+    # Retorno [JSON] CPFS
+    #   campos: [Sring]
+    def self.cpfs_deferidos
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/cpfs_deferidos')
+    end
+    
+    # Dados de uma pré-pessoa fisica do Intranet
+    # Parâmetro cpf [String] CPF da pessoa
+    # Retorno [JSON] Dados da pessoa no intranet
+    #   campos: Estrutura completa da pré-pessoa do intranet
+    def self.pre_pessoa_info(cpf)
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/pre_pessoa_info', cpf: cpf)
     end
 
-    def self.feriados(inicio: Date.today, fim: 1.month.after, ibge: '2211001')
-      Sticapi::SticapiClient.instance.sticapi_request('/intranet/feriados', inicio: inicio, fim: fim, ibge: ibge)
+    # Dados de uma pessoa física do Intranet
+    # Parâmetro cpf [String] CPF da pessoa
+    # Retorno [JSON] Dados da pessoa no intranet
+    #   campos: Estrutura completa da pessoa do intranet
+    def self.pessoa_info(cpf)
+      Sticapi::SticapiClient.instance.sticapi_request('/intranet/pessoa_info', cpf: cpf)
     end
   end
 end

data/lib/sticapi_client/transparencia.rb

@@ -0,0 +1,20 @@
+module SticapiClient
+  class Transparencia
+    # Buscar número de oficiais de justiça por unidade
+    # Retorno [JSON] Quantidade de oficiais de justiça em cada unidade
+    #  campos: [id total_oficiais caminho descricao cidade cidade_id cidade_ibge]
+    def self.oficiais_por_unidade
+      Sticapi::SticapiClient.instance.sticapi_request("/transparencia/oficiais_por_unidade", kind: 'get')
+    end
+    
+    # Buscar a lista de processos sobrestados no eTJPI
+    # Parâmetro ibge [String] Código IBGE da cidade (padrão 2211001, Teresina)
+    # Retorno [JSON] Relatório do Município
+    #  campos: [dados_intranet dados_themis]
+    def self.municipio_info(options = {})
+      options[:kind] = 'get'
+      options[:ibge] ||= '2211001'
+      Sticapi::SticapiClient.instance.sticapi_request("/transparencia/municipio_info", options)
+    end
+  end
+end

data/lib/sticapi_client/user.rb

@@ -0,0 +1,7 @@
+module SticapiClient
+  class User
+    def self.find_user(filter: 'cn', value: '')
+      Sticapi::SticapiClient.instance.sticapi_request("/users/find_user", kind: 'post', filter: filter, value: value)
+    end
+  end
+end

data/lib/sticapi_client/version.rb

@@ -1,3 +1,3 @@
 module SticapiClient
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

data/lib/sticapi_client.rb

@@ -12,6 +12,8 @@ require 'sticapi_client/gestorh'
 require 'sticapi_client/pessoas'
 require 'sticapi_client/sip'
 require 'sticapi_client/themis'
+require 'sticapi_client/transparencia'
+require 'sticapi_client/user'
 require 'net/http'
 
 module Sticapi
@@ -21,6 +23,7 @@ module Sticapi
     attr_accessor :host
     attr_accessor :urn
     attr_accessor :port
+    attr_accessor :ssl
     attr_accessor :user
     attr_accessor :password
     attr_accessor :access_token
@@ -35,6 +38,7 @@ module Sticapi
       @port = configs['port'] || 80
       @user = configs['user']
       @urn = configs['urn']
+      @ssl = configs['ssl'] || false
       @password = configs['password']
       @access_token = ''
       @client = ''
@@ -44,13 +48,14 @@ module Sticapi
     end
 
     def uri
-      "http://#{@host}:#{@port}#{'/' if @urn}#{@urn}"
+      "http#{'s' if @ssl}://#{@host}:#{@port}#{'/' if @urn}#{@urn}"
     end
 
     def get_token
       if @access_token.blank?
         uri = URI.parse("#{self.uri}/auth/sign_in")
         http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = @ssl
         request = Net::HTTP::Post.new(uri.request_uri)
         request['email'] = @user
         request['password'] = @password
@@ -70,6 +75,7 @@ module Sticapi
       kind = options[:kind] || 'post'
       uri = URI.parse("#{self.uri}#{route}")
       http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = @ssl
       request = nil
       request = Net::HTTP::Post.new(uri.request_uri) if kind == 'post'
       request = Net::HTTP::Get.new(uri.request_uri) if kind == 'get'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sticapi_client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ricardo Viana
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -113,6 +113,8 @@ files:
 - lib/sticapi_client/sticapi_controller.rb
 - lib/sticapi_client/sticapi_devise_strategy.rb
 - lib/sticapi_client/themis.rb
+- lib/sticapi_client/transparencia.rb
+- lib/sticapi_client/user.rb
 - lib/sticapi_client/version.rb
 homepage: https://github.com/zezim/sticapi_client
 licenses:
@@ -133,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Client to use TJPI sticapi services