Update 0.1

.gitignore

@@ -99,7 +99,7 @@ ipython_config.py
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
 #   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
+poetry.lock
 
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 __pypackages__/
@@ -149,4 +149,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

README.md

@@ -1,2 +1,51 @@
-# Python_valida_cnpj_ReceitaWS
- Sistema para validação de base de dados CNPJs gratuito
+# PoC CNPJ Analyzer | ReceitaWS
+[![Python Version](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
+[![Poetry Version](https://img.shields.io/badge/poetry-1.1.4-blue.svg)](https://python-poetry.org/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+
+Esta Prova de Conceito (PoC) demonstra a funcionalidade de análise de CNPJs utilizando uma API da Receita Federal e
+manipulação de arquivos Excel em Python, gerenciada pelo Poetry.
+
+## Estrutura do Projeto
+
+O projeto é composto por:
+
+- `main.py`: Script principal para análise de CNPJs.
+- `/services`: Módulos de serviços para análise de CNPJ, API da Receita Federal e gerenciamento de arquivos.
+- `/utils/make_data.py`: Script para geração de dados fictícios de contratantes.
+- `/.res`: Diretório para o arquivo Excel com dados fictícios.
+
+## Pré-requisitos
+
+Certifique-se de ter o Python 3.10 ou superior e o Poetry instalados em seu sistema.
+
+## Configuração do Projeto
+
+1. **Instalação das Dependências**: Dentro do diretório do projeto, execute o seguinte comando para instalar todas as
+   dependências listadas no `pyproject.toml`:
+
+    ```bash
+    poetry install
+    ```
+
+2. **Gerar Dados Fictícios**: Execute o script `make_data.py` para criar um arquivo Excel com dados fictícios:
+
+    ```bash
+    python /utils/make_data.py
+    ```
+
+   Isso irá gerar o arquivo `contratantes.xlsx` no diretório `/.res`.
+
+## Executando o Projeto
+
+Após configurar o ambiente, você pode executar o script principal com o seguinte comando:
+
+```bash
+python main.py
+```
+
+Isso iniciará a análise dos CNPJs, lendo os dados do arquivo Excel e realizando consultas na API da Receita Federal.
+
+## Saída Esperada
+
+O script exibirá no console a situação dos CNPJs analisados e gravará informações relevantes no arquivo `RelCNPJ.txt`.

main.py

@@ -0,0 +1,9 @@
+from services.analysers import CNPJAnalyzer
+from services.apis import ReceitaFederalService
+from services.files import FileManager
+
+CNPJAnalyzer(
+    ReceitaFederalService('https://www.receitaws.com.br/v1/cnpj')
+).analyze_cnpj(
+    FileManager('./.res/contratantes.xlsx').get_data_from_excel()
+)

pyproject.toml

@@ -0,0 +1,19 @@
+[tool.poetry]
+name = "python-valida-cnpj-receitaws"
+version = "0.1.0"
+description = ""
+authors = ["Marcus Vinicus Braga <mvbraga@gmail.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+requests = "^2.31.0"
+pandas = "^2.1.4"
+faker = "^21.0.0"
+openpyxl = "^3.1.2"
+chardet = "^5.2.0"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

services/analysers.py

@@ -0,0 +1,46 @@
+import os.path
+import re
+import time
+
+from services.apis import ReceitaFederalService
+
+
+class CNPJAnalyzer:
+    """
+    Classe principal para analisar CNPJs utilizando o serviço da Receita Federal.
+
+    Atributos:
+        receita_service (ReceitaFederalService): Instância do serviço de consulta à Receita Federal.
+    """
+
+    def __init__(self, receita_service: ReceitaFederalService):
+        self.receita_service = receita_service
+
+    def save_data(self, cnpj, situacao):
+        """
+        Salva a situação do CNPJ em um arquivo.
+
+        Parâmetros:
+            cnpj (str): CNPJ analisado.
+            situacao (str): Situação do CNPJ obtida da Receita Federal.
+        """
+        filename = os.path.normpath(os.path.join('./.res', 'RelCNPJ.txt'))
+        with open(filename, 'a', encoding='utf-8') as file:
+            file.write(f'A situação do CNPJ {cnpj} é {situacao}.\n')
+
+        print(f'A situação do CNPJ {cnpj} é {situacao}')
+        return self
+
+    def analyze_cnpj(self, cnpj_list):
+        """
+        Analisa uma sequência de CNPJs, consultando a situação de cada um na Receita Federal.
+
+        :param:
+            cnpj_list (generator): Gerador que produz CNPJs.
+        """
+        for cnpj in cnpj_list:
+            cnpj = re.sub('[^0-9]+', '', str(cnpj))
+            if len(cnpj) > 5:
+                time.sleep(21)  # Mantendo a regra do plano gratuito
+                situacao = self.receita_service.get_situacao_cnpj(cnpj)
+                self.save_data(cnpj, situacao)

services/apis.py

@@ -0,0 +1,58 @@
+import re
+
+import requests
+
+
+class ReceitaFederalService:
+    """
+    Classe para interagir com a API da Receita Federal para consulta de CNPJs.
+
+    Atributos:
+        base_url (str): URL base da API da Receita Federal.
+    """
+
+    def __init__(self, base_url):
+        self.base_url = base_url
+
+    def consulta_cnpj(self, cnpj):
+        """
+        Consulta um CNPJ na API da Receita Federal e retorna os dados.
+
+        :param:
+            cnpj (str): CNPJ a ser consultado.
+
+        :return:
+            dict: Dados retornados pela API para o CNPJ especificado.
+        """
+        url = f'{self.base_url}/{cnpj}'
+        headers = {'Accept': 'application/json'}
+        response = requests.get(url=url, headers=headers)
+        return response.json()
+
+    def validar_cnpj(self, cnpj):
+        """
+        Verifica se um CNPJ é válido e está ativo.
+
+        :param:
+            cnpj (str): CNPJ a ser validado.
+
+        :return:
+            bool: True se o CNPJ é válido e está ativo, False caso contrário.
+        """
+        data = self.consulta_cnpj(cnpj)
+        if data.get('status') == 'ERROR':
+            return {'situacao': data.get('message')}
+        return data
+
+    def get_situacao_cnpj(self, cnpj):
+        """
+        Obtém a situação de um CNPJ.
+
+        :param:
+            cnpj (str): CNPJ cuja situação será obtida.
+
+        :return:
+            str: Situação do CNPJ.
+        """
+        data = self.validar_cnpj(cnpj)
+        return data.get('situacao')

services/files.py

@@ -0,0 +1,23 @@
+import pandas as pd
+
+
+class FileManager:
+    """
+    Classe para gerenciar operações de arquivo, como leitura e conversão de formatos.
+
+    Atributos:
+        file_path (str): Caminho do arquivo a ser manipulado.
+    """
+
+    def __init__(self, file_path):
+        self.file_path = file_path
+
+    def get_data_from_excel(self):
+        """
+        Gera uma sequência de CNPJs a partir de um arquivo Excel com múltiplas abas.
+        Cada CNPJ é gerado um de cada vez.
+        """
+        df = pd.read_excel(self.file_path, sheet_name=None)
+        for _, value in df.items():
+            for cnpj in value["CNPJ"]:
+                yield cnpj

utils/make_data.py

@@ -0,0 +1,23 @@
+import pandas as pd
+from faker import Faker
+
+# Inicializar o gerador de dados fictícios
+fake = Faker('pt-BR')
+
+# Criar dados fictícios para contratantes
+data = {
+    "CNPJ": [fake.unique.random_number(digits=14, fix_len=True) for _ in range(10)],
+    "Nome da Empresa": [fake.company() for _ in range(10)],
+    "Endereço": [fake.address().replace('\n', ' ').strip() for _ in range(10)],
+    "Telefone": [fake.phone_number() for _ in range(10)],
+    "E-mail": [fake.email() for _ in range(10)],
+    "Setor": [fake.job() for _ in range(10)],
+    "Data de Fundação": [fake.date_between(start_date='-30y', end_date='today') for _ in range(10)]
+}
+
+# Criar DataFrame com os dados
+df = pd.DataFrame(data)
+
+# Salvar o DataFrame como um arquivo Excel
+file_path = '../.res/contratantes.xlsx'
+df.to_excel(file_path, index=False)