request-cnpj 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8107226372f6afef3e83e5bf0ca7a44c5024492d02f22eee29cbe062f5dd3a8c
+  data.tar.gz: 17404f2e1f66e641cceb063929548a2e3dbc10ad8fe14cb3a2999b97650e9b49
+SHA512:
+  metadata.gz: 1e06229aa3c680ca81c4bd9ac786519a65408cf2666679a0c4ae3b28c29777151e848f171c93baf6170df246399882cfdf56d5a3f818562825eefbcc481ea131
+  data.tar.gz: 3d2114d93c14947943c26e6f04c94a72e58f7ca9498f445e02316da05b7616d05f4d84d0b8fa8c8b28385d2b7f12fca6890290d789606cd7e8998083f1fbdc05

data/.claude/settings.json

@@ -0,0 +1,11 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(bundle install *)",
+      "Bash(curl -s -o /dev/null -w \"%{http_code}\\\\n\" --max-time 5 https://api.opencnpj.org/00000000000191)",
+      "Bash(curl -s --max-time 5 https://api.opencnpj.org/00000000000191)",
+      "Bash(curl -s -o /dev/null -w \"%{http_code}\\\\n\" --max-time 5 https://api.opencnpj.org/11111111111111)",
+      "Bash(gem build *)"
+    ]
+  }
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-05-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"request-cnpj" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["moises.ribeiro.developer@gmail.com"](mailto:"moises.ribeiro.developer@gmail.com").

data/README.md

@@ -0,0 +1,57 @@
+# Request::Cnpj
+
+[Leia em Português](README.pt-BR.md)
+
+A Ruby client for looking up Brazilian company registration data (CNPJ) via the [OpenCNPJ API](https://api.opencnpj.org).
+
+## Installation
+
+Install the gem and add it to the application's Gemfile by executing:
+
+```bash
+bundle add request-cnpj
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install request-cnpj
+```
+
+Alternatively, add it directly to your Gemfile:
+
+```ruby
+gem 'request-cnpj'
+```
+
+And run:
+
+```bash
+bundle install
+```
+
+## Usage
+
+```ruby
+require 'request/cnpj'
+
+client = Request::Cnpj::Client.new
+client.find('12.345.678/0001-95')
+# => { "cnpj" => "12345678000195", ... }
+```
+
+`find` accepts the CNPJ with or without punctuation — any non-digit characters are stripped before the request is made.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moshepedroribeiro/request-cnpj. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Request::Cnpj project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/README.pt-BR.md

@@ -0,0 +1,57 @@
+# Request::Cnpj
+
+[Read in English](README.md)
+
+Um cliente Ruby para consultar dados de CNPJ (Cadastro Nacional da Pessoa Jurídica) por meio da [API OpenCNPJ](https://api.opencnpj.org).
+
+## Instalação
+
+Instale a gem e adicione-a ao Gemfile da aplicação executando:
+
+```bash
+bundle add request-cnpj
+```
+
+Se o bundler não estiver sendo usado para gerenciar as dependências, instale a gem executando:
+
+```bash
+gem install request-cnpj
+```
+
+Alternativamente, adicione-a diretamente ao seu Gemfile:
+
+```ruby
+gem 'request-cnpj'
+```
+
+E execute:
+
+```bash
+bundle install
+```
+
+## Uso
+
+```ruby
+require 'request/cnpj'
+
+client = Request::Cnpj::Client.new
+client.find('12.345.678/0001-95')
+# => { "cnpj" => "12345678000195", ... }
+```
+
+O método `find` aceita o CNPJ com ou sem pontuação — qualquer caractere que não seja número é removido antes da requisição.
+
+## Desenvolvimento
+
+Após clonar o repositório, rode `bin/setup` para instalar as dependências. Em seguida, rode `rake spec` para executar os testes. Você também pode rodar `bin/console` para um prompt interativo e experimentar o código.
+
+Para instalar essa gem na sua máquina local, rode `bundle exec rake install`. Para lançar uma nova versão, atualize o número da versão em `version.rb` e rode `bundle exec rake release`, que cria uma tag no git, envia os commits e a tag criada, e publica o arquivo `.gem` no [rubygems.org](https://rubygems.org).
+
+## Contribuindo
+
+Relatos de bugs e pull requests são bem-vindos no GitHub em https://github.com/moshepedroribeiro/request-cnpj. Este projeto pretende ser um espaço seguro e acolhedor para colaboração, e espera-se que os contribuidores sigam o [código de conduta](CODE_OF_CONDUCT.md).
+
+## Código de Conduta
+
+Espera-se que todos que interagem nos códigos-fonte, issue trackers, salas de chat e listas de e-mail do projeto Request::Cnpj sigam o [código de conduta](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/request/cnpj/base_client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Request
+  module Cnpj
+    # Base class for CNPJ request clients, providing shared execution logic.
+    class BaseClient
+      protected
+
+      def get(path = nil, params: nil, headers: default_headers, url: url_for(path, **params.to_h), &)
+        execute(method: :get, url:, headers:, &)
+      end
+
+      def execute(**)
+        response = executor.execute(**default_execute_options, **)
+
+        return yield response if block_given?
+
+        response.body
+      end
+
+      def default_headers
+        {
+          accept: 'application/json'
+        }
+      end
+
+      def default_execute_options
+        {}
+      end
+
+      def url_for(path, **params)
+        URI('https://api.opencnpj.org').tap do |uri|
+          uri.path += path
+          uri.query = params.to_query if params.any?
+        end.to_s
+      end
+    end
+  end
+end

data/lib/request/cnpj/client.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Request
+  module Cnpj
+    # Client for fetching CNPJ data from the OpenCNPJ API.
+    class Client < BaseClient
+      attr_reader :url, :executor
+
+      def initialize(executor: RestClient::Request)
+        super()
+        @executor = executor
+      end
+
+      # Method to request CNPJ to API
+      def find(cnpj)
+        JSON.parse(get("/#{cnpj.gsub(/[^0-9]/, '')}"))
+      end
+    end
+  end
+end

data/lib/request/cnpj/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Request
+  module Cnpj
+    VERSION = '0.1.0'
+  end
+end

data/lib/request/cnpj.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rest-client'
+require_relative 'cnpj/version'
+require_relative 'cnpj/base_client'
+require_relative 'cnpj/client'
+
+module Request
+  module Cnpj
+    class Error < StandardError; end
+  end
+end

data/sig/request/cnpj.rbs

@@ -0,0 +1,6 @@
+module Request
+  module Cnpj
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: request-cnpj
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Moisés Ribeiro
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Request::Cnpj is a lightweight Ruby client for fetching CNPJ (Cadastro
+  Nacional da Pessoa Jurídica) data from the OpenCNPJ API.
+email:
+- moises.ribeiro.developer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".claude/settings.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- README.pt-BR.md
+- Rakefile
+- lib/request/cnpj.rb
+- lib/request/cnpj/base_client.rb
+- lib/request/cnpj/client.rb
+- lib/request/cnpj/version.rb
+- sig/request/cnpj.rbs
+homepage: https://github.com/moshepedroribeiro/request-cnpj
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/moshepedroribeiro/request-cnpj
+  source_code_uri: https://github.com/moshepedroribeiro/request-cnpj
+  changelog_uri: https://github.com/moshepedroribeiro/request-cnpj/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Ruby client for looking up Brazilian company registration data (CNPJ) via
+  the OpenCNPJ API.
+test_files: []