br_db 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45b4a2cc6e85d14a69fd9e1d3c2fd37504215841ba20098fa58e01927afe0eff
-  data.tar.gz: e1ad089a2fd355c501737dc44b0b43e16244b0d8ce6c33221d9b2b97e8faa4cb
+  metadata.gz: d7122614bb0bbd93ba570e9d703bc5133ce879cd828ad0f47dfc1b66b2c241fc
+  data.tar.gz: 1d33a775a1e1a5378363263d55db8b3c657ec2f743908371798cbed1ab9788c6
 SHA512:
-  metadata.gz: a5d3822a1d31e2abed2e478acdb3c1252815af430f94753035c4100a3a74802a84c5cd1eb3a5632331796f7d672dbcc2648ae1f6c2d795cd746c90e1c778d3d8
-  data.tar.gz: dd0d59e37f841c24818356b4a619b6af049e8fc0526b76ea97531b71c3d6a110f17248d701d499db2d25415914d828f032861f6a9de8a719e129f785f6901baf
+  metadata.gz: 68214a5e0f88a4ef0f2f725576b2d2fc9dd89ce39dc4c65d8e4f68cb0ac6e49740775369d71fc7ecfbeedc78c2690525a09f608b3f19ac0b2d48e811ab603521
+  data.tar.gz: 0c739fc67c46abfcfe3b83cae0ac8d7f9a26236cfa3bf1acd5250b379b3255d3aa1addfe4046389715b6fdde32115988bf93f62c3e150bfb9953851c39b1a0d1

data/README.md

@@ -1,21 +1,14 @@
-# Brdb
-A rails engine to add all the necessary Brazilian data to your app
-
-# Currently importing:
-
-- [x] ZipCodes (you'll need to buy a key from the [Brazilian Correios](https://www.correios.com.br/educacao-e-cultura/filatelia/compre-seu-selo-aqui/compre-seu-selo-aqui))
-- [x] Cities
-- [x] States
-- [ ] Company Data - (WIP - Importing data from dados.gov.br)
+# BrDb
+Short description and motivation.
 
 ## Usage
-Each data point has a corresponding ActiveJob job, so you can manage the download process in parallel.
+How to use my plugin.
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "brdb"
+gem "br_db"
 ```
 
 And then execute:
@@ -25,16 +18,11 @@ $ bundle
 
 Or install it yourself as:
 ```bash
-$ gem install brdb
+$ gem install br_db
 ```
 
 ## Contributing
-Fork, open a PR.
-
-
-## TODO:
-- [ ] Finish up company data import
-- [ ] Add tests
+Contribution directions go here.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/{brdb → br_db}/application_controller.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ApplicationController < ActionController::Base
   end
 end

data/app/controllers/{brdb → br_db}/import_cities_controller.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ImportCitiesController < ApplicationController
     def create
       LoadCitiesJob.perform_later

data/app/controllers/{brdb → br_db}/import_companies_controller.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ImportCompaniesController < ApplicationController
     def create
       LoadCompaniesJob.perform_later

data/app/controllers/{brdb → br_db}/import_countries_controller.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ImportCountriesController < ApplicationController
     def create
       LoadCountriesJob.perform_later

data/app/controllers/{brdb → br_db}/import_states_controller.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ImportStatesController < ApplicationController
     def create
       LoadStatesJob.perform_later

data/app/controllers/{brdb → br_db}/import_zip_codes_controller.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ImportZipCodesController < ApplicationController
     def create
       LoadZipCodesJob.perform_later

data/app/helpers/{brdb → br_db}/application_helper.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   module ApplicationHelper
   end
 end

data/app/jobs/{brdb → br_db}/application_job.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ApplicationJob < ActiveJob::Base
   end
 end

data/app/jobs/{brdb → br_db}/load_cities_job.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class LoadCitiesJob < ApplicationJob
     queue_as :default
 

data/app/jobs/{brdb → br_db}/load_companies_job.rb

@@ -3,12 +3,12 @@ require "down"
 require "csv"
 require "fileutils"
 
-module Brdb
+module BrDb
   class LoadCompaniesJob < ApplicationJob
     queue_as :default
 
     BASE_URL = "https://arquivos.receitafederal.gov.br/dados/cnpj/dados_abertos_cnpj/"
-    RESOURCES = [ "Cnaes", "Estabelecimentos" ]
+    RESOURCES = [ "Cnaes" ] # TODO: enable "Estabelecimentos" again
     DELIMITER = ";"
     ENCODING = "iso-8859-1:utf-8"
     QUOTE_CHARS = %w[" | ~ ^ & *]
@@ -27,7 +27,7 @@ module Brdb
     def load(prefix)
       case prefix
       when "Cnaes"
-        # load_cnaes
+        load_cnaes
       when "Estabelecimentos"
         load_companies
       end
@@ -35,6 +35,7 @@ module Brdb
 
     def download_files(prefix)
       urls = get_urls(prefix.titleize)
+      puts "Found the following URLs: #{urls}"
       urls.each_with_index do |url, i|
         destination = FileUtils.makedirs(Rails.root.join("tmp", prefix))
         tmp_file_path = destination.join(prefix)  + "/#{i}.zip"
@@ -129,6 +130,9 @@ module Brdb
       html = resp.body
       doc = Nokogiri::HTML(html)
       href = doc.css("tr")[-2].css("a").first["href"]
+      if href.starts_with?("temp")
+        href = doc.css("tr")[-3].css("a").first["href"]
+      end
       BASE_URL + href
     end
 

data/app/jobs/{brdb → br_db}/load_countries_job.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class LoadCountriesJob < ApplicationJob
     queue_as :default
 

data/app/jobs/{brdb → br_db}/load_states_job.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class LoadStatesJob < ApplicationJob
     queue_as :default
 

data/app/jobs/{brdb → br_db}/load_zip_codes_job.rb

@@ -2,7 +2,7 @@ require "zip"
 require "csv"
 require "fileutils"
 
-module Brdb
+module BrDb
   class LoadZipCodesJob < ApplicationJob
     queue_as :default
 

data/app/mailers/{brdb → br_db}/application_mailer.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ApplicationMailer < ActionMailer::Base
     default from: "from@example.com"
     layout "mailer"

data/app/models/{brdb → br_db}/application_record.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
   end

data/app/models/{brdb → br_db}/city.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class City < ApplicationRecord
   end
 end

data/app/models/{brdb → br_db}/cnae.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class Cnae < ApplicationRecord
   end
 end

data/app/models/{brdb → br_db}/company.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class Company < ApplicationRecord
   end
 end

data/app/models/{brdb → br_db}/country.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class Country < ApplicationRecord
   end
 end

data/app/models/{brdb → br_db}/state.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class State < ApplicationRecord
   end
 end

data/app/models/{brdb → br_db}/zip_code.rb

@@ -1,4 +1,4 @@
-module Brdb
+module BrDb
   class ZipCode < ApplicationRecord
   end
 end

data/app/views/layouts/{brdb → br_db}/application.html.erb

@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Brdb</title>
+  <title>Br db</title>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
   <%= yield :head %>
 
-  <%= stylesheet_link_tag    "brdb/application", media: "all" %>
+  <%= stylesheet_link_tag    "br_db/application", media: "all" %>
 </head>
 <body>
 

data/config/routes.rb

@@ -1,4 +1,4 @@
-Brdb::Engine.routes.draw do
+BrDb::Engine.routes.draw do
   get "import_cities", to: "import_cities#create"
   get "import_states", to: "import_states#create"
   get "import_countries", to: "import_countries#create"

data/lib/{brdb → br_db}/engine.rb

@@ -1,5 +1,5 @@
-module Brdb
+module BrDb
   class Engine < ::Rails::Engine
-    isolate_namespace Brdb
+    isolate_namespace BrDb
   end
 end

data/lib/br_db/version.rb

@@ -0,0 +1,3 @@
+module BrDb
+  VERSION = "0.1.1"
+end

data/lib/br_db.rb

@@ -0,0 +1,6 @@
+require "br_db/version"
+require "br_db/engine"
+
+module BrDb
+  # Your code goes here...
+end

data/lib/tasks/{brdb_tasks.rake → br_db_tasks.rake}

@@ -1,4 +1,4 @@
 # desc "Explaining what the task does"
-# task :brdb do
+# task :br_db do
 #   # Task goes here
 # end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: br_db
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- caonUlisses
+- Ulisses Caon
 autorequire:
 bindir: bin
 cert_chain: []
@@ -16,15 +16,15 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: 8.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0
-description: A rails engine to add all the necessary Brazilian data to your app..
+        version: 8.0.1
+description: Download and import Brazilian data into your Ruby on Rails app
 email:
 - ulissescaon@gmail.com
 executables: []
@@ -34,34 +34,29 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/stylesheets/brdb/application.css
-- app/controllers/brdb/application_controller.rb
-- app/controllers/brdb/import_cities_controller.rb
-- app/controllers/brdb/import_companies_controller.rb
-- app/controllers/brdb/import_countries_controller.rb
-- app/controllers/brdb/import_states_controller.rb
-- app/controllers/brdb/import_zip_codes_controller.rb
-- app/helpers/brdb/application_helper.rb
-- app/helpers/brdb/import_companies_helper.rb
-- app/helpers/brdb/import_countries_helper.rb
-- app/helpers/brdb/import_states_helper.rb
-- app/helpers/brdb/import_zip_codes_helper.rb
-- app/helpers/brdb/imports_helper.rb
-- app/jobs/brdb/application_job.rb
-- app/jobs/brdb/load_cities_job.rb
-- app/jobs/brdb/load_companies_job.rb
-- app/jobs/brdb/load_countries_job.rb
-- app/jobs/brdb/load_states_job.rb
-- app/jobs/brdb/load_zip_codes_job.rb
-- app/mailers/brdb/application_mailer.rb
-- app/models/brdb/application_record.rb
-- app/models/brdb/city.rb
-- app/models/brdb/cnae.rb
-- app/models/brdb/company.rb
-- app/models/brdb/country.rb
-- app/models/brdb/state.rb
-- app/models/brdb/zip_code.rb
-- app/views/layouts/brdb/application.html.erb
+- app/assets/stylesheets/br_db/application.css
+- app/controllers/br_db/application_controller.rb
+- app/controllers/br_db/import_cities_controller.rb
+- app/controllers/br_db/import_companies_controller.rb
+- app/controllers/br_db/import_countries_controller.rb
+- app/controllers/br_db/import_states_controller.rb
+- app/controllers/br_db/import_zip_codes_controller.rb
+- app/helpers/br_db/application_helper.rb
+- app/jobs/br_db/application_job.rb
+- app/jobs/br_db/load_cities_job.rb
+- app/jobs/br_db/load_companies_job.rb
+- app/jobs/br_db/load_countries_job.rb
+- app/jobs/br_db/load_states_job.rb
+- app/jobs/br_db/load_zip_codes_job.rb
+- app/mailers/br_db/application_mailer.rb
+- app/models/br_db/application_record.rb
+- app/models/br_db/city.rb
+- app/models/br_db/cnae.rb
+- app/models/br_db/company.rb
+- app/models/br_db/country.rb
+- app/models/br_db/state.rb
+- app/models/br_db/zip_code.rb
+- app/views/layouts/br_db/application.html.erb
 - config/routes.rb
 - db/migrate/20241209190243_create_brdb_countries.rb
 - db/migrate/20241209190300_create_brdb_states.rb
@@ -69,17 +64,16 @@ files:
 - db/migrate/20241209202503_create_brdb_zip_codes.rb
 - db/migrate/20241210125732_create_brdb_companies.rb
 - db/migrate/20241210130730_create_brdb_cnaes.rb
-- lib/brdb.rb
-- lib/brdb/engine.rb
-- lib/brdb/version.rb
-- lib/tasks/brdb_tasks.rake
-homepage: https://github.com/caonUlisses/brdb
+- lib/br_db.rb
+- lib/br_db/engine.rb
+- lib/br_db/version.rb
+- lib/tasks/br_db_tasks.rake
+homepage: https://github.com/caonUlisses/br_db
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/caonUlisses/brdb
-  source_code_uri: https://github.com/caonUlisses/brdb
-  changelog_uri: https://github.com/caonUlisses/brdb
+  homepage_uri: https://github.com/caonUlisses/br_db
+  source_code_uri: https://github.com/caonUlisses/br_db
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -98,5 +92,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: A rails engine to add all the necessary Brazilian data to your app.
+summary: A Rails engine to download and load Brazilian data
 test_files: []

data/app/helpers/brdb/import_companies_helper.rb

@@ -1,4 +0,0 @@
-module Brdb
-  module ImportCompaniesHelper
-  end
-end

data/app/helpers/brdb/import_countries_helper.rb

@@ -1,4 +0,0 @@
-module Brdb
-  module ImportCountriesHelper
-  end
-end

data/app/helpers/brdb/import_states_helper.rb

@@ -1,4 +0,0 @@
-module Brdb
-  module ImportStatesHelper
-  end
-end

data/app/helpers/brdb/import_zip_codes_helper.rb

@@ -1,4 +0,0 @@
-module Brdb
-  module ImportZipCodesHelper
-  end
-end

data/app/helpers/brdb/imports_helper.rb

@@ -1,4 +0,0 @@
-module Brdb
-  module ImportsHelper
-  end
-end

data/lib/brdb/version.rb

@@ -1,3 +0,0 @@
-module Brdb
-  VERSION = "0.1.0"
-end

data/lib/brdb.rb

@@ -1,6 +0,0 @@
-require "brdb/version"
-require "brdb/engine"
-
-module Brdb
-  # Your code goes here...
-end