brazil-cep 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebcf36ea20edd02418b626e0741972620cea2b3a4af54dbaffb0413c4af1bb1e
-  data.tar.gz: 4fa2527e8007a0f0d7dc5a13a72f54a54508be5aab0887dfb21582b7c395ccdf
+  metadata.gz: 0a4a5033b0b8e49dbd7d48f464c76e857a30140c6e29be85ca3440ed45bec589
+  data.tar.gz: ea457dfc8a836178131f231002907c5f6ae165d0f9124bbb7faa711a7e88784c
 SHA512:
-  metadata.gz: 3aa434fd7b4ab0149bf7a70167c2302b3eb78782d5df6077e18763b3f24e5eb5d70e151384cced2b46d1676d54f90a4a14b2ba710ef4f537842675df8ad9ea52
-  data.tar.gz: 2048b051f9853cc1fce960257e49c13d30f11a20d10414c914ce0f4d068fe96e9ea240e72c3eec76597097d2873e5c0a8f84b84301c5e90199a9d106b83f445b
+  metadata.gz: d632a23cd2e78c93392d3c405a9d9023efc4d639e69ddf3c7bc334b0ebaa48bf42a968067c18fea8e2cae8e7541b17ea56f6265ddfccf1c9bbe829e298b462ca
+  data.tar.gz: 01e72027e7660a8b6f67a1730df08824bbfc72bcbed978d2c7ee2a87fd13901b62f7130ec0576d5b00fe0aeb3101afdb2196abec7d6df1f610288989bcff9f34

data/.rubocop.yml

@@ -11,3 +11,156 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+AllCops:
+  NewCops: enable
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/ItWithoutArgumentsInBlock: # new in 1.59
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/LiteralAssignmentInCondition: # new in 1.58
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SuperWithArgsParentheses: # new in 1.58
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## [Unreleased]
 
+
+## 0.2.0 - 2024-03-26
+
+### Added
+- Add methods to register new provider adapter
+- Change cep word by zipcode to keep the same terminology
+- Add simplecov to project CI build
+- Add more ruby versions to CI build
+
+### Fixed
+- Remove wrong markdown code block tag from README
+
+### Removed
+- Remove rubocop check from rake default task
+
+### Security
+- Enable rubygems mfa requirement at gemspec file
+
+
 ## [0.1.0] - 2024-03-26
 
 - Initial release

data/README.md

@@ -1,5 +1,10 @@
 # Brazil::Cep
 
+[![Gem Version](https://badge.fury.io/rb/brazil-cep.svg)](https://badge.fury.io/rb/brazil-cep)
+[![Ruby](https://github.com/dvinciguerra/brazil-cep/actions/workflows/main.yml/badge.svg)](https://github.com/dvinciguerra/brazil-cep/actions/workflows/main.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ebe40dff21c15748fd1c/maintainability)](https://codeclimate.com/github/dvinciguerra/brazil-cep/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ebe40dff21c15748fd1c/test_coverage)](https://codeclimate.com/github/dvinciguerra/brazil-cep/test_coverage)
+
 This gem provides a simple way to validate and format Brazilian postal codes (CEP).
 
 ## Installation
@@ -62,7 +67,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/dvinci
 ## Code of Conduct
 
 Everyone interacting in the Brazil::Cep project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dvinciguerra/brazil-cep/blob/master/CODE_OF_CONDUCT.md).
-```
 
 ## License
 

data/Rakefile

@@ -5,8 +5,8 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+# require "rubocop/rake_task"
+# RuboCop::RakeTask.new
 
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+# task default: %i[spec rubocop]
+task default: %i[spec]

data/lib/brazil_cep/adapters/base.rb

@@ -31,7 +31,8 @@ module Brazil
           @cep = value unless value.nil?
 
           http_request(provider_url) do |http_response|
-            raise Brazil::Cep::RequestError, http_response unless http_response.is_a?(Net::HTTPSuccess)
+            raise Brazil::Cep::ZipcodeNotFound, http_response if http_response.is_a?(Net::HTTPNotFound)
+            raise Brazil::Cep::RequestError, http_response if http_response.code.to_i >= 400
           end
 
           deserialization!

data/lib/brazil_cep/adapters/postmon.rb

@@ -12,7 +12,7 @@ module Brazil
 
         def transformation!
           address_params = {
-            cep: @payload[:cep],
+            zipcode: @payload[:cep],
             state: @payload[:estado],
             city: @payload[:cidade],
             neighborhood: @payload[:bairro],

data/lib/brazil_cep/adapters/republica_virtual.rb

@@ -12,7 +12,7 @@ module Brazil
 
         def transformation!
           address_params = {
-            cep: @cep,
+            zipcode: @cep,
             state: @payload[:uf],
             city: @payload[:cidade],
             neighborhood: @payload[:bairro],

data/lib/brazil_cep/adapters/viacep.rb

@@ -11,14 +11,16 @@ module Brazil
         private
 
         def transformation!
+          raise Brazil::Cep::ZipcodeNotFound, @response if @payload[:erro] == true
+
           address_params = {
-            cep: @payload[:cep],
+            zipcode: @payload[:cep],
             state: @payload[:uf],
             city: @payload[:localidade],
             neighborhood: @payload[:bairro],
             street: @payload[:logradouro],
             complement: @payload[:complemento],
-            meta: @payload.update(provider: :postmon)
+            meta: @payload.update(provider: :viacep)
           }
 
           Brazil::Cep::Address.new(**address_params)

data/lib/brazil_cep/adapters.rb

@@ -4,6 +4,7 @@ module Brazil
   module Cep
     # Adapters class namespace
     module Adapters
+      # autoload default adapters
       autoload :Base, "brazil_cep/adapters/base"
       autoload :Viacep, "brazil_cep/adapters/viacep"
       autoload :Postmon, "brazil_cep/adapters/postmon"
@@ -14,8 +15,30 @@ module Brazil
         viacep: Viacep,
         postmon: Postmon,
         republica_virtual: RepublicaVirtual
-      }.freeze
+      }
 
+      private_constant :PROVIDERS
+
+      # get providers
+      # @return [Hash] providers
+      def self.providers
+        PROVIDERS
+      end
+
+      # register a provider
+      #
+      # @example
+      #   Brazil::Cep::Adapters.register(:custom_provider, Brazil::Cep::Adapters::CustomProvider)
+      #
+      # @param provider_key [Symbol] provider key
+      # @param provider_class [Class] provider class
+      def self.register(provider_key, provider_class)
+        PROVIDERS[provider_key] = provider_class
+      end
+
+      # get provider instance
+      # @param provider [Symbol] provider key
+      # @return [Base] provider instance
       def self.get(provider = :viacep)
         PROVIDERS[provider].new
       end

data/lib/brazil_cep/address.rb

@@ -4,10 +4,10 @@ module Brazil
   module Cep
     # Address class
     class Address
-      attr_reader :cep, :state, :city, :neighborhood, :street, :complement, :meta
+      attr_reader :zipcode, :state, :city, :neighborhood, :street, :complement, :meta
 
       def initialize(**arguments)
-        @cep = arguments[:cep]
+        @zipcode = arguments[:zipcode]
         @state = arguments[:state]
         @city = arguments[:city]
         @neighborhood = arguments[:neighborhood]

data/lib/brazil_cep/version.rb

@@ -2,6 +2,6 @@
 
 module Brazil
   module Cep
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/brazil_cep.rb

@@ -8,8 +8,24 @@ module Brazil
   # Brazil::Cep providers a simple way to fetch address information from a Brazilian CEP
   # @public
   module Cep
+    # generic error class
     class Error < StandardError; end
-    class RequestError < Error; end
+
+    # request error class
+    class RequestError < Error
+      attr_reader :status, :code, :response
+
+      def initialize(response)
+        @response = response
+        @status = response.message || "Undefined"
+        @code = response.code.to_i
+
+        super("Request Error: #{code} #{status} - #{response.body[0..1000].inspect}")
+      end
+    end
+
+    # zipcode not found error class
+    class ZipcodeNotFound < RequestError; end
 
     # fetch address information from a Brazilian CEP
     # @param [String] cep the CEP to fetch

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brazil-cep
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Vinciguerra
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-27 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies: []
 description: Brazil::CEP is a gem to provide interface to use common CEP services
 email:
@@ -38,6 +38,7 @@ homepage: https://github.com/dvinciguerra/brazil-cep
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/dvinciguerra/brazil-cep
   source_code_uri: https://github.com/dvinciguerra/brazil-cep
   changelog_uri: https://github.com/dvinciguerra/brazil-cep