sepomex_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9db38b97ba3c20e91c0e474c37dfd9c28a1c17fb2c0050e088a1110f16544b9
-  data.tar.gz: 7c40f0691e08848b319828cd6cd1cde57c7c4c493aacbc1f71fb7260754c1486
+  metadata.gz: 5c26ab8e8d11f89a49dcfd544ee139a6b42b004551a1b80df3ce3d29b3878316
+  data.tar.gz: b1537a4d86406414eea80e91354f5c707b211ca8b196c84f5719161655fbb7ea
 SHA512:
-  metadata.gz: d222836fce1efcbce435f1e2274f8ce60a786cafc17d057bd88fe5a862ea155e5b8e8a0bbf9aa32e94dfdd0bfd0682c9fab92e26ba4ab4a0aaaf903a7418064e
-  data.tar.gz: 655821d688f072fa86cd412e54063eefa499cd13544ee78f9405d25f40bf3897cedbfafeb67994c0466f2a93839da750c0e7c1738c19cb36f6f8a53998f1fb2f
+  metadata.gz: c7f3bda39e1290880d6286830bc86911211850fcab702f8fa0ce7f06343ea88f1d8687808427a7cfdbf69e51b4d756acae906cda62beea288e6dd3b12b2ef4e5
+  data.tar.gz: d59b646ec9c461b6b0cbe1f8387c2443591b0f1bdd5a2aed6f175408c0c1c07f0820090c0bcefda03a503c1398f03fd19fff9df6679077ba27579e772bc9cc5b

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in commons.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    sepomex_client (0.1.0)
+      sepomex_acrogenesis (~> 0.5.2)
+      sepomex_hckdrk (~> 0.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    hashdiff (1.0.0)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    minitest (5.13.0)
+    multi_xml (0.6.0)
+    public_suffix (4.0.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    sepomex_acrogenesis (0.5.2)
+      activesupport (~> 5.2)
+      httparty (~> 0.16.0)
+      json (~> 2.0)
+    sepomex_hckdrk (0.4.1)
+      activesupport (~> 5.2)
+      httparty (~> 0.16.0)
+      json (~> 2.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.8)
+  sepomex_client!
+  simplecov (~> 0.17)
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   2.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Juan Ku
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# sepomex-ruby
+SEPOMEX is a ruby integration to SEPOMEX clients for zip code information gathering

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/spec`
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sepomex/clients/acrogenesis.rb

@@ -0,0 +1,18 @@
+module SEPOMEX
+  module Clients
+    class Acrogenesis
+      def initialize(zip_code)
+        @zip_code = zip_code
+      end
+
+      #
+      # Método que se encarga de solicitar información de un código postal
+      #
+      # @raise [SepomexError]
+      #
+      def query
+        SEPOMEX_Acrogenesis::General.info_zip_code(zip_code: @zip_code)
+      end
+    end
+  end
+end

data/lib/sepomex/clients/hckdrk.rb

@@ -0,0 +1,18 @@
+module SEPOMEX
+  module Clients
+    class Hckdrk
+      def initialize(zip_code)
+        @zip_code = zip_code
+      end
+
+      #
+      # Método que se encarga de solicitar información de un código postal
+      #
+      # @raise [SepomexError]
+      #
+      def query
+        SEPOMEX_HCKDRK::General.info_zip_code(zip_code: @zip_code)
+      end
+    end
+  end
+end

data/lib/sepomex/data_not_found_error.rb

@@ -0,0 +1,4 @@
+module SEPOMEX
+  class DataNotFoundError < StandardError
+  end
+end

data/lib/sepomex/strategy.rb

@@ -0,0 +1,43 @@
+module SEPOMEX
+  class Strategy
+    ACROGENESIS = 'acrogenesis'.freeze
+    HCKDRK = 'hckdrk'.freeze
+
+    def self.call(*args, &block)
+      new(*args, &block).call
+    end
+
+    def initialize(zip_code)
+      @zip_code = zip_code
+      @clients = [HCKDRK, ACROGENESIS]
+    end
+
+    def call
+      raise ArgumentError if @zip_code.blank?
+
+      zip_code_result = {}
+      @clients.each do |client|
+        strategy = processor(client)
+        zip_code_result = strategy.query
+        break if zip_code_result.settlement.present?
+      rescue StandardError => e
+      end
+      raise DataNotFoundError if zip_code_result.blank? || zip_code_result.settlement.blank?
+
+      zip_code_result
+    end
+
+    private
+
+    def processor(client)
+      case client
+      when HCKDRK
+        SEPOMEX::Clients::Hckdrk.new(@zip_code)
+      when ACROGENESIS
+        SEPOMEX::Clients::Acrogenesis.new(@zip_code)
+      else
+        raise ArgumentError
+      end
+    end
+  end
+end

data/lib/sepomex/version.rb

@@ -0,0 +1,3 @@
+module SEPOMEX
+  VERSION = '0.1.1'
+end

data/sepomex.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "sepomex/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "sepomex_client"
+  spec.version     = SEPOMEX::VERSION
+  spec.date        = '2019-12-10'
+  spec.description = "SEPOMEX is a ruby integration to SEPOMEX clients for zip code information gathering"
+  spec.summary     = "SEPOMEX is a library that integrates to multiple SEPOMEX clients for MX zip code information gathering"
+  spec.files       = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.authors     = ["Yellowme"]
+  spec.email       = 'hola@yellowme.mx'
+  spec.homepage    = 'https://github.com/yellowme/sepomex-ruby'
+  spec.license      = 'MIT'
+
+  spec.add_dependency "sepomex_acrogenesis", "~> 0.5.2"
+  spec.add_dependency 'sepomex_hckdrk', "~> 0.4.1"
+
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "webmock", "~> 3.7"
+  spec.add_development_dependency "simplecov", "~> 0.17"
+end

data/spec/sepomex/strategy_spec.rb

@@ -0,0 +1,129 @@
+require 'webmock/rspec'
+
+RSpec.describe SEPOMEX::Strategy do
+  zip_code = '97305'
+
+  let(:sepomex_zip_code_response) do
+    [
+      {
+        error: false,
+        code_error: 0,
+        error_message: 'null',
+        response: {
+          cp: zip_code,
+          asentamiento: 'Granjas Cholul',
+          tipo_asentamiento: 'Colonia',
+          municipio: 'Mérida',
+          estado: 'Yucatán',
+          ciudad: '',
+          pais: 'México',
+        },
+      },
+      {
+        error: false,
+        code_error: 0,
+        error_message: 'null',
+        response: {
+          cp: zip_code,
+          asentamiento: 'Cabo Norte',
+          tipo_asentamiento: 'Fraccionamiento',
+          municipio: 'Mérida',
+          estado: 'Yucatán',
+          ciudad: '',
+          pais: 'México',
+        },
+      },
+    ]
+  end
+
+  let(:sepomex_invalid_zip_code_response) do
+    {
+      error: true,
+      code_error: 102,
+      error_message: 'La longitud del cp es inválida',
+      response: 'null',
+    }
+  end
+
+  let(:sepomex_acrogenesis_valid_zip_code_response) do
+    {
+      codigo_postal: '97305',
+      municipio: 'Mérida',
+      estado: 'Yucatán',
+      colonias: ['Cholul'],
+    }
+  end
+
+  let(:sepomex_acrogenesis_invalid_zip_code_response) do
+    {
+      codigo_postal: '94',
+      municipio: '',
+      estado: '',
+      colonias: [],
+    }
+  end
+
+  describe 'it works' do
+    context 'when hckdrk works' do
+      before do
+        stub_request(:get, "https://api-sepomex.hckdrk.mx/query/info_cp/#{zip_code}").to_return(
+          body: JSON.dump(sepomex_zip_code_response), status: 200
+        )
+      end
+
+      subject { described_class.call(zip_code) }
+
+      it do
+        expect { subject }.not_to raise_error
+        expect(subject.state).to eq 'Yucatán'
+      end
+    end
+
+    context 'when hckdrk fails but acrogenesis works' do
+      before do
+        stub_request(:get, "https://api-sepomex.hckdrk.mx/query/info_cp/#{zip_code}").to_return(
+          body: JSON.dump(sepomex_invalid_zip_code_response), status: 200
+        )
+
+        stub_request(:get, "https://api-codigos-postales.herokuapp.com/v2/codigo_postal/#{zip_code}").to_return(
+          body: JSON.dump(sepomex_acrogenesis_valid_zip_code_response), status: 200
+        )
+      end
+
+      subject { described_class.call(zip_code) }
+
+      it do
+        expect { subject }.not_to raise_error
+        expect(subject.state).to eq 'Yucatán'
+      end
+    end
+  end
+
+  describe 'fails correctly' do
+    context 'when both APIs fail' do
+      before do
+        stub_request(:get, "https://api-sepomex.hckdrk.mx/query/info_cp/#{zip_code}").to_return(
+          body: JSON.dump(sepomex_invalid_zip_code_response), status: 200
+        )
+
+        stub_request(:get, "https://api-codigos-postales.herokuapp.com/v2/codigo_postal/#{zip_code}").to_return(
+          body: JSON.dump(sepomex_acrogenesis_invalid_zip_code_response), status: 200
+        )
+      end
+
+      it do
+        expect do
+          described_class.call(zip_code)
+        end.to raise_error SEPOMEX::DataNotFoundError
+      end
+    end
+
+    context 'when no zip_code sent' do
+      it do
+        expect do
+          described_class.call
+        end.to raise_error ArgumentError
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'simplecov'
+
+require 'sepomex'
+
+SimpleCov.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sepomex_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yellowme
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: sepomex_hckdrk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +87,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
 - lib/sepomex.rb
+- lib/sepomex/clients/acrogenesis.rb
+- lib/sepomex/clients/hckdrk.rb
+- lib/sepomex/data_not_found_error.rb
+- lib/sepomex/strategy.rb
+- lib/sepomex/version.rb
+- sepomex.gemspec
+- spec/sepomex/strategy_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/yellowme/sepomex-ruby
 licenses:
 - MIT
@@ -113,4 +128,6 @@ signing_key:
 specification_version: 4
 summary: SEPOMEX is a library that integrates to multiple SEPOMEX clients for MX zip
   code information gathering
-test_files: []
+test_files:
+- spec/sepomex/strategy_spec.rb
+- spec/spec_helper.rb