sepomex_hckdrk 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bd07fb01e8c6fa056f484f8938f2fd6c9f2b3a6437863ed935b09d89f9900fa
-  data.tar.gz: c0a1f81d6a931a1a81cb3bec6de8ee62a25e5f70a66d2eaa634f3b67da8961f9
+  metadata.gz: 8612099c295c9bdf943474b688aca3519afff6c536c6b88c9a1cead63360fdce
+  data.tar.gz: bee904524bbe0d8f4a78cccf468224b90a02d75912c34521a99f1853f1b0618e
 SHA512:
-  metadata.gz: 6066c9acd5ca57dea24c5dc1332205334ac3284e6069e81874097822cbc332b9297b449fdc452ab5e8ea5869f6b6e03586c88768686804a56d5e7baa02d62786
-  data.tar.gz: 232bee3b0d09e037838399b837a2a03f8705281d80cfce7e1ef058ecb2696363b0e5bd9413a2a94ebc9b70f272f63cbbdecaa18fc7d71f8b56db6a1ed1580d3a
+  metadata.gz: 7def5510d944b07e8c87e690bf58a2ac23d71b1318e4d2f34623b21f46a774e7ebc544317eaf3ed6dfbfac145afe5b742cfc7783e806c338d8b9eaf0199d1b3e
+  data.tar.gz: 5a09cfe3faed1b8bda61bf52f5e976d8b4f68b894fd9795e421b6ea08e5f6c1f97d2e5eafa90c80060e81a6b595f6c32062e82e90bf96869a58d0f5f3e618856

data/.gitignore

@@ -0,0 +1,53 @@
+*.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
+
+# Mac
+.DS_Store

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,74 @@
+PATH
+  remote: .
+  specs:
+    sepomex_hckdrk (0.4.0)
+      activesupport (~> 5.2)
+      httparty (~> 0.16.0)
+      json (~> 2.0)
+
+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.2.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.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    safe_yaml (1.0.5)
+    simplecov (0.17.0)
+      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.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 3.8)
+  sepomex_hckdrk!
+  simplecov (~> 0.17)
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Yellowme
+
+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-hckdrk-ruby
+Ruby Bindings for SEPOMEX HCKDRK API

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_hckdrk/client/api_client.rb

@@ -0,0 +1,19 @@
+require 'singleton'
+
+module SEPOMEX_HCKDRK
+  class ApiClient
+    include SEPOMEX_HCKDRK::JsonApi
+
+    def self.config
+      yield self
+    end
+
+    def self.api_base
+      @api_base
+    end
+
+    def self.api_base=(api_base)
+      @api_base = api_base
+    end
+  end
+end

data/lib/sepomex_hckdrk/client/json_api.rb

@@ -0,0 +1,48 @@
+require 'httparty'
+
+module SEPOMEX_HCKDRK
+  module JsonApi
+    module ClassMethods
+      def default_headers
+        {
+          'Content-type' => 'application/json'
+        }
+      end
+
+      def api_get(url:, headers: {})
+        custom_headers = headers.merge(default_headers)
+        response = HTTParty.get(SEPOMEX_HCKDRK.api_base + url, headers: custom_headers)
+
+        JSON.parse(response.body, symbolize_names: true)
+      end
+
+      def api_post(url:, body: {}, headers: {})
+        custom_headers = headers.merge(default_headers)
+
+        response =
+          HTTParty.post(
+            SEPOMEX_HCKDRK.api_base + url,
+            body: body.to_json, headers: custom_headers
+          )
+
+        JSON.parse(response.body, symbolize_names: true)
+      end
+
+      def api_post_multipart(url:, body: {}, headers: {})
+        custom_headers = headers.merge(default_headers)
+
+        response =
+          HTTParty.post(
+            SEPOMEX_HCKDRK.api_base + url,
+            multipart: true, body: body, headers: custom_headers
+          )
+
+        response.body
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/sepomex_hckdrk/error.rb

@@ -0,0 +1,12 @@
+module SEPOMEX_HCKDRK
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(response = {})
+      @response = response
+      super
+    end
+  end
+
+  class RequestError < Error; end
+end

data/lib/sepomex_hckdrk/general.rb

@@ -0,0 +1,24 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+module SEPOMEX_HCKDRK
+  class General < ApiClient
+    def self.info_zip_code(zip_code:)
+      url = "query/info_cp/#{zip_code}"
+      response = api_get(url: url)
+      raise SEPOMEX_HCKDRK::RequestError.new(response[:error_message]) if !response.kind_of?(Array) && response[:error] == true
+      payload = response[0]
+      raise SEPOMEX_HCKDRK::RequestError.new(payload[:error_message]) if payload[:error] == true
+      data = {
+        zip_code: payload[:response][:cp].present? ? payload[:response][:cp] : nil,
+        settlement: payload[:response][:asentamiento].present? ? payload[:response][:asentamiento] : nil,
+        settlement_type: payload[:response][:tipo_asentamiento].present? ? payload[:response][:tipo_asentamiento] : nil,
+        municipality: payload[:response][:municipio].present? ? payload[:response][:municipio] : nil,
+        state: payload[:response][:estado].present? ? payload[:response][:estado] : nil,
+        city: payload[:response][:ciudad].present? ? payload[:response][:ciudad] : nil,
+        country: payload[:response][:pais].present? ? payload[:response][:pais] : nil
+      }
+      SEPOMEX_HCKDRK::ZipCode.new(*data.values_at(*SEPOMEX_HCKDRK::ZipCode.members))
+    end
+  end
+end

data/lib/sepomex_hckdrk/structs/zip_code.rb

@@ -0,0 +1,12 @@
+module SEPOMEX_HCKDRK
+  ZipCode =
+    Struct.new(
+      :zip_code,
+      :settlement,
+      :settlement_type,
+      :municipality,
+      :state,
+      :city,
+      :country
+    )
+end

data/lib/sepomex_hckdrk/version.rb

@@ -0,0 +1,3 @@
+module SEPOMEX_HCKDRK
+  VERSION = '0.4.1'
+end

data/sepomex_hckdrk.gemspec

@@ -0,0 +1,28 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "sepomex_hckdrk/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "sepomex_hckdrk"
+  spec.version     = SEPOMEX_HCKDRK::VERSION
+  spec.date        = '2019-10-10'
+  spec.description = "Ruby Bindings for SEPOMEX HCKDRK API"
+  spec.summary     = "Ruby that provides a library to SEPOMEX HCKDRK API"
+  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://rubygems.org/gems/sepomex-hckdrk-ruby'
+  spec.license      = 'MIT'
+
+  spec.add_dependency 'httparty', "~> 0.16.0"
+  spec.add_dependency "json", "~> 2.0"
+  spec.add_dependency 'activesupport', "~> 5.2"
+
+  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_hckdrk/general_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe SEPOMEX_HCKDRK::General do
+  describe '.info_cp' do
+    it 'successfully creates a customer' do
+      stub_request(:get, 'https://api-sepomex.hckdrk.mx/query/info_cp/97305').to_return(
+        body:
+          JSON.dump(
+            [
+              {
+                error: false,
+                code_error: 0,
+                error_message: "null",
+                response: {
+                  cp: "97305",
+                  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: "97305",
+                  asentamiento: "Cabo Norte",
+                  tipo_asentamiento: "Fraccionamiento",
+                  municipio: "Mérida",
+                  estado: "Yucatán",
+                  ciudad: "",
+                  pais: "México"
+                }
+              }
+            ]
+          ),
+        status: 200
+      )
+
+      zip_code = SEPOMEX_HCKDRK::General.info_zip_code(zip_code: '97305')
+
+      expect(zip_code).to be_a(SEPOMEX_HCKDRK::ZipCode)
+      expect(zip_code.zip_code).to eq('97305')
+      expect(zip_code.settlement).to eq('Granjas Cholul')
+      expect(zip_code.settlement_type).to eq('Colonia')
+      expect(zip_code.municipality).to eq('Mérida')
+      expect(zip_code.state).to eq('Yucatán')
+      expect(zip_code.city).to be_nil
+      expect(zip_code.country).to eq('México')
+    end
+
+    it 'raises error whith invalid cp' do
+      stub_request(:get, 'https://api-sepomex.hckdrk.mx/query/info_cp/97305123').to_return(
+        body:
+          JSON.dump(
+            {
+              error: true,
+              code_error: 102,
+              error_message: "La longitud del cp es inválida",
+              response: "null"
+            }
+          ),
+        status: 200
+      )
+
+      begin
+        zip_code = SEPOMEX_HCKDRK::General.info_zip_code(zip_code: '97305123')
+      rescue => exception
+        expect(exception).to be_a(SEPOMEX_HCKDRK::RequestError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'webmock/rspec'
+require 'rspec'
+require 'simplecov'
+
+require 'sepomex_hckdrk'
+
+SimpleCov.start { add_filter '/spec/' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sepomex_hckdrk
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Yellowme
@@ -100,7 +100,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
 - lib/sepomex_hckdrk.rb
+- lib/sepomex_hckdrk/client/api_client.rb
+- lib/sepomex_hckdrk/client/json_api.rb
+- lib/sepomex_hckdrk/error.rb
+- lib/sepomex_hckdrk/general.rb
+- lib/sepomex_hckdrk/structs/zip_code.rb
+- lib/sepomex_hckdrk/version.rb
+- sepomex_hckdrk.gemspec
+- spec/sepomex_hckdrk/general_spec.rb
+- spec/spec_helper.rb
 homepage: https://rubygems.org/gems/sepomex-hckdrk-ruby
 licenses:
 - MIT
@@ -125,4 +140,6 @@ rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby that provides a library to SEPOMEX HCKDRK API
-test_files: []
+test_files:
+- spec/sepomex_hckdrk/general_spec.rb
+- spec/spec_helper.rb