add limit

Author: acrogenesis

Readme.md

@@ -48,13 +48,24 @@ _parámetros necesarios_
 ```text
   codigo_postal=# codigo a buscar, parcial o total
 ```
+
+_parámetros opcionales_
+```text
+  limit=# número máximo de resultados a devolver
+```
+
 _Ejemplo de búsqueda para códigos que inicien con **66**, con **664** y con **6641**_
 ```json
 https://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=66
 https://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=664
 https://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=6641
 ```
 
+_Ejemplo de búsqueda limitada a 3 resultados_
+```json
+https://mexico-zip-codes.p.rapidapi.com/buscar?codigo_postal=66&limit=3
+```
+
 ** Para el código postal 6641 el servidor regresa **
 ```json
 {
@@ -87,6 +98,7 @@ _parámetros necesarios_
 _parámetros opcionales_
 ```text
   colonia=# nombre de la colonia (opcional)
+  limit=# número máximo de resultados a devolver
 ```
 
 _Ejemplo de búsqueda para códigos postales en Nuevo León, San Nicolás de los Garza_
@@ -99,6 +111,11 @@ _Ejemplo de búsqueda para códigos postales en Nuevo León, San Nicolás de los
 https://mexico-zip-codes.p.rapidapi.com/v2/buscar_por_ubicacion?estado=Nuevo%20León&municipio=San%20Nicolás%20de%20los%20Garza&colonia=Praderas%20de%20Santo%20Domingo
 ```
 
+_Ejemplo de búsqueda limitada a 5 resultados_
+```text
+https://mexico-zip-codes.p.rapidapi.com/v2/buscar_por_ubicacion?estado=Nuevo%20León&municipio=San%20Nicolás%20de%20los%20Garza&limit=5
+```
+
 **Respuesta del servidor**
 ```json
 {

app.rb

@@ -30,14 +30,16 @@
     on 'v2/buscar', param('codigo_postal') do |codigo_postal|
       res.headers['Cache-Control'] = 'max-age=525600, public'
       res.headers['Access-Control-Allow-Origin'] = '*'
-      res.write PostalCodes.fetch_codes(codigo_postal)
+      limit = req.params['limit']&.to_i
+      res.write PostalCodes.fetch_codes(codigo_postal, limit)
     end
 
     on 'v2/buscar_por_ubicacion', param('estado'), param('municipio') do |estado, municipio|
       res.headers['Cache-Control'] = 'max-age=525600, public'
       res.headers['Access-Control-Allow-Origin'] = '*'
       colonia = req.params['colonia'] # Optional parameter
-      res.write PostalCodes.fetch_by_location(estado, municipio, colonia)
+      limit = req.params['limit']&.to_i
+      res.write PostalCodes.fetch_by_location(estado, municipio, colonia, limit)
     end
   end
 end

models/postal_code.rb

@@ -1,13 +1,15 @@
 class PostalCode < ActiveRecord::Base
   self.table_name = 'codigos_postales'
 
-  scope :with_code, -> (code) { where(codigo_postal: code) }
+  scope :with_code, ->(code) { where(codigo_postal: code) }
 
-  def self.with_code_hint(code_hint)
-    where('codigo_postal LIKE :prefix', prefix: "#{code_hint}%")
-      .order(codigo_postal: :asc)
-      .distinct
-      .pluck(:codigo_postal)
+  def self.with_code_hint(code_hint, limit = nil)
+    query = where('codigo_postal LIKE :prefix', prefix: "#{code_hint}%")
+            .order(codigo_postal: :asc)
+            .distinct
+
+    query = query.limit(limit) if limit&.positive?
+    query.pluck(:codigo_postal)
   end
 
   def self.get_suburbs_for(code)

presenters/postal_codes.rb

@@ -1,11 +1,11 @@
 module PostalCodes
-  def self.fetch_codes(code)
-    postal_codes = search_postal_codes(code)
+  def self.fetch_codes(code, limit = nil)
+    postal_codes = search_postal_codes(code, limit)
     serialize('codigos_postales' => postal_codes)
   end
 
-  def self.search_postal_codes(code)
-    PostalCode.with_code_hint(code)
+  def self.search_postal_codes(code, limit = nil)
+    PostalCode.with_code_hint(code, limit)
   end
 
   def self.fetch_locations(code)
@@ -15,40 +15,44 @@ def self.fetch_locations(code)
     serialize(locations_json)
   end
 
-  def self.fetch_by_location(estado, municipio, colonia = nil)
-    postal_codes = search_by_location(estado, municipio, colonia)
+  def self.fetch_by_location(estado, municipio, colonia = nil, limit = nil)
+    postal_codes = search_by_location(estado, municipio, colonia, limit)
     locations_json = prepare_location_search_json(postal_codes, estado, municipio, colonia)
     serialize(locations_json)
   end
 
-  def self.search_by_location(estado, municipio, colonia = nil)
+  def self.search_by_location(estado, municipio, colonia = nil, limit = nil)
     # Use PostgreSQL's unaccent extension for better performance
     query = PostalCode
 
     # Find matching estado
-    matching_estado = query.where("unaccent(lower(estado)) = unaccent(lower(?))", estado).pluck(:estado).first
+    matching_estado = query.where('unaccent(lower(estado)) = unaccent(lower(?))', estado).pluck(:estado).first
 
     if matching_estado
       query = query.where(estado: matching_estado)
 
       # Find matching municipio
-      matching_municipio = query.where("unaccent(lower(municipio)) = unaccent(lower(?))", municipio).pluck(:municipio).first
+      matching_municipio = query.where('unaccent(lower(municipio)) = unaccent(lower(?))',
+                                       municipio).pluck(:municipio).first
 
       if matching_municipio
         query = query.where(municipio: matching_municipio)
 
         # Find matching colonia if provided
         matching_colonia = nil
         if colonia.present?
-          matching_colonia = query.where("unaccent(lower(colonia)) = unaccent(lower(?))", colonia).pluck(:colonia).first
+          matching_colonia = query.where('unaccent(lower(colonia)) = unaccent(lower(?))', colonia).pluck(:colonia).first
           query = query.where(colonia: matching_colonia) if matching_colonia
         end
 
+        postal_codes_query = query.select('DISTINCT codigo_postal').order('codigo_postal ASC')
+        postal_codes_query = postal_codes_query.limit(limit) if limit&.positive?
+
         {
           found_estado: matching_estado,
           found_municipio: matching_municipio,
           found_colonia: matching_colonia,
-          postal_codes: query.select('DISTINCT codigo_postal').order('codigo_postal ASC')
+          postal_codes: postal_codes_query
         }
       else
         { found_estado: matching_estado, found_municipio: nil, found_colonia: nil, postal_codes: [] }

spec/requests/api_spec.rb

@@ -107,15 +107,35 @@
   describe 'GET /v2/buscar' do
     let!(:postal_code1) { create(:postal_code, codigo_postal: '12345') }
     let!(:postal_code2) { create(:postal_code, codigo_postal: '12346') }
+    let!(:postal_code3) { create(:postal_code, codigo_postal: '12347') }
+    let!(:postal_code4) { create(:postal_code, codigo_postal: '12348') }
 
     it 'returns matching postal codes in v2 format' do
       get '/v2/buscar?codigo_postal=123'
       expect(last_response).to be_ok
       expect(last_response.headers['Content-Type']).to include('application/json')
 
       json_response = Oj.load(last_response.body)
-      puts "Response body: #{last_response.body}"
-      expect(json_response['codigos_postales']).to match_array(%w[12345 12346])
+      expect(json_response['codigos_postales']).to match_array(%w[12345 12346 12347 12348])
+    end
+
+    it 'returns limited postal codes when limit parameter is provided' do
+      get '/v2/buscar?codigo_postal=123&limit=2'
+      expect(last_response).to be_ok
+      expect(last_response.headers['Content-Type']).to include('application/json')
+
+      json_response = Oj.load(last_response.body)
+      expect(json_response['codigos_postales'].length).to eq(2)
+      expect(json_response['codigos_postales']).to include('12345', '12346')
+    end
+
+    it 'returns all postal codes when limit is not a positive number' do
+      get '/v2/buscar?codigo_postal=123&limit=0'
+      expect(last_response).to be_ok
+
+      json_response = Oj.load(last_response.body)
+      expect(json_response['codigos_postales'].length).to eq(4)
+      expect(json_response['codigos_postales']).to match_array(%w[12345 12346 12347 12348])
     end
   end
 
@@ -138,6 +158,18 @@
              municipio: test_municipio,
              colonia: 'Different Colonia')
 
+      create(:postal_code,
+             codigo_postal: '12347',
+             estado: test_estado,
+             municipio: test_municipio,
+             colonia: 'Another Colonia')
+
+      create(:postal_code,
+             codigo_postal: '12348',
+             estado: test_estado,
+             municipio: test_municipio,
+             colonia: 'Yet Another Colonia')
+
       # Create a postal code with different estado
       create(:postal_code,
              codigo_postal: '54321',
@@ -154,7 +186,27 @@
 
         json_response = Oj.load(last_response.body)
         expect(json_response).to have_key('codigos_postales')
-        expect(json_response['codigos_postales']).to match_array(%w[12345 12346])
+        expect(json_response['codigos_postales']).to match_array(%w[12345 12346 12347 12348])
+      end
+
+      it 'returns limited postal codes when limit parameter is provided' do
+        get "/v2/buscar_por_ubicacion?estado=#{test_estado}&municipio=#{test_municipio}&limit=2"
+        expect(last_response).to be_ok
+        expect(last_response.headers['Content-Type']).to include('application/json')
+
+        json_response = Oj.load(last_response.body)
+        expect(json_response).to have_key('codigos_postales')
+        expect(json_response['codigos_postales'].length).to eq(2)
+      end
+
+      it 'returns all postal codes when limit is not a positive number' do
+        get "/v2/buscar_por_ubicacion?estado=#{test_estado}&municipio=#{test_municipio}&limit=0"
+        expect(last_response).to be_ok
+
+        json_response = Oj.load(last_response.body)
+        expect(json_response).to have_key('codigos_postales')
+        expect(json_response['codigos_postales'].length).to eq(4)
+        expect(json_response['codigos_postales']).to match_array(%w[12345 12346 12347 12348])
       end
     end
 
@@ -167,6 +219,27 @@
         expect(json_response).to have_key('codigos_postales')
         expect(json_response['codigos_postales']).to match_array(['12345'])
       end
+
+      it 'applies limit parameter correctly with colonia filter' do
+        # Creating additional postal codes for the same colonia
+        create(:postal_code,
+               codigo_postal: '12349',
+               estado: test_estado,
+               municipio: test_municipio,
+               colonia: test_colonia)
+        create(:postal_code,
+               codigo_postal: '12350',
+               estado: test_estado,
+               municipio: test_municipio,
+               colonia: test_colonia)
+
+        get "/v2/buscar_por_ubicacion?estado=#{test_estado}&municipio=#{test_municipio}&colonia=#{test_colonia}&limit=2"
+        expect(last_response).to be_ok
+
+        json_response = Oj.load(last_response.body)
+        expect(json_response).to have_key('codigos_postales')
+        expect(json_response['codigos_postales'].length).to eq(2)
+      end
     end
 
     context 'without authentication' do