epok 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d0e1ef79e2fd5ff522e79748f413cdb123a79c863bba24a85dce868a1c7127
-  data.tar.gz: 0c44daa4fe8d10908c75301d9a363bacf4d03ff0edf0eb13a2ff307cf96fe286
+  metadata.gz: 74780db81aad8442533598aab22a695b4565710ce30ab5504439f59e55587195
+  data.tar.gz: d3562a616e0f3d28a666041f43abaa770e0bdbf386b581f64f5d225ccc6cbbd4
 SHA512:
-  metadata.gz: 8358374a58c28bd2cb5f10ec9ce94248b0a9ba2a2bb2a733f4cfb003a62fecf90e8e6ec46ffd8648b8ab4172df745976586fcc09b264d10c26f34438138af961
-  data.tar.gz: bcc962b28eaf4a3d8bb62325a422709488a437338aad6c7eced0afe9bce2c27a5865f7d367674759888e7fe78c28f46d8fb4350b3424dab60fba894627050816
+  metadata.gz: 02e22d2fb37d7b44611461af1bcc7e006b6a97d78c54a07416f092e9a00a989b26bd6a0bc38a6558378a200fb177e7c921a54f970e388711fa520888ab71f16e
+  data.tar.gz: 637d65db4058187386da2b632685b1488749eb859689bfaf242d962803d05fbfd1147f78d41256ea005445307e3ec8e5258c7b4c9437c2187181ddd5e9b4dfc7

data/CHANGELOG.md

@@ -0,0 +1,97 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project
+follows [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.6.0] - 2026-09-15
+
+### Changed
+
+- **Breaking:** `Epok.geocoder` is now `Epok.nearby`. Next to `Epok.geocode`
+  (address to point) the old name read as the same thing backwards.
+- Every string in an API response is stripped and squeezed once in `API.get`.
+  The API pads and double-spaces names at random, in every endpoint, and the
+  per-field strips it replaces only covered some of them.
+- Gemspec declares `required_ruby_version >= 3.3`, links the changelog and
+  source on rubygems.org, and ships only `lib/`, README, CHANGELOG and
+  LICENSE instead of the whole repository (tests and cassettes included).
+
+### Fixed
+
+- Malformed responses no longer escape as `NoMethodError`: an unparseable
+  centroid raises `Epok::Error`, non-string content values are kept as
+  strings, and a geocode match without coordinates has a nil `location`.
+
+## [0.5.0] - 2026-09-15
+
+### Added
+
+- `Epok.geocode(text)` turns "cabildo 1234" or "callao y corrientes" into
+  `Address` structs with the normalized text, partido, localidad and a
+  `Location`, via USIG's normalizer. Unknown addresses raise `Epok::NotFound`
+  with the service's message.
+- `Epok.datos_utiles(location)` returns the barrio, comuna, comisaría,
+  hospital area, health region and school district for a point. Outside the
+  city those are nil and `partido_amba` and `localidad_amba` are filled.
+- `Epok.search` accepts `categories:` (one or an array) and `limit:`.
+
+### Changed
+
+- README rewritten around an end-to-end example.
+- Removed minitest-reporters from the development dependencies.
+
+## [0.4.0] - 2026-09-15
+
+### Added
+
+- `Epok::Object` keeps listing data: `name`, `kind`, `category` and
+  `distance` (metres, from the geocoder) are available without a request.
+  `content`, `normalized_address` and `location` fetch lazily.
+- `Epok::Object#location` returns longitude and latitude, converted from the
+  city's projected grid through USIG. Nil when the object has no centroid.
+- `Epok.categories` lists all EPOk categories as `Category` structs.
+- `Epok.geocoder` accepts `radius:` (default 500 metres) and an array of
+  categories.
+- `Epok::Error` wraps timeouts, network failures, non-2xx responses and bad
+  JSON. `Epok::NotFound` for unknown ids.
+
+## [0.3.0] - 2026-09-15
+
+Tagged but never pushed to rubygems.org.
+
+### Changed
+
+- **Breaking:** `Epok.search` and `Epok.geocoder` return an
+  `Epok::Collection`, which is `Enumerable` and lazy. `Epok::Search`,
+  `Epok::Geocoder` and `Epok::Collectable` are removed, along with the
+  `query`, `x`, `y` and `categories` readers.
+
+### Fixed
+
+- Query parameters are URL-encoded, so non-ASCII searches like "peña" no
+  longer raise `URI::InvalidURIError`.
+
+## [0.2.0] - 2026-09-15
+
+### Fixed
+
+- Requests go over HTTPS. The API started redirecting plain HTTP to HTTPS
+  with an empty body, which made every call fail with a JSON parse error.
+- Object content values are stripped of surrounding whitespace.
+- Test suite runs on Ruby 4: vcr bumped to 6.x, lockfile regenerated,
+  bundler dev dependency dropped.
+
+## [0.1.1] - 2019-04-24
+
+Initial release: `Epok.search`, `Epok.geocoder` and `Epok::Object`.
+
+[Unreleased]: https://github.com/arzezak/epok/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/arzezak/epok/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/arzezak/epok/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/arzezak/epok/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/arzezak/epok/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/arzezak/epok/compare/e629f99...v0.2.0
+[0.1.1]: https://github.com/arzezak/epok/commits/e629f99

data/README.md

@@ -20,29 +20,73 @@ Or install it yourself as:
 
 ## Usage
 
+"I'm at Callao y Corrientes, what's around me?" in five requests:
+
 ```ruby
->> obelisco = Epok::Location.new(x: -58.381570, y: -34.603738)
-=> #<struct Epok::Location x=-58.38157, y=-34.603738>
+require "epok"
+
+# 1. Turn a typed address into coordinates.
+here = Epok.geocode("callao y corrientes").first
+puts "You are at #{here.address}"
+
+# 2. Which neighbourhood and comuna is that?
+area = Epok.datos_utiles(here.location)
+puts "That's #{area.barrio}, #{area.comuna}"
+
+# 3. What's within 300 metres, by category?
+nearby = Epok.nearby(here.location, %w[estaciones_de_subte farmacias], radius: 300)
+nearby.sort_by(&:distance).first(5).each do |place|
+  puts "  #{place.distance.round} m  #{place.name} (#{place.kind})"
+end
+
+# 4. Drill into one: full record and coordinates for a map pin.
+closest = nearby.min_by(&:distance)
+puts "Pin: #{closest.location.y}, #{closest.location.x}"
+closest.content.each { |key, value| puts "  #{key}: #{value}" }
+```
+
+```
+You are at CALLAO AV. y CORRIENTES AV., CABA
+That's San Nicolas, Comuna 3
+  3 m  CALLAO - MAESTRO ALFREDO BRAVO (Línea B) (Estación de Subte (Metro))
+  42 m  Farmacia en CORRIENTES AV. 1820 (Farmacia)
+  73 m  Farmacia en CORRIENTES AV. 1835 (Farmacia)
+  98 m  Farmacia en CALLAO AV. 477 (Farmacia)
+  111 m  Farmacia en CORRIENTES AV. 1880 (Farmacia)
+Pin: -34.604419, -58.392318
+  Nombre: CALLAO - MAESTRO ALFREDO BRAVO (Línea B)
+  Línea: B
+  Estado: Estación Malabia cerrada por obras de renovación integral.
+  Cabeceras: J. M. de Rosas - L. N. Alem
+  Tiempo: 27 min.
+```
 
->> pharmacies_around_obelisco = Epok.geocoder(obelisco, "farmacias")
-=> #<Epok::Geocoder:0x00007f8719ab4f08 @x=-58.38157, @y=-34.603738, @categories="farmacias">
+Steps 1 to 3 are one request each; step 4 is two (the record, then the coordinate conversion). The content hash is whatever the city publishes for that category: subway stations carry line, status and travel time, pharmacies carry phone and delivery details.
 
->> pharmacies_around_obelisco.first.content
-=> {"Nombre"=>"Farmacia en PELLEGRINI, CARLOS 765", "Teléfono"=>"43223198 43220298"}
+### The rest
 
->> cgp = Epok.search("cgp")
-=> #<Epok::Search:0x00007f871a09ac60 @query="cgp">
+**Search by text**, optionally filtered by category and capped:
 
->> sede_4 = cgp.first
-=> #<Epok::Object:0x00007f8719b36788 @id="sedes_de_comunas|4">
+```ruby
+Epok.search("cgp", categories: "sedes_de_comunas", limit: 3).map(&:name)
+# => ["Sede Comunal 4", "Sede Comunal 9", "Sede Comunal 10"]
+```
 
->> sede_4.name
-=> "Sede Comunal 4"
+**Categories** are what `nearby` and the search filter take. There are 167, each with an id, a display name and a description:
 
->> sede_4.content
-=> {"Nombre"=>"Sede Comunal 4", "Dirección"=>"BARCO CENTENERA del 2906", "Teléfonos"=>"4918-2243/1815/8920-4949 9024 Int. 105", "Trámites y Servicios"=>"<a href=\"http://www.buenosaires.gob.ar/comuna-4/sede-comunal-4\" target=\"_blank\">link</a>"}
+```ruby
+Epok.categories.find { |c| c.id == "farmacias" }
+# => #<struct Epok::Category id="farmacias", name="Farmacias", description="">
 ```
 
+**Collections** from `search` and `nearby` are `Enumerable` and lazy: nothing is requested until you iterate.
+
+**Objects** know their `id`, `name`, `kind`, `category` and, from `nearby`, `distance` in metres straight from the listing. `content`, `normalized_address` and `location` fetch the full record on first use; `location` also converts the city's projected coordinates through USIG. `Epok::Object.new("farmacias|1082")` looks one up by id.
+
+**Locations** are `Epok::Location.new(x: longitude, y: latitude)`. `geocode` returns every match across the metro area, city first, as `Address` structs with `address`, `partido`, `localidad` and `location`. `datos_utiles` returns nil for the city fields outside CABA and fills `partido_amba` and `localidad_amba` instead.
+
+**Errors**: every request failure raises `Epok::Error`. An unknown id or address raises `Epok::NotFound`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/epok/api.rb

@@ -2,26 +2,87 @@ require "net/http"
 require "json"
 
 module Epok
+  class Error < StandardError; end
+  class NotFound < Error; end
+
   class API
-    BASE_URL = "https://epok.buenosaires.gob.ar".freeze
+    EPOK_URL = "https://epok.buenosaires.gob.ar".freeze
+    USIG_URL = "https://ws.usig.buenosaires.gob.ar".freeze
+    USIG_SERVICES_URL = "https://servicios.usig.buenosaires.gob.ar".freeze
+    TIMEOUT = 10
 
     def self.object(id)
-      JSON.parse(get("/getObjectContent/?id=#{id}"))
+      object = get(EPOK_URL, "/getObjectContent/", id: id)
+      raise NotFound, "no object with id #{id}" if object.empty?
+
+      object
+    end
+
+    def self.search(query, categories = nil, limit = nil)
+      params = { texto: query, categoria: categories, limit: limit }.compact
+
+      get(EPOK_URL, "/buscar/", params)["instancias"]
+    end
+
+    def self.nearby(x, y, categories, radius)
+      get(EPOK_URL, "/reverseGeocoderLugares/",
+        x: x, y: y, categorias: categories, radio: radius)["instancias"]
+    end
+
+    def self.categories
+      get(EPOK_URL, "/getCategorias/", {})["categorias"]
     end
 
-    def self.search(query)
-      JSON.parse(get("/buscar/?texto=#{query}"))["instancias"]
+    def self.geocode(text)
+      response = get(USIG_SERVICES_URL, "/normalizar/", direccion: text, geocodificar: true)
+      addresses = response["direccionesNormalizadas"]
+      raise NotFound, response["errorMessage"] if addresses.empty?
+
+      addresses
     end
 
-    def self.geocoder(x, y, categories)
-      JSON.parse(get(
-        "/reverseGeocoderLugares/?x=#{x}&y=#{y}&categorias=#{categories}&radio=500"
-      ))["instancias"]
+    def self.datos_utiles(x, y)
+      get(USIG_URL, "/datos_utiles", x: x, y: y)
     end
 
-    def self.get(path)
-      Net::HTTP.get_response(URI("#{BASE_URL}#{path}")).body
+    # Converts EPOk's projected coordinates (Gauss-Krüger Buenos Aires) to
+    # longitude and latitude through the city's USIG service.
+    def self.to_lonlat(x, y)
+      response = get(USIG_URL, "/rest/convertir_coordenadas", x: x, y: y, output: "lonlat")
+      raise Error, "USIG could not convert (#{x}, #{y})" unless response["tipo_resultado"] == "Ok"
+
+      response["resultado"].values_at("x", "y").map(&:to_f)
+    end
+
+    def self.get(host, path, params)
+      uri = URI("#{host}#{path}")
+      uri.query = URI.encode_www_form(params)
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true,
+        open_timeout: TIMEOUT, read_timeout: TIMEOUT) do |http|
+        http.get(uri.request_uri)
+      end
+
+      unless response.is_a?(Net::HTTPSuccess)
+        raise Error, "EPOk responded #{response.code} to #{uri}"
+      end
+
+      normalize(JSON.parse(response.body))
+    rescue SystemCallError, SocketError, Timeout::Error, OpenSSL::SSL::SSLError, JSON::ParserError => e
+      raise Error, "#{e.class}: #{e.message}"
     end
     private_class_method :get
+
+    # The API pads and double-spaces strings at random. Clean every string
+    # in a response once, here, so no field needs its own strip.
+    def self.normalize(value)
+      case value
+      when Hash then value.transform_values { |v| normalize(v) }
+      when Array then value.map { |v| normalize(v) }
+      when String then value.strip.squeeze(" ")
+      else value
+      end
+    end
+    private_class_method :normalize
   end
 end

data/lib/epok/collection.rb

@@ -2,22 +2,18 @@ module Epok
   class Collection
     include Enumerable
 
-    attr_reader :data
-
-    def initialize(data, id = "id")
-      @data = collection(data, id)
+    def initialize(&fetch)
+      @fetch = fetch
     end
 
     def each(&block)
-      data.each(&block)
+      objects.each(&block)
     end
 
     private
 
-    def collection(data, id)
-      data.map do |item|
-        Object.new(item[id])
-      end
+    def objects
+      @objects ||= @fetch.call.map { |item| Object.new(item) }
     end
   end
 end

data/lib/epok/object.rb

@@ -1,23 +1,54 @@
 module Epok
   class Object
-    attr_reader :id
+    attr_reader :id, :distance
 
-    def initialize(id)
-      @id = id
+    # Accepts either an id ("farmacias|1082") or a result hash from a search
+    # or nearby listing. Listing attributes are available immediately; the
+    # full content is fetched on first use.
+    def initialize(attributes)
+      attributes = { "id" => attributes } if attributes.is_a?(String)
+
+      @id = attributes.fetch("id")
+      @name = attributes["nombre"]
+      @kind = attributes["clase"]
+      @distance = attributes["distancia"]&.to_f
     end
 
     def name
-      content["Nombre"]
+      @name ||= content["Nombre"]
+    end
+
+    def kind
+      @kind ||= object["clase"]
+    end
+
+    def category
+      id.split("|").first
     end
 
     def normalized_address
       object["direccionNormalizada"]
     end
 
+    # Longitude and latitude as a Location, or nil when EPOk has no
+    # centroid for the object. Costs one extra request the first time.
+    def location
+      return @location if defined?(@location)
+
+      centroid = object.dig("ubicacion", "centroide")
+      @location = centroid && begin
+        point = centroid[/\(([^)]*)\)/, 1]
+        raise Error, "unparseable centroid #{centroid.inspect} for #{id}" unless point
+
+        lon, lat = API.to_lonlat(*point.split.map(&:to_f))
+        Location.new(x: lon, y: lat)
+      end
+    end
+
     def content
       object["contenido"].each_with_object({}) do |entry, hash|
         name, value = entry.values_at("nombre", "valor")
-        value = value.strip
+        value = value.to_s
         hash[name] = value unless value.empty?
       end
     end

data/lib/epok/version.rb

@@ -1,3 +1,3 @@
 module Epok
-  VERSION = "0.2.0"
+  VERSION = "0.6.0"
 end

data/lib/epok.rb

@@ -1,17 +1,68 @@
 require "epok/api"
-require "epok/collectable"
 require "epok/collection"
-require "epok/geocoder"
 require "epok/object"
-require "epok/search"
 require "epok/version"
 
 module Epok
-  def self.search(query)
-    Search.new(query)
+  Location = Struct.new(:x, :y, keyword_init: true)
+  Category = Struct.new(:id, :name, :description, keyword_init: true)
+  DatosUtiles = Struct.new(
+    :barrio, :comuna, :comisaria, :comisaria_vecinal,
+    :area_hospitalaria, :region_sanitaria, :distrito_escolar,
+    :partido_amba, :localidad_amba,
+    keyword_init: true
+  )
+
+  Address = Struct.new(:address, :partido, :localidad, :location, keyword_init: true)
+
+  DEFAULT_RADIUS = 500
+
+  def self.search(query, categories: nil, limit: nil)
+    categories = Array(categories).join(",") if categories
+
+    Collection.new { API.search(query, categories, limit) }
+  end
+
+  def self.nearby(location, categories, radius: DEFAULT_RADIUS)
+    categories = Array(categories).join(",")
+
+    Collection.new { API.nearby(location.x, location.y, categories, radius) }
+  end
+
+  def self.geocode(text)
+    API.geocode(text).map do |address|
+      coordinates = address["coordenadas"]
+      location = coordinates && Location.new(
+        x: coordinates["x"].to_f, y: coordinates["y"].to_f
+      )
+
+      Address.new(
+        address: address["direccion"],
+        partido: address["nombre_partido"],
+        localidad: address["nombre_localidad"],
+        location: location
+      )
+    end
+  end
+
+  def self.datos_utiles(location)
+    datos = API.datos_utiles(location.x, location.y)
+
+    DatosUtiles.new(
+      DatosUtiles.members.to_h do |member|
+        value = datos[member.to_s]
+        [member, value.to_s.empty? ? nil : value]
+      end
+    )
   end
 
-  def self.geocoder(location, categories)
-    Geocoder.new(location, categories)
+  def self.categories
+    API.categories.map do |category|
+      Category.new(
+        id: category["nombre_normalizado"],
+        name: category["nombre"],
+        description: category["descripcion"]
+      )
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epok
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ariel Rzezak
@@ -23,26 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -91,42 +71,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.1
-description: GCBA EPOk wrapper to query indexed geographic objects.
+description: Search the city's indexed geographic objects, find what is near a point,
+  geocode addresses and look up the barrio and comuna of a location, through the GCBA
+  EPOk and USIG services.
 email:
 - arzezak@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".claude/skills/swarf/SKILL.md"
-- ".gitignore"
-- CLAUDE.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- epok.gemspec
 - lib/epok.rb
 - lib/epok/api.rb
-- lib/epok/collectable.rb
 - lib/epok/collection.rb
-- lib/epok/geocoder.rb
 - lib/epok/object.rb
-- lib/epok/search.rb
 - lib/epok/version.rb
-- test/epok/geocoder_test.rb
-- test/epok/object_test.rb
-- test/epok/search_test.rb
-- test/epok_test.rb
-- test/test_helper.rb
 homepage: https://github.com/arzezak/epok
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/arzezak/epok
+  changelog_uri: https://github.com/arzezak/epok/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/arzezak/epok/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -134,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -143,5 +112,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.20
 specification_version: 4
-summary: GCBA EPOk wrapper.
+summary: Ruby client for the Buenos Aires city EPOk geographic API.
 test_files: []

data/.claude/skills/swarf/SKILL.md

@@ -1,77 +0,0 @@
----
-name: swarf
-description: Score Ruby methods by complexity against test coverage with swarf, and turn the worst rows into the next test to write. Use after writing or changing Ruby code and before calling a change done.
----
-
-# swarf
-
-swarf scores every Ruby method with `CRAP = CC² · (1 − coverage)³ + CC` and lists them worst first. Complexity is parsed from source. Coverage is recorded by a probe loaded into the test run and stored in `.swarf/coverage.json`, so scoring works without setup but coverage needs a test run.
-
-## The loop
-
-1. Run the suite with the probe loaded (see Setup if unsure):
-
-   ```
-   bundle exec rspec          # or: bundle exec rake test
-   ```
-
-2. Score the files you touched, not the whole project:
-
-   ```
-   git diff --name-only --diff-filter=d main -- '*.rb' | xargs bundle exec swarf
-   ```
-
-   Named paths are always scored, even under `test/`, `db/` or a `.swarfignore` pattern.
-
-3. Take the top rows and act on the Evidence column (next section). Write or extend the test, re-run the suite, score again.
-
-4. Stop when the touched methods sit at `CRAP = CC` with `Cov% 100.0`. Nothing you test pulls a score under its CC. If a score is too high at full coverage, that is complexity, which is a refactor question, not a testing one. Do not split methods to chase the number.
-
-Before saying a change is done, run step 2 and report the top rows.
-
-## Reading a row
-
-```
-Method          CC    Cov%   CRAP      Evidence  Location
-Cart#checkout    6    0.0%  42.00  never called  lib/cart.rb:31
-Cart#discount    4   50.0%   6.00        3/6 br  lib/cart.rb:24
-```
-
-| Evidence       | Meaning                                      | Do                                                            |
-| -------------- | -------------------------------------------- | ------------------------------------------------------------- |
-| `never called` | A VM call count of zero. No test reaches it. | Write a test that calls it.                                   |
-| `3/6 br`       | 3 of 6 branch outcomes ran.                  | Extend a test to the untaken outcomes.                        |
-| `1/1 ln`       | No branches, so lines are the whole truth.   | Nothing, at 100%.                                             |
-| `no data`      | No run has been recorded for this file.      | The probe is not loaded, or the suite has not run. Fix Setup. |
-| `stale`        | The file changed after it was measured.      | Re-run the suite, then score again.                           |
-
-`no data` and `stale` both score at the `CC² + CC` floor rather than guess. They are also counted per file under the table, because the fix is per file.
-
-A `never called` on a method a test clearly exercises means the test ran without the probe, or the probe loaded after the file. Check Setup before writing a duplicate test.
-
-## Setup
-
-The probe must load before the code under test, because `Coverage` only sees files loaded after it starts. One line, placed first:
-
-- **RSpec**: first line of `.rspec`: `--require swarf/probe`
-- **Minitest**: first line of `test/test_helper.rb`: `require "swarf/probe"`
-- **Rails**: in `test/test_helper.rb`, after `require "bundler/setup"` and before `require_relative "../config/environment"`. Below the environment require, the whole app is invisible to it.
-- **Anything**: `RUBYOPT="-rswarf/probe" bundle exec rake test`
-
-Add `.swarf/` to `.gitignore`. Runs merge, so a single spec file adds to what earlier runs proved; nothing is erased until the file's bytes change.
-
-Do not run swarf's probe alongside SimpleCov. Ruby allows one `Coverage.start` per process; if SimpleCov started first, swarf warns and records nothing.
-
-## Commands
-
-```
-bundle exec swarf                       # whole project, worst 20
-bundle exec swarf lib/ app/             # directories
-bundle exec swarf app/models/cart.rb    # one file
-bundle exec swarf --limit 0             # every row
-bundle exec swarf --ignore "app/legacy/**"
-bundle exec swarf --all                 # ignore nothing, including db/ and .swarfignore
-SWARF_DIR=/tmp/swarf bundle exec swarf  # store elsewhere; set for the test run too
-```
-
-swarf's CC counts `if`, `unless`, `while`, `until`, `for`, `when`, `in`, `rescue`, `&&`, `||` and `&.`, not blocks, so it will not match RuboCop's. Methods made by `define_method` are not seen.

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/test/fixtures/
-.swarf/

data/CLAUDE.md

@@ -1,31 +0,0 @@
-# Epok
-
-Ruby gem wrapping the GCBA EPOk API (https://epok.buenosaires.gob.ar).
-No runtime dependencies beyond the standard library.
-
-## Development
-
-```
-bundle install
-bundle exec rake test     # records VCR cassettes into test/fixtures on first run
-bundle exec swarf lib/    # complexity vs. coverage report, worst first
-```
-
-Cassettes are gitignored, so the first test run hits the live API.
-The API rejects curl's default User-Agent, but Ruby's Net::HTTP works fine.
-
-## Releasing
-
-1. Make sure `main` is clean and pushed, and `bundle exec rake test` passes.
-2. Bump `Epok::VERSION` in `lib/epok/version.rb`. Follow semver:
-   patch for fixes, minor for new behaviour, major for breaking changes.
-3. Commit it as `Bump version to X.Y.Z`.
-4. Run `bundle exec rake release`. This builds the gem, creates and pushes
-   the `vX.Y.Z` tag, and pushes the gem to rubygems.org. It needs rubygems
-   credentials (`gem signin`) and may prompt for an OTP if the account has
-   MFA enabled. If it prompts, the user has to run it themselves.
-5. Create a GitHub release from the tag with a short summary of what changed:
-   `gh release create vX.Y.Z --generate-notes`.
-
-Version numbers on rubygems.org cannot be reused, so check the diff before
-running step 4.

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at arzezak@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-gemspec
-
-gem "swarf", group: :development

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    epok (0.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.9.0)
-      public_suffix (>= 2.0.2, < 8.0)
-    ansi (1.6.0)
-    bigdecimal (4.1.3)
-    builder (3.3.0)
-    crack (1.0.1)
-      bigdecimal
-      rexml
-    hashdiff (1.2.1)
-    minitest (5.27.0)
-    minitest-reporters (1.8.0)
-      ansi
-      builder
-      minitest (>= 5.0, < 7)
-      ruby-progressbar
-    public_suffix (7.0.5)
-    rake (13.4.2)
-    rexml (3.4.4)
-    ruby-progressbar (1.13.0)
-    swarf (0.2.0)
-    vcr (6.4.0)
-    webmock (3.26.4)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  arm64-darwin-23
-  ruby
-
-DEPENDENCIES
-  epok!
-  minitest (~> 5.0)
-  minitest-reporters (~> 1.3, >= 1.3.6)
-  rake (~> 13.0)
-  swarf
-  vcr (~> 6.0)
-  webmock (~> 3.5, >= 3.5.1)
-
-CHECKSUMS
-  addressable (2.9.0) sha256=7fdf6ac3660f7f4e867a0838be3f6cf722ace541dd97767fa42bc6cfa980c7af
-  ansi (1.6.0) sha256=ac9ea0c0ea8d32fb4e271348e609963ac78882f34b73836c2a02b3622e666658
-  bigdecimal (4.1.3) sha256=61ebe1e5e559bdc3cc6f2c0ee7f427321fc838f59611c294356eb04d6e21cf66
-  builder (3.3.0) sha256=497918d2f9dca528fdca4b88d84e4ef4387256d984b8154e9d5d3fe5a9c8835f
-  crack (1.0.1) sha256=ff4a10390cd31d66440b7524eb1841874db86201d5b70032028553130b6d4c7e
-  epok (0.2.0)
-  hashdiff (1.2.1) sha256=9c079dbc513dfc8833ab59c0c2d8f230fa28499cc5efb4b8dd276cf931457cd1
-  minitest (5.27.0) sha256=2d3b17f8a36fe7801c1adcffdbc38233b938eb0b4966e97a6739055a45fa77d5
-  minitest-reporters (1.8.0) sha256=8ce5280fb73ad3178ae525454df169b6f28c1b38b1d088ea91815d3a370ba384
-  public_suffix (7.0.5) sha256=1a8bb08f1bbea19228d3bed6e5ed908d1cb4f7c2726d18bd9cadf60bc676f623
-  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
-  rexml (3.4.4) sha256=19e0a2c3425dfbf2d4fc1189747bdb2f849b6c5e74180401b15734bc97b5d142
-  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
-  swarf (0.2.0) sha256=b4306a244fe4b096cfe263e452e666156856eac2467ae5d770639ef11388b375
-  vcr (6.4.0) sha256=077ac92cc16efc5904eb90492a18153b5e6ca5398046d8a249a7c96a9ea24ae6
-  webmock (3.26.4) sha256=8d8da206d217ebe6968cfb09c77f4533c23074e1432bad865f3994eacbaad50d
-
-BUNDLED WITH
-  4.0.20

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task default: :test

data/bin/console

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "epok"
-require "irb"
-
-@obelisco = Epok::Location.new(x: -58.381570, y: -34.603738)
-
-IRB.start(__FILE__)

data/bin/setup

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install

data/epok.gemspec

@@ -1,25 +0,0 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "epok/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "epok"
-  spec.version       = Epok::VERSION
-  spec.authors       = ["Ariel Rzezak"]
-  spec.email         = ["arzezak@gmail.com"]
-
-  spec.summary       = "GCBA EPOk wrapper."
-  spec.description   = "GCBA EPOk wrapper to query indexed geographic objects."
-  spec.homepage      = "https://github.com/arzezak/epok"
-  spec.license       = "MIT"
-
-  spec.files = `git ls-files`.split("\n")
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "minitest-reporters", "~> 1.3", ">= 1.3.6"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "vcr", "~> 6.0"
-  spec.add_development_dependency "webmock", "~> 3.5", ">= 3.5.1"
-end

data/lib/epok/collectable.rb

@@ -1,17 +0,0 @@
-require "forwardable"
-
-module Epok
-  module Collectable
-    def self.included(base)
-      base.class_eval do
-        extend Forwardable
-
-        def_delegators :results, :entries, :first
-      end
-    end
-
-    def collection(object)
-      Collection.new object
-    end
-  end
-end

data/lib/epok/geocoder.rb

@@ -1,21 +0,0 @@
-module Epok
-  Location = Struct.new(:x, :y, keyword_init: true)
-
-  class Geocoder
-    include Collectable
-
-    attr_reader :x, :y, :categories
-
-    def initialize(location, categories)
-      @x = location.x
-      @y = location.y
-      @categories = categories
-    end
-
-    private
-
-    def results
-      collection API.geocoder(x, y, categories)
-    end
-  end
-end

data/lib/epok/search.rb

@@ -1,17 +0,0 @@
-module Epok
-  class Search
-    include Collectable
-
-    attr_reader :query
-
-    def initialize(query)
-      @query = query
-    end
-
-    private
-
-    def results
-      collection API.search(query)
-    end
-  end
-end

data/test/epok/geocoder_test.rb

@@ -1,29 +0,0 @@
-require "test_helper"
-
-module Epok
-  class GeocoderTest < Minitest::Test
-    def setup
-      VCR.insert_cassette("geocoder", record: :new_episodes)
-    end
-
-    def teardown
-      VCR.eject_cassette("geocoder")
-    end
-
-    def test_that_geocoder_results_are_epok_objects
-      assert_instance_of Object, result
-    end
-
-    def test_that_a_single_geocoder_result_has_a_name
-      assert_match "Línea D", result.name
-    end
-
-    private
-
-    def result
-      obelisco = Location.new(x: -58.381570, y: -34.603738)
-      results = Geocoder.new(obelisco, "estaciones_de_subte")
-      results.first
-    end
-  end
-end

data/test/epok/object_test.rb

@@ -1,45 +0,0 @@
-require "test_helper"
-
-module Epok
-  class ObjectTest < Minitest::Test
-    def setup
-      VCR.insert_cassette("object")
-    end
-
-    def teardown
-      VCR.eject_cassette("object")
-    end
-
-    def test_that_an_object_has_a_name
-      assert_equal "BIBLIOTECA ANMAT", object.name
-    end
-
-    def test_that_an_object_has_a_normalized_address
-      assert_equal "DE MAYO AV. 869", object.normalized_address
-    end
-
-    def test_that_an_object_has_content
-      expected_content = {
-        "Nombre" => "BIBLIOTECA ANMAT",
-        "Categoria" => "BIBLIOTECA",
-        "Subcategoria" => "ESPECIALIZADA GUBERNAMENTAL",
-        "Teléfonos" => "54.011 4340-0800 INT. 1047 FAX 54.011 4340-0800 INT. 1048",
-        "E-Mail" => "<a href=\"mailto:NDURAND@ANMAT.GOV.AR\">NDURAND@ANMAT.GOV.AR</a>",
-        "Página WEB" => "<a href=\"http://WWW.ANMAT.GOV.AR\" target=\"_blank\">WWW.ANMAT.GOV.AR</a>",
-        "Dependencia" => "ADMINISTRACION NACIONAL DE MEDICAMENTOS Y TECNOLOGIA MEDICA ANMAT",
-        "Sector" => "PUBLICO",
-        "Dirección" => "DE MAYO AV. 869",
-        "Barrio" => "MONSERRAT",
-        "Comuna" => "Comuna 1"
-      }
-
-      assert_equal expected_content, object.content
-    end
-
-    private
-
-    def object
-      Object.new("dependencias_culturales|1635")
-    end
-  end
-end

data/test/epok/search_test.rb

@@ -1,28 +0,0 @@
-require "test_helper"
-
-module Epok
-  class SearchTest < Minitest::Test
-    def setup
-      VCR.insert_cassette("search")
-    end
-
-    def teardown
-      VCR.eject_cassette("search")
-    end
-
-    def test_that_search_results_are_epok_objects
-      assert_instance_of Object, result
-    end
-
-    def test_that_a_single_search_result_has_a_name
-      assert_match "San Miguel de Garicoits", result.name
-    end
-
-    private
-
-    def result
-      results = Search.new("garicoits")
-      results.first
-    end
-  end
-end

data/test/epok_test.rb

@@ -1,20 +0,0 @@
-require "test_helper"
-
-class EpokTest < Minitest::Test
-  def test_that_search_builds_a_search
-    search = Epok.search("garicoits")
-
-    assert_instance_of Epok::Search, search
-    assert_equal "garicoits", search.query
-  end
-
-  def test_that_geocoder_builds_a_geocoder
-    obelisco = Epok::Location.new(x: -58.381570, y: -34.603738)
-    geocoder = Epok.geocoder(obelisco, "farmacias")
-
-    assert_instance_of Epok::Geocoder, geocoder
-    assert_equal(-58.381570, geocoder.x)
-    assert_equal(-34.603738, geocoder.y)
-    assert_equal "farmacias", geocoder.categories
-  end
-end

data/test/test_helper.rb

@@ -1,15 +0,0 @@
-require "swarf/probe"
-
-$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-
-require "epok"
-require "minitest/autorun"
-require "minitest/reporters"
-require "vcr"
-
-Minitest::Reporters.use!
-
-VCR.configure do |config|
-  config.cassette_library_dir = "test/fixtures"
-  config.hook_into :webmock
-end