sperant-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 870356b1e113b4da8ab850d488569b39b1d8ba1ef626d66d71b365abfd582935
-  data.tar.gz: ff69f45c39a84969c6fbbe740a10c0b5256aeb89f8342f93d7b1c84eb74b3c39
+  metadata.gz: c254887c9d318140a66af53ffb6f073815d62b62aed1aed3798796eb487a10a4
+  data.tar.gz: c0233f7fca76222908805bd3a743df578a7fd1b694efdfea8ebd041d49667087
 SHA512:
-  metadata.gz: 84410faecd8b3829e4ddd6475cd55341caafd32b8936a91433be2d96acbcd0851c862b2601ea9ed2dbfa9cb4a1d99ebb8eacbd89c3beff8f6a4436c7057711c6
-  data.tar.gz: fe670ebde1bef5c54286c40c4da34cb6ba35a3c35f69e949c92d5eebbb53a9339aafe9a05c3ec77e02bdecfa6858feb6ab8dabe64ee6f58779e247617c9b8fa0
+  metadata.gz: 1678919c944c5a593ee8377b7574752a2da21a6ba08ba2cdaf057df5333530e80aeb0286c222a839d6cd56a875299b16a6e506f3f592cce4a189c22701a03edf
+  data.tar.gz: 7e62119e77a6c5de14c7ffa0b654b5126a0248629897aa172de5a775747a118f9a82d8c42a7c789f623309e5101953ff08144334266d206825e5601071dd77bf

data/README.md

@@ -83,6 +83,48 @@ client = SperantApi::Client.new
 client.projects.list(q: "Prados")
 ```
 
+## Endpoints disponibles
+
+Resumen de qué hace cada endpoint para encontrarlos rápido:
+
+<details>
+<summary><strong>Proyectos</strong> — listar y obtener un proyecto por ID</summary>
+
+| Método | Descripción |
+|--------|-------------|
+| `client.projects.list` | Lista proyectos (paginado). Filtros: `code`, `q`, `page`. |
+| `client.projects.find(id)` | Obtiene un proyecto por su ID. |
+
+<pre>GET /v3/projects
+GET /v3/projects/:id</pre>
+</details>
+
+<details>
+<summary><strong>Clientes</strong> — listar y obtener un cliente por ID</summary>
+
+| Método | Descripción |
+|--------|-------------|
+| `client.clients.list` | Lista clientes (paginado). Filtros: `q` (documento/email/celular), `page`. |
+| `client.clients.find(id)` | Obtiene un cliente por su ID. |
+
+<pre>GET /v3/clients
+GET /v3/clients/:id</pre>
+</details>
+
+<details>
+<summary><strong>Unidades</strong> — listar y obtener una unidad por ID (dentro de un proyecto)</summary>
+
+| Método | Descripción |
+|--------|-------------|
+| `client.units.list(project_id:)` | Lista unidades de un proyecto (paginado). Filtros: `block_id`, `commercial_status_id`, `page`. |
+| `client.units.find(project_id:, id:)` | Obtiene una unidad por ID dentro del proyecto indicado. |
+
+<pre>GET /v3/projects/:project_id/units
+GET /v3/projects/:project_id/units/:id</pre>
+</details>
+
+---
+
 ## Uso básico
 
 ### Listar proyectos
@@ -103,6 +145,12 @@ response = client.projects.list(code: "PRADOS")
 response = client.projects.list(page: 2)
 ```
 
+### Obtener un proyecto por ID
+
+```ruby
+project = client.projects.find(456)   # Hash con los datos del proyecto
+```
+
 ### Listar clientes
 
 ```ruby
@@ -111,6 +159,12 @@ response = client.clients.list(q: "+51999...")  # filtrar por documento, email o
 response = client.clients.list(page: 1)
 ```
 
+### Obtener un cliente por ID
+
+```ruby
+client_data = client.clients.find(123)   # Hash con los datos del cliente
+```
+
 ### Listar unidades de un proyecto
 
 ```ruby
@@ -123,6 +177,12 @@ response = client.units.list(
 )
 ```
 
+### Obtener una unidad por ID
+
+```ruby
+unit = client.units.find(project_id: 7, id: 42)   # Hash con los datos de la unidad
+```
+
 ## Respuesta paginada
 
 Los métodos `list` devuelven un objeto `SperantApi::Response::Paginated` con:

data/lib/sperant_api/resources/base.rb

@@ -25,6 +25,14 @@ module SperantApi
         build_paginated_response(raw)
       end
 
+      # Realiza GET al path y devuelve el cuerpo de la respuesta (hash parseado).
+      # @param path [String, Array<String>] Segmentos del path (se unen con +/+).
+      # @return [Hash] Respuesta cruda de la API (suele incluir +data+ para un recurso).
+      def get_one(path)
+        path = Array(path).join("/")
+        connection.get(path)
+      end
+
       def build_paginated_response(raw)
         Response::Paginated.new(
           data: raw["data"] || [],

data/lib/sperant_api/resources/clients.rb

@@ -17,6 +17,18 @@ module SperantApi
         query = { q: q, page: page }.compact
         get_list(Constants::PATH_CLIENTS, query)
       end
+
+      # Obtiene un cliente por ID.
+      #
+      # @param id [Integer, String] ID del cliente.
+      # @return [Hash] Datos del cliente (contenido de +data+ en la respuesta de la API).
+      #
+      # @example
+      #   client_data = client.clients.find(123)
+      def find(id)
+        raw = get_one([Constants::PATH_CLIENTS, id])
+        raw["data"] || raw
+      end
     end
   end
 end

data/lib/sperant_api/resources/projects.rb

@@ -18,6 +18,18 @@ module SperantApi
         query = { code: code, q: q, page: page }.compact
         get_list(Constants::PATH_PROJECTS, query)
       end
+
+      # Obtiene un proyecto por ID.
+      #
+      # @param id [Integer, String] ID del proyecto.
+      # @return [Hash] Datos del proyecto (contenido de +data+ en la respuesta de la API).
+      #
+      # @example
+      #   project_data = client.projects.find(456)
+      def find(id)
+        raw = get_one([Constants::PATH_PROJECTS, id])
+        raw["data"] || raw
+      end
     end
   end
 end

data/lib/sperant_api/resources/units.rb

@@ -20,6 +20,20 @@ module SperantApi
         query = { block_id: block_id, commercial_status_id: commercial_status_id, page: page }.compact
         get_list(path, query)
       end
+
+      # Obtiene una unidad por ID dentro de un proyecto.
+      #
+      # @param project_id [Integer] ID del proyecto.
+      # @param id [Integer, String] ID de la unidad.
+      # @return [Hash] Datos de la unidad (contenido de +data+ en la respuesta de la API).
+      #
+      # @example
+      #   unit_data = client.units.find(project_id: 7, id: 42)
+      def find(project_id:, id:)
+        path = [Constants::PATH_PROJECTS, project_id, Constants::PATH_UNITS, id]
+        raw = get_one(path)
+        raw["data"] || raw
+      end
     end
   end
 end

data/lib/sperant_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SperantApi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sperant-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lee Palacios