Ruby

Un script de Ruby que usa la API con net/http y json de la biblioteca estándar: no hay que instalar gemas. Enumera las variables etiquetadas de una plantilla, mide el dibujo que genera con los valores dados y lo exporta como PDF.

Descárguelo: box.rb.

# box.rb: list a template's inputs, measure it and export it as a PDF with the PiQ SaaS API.
# Ruby 3.0 or later; net/http and json from the standard library.
require "json"
require "net/http"

KEY = ENV["PIQ_API_KEY"]
BASE = (ENV["PIQ_URL"] || "https://saas.parametriq.co.uk").chomp("/")
storage = ENV["PIQ_STORAGE"] # optional: a registered storage's name
abort "Set PIQ_API_KEY to your API key." if KEY.to_s.empty?

TEMPLATE = "L=400,\"Length\"\nW=300,\"Width\"\nP1=[L,0]\nP2=[L,W]\nP3=[0,W]\nPOLYLINE @1,[P0,P1,P2,P3],TRUE,0"
# the template itself, or (optional) where it is kept in your storage
template = storage ? { source: { storage: storage, key: "templates/box.piq" } } : { template: TEMPLATE }
values = { L: 500, W: 250 }

def post(path, body)
  uri = URI(BASE + path)
  response = Net::HTTP.post(uri, JSON.generate(body), "X-API-KEY" => KEY, "Content-Type" => "application/json")
  return response if response.is_a?(Net::HTTPSuccess)

  warn "Error #{response.code} #{response.message}"
  unless response.body.to_s.empty? # a 401 has no body
    problem = JSON.parse(response.body) rescue { "detail" => response.body }
    warn problem["title"] if problem["title"]
    warn problem["detail"] if problem["detail"]
    (problem["errors"] || {}).each { |field, messages| warn "  #{field}: #{messages.join(" ")}" }
  end
  exit 1
end

# 1. The template's labelled variables
JSON.parse(post("/inputs", template).body)["inputs"].each do |i|
  puts "#{i["name"]}: #{i["label"]} (#{i["kind"]}, #{i["value"]})"
end

# 2. The drawing measured, with the values given
m = JSON.parse(post("/measure", template.merge(values: values)).body)
cut = m["layers"].find { |layer| layer["layer"] == "Cut" }&.fetch("length") || 0
puts "Size: #{m["width"]} x #{m["height"]}, cut length: #{cut}"

# 3. The drawing as a PDF
pdf = post("/export/pdf", template.merge(values: values))
File.binwrite("box.pdf", pdf.body)
puts "Saved box.pdf (#{pdf["X-PiQ-Warnings"]} warnings)"

# 4. Optional: the PDF saved to your storage instead of downloaded
if storage
  destination = { storage: storage, key: "drawings/box.pdf" }
  saved = JSON.parse(post("/save/pdf", template.merge(values: values, destination: destination, overwrite: true)).body)
  puts "Saved #{saved["key"]} to #{saved["storage"]} (#{saved["size"]} bytes)"
end

Cómo funciona

1. Configuración. La clave se toma de PIQ_API_KEY, la dirección de PIQ_URL (el propio servicio si no está definida) y, opcionalmente, el nombre de un almacenamiento de PIQ_STORAGE. Sin clave, el script se detiene de inmediato.
2. La plantilla. template es el cuerpo del que parte cada solicitud: el texto de la plantilla como template o, cuando PIQ_STORAGE está definida, dónde está guardada en su almacenamiento como source. values da L y W por nombre. Cada solicitud le añade lo suyo con merge.
3. post envía un cuerpo a una operación como JSON, con la clave en el encabezado X-API-KEY (Net::HTTP.post usa HTTPS para una dirección https). Una respuesta correcta se devuelve para leerla.
4. Errores. De cualquier otra respuesta se imprime el estado y después la descripción del problema: su title, su detail y cada entrada de errors, el campo y qué está mal en él. Un 401 no tiene cuerpo, así que no hay nada más que imprimir; un cuerpo que no es JSON se imprime tal cual. Después, el script termina con 1.
5. Inputs. POST /inputs solo necesita la plantilla. Cada uno de sus inputs tiene un name, label, kind y value.
6. Measure. POST /measure con los valores da el width y el height del dibujo, y las longitudes de sus líneas por capa en layers; la longitud de corte es la longitud en la capa Cut.
7. Export. POST /export/pdf responde con el propio PDF, no con JSON: su cuerpo se escribe en box.pdf con File.binwrite. El encabezado X-PiQ-Warnings indica cuántas cosas no pudieron exportarse tal cual.
8. Save (opcional). Con un almacenamiento, POST /save/pdf exporta el mismo dibujo y lo guarda en su almacenamiento en destination; overwrite: true reemplaza un archivo que ya exista. Responde con dónde lo ha guardado y su tamaño.

Cómo ejecutarlo

Guarde el script como box.rb y, a continuación:

export PIQ_API_KEY=XXXX-XXXX-XXXX-XXXXX
ruby box.rb

Imprime las variables etiquetadas de la plantilla, el tamaño del dibujo y su longitud de corte, y guarda box.pdf:

L: Length (Number, 400)
W: Width (Number, 300)
D: Depth (Number, 300)
Size: 500 x 250, cut length: 1500
Saved box.pdf (0 warnings)

Con un valor que la plantilla no puede usar (por ejemplo, "L": "long"), imprime el problema y se detiene:

Error 400 Bad Request
One or more validation errors occurred.
Some of the values given can't be used.
  L: L is a number.

Con una clave incorrecta, solo imprime Error 401 Unauthorized: un 401 no tiene descripción del problema.

Para probar la parte del almacenamiento, registre un almacenamiento (consulte Registrar un almacenamiento), coloque en él una plantilla como templates/box.piq y establezca PIQ_STORAGE con el nombre del almacenamiento. La plantilla se lee entonces desde su almacenamiento, y el PDF también se guarda en él como drawings/box.pdf, reemplazando cualquier archivo que ya exista.

Consulte también: API, Inputs, Measure, Exportar un dibujo, Guardar en su almacenamiento, Registrar un almacenamiento, Clientes.