alpr-sdk 0.1.1

data/lib/alpr/models.rb

@@ -0,0 +1,622 @@
+# frozen_string_literal: true
+
+# Code generated by sdk/generator. DO NOT EDIT.
+
+module Alpr
+  # Camera is a resource of Alpr.sh's API.
+  class Camera < Model
+    MEMBERS = %i[created_at enabled id location name protocol reading_area].freeze
+
+    # @return [String]
+    attr_reader :created_at
+
+    # @return [Boolean]
+    attr_reader :enabled
+
+    # @return [String]
+    attr_reader :id
+
+    # O endereço da câmera como texto; vazio se não foi informado.
+    # @return [String]
+    attr_reader :location
+
+    # @return [String]
+    attr_reader :name
+
+    # Como a câmera é lida. Nunca traz o endereço do stream, usuário nem senha.
+    # @return [String ("rtsp", "rtmp", "hls", "http", "hikconnect", "hikcloud", "rtmppush")]
+    attr_reader :protocol
+
+    # Nulo quando a câmera lê a imagem inteira.
+    # @return [ReadingArea, nil]
+    attr_reader :reading_area
+
+    def initialize(created_at:, enabled:, id:, location:, name:, protocol:, reading_area:)
+      @created_at = created_at
+      @enabled = enabled
+      @id = id
+      @location = location
+      @name = name
+      @protocol = protocol
+      @reading_area = reading_area
+      freeze
+    end
+
+    # Builds a Camera from the API's JSON.
+    def self.from_hash(data)
+      new(
+        created_at: data.fetch("createdAt"),
+        enabled: data.fetch("enabled"),
+        id: data.fetch("id"),
+        location: data.fetch("location"),
+        name: data.fetch("name"),
+        protocol: data.fetch("protocol"),
+        reading_area: data["readingArea"]&.then { |value| ReadingArea.from_hash(value) }
+      )
+    end
+  end
+
+  # DetectedPlate is a resource of Alpr.sh's API.
+  class DetectedPlate < Model
+    MEMBERS = %i[conf coordinate_bottom coordinate_left coordinate_right coordinate_top created_at plate_type time].freeze
+
+    # Confiança do detector, de 0 a 100, com uma casa.
+    # @return [Float]
+    attr_reader :conf
+
+    # @return [Integer]
+    attr_reader :coordinate_bottom
+
+    # @return [Integer]
+    attr_reader :coordinate_left
+
+    # @return [Integer]
+    attr_reader :coordinate_right
+
+    # @return [Integer]
+    attr_reader :coordinate_top
+
+    # @return [String]
+    attr_reader :created_at
+
+    # @return [String ("car")]
+    attr_reader :plate_type
+
+    # @return [String]
+    attr_reader :time
+
+    def initialize(conf:, coordinate_bottom:, coordinate_left:, coordinate_right:, coordinate_top:, created_at:, plate_type:, time:)
+      @conf = conf
+      @coordinate_bottom = coordinate_bottom
+      @coordinate_left = coordinate_left
+      @coordinate_right = coordinate_right
+      @coordinate_top = coordinate_top
+      @created_at = created_at
+      @plate_type = plate_type
+      @time = time
+      freeze
+    end
+
+    # Builds a DetectedPlate from the API's JSON.
+    def self.from_hash(data)
+      new(
+        conf: Float(data.fetch("conf")),
+        coordinate_bottom: data.fetch("coordinateBottom"),
+        coordinate_left: data.fetch("coordinateLeft"),
+        coordinate_right: data.fetch("coordinateRight"),
+        coordinate_top: data.fetch("coordinateTop"),
+        created_at: data.fetch("createdAt"),
+        plate_type: data.fetch("plateType"),
+        time: data.fetch("time")
+      )
+    end
+  end
+
+  # DetectionImageLink is a resource of Alpr.sh's API.
+  class DetectionImageLink < Model
+    MEMBERS = %i[detection_id expires_in image_url].freeze
+
+    # @return [String]
+    attr_reader :detection_id
+
+    # Segundos de validade do link (300).
+    # @return [Integer]
+    attr_reader :expires_in
+
+    # Endereço absoluto de GET /api/v1/detections/{id}/image/file, assinado; abra-o como veio.
+    # @return [String]
+    attr_reader :image_url
+
+    def initialize(detection_id:, expires_in:, image_url:)
+      @detection_id = detection_id
+      @expires_in = expires_in
+      @image_url = image_url
+      freeze
+    end
+
+    # Builds a DetectionImageLink from the API's JSON.
+    def self.from_hash(data)
+      new(
+        detection_id: data.fetch("detectionId"),
+        expires_in: data.fetch("expiresIn"),
+        image_url: data.fetch("imageUrl")
+      )
+    end
+  end
+
+  # PhotoDetection is a resource of Alpr.sh's API.
+  class PhotoDetection < Model
+    MEMBERS = %i[image_height image_width plates processing_time_ms].freeze
+
+    # @return [Integer]
+    attr_reader :image_height
+
+    # @return [Integer]
+    attr_reader :image_width
+
+    # Onde há placa, sem o texto; o detector não filtra pelo formato brasileiro. Sem placa, [].
+    # @return [Array<DetectedPlate>]
+    attr_reader :plates
+
+    # @return [Integer]
+    attr_reader :processing_time_ms
+
+    def initialize(image_height:, image_width:, plates:, processing_time_ms:)
+      @image_height = image_height
+      @image_width = image_width
+      @plates = plates
+      @processing_time_ms = processing_time_ms
+      freeze
+    end
+
+    # Builds a PhotoDetection from the API's JSON.
+    def self.from_hash(data)
+      new(
+        image_height: data.fetch("imageHeight"),
+        image_width: data.fetch("imageWidth"),
+        plates: data.fetch("plates").map { |item| DetectedPlate.from_hash(item) },
+        processing_time_ms: data.fetch("processingTimeMs")
+      )
+    end
+  end
+
+  # PhotoRecognition is a resource of Alpr.sh's API.
+  class PhotoRecognition < Model
+    MEMBERS = %i[credits_remaining image_height image_width plates processing_time_ms].freeze
+
+    # Créditos que sobraram depois desta leitura.
+    # @return [Integer]
+    attr_reader :credits_remaining
+
+    # @return [Integer]
+    attr_reader :image_height
+
+    # @return [Integer]
+    attr_reader :image_width
+
+    # Só as placas válidas no Brasil (ABC1234 ou ABC1D23); sem placa, [].
+    # @return [Array<RecognizedPlate>]
+    attr_reader :plates
+
+    # @return [Integer]
+    attr_reader :processing_time_ms
+
+    def initialize(credits_remaining:, image_height:, image_width:, plates:, processing_time_ms:)
+      @credits_remaining = credits_remaining
+      @image_height = image_height
+      @image_width = image_width
+      @plates = plates
+      @processing_time_ms = processing_time_ms
+      freeze
+    end
+
+    # Builds a PhotoRecognition from the API's JSON.
+    def self.from_hash(data)
+      new(
+        credits_remaining: data.fetch("creditsRemaining"),
+        image_height: data.fetch("imageHeight"),
+        image_width: data.fetch("imageWidth"),
+        plates: data.fetch("plates").map { |item| RecognizedPlate.from_hash(item) },
+        processing_time_ms: data.fetch("processingTimeMs")
+      )
+    end
+  end
+
+  # PlateReading is a resource of Alpr.sh's API.
+  class PlateReading < Model
+    MEMBERS = %i[confidence credits_remaining detection_id latency_ms plate].freeze
+
+    # Confiança da leitura, de 0 a 1 com quatro casas (nas outras rotas conf vai de 0 a 100).
+    # @return [Float]
+    attr_reader :confidence
+
+    # Créditos que sobraram depois desta leitura.
+    # @return [Integer]
+    attr_reader :credits_remaining
+
+    # Hoje sempre nulo: a leitura de uma placa recortada não é guardada.
+    # @return [String, nil]
+    attr_reader :detection_id
+
+    # @return [Integer]
+    attr_reader :latency_ms
+
+    # O texto lido, sem hífen, maiúsculo; não é validado pelo formato brasileiro.
+    # @return [String]
+    attr_reader :plate
+
+    def initialize(confidence:, credits_remaining:, detection_id:, latency_ms:, plate:)
+      @confidence = confidence
+      @credits_remaining = credits_remaining
+      @detection_id = detection_id
+      @latency_ms = latency_ms
+      @plate = plate
+      freeze
+    end
+
+    # Builds a PlateReading from the API's JSON.
+    def self.from_hash(data)
+      new(
+        confidence: Float(data.fetch("confidence")),
+        credits_remaining: data.fetch("creditsRemaining"),
+        detection_id: data["detectionId"],
+        latency_ms: data.fetch("latencyMs"),
+        plate: data.fetch("plate")
+      )
+    end
+  end
+
+  # ReadingArea is a resource of Alpr.sh's API.
+  class ReadingArea < Model
+    MEMBERS = %i[box points].freeze
+
+    # A caixa envolvente, em frações da imagem (0 a 1); é o que o motor lê.
+    # @return [ReadingAreaBox]
+    attr_reader :box
+
+    # Os cantos do polígono, de 3 a 16 pares [x, y] em frações da imagem; um retângulo traz os quatro cantos. Placas fora dele são ignoradas.
+    # @return [Array<Array<Float>>]
+    attr_reader :points
+
+    def initialize(box:, points:)
+      @box = box
+      @points = points
+      freeze
+    end
+
+    # Builds a ReadingArea from the API's JSON.
+    def self.from_hash(data)
+      new(
+        box: ReadingAreaBox.from_hash(data.fetch("box")),
+        points: data.fetch("points").map { |item| item.map { |item_| Float(item_) } }
+      )
+    end
+  end
+
+  # A caixa envolvente, em frações da imagem (0 a 1); é o que o motor lê.
+  class ReadingAreaBox < Model
+    MEMBERS = %i[height width x y].freeze
+
+    # @return [Float]
+    attr_reader :height
+
+    # @return [Float]
+    attr_reader :width
+
+    # @return [Float]
+    attr_reader :x
+
+    # @return [Float]
+    attr_reader :y
+
+    def initialize(height:, width:, x:, y:)
+      @height = height
+      @width = width
+      @x = x
+      @y = y
+      freeze
+    end
+
+    # Builds a ReadingAreaBox from the API's JSON.
+    def self.from_hash(data)
+      new(
+        height: Float(data.fetch("height")),
+        width: Float(data.fetch("width")),
+        x: Float(data.fetch("x")),
+        y: Float(data.fetch("y"))
+      )
+    end
+  end
+
+  # Recognition is a resource of Alpr.sh's API.
+  class Recognition < Model
+    MEMBERS = %i[camera_id captured_at conf id plate source].freeze
+
+    # Nulo numa leitura feita pela API por foto.
+    # @return [String, nil]
+    attr_reader :camera_id
+
+    # Com o deslocamento do fuso do Alpr.sh.
+    # @return [String]
+    attr_reader :captured_at
+
+    # De 0 a 100, com uma casa.
+    # @return [Float]
+    attr_reader :conf
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :plate
+
+    # camera: lida por uma câmera; api: enviada por foto.
+    # @return [String ("camera", "api")]
+    attr_reader :source
+
+    def initialize(camera_id:, captured_at:, conf:, id:, plate:, source:)
+      @camera_id = camera_id
+      @captured_at = captured_at
+      @conf = conf
+      @id = id
+      @plate = plate
+      @source = source
+      freeze
+    end
+
+    # Builds a Recognition from the API's JSON.
+    def self.from_hash(data)
+      new(
+        camera_id: data["cameraId"],
+        captured_at: data.fetch("capturedAt"),
+        conf: Float(data.fetch("conf")),
+        id: data.fetch("id"),
+        plate: data.fetch("plate"),
+        source: data.fetch("source")
+      )
+    end
+  end
+
+  # RecognizedPlate is a resource of Alpr.sh's API.
+  class RecognizedPlate < Model
+    MEMBERS = %i[char_confs conf coordinate_bottom coordinate_left coordinate_right coordinate_top created_at plate plate_type time].freeze
+
+    # Confiança de cada caractere, de 0 a 1 com duas casas, separadas por ponto e vírgula ("0.99;0.98").
+    # @return [String]
+    attr_reader :char_confs
+
+    # Confiança da placa, de 0 a 100, com uma casa.
+    # @return [Float]
+    attr_reader :conf
+
+    # Pixels da foto enviada.
+    # @return [Integer]
+    attr_reader :coordinate_bottom
+
+    # @return [Integer]
+    attr_reader :coordinate_left
+
+    # @return [Integer]
+    attr_reader :coordinate_right
+
+    # @return [Integer]
+    attr_reader :coordinate_top
+
+    # Igual a time.
+    # @return [String]
+    attr_reader :created_at
+
+    # Sete caracteres, maiúsculos: ABC1234 ou ABC1D23 (Mercosul).
+    # @return [String]
+    attr_reader :plate
+
+    # Sempre car; a API não informa país nem formato.
+    # @return [String ("car")]
+    attr_reader :plate_type
+
+    # Instante da leitura, com o deslocamento do fuso do Alpr.sh.
+    # @return [String]
+    attr_reader :time
+
+    def initialize(char_confs:, conf:, coordinate_bottom:, coordinate_left:, coordinate_right:, coordinate_top:, created_at:, plate:, plate_type:, time:)
+      @char_confs = char_confs
+      @conf = conf
+      @coordinate_bottom = coordinate_bottom
+      @coordinate_left = coordinate_left
+      @coordinate_right = coordinate_right
+      @coordinate_top = coordinate_top
+      @created_at = created_at
+      @plate = plate
+      @plate_type = plate_type
+      @time = time
+      freeze
+    end
+
+    # Builds a RecognizedPlate from the API's JSON.
+    def self.from_hash(data)
+      new(
+        char_confs: data.fetch("charConfs"),
+        conf: Float(data.fetch("conf")),
+        coordinate_bottom: data.fetch("coordinateBottom"),
+        coordinate_left: data.fetch("coordinateLeft"),
+        coordinate_right: data.fetch("coordinateRight"),
+        coordinate_top: data.fetch("coordinateTop"),
+        created_at: data.fetch("createdAt"),
+        plate: data.fetch("plate"),
+        plate_type: data.fetch("plateType"),
+        time: data.fetch("time")
+      )
+    end
+  end
+
+  # WebhookAlertTriggered is a resource of Alpr.sh's API.
+  class WebhookAlertTriggered < Model
+    MEMBERS = %i[camera_id captured_at confidence event id plate recognition_id rule_id rule_name skip tenant_id].freeze
+
+    # Ausente se a leitura não veio de uma câmera.
+    # @return [String, nil]
+    attr_reader :camera_id
+
+    # @return [String]
+    attr_reader :captured_at
+
+    # De 0 a 1.
+    # @return [Float]
+    attr_reader :confidence
+
+    # @return [String ("alert.triggered")]
+    attr_reader :event
+
+    # O id do disparo.
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :plate
+
+    # A leitura que disparou o alerta.
+    # @return [String]
+    attr_reader :recognition_id
+
+    # @return [String]
+    attr_reader :rule_id
+
+    # @return [String]
+    attr_reader :rule_name
+
+    # Os destinos que as listas de permitidos e de bloqueados excluíram deste disparo (internal, channel:<id>, partner:<id>). Presente só quando algum foi excluído; é informação, não há o que fazer com ela.
+    # @return [Array<String>, nil]
+    attr_reader :skip
+
+    # @return [String]
+    attr_reader :tenant_id
+
+    def initialize(camera_id: nil, captured_at:, confidence:, event:, id:, plate:, recognition_id:, rule_id:, rule_name:, skip: nil, tenant_id:)
+      @camera_id = camera_id
+      @captured_at = captured_at
+      @confidence = confidence
+      @event = event
+      @id = id
+      @plate = plate
+      @recognition_id = recognition_id
+      @rule_id = rule_id
+      @rule_name = rule_name
+      @skip = skip
+      @tenant_id = tenant_id
+      freeze
+    end
+
+    # Builds a WebhookAlertTriggered from the API's JSON.
+    def self.from_hash(data)
+      new(
+        camera_id: data["camera_id"],
+        captured_at: data.fetch("captured_at"),
+        confidence: Float(data.fetch("confidence")),
+        event: data.fetch("event"),
+        id: data.fetch("id"),
+        plate: data.fetch("plate"),
+        recognition_id: data.fetch("recognition_id"),
+        rule_id: data.fetch("rule_id"),
+        rule_name: data.fetch("rule_name"),
+        skip: data["skip"],
+        tenant_id: data.fetch("tenant_id")
+      )
+    end
+  end
+
+  # WebhookRecognitionCreated is a resource of Alpr.sh's API.
+  class WebhookRecognitionCreated < Model
+    MEMBERS = %i[camera_id captured_at confidence event id plate source tenant_id].freeze
+
+    # Ausente numa leitura enviada por foto.
+    # @return [String, nil]
+    attr_reader :camera_id
+
+    # UTC, com fração de segundo.
+    # @return [String]
+    attr_reader :captured_at
+
+    # De 0 a 1 (na API de chave, conf vai de 0 a 100).
+    # @return [Float]
+    attr_reader :confidence
+
+    # @return [String ("recognition.created")]
+    attr_reader :event
+
+    # O id da leitura; é o mesmo id de GET /api/v1/recognitions e de GET /api/v1/detections/{id}/image.
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :plate
+
+    # camera: lida por uma câmera; api: enviada por foto.
+    # @return [String ("camera", "api")]
+    attr_reader :source
+
+    # O espaço de trabalho dono da leitura.
+    # @return [String]
+    attr_reader :tenant_id
+
+    def initialize(camera_id: nil, captured_at:, confidence:, event:, id:, plate:, source:, tenant_id:)
+      @camera_id = camera_id
+      @captured_at = captured_at
+      @confidence = confidence
+      @event = event
+      @id = id
+      @plate = plate
+      @source = source
+      @tenant_id = tenant_id
+      freeze
+    end
+
+    # Builds a WebhookRecognitionCreated from the API's JSON.
+    def self.from_hash(data)
+      new(
+        camera_id: data["camera_id"],
+        captured_at: data.fetch("captured_at"),
+        confidence: Float(data.fetch("confidence")),
+        event: data.fetch("event"),
+        id: data.fetch("id"),
+        plate: data.fetch("plate"),
+        source: data.fetch("source"),
+        tenant_id: data.fetch("tenant_id")
+      )
+    end
+  end
+
+  # WebhookTest is a resource of Alpr.sh's API.
+  class WebhookTest < Model
+    MEMBERS = %i[event id sent_at tenant_id].freeze
+
+    # @return [String ("webhook.test")]
+    attr_reader :event
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :sent_at
+
+    # @return [String]
+    attr_reader :tenant_id
+
+    def initialize(event:, id:, sent_at:, tenant_id:)
+      @event = event
+      @id = id
+      @sent_at = sent_at
+      @tenant_id = tenant_id
+      freeze
+    end
+
+    # Builds a WebhookTest from the API's JSON.
+    def self.from_hash(data)
+      new(
+        event: data.fetch("event"),
+        id: data.fetch("id"),
+        sent_at: data.fetch("sent_at"),
+        tenant_id: data.fetch("tenant_id")
+      )
+    end
+  end
+end

data/lib/alpr/multipart.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "securerandom"
+
+module Alpr
+  # A multipart/form-data body, written by hand: one file and the text fields
+  # beside it.
+  class Form
+    # The Content-Type and file name of a photo, told by its first bytes: JPEG
+    # and PNG are what the API reads, and anything else goes as bytes for the
+    # API to refuse.
+    JPEG_MAGIC = "\xFF\xD8\xFF".b.freeze
+    PNG_MAGIC = "\x89PNG\r\n\x1A\n".b.freeze
+
+    def self.image_type(data)
+      head = data.byteslice(0, 8).to_s.b
+      return ["image/jpeg", "photo.jpg"] if head.start_with?(JPEG_MAGIC)
+      return ["image/png", "photo.png"] if head.start_with?(PNG_MAGIC)
+
+      ["application/octet-stream", "photo"]
+    end
+
+    # A number, boolean or string as the text of a field: the shortest decimal
+    # form, 0.5 and 1, not 0.50 or 1.0.
+    def self.text_of(value)
+      return value.to_s unless value.is_a?(Float) && value.finite?
+
+      value == value.floor && value.abs < 1e15 ? value.to_i.to_s : value.to_s.sub(/\.0e/, "e")
+    end
+
+    def initialize
+      @parts = []
+    end
+
+    # Adds a text field.
+    def text(name, value)
+      @parts << [:text, name.to_s, Form.text_of(value).b]
+      self
+    end
+
+    # Adds the photo, named and typed by what its first bytes say it is.
+    def file(name, data)
+      raise ArgumentError, "alpr: #{name} is the bytes of a photo (a String), not #{data.class}" unless data.is_a?(String)
+
+      @parts << [:file, name.to_s, data.b]
+      self
+    end
+
+    # The body, as bytes.
+    def body
+      encode.first
+    end
+
+    # The Content-Type header, boundary included.
+    def content_type
+      "multipart/form-data; boundary=#{encode.last}"
+    end
+
+    private
+
+    # Writes the body once, with a boundary no part contains.
+    def encode
+      @encoded ||= begin
+        boundary = nil
+        loop do
+          boundary = "alpr-#{SecureRandom.hex(16)}".b
+          break unless @parts.any? { |_, _, data| data.include?(boundary) }
+        end
+        out = "".b
+        @parts.each do |kind, name, data|
+          out << "--".b << boundary << "\r\n".b
+          if kind == :file
+            type, filename = Form.image_type(data)
+            out << %(Content-Disposition: form-data; name="#{quote(name)}"; filename="#{filename}"\r\n).b
+            out << "Content-Type: #{type}\r\n".b
+          else
+            out << %(Content-Disposition: form-data; name="#{quote(name)}"\r\n).b
+          end
+          out << "\r\n".b << data << "\r\n".b
+        end
+        out << "--".b << boundary << "--\r\n".b
+        [out, boundary]
+      end
+    end
+
+    def quote(name)
+      name.gsub(/["\r\n]/) { |char| format("%%%02X", char.ord) }
+    end
+  end
+end