aztec-decoder 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc04a0abaada2107d02381a7a2a52e0bd9f8a743caa66a9f3b46975ddc32d67f
+  data.tar.gz: 7d0b603424bdc0e0fb226a90a968f398f145e25b042fa71ea02b77e14d17bc60
+SHA512:
+  metadata.gz: 342a90772ea5c9c7d1ff781492561097cfc02bef52df06e2288d9f2e20262accd509c19bd5d5999d5199d10bb906078d1b1dfbc09acbb2adc45e9b1a6dad45c7
+  data.tar.gz: 0f7b94f5d35d388d39935b090cced92434b90ee888fc265269d66c0294a4eef35424130da132665e9a543cb1a5f1238dadeb28a3a957caefd3d7bdc49437e76a

data/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 Bartosz Wójcik
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,113 @@
+# Dekoder Kodu AZTEC 2D z Dowodu Rejestracyjnego dla Ruby
+
+Oferujemy Państwu usługę Web API pozwalającą zdekodować dane z kodu AZTEC 2D zapisanego w dowodach rejestracyjnych pojazdów samochodowych.
+
+![Kod AZTEC 2D zapisany w formie obrazkowej w dowodzie rejestracyjnym pojazdu](https://www.pelock.com/img/pl/produkty/dekoder-aztec/dowod-rejestracyjny-kod-aztec-2d.jpg)
+
+Nasza biblioteka dekoduje dane z dowodu rejestracyjnego, zapisane w postaci kodu obrazkowego tzw. kod aztec. Dekodowane są wszystkie wymienione pola w dowodzie rejestracyjnym pojazdu.
+
+https://www.pelock.com/pl/produkty/dekoder-aztec
+
+## Gdzie znajdzie zastosowanie Dekoder AZTec?
+
+Dekoder AZTec może przydać się firmom i instytucjom, które pragną zautomatyzować proces ręcznego wprowadzania danych z dowodów rejestracyjnych i zastąpić go poprzez wykorzystanie naszej biblioteki programistycznej, która potrafi rozpoznać i rozkodowac kody AZTEC 2D bezpośrednio ze zdjęć dowodów rejestracyjnych lub zeskanowanych już kodów (wykorzystując skaner QR / AZTEC 2D).
+
+## Dostępne edycje programistyczne
+
+Dekoder AZTec dostepny jest w trzech edycjach. Każda wersja posiada inne cechy i inne możliwości dekodowania. Wersja oparta o Web API jako jedyna posiada możliwość rozpoznawania i dekodowania danych bezpośrednio ze zdjęć i obrazków. Pozostałe wersje do dekodowania wymagają już odczytanego kodu w postaci tekstu (np. ze skanera).
+
+![Dekodowanie kodu AZTEC 2D do formatu JSON](https://www.pelock.com/img/pl/produkty/dekoder-aztec/dekodowanie-kodu-aztec-2d-do-json.png)
+
+### Wersja Web API
+
+Jest to najbardziej zaawansowana edycja Dekodera AZTec, ponieważ umożliwia precyzyjne rozpoznawanie i dekodowanie kodów AZTEC 2D bezpośrednio ze zdjęć oraz obrazków zapisanych w formatach PNG lub JPG.
+
+Algorytm rozpoznawania obrazu należy do naszej firmy, jest to innowacyjne rozwiązanie rozwijane od podstaw przez prawie rok czasu.
+
+Rozumiemy potrzeby naszych klientów oraz problemy wynikające z rozpoznawnia rzeczywistych zdjęć kodów AZTEC 2D znajdujących się w dowodach rejestracyjnych, które nie zawsze są idealnie wykonane, czy to ze względu na rodzaj aparatu, kąta wykonania zdjęcia, refleksów czy słabej rozdzielczości.
+
+Przy tworzeniu naszego rozwiązania wzieliśmy wszystkie te czynniki pod uwagę i w efekcie nasz algorytm radzi sobie znakomicie z rozpoznawaniem kodów AZTEC 2D ze zdjęć z wszelkiego rodzaju zniekształceniami, uszkodzeniami i niedoskonałościami. Znacznie przewyższa pod względem funkcjonowania dostępne na rynku biblioteki rozpoznawnia kodów AZTEC 2D takie jak np. ZXing.
+
+### Gotowe paczki dla różnych języków programowania
+
+Dla ułatwienia szybkiego wdrożenia, paczki instalacyjne Dekodera AZTec zostały wgrane na repozytoria dla kilku popularnych języków programowania, a dodatkowo ich kody źródłowe zostały opublikowane na GitHubie:
+
+| Repozytorium | Język | Instalacja | Paczka | GitHub |
+| ------------ | ----- | ---------- | ------ | ------ |
+| ![Centralne Repozytorium Maven](https://www.pelock.com/img/logos/repo-maven.png) | Java | Dodaj wpis do pliku `pom.xml`<br />`<dependency>`<br />`  <groupId>com.pelock</groupId>`<br />`  <artifactId>AZTecDecoder</artifactId>`<br />`  <version>1.0.0</version>`<br />`</dependency>` | [Maven](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.pelock%22) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-Java)
+| ![Repozytorium NPM](https://www.pelock.com//img/logos/repo-npm.png) | JavaScript, TypeScript | `npm install aztec-decoder` | [NPM](https://www.npmjs.com/package/aztec-decoder) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-JavaScript)
+| ![Repozytorium NuGet](https://www.pelock.com/img/logos/repo-nuget.png) | C#, VB.NET, .NET | `PM> Install-Package AZTecDecoder` | [NuGet](https://www.nuget.org/packages/AZTecDecoder/) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-CSharp)
+| ![Repozytorium Packagist dla Composer](https://www.pelock.com/img/logos/repo-packagist-composer.png) | PHP | Dodaj do sekcji `require` w twoim pliku `composer.json` linijkę `"pelock/aztec-decoder": "*"` | [Packagist](https://packagist.org/packages/pelock/aztec-decoder) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-PHP)
+| ![Repozytorium PyPI dla Python](https://www.pelock.com/img/logos/repo-pypi.png) | Python | `pip install aztecdecoder` | [PyPi](https://pypi.org/project/aztecdecoder/) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-Python)
+
+#### Instalacja
+
+The preferred way to install the Web API SDK is via RubyGems.
+
+```bash
+gem install aztec-decoder
+```
+
+```ruby
+require "aztec-decoder"
+```
+
+The gem is published at https://rubygems.org/gems/aztec-decoder
+
+## Usage examples
+
+### Example — `decode_image.rb`
+
+```ruby
+# frozen_string_literal: true
+
+###############################################################################
+#
+# AZTecDecoder — decode-image
+#
+# Version        : v2.0.0
+# Language       : Ruby
+# Author         : Bartosz Wójcik
+# Web page       : https://www.pelock.com
+#
+###############################################################################
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "aztec-decoder"
+require "json"
+
+client = AZTecDecoder.new("YOUR-WEB-API-KEY")
+result = client.decode_image_from_file("registration.jpg")
+puts JSON.pretty_generate(result) if result
+```
+
+### Example — `decode_text.rb`
+
+```ruby
+# frozen_string_literal: true
+
+###############################################################################
+#
+# AZTecDecoder — decode-text
+#
+# Version        : v2.0.0
+# Language       : Ruby
+# Author         : Bartosz Wójcik
+# Web page       : https://www.pelock.com
+#
+###############################################################################
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "aztec-decoder"
+require "json"
+
+client = AZTecDecoder.new("YOUR-WEB-API-KEY")
+aztec_ascii = "PASTE-AZTEC-ASCII-HERE"
+result = client.decode_text(aztec_ascii)
+puts JSON.pretty_generate(result) if result
+```
+
+See the `examples/` directory in this repository for complete samples.
+
+Bartosz Wójcik
+https://www.pelock.com | https://www.dekoderaztec.pl

data/lib/aztec-decoder/client.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class AZTecDecoder
+  API_URL = "https://www.pelock.com/api/aztec-decoder/v1"
+  USER_AGENT = "PELock AZTecDecoder"
+
+  def initialize(api_key = nil)
+    @api_key = api_key.to_s
+  end
+
+  def decode_text(text)
+    post_request("command" => "decode-text", "text" => text)
+  end
+
+  def decode_text_from_file(text_file_path)
+    data = File.read(text_file_path, encoding: "UTF-8")
+    decode_text(data)
+  rescue StandardError
+    nil
+  end
+
+  def decode_image_from_file(image_file_path)
+    post_request("command" => "decode-image", image_path: image_file_path)
+  end
+
+  private
+
+  def post_request(params)
+    # Empty activation key is allowed (demo), unlike the older PHP SDK.
+    fields = {
+      "key" => @api_key,
+      "command" => params["command"]
+    }
+    files = {}
+
+    if params[:image_path]
+      path = params[:image_path]
+      return nil unless File.file?(path)
+
+      files["image"] = { path: path, filename: File.basename(path) }
+    else
+      fields["text"] = params["text"]
+    end
+
+    body = Http.post_multipart(API_URL, fields, user_agent: USER_AGENT, files: files)
+    return nil if body.nil? || body.empty?
+
+    Http.parse_json(body)
+  end
+end

data/lib/aztec-decoder/http.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "openssl"
+require "securerandom"
+require "uri"
+
+class AZTecDecoder
+  # Stdlib HTTP helper. Multipart for API form posts / file uploads; urlencoded when needed.
+  module Http
+    class << self
+      def post_multipart(url, fields, user_agent:, files: {})
+        boundary = "----PELock#{SecureRandom.hex(16)}"
+        body = build_multipart(fields, files, boundary)
+        request(url, body, user_agent, "multipart/form-data; boundary=#{boundary}")
+      end
+
+      def post_urlencoded(url, fields, user_agent:)
+        pairs = []
+        fields.each do |key, value|
+          next if value.nil?
+
+          pairs << [key.to_s, normalize_form_value(value)]
+        end
+        request(url, URI.encode_www_form(pairs), user_agent, "application/x-www-form-urlencoded")
+      end
+
+      def parse_json(body)
+        return nil if body.nil? || body.to_s.empty?
+
+        JSON.parse(body)
+      rescue JSON::ParserError
+        nil
+      end
+
+      def request(url, body, user_agent, content_type)
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        http.open_timeout = 30
+        http.read_timeout = 180
+        req = Net::HTTP::Post.new(uri.request_uri)
+        req["User-Agent"] = user_agent
+        req["Content-Type"] = content_type
+        req.body = body
+        http.request(req).body
+      rescue StandardError
+        nil
+      end
+
+      def build_multipart(fields, files, boundary)
+        body = String.new(encoding: Encoding::ASCII_8BIT)
+        fields.each do |name, value|
+          next if value.nil?
+
+          body << "--#{boundary}\r\n"
+          body << "Content-Disposition: form-data; name=\"#{name}\"\r\n\r\n"
+          body << value.to_s.dup.force_encoding(Encoding::UTF_8).b
+          body << "\r\n"
+        end
+        files.each do |name, file|
+          filename = file[:filename] || File.basename(file[:path].to_s)
+          content = file[:content] || File.binread(file[:path])
+          content_type = file[:content_type] || "application/octet-stream"
+          body << "--#{boundary}\r\n"
+          body << "Content-Disposition: form-data; name=\"#{name}\"; filename=\"#{filename}\"\r\n"
+          body << "Content-Type: #{content_type}\r\n\r\n"
+          body << content.b
+          body << "\r\n"
+        end
+        body << "--#{boundary}--\r\n"
+        body
+      end
+
+      def normalize_form_value(value)
+        case value
+        when true then "1"
+        when false then "0"
+        else value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/aztec-decoder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class AZTecDecoder
+  VERSION = "2.0.0"
+end

data/lib/aztec-decoder.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "aztec-decoder/version"
+require_relative "aztec-decoder/http"
+require_relative "aztec-decoder/client"

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: aztec-decoder
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Bartosz Wójcik
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- support@pelock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/aztec-decoder.rb
+- lib/aztec-decoder/client.rb
+- lib/aztec-decoder/http.rb
+- lib/aztec-decoder/version.rb
+homepage: https://www.pelock.com/pl/produkty/dekoder-aztec
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://www.pelock.com/pl/produkty/dekoder-aztec
+  source_code_uri: https://github.com/PELock/Dekoder-AZTEC-2D-Ruby
+  bug_tracker_uri: https://www.pelock.com
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: AZTEC 2D decoder Web API Ruby SDK (Polish vehicle registration certificates)
+test_files: []