qrdot 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0982551dc56a50a959a76a8d326ad0c41e2fffb11e3f8126dced5f4b946058a7'
+  data.tar.gz: 91403796803dcb2102418b6e391372dc500dea7b45e142374d53c3df9381d1ef
+SHA512:
+  metadata.gz: 8f3417cab48970b32af8a7ca837a5b316c6f28eead703de0a70aa58fcbd530438b645393c7ff8a0c59ec77f6c4bf9c8e41a4ead287b07019c130cb06063a6fdb
+  data.tar.gz: 1d61e77849757de5ec29e7d674894c275f287ff3b99b01360667d805d9437d905be4ab2e216f02ec3e53e75f4ce054d6305087d781e6ac7534d07003813a4289

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 QR. / intuitix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# qrdot (Ruby)
+
+Official Ruby client for the [QR.](https://qrdot.dev) API.
+
+```bash
+gem install qrdot
+# or: bundle add qrdot
+```
+
+## Quick start
+
+```ruby
+require "qrdot"
+
+client = Qrdot::Client.new(ENV.fetch("QRDOT_API_KEY"))
+
+qr = client.qr.create({
+  "targetUrl" => "https://example.com",
+  "name" => "Launch",
+  "style" => { "dark_color" => "#0F766E", "light_color" => "#FFFFFF" },
+})
+
+png, mime = client.qr.image(qr["id"], "png")
+zip, = client.qr.export_images([qr["id"]], "png")
+
+ok = Qrdot.verify_webhook_signature(secret, raw_body, request.get_header("HTTP_X_QRDOT_SIGNATURE"))
+```
+
+## Docs
+
+- Guides: https://qrdot.dev/docs/
+- OpenAPI: https://api.qrdot.dev/v1/openapi.json

data/lib/qrdot/client.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+
+module Qrdot
+  class Client
+    attr_reader :qr, :assets, :analytics, :webhooks, :domains
+
+    def initialize(api_key, base_url: "https://api.qrdot.dev")
+      unless api_key.start_with?("sk_test_", "sk_live_")
+        raise ArgumentError, "api_key must start with sk_test_ or sk_live_"
+      end
+
+      @api_key = api_key
+      @base_url = base_url.sub(%r{/\z}, "")
+      @qr = QrResource.new(self)
+      @assets = AssetsResource.new(self)
+      @analytics = AnalyticsResource.new(self)
+      @webhooks = WebhooksResource.new(self)
+      @domains = DomainsResource.new(self)
+    end
+
+    # Convenience — same as qr.create
+    def create_qr(payload, idempotency_key: nil)
+      qr.create(payload, idempotency_key: idempotency_key)
+    end
+
+    def request(method, path, body: nil, headers: {})
+      data, status, = raw(method, path, body: body, headers: headers)
+      return nil if status == 204 || data.nil? || data.empty?
+
+      JSON.parse(data)
+    end
+
+    def request_bytes(method, path, body: nil)
+      data, _status, ct = raw(method, path, body: body, headers: {})
+      mime = (ct || "application/octet-stream").split(";").first.strip
+      [data, mime]
+    end
+
+    def put_external(url, body, headers)
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      req = Net::HTTP::Put.new(uri)
+      headers.each { |k, v| req[k] = v }
+      req.body = body
+      res = http.request(req)
+      res.code.to_i
+    end
+
+    def raw(method, path, body:, headers:)
+      uri = URI("#{@base_url}#{path}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = 30
+      http.read_timeout = 60
+
+      req = Net::HTTPGenericRequest.new(
+        method,
+        !body.nil?,
+        true,
+        uri.request_uri
+      )
+      req["Authorization"] = "Bearer #{@api_key}"
+      req["Accept"] = "application/json"
+      headers.each { |k, v| req[k] = v }
+      if body
+        req["Content-Type"] = "application/json"
+        req.body = JSON.generate(body)
+      end
+
+      res = http.request(req)
+      status = res.code.to_i
+      if status < 200 || status >= 300
+        code = "internal"
+        message = res.message
+        begin
+          parsed = JSON.parse(res.body.to_s)
+          code = parsed.dig("error", "code") || code
+          message = parsed.dig("error", "message") || message
+        rescue JSON::ParserError
+          # ignore
+        end
+        raise ApiError.new(code, message, status)
+      end
+      [res.body.to_s, status, res["content-type"]]
+    end
+  end
+
+  class QrResource
+    def initialize(client)
+      @c = client
+    end
+
+    def create(payload, idempotency_key: nil)
+      headers = {}
+      headers["Idempotency-Key"] = idempotency_key if idempotency_key
+      @c.request("POST", "/v1/qr", body: payload, headers: headers)
+    end
+
+    def list(query = {})
+      qs = query.empty? ? "" : "?#{URI.encode_www_form(query)}"
+      @c.request("GET", "/v1/qr#{qs}")
+    end
+
+    def batch(items, idempotency_key: nil)
+      headers = {}
+      headers["Idempotency-Key"] = idempotency_key if idempotency_key
+      @c.request("POST", "/v1/qr/batch", body: { items: items }, headers: headers)
+    end
+
+    def get(id)
+      @c.request("GET", "/v1/qr/#{URI.encode_www_form_component(id)}")
+    end
+
+    def update(id, payload)
+      @c.request("PATCH", "/v1/qr/#{URI.encode_www_form_component(id)}", body: payload)
+    end
+
+    def delete(id)
+      @c.request("DELETE", "/v1/qr/#{URI.encode_www_form_component(id)}")
+    end
+
+    def duplicate(id)
+      @c.request("POST", "/v1/qr/#{URI.encode_www_form_component(id)}/duplicate")
+    end
+
+    def image(id, format = "png")
+      @c.request_bytes("GET", "/v1/qr/#{URI.encode_www_form_component(id)}/image.#{format}")
+    end
+
+    def export_images(ids, format = "png")
+      @c.request_bytes("POST", "/v1/qr/export/images", body: { ids: ids, format: format })
+    end
+  end
+
+  class AssetsResource
+    def initialize(client)
+      @c = client
+    end
+
+    def presign_logo(content_type, filename: nil)
+      body = { content_type: content_type }
+      body[:filename] = filename if filename
+      @c.request("POST", "/v1/assets/logo/presign", body: body)
+    end
+
+    def complete_logo(id, filename: nil)
+      complete = {}
+      complete[:filename] = filename if filename
+      @c.request(
+        "POST",
+        "/v1/assets/logo/#{URI.encode_www_form_component(id)}/complete",
+        body: complete
+      )
+    end
+
+    def list_logos
+      @c.request("GET", "/v1/assets/logo")
+    end
+
+    def get_logo(id)
+      @c.request("GET", "/v1/assets/logo/#{URI.encode_www_form_component(id)}")
+    end
+
+    def delete_logo(id)
+      @c.request("DELETE", "/v1/assets/logo/#{URI.encode_www_form_component(id)}")
+    end
+
+    def upload_logo(bytes, content_type, filename: nil)
+      presign = presign_logo(content_type, filename: filename)
+      status = @c.put_external(presign["upload_url"], bytes, presign["headers"] || {})
+      if status < 200 || status >= 300
+        raise ApiError.new("internal", "Logo storage upload failed (#{status})", status)
+      end
+      complete_logo(presign["asset_id"], filename: filename)
+    end
+  end
+
+  class AnalyticsResource
+    def initialize(client)
+      @c = client
+    end
+
+    def summary(query = {})
+      qs = query.empty? ? "" : "?#{URI.encode_www_form(query)}"
+      @c.request("GET", "/v1/analytics/summary#{qs}")
+    end
+
+    def qr(id, query = {})
+      qs = query.empty? ? "" : "?#{URI.encode_www_form(query)}"
+      @c.request("GET", "/v1/analytics/qr/#{URI.encode_www_form_component(id)}#{qs}")
+    end
+
+    def scans(id, query = {})
+      qs = query.empty? ? "" : "?#{URI.encode_www_form(query)}"
+      @c.request("GET", "/v1/analytics/qr/#{URI.encode_www_form_component(id)}/scans#{qs}")
+    end
+  end
+
+  class WebhooksResource
+    def initialize(client)
+      @c = client
+    end
+
+    def create(payload)
+      payload = payload.dup
+      payload[:events] ||= payload["events"] || ["qr.scanned"]
+      @c.request("POST", "/v1/webhooks", body: payload)
+    end
+
+    def list
+      @c.request("GET", "/v1/webhooks")
+    end
+
+    def update(id, patch)
+      @c.request("PATCH", "/v1/webhooks/#{URI.encode_www_form_component(id)}", body: patch)
+    end
+
+    def delete(id)
+      @c.request("DELETE", "/v1/webhooks/#{URI.encode_www_form_component(id)}")
+    end
+
+    def test(id, payload = {})
+      @c.request("POST", "/v1/webhooks/#{URI.encode_www_form_component(id)}/test", body: payload)
+    end
+
+    def list_deliveries(id, limit: nil)
+      qs = limit.nil? ? "" : "?limit=#{URI.encode_www_form_component(limit.to_s)}"
+      @c.request("GET", "/v1/webhooks/#{URI.encode_www_form_component(id)}/deliveries#{qs}")
+    end
+
+    def replay(id, payload)
+      @c.request("POST", "/v1/webhooks/#{URI.encode_www_form_component(id)}/replay", body: payload)
+    end
+
+    def verify_signature(secret, raw_body, header, tolerance_sec: 300)
+      Qrdot.verify_webhook_signature(secret, raw_body, header, tolerance_sec: tolerance_sec)
+    end
+  end
+
+  class DomainsResource
+    def initialize(client)
+      @c = client
+    end
+
+    def create(payload)
+      @c.request("POST", "/v1/domains", body: payload)
+    end
+
+    def list
+      @c.request("GET", "/v1/domains")
+    end
+
+    def get(id)
+      @c.request("GET", "/v1/domains/#{URI.encode_www_form_component(id)}")
+    end
+
+    def dns(id)
+      @c.request("GET", "/v1/domains/#{URI.encode_www_form_component(id)}/dns")
+    end
+
+    def dns_provider(id)
+      @c.request("GET", "/v1/domains/#{URI.encode_www_form_component(id)}/dns-provider")
+    end
+
+    def domain_connect_start(id)
+      @c.request("POST", "/v1/domains/#{URI.encode_www_form_component(id)}/domain-connect/start")
+    end
+
+    def forward_dns(id, payload)
+      @c.request("POST", "/v1/domains/#{URI.encode_www_form_component(id)}/dns/forward", body: payload)
+    end
+
+    def refresh(id)
+      @c.request("POST", "/v1/domains/#{URI.encode_www_form_component(id)}/refresh")
+    end
+
+    def set_default(id)
+      @c.request("POST", "/v1/domains/#{URI.encode_www_form_component(id)}/default")
+    end
+
+    def delete(id)
+      @c.request("DELETE", "/v1/domains/#{URI.encode_www_form_component(id)}")
+    end
+  end
+end

data/lib/qrdot/version.rb

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

data/lib/qrdot.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "openssl"
+require "uri"
+require_relative "qrdot/version"
+require_relative "qrdot/client"
+
+module Qrdot
+  class Error < StandardError; end
+
+  class ApiError < Error
+    attr_reader :code, :status
+
+    def initialize(code, message, status)
+      super(message)
+      @code = code
+      @status = status
+    end
+  end
+
+  # Verify X-Qrdot-Signature: t=…,v1=… over "#{t}.#{raw_body}"
+  def self.verify_webhook_signature(secret, raw_body, header, tolerance_sec: 300)
+    parts = {}
+    header.to_s.split(",").each do |piece|
+      k, v = piece.strip.split("=", 2)
+      parts[k] = v if k && v
+    end
+    t = Integer(parts["t"], exception: false)
+    v1 = parts["v1"]
+    return false if t.nil? || t.zero? || v1.nil? || v1.empty?
+    return false if (Time.now.to_i - t).abs > tolerance_sec
+
+    expected = OpenSSL::HMAC.hexdigest("SHA256", secret, "#{t}.#{raw_body}")
+    return false if expected.bytesize != v1.bytesize
+
+    res = 0
+    expected.bytes.zip(v1.bytes) { |a, b| res |= a ^ b }
+    res.zero?
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: qrdot
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- QR.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Thin REST client for qrdot.dev — create dynamic QR codes, images, logos,
+  webhooks, domains.
+email:
+- hello@qrdot.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/qrdot.rb
+- lib/qrdot/client.rb
+- lib/qrdot/version.rb
+homepage: https://qrdot.dev/libraries/
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/intuitix/qrdot-clients/tree/main/ruby
+  changelog_uri: https://github.com/intuitix/qrdot-clients/releases
+  bug_tracker_uri: https://github.com/intuitix/qrdot-clients/issues
+  documentation_uri: https://qrdot.dev/docs/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Official Ruby client for the QR. API
+test_files: []