trmnl-api 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8a754ac699d2142cb950f2bc7739616181a33f085c99b244856f9115f823b6e
-  data.tar.gz: 8a221272e414bed3c1c25a8517c91bbce9286655c51057d9487077abdad22d6c
+  metadata.gz: 278f09b420c7a49d0f325e0a1128c5fd5d9a133958a9131c00e18a0c80aca017
+  data.tar.gz: 6730afa2771d004abb699dff8877f27c60e4b0f79e0faf962c43569aa9a7338c
 SHA512:
-  metadata.gz: fadb0d344109f6a8ae6b84f411ee7f7363c708daa823a68c5adcd875871dc41928526505241587fa3218a48ece69acc2142d787245c2ce41a28e0cb30e3d28b5
-  data.tar.gz: 3ae4afaab60d62d8a1d8e6d776175031915cea50f237af2a025686c769a02651bc9137e2e3ffd4aa95bc24c925bc2f18b6a04161e33c1b8a683c1b7adb2467c4
+  metadata.gz: 12a21186fb3b4601fb4fd4d0032df1cc54b4f84682a95c84f4d704e62abfada39306f1ff2b723d17c04fc2fc6bda2917dde7ad9a511676cfa3619e118a011dcd
+  data.tar.gz: 578927511c6a842a0fc2941e2e658acf27b6a7926cef1974b29a3b1c6f062e39d18da5e793cdad886658566e410a0b3bb51379c538bc6a890b350d2cc2e359ee

data/README.adoc

@@ -130,7 +130,7 @@ Allows you to obtain the current stable firmware version. Example:
 [source,ruby]
 ----
 client = TRMNL::API::Client.new
-client.call
+client.firmware
 
 # Success(#<data TRMNL::API::Models::Firmware url="https://trmnl-fw.s3.us-east-2.amazonaws.com/FW1.4.8.bin", version="1.4.8">)
 ----
@@ -142,7 +142,7 @@ Allows you to create a log entry (which is what the device reports when it captu
 [source,ruby]
 ----
 client = TRMNL::API::Client.new
-client.call token: "secret",
+client.log token: "secret",
             log: {
               logs_array: [
                 {
@@ -174,6 +174,36 @@ client.call token: "secret",
 
 You'll either get a 204 No Content or 200 OK response depending on if the device exists or not.
 
+==== Models
+
+Allows you to obtain the model information for all devices and screens. Example:
+
+[source,ruby]
+----
+client = TRMNL::API::Client.new
+client.models
+
+# Success(
+#   #<data TRMNL::API::Models::Model
+#     name="test",
+#     label="Test",
+#     description="A test.",
+#     colors=2,
+#     bit_depth=1,
+#     scale_factor=1,
+#     rotation=90,
+#     mime_type="image/png",
+#     width=800,
+#     height=480,
+#     offset_x=10,
+#     offset_y=15,
+#     published_at="2025-07-16T18:18:11+00:00"
+#   >
+# )
+----
+
+ℹ️ The `scale_factor` can be an integer or float.
+
 ==== Setup
 
 Allows you to obtain the setup response for when a new device is setup. You must supply your device's MAC Address as the `id`. Example:
@@ -181,7 +211,7 @@ Allows you to obtain the setup response for when a new device is setup. You must
 [source,ruby]
 ----
 client = TRMNL::API::Client.new
-client.call id: "A1:B2:C3:D4:E5:F6"
+client.setup id: "A1:B2:C3:D4:E5:F6"
 
 # Success(
 #   #<data TRMNL::API::Models::Setup

data/lib/trmnl/api/client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "inspectable"
+
 module TRMNL
   module API
     # Provides the primary client for making API requests.
@@ -11,9 +13,19 @@ module TRMNL
         endpoint_display: :display,
         endpoint_firmware: :firmware,
         endpoint_log: :log,
+        endpoint_models: :models,
         endpoint_setup: :setup
       ]
 
+      include Inspectable[
+        endpoint_current_screen: :class,
+        endpoint_display: :class,
+        endpoint_firmware: :class,
+        endpoint_log: :class,
+        endpoint_models: :class,
+        endpoint_setup: :class
+      ]
+
       def initialize(**)
         super
         yield settings if block_given?
@@ -27,6 +39,8 @@ module TRMNL
 
       def log(**) = endpoint_log.call(**)
 
+      def models(**) = endpoint_models.call(**)
+
       def setup(**) = endpoint_setup.call(**)
     end
   end

data/lib/trmnl/api/container.rb

@@ -23,6 +23,7 @@ module TRMNL
         register :current_screen, Contracts::CurrentScreen
         register :display, Contracts::Display
         register :firmware, Contracts::Firmware
+        register :model, Contracts::Model
         register :setup, Contracts::Setup
       end
 
@@ -30,6 +31,7 @@ module TRMNL
         register :current_screen, Models::CurrentScreen
         register :display, Models::Display
         register :firmware, Models::Firmware
+        register :model, Models::Model
         register :setup, Models::Setup
       end
     end

data/lib/trmnl/api/contracts/model.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+module TRMNL
+  module API
+    module Contracts
+      # Validates API response.
+      Model = Dry::Schema.JSON do
+        required(:data).array(:hash) do
+          required(:name).filled :string
+          required(:label).filled :string
+          required(:description).filled :string
+          required(:colors).filled :integer
+          required(:bit_depth).filled :integer
+          required(:scale_factor) { filled? > int? | float? }
+          required(:rotation).filled :integer
+          required(:mime_type).filled :string
+          required(:width).filled :integer
+          required(:height).filled :integer
+          required(:offset_x).filled :integer
+          required(:offset_y).filled :integer
+          required(:published_at).filled :time
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/api/endpoints/container.rb

@@ -13,6 +13,7 @@ module TRMNL
         register(:display) { Display.new }
         register(:firmware) { Firmware.new }
         register(:log) { Log.new }
+        register(:models) { Model.new }
         register(:setup) { Setup.new }
       end
     end

data/lib/trmnl/api/endpoints/current_screen.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "inspectable"
 require "pipeable"
 
 module TRMNL
@@ -13,6 +14,7 @@ module TRMNL
           model: "models.current_screen"
         ]
 
+        include Inspectable[contract: :class]
         include Pipeable
 
         def call token:

data/lib/trmnl/api/endpoints/display.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "inspectable"
 require "pipeable"
 
 module TRMNL
@@ -13,6 +14,7 @@ module TRMNL
           model: "models.display"
         ]
 
+        include Inspectable[contract: :class]
         include Pipeable
 
         def call token:

data/lib/trmnl/api/endpoints/firmware.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "inspectable"
 require "pipeable"
 
 module TRMNL
@@ -13,6 +14,7 @@ module TRMNL
           model: "models.firmware"
         ]
 
+        include Inspectable[contract: :class]
         include Pipeable
 
         def call

data/lib/trmnl/api/endpoints/model.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "inspectable"
+require "pipeable"
+
+module TRMNL
+  module API
+    module Endpoints
+      # Handles API request/response.
+      class Model
+        include TRMNL::API::Dependencies[
+          :requester,
+          contract: "contracts.model",
+          model: "models.model"
+        ]
+
+        include Inspectable[contract: :class]
+        include Pipeable
+
+        def call
+          pipe(
+            requester.get("models"),
+            try(:parse, catch: JSON::ParserError),
+            validate(contract, as: :to_h),
+            as(:fetch, :data),
+            map { |data| model.for(**data) }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/api/endpoints/setup.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "inspectable"
 require "pipeable"
 
 module TRMNL
@@ -13,6 +14,7 @@ module TRMNL
           model: "models.setup"
         ]
 
+        include Inspectable[contract: :class]
         include Pipeable
 
         def call id:

data/lib/trmnl/api/models/model.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module TRMNL
+  module API
+    module Models
+      # Models data for API display responses.
+      Model = Struct.new(
+        :name,
+        :label,
+        :description,
+        :colors,
+        :bit_depth,
+        :scale_factor,
+        :rotation,
+        :mime_type,
+        :width,
+        :height,
+        :offset_x,
+        :offset_y,
+        :published_at
+      ) do
+        def self.for(attributes) = new(**attributes)
+
+        def initialize(**)
+          super
+          apply_defaults
+          freeze
+        end
+
+        def to_json(*) = to_h.to_json(*)
+
+        private
+
+        def apply_defaults
+          %i[colors bit_depth scale_factor rotation width height offset_x offset_y].each do |name|
+            self[name] ||= 0
+          end
+        end
+      end
+    end
+  end
+end
+
+# TODO: Remove when finished.
+__END__
+
+# frozen_string_literal: true
+
+module Kagi
+  module API
+    module Models
+      # Models the search payload.
+      Search = Data.define :meta, :data do
+        def self.for(**attributes)
+          new(
+            **attributes.merge!(
+              meta: Content::Meta.for(**attributes[:meta]),
+              data: attributes[:data].map { Content::Search.for(**it) }
+            )
+          )
+        end
+      end
+    end
+  end
+end
+
+

data/lib/trmnl/api.rb

@@ -16,7 +16,7 @@ module TRMNL
   # Main namespace.
   module API
     def self.loader registry = Zeitwerk::Registry
-      @loader ||= registry.loaders.find { |loader| loader.tag == "trmnl-api" }
+      @loader ||= registry.loaders.each.find { |loader| loader.tag == "trmnl-api" }
     end
 
     def self.new(&) = Client.new(&)

data/trmnl-api.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |spec|
   spec.name = "trmnl-api"
-  spec.version = "0.1.0"
+  spec.version = "0.3.0"
   spec.authors = ["TRMNL"]
-  spec.email = ["support@usetrmnl.com"]
+  spec.email = ["engineering@usetrmnl.com"]
   spec.homepage = "https://github.com/usetrmnl/trmnl-api"
   spec.summary = "A monadic TRMNL API client."
   spec.license = "MIT"
@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-schema", "~> 1.14"
   spec.add_dependency "http", "~> 5.2"
   spec.add_dependency "infusible", "~> 4.3"
+  spec.add_dependency "inspectable", "~> 0.3"
   spec.add_dependency "pipeable", "~> 1.3"
   spec.add_dependency "zeitwerk", "~> 2.7"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - TRMNL
@@ -119,6 +119,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: inspectable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: pipeable
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +162,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.7'
 email:
-- support@usetrmnl.com
+- engineering@usetrmnl.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -165,6 +179,7 @@ files:
 - lib/trmnl/api/contracts/current_screen.rb
 - lib/trmnl/api/contracts/display.rb
 - lib/trmnl/api/contracts/firmware.rb
+- lib/trmnl/api/contracts/model.rb
 - lib/trmnl/api/contracts/setup.rb
 - lib/trmnl/api/dependencies.rb
 - lib/trmnl/api/endpoints/container.rb
@@ -173,10 +188,12 @@ files:
 - lib/trmnl/api/endpoints/display.rb
 - lib/trmnl/api/endpoints/firmware.rb
 - lib/trmnl/api/endpoints/log.rb
+- lib/trmnl/api/endpoints/model.rb
 - lib/trmnl/api/endpoints/setup.rb
 - lib/trmnl/api/models/current_screen.rb
 - lib/trmnl/api/models/display.rb
 - lib/trmnl/api/models/firmware.rb
+- lib/trmnl/api/models/model.rb
 - lib/trmnl/api/models/setup.rb
 - lib/trmnl/api/requester.rb
 - trmnl-api.gemspec
@@ -204,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.7.1
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []