trmnl-api 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 168b5086d30774ef88cc9d12ae187ffa4da349bfe10456c64a5e2fe7e94372a3
-  data.tar.gz: d7c785269f0ddf0238d399a352cef774c9081bb6706a238cf9ead6bcc413ff0e
+  metadata.gz: bcb09ea59c1cbe86f0258090074a66e73e085912a4aacd0439a5aa131d8688ad
+  data.tar.gz: e2bbe53703db7d2c1bdad4594d75217aee1e8680a68e6c15962c3cd2f04f5218
 SHA512:
-  metadata.gz: 4b6cdd52fa7cc10214220a4906298a1d2243d1da94f8854d1dd1eb67cdcd70a761655a717630bb561151e84c01b8926e7b9fac65e1cd84c9fb7590cddc164f7e
-  data.tar.gz: 732532ba60f51c994898d1a982f404ba0d38b419ccc2c6cc95b46548234c51e1b40eedeeda6b4047d81b46f03408b4fccaa8dc8bef3b85dbcef70c0a4a355576
+  metadata.gz: a59f41ff8b9ec8924c66e35b211dcf3d42aabb26425a3467e6f9c2d1afc6cbf463d0710d6a5e3ae9c13eaddcfa75014831e5217feaf14ab6ed2cb9cd7cdb4cc8
+  data.tar.gz: a12ef6cd9a48449b11dd00f718cf14f431f0e211080a04b763f3e0040ef54fc82ee2ccec30fd1d7a39383d82be94ba5566e4761b5fc8c3259a35751eb454edfd

data/README.adoc

@@ -2,8 +2,8 @@
 :toclevels: 5
 :figure-caption!:
 
-:trmnl_link: link:https://usetrmnl.com[TRMNL]
-:trmnl_api_link: link:https://usetrmnl.com/api-docs/index.html[TRMNL API]
+:trmnl_link: link:https://trmnl.com[TRMNL]
+:trmnl_api_link: link:https://trmnl.com/api-docs/index.html[TRMNL API]
 :dry_monads_link: link:https://dry-rb.org/gems/dry-monads[Dry Monads]
 
 = TRMNL API
@@ -113,7 +113,7 @@ client.current_screen token: "secret"
 # Success(
 #   #<data TRMNL::API::Models::CurrentScreen
 #      refresh_rate=1773,
-#      image_url="https://usetrmnl.com/plugin-2025-04-10T11-34-38Z-380c77",
+#      image_url="https://trmnl.com/plugin-2025-04-10T11-34-38Z-380c77",
 #      filename="plugin-2025-04-10T11-34-38Z-380c77"
 #   >
 # )
@@ -132,6 +132,7 @@ client.display token: "secret"
 #   #<struct TRMNL::API::Models::Display
 #     filename="plugin-1745348489",
 #     firmware_url="https://trmnl-fw.s3.us-east-2.amazonaws.com/FW1.4.8.bin",
+#     firmware_version="1.4.8",
 #     image_url="https://trmnl.s3.us-east-2.amazonaws.com/plugin-1745348489",
 #     image_url_timeout=0,
 #     refresh_rate=1771,
@@ -302,11 +303,11 @@ Success(
 
 ==== Recipes
 
-Allows you to obtain information about link:https://usetrmnl.com/recipes[Recipes]. Example:
+Allows you to obtain information about link:https://trmnl.com/recipes[Recipes]. Example:
 
 [source,ruby]
 ----
-client = TRMNL::API.new { |settings| settings.uri = "https://usetrmnl.com" }
+client = TRMNL::API.new { |settings| settings.uri = "https://trmnl.com" }
 
 client.recipes                     # Answers first page.
 client.recipes page: 10            # Answers page ten.
@@ -376,7 +377,7 @@ client.recipes sort: "popularity"  # Answers first page sorted by popularity.
 # )
 ----
 
-⚠️ This _does not_ use the {trmnl_api_link} like every other endpoint documented here. Instead, you must customize the settings URI to point to the root of the TRMNL application (i.e. `https://usetrmnl.com`) instead of using the default API endpoint.
+⚠️ This _does not_ use the {trmnl_api_link} like every other endpoint documented here. Instead, you must customize the settings URI to point to the root of the TRMNL application (i.e. `https://trmnl.com`) instead of using the default API endpoint.
 
 You'll always get a `data` array which may or may not be filled and `meta` (metadata) for handling pagination information. You can also combine the `page`, `search`, and `page` parameters as you see fit.
 
@@ -393,7 +394,7 @@ client.setup id: "A1:B2:C3:D4:E5:F6"
 #   #<data TRMNL::API::Models::Setup
 #     api_key="secret",
 #     friendly_id="F51FDE",
-#     image_url="https://usetrmnl.com/images/setup/setup-logo.bmp",
+#     image_url="https://trmnl.com/images/setup/setup-logo.bmp",
 #     message="Register at usetrmnl.com/signup with Device ID 'F51FDE'"
 #   >
 # )
@@ -429,4 +430,4 @@ bin/rake
 == Credits
 
 * Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
-* Engineered by link:https://usetrmnl.com/developers[TRMNL].
+* Engineered by link:https://trmnl.com/developers[TRMNL].

data/lib/trmnl/api/configuration/loader.rb

@@ -13,7 +13,7 @@ module TRMNL
         def call
           model[
             content_type: environment.fetch("TRMNL_API_CONTENT_TYPE", "application/json"),
-            uri: environment.fetch("TRMNL_API_URI", "https://usetrmnl.com/api")
+            uri: environment.fetch("TRMNL_API_URI", "https://trmnl.com/api")
           ]
         end
 

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

@@ -9,6 +9,7 @@ module TRMNL
       Display = Dry::Schema.JSON do
         required(:filename).filled :string
         required(:firmware_url).filled :string
+        optional(:firmware_version).maybe :string
         required(:image_url).filled :string
         required(:refresh_rate).filled :integer
         required(:reset_firmware).filled :bool

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

@@ -7,6 +7,7 @@ module TRMNL
       Display = Struct.new(
         :filename,
         :firmware_url,
+        :firmware_version,
         :image_url,
         :image_url_timeout,
         :refresh_rate,

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

@@ -5,6 +5,8 @@ module TRMNL
     module Models
       # Models the payload of the API response.
       Recipe = ::Data.define :data, :meta do
+        def self.empty(meta: Recipes::Meta.new) = new(data: [], meta:)
+
         def self.for(**attributes)
           meta = attributes.slice :from,
                                   :to,

data/trmnl-api.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |spec|
   spec.name = "trmnl-api"
-  spec.version = "0.10.0"
+  spec.version = "0.12.0"
   spec.authors = ["TRMNL"]
-  spec.email = ["engineering@usetrmnl.com"]
+  spec.email = ["engineering@trmnl.com"]
   spec.homepage = "https://github.com/usetrmnl/trmnl-api"
   spec.summary = "A monadic TRMNL API client."
   spec.license = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl-api
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - TRMNL
@@ -176,7 +176,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.7'
 email:
-- engineering@usetrmnl.com
+- engineering@trmnl.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -253,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.7
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []