trmnl-api 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4ad04625f2891041bc884419cfdf98484be6a3a6a45cec71a45353615b3280f
-  data.tar.gz: eca25cf2510f0967c85960102396e4307a3f99054640d3ef07b0f288b22ccde1
+  metadata.gz: 8efedaa295b0c387a87ff3ae179bc8179e21485505de33474d1b5e00bb694e15
+  data.tar.gz: ca6875d143b129e2b42114289a3be856e41b5581b4e7ba5286292e6829b3c940
 SHA512:
-  metadata.gz: 8099e1466106d6a33afec9ec777e378bee3805ea7f0abbf2e73044373705b9eae36c2c6290c6748c2e592dfadb9e16d734f67a2aba3a50a936fde136c35ff11e
-  data.tar.gz: f6b487d1e3ee7b3f1bb55cf992d88c106427093fe6bcb84937a19a47ef0031bc4a35c6d2413ceb8c2be9f37404280ed78227b2488cc1aee54e4bcf95437e4e66
+  metadata.gz: d2ba42f64f6e549c6852b5326d7ef0e1a1a8356baff3010fa88e2fe7469fcc82986b3b15ade6fe9734cc1d7df36474139b8c6345733eb8bf932e900ddd04f791
+  data.tar.gz: 0d7e7e1ade6a86c1f689ac783ba5160dd87544306e295b9befe9150c86cb26d410f15e0efa64ee867be9e2a06ef06bd82c6ff19a6502a53709da4a2f863db570

data/README.adoc

@@ -232,6 +232,38 @@ client.firmware_latest
 # )
 ----
 
+You can also tweak the result to answer current (or past) versions, specific model names, and/or both. Examples:
+
+**By Version**
+
+[source,ruby]
+----
+client = TRMNL::API.new
+client.firmware_latest "1.8.0"
+
+# Success(
+#   #<data TRMNL::API::Models::Firmware::Latest
+#          url="https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_og/FW1.8.0.bin",
+#          version="1.8.0">
+# )
+----
+
+**By Model Name**
+
+[source,ruby]
+----
+client = TRMNL::API.new
+client.firmware_latest model_name: "trmnl_x"
+
+# Success(
+#   #<data TRMNL::API::Models::Firmware::Latest
+#          url="https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/FW1.8.17.bin",
+#          version="1.8.17">
+# )
+----
+
+⚠️ This isn't officially supported by the TRMNL API since the endpoint only knows how to provide the latest firmware for OG models so the above allows you to obtain what you need by dynamically formatting the URI based on version and model name. This also means if you make a typo, you might get a URI that doesn't exist since no verification happens.
+
 ==== IP Addresses
 
 Allows you obtain a list of public IP addresses for all TRMNL core servers because plugin poll requests will only originate from these IPs. Example:

data/lib/trmnl/api/client.rb

@@ -43,7 +43,7 @@ module TRMNL
 
       def firmware_flashes = endpoints.fetch(__method__).call
 
-      def firmware_latest = endpoints.fetch(__method__).call
+      def firmware_latest(...) = endpoints.fetch(__method__).call(...)
 
       def ip_addresses = endpoints.fetch(__method__).call
 

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

@@ -18,12 +18,28 @@ module TRMNL
           include Inspectable[schema: :type]
           include Pipeable
 
-          def call
+          ASSET_URI = "https://trmnl-fw.s3.us-east-2.amazonaws.com/%<model_name>s/FW%<version>s.bin"
+
+          def initialize(asset_uri: ASSET_URI, **)
+            @asset_uri = asset_uri
+            super(**)
+          end
+
+          def call version = nil, model_name: "trmnl_og"
             pipe requester.get("firmware/latest"),
                  try(:parse, catch: JSON::ParserError),
                  validate(schema, as: :to_h),
+                 fmap { transform_uri it, (version || it[:version]), model_name },
                  to(model, :for)
           end
+
+          private
+
+          attr_reader :asset_uri
+
+          def transform_uri data, version, model_name
+            data.merge! url: format(asset_uri, model_name:, version:), version:
+          end
         end
       end
     end

data/trmnl-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "trmnl-api"
-  spec.version = "0.21.0"
+  spec.version = "0.22.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/trmnl-api"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl-api
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -272,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.21
+rubygems_version: 4.0.22
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []