trmnl-api 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3c03e9ded479cf04ef8e035dbc2370b7ea85f6e6c100e923151a0b12c4449ea
-  data.tar.gz: ce9207dfa7ccfddb34c9459cb6a62681b99aefcfceaa2d1ed99a0b75c028d61b
+  metadata.gz: f763f8369338b964c61941391955b24c4ce660b8652176414184d70515a33c0d
+  data.tar.gz: 1f56f30717b729c32dd782c12ac04bb6b1009dc6abc1bcf772c167da41600310
 SHA512:
-  metadata.gz: c8475df46de7907f16ec20200e9b331e7cd740778d09ae83816654cc23ac7d9604b927ccf10d2b6a2f799d9f12f25bbc899543c576f2972c996ae864eadb655b
-  data.tar.gz: a72e2f57727fa4fd2db7b600e93b26a7ee6b098b937341f30a1de6d90f21cfa397563ac35860fdd41c44795f4aa362048cf7a5037b43b5bd09f2555063259f9a
+  metadata.gz: 191da096d070d71e5b1fcc8b7b671a7ac2306a0e0b24207042ed2ea2dbe5560f15b2912dfb0486929b3db5d491d70a2c86185c677614b114083b752087481e6d
+  data.tar.gz: 330b466f275c45fdf634fe96cb345d5c40a70cfd6427a85d8a75168775d4d7e84ef93deae659c641a54557edf7d9be62fcd0a5b6c08285d650227b1c33dc6f29

data/README.adoc

@@ -154,6 +154,84 @@ client.display token: "secret"
 # )
 ----
 
+==== Firmware Flashes
+
+Allows you to obtain firmware flashes. Example:
+
+[source,ruby]
+----
+client = TRMNL::API.new
+client.firmware_flashes
+
+# Success(
+#  [
+#    #<data TRMNL::API::Models::Firmware::Flash:0x000024c0
+#      chip_family = "ESP32-S3",
+#      label = "TRMNL X",
+#      name = "trmnl_x",
+#      versions = [
+#        #<data TRMNL::API::Models::Firmware::Version:0x00002510
+#          label = "FW1.7.7",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.7.7.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x00002540
+#          label = "FW1.7.9",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.7.9.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x00002570
+#          label = "FW1.8.1",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.8.1.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x000025a0
+#          label = "FW1.8.2",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.8.2.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x000025d0
+#          label = "FW1.8.5",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.8.5.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x00002600
+#          label = "FW1.8.6",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.8.6.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x00002630
+#          label = "FW1.8.8",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.8.8.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x00002660
+#          label = "FW1.8.9",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.8.9.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x00002690
+#          label = "FW1.8.10",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.8.10.bin"
+#        >,
+#        #<data TRMNL::API::Models::Firmware::Version:0x000026c0
+#          label = "FW1.8.12",
+#          uri = "https://trmnl-fw.s3.us-east-2.amazonaws.com/trmnl_x/flash/FW1.8.12.bin"
+#        >
+#      ]
+#    >
+#  ]
+# )
+----
+
+==== Firmware Latest
+
+Allows you to obtain the latest stable firmware version. Example:
+
+[source,ruby]
+----
+client = TRMNL::API.new
+client.firmware_latest
+
+# Success(
+#   #<data TRMNL::API::Models::Firmware::Latest
+#          url="https://trmnl-fw.s3.us-east-2.amazonaws.com/FW1.8.12.bin",
+#          version="1.4.8">
+# )
+----
+
 ==== 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:
@@ -177,22 +255,6 @@ client.ip_addresses
 # )
 ----
 
-==== Latest Firmware
-
-Allows you to obtain the latest stable firmware version. Example:
-
-[source,ruby]
-----
-client = TRMNL::API.new
-client.latest_firmware
-
-# Success(
-#   #<data TRMNL::API::Models::LatestFirmware
-#          url="https://trmnl-fw.s3.us-east-2.amazonaws.com/FW1.4.8.bin",
-#          version="1.4.8">
-# )
-----
-
 ==== Log
 
 Allows you to create a log entry (which is what the device reports when it captures an error). You must supply your device's API token as the `token`. Example:
@@ -468,7 +530,19 @@ To test, run:
 bin/rake
 ----
 
+== link:https://alchemists.io/policies/security[Security]
+
+== link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]
+
+== link:https://alchemists.io/policies/contributions[Contributions]
+
+== link:https://alchemists.io/policies/developer_certificate_of_origin[Developer Certificate of Origin]
+
+== link:https://alchemists.io/projects/trmnl-api/versions[Versions]
+
+== link:https://alchemists.io/community[Community]
+
 == Credits
 
 * Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
-* Engineered by link:https://trmnl.com/developers[TRMNL].
+* Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann]

data/lib/trmnl/api/client.rb

@@ -13,8 +13,9 @@ module TRMNL
         categories: Endpoints::Category,
         current_screen: Endpoints::CurrentScreen,
         display: Endpoints::Display,
+        firmware_flashes: Endpoints::Firmware::Flash,
+        firmware_latest: Endpoints::Firmware::Latest,
         ip_addresses: Endpoints::IPAddress,
-        latest_firmware: Endpoints::LatestFirmware,
         log: Endpoints::Log,
         models: Endpoints::Model,
         palettes: Endpoints::Palette,
@@ -40,9 +41,11 @@ module TRMNL
 
       def display(**) = endpoints.fetch(__method__).call(**)
 
-      def ip_addresses = endpoints.fetch(__method__).call
+      def firmware_flashes = endpoints.fetch(__method__).call
+
+      def firmware_latest = endpoints.fetch(__method__).call
 
-      def latest_firmware = endpoints.fetch(__method__).call
+      def ip_addresses = endpoints.fetch(__method__).call
 
       def log(**) = endpoints.fetch(__method__).call(**)
 

data/lib/trmnl/api/container.rb

@@ -23,10 +23,14 @@ module TRMNL
       end
 
       namespace :schemas do
+        namespace :firmware do
+          register :flash, Schemas::Firmware::Flash
+          register :latest, Schemas::Firmware::Latest
+        end
+
         register :category, Schemas::Category
         register :current_screen, Schemas::CurrentScreen
         register :display, Schemas::Display
-        register :latest_firmware, Schemas::LatestFirmware
         register :ip_address, Schemas::IPAddress
         register :model, Schemas::Model
         register :palette, Schemas::Palette
@@ -35,9 +39,13 @@ module TRMNL
       end
 
       namespace :models do
+        namespace :firmware do
+          register :flash, Models::Firmware::Flash
+          register :latest, Models::Firmware::Latest
+        end
+
         register :current_screen, Models::CurrentScreen
         register :display, Models::Display
-        register :latest_firmware, Models::LatestFirmware
         register :ip_address, Models::IPAddress
         register :model, Models::Model
         register :palette, Models::Palette

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

@@ -9,10 +9,14 @@ module TRMNL
       module Container
         extend Containable
 
+        namespace :firmware do
+          register(:flashes) { Firmwares::Flash.new }
+          register(:latest) { Firmware.new }
+        end
+
         register(:categories) { Category.new }
         register(:current_screen) { CurrentScreen.new }
         register(:display) { Display.new }
-        register(:firmware) { Firmware.new }
         register(:ip_addresses) { IPAddress.new }
         register(:log) { Log.new }
         register(:models) { Model.new }

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

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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "inspectable"
+require "pipeable"
+
+module TRMNL
+  module API
+    module Endpoints
+      module Firmware
+        # Handles API request/response.
+        class Latest
+          include TRMNL::API::Dependencies[
+            :requester,
+            schema: "schemas.firmware.latest",
+            model: "models.firmware.latest"
+          ]
+
+          include Inspectable[schema: :type]
+          include Pipeable
+
+          def call
+            pipe requester.get("firmware/latest"),
+                 try(:parse, catch: JSON::ParserError),
+                 validate(schema, as: :to_h),
+                 to(model, :for)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,6 @@
 
 require "inspectable"
 require "pipeable"
-require "refinements/hash"
 
 module TRMNL
   module API
@@ -18,8 +17,6 @@ module TRMNL
         include Inspectable[schema: :type]
         include Pipeable
 
-        using Refinements::Hash
-
         def call **parameters
           parameters.transform_keys! sort: "sort-by"
 

data/lib/trmnl/api/models/firmware/flash.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "core"
+
+module TRMNL
+  module API
+    module Models
+      module Firmware
+        # Models the data of the API response.
+        Flash = Data.define :name, :label, :chip_family, :versions do
+          def self.for **attributes
+            versions = Array(attributes.delete(:versions)).map { Version.for(**it) }
+            new(**attributes.transform_keys!(keyname: :name, chipFamily: :chip_family), versions:)
+          end
+
+          def initialize name: nil, label: nil, chip_family: nil, versions: Core::EMPTY_ARRAY
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TRMNL
+  module API
+    module Models
+      module Firmware
+        # Models the data of the API response.
+        Latest = ::Data.define :url, :version do
+          def self.for(attributes) = new(**attributes)
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/api/models/firmware/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TRMNL
+  module API
+    module Models
+      module Firmware
+        # Models the data of the API response.
+        Version = Data.define :label, :uri do
+          def self.for(**attributes) = new(**attributes.transform_keys!(version: :label, url: :uri))
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module TRMNL
       # Models the data of the API response.
       IPAddress = ::Data.define :version_4, :version_6 do
         def self.for attributes
-          new(**attributes.transform_keys(ipv4: :version_4, ipv6: :version_6))
+          new(**attributes.transform_keys!(ipv4: :version_4, ipv6: :version_6))
         end
       end
     end

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "core"
-require "refinements/hash"
 
 module TRMNL
   module API
@@ -24,7 +23,7 @@ module TRMNL
         :palette_names,
         :css
       ) do
-        def self.for(attributes) = new(**attributes.transform_keys(palette_ids: :palette_names))
+        def self.for(attributes) = new(**attributes.transform_keys!(palette_ids: :palette_names))
 
         def initialize(**)
           super

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

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
 require "core"
-require "refinements/hash"
 
 module TRMNL
   module API
     module Models
       # Models the data of the API response.
       Palette = Struct.new :name, :label, :grays, :colors, :framework_class do
-        using Refinements::Hash
-
-        def self.for(attributes) = new(**attributes.transform_keys(name: :label, id: :name))
+        def self.for(attributes) = new(**attributes.transform_keys!(name: :label, id: :name))
 
         def initialize(**)
           super

data/lib/trmnl/api/schemas/firmware/flash.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+module TRMNL
+  module API
+    module Schemas
+      module Firmware
+        # Validates API response.
+        Flash = Dry::Schema.JSON do
+          required(:data).filled(:hash) do
+            required(:models).filled(:array).each(:hash) do
+              required(:keyname).filled :string
+              required(:label).filled :string
+              required(:chipFamily).filled :string
+              required(:versions).filled(:array).each(:hash) do
+                required(:version).filled :string
+                required(:url).filled :string
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+module TRMNL
+  module API
+    module Schemas
+      module Firmware
+        # Validates API response.
+        Latest = Dry::Schema.JSON do
+          required(:url).filled :string
+          required(:version).filled :string
+        end
+      end
+    end
+  end
+end

data/trmnl-api.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |spec|
   spec.name = "trmnl-api"
-  spec.version = "0.19.0"
-  spec.authors = ["TRMNL"]
-  spec.email = ["engineering@trmnl.com"]
-  spec.homepage = "https://github.com/usetrmnl/trmnl-api"
+  spec.version = "0.20.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://alchemists.io/projects/trmnl-api"
   spec.summary = "A monadic TRMNL API client."
   spec.license = "MIT"
 
   spec.metadata = {
     "bug_tracker_uri" => "https://github.com/usetrmnl/trmnl-api/issues",
-    "changelog_uri" => "https://github.com/usetrmnl/trmnl-api/tags",
-    "homepage_uri" => "https://github.com/usetrmnl/trmnl-api",
+    "changelog_uri" => "https://alchemists.io/projects/trmnl-api/versions",
+    "homepage_uri" => "https://alchemists.io/projects/trmnl-api",
     "label" => "TRMNL API",
     "rubygems_mfa_required" => "true",
     "source_code_uri" => "https://github.com/usetrmnl/trmnl-api"

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: trmnl-api
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
-- TRMNL
+- Brooke Kuhlmann
 bindir: bin
 cert_chain:
 - |
@@ -190,7 +190,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.8'
 email:
-- engineering@trmnl.com
+- brooke@alchemists.io
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -211,8 +211,9 @@ files:
 - lib/trmnl/api/endpoints/current_screen.rb
 - lib/trmnl/api/endpoints/dependencies.rb
 - lib/trmnl/api/endpoints/display.rb
+- lib/trmnl/api/endpoints/firmware/flash.rb
+- lib/trmnl/api/endpoints/firmware/latest.rb
 - lib/trmnl/api/endpoints/ip_address.rb
-- lib/trmnl/api/endpoints/latest_firmware.rb
 - lib/trmnl/api/endpoints/log.rb
 - lib/trmnl/api/endpoints/model.rb
 - lib/trmnl/api/endpoints/palette.rb
@@ -221,8 +222,10 @@ files:
 - lib/trmnl/api/locale_reducer.rb
 - lib/trmnl/api/models/current_screen.rb
 - lib/trmnl/api/models/display.rb
+- lib/trmnl/api/models/firmware/flash.rb
+- lib/trmnl/api/models/firmware/latest.rb
+- lib/trmnl/api/models/firmware/version.rb
 - lib/trmnl/api/models/ip_address.rb
-- lib/trmnl/api/models/latest_firmware.rb
 - lib/trmnl/api/models/model.rb
 - lib/trmnl/api/models/palette.rb
 - lib/trmnl/api/models/recipe.rb
@@ -235,8 +238,9 @@ files:
 - lib/trmnl/api/schemas/category.rb
 - lib/trmnl/api/schemas/current_screen.rb
 - lib/trmnl/api/schemas/display.rb
+- lib/trmnl/api/schemas/firmware/flash.rb
+- lib/trmnl/api/schemas/firmware/latest.rb
 - lib/trmnl/api/schemas/ip_address.rb
-- lib/trmnl/api/schemas/latest_firmware.rb
 - lib/trmnl/api/schemas/model.rb
 - lib/trmnl/api/schemas/palette.rb
 - lib/trmnl/api/schemas/recipe.rb
@@ -244,13 +248,13 @@ files:
 - lib/trmnl/api/schemas/setup.rb
 - lib/trmnl/api/types.rb
 - trmnl-api.gemspec
-homepage: https://github.com/usetrmnl/trmnl-api
+homepage: https://alchemists.io/projects/trmnl-api
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/usetrmnl/trmnl-api/issues
-  changelog_uri: https://github.com/usetrmnl/trmnl-api/tags
-  homepage_uri: https://github.com/usetrmnl/trmnl-api
+  changelog_uri: https://alchemists.io/projects/trmnl-api/versions
+  homepage_uri: https://alchemists.io/projects/trmnl-api
   label: TRMNL API
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/usetrmnl/trmnl-api
@@ -268,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.17
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "inspectable"
-require "pipeable"
-
-module TRMNL
-  module API
-    module Endpoints
-      # Handles API request/response.
-      class LatestFirmware
-        include TRMNL::API::Dependencies[
-          :requester,
-          schema: "schemas.latest_firmware",
-          model: "models.latest_firmware"
-        ]
-
-        include Inspectable[schema: :type]
-        include Pipeable
-
-        def call
-          pipe requester.get("firmware/latest"),
-               try(:parse, catch: JSON::ParserError),
-               validate(schema, as: :to_h),
-               to(model, :for)
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module TRMNL
-  module API
-    module Models
-      # Models the data of the API response.
-      LatestFirmware = ::Data.define :url, :version do
-        def self.for(attributes) = new(**attributes)
-      end
-    end
-  end
-end

data/lib/trmnl/api/schemas/latest_firmware.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/schema"
-
-module TRMNL
-  module API
-    module Schemas
-      # Validates API response.
-      LatestFirmware = Dry::Schema.JSON do
-        required(:url).filled :string
-        required(:version).filled :string
-      end
-    end
-  end
-end