trmnl-api 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9fb20c5a06061df12d534be39e9d165b7774a7854f35c6c3b89ee4021f6831c
-  data.tar.gz: 30da4deb5099f07f3c23be8e093cc7e926718545919d2ecdd06c035006649a30
+  metadata.gz: cb8a2557d167924338d70a68b91207d89f48b72a44e66e252fd0760fc3ffc035
+  data.tar.gz: 4c3329056c42c1b57347eb00b748f0baf384720c67aeacf938ce2dcecee4a2e3
 SHA512:
-  metadata.gz: eaa11f3d4ba80ce5eae39682e952536a1b05f1577d856e217028a8164b44b5d123ae188700c3b096205ca743dbb3b291cea7643094678f49f81a28c96bd42719
-  data.tar.gz: fd5cb1d4372bbce29288d3d466b730223f51d4fca707ab9b432eb79cb987140a8ac6767ca49d60aa6a2e3100a8a422c3bab77be1137fc6463d1d180d0c49d73d
+  metadata.gz: 6b7a621e59c10820c52b5dbad143b03399544297fba3faa89078a938539ef53cbb7c823a1028f24930fa4edd56d21c2788a440bdf5b3310ccba8d8dac1fc7f06
+  data.tar.gz: b67362a9aa48c7a4009e5b7f59201378c69bca85de6bb560e4c1b208ab6c5bc15c64e6edceb17d3d6a163b7f1fae00fffb3052c987cb9ee4a851c131b713ead9

data/README.adoc

@@ -3,17 +3,18 @@
 :figure-caption!:
 
 :trmnl_link: link:https://usetrmnl.com[TRMNL]
+:trmnl_api_link: link:https://usetrmnl.com/api-docs/index.html[TRMNL API]
 :dry_monads_link: link:https://dry-rb.org/gems/dry-monads[Dry Monads]
 
 = TRMNL API
 
-A monadic {trmnl_link} API client. You can use this client in your own code to interact with our APIs for any/all devices that you own.
+A monadic {trmnl_api_link} client. You can use this client in your own code to interact with our APIs for any/all devices that you own.
 
 toc::[]
 
 == Features
 
-* Provides {trmnl_link} API access.
+* Provides {trmnl_api_link} access.
 
 == Requirements
 
@@ -48,7 +49,7 @@ require "trmnl/api"
 This client provides access to multiple endpoints. Each endpoint will answer either a `Success` or `Failure` (as provided by {dry_monads_link}) based on result of the API call. This allows you pattern match in your own code when using each endpoint. Example:
 
 ``` ruby
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 
 case client.display token: "secret"
   in Success(payload) then puts payload
@@ -65,7 +66,7 @@ By default, you shouldn't need to change the default configuration but you can a
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new do |settings|
+client = TRMNL::API.new do |settings|
   settings.content_type = "application/json",
   settings.uri = "https://trmnl.app/api"
 end
@@ -88,7 +89,7 @@ Allows you to obtain the list of approved plugin categories. Example:
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 client.categories
 
 # Success(
@@ -106,7 +107,7 @@ Allows you to obtain current screen being displayed for your device. You must su
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 client.current_screen token: "secret"
 
 # Success(
@@ -124,7 +125,7 @@ Allows you to obtain current screen being displayed for your device with additio
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 client.display token: "secret"
 
 # Success(
@@ -147,7 +148,7 @@ Allows you to obtain the current stable firmware version. Example:
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 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">)
@@ -159,7 +160,7 @@ Allows you obtain a list of public IP addresses for all TRMNL core servers becau
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 client.ip_addresses
 
 # Success(
@@ -182,7 +183,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 = TRMNL::API.new
 client.log token: "secret",
             log: {
               logs_array: [
@@ -221,7 +222,7 @@ Allows you to obtain the model information for all devices and screens. Example:
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 client.models
 
 # Success(
@@ -276,7 +277,7 @@ Allows you to obtain palettes details. The IDs correlate to the `palette_ids` as
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 client.palettes
 
 Success(
@@ -299,13 +300,94 @@ Success(
 )
 ----
 
+==== Recipes
+
+Allows you to obtain information about link:https://usetrmnl.com/recipes[Recipes]. Example:
+
+⚠️ This _does not_ use the {trmnl_api_link} like every other endpoint documented here. This is why you must customize the settings URI to point to the root of the TRMNL application instead of using the default API endpoint.
+
+[source,ruby]
+----
+client = TRMNL::API.new { |settings| settings.uri = "https://usetrmnl.com" }
+
+client.recipes                          # Answers first page.
+client.recipes page: 10                 # Answers page ten.
+client.recipes search: "comic"          # Answers first page of comics.
+client.recipes "sort-by": "popularity"  # Answers first page sorted by popularity.
+
+# Success(
+#   #<data TRMNL::API::Models::Recipe:0x0000b4d0
+#     current_page = 1,
+#     data = [
+#       #<Struct:TRMNL::API::Models::Recipes::Entry:0x0000b4f0
+#         author = #<Struct:TRMNL::API::Models::Recipes::Author:0x0000b500
+#           category = "travel",
+#           description = "Displays upcoming...",
+#           description_locales = {},
+#           email_address = nil,
+#           field_type = "author_bio",
+#           github_url = "https://github.com/CaptainProton42/trmnl-bustimes-org",
+#           keyname = "readme",
+#           learn_more_url = nil,
+#           name = "About This Plugin",
+#           youtube_url = nil
+#         >,
+#         custom_fields = [
+#           {
+#                 "keyname" => "readme",
+#                    "name" => "About This Plugin",
+#                "category" => "travel",
+#              "field_type" => "author_bio",
+#             "description" => "Displays upcoming...",
+#              "github_url" => "https://github.com/CaptainProton42/trmnl-bustimes-org"
+#           },
+#           {
+#                 "keyname" => "atco",
+#              "field_type" => "string",
+#                    "name" => "Bus Stop",
+#             "description" => "The <a href=\"https://mullinscr.github.io/naptan/atco_codes/\">ATCO</a> code for your bus stop.",
+#               "help_text" => "You can find this..."
+#           },
+#           {
+#                 "keyname" => "bus",
+#              "field_type" => "multi_string",
+#                    "name" => "Busses",
+#             "description" => "Optionally, choose specific bus services you want to display departures for.",
+#               "help_text" => "Use the name of the service, e.g. '10' or '3A'.",
+#                "optional" => true
+#           }
+#         ],
+#         icon_content_type = "image/png",
+#         icon_url = "https://trmnl-public.s3.us-east-2.amazonaws.com/59lqujqwid1cvzsd7sr3erfuexur",
+#         id = 222328,
+#         name = "UK Bus Departures (bustimes.org)",
+#         published_at = 2026-01-14 22:53:07.587 UTC,
+#         screenshot_url = "https://trmnl.s3.us-east-2.amazonaws.com...",
+#         statistics = #<data TRMNL::API::Models::Recipes::Statistics:0x0000b710
+#           forks = 0,
+#           installs = 1
+#         >
+#       >
+#     ],
+#     from = 1,
+#     next_page_url = "/recipes.json?page=2",
+#     per_page = 25,
+#     prev_page_url = nil,
+#     to = 25,
+#     total = 658
+#   >
+# )
+----
+
+You'll always get a `data` array with may or may not be filled. Pagination information is listed at the bottom.
+
 ==== 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:
 
 [source,ruby]
 ----
-client = TRMNL::API::Client.new
+client = TRMNL::API.new
 client.setup id: "A1:B2:C3:D4:E5:F6"
 
 # Success(

data/lib/trmnl/api/client.rb

@@ -7,53 +7,56 @@ module TRMNL
     # Provides the primary client for making API requests.
     class Client
       include Dependencies[:settings]
+      include Inspectable[:endpoints]
+
+      ENDPOINTS = {
+        categories: Endpoints::Category,
+        current_screen: Endpoints::CurrentScreen,
+        display: Endpoints::Display,
+        firmware: Endpoints::Firmware,
+        ip_addresses: Endpoints::IPAddress,
+        log: Endpoints::Log,
+        models: Endpoints::Model,
+        palettes: Endpoints::Palette,
+        recipes: Endpoints::Recipe,
+        setup: Endpoints::Setup
+      }.freeze
+
+      def initialize(requester: Requester, endpoints: ENDPOINTS, **)
+        super(**)
 
-      include Endpoints::Dependencies[
-        endpoint_categories: :categories,
-        endpoint_current_screen: :current_screen,
-        endpoint_display: :display,
-        endpoint_firmware: :firmware,
-        endpoint_ip_addresses: :ip_addresses,
-        endpoint_log: :log,
-        endpoint_models: :models,
-        endpoint_palettes: :palettes,
-        endpoint_setup: :setup
-      ]
-
-      include Inspectable[
-        endpoint_categories: :class,
-        endpoint_current_screen: :class,
-        endpoint_display: :class,
-        endpoint_firmware: :class,
-        endpoint_ip_addresses: :class,
-        endpoint_log: :class,
-        endpoint_models: :class,
-        endpoint_palettes: :class,
-        endpoint_setup: :class
-      ]
-
-      def initialize(**)
-        super
         yield settings if block_given?
+
+        requester = requester.new(settings:)
+
+        @endpoints = endpoints.each.with_object({}) do |(key, value), all|
+          all[key] = value.new requester:
+        end
       end
 
-      def categories = endpoint_categories.call
+      def categories = endpoints.fetch(__method__).call
+
+      def current_screen(**) = endpoints.fetch(__method__).call(**)
+
+      def display(**) = endpoints.fetch(__method__).call(**)
+
+      def firmware = endpoints.fetch(__method__).call
 
-      def current_screen(**) = endpoint_current_screen.call(**)
+      def ip_addresses = endpoints.fetch(__method__).call
 
-      def display(**) = endpoint_display.call(**)
+      def log(**) = endpoints.fetch(__method__).call(**)
 
-      def firmware = endpoint_firmware.call
+      def models(**) = endpoints.fetch(__method__).call(**)
 
-      def ip_addresses = endpoint_ip_addresses.call
+      def palettes = endpoints.fetch(__method__).call
 
-      def log(**) = endpoint_log.call(**)
+      def recipes(**) = endpoints.fetch(__method__).call(**)
 
-      def models(**) = endpoint_models.call(**)
+      def setup(**) = endpoints.fetch(__method__).call(**)
 
-      def palettes = endpoint_palettes.call
+      private
 
-      def setup(**) = endpoint_setup.call(**)
+      attr_reader :endpoints
     end
   end
 end

data/lib/trmnl/api/container.rb

@@ -10,7 +10,7 @@ module TRMNL
     module Container
       extend Containable
 
-      register(:settings) { TRMNL::API::Configuration::Loader.new.call }
+      register(:settings, as: :fresh) { TRMNL::API::Configuration::Loader.new.call }
       register(:requester) { API::Requester.new }
       register(:logger) { Cogger.new id: "trmnl-api", formatter: :json }
 
@@ -27,6 +27,7 @@ module TRMNL
         register :ip_address, Contracts::IPAddress
         register :model, Contracts::Model
         register :palette, Contracts::Palette
+        register :recipe, Contracts::Recipe
         register :setup, Contracts::Setup
       end
 
@@ -37,6 +38,7 @@ module TRMNL
         register :ip_address, Models::IPAddress
         register :model, Models::Model
         register :palette, Models::Palette
+        register :recipe, Models::Recipe
         register :setup, Models::Setup
       end
     end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+module TRMNL
+  module API
+    module Contracts
+      # Validates API response.
+      Recipe = Dry::Schema.JSON do
+        required(:data).array(:hash) do
+          required(:id).filled :integer
+          required(:name).filled :string
+          required(:screenshot_url).filled :string
+          required(:published_at).filled :time
+          optional(:icon_url).maybe :string
+          optional(:icon_content_type).maybe :string
+          required(:author_bio).maybe Recipes::Author
+          required(:custom_fields).array(:hash)
+
+          required(:stats).filled :hash do
+            required(:installs).filled :integer
+            required(:forks).filled :integer
+          end
+        end
+
+        required(:total).filled :integer
+        required(:from).filled :integer
+        required(:to).filled :integer
+        required(:per_page).filled :integer
+        required(:current_page).filled :integer
+        required(:prev_page_url).maybe :string
+        required(:next_page_url).maybe :string
+      end
+    end
+  end
+end

data/lib/trmnl/api/contracts/recipes/author.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "dry/schema"
+
+module TRMNL
+  module API
+    module Contracts
+      module Recipes
+        # Validates API response.
+        Author = Dry::Schema.JSON do
+          required(:keyname).filled :string
+          required(:name).filled :string
+          required(:field_type).filled :string
+          optional(:category).filled :string
+          optional(:description).filled :string
+          optional(:"description-de").filled :string
+          optional(:"description-nl").filled :string
+          optional(:"description-fr").filled :string
+          optional(:"description-en").filled :string
+          optional(:"description-en-GB").filled :string
+          optional(:"description-es-ES").filled :string
+          optional(:"description-it").filled :string
+          optional(:"description-no").filled :string
+          optional(:"description-da").filled :string
+          optional(:"description-ja").filled :string
+          optional(:"description-de-AT").filled :string
+          optional(:"description-ko").filled :string
+          optional(:"description-sv").filled :string
+          optional(:"description-pt-BR").filled :string
+          optional(:"description-zh-HK").filled :string
+          optional(:"description-pl").filled :string
+          optional(:"description-uk").filled :string
+          optional(:"description-zh-CN").filled :string
+          optional(:"description-hu").filled :string
+          optional(:"description-he").filled :string
+          optional(:"description-sk").filled :string
+          optional(:"description-ru").filled :string
+          optional(:"description-is").filled :string
+          optional(:"description-id").filled :string
+          optional(:email_address).filled :string
+          optional(:learn_more_url).filled :string
+          optional(:github_url).filled :string
+          optional(:youtube_url).filled :string
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module TRMNL
       class Category
         include TRMNL::API::Dependencies[:requester, contract: "contracts.category"]
 
-        include Inspectable[contract: :class]
+        include Inspectable[contract: :type]
         include Pipeable
 
         def call

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

@@ -17,6 +17,7 @@ module TRMNL
         register(:log) { Log.new }
         register(:models) { Model.new }
         register(:palettes) { Palette.new }
+        register(:recipes) { Recipe.new }
         register(:setup) { Setup.new }
       end
     end

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

@@ -14,7 +14,7 @@ module TRMNL
           model: "models.current_screen"
         ]
 
-        include Inspectable[contract: :class]
+        include Inspectable[contract: :type]
         include Pipeable
 
         def call token:

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

@@ -14,7 +14,7 @@ module TRMNL
           model: "models.display"
         ]
 
-        include Inspectable[contract: :class]
+        include Inspectable[contract: :type]
         include Pipeable
 
         def call token:

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

@@ -14,7 +14,7 @@ module TRMNL
           model: "models.firmware"
         ]
 
-        include Inspectable[contract: :class]
+        include Inspectable[contract: :type]
         include Pipeable
 
         def call

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

@@ -14,7 +14,7 @@ module TRMNL
           model: "models.ip_address"
         ]
 
-        include Inspectable[contract: :class]
+        include Inspectable[contract: :type]
         include Pipeable
 
         def call

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

@@ -14,7 +14,7 @@ module TRMNL
           model: "models.model"
         ]
 
-        include Inspectable[contract: :class]
+        include Inspectable[contract: :type]
         include Pipeable
 
         def call

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

@@ -14,7 +14,7 @@ module TRMNL
           model: "models.palette"
         ]
 
-        include Inspectable[contract: :class]
+        include Inspectable[contract: :type]
         include Pipeable
 
         def call

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

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

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

@@ -14,7 +14,7 @@ module TRMNL
           model: "models.setup"
         ]
 
-        include Inspectable[contract: :class]
+        include Inspectable[contract: :type]
         include Pipeable
 
         def call id:

data/lib/trmnl/api/locale_reducer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TRMNL
+  module API
+    LocaleReducer = lambda do |attributes, prefix: "description-"|
+      attributes.each.with_object({}) do |(key, value), all|
+        next unless key.start_with? prefix
+
+        attributes.delete key
+        all[key.to_s.delete_prefix(prefix)] = value
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module TRMNL
   module API
     module Models
-      # Models API response.
+      # Models the data of the API response.
       CurrentScreen = Data.define :refresh_rate, :image_url, :filename do
         def self.for(attributes) = new(**attributes)
       end

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

@@ -3,7 +3,7 @@
 module TRMNL
   module API
     module Models
-      # Models data for API display responses.
+      # Models the data of the API response.
       Display = Struct.new(
         :filename,
         :firmware_url,

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

@@ -3,7 +3,7 @@
 module TRMNL
   module API
     module Models
-      # Models API response.
+      # Models the data of the API response.
       Firmware = Data.define :url, :version do
         def self.for(attributes) = new(**attributes)
       end

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

@@ -3,7 +3,7 @@
 module TRMNL
   module API
     module Models
-      # IPs API response.
+      # 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))

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

@@ -3,7 +3,7 @@
 module TRMNL
   module API
     module Models
-      # Models data for API display responses.
+      # Models the data of the API response.
       Model = Struct.new(
         :name,
         :label,

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

@@ -3,8 +3,8 @@
 module TRMNL
   module API
     module Models
-      # IPs API response.
-      Palette = Data.define :id, :name, :grays, :colors, :framework_class do
+      # Models the data of the API response.
+      Palette = Struct.new :id, :name, :grays, :colors, :framework_class do
         def self.for(attributes) = new(**attributes)
       end
     end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TRMNL
+  module API
+    module Models
+      # Models the data of the API response.
+      Recipe = Data.define(
+        :data,
+        :total,
+        :from,
+        :to,
+        :per_page,
+        :current_page,
+        :prev_page_url,
+        :next_page_url
+      ) do
+        def self.for(**attributes)
+          data = attributes[:data].map { Recipes::Entry.for(**it) }
+          new(**attributes.merge!(data:))
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/api/models/recipes/author.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module TRMNL
+  module API
+    module Models
+      module Recipes
+        # Models the author of the API response.
+        Author = Struct.new(
+          :keyname,
+          :name,
+          :field_type,
+          :category,
+          :description,
+          :description_locales,
+          :email_address,
+          :learn_more_url,
+          :github_url,
+          :youtube_url
+        ) do
+          def self.for(locale_reducer: LocaleReducer, **attributes)
+            description_locales = locale_reducer.call attributes
+            new(description_locales:, **attributes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/api/models/recipes/entry.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module TRMNL
+  module API
+    module Models
+      module Recipes
+        # Models the data of the API response.
+        Entry = Struct.new(
+          :id,
+          :name,
+          :icon_url,
+          :icon_content_type,
+          :screenshot_url,
+          :author,
+          :custom_fields,
+          :statistics,
+          :published_at
+        ) do
+          def self.for(**attributes)
+            new(
+              **attributes.merge!(
+                author: Author.for(**attributes.delete(:author_bio)),
+                statistics: Statistics[**attributes.delete(:stats)]
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trmnl/api/models/recipes/statistics.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TRMNL
+  module API
+    module Models
+      module Recipes
+        # Models the statistics of the API response.
+        Statistics = Data.define :installs, :forks
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module TRMNL
   module API
     module Models
-      # Models API response.
+      # Models the data of the API response.
       Setup = Data.define :api_key, :friendly_id, :image_url, :message do
         def self.for(attributes) = new(**attributes)
       end

data/lib/trmnl/api/requester.rb

@@ -23,18 +23,20 @@ module TRMNL
 
       private
 
-      attr_reader :settings, :http
-
       def call method, path, headers, **options
         http.headers(settings.headers.merge(headers))
             .public_send(method, uri(path), options)
             .then { |response| response.status.success? ? Success(response) : Failure(response) }
+      rescue HTTP::RequestError => error then handle_bad_request path, error
       rescue HTTP::ConnectionError => error then handle_bad_connection path, error
       rescue HTTP::TimeoutError => error then handle_timeout path, error
       rescue OpenSSL::SSL::SSLError => error then handle_bad_ssl path, error
       end
 
-      def uri(path) = "#{settings.uri}/#{path}"
+      def handle_bad_request path, error
+        logger.debug { error.message }
+        Failure "Unable to make request: #{uri(path).inspect}. Is the URI valid?"
+      end
 
       def handle_bad_connection path, error
         logger.debug { error.message }
@@ -51,6 +53,8 @@ module TRMNL
         Failure "Unable to secure connection: #{uri(path).inspect}. " \
                 "Is your certificate or SSL valid?"
       end
+
+      def uri(path) = "#{settings.uri}/#{path}"
     end
   end
 end

data/trmnl-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "trmnl-api"
-  spec.version = "0.7.0"
+  spec.version = "0.9.0"
   spec.authors = ["TRMNL"]
   spec.email = ["engineering@usetrmnl.com"]
   spec.homepage = "https://github.com/usetrmnl/trmnl-api"
@@ -21,18 +21,17 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = ">= 3.4"
+  spec.required_ruby_version = ">= 4.0"
 
-  spec.add_dependency "cogger", "~> 1.4"
-  spec.add_dependency "containable", "~> 1.2"
-  spec.add_dependency "dry-monads", "~> 1.8"
+  spec.add_dependency "cogger", "~> 2.0"
+  spec.add_dependency "containable", "~> 2.0"
+  spec.add_dependency "dry-monads", "~> 1.9"
   spec.add_dependency "dry-schema", "~> 1.14"
   spec.add_dependency "dry-types", "~> 1.8"
   spec.add_dependency "http", "~> 5.3"
-  spec.add_dependency "infusible", "~> 4.3"
-  spec.add_dependency "inspectable", "~> 0.3"
-  spec.add_dependency "openssl", "~> 3.3"
-  spec.add_dependency "pipeable", "~> 1.3"
+  spec.add_dependency "infusible", "~> 5.0"
+  spec.add_dependency "inspectable", "~> 1.0"
+  spec.add_dependency "pipeable", "~> 2.0"
   spec.add_dependency "zeitwerk", "~> 2.7"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl-api
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - TRMNL
@@ -41,42 +41,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: containable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: dry-schema
   requirement: !ruby/object:Gem::Requirement
@@ -125,56 +125,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.0'
 - !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: openssl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pipeable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +197,8 @@ files:
 - lib/trmnl/api/contracts/ip_address.rb
 - lib/trmnl/api/contracts/model.rb
 - lib/trmnl/api/contracts/palette.rb
+- lib/trmnl/api/contracts/recipe.rb
+- lib/trmnl/api/contracts/recipes/author.rb
 - lib/trmnl/api/contracts/setup.rb
 - lib/trmnl/api/dependencies.rb
 - lib/trmnl/api/endpoints/category.rb
@@ -223,13 +211,19 @@ files:
 - lib/trmnl/api/endpoints/log.rb
 - lib/trmnl/api/endpoints/model.rb
 - lib/trmnl/api/endpoints/palette.rb
+- lib/trmnl/api/endpoints/recipe.rb
 - lib/trmnl/api/endpoints/setup.rb
+- lib/trmnl/api/locale_reducer.rb
 - lib/trmnl/api/models/current_screen.rb
 - lib/trmnl/api/models/display.rb
 - lib/trmnl/api/models/firmware.rb
 - lib/trmnl/api/models/ip_address.rb
 - lib/trmnl/api/models/model.rb
 - lib/trmnl/api/models/palette.rb
+- lib/trmnl/api/models/recipe.rb
+- lib/trmnl/api/models/recipes/author.rb
+- lib/trmnl/api/models/recipes/entry.rb
+- lib/trmnl/api/models/recipes/statistics.rb
 - lib/trmnl/api/models/setup.rb
 - lib/trmnl/api/requester.rb
 - lib/trmnl/api/types.rb
@@ -251,14 +245,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.4
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []