trmnl-api 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff7ecb483d86f9e68a550342e7e923e08ac1ef5d7330a12f4631e94e7a517438
-  data.tar.gz: a249a3fd8c173416d35fb2da4a15be7accf19e29e6505e667c90b4f440866047
+  metadata.gz: 1bf06832c324918b8f93b02b8a8700b617c57cd804e206b2b28b20dc0509c6f2
+  data.tar.gz: 5547395a2b3fe1abb54de0cee20a58bbb438bdfc9786a5a602eef40a8b12e147
 SHA512:
-  metadata.gz: 40d5b26f6f84761379eb2078048ed792eb376506c3e7bc4d59bd05f08215008be16ccff61548cbd63a302350b357174c479fefcce692cd0d34c6fac3d280dd05
-  data.tar.gz: c8ac0a599cf3743f67f58ac0e9021277b08327110b952b4b7c0aabf45ad3679eeae05b0bfe44dc2ea39e191c6370a857558b3422193d01edb82d49c2b4b2d4d3
+  metadata.gz: e8c73489d9f1334bbd721aab3c7c6270b4bb791982112245b57a9a1305d1e8f6f108e82356dcecf25db970e644ee9de3b626b1db5b4b741edcd633ed262e4e03
+  data.tar.gz: c511a0cd0e6ca2a15584ee84bf58b6f6556b503118b2a89075401e0c515217a9821ce1e249b1e77741e166bd432678e932d9d4416926174067381df50ebef848

data/README.adoc

@@ -76,8 +76,8 @@ end
 
 You can configure the client via the following environment variables:
 
-* `TRMNL_API_CONTENT_TYPE`: Defines the HTTP `Content-Type` header. You shouldn't need to change this but is here if you need it. Default: "application/json".
-* `TRMNL_API_URI`: Defines the API URI. Default: "https://trmnl.app/api".
+* `TRMNL_API_CONTENT_TYPE`: Defines the HTTP `Content-Type` header. You shouldn't need to change this but is here if you need it. Default: `"application/json"`.
+* `TRMNL_API_URI`: Defines the API URI. Default: `"https://trmnl.app/api"`.
 
 Any/all environment changes will be applied unless you override these settings via the client configuration block shown above.
 
@@ -227,46 +227,48 @@ client = TRMNL::API.new
 client.models
 
 # Success(
-#   #<data TRMNL::API::Models::Model
-#     name="test",
-#     label="Test",
-#     description="A test.",
-#     kind="trmnl",
-#     colors=2,
-#     bit_depth=1,
-#     scale_factor=1,
-#     rotation=90,
-#     mime_type="image/png",
-#     width=800,
-#     height=480,
-#     offset_x=10,
-#     offset_y=15,
-#     palette_ids=["bw"],
-#     css: {
-#       classes: {
-#         device: "screen--og_png",
-#         size: "screen--md"
-#       },
-#       variables: [
-#         [
-#           "--screen-w",
-#           "800px"
-#         ],
-#         [
-#           "--screen-h",
-#           "480px"
-#         ],
-#         [
-#           "--ui-scale",
-#           "1.0"
-#         ],
-#         [
-#           "--gap-scale",
-#           "1.0"
-#         ]
-#       ]
-#     }
-#   >
+#  [
+#    #<data TRMNL::API::Models::Model
+#      name="test",
+#      label="Test",
+#      description="A test.",
+#      kind="trmnl",
+#      colors=2,
+#      bit_depth=1,
+#      scale_factor=1,
+#      rotation=90,
+#      mime_type="image/png",
+#      width=800,
+#      height=480,
+#      offset_x=10,
+#      offset_y=15,
+#      palette_names=["bw"],
+#      css: {
+#        classes: {
+#          device: "screen--og_png",
+#          size: "screen--md"
+#        },
+#        variables: [
+#          [
+#            "--screen-w",
+#            "800px"
+#          ],
+#          [
+#            "--screen-h",
+#            "480px"
+#          ],
+#          [
+#            "--ui-scale",
+#            "1.0"
+#          ],
+#          [
+#            "--gap-scale",
+#            "1.0"
+#          ]
+#        ]
+#      }
+#    >
+#  ]
 # )
 ----
 
@@ -274,7 +276,7 @@ client.models
 
 ==== Palettes
 
-Allows you to obtain palettes details. The IDs correlate to the `palette_ids` as found in the Models API. Example:
+Allows you to obtain palettes details. The names correlate to the `palette_names` as found in the Models API. Example:
 
 [source,ruby]
 ----
@@ -283,19 +285,30 @@ client.palettes
 
 Success(
   [
-    #<data TRMNL::API::Models::Palette
-      id="bw",
-      name="Black & White (1-bit)",
-      grays=2,
-      colors=nil,
-      framework_class="screen--1bit"
+    #<Struct:TRMNL::API::Models::Palette
+      name = "bw",
+      label = "Black & White (1-bit)",
+      grays = 2,
+      colors = [],
+      framework_class = "screen--1bit"
+    >,
+    #<Struct:TRMNL::API::Models::Palette
+      name = "color-3bwr",
+      label = "Color (3 colors)",
+      grays = 2,
+      colors = [
+        "#000000",
+        "#FF0000",
+        "#FFFFFF"
+      ],
+      framework_class = nil
     >,
-    #<data TRMNL::API::Models::Palette
-      id="color-24bit",
-      name="Color (24-bit)",
-      grays=nil,
-      colors=nil,
-      framework_class=""
+    #<Struct:TRMNL::API::Models::Palette
+      name = "color-24bit",
+      label = "Color (16777216 colors)",
+      grays = 2,
+      colors = [],
+      framework_class = nil
     >
   ]
 )

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "refinements/hash"
+
 module TRMNL
   module API
     module Models
@@ -18,10 +20,10 @@ module TRMNL
         :height,
         :offset_x,
         :offset_y,
-        :palette_ids,
+        :palette_names,
         :css
       ) do
-        def self.for(attributes) = new(**attributes)
+        def self.for(attributes) = new(**attributes.transform_keys(palette_ids: :palette_names))
 
         def initialize(**)
           super
@@ -34,6 +36,8 @@ module TRMNL
         private
 
         def apply_defaults
+          self[:palette_names] ||= []
+
           %i[colors bit_depth scale_factor rotation width height offset_x offset_y].each do |name|
             self[name] ||= 0
           end

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

@@ -1,11 +1,22 @@
 # frozen_string_literal: true
 
+require "refinements/hash"
+
 module TRMNL
   module API
     module Models
       # Models the data of the API response.
-      Palette = Struct.new :id, :name, :grays, :colors, :framework_class do
-        def self.for(attributes) = new(**attributes)
+      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 initialize(**)
+          super
+          self[:grays] ||= 0
+          self[:colors] ||= []
+          freeze
+        end
       end
     end
   end

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.11.0"
+  spec.version = "0.13.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.11.0
+  version: 0.13.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.8
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []