trmnl-api 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bf06832c324918b8f93b02b8a8700b617c57cd804e206b2b28b20dc0509c6f2
-  data.tar.gz: 5547395a2b3fe1abb54de0cee20a58bbb438bdfc9786a5a602eef40a8b12e147
+  metadata.gz: dedac6b2c46579d646be122b295be973bb3c39bbc35847da48d77f9ce2f506ae
+  data.tar.gz: dd7ec7571e0c2cc0f74c67bfc78c4e157b8590a8736913102e582959a85f920c
 SHA512:
-  metadata.gz: e8c73489d9f1334bbd721aab3c7c6270b4bb791982112245b57a9a1305d1e8f6f108e82356dcecf25db970e644ee9de3b626b1db5b4b741edcd633ed262e4e03
-  data.tar.gz: c511a0cd0e6ca2a15584ee84bf58b6f6556b503118b2a89075401e0c515217a9821ce1e249b1e77741e166bd432678e932d9d4416926174067381df50ebef848
+  metadata.gz: 4b18624c8fb2ec5c395a58824691d5da9a1495f8bc26fe41f1119de67cde3aa6d1d2ef4657a72a490e74db51343c7aceea5930887624cdb5c9ae3a7e1fb46f65
+  data.tar.gz: 91c83467a642383c7edf9ed5decd35b9514fbf45382a9574e39e4510dc48ac748bc70ae0cec6a218fa312652268968826cd2c65c216015d589564a6cd64c07dc

data/README.adoc

@@ -228,34 +228,31 @@ 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_names=["bw"],
-#      css: {
-#        classes: {
-#          device: "screen--og_png",
-#          size: "screen--md"
+#    #<Struct:TRMNL::API::Models::Model:0x00003c20
+#      bit_depth = 4,
+#      colors = 16,
+#      css = {
+#          classes: {
+#          density: "screen--density-2x",
+#           device: "screen--v2",
+#             size: "screen--lg"
 #        },
 #        variables: [
 #          [
 #            "--screen-w",
-#            "800px"
+#            "1040px"
 #          ],
 #          [
 #            "--screen-h",
-#            "480px"
+#            "780px"
+#          ],
+#          [
+#            "--pixel-ratio",
+#            "1.8"
+#          ],
+#          [
+#            "--dither-pixel-ratio",
+#            "2.0"
 #          ],
 #          [
 #            "--ui-scale",
@@ -266,7 +263,23 @@ client.models
 #            "1.0"
 #          ]
 #        ]
-#      }
+#      },
+#      description = "TRMNL X",
+#      height = 1404,
+#      kind = "trmnl",
+#      label = "TRMNL X",
+#      mime_type = "image/png",
+#      name = "v2",
+#      offset_x = 0,
+#      offset_y = 0,
+#      palette_names = [
+#        "gray-16",
+#        "gray-4",
+#        "bw"
+#      ],
+#      rotation = 0,
+#      scale_factor = 1.8,
+#      width = 1872
 #    >
 #  ]
 # )
@@ -328,7 +341,7 @@ client.recipes search: "comic"     # Answers first page of comics.
 client.recipes sort: "popularity"  # Answers first page sorted by popularity.
 
 # Success(
-#  #<data TRMNL::API::Models::Recipe:0x00010fc0
+#  #<data TRMNL::API::Models::Recipe
 #    data = [
 #      #<Struct:TRMNL::API::Models::Recipes::Data:0x00010fe0
 #        author = #<Struct:TRMNL::API::Models::Recipes::Author:0x00010ff0

data/lib/trmnl/api/container.rb

@@ -19,16 +19,16 @@ module TRMNL
         HTTP
       end
 
-      namespace :contracts do
-        register :category, Contracts::Category
-        register :current_screen, Contracts::CurrentScreen
-        register :display, Contracts::Display
-        register :firmware, Contracts::Firmware
-        register :ip_address, Contracts::IPAddress
-        register :model, Contracts::Model
-        register :palette, Contracts::Palette
-        register :recipe, Contracts::Recipe
-        register :setup, Contracts::Setup
+      namespace :schemas do
+        register :category, Schemas::Category
+        register :current_screen, Schemas::CurrentScreen
+        register :display, Schemas::Display
+        register :firmware, Schemas::Firmware
+        register :ip_address, Schemas::IPAddress
+        register :model, Schemas::Model
+        register :palette, Schemas::Palette
+        register :recipe, Schemas::Recipe
+        register :setup, Schemas::Setup
       end
 
       namespace :models do

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

@@ -8,16 +8,16 @@ module TRMNL
     module Endpoints
       # Handles API request/response.
       class Category
-        include TRMNL::API::Dependencies[:requester, contract: "contracts.category"]
+        include TRMNL::API::Dependencies[:requester, schema: "schemas.category"]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         def call
           pipe(
             requester.get("categories"),
             try(:parse, catch: JSON::ParserError),
-            validate(contract, as: :to_h),
+            validate(schema, as: :to_h),
             as(:fetch, :data)
           )
         end

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

@@ -10,17 +10,17 @@ module TRMNL
       class CurrentScreen
         include TRMNL::API::Dependencies[
           :requester,
-          contract: "contracts.current_screen",
+          schema: "schemas.current_screen",
           model: "models.current_screen"
         ]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         def call token:
           pipe requester.get("current_screen", headers: {"Access-Token" => token}),
                try(:parse, catch: JSON::ParserError),
-               validate(contract, as: :to_h),
+               validate(schema, as: :to_h),
                to(model, :for)
         end
       end

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

@@ -10,17 +10,17 @@ module TRMNL
       class Display
         include TRMNL::API::Dependencies[
           :requester,
-          contract: "contracts.display",
+          schema: "schemas.display",
           model: "models.display"
         ]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         def call token:
           pipe requester.get("display", headers: {"Access-Token" => token}),
                try(:parse, catch: JSON::ParserError),
-               validate(contract, as: :to_h),
+               validate(schema, as: :to_h),
                to(model, :for)
         end
       end

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

@@ -10,17 +10,17 @@ module TRMNL
       class Firmware
         include TRMNL::API::Dependencies[
           :requester,
-          contract: "contracts.firmware",
+          schema: "schemas.firmware",
           model: "models.firmware"
         ]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         def call
           pipe requester.get("firmware/latest"),
                try(:parse, catch: JSON::ParserError),
-               validate(contract, as: :to_h),
+               validate(schema, as: :to_h),
                to(model, :for)
         end
       end

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

@@ -10,17 +10,17 @@ module TRMNL
       class IPAddress
         include TRMNL::API::Dependencies[
           :requester,
-          contract: "contracts.ip_address",
+          schema: "schemas.ip_address",
           model: "models.ip_address"
         ]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         def call
           pipe requester.get("ips"),
                try(:parse, catch: JSON::ParserError),
-               validate(contract, as: :to_h),
+               validate(schema, as: :to_h),
                as(:fetch, :data),
                to(model, :for)
         end

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

@@ -10,18 +10,18 @@ module TRMNL
       class Model
         include TRMNL::API::Dependencies[
           :requester,
-          contract: "contracts.model",
+          schema: "schemas.model",
           model: "models.model"
         ]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         def call
           pipe(
             requester.get("models"),
             try(:parse, catch: JSON::ParserError),
-            validate(contract, as: :to_h),
+            validate(schema, as: :to_h),
             as(:fetch, :data),
             map { |data| model.for(**data) }
           )

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

@@ -10,18 +10,18 @@ module TRMNL
       class Palette
         include TRMNL::API::Dependencies[
           :requester,
-          contract: "contracts.palette",
+          schema: "schemas.palette",
           model: "models.palette"
         ]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         def call
           pipe(
             requester.get("palettes"),
             try(:parse, catch: JSON::ParserError),
-            validate(contract, as: :to_h),
+            validate(schema, as: :to_h),
             as(:fetch, :data),
             map { |data| model.for(**data) }
           )

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

@@ -11,11 +11,11 @@ module TRMNL
       class Recipe
         include TRMNL::API::Dependencies[
           :requester,
-          contract: "contracts.recipe",
+          schema: "schemas.recipe",
           model: "models.recipe"
         ]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         using Refinements::Hash
@@ -26,7 +26,7 @@ module TRMNL
           pipe(
             requester.get("recipes.json", **parameters),
             try(:parse, catch: JSON::ParserError),
-            validate(contract, as: :to_h),
+            validate(schema, as: :to_h),
             to(model, :for)
           )
         end

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

@@ -10,17 +10,17 @@ module TRMNL
       class Setup
         include TRMNL::API::Dependencies[
           :requester,
-          contract: "contracts.setup",
+          schema: "schemas.setup",
           model: "models.setup"
         ]
 
-        include Inspectable[contract: :type]
+        include Inspectable[schema: :type]
         include Pipeable
 
         def call id:
           pipe requester.get("setup", headers: {"ID" => id}),
                try(:parse, catch: JSON::ParserError),
-               validate(contract, as: :to_h),
+               validate(schema, as: :to_h),
                to(model, :for)
         end
       end

data/lib/trmnl/api/{contracts → schemas}/category.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       Category = Dry::Schema.JSON { required(:data).array(:string) }
     end

data/lib/trmnl/api/{contracts → schemas}/current_screen.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       CurrentScreen = Dry::Schema.JSON do
         required(:refresh_rate).filled :integer

data/lib/trmnl/api/{contracts → schemas}/display.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       Display = Dry::Schema.JSON do
         required(:filename).filled :string

data/lib/trmnl/api/{contracts → schemas}/firmware.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       Firmware = Dry::Schema.JSON do
         required(:url).filled :string

data/lib/trmnl/api/{contracts → schemas}/ip_address.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       IPAddress = Dry::Schema.JSON do
         required(:data).hash do

data/lib/trmnl/api/{contracts → schemas}/model.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       Model = Dry::Schema.JSON do
         required(:data).array(:hash) do
@@ -24,6 +24,7 @@ module TRMNL
           required(:palette_ids).array(:string)
           optional(:css).hash do
             optional(:classes).hash do
+              required(:density).filled :string
               required(:device).filled :string
               required(:size).filled :string
             end

data/lib/trmnl/api/{contracts → schemas}/palette.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       Palette = Dry::Schema.JSON do
         required(:data).array(:hash) do

data/lib/trmnl/api/{contracts → schemas}/recipe.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       Recipe = Dry::Schema.JSON do
         required(:data).array(:hash) do

data/lib/trmnl/api/{contracts → schemas}/recipes/author.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       module Recipes
         # Validates API response.
         Author = Dry::Schema.JSON do

data/lib/trmnl/api/{contracts → schemas}/setup.rb

@@ -4,7 +4,7 @@ require "dry/schema"
 
 module TRMNL
   module API
-    module Contracts
+    module Schemas
       # Validates API response.
       Setup = Dry::Schema.JSON do
         required(:api_key).filled :string

data/trmnl-api.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "trmnl-api"
-  spec.version = "0.13.0"
+  spec.version = "0.14.0"
   spec.authors = ["TRMNL"]
   spec.email = ["engineering@trmnl.com"]
   spec.homepage = "https://github.com/usetrmnl/trmnl-api"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl-api
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - TRMNL
@@ -9,9 +9,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIENjCCAp6gAwIBAgIBAjANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
+  MIIENjCCAp6gAwIBAgIBAzANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
   a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
-  aW8wHhcNMjUwMzIyMTQ1NDE3WhcNMjYwMzIyMTQ1NDE3WjBBMQ8wDQYDVQQDDAZi
+  aW8wHhcNMjYwMzI1MTI0OTEyWhcNMjcwMzI1MTI0OTEyWjBBMQ8wDQYDVQQDDAZi
   cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
   GRYCaW8wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCro8tj5/E1Hg88
   f4qfiwPVd2zJQHvdYt4GHVvuHRRgx4HGhJuNp+4BId08RBn7V6V1MW6MY3kezRBs
@@ -23,15 +23,15 @@ cert_chain:
   GUHU9MyIXbFOsnp3K3ADrAVjPWop8EZkmUR3MV/CUm00w2cZHCSGiXl1KMpiVKvk
   Ywr1gd2ZME4QLSo+EXUtLxDUa/W3xnBS8dBOuMMz02FPWYr3PN8CAwEAAaM5MDcw
   CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAFgmv0tYMZnItuPycSM
-  F5wykJEVMA0GCSqGSIb3DQEBCwUAA4IBgQBlzRfyAYx/fCFjizS0Npxw4+4T3aYL
-  hbXoDqQRWjxuhFZcXUymhz3r8/Ltyri9lSof8grzB+8/+mrMVms7Gwt5qolk6zdn
-  FkySGy/jmpN12ldOHFbBEnyVBZNBvOBVb8zkkw8PhiHdBdXOUm4Jy39yJvBLfjcC
-  iM1aeWPmgPy1GbvZU+leRGZLt6dRIR9oCDXcWLRjha8xLMoz6Yn9fJBYexBA3iEz
-  h5S7pn4AX/JhVRiSyl8pAy4jEKydpyQrliH3gHkpNmUS/XDczP+9xX1bAB4BvqL2
-  NCxMcQ+hiJNqCKpPgHxaOOHZfIxV33logIuPEQ8NryHAwZ9ZWnwtYDE8kQGGKskI
-  Kkm6QT474hZl7MpwiJjWgW313CR7jUEekQahX1QxCxHPI7LSrKpno0plH3uWIOQp
-  KUlkb9uyACBgyRO52ZHiDVI8YvtU5O/j9pSes9/3XgvBeC1onx4qWp+uRX7eVsYS
-  GiijocTc3enZVrXERetaXj8/9XWs3fB3HWY=
+  F5wykJEVMA0GCSqGSIb3DQEBCwUAA4IBgQAG+ykjp+DIXSybGEtX+/ve974mYfN6
+  8U7qcVfRM+qDSOZ+97iu30qUTbVAKIHlHCDKRn3SgOffDUB5VU2MsJBh/3TPKWBZ
+  anB/uzMcwOfru+qyA3b7ZFqZzRLWmR5FtPObFxc0gYMT3YvLNHk2Nb9Vjq/PoiGG
+  e75PXweDOokwDA5m1gMOz1rdp/dlGMXkSFQg94PPVyUKXgO4VzWTgePSDxOIL+v6
+  +OWV6AaEH9BaqxnmdA5ubi0L7bhl0gbN92FxpNO3kpTjww8kme856a+wCK3qyM5w
+  7ZLbUexynDN0Au8eSpT2Bf6ztGmB1S9ffzDJsGX1/lkpMIB51e48Xe2+gzzOgemk
+  CdZaGupj6WkarnT8kh/cPtyA5ax4rGX6GOS8meGxzkv8Uy0JSEOYAp6wLfIisYZp
+  IJBIXIOkwKKJ0eB5YHrUSJxzpP4LlcIg/eTftaXmJdYjy+2VRrCZYDjfguyLmMjR
+  KR9w4/Fjvqy87kCHmxMWa6IL2Vzt1Clm2cA=
   -----END CERTIFICATE-----
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -190,16 +190,6 @@ files:
 - lib/trmnl/api/configuration/content.rb
 - lib/trmnl/api/configuration/loader.rb
 - lib/trmnl/api/container.rb
-- lib/trmnl/api/contracts/category.rb
-- lib/trmnl/api/contracts/current_screen.rb
-- lib/trmnl/api/contracts/display.rb
-- lib/trmnl/api/contracts/firmware.rb
-- 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
 - lib/trmnl/api/endpoints/container.rb
@@ -227,6 +217,16 @@ files:
 - lib/trmnl/api/models/recipes/statistics.rb
 - lib/trmnl/api/models/setup.rb
 - lib/trmnl/api/requester.rb
+- lib/trmnl/api/schemas/category.rb
+- lib/trmnl/api/schemas/current_screen.rb
+- lib/trmnl/api/schemas/display.rb
+- lib/trmnl/api/schemas/firmware.rb
+- lib/trmnl/api/schemas/ip_address.rb
+- lib/trmnl/api/schemas/model.rb
+- lib/trmnl/api/schemas/palette.rb
+- lib/trmnl/api/schemas/recipe.rb
+- lib/trmnl/api/schemas/recipes/author.rb
+- lib/trmnl/api/schemas/setup.rb
 - lib/trmnl/api/types.rb
 - trmnl-api.gemspec
 homepage: https://github.com/usetrmnl/trmnl-api
@@ -253,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.9
 specification_version: 4
 summary: A monadic TRMNL API client.
 test_files: []