trmnl_preview 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '089ae072f5b1117682e0aeec9337910929f304d36ff8f19e33cc2ca08c76ccdc'
-  data.tar.gz: e3fc15289b21f4b039fb236096ea8c6bddf8323ce468ea92057f3864868adffd
+  metadata.gz: 8ae35ca9666591a11737a146ccc41ce507f64e9828df8e099d4200e3d6fda809
+  data.tar.gz: fafd948b1cac498f3b24a793075782eff32dd3608ea083242cc90807227ab6a7
 SHA512:
-  metadata.gz: 9cb4cf95b5c00363682503b4383c236f8d63becc470146c37248da0b7c6073ef5b490f8cc7cbb774fc3053fa0061c5097151f08cd9a84f19dbd9531e43762131
-  data.tar.gz: a5411570286789b52c8d0c44e27626b7a4a181f4c8fd8737ecb4b2ad147103da60a977a0b83d320c5cab68bd10b06e3dcd84fd5ee50d137ef8a6b518968259fc
+  metadata.gz: 3877a9953a508027f9fb2ad2700a138842f7376f4f7567af2259b168a82a910d1bec70e9a192ad50623410c575f8c47ffc0ba60f1a8681c6e4f8aff68fdb47b0
+  data.tar.gz: 8da826b2291adbc73c08043c9c8239a9924103aecd42f16e1a5e072e63832ba8dbb79081591d368f526861359aa26880b2912e256d2fbc1f1928781a7499379f

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 
 # Changelog
 
+## 0.23.0
+
+- `TRMNLP::Poller#fetch_responses` is public: each polling url as TRMNL resolves it, with its live response. A tool can keep them as the mocks `trmnlp test` answers with.
+- `it_behaves_like 'a publishable recipe'` uses the group's `data`, so a webhook plugin's examples can draw from the merge variables it stores.
+- A static plugin with blank `static_data` renders with no data, as on TRMNL, instead of failing with "invalid JSON in static_data". A byte order mark before the JSON is skipped, as on TRMNL.
+
+## 0.22.1
+
+- The Docker image runs liquid 5.14 and selenium-webdriver 4.50, as TRMNL does. It had 5.13 and 4.48, so Liquid output could differ from TRMNL. Installs of the gem already took the newer versions.
+
 ## 0.22.0
 
 - The `bin/trmnlp` script that `trmnlp init` writes takes the steps that run the Docker image from the image, once a day, so a fix to them reaches every plugin with the image. Before, each plugin kept its own copy, which changed only when `trmnlp init` ran again. A plugin made before this release gets the new script from `trmnlp init <its folder>`, answering `y` for `bin/trmnlp` only, once.

data/README.md

@@ -550,6 +550,16 @@ To cut a release:
 
 By convention, add a matching `CHANGELOG.md` entry in the same change.
 
+## Related guides
+
+- [Private Plugins](https://help.trmnl.com/en/articles/9510536-private-plugins): strategies, polling and webhooks
+- [Liquid 101](https://help.trmnl.com/en/articles/10671186-liquid-101) and the [Framework Design Docs](https://help.trmnl.com/en/articles/12410486-framework-design-docs)
+- [Custom plugin form builder](https://help.trmnl.com/en/articles/10513740-custom-plugin-form-builder): the form fields `src/settings.yml` declares
+- [Syncing Plugins with GitHub](https://help.trmnl.com/en/articles/13465101-syncing-plugins-with-github) and [GitHub Sync](https://help.trmnl.com/en/articles/15977899-github-sync)
+- [Recipe best practices](https://help.trmnl.com/en/articles/11395668-recipe-best-practices) and [Demo Data for Publishing Plugins](https://help.trmnl.com/en/articles/12772238-demo-data-for-publishing-plugins)
+- [TRMNL CLI](https://help.trmnl.com/en/articles/17226209-trmnl-cli): the rest of your account from the terminal
+- [MCP Server](https://help.trmnl.com/en/articles/17432548-mcp-server) and our [agent skills](https://github.com/usetrmnl/trmnl-agent-skills): build plugins with an AI agent
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/usetrmnl/trmnlp.

data/lib/trmnlp/config/plugin.rb

@@ -69,8 +69,10 @@ module TRMNLP
 
       def id = @config['id']
 
+      # Like TRMNL: blank is no data, and a byte order mark is not part of the JSON.
       def static_data
-        JSON.parse(@config['static_data'] || '{}')
+        text = @config['static_data'].to_s.delete_prefix("\uFEFF")
+        text.strip.empty? ? {} : JSON.parse(text)
       rescue JSON::ParserError
         raise InvalidConfig, 'invalid JSON in static_data'
       end

data/lib/trmnlp/poller.rb

@@ -46,6 +46,16 @@ module TRMNLP
       {}
     end
 
+    # Each polling url as TRMNL resolves it, with its response, or nil when the fetch failed.
+    def fetch_responses
+      # Resolve once per attempt (it refreshes as a side effect), then share across
+      # every URL, header, and body render.
+      variables = trmnl_variables.call.merge(oauth_session.liquid_variables)
+      headers = config.plugin.polling_headers(extra_variables: variables)
+      body = config.plugin.polling_body(extra_variables: variables)
+      config.plugin.polling_urls(extra_variables: variables).map { |url| [url, fetch_one(url, headers, body)] }
+    end
+
     private
 
     attr_reader :config, :paths, :oauth_session, :trmnl_variables, :reporter, :async_callback
@@ -74,24 +84,16 @@ module TRMNLP
     end
 
     def aggregate_responses
-      fetched = fetch_all
+      fetched = fetch_responses
       # Like the hosted service: a token rejected before its expiry gets one refresh and retry.
-      fetched = fetch_all if fetched.any? { |_url, response| response&.status == 401 } && oauth_session.force_refresh!
+      token_rejected = fetched.any? { |_url, response| response&.status == 401 }
+      fetched = fetch_responses if token_rejected && oauth_session.force_refresh!
       responses = fetched.map { |url, response| response ? parse_response(response, url) : {} }
       return responses.first if responses.size == 1
 
       responses.each_with_index.with_object({}) { |(r, i), h| h["IDX_#{i}"] = r }
     end
 
-    def fetch_all
-      # Resolve once per attempt (it refreshes as a side effect), then share across
-      # every URL, header, and body render.
-      variables = trmnl_variables.call.merge(oauth_session.liquid_variables)
-      headers = config.plugin.polling_headers(extra_variables: variables)
-      body = config.plugin.polling_body(extra_variables: variables)
-      config.plugin.polling_urls(extra_variables: variables).map { |url| [url, fetch_one(url, headers, body)] }
-    end
-
     def fetch_one(url, headers, body)
       verb = config.plugin.polling_verb.upcase
       response, failure = outbound_request.call(verb, url, headers:, body:)

data/lib/trmnlp/testing/publishable_recipe.rb

@@ -35,7 +35,8 @@ end
 RSpec.shared_examples 'a publishable recipe' do |screens: TRMNLP::Testing::PUBLISHABLE_RECIPE_SCREENS|
   let(:recipe_inputs) do
     { mocks: respond_to?(:mocks) ? mocks : {}, custom_fields: respond_to?(:custom_fields) ? custom_fields : {},
-      variables: respond_to?(:variables) ? variables : {}, now: respond_to?(:now) ? now : nil }
+      variables: respond_to?(:variables) ? variables : {}, now: respond_to?(:now) ? now : nil,
+      data: respond_to?(:data) ? data : nil }
   end
 
   def draw_cleanly = have_no_problems.and(have_no_leaked_text)

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = '0.22.0'
+  VERSION = '0.23.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Rockwell Schrock