trmnl_preview 0.13.2 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 905205771ecf23f22c55a3d48835e6ee75ea90d4d2b55638c6ebea0160173578
-  data.tar.gz: 663c559a8b71f943023fae8e18ea2e494c8df04e2d5fe81ffd34ce19a6d4d736
+  metadata.gz: fbe879abcadc7c6f7efceb9e54c88606aafd090a9538c9942f8cd3afef9596da
+  data.tar.gz: d9a123366e021a55b8bdc5b55016e38f1f1b4107163bc570a5112d89c8084270
 SHA512:
-  metadata.gz: d8fbb97e1eb0ccc38a54ab7820de2837e7ef27b1bc52faed278b912a1ad709aee63f5b58860cbe4dedbd9fac7a5b7b3bce5fb68f2a750a0c064bb489a4846bc5
-  data.tar.gz: 0d3ffc25d6567a13c125bd332be0fd76ec2b018e4de2e144b3e36ac1e4dc99882b6c802c31bbfdcac86e104b00b3448e8d1d4d61733aad953325a67b9399ca0c
+  metadata.gz: 0cd3eb90f4a2231a28dfe8e08097a90bc0d70d93861f9decd1946708b77c0ddf4b5ba3e3dd1acbae0b1daac7238cb88ea74d9f504880adeb1ee7c6ac6402c774
+  data.tar.gz: fbd799614df7d3c978ca2a67fb1b7916b446994bfbd15ce268f764ad0dbd62fed7a34f6c8e63621926490a3eabece74d44b089f3175bd0ad305de7958cf622a1

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 
 # Changelog
 
+## 0.14.1
+
+- `trmnlp lint` reports a `recipe_overview` under 100 words. Below that, TRMNL serves the public recipe page with `robots: noindex`, so the recipe never appears in Google or other search engines, and nothing said so: the page looked fine, and only its HTML gave it away. A blank overview still passes, since private plugins have none. (#144)
+
+## 0.14.0
+
+- `trmnlp serve` and `build` print what the transform writes to stdout and stderr (`console.log`, `print`, `puts`), one `transform stdout:` / `transform stderr:` line each, so a transform can be debugged without returning its logs in the data. (#128)
+- The OAuth token exchange and refresh honor `oauth_token_request_auth_method` the way the hosted service does: HTTP Basic only for `header`, otherwise the client credentials go in the request body. trmnlp used HTTP Basic whenever a client secret was set, so a provider that wants the credentials in the body rejected the callback with `invalid_client: client_id is required`. A plugin that relied on HTTP Basic locally sets `oauth_token_request_auth_method: header`, which the hosted service already needs. (#121)
+- `polling_headers` are parsed the way the hosted service parses them: one header per line, `Name: Value` as well as `Name=Value`, a JSON object, and values that contain `=`. Before, trmnlp split only on `&`, so headers saved one per line made the whole poll fail with "cannot include CR/LF" and the markup and transform got no polled data (no `IDX_0`/`IDX_1`). (#127)
+- `trmnlp lint` no longer reports a custom field as unused when only the serverless transform (`src/transform.{py,rb,php,js}`) reads it. Plugins that move their data handling into the transform, reading fields from `input["trmnl"]["plugin_settings"]["custom_fields_values"]`, got one "is not used in form fields or markup" warning per field. The check now searches the transform as well, and its message names it. (#136)
+
 ## 0.13.2
 
 - `google_photos_picker`, `json`, `modal_trigger` and `oauth_provider_select` are known form field types, so `trmnlp lint`, `build` and `serve` no longer warn "unknown field_type" for them. The hosted service renders all four. (#137)

data/README.md

@@ -334,6 +334,7 @@ oauth_scopes: "read:user user:email"
 oauth_pkce_enabled: "true"      # optional, default false
 # oauth_scope_separator: " "      # optional; some providers use ","
 # oauth_refresh_url: https://...  # optional; defaults to oauth_token_url
+# oauth_token_request_auth_method: header  # optional; "header" sends the client credentials as HTTP Basic, otherwise they go in the body
 ```
 
 Your OAuth app credentials stay local and are never synced, so set them in your environment:
@@ -433,7 +434,7 @@ The `settings.yml` file is part of the plugin definition, and is uploaded and do
 
 `description:` is an optional one-line summary of the plugin, up to 35 characters. `trmnlp lint` reports anything longer, and `trmnlp list` shows it next to each plugin name.
 
-`recipe_overview:` is optional free text for a published recipe, with no length limit. TRMNL shows it on the public recipe page with its line breaks kept, and its first 120 characters feed the page's link preview. An overview of at least 100 words lets the recipe appear in Google and other search engines. Put credits and links in an About This Plugin field instead. Leave the key out to keep the overview already on TRMNL; an empty value clears it.
+`recipe_overview:` is optional free text for a published recipe, with no length limit. TRMNL shows it on the public recipe page with its line breaks kept, and its first 120 characters feed the page's link preview. An overview of at least 100 words lets the recipe appear in Google and other search engines; `trmnlp lint` reports one that is shorter. Put credits and links in an About This Plugin field instead. Leave the key out to keep the overview already on TRMNL; an empty value clears it.
 
 See [TRMNL documentation](https://help.trmnl.com/en/articles/10542599-importing-and-exporting-private-plugins#h_581fb988f0) for details on this file's contents.
 

data/lib/trmnlp/config/plugin.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'cgi'
+require 'json'
 require 'yaml'
 
 require_relative '../errors'
@@ -113,13 +114,34 @@ module TRMNLP
         project_config.with_custom_fields(value, extra_variables:)
       end
 
-      def string_to_hash(str, delimiter: '=')
-        str.split('&').map do |k_v|
-          key, value = k_v.split(delimiter)
+      # Mirrors the hosted service's Plugins::Helpers::Transformer#string_to_hash.
+      def string_to_hash(str)
+        return json_to_hash(str) if str.strip.start_with?('{')
+
+        str.split(/[\n&]/).filter_map do |pair|
+          pair = pair.strip
+          key, value = pair.split(delimiter_for(pair), 2)
           next if value.nil?
 
-          { key => CGI.unescape_uri_component(value) }
-        end.compact.reduce({}, :merge)
+          [key.strip, CGI.unescape_uri_component(value.strip)]
+        end.to_h
+      end
+
+      # ": " (not ":") so an "https://" URL isn't mistaken for a "Name: Value" header.
+      def delimiter_for(pair)
+        equals = pair.index('=')
+        colon = pair.index(': ')
+        return '=' if colon.nil?
+        return ': ' if equals.nil?
+
+        colon < equals ? ': ' : '='
+      end
+
+      def json_to_hash(str)
+        parsed = JSON.parse(str)
+        parsed.is_a?(Hash) ? parsed.transform_values(&:to_s) : {}
+      rescue JSON::ParserError
+        {}
       end
     end
   end

data/lib/trmnlp/lint/checks/custom_fields_used.rb

@@ -6,13 +6,14 @@ module TRMNLP
   module Lint
     module Checks
       # Reports custom fields declared in .trmnlp.yml that never appear in the
-      # polling settings or the markup — one finding per unused field.
+      # polling settings, the markup or the serverless transform — one finding
+      # per unused field.
       class CustomFieldsUsed < Check
         SETTINGS_KEYS = %w[polling_url polling_headers polling_body].freeze
 
         def issues
           source.custom_field_values.keys.reject { |keyname| used?(keyname) }.map do |keyname|
-            { message: "Custom field '#{keyname}' is not used in form fields or markup." }
+            { message: "Custom field '#{keyname}' is not used in form fields, markup or the transform." }
           end
         end
 
@@ -20,7 +21,8 @@ module TRMNLP
 
         def used?(keyname)
           pattern = /#{Regexp.escape(keyname)}/
-          searchable_settings.match?(pattern) || source.all_markup.match?(pattern)
+          searchable_settings.match?(pattern) || source.all_markup.match?(pattern) ||
+            source.transform_code.match?(pattern)
         end
 
         def searchable_settings

data/lib/trmnlp/lint/checks/recipe_overview_length.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../check'
+
+module TRMNLP
+  module Lint
+    module Checks
+      # Below this many words the hosted service serves the public recipe page
+      # with `robots: noindex`, so search engines drop it. The overview is
+      # optional (private plugins never show one), so a blank value passes.
+      # Words are counted on whitespace; there is no upstream count to match.
+      class RecipeOverviewLength < Check
+        MIN_WORDS = 100
+        MESSAGE = "Recipe overview should be at least #{MIN_WORDS} words long " \
+                  'for the recipe page to appear in Google and other search engines.'.freeze
+
+        private
+
+        def pass?
+          words = source.recipe_overview.split.size
+          words.zero? || words >= MIN_WORDS
+        end
+      end
+    end
+  end
+end

data/lib/trmnlp/lint/source.rb

@@ -17,6 +17,7 @@ module TRMNLP
 
       def plugin_name = settings['name'].to_s
       def plugin_description = settings['description'].to_s
+      def recipe_overview = settings['recipe_overview'].to_s
       def settings = config.plugin.settings
       def custom_field_values = config.project.custom_fields
       def custom_field_definitions = config.plugin.custom_field_definitions
@@ -33,6 +34,15 @@ module TRMNLP
         @all_markup ||= view_markup.values.join + shared_markup
       end
 
+      # The serverless transform (src/transform.{py,rb,php,js}), or '' without one.
+      # It reads custom fields from its input, so a field may be used only there.
+      def transform_code
+        @transform_code ||= begin
+          path, = paths.transform_file
+          path ? read(path) : ''
+        end
+      end
+
       private
 
       attr_reader :config, :paths

data/lib/trmnlp/lint.rb

@@ -5,6 +5,7 @@ require_relative 'lint/source'
 require_relative 'lint/checks/title_casing'
 require_relative 'lint/checks/title_length'
 require_relative 'lint/checks/description_length'
+require_relative 'lint/checks/recipe_overview_length'
 require_relative 'lint/checks/layouts_have_content'
 require_relative 'lint/checks/no_async_functions'
 require_relative 'lint/checks/waits_for_dom_load'
@@ -25,6 +26,7 @@ module TRMNLP
       Checks::TitleCasing,
       Checks::TitleLength,
       Checks::DescriptionLength,
+      Checks::RecipeOverviewLength,
       Checks::LayoutsHaveContent,
       Checks::NoAsyncFunctions,
       Checks::WaitsForDomLoad,

data/lib/trmnlp/oauth/client.rb

@@ -39,9 +39,8 @@ module TRMNLP
         )
       end
 
-      # A PKCE public client has no secret, so its client_id must travel in the
-      # request body; a confidential client authenticates with HTTP Basic.
-      def auth_scheme = provider.client_secret ? :basic_auth : :request_body
+      # Same rule as the hosted service: HTTP Basic only when asked for, otherwise the body.
+      def auth_scheme = provider.token_request_auth_method == 'header' ? :basic_auth : :request_body
 
       # oauth2 posts tokens through a connection built from the site, so give it
       # the endpoint's origin even though the full URL is absolute.

data/lib/trmnlp/oauth/provider.rb

@@ -19,6 +19,7 @@ module TRMNLP
       def refresh_url = settings['oauth_refresh_url'] || token_url
       def scopes = settings['oauth_scopes']
       def scope_separator = settings['oauth_scope_separator'] || ' '
+      def token_request_auth_method = settings['oauth_token_request_auth_method']
       def pkce? = truthy?(settings['oauth_pkce_enabled'])
       def enabled? = truthy?(settings['oauth_enabled'])
       def client_id = env_first(ENV_CLIENT_ID, settings['oauth_client_id'])

data/lib/trmnlp/transform_pipeline.rb

@@ -40,11 +40,19 @@ module TRMNLP
     def run(path, inferred_language, data)
       language = config.plugin.serverless_language || inferred_language
       result = client.execute(code: path.read, stdin: JSON.generate(data), language:)
+      report_printed_output(result)
       return record_failure(result, data) unless result.success?
 
       parse_output(result.output, data)
     end
 
+    # The transform's return value travels separately, so stdout holds only what it printed.
+    def report_printed_output(result)
+      { 'stdout' => result.stdout, 'stderr' => result.stderr }.each do |stream, text|
+        reporter.info("transform #{stream}: #{text.strip}") unless text.strip.empty?
+      end
+    end
+
     def record_failure(result, fallback)
       @error = result.error || "transform exited #{result.exit_code}: #{result.stderr.strip}"
       reporter.info("transform failed: #{@error}")

data/lib/trmnlp/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.14.1
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -315,6 +315,7 @@ files:
 - lib/trmnlp/lint/checks/no_async_functions.rb
 - lib/trmnlp/lint/checks/no_opacity.rb
 - lib/trmnlp/lint/checks/no_size_classes.rb
+- lib/trmnlp/lint/checks/recipe_overview_length.rb
 - lib/trmnlp/lint/checks/title_casing.rb
 - lib/trmnlp/lint/checks/title_length.rb
 - lib/trmnlp/lint/checks/waits_for_dom_load.rb