trmnl_preview 0.3.2 → 0.5.1

data/lib/trmnlp/commands/push.rb

@@ -0,0 +1,61 @@
+require 'zip'
+
+require_relative 'base'
+require_relative '../api_client'
+
+module TRMNLP
+  module Commands
+    class Push < Base
+      def call
+        context.validate!
+        authenticate!
+
+        is_new = false
+
+        api = APIClient.new(config)
+
+        plugin_settings_id = options.id || config.plugin.id
+        if plugin_settings_id.nil?
+          output 'Creating a new plugin on the server...'
+          response = api.post_plugin_setting(name: 'New TRMNLP Plugin', plugin_id: 37) # hardcoded id for private_plugin
+          plugin_settings_id = response.dig('data', 'id')
+          is_new = true
+        end
+
+        unless is_new || options.force
+          answer = prompt("Plugin settings on the server will be overwritten. Are you sure? (y/n) ").downcase
+          raise Error, 'aborting' unless answer == 'y' || answer == 'yes'
+        end
+
+        size = 0
+
+        Tempfile.create(binmode: true) do |temp_file|
+          Zip::File.open(temp_file.path, Zip::File::CREATE) do |zip_file|
+            paths.src_files.each do |file|
+              zip_file.add(File.basename(file), file)
+            end
+          end
+        
+          response = api.post_plugin_setting_archive(plugin_settings_id, temp_file.path)
+          paths.plugin_config.write(response.dig('data', 'settings_yaml'))
+
+          size = File.size(temp_file.path)
+        end
+        
+        output <<~HEREDOC
+        Uploaded plugin (#{size} bytes)
+        Dashboard: #{config.app.edit_plugin_settings_uri(plugin_settings_id)}
+        HEREDOC
+
+        if is_new
+          output <<~HEREDOC
+
+          IMPORTANT! Don't forget to add it to your device playlist!
+
+              #{config.app.playlists_uri}
+          HEREDOC
+        end
+      end
+    end
+  end
+end

data/lib/trmnlp/commands/serve.rb

@@ -0,0 +1,25 @@
+require 'zip'
+
+require_relative 'base'
+require_relative '../api_client'
+
+module TRMNLP
+  module Commands
+    class Serve < Base
+      def call
+        context.validate!
+        
+        # Must come AFTER parsing options
+        require_relative '../app'
+
+        # Now we can configure things
+        App.set(:context, context)
+        App.set(:bind, options.bind)
+        App.set(:port, options.port)
+
+        # Finally, start the app!
+        App.run!
+      end
+    end
+  end
+end

data/lib/trmnlp/commands.rb

@@ -0,0 +1 @@
+Dir[File.join(__dir__, 'commands', '*.rb')].each { |file| require file }

data/lib/trmnlp/config/app.rb

@@ -0,0 +1,43 @@
+require 'yaml'
+
+module TRMNLP
+  class Config
+    # Stores trmnlp-wide configuration (irrespective of the current plugin)
+    class App
+      def initialize(paths)
+        @paths = paths
+        @config = read_config
+      end
+
+      def save
+        paths.app_config_dir.mkpath
+        paths.app_config.write(YAML.dump(@config))
+      end
+
+      def logged_in? = api_key && !api_key.empty?
+      def logged_out? = !logged_in?
+
+      def api_key = @config['api_key']
+
+      def api_key=(key)
+        @config['api_key'] = key
+      end
+
+      def base_uri = URI.parse(@config['base_url'] || 'https://usetrmnl.com')
+
+      def api_uri = URI.join(base_uri, '/api')
+
+      def account_uri = URI.join(base_uri, '/account')
+
+      def edit_plugin_settings_uri(id) = URI.join(base_uri, "/plugin_settings/#{id.to_s}/edit")
+
+      def playlists_uri = URI.join(base_uri, '/playlists')
+
+      private
+
+      attr_reader :paths
+
+      def read_config = paths.app_config.exist? ? YAML.safe_load(paths.app_config.read) : {}
+    end
+  end
+end

data/lib/trmnlp/config/plugin.rb

@@ -0,0 +1,74 @@
+require 'yaml'
+
+module TRMNLP
+  class Config
+    class Plugin
+      def initialize(paths, trmnlp_config)
+        @paths = paths
+        @trmnlp_config = trmnlp_config
+        reload!
+      end
+
+      def reload!
+        if paths.plugin_config.exist?
+          @config = YAML.load_file(paths.plugin_config)
+        else
+          @config = {}
+        end
+      end
+      
+      def strategy = @config['strategy']
+      def polling? = strategy == 'polling'
+      def webhook? = strategy == 'webhook'
+      def static? = strategy == 'static'
+
+      def polling_urls
+        return [] if @config['polling_url'].nil? || @config['polling_url'].empty?
+
+        urls = @config['polling_url'].split("\n").map(&:strip)
+
+        urls.map { |url| with_custom_fields(url) }
+      end
+
+      def polling_url_text = polling_urls.join("\r\n") # for {{ trmnl }}
+
+      def polling_verb = @config['polling_verb'] || 'GET'
+
+      def polling_headers
+        string_to_hash(@config['polling_headers'] || '').transform_values { |v| with_custom_fields(v) }
+      end
+
+      def polling_headers_encoded = polling_headers.map { |k, v| "#{k}=#{v}" }.join('&') # for {{ trmnl }}
+
+      def polling_body = with_custom_fields(@config['polling_body'] || '')
+      
+      def dark_mode = @config['dark_mode'] || 'no'
+
+      def no_screen_padding = @config['no_screen_padding'] || 'no'
+
+      def id = @config['id']
+
+      def static_data
+        JSON.parse(@config['static_data'] || '{}')
+      rescue JSON::ParserError
+        raise Error, 'invalid JSON in static_data'
+      end
+
+      private
+
+      attr_reader :paths, :trmnlp_config
+
+      def with_custom_fields(value) = trmnlp_config.with_custom_fields(value)
+
+      # copied from TRMNL core
+      def string_to_hash(str, delimiter: '=')
+        str.split('&').map do |k_v|
+          key, value = k_v.split(delimiter)
+          next if value.nil?
+
+          { key => CGI.unescape_uri_component(value) }
+        end.compact.reduce({}, :merge)
+      end
+    end
+  end
+end

data/lib/trmnlp/config/project.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module TRMNLP
+  class Config
+    class Project
+      attr_reader :paths
+
+      def initialize(paths)
+        @paths = paths
+        reload!
+      end
+
+      def reload!
+        if paths.trmnlp_config.exist?
+          @config = YAML.load_file(paths.trmnlp_config)
+        else
+          @config = {}
+        end
+      end
+
+      def user_filters = @config['custom_filters'] || []
+
+      def live_render? = !watch_paths.empty?
+
+      def watch_paths
+        (@config['watch'] || []).map { |watch_path| paths.expand(watch_path) }.uniq
+      end
+
+      def custom_fields = @config['custom_fields'] || {}
+
+      def user_data_overrides = @config['variables'] || {}
+
+      # for interpolating custom_fields into polling_* options
+      def with_custom_fields(value)
+        custom_fields_with_env = custom_fields.transform_values { |v| with_env(v) }
+        Liquid::Template.parse(value).render(custom_fields_with_env)
+      end
+
+      private
+
+      # for interpolating ENV vars into custom_fields
+      def with_env(value)
+        Liquid::Template.parse(value).render({ 'env' => ENV.to_h })
+      end
+    end
+  end
+end

data/lib/trmnlp/config.rb

@@ -0,0 +1,15 @@
+require_relative 'config/app'
+require_relative 'config/plugin'
+require_relative 'config/project'
+
+module TRMNLP
+  class Config
+    attr_reader :app, :project, :plugin
+
+    def initialize(path)
+      @app = App.new(path)
+      @project = Project.new(path)
+      @plugin = Plugin.new(path, @project)
+    end
+  end
+end

data/lib/trmnlp/context.rb

@@ -0,0 +1,211 @@
+require 'erb'
+require 'faraday'
+require 'filewatcher'
+require 'json'
+require 'liquid'
+
+require_relative 'config'
+require_relative 'custom_filters'
+require_relative 'paths'
+
+module TRMNLP
+  class Context
+    attr_reader :config, :paths
+    
+    def initialize(root_dir)
+      @paths = Paths.new(root_dir)
+      @config = Config.new(paths)
+    end
+
+    def validate!
+      raise Error, "not a plugin directory (did not find #{paths.trmnlp_config})" unless paths.valid?
+    end
+
+    def start_filewatcher
+      @filewatcher_thread ||= Thread.new do
+        loop do
+          begin
+            Filewatcher.new(config.project.watch_paths).watch do |changes|
+              config.project.reload!
+              config.plugin.reload!
+              new_user_data = user_data
+
+              views = changes.map { |path, _change| File.basename(path, '.liquid') }
+              views.each do |view|
+                @view_change_callback.call(view, new_user_data) if @view_change_callback
+              end
+            end
+          rescue => e
+            puts "Error during live render: #{e}"
+          end
+        end
+      end
+    end
+
+    def on_view_change(&block)
+      @view_change_callback = block
+    end
+
+    def user_data
+      merged_data = base_trmnl_data
+
+      if config.plugin.static?
+        merged_data.merge!(config.plugin.static_data)
+      elsif paths.user_data.exist?
+        merged_data.merge!(JSON.parse(paths.user_data.read))
+      end
+
+      # Praise be to ActiveSupport
+      merged_data.deep_merge!(config.project.user_data_overrides)
+    end
+
+    def poll_data
+      return unless config.plugin.polling?
+
+      data = {}
+
+      if config.plugin.polling_urls.empty?
+        raise Error, "config must specify polling_url or polling_urls"
+      end
+
+      config.plugin.polling_urls.each.with_index do |url, i|
+        verb = config.plugin.polling_verb.upcase
+
+        print "#{verb} #{url}... "
+
+        conn = Faraday.new(url:, headers: config.plugin.polling_headers)
+
+        case verb
+        when 'GET'
+          response = conn.get
+        when 'POST'
+          response = conn.post do |req|
+            req.body = config.plugin.polling_body
+          end
+        end
+
+        puts "received #{response.body.length} bytes (#{response.status} status)"
+        if response.status == 200
+          json = wrap_array(JSON.parse(response.body))
+        else
+          json = {}
+          puts response.body
+        end
+        
+        if config.plugin.polling_urls.count == 1
+          # For a single polling URL, we just return the JSON directly
+          data = json
+          break
+        else
+          # Multiple URLs are namespaced by index
+          data["IDX_#{i}"] = json
+        end
+      end
+
+      write_user_data(data)
+
+      data
+    rescue StandardError => e
+      puts "error: #{e.message}"
+      {}
+    end
+
+    def put_webhook(payload)
+      data = wrap_array(JSON.parse(payload))
+      write_user_data(data)
+    rescue
+      puts "webhook error: #{e.message}"
+    end
+
+    def render_template(view)
+      template_path = paths.template(view)
+      return "Missing template: #{template_path}" unless template_path.exist?
+
+      user_template = Liquid::Template.parse(template_path.read, environment: liquid_environment)
+      user_template.render(user_data)
+    rescue StandardError => e
+      e.message
+    end
+
+    def render_full_page(view)
+      template = paths.render_template.read
+      
+      ERB.new(template).result(TemplateBinding.new(self, view).get_binding do
+        render_template(view)
+      end)
+    end
+
+    def screen_classes
+      classes = 'screen'
+      classes << ' screen--no-bleed' if config.plugin.no_screen_padding == 'yes'
+      classes << ' dark-mode' if config.plugin.dark_mode == 'yes'
+      classes
+    end
+
+    private 
+
+    # bindings must match the `GET /render/{view}.html` route in app.rb
+    class TemplateBinding
+      def initialize(context, view)
+        @screen_classes = context.screen_classes
+        @view = view
+      end
+
+      def get_binding = binding
+    end
+
+    def wrap_array(json)
+      json.is_a?(Array) ? { data: json } : json
+    end
+
+    def base_trmnl_data
+      {
+        'trmnl' => {
+          'user' => {
+            'name' => 'name',
+            'first_name' => 'first_name',
+            'last_name' => 'last_name',
+            'locale' => 'en',
+            'time_zone' => 'Eastern Time (US & Canada)',
+            'time_zone_iana' => 'America/New_York',
+            'utc_offset' => -14400
+          },
+          'device' => {
+            'friendly_id' => 'ABC123',
+            'percent_charged' => 85.0,
+            'wifi_strength' => 90,
+            'height' => 480,
+            'width' => 800
+          },
+          'system' => {
+            'timestamp_utc' => Time.now.utc.to_i,
+          },
+          'plugin_settings' => {
+            'instance_name' => 'instance_name',
+            'strategy' => config.plugin.strategy,
+            'dark_mode' => config.plugin.dark_mode,
+            'polling_headers' => config.plugin.polling_headers_encoded,
+            'polling_url' => config.plugin.polling_url_text,
+            'custom_fields_values' => config.project.custom_fields
+          }
+        }
+      }
+    end
+
+    def liquid_environment
+      @liquid_environment ||= Liquid::Environment.build do |env|
+        env.register_filter(CustomFilters)
+
+        config.project.user_filters.each do |module_name, relative_path|
+          require paths.root_dir.join(relative_path)
+          env.register_filter(Object.const_get(module_name))
+        end
+      end
+    end
+
+    def write_user_data(data)
+      paths.create_cache_dir
+      paths.user_data.write(JSON.generate(data))
+    end
+  end
+end

data/lib/{trmnl_preview → trmnlp}/custom_filters.rb

@@ -1,7 +1,8 @@
 require 'active_support'
 
-module TRMNLPreview
+module TRMNLP
   module CustomFilters
+    # TODO: sync up with core
     def number_with_delimiter(*args)
       ActiveSupport::NumberHelper.number_to_delimited(*args)
     end

data/lib/trmnlp/paths.rb

@@ -0,0 +1,56 @@
+require 'xdg'
+
+module TRMNLP
+  class Paths
+    attr_reader :root_dir
+    
+    def initialize(root_dir)
+      @root_dir = Pathname.new(root_dir)
+      @xdg = XDG.new
+    end
+    
+    # --- trmnlp library ---
+    
+    def gem_dir = Pathname.new(__dir__).join('..', '..').expand_path
+
+    def templates_dir = gem_dir.join('templates')
+
+    # --- directories ---
+    
+    def src_dir = root_dir.join('src')
+
+    def build_dir = root_dir.join('_build')
+    def create_build_dir = build_dir.mkpath
+
+    def app_config_dir = xdg.config_home.join('trmnlp')
+
+    def cache_dir = xdg.cache_home.join('trmnl')
+    def create_cache_dir = cache_dir.mkpath
+
+    def valid? = trmnlp_config.exist?
+
+    # --- files ---
+
+    def trmnlp_config = root_dir.join('.trmnlp.yml')
+
+    def plugin_config = src_dir.join('settings.yml')
+      
+    def template(view) = src_dir.join("#{view}.liquid")
+      
+    def app_config = app_config_dir.join('config.yml')
+
+    def user_data = cache_dir.join('data.json')
+
+    def render_template = Pathname.new(__dir__).join('..', '..', 'web', 'views', 'render_html.erb')
+    
+    def src_files = src_dir.glob('*').select(&:file?)
+
+    # --- utilities ---
+
+    def expand(path) = Pathname.new(path).expand_path(root_dir)
+
+    private
+
+    attr_reader :xdg
+  end
+end

data/lib/{trmnl_preview → trmnlp}/screen_generator.rb

@@ -3,7 +3,7 @@ require 'mini_magick'
 require 'puppeteer-ruby'
 require 'base64'
 
-module TRMNLPreview
+module TRMNLP
   class ScreenGenerator
 
     def initialize(html, opts = {})

data/lib/trmnlp/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TRMNLP
+  VERSION = "0.5.1".freeze
+end

data/lib/trmnlp.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TRMNLP; end
+require 'oj'
+Oj.mimic_JSON()
+require_relative "trmnlp/config"
+require_relative "trmnlp/context"
+require_relative "trmnlp/version"
+
+module TRMNLP
+  VIEWS = %w{full half_horizontal half_vertical quadrant}
+
+  class Error < StandardError; end
+end

data/templates/init/.trmnlp.yml

@@ -0,0 +1,14 @@
+# TRMNLP configuration
+# {{ env.VARIABLE }} interpolation is available here
+---
+# auto-reload when files change (`watch: false` to disable)
+watch:
+  - .trmnlp.yml
+  - src
+
+# values of custom fields (defined in src/settings.yml)
+custom_fields: {}
+
+# override variables
+variables:
+  trmnl: {}

data/templates/init/bin/dev

@@ -0,0 +1,25 @@
+#! /bin/bash
+
+if command -v trmnlp &> /dev/null
+then
+    echo "Starting trmnlp..."
+    trmnlp serve
+    exit
+fi
+
+if command -v docker &> /dev/null
+then
+    echo "Running trmnl/trmnlp container..."
+    docker run -p 4567:4567 -v .:/plugin trmnl/trmnlp
+    exit
+fi
+
+echo "Install the trmnl_preview gem:
+
+  gem install trmnl_preview
+
+Or install Docker:
+
+    https://docs.docker.com/get-docker/"
+
+exit 1

data/templates/init/src/full.liquid

@@ -0,0 +1 @@
+full!

data/templates/init/src/half_horizontal.liquid

@@ -0,0 +1 @@
+half horizontal!

data/templates/init/src/half_vertical.liquid

@@ -0,0 +1 @@
+half vertical!

data/templates/init/src/quadrant.liquid

@@ -0,0 +1 @@
+quadrant!

data/templates/init/src/settings.yml

@@ -0,0 +1,15 @@
+#
+# Changes to this file will be overwritten by `trmnlp pull`.
+#
+# Docs: https://help.usetrmnl.com/en/articles/10542599-importing-and-exporting-private-plugins#h_581fb988f0
+#
+---
+strategy: polling
+no_screen_padding: 'no'
+dark_mode: 'no'
+static_data: ''
+polling_verb: get
+polling_url: ''
+polling_headers: ''
+name: My Plugin
+refresh_interval: 1440