trmnl_preview 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16a333009aab09891c12d6fe7bf3b8662912cd6e376f31c1a4997de5a6c93314
-  data.tar.gz: cf57e05fa4ba41059e55fb7281d7644ee07772459b63503ebe4a4023fae14085
+  metadata.gz: abf6757d447adc5c12e7eed3baa049bc80757bc536f0da60af8ccb624d4216d4
+  data.tar.gz: a533ae492f2ea9b71a55130977a88988ec3767c1393b2ebbbf618364a5a0f53b
 SHA512:
-  metadata.gz: 43048f869b37533061b92b7e06b2623b8d47e35098942f535301655727efc726f09c004330f277fb1ee7d0a73f3b5785283846b1404e0d8a6b92cec4f94b9105
-  data.tar.gz: 3a8672a65e06a537fef9c51e759657076bcda0a320cc4f2ee8a211c27bad31bcab09993ab592c520c3103805e2077a5f907c67c2423184688fd612d0c307e276
+  metadata.gz: a88985299e6c183a0ee61fa609f117dffad48b42e1abdd4c2ea8303051725f44fc411870d9b5999d0ce7b1f78e6923d10974cf79ea79787ed61212eed36c3aa4
+  data.tar.gz: bbdd8ac78d326b086eb56c8a66cf2aaf96096e1beb879ee951cda37b6f699cf14fc5d796fac34d4711b20c8d750075f38c1110d2829d0ebe1ed0d5fafa44c9c3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.6
+
+- Fixed bug that left blank plugins on server after upload failed
+- Fixed bug creating upload.zip after previous upload had failed
+- Added support to read API key fromk `TRMNL_API_KEY` environment variable (@andi4000)
+- Fixed `init` command in Docker container (@jbarreiros)
+- Automatically remove ephemeral Docker container after exit (@andi4000)
+
 ## 0.5.5
 
 - Added dark mode (@stephenyeargin)

data/README.md

@@ -31,11 +31,11 @@ This is the structure of a plugin project:
 You can start building a plugin locally, then `push` it to the TRMNL server for display on your device.
 
 ```sh
-trmnlp init my_plugin  # generate
-cd my_plugin
-trmnlp serve           # develop locally
-trmnlp login           # authenticate
-trmnlp push            # upload
+trmnlp init [my_plugin]  # generate
+cd [my_plugin]
+trmnlp serve             # develop locally
+trmnlp login             # authenticate
+trmnlp push              # upload
 ```
 
 ## Modifying an Existing Plugin
@@ -43,13 +43,19 @@ trmnlp push            # upload
 If you have built a plugin with the web-based editor, you can `clone` it, work on it locally, and `push` changes back to the server.
 
 ```sh
-trmnlp login                 # authenticate
-trmnlp clone my_plugin [id]  # first download
-cd my_plugin
-trmnlp serve                 # develop locally
-trmnlp push                  # upload
+trmnlp login                   # authenticate
+trmnlp clone [my_plugin] [id]  # first download
+cd [my_plugin]
+trmnlp serve                   # develop locally
+trmnlp push                    # upload
 ```
 
+## Authentication
+
+The `trmnlp login` command saves your API key to `~/.config/trmnlp/config.yml`.
+
+If an environment variable is more convenient (for example in a CI/CD pipeline), you can set `$TRMNL_API_KEY` instead.
+
 ## Running trmnlp
 
 The `bin/trmnlp` script is provided as a convenience. It will use the local Ruby gem if available, falling back to the `trmnl/trmnlp` Docker image.

data/lib/trmnlp/api_client.rb

@@ -53,6 +53,16 @@ module TRMNLP
       end
     end
 
+    def delete_plugin_setting(id)
+      response = conn.delete("plugin_settings/#{id}")
+
+      if response.status == 204
+        true
+      else
+        raise Error, "failed to delete plugin setting: #{response.status} #{response.body}"
+      end
+    end
+
     private
   
     attr_reader :config

data/lib/trmnlp/commands/login.rb

@@ -6,7 +6,9 @@ module TRMNLP
       def call
         if config.app.logged_in?
           anonymous_key = config.app.api_key[0..10] + '*' * (config.app.api_key.length - 11)
-          output "Currently authenticated as: #{anonymous_key}" 
+          output "Currently authenticated as: #{anonymous_key}"
+          confirm = prompt("You are already authenticated. Do you want to re-authenticate? (y/N): ")
+          return unless confirm.strip.downcase == 'y'
         end
 
         output "Please visit #{config.app.account_uri} to grab your API key, then paste it here."

data/lib/trmnlp/commands/push.rb

@@ -11,6 +11,7 @@ module TRMNLP
         authenticate!
 
         is_new = false
+        zip_path = 'upload.zip'
 
         api = APIClient.new(config)
 
@@ -27,10 +28,7 @@ module TRMNLP
           raise Error, 'aborting' unless answer == 'y' || answer == 'yes'
         end
 
-        size = 0
-
-        zip_path = 'upload.zip'
-        f = Zip::File.open(zip_path, Zip::File::CREATE) do |zip_file|
+        Zip::File.open(zip_path, Zip::File::CREATE) do |zip_file|
           paths.src_files.each do |file|
             zip_file.add(File.basename(file), file)
           end
@@ -40,7 +38,6 @@ module TRMNLP
         paths.plugin_config.write(response.dig('data', 'settings_yaml'))
 
         size = File.size(zip_path)
-        File.delete(zip_path)
         
         output <<~HEREDOC
         Uploaded plugin (#{size} bytes)
@@ -55,6 +52,15 @@ module TRMNLP
               #{config.app.playlists_uri}
           HEREDOC
         end
+      rescue
+        if is_new && plugin_settings_id
+          output 'Error during creation, cleaning up...'
+          api.delete_plugin_setting(plugin_settings_id)
+        end
+
+        raise
+      ensure
+        File.delete(zip_path) if File.exist?(zip_path)
       end
     end
   end

data/lib/trmnlp/config/app.rb

@@ -17,7 +17,11 @@ module TRMNLP
       def logged_in? = api_key && !api_key.empty?
       def logged_out? = !logged_in?
 
-      def api_key = @config['api_key']
+      def api_key
+        env_api_key = ENV['TRMNL_API_KEY']
+        return env_api_key if env_api_key && !env_api_key.empty?
+        @config['api_key']
+      end
 
       def api_key=(key)
         @config['api_key'] = key

data/lib/trmnlp/version.rb

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

data/templates/init/bin/trmnlp

@@ -13,6 +13,7 @@ fi
 if command -v docker &> /dev/null
 then
     docker run \
+        --rm \
         --publish 4567:4567 \
         --volume "$(pwd):/plugin" \
         trmnl/trmnlp "$@"
@@ -27,4 +28,4 @@ Or install Docker:
 
     https://docs.docker.com/get-docker/"
 
-exit 1
+exit 1

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Rockwell Schrock
 bindir: bin
 cert_chain: []
-date: 2025-06-27 00:00:00.000000000 Z
+date: 2025-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra