trmnl_preview 0.7.1 → 0.7.2

data/bin/rake

@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rake' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-bundle_binstub = File.expand_path("bundle", __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rake", "rake")

data/lib/trmnlp/api_client.rb

@@ -1,86 +0,0 @@
-require 'faraday'
-require 'faraday/multipart'
-
-require_relative 'config'
-
-module TRMNLP
-  class APIClient
-    def initialize(config)
-      @config = config
-    end
-
-    def get_plugin_setting_archive(id)
-      response = conn.get("plugin_settings/#{id}/archive")
-
-      if response.status == 200
-        temp_file = Tempfile.new(["plugin_settings_#{id}", '.zip'])
-        temp_file.binmode
-        temp_file.write(response.body)
-        temp_file.rewind
-
-        # return the temp file IO
-        temp_file
-      else
-        raise Error, "failed to download plugin settings archive: #{response.status} #{response.body}"
-      end
-    end
-
-    def post_plugin_setting_archive(id, path)
-      filepart = Faraday::Multipart::FilePart.new(path, 'application/zip')
-
-      payload = {
-        file: filepart
-      }
-
-      response = conn.post("plugin_settings/#{id}/archive", payload)
-
-      filepart.close
-
-      if response.status == 200
-        JSON.parse(response.body)
-      else
-        raise Error, "failed to upload plugin settings archive: #{response.status} #{response.body}"
-      end
-    end
-
-    def post_plugin_setting(params)
-      response = conn.post("plugin_settings", params.to_json, content_type: 'application/json')
-
-      if response.status == 200
-        JSON.parse(response.body)
-      else
-        raise Error, "failed to create plugin setting: #{response.status} #{response.body}"
-      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
-  
-    def api_uri = config.app.api_uri
-
-    def conn
-      @conn ||= Faraday.new(url: api_uri, headers:) do |f|
-        f.request :multipart
-      end
-    end
-
-
-    def headers
-      {
-        'Authorization' => "Bearer #{config.app.api_key}",
-        'User-Agent' => "trmnlp/#{VERSION}",
-      }
-    end
-  end
-end

data/lib/trmnlp/app.rb

@@ -1,103 +0,0 @@
-
-require 'faye/websocket'
-require 'sinatra'
-require 'sinatra/base'
-
-require_relative 'context'
-require_relative 'screen_generator'
-
-module TRMNLP
-  class App < Sinatra::Base
-    # Sinatra settings
-    set :views, File.join(File.dirname(__FILE__), '..', '..', 'web', 'views')
-    set :public_folder, File.join(File.dirname(__FILE__), '..', '..', 'web', 'public')
-    
-    def initialize(*args)
-      super
-
-      @context = settings.context
-
-      @context.poll_data
-
-      @context.start_filewatcher if @context.config.project.live_render?
-
-      @live_reload_clients = []
-      @context.on_view_change do |view, user_data|
-        @live_reload_clients.each do |ws|
-          payload = {
-            'type' => 'reload',
-            'view' => view,
-            'user_data' => user_data
-          }
-
-          ws.send(payload.to_json)
-        end
-      end
-    end
-
-    post '/webhook' do
-      @context.put_webhook(request.body.read)
-      "OK"
-    end
-    
-    get '/' do
-      redirect '/full'
-    end
-
-    get '/data' do
-      content_type :json
-      JSON.pretty_generate(@context.user_data)
-    end
-
-    get '/live_reload' do
-      ws = Faye::WebSocket.new(request.env)
-
-      ws.on(:open) do |event|
-        @live_reload_clients << ws
-      end
-  
-      ws.on(:close) do |event|
-        @live_reload_clients.delete(ws)
-      end
-  
-      ws.rack_response
-    end
-
-    get '/poll' do
-      @context.poll_data
-      redirect back
-    end
-    
-    VIEWS.each do |view|
-      get "/#{view}" do
-        @view = view
-        @user_data = JSON.pretty_generate(@context.user_data)
-        @live_reload = @context.config.project.live_render?
-
-        erb :index
-      end
-
-      get "/render/#{view}.html" do
-        @context.render_full_page(view, params)
-      end
-      
-      get "/render/#{view}.png" do
-        @view = view
-        html = @context.render_full_page(view, params)
-
-        # Parse optional rendering params (sent by the web UI for PNG output)
-        width = params[:width] && params[:width].to_i
-        height = params[:height] && params[:height].to_i
-        color_depth = params[:color_depth] && params[:color_depth].to_i
-
-        generator = ScreenGenerator.new(html, image: true, width: width, height: height, color_depth: color_depth)
-        temp_image = generator.process
-        
-        send_file temp_image.path, type: 'image/png', disposition: 'inline'
-
-        temp_image.close
-        temp_image.unlink
-      end
-    end
-  end
-end

data/lib/trmnlp/cli.rb

@@ -1,68 +0,0 @@
-require 'thor'
-
-require_relative '../trmnlp'
-require_relative '../trmnlp/commands'
-
-module TRMNLP
-  class CLI < Thor
-    package_name 'trmnlp'
-
-    class_option :dir, type: :string, default: Dir.pwd, aliases: '-d',
-                  desc: 'Plugin project directory'
-
-    class_option :quiet, type: :boolean, default: false, desc: 'Suppress output', aliases: '-q'
-
-    def self.exit_on_failure? = true
-
-    def self.default_bind = File.exist?('/.dockerenv') ? '0.0.0.0' : '127.0.0.1'
-
-    desc 'build', 'Generate static HTML files'
-    def build
-      Commands::Build.new(options).call
-    end
-
-    desc 'login', 'Authenticate with TRMNL server'
-    def login
-      Commands::Login.new(options).call
-    end
-
-    desc 'init NAME', 'Start a new plugin project'
-    method_option :skip_liquid, type: :boolean, default: false, desc: 'Skip generating liquid templates'
-    def init(name)
-      Commands::Init.new(options).call(name)
-    end
-
-    desc 'clone NAME ID', 'Copy a plugin project from TRMNL server'
-    def clone(name, id)
-      Commands::Clone.new(options).call(name, id)
-    end
-
-    desc 'pull', 'Download latest plugin settings from TRMNL server'
-    method_option :force, type: :boolean, default: false, aliases: '-f',
-                  desc: 'Skip confirmation prompts'
-    method_option :id, type: :string, aliases: '-i', desc: 'Plugin settings ID'
-    def pull
-      Commands::Pull.new(options).call
-    end
-
-    desc 'push', 'Upload latest plugin settings to TRMNL server'
-    method_option :force, type: :boolean, default: false, aliases: '-f',
-                  desc: 'Skip confirmation prompts'
-    method_option :id, type: :string, aliases: '-i', desc: 'Plugin settings ID'
-    def push
-      Commands::Push.new(options).call
-    end
-
-    desc 'serve', 'Start a local dev server'
-    method_option :bind, type: :string, default: default_bind, aliases: '-b', desc: 'Bind address'
-    method_option :port, type: :numeric, default: 4567, aliases: '-p', desc: 'Port number'
-    def serve
-      Commands::Serve.new(options).call
-    end
-
-    desc 'version', 'Show version'
-    def version
-      puts VERSION
-    end
-  end
-end

data/lib/trmnlp/commands/base.rb

@@ -1,40 +0,0 @@
-require 'thor/core_ext/hash_with_indifferent_access'
-
-require_relative '../context'
-
-module TRMNLP
-  module Commands
-    class Base
-      include Thor::CoreExt
-
-      def initialize(options = HashWithIndifferentAccess.new)
-        @options = HashWithIndifferentAccess.new(options)
-        @context = Context.new(@options.dir)
-      end
-
-      def call
-        raise NotImplementedError
-      end
-
-      protected
-
-      attr_accessor :options, :context
-
-      def config = context.config
-      def paths = context.paths
-
-      def authenticate!
-        raise Error, "please run `trmnlp login`" unless config.app.logged_in?
-      end
-
-      def output(message)
-        puts(message) unless options.quiet?
-      end
-
-      def prompt(message)
-        print message
-        $stdin.gets.chomp
-      end
-    end
-  end
-end

data/lib/trmnlp/commands/build.rb

@@ -1,21 +0,0 @@
-require_relative 'base'
-
-module TRMNLP
-  module Commands
-    class Build < Base
-      def call
-        context.validate!
-        context.poll_data
-        context.paths.create_build_dir
-
-        VIEWS.each do |view|
-          output_path = context.paths.build_dir.join("#{view}.html")
-          output "Writing #{output_path}..."
-          output_path.write(context.render_full_page(view))
-        end
-  
-        output "Done!"
-      end
-    end
-  end
-end

data/lib/trmnlp/commands/clone.rb

@@ -1,30 +0,0 @@
-require_relative 'base'
-require_relative 'pull'
-
-module TRMNLP
-  module Commands
-    class Clone < Base
-      def call(directory_name, id)
-        authenticate!
-
-        destination_path = Pathname.new(options.dir).join(directory_name)
-        raise Error, "directory #{destination_path} already exists, aborting" if destination_path.exist?
-
-        Init.new(dir: options.dir, skip_liquid: true, quiet: true).call(directory_name)
-
-        Pull.new(dir: destination_path.to_s, force: true, id: id).call
-
-        output <<~HEREDOC
-
-        To start the local server:
-
-            cd #{Pathname.new(destination_path).relative_path_from(Dir.pwd)} && trmnlp serve
-        HEREDOC
-      end
-
-      private
-
-      def template_dir = paths.templates_dir.join('init')
-    end
-  end
-end

data/lib/trmnlp/commands/init.rb

@@ -1,55 +0,0 @@
-require 'fileutils'
-
-require_relative 'base'
-
-module TRMNLP
-  module Commands
-    class Init < Base
-      def call(name)
-        destination_dir = Pathname.new(options.dir).join(name)
-
-        unless destination_dir.exist?
-          output "Creating #{destination_dir}"
-          destination_dir.mkpath
-        end
-
-        template_dir.glob('**/{*,.*}').each do |source_pathname|
-          next if source_pathname.directory?
-          next if options.skip_liquid && source_pathname.extname == '.liquid'
-
-          relative_pathname = source_pathname.relative_path_from(template_dir)
-          destination_pathname = destination_dir.join(relative_pathname)
-          destination_pathname.dirname.mkpath
-          
-          if destination_pathname.exist?
-            answer = prompt("#{destination_pathname} already exists. Overwrite? (y/n): ").downcase
-            if answer != 'y'
-              output "Skipping #{destination_pathname}"
-              next
-            end
-          end
-
-          output "Creating #{destination_pathname}"
-          FileUtils.cp(source_pathname, destination_pathname)
-        end
-
-        output <<~HEREDOC
-
-        To start the local server:
-
-            cd #{Pathname.new(destination_dir).relative_path_from(Dir.pwd)}
-            trmnlp serve
-
-        To publish the plugin:
-
-            trmnlp login
-            trmnlp push
-        HEREDOC
-      end
-
-      private
-
-      def template_dir = paths.templates_dir.join('init')  
-    end
-  end
-end

data/lib/trmnlp/commands/login.rb

@@ -1,27 +0,0 @@
-require_relative 'base'
-
-module TRMNLP
-  module Commands
-    class Login < Base
-      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}"
-          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."
-        
-        api_key = prompt("API Key: ")
-        raise Error, "API key cannot be empty" if api_key.empty?
-        raise Error, "Invalid API key; did you copy it from the right place?" unless api_key.start_with?("user_")
-        
-        config.app.api_key = api_key
-        config.app.save
-        
-        output "Saved changes to #{paths.app_config}"
-      end
-    end
-  end
-end

data/lib/trmnlp/commands/pull.rb

@@ -1,43 +0,0 @@
-require 'zip'
-
-require_relative 'base'
-require_relative '../api_client'
-
-module TRMNLP
-  module Commands
-    class Pull < Base
-      def call
-        context.validate!
-        authenticate!
-
-        plugin_settings_id = options.id || config.plugin.id
-        raise Error, 'plugin ID must be specified' if plugin_settings_id.nil?
-
-        unless options.force
-          answer = prompt("Local plugin files will be overwritten. Are you sure? (y/n) ").downcase
-          raise Error, 'aborting' unless answer == 'y' || answer == 'yes'
-        end
-
-        api = APIClient.new(config)
-        tempfile = api.get_plugin_setting_archive(plugin_settings_id)
-        size = 0
-
-        begin
-          Zip::File.open(tempfile.path) do |zip_file|
-            zip_file.each do |entry|
-              dest_path = paths.src_dir.join(entry.name)
-              dest_path.dirname.mkpath
-              zip_file.extract(entry, dest_path) { true } # overwrite existing
-            end
-          end
-
-          size = File.size(tempfile.path)
-        ensure
-          tempfile.close
-        end
-
-        puts "Downloaded plugin (#{size} bytes)"
-      end
-    end
-  end
-end

data/lib/trmnlp/commands/push.rb

@@ -1,67 +0,0 @@
-require 'zip'
-
-require_relative 'base'
-require_relative '../api_client'
-
-module TRMNLP
-  module Commands
-    class Push < Base
-      def call
-        context.validate!
-        authenticate!
-
-        is_new = false
-        zip_path = 'upload.zip'
-
-        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
-
-        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
-        end
-      
-        response = api.post_plugin_setting_archive(plugin_settings_id, zip_path)
-        paths.plugin_config.write(response.dig('data', 'settings_yaml'))
-
-        size = File.size(zip_path)
-        
-        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
-      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
-end

data/lib/trmnlp/commands/serve.rb

@@ -1,25 +0,0 @@
-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

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

data/lib/trmnlp/config/app.rb

@@ -1,47 +0,0 @@
-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
-        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
-      end
-
-      def base_uri = URI.parse(@config['base_url'] || 'https://trmnl.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